Merge pull request #97 from auxbh/feature/DDR

Add DDR Guides, A20 to WORLD

docs/games/ddr/a20/setup.md

@@ -0,0 +1,6 @@
+# Game Setup (DDR A2O)
+<div style="text-align: center;">
+    <img src="/img/ddr/a20.png" width="50%">
+</div>
+
+--8<-- "docs/games/ddr/setup.md"

docs/games/ddr/a20/troubleshooting.md

@@ -0,0 +1,6 @@
+# Troubleshooting (DDR A20)
+<div style="text-align: center;">
+    <img src="/img/ddr/a20.png" width="50%">
+</div>
+
+--8<-- "docs/games/ddr/troubleshooting.md"

docs/games/ddr/a20plus/setup.md

@@ -0,0 +1,6 @@
+# Game Setup (DDR A2O PLUS)
+<div style="text-align: center;">
+    <img src="/img/ddr/a20plus.png" width="50%">
+</div>
+
+--8<-- "docs/games/ddr/setup.md"

docs/games/ddr/a20plus/troubleshooting.md

@@ -0,0 +1,6 @@
+# Troubleshooting (DDR A20 PLUS)
+<div style="text-align: center;">
+    <img src="/img/ddr/a20plus.png" width="50%">
+</div>
+
+--8<-- "docs/games/ddr/troubleshooting.md"

docs/games/ddr/a3/setup.md

@@ -0,0 +1,6 @@
+# Game Setup (DDR A3)
+<div style="text-align: center;">
+    <img src="/img/ddr/a3.png" width="50%">
+</div>
+
+--8<-- "docs/games/ddr/setup.md"

docs/games/ddr/a3/troubleshooting.md

@@ -0,0 +1,6 @@
+# Troubleshooting (DDR A3)
+<div style="text-align: center;">
+    <img src="/img/ddr/a3.png" width="50%">
+</div>
+
+--8<-- "docs/games/ddr/troubleshooting.md"

docs/games/ddr/setup.md

@@ -0,0 +1,230 @@
+!!! danger "Warning"
+
+	Please make sure you downloaded your data from an appropriate source.
+	This guide is unable to troubleshoot any problems related to bad or poorly managed data.
+
+---
+### About data
+
+!!! info "The full game should be around 20-25gb in size."
+
+!!! info ""
+
+	Please keep the following in mind as you're going through this guide.  
+
+	DDR's codename is `MDX`. Starting with `DDR A20` this would be either:
+
+	- `MDX-001` *(Other cabs, 32 bits)*
+	- `MDX-003` *(Gold cab, 64 bits)*
+
+	The gold cab version contains more features, such as exclusive songs or the "GOLDEN LEAGUE" mode.
+
+---
+### Preparing data
+
+!!! tip ""
+
+	After downloading and extracting your data, we need to make sure your files aren't set to `Read-only`.
+
+	- Right click the folder containing your data, then click on `Properties`.
+	- In the `General` tab go down to `Attributes`, untick `Read-only` and click `Apply`.
+	- A popup will appear, select `Apply changes to this folder, subfolder and files` and press `OK`.
+	- Finally, click `OK` again to exit out of properties.
+
+	You should end up with a file structure with a few folders only, as follows.
+
+<img src="/img/ddr/setup/1_data.png">
+
+??? warning "If your data doesn't look like this"
+
+	If you're missing the `modules` folder and instead have bunch of `.dll` files next to your folders:  
+
+	- Create a `modules` folder.
+	- Move all `.dll` files inside of it so you end up with a structure as shown above.
+
+	If extra files are present next to your folders, such as executables, scripts, etc.. **remove them**.  
+	**This also means your data was tampered with and we strongly recommend getting new data from somewhere else.**
+
+---
+### Updating data
+
+??? danger "Please make sure you're using the right update for your current data."
+
+	DDR Patches re-uploaded by the community tend to be appropriately named `MDX-DATECODE-to-DATECODE`.
+
+	For example `MDX-2024091000-to-2024101500`.
+
+	- `2024091000` being your current data's version.
+	- `2024101500` being the one you would arrive at.
+
+!!! tip ""
+
+	- Extract your patch's files to your existing data in a way that matches its file structure. Agree to overwrite files if necessary.
+	- Open `prop\ea3-config.xml` in a text editor and find the following lines near the top.
+
+	```xml
+		<soft>
+			<model __type="str">MDX</model>
+			<dest __type="str">J</dest>
+			<spec __type="str">A</spec>
+			<rev __type="str">A</rev>
+			<ext __type="str">2024101500</ext>
+		</soft>
+	```
+
+	On the line with `<ext __type="str">` the datecode needs to match your new version.
+
+	- If that's already the case then great! Don't touch anything.
+	- If it instead corresponds to your pre-patch datecode, replace it with the new one and save the file.
+
+---
+### Installing Spice2x
+
+!!! info ""
+
+	If you already have Spice2x installed, make sure it is up to date!
+
+??? tip "For MDX-001 (32 bits)"
+
+	- Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release.
+	- Extract the `spice.exe` and `spicecfg.exe` files from the archive to your game's directory.
+  
+	<img src="/img/ddr/setup/2_spicedata32.png">
+
+??? tip "For MDX-003 (64 bits)"
+
+	- Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release.
+	- Extract the `spice64.exe` and `spicecfg.exe` files from the archive to your game's directory.
+  
+	<img src="/img/ddr/setup/2_spicedata64.png">
+
+### Configuring Spice2x
+
+!!! info "Open `spicecfg.exe`, each following sub-section corresponds to a tab at the top."
+
+#### Buttons
+
+!!! tip ""
+
+	Click on `Bind` then press the key you want associated with the action.
+
+	With your controller and/or keyboard plugged in, configure your keys for:  
+
+	- **Maintenance**: `Service, Test`
+	- **P1 Panel buttons**: `Up, Down, Left, Right` 
+	- **P1 Menu buttons**: ` Start, Up, Down, Left, Right`
+	- **P1 Keypad**: `1 to 9, Keypad Insert Card`
+
+#### Overlay
+
+!!! tip ""
+
+	Modifying buttons in this section is not required but you are free to change what you want.
+
+	Click on `Bind` then press the key you want associated with the action.
+
+#### Lights (controller/cab only)
+
+!!! tip ""
+
+	Your controller might support having its lights controlled by the game through spice2x.
+
+	If it does, here's how you may link different actions to your lights:
+
+	- Click `Bind`.
+	- In `Device`, pick your controller.
+	- In `Light Control`, select the corresponding light.
+	- Click `Close`.
+	- Repeat for your other lights.
+
+#### Cards
+
+!!! info "Covered in the [Connecting to a network](#connecting-to-a-network) section."
+
+#### Patches
+
+!!! info "Go through the [Spice2x Patching](../../../extras/patchsp2x.md) page to import patches."
+
+!!! danger "To prevent issues, avoid patching things you don't need or understand."
+
+#### API
+
+!!! warning "Leave everything at default unless you know what you're doing."
+
+#### Options
+
+!!! info "If you don't know what an option does, hover over the question mark at the very left."
+
+	<img src="/img/ddr/setup/3_opthover.png">
+
+!!! danger "Be very careful changing options you don't understand as it may cause issues."
+
+!!! tip "Required"
+
+	| Category 		| Option 				| Parameter 		| Setting |
+	|---------------|-----------------------|-------------------|---------|
+	| Network		| EA Service URL		| -url				| Covered in [Connecting to a network](#connecting-to-a-network) |
+
+!!! tip "Highly Recommended for NVIDIA users ONLY"
+
+	| Category 			| Option 							| Parameter 	| Setting |
+	|-------------------|-----------------------------------|---------------| 		  |
+	| Graphics (common)	| NVIDIA profile optimization	 	| -nvprofile 	| ON	  |
+
+
+#### Advanced & Development
+
+!!! warning "Leave everything at default unless you know what you're doing."
+
+---
+### Connecting to a network
+
+!!! danger "Please choose one of the two solutions, not both!"
+
+??? tip "Remote (Online Network)"
+
+	Open `spicecfg.exe` and head to the `Options` tab.
+  
+	In the `Network` category, set the following settings: 
+	
+	- `EA Service URL` to the URL provided by your network.
+	- `PCBID` to the PCBID provided by your network.
+	
+	<img src="/img/ddr/setup/4_network.png">
+
+	Next you need a card number.  
+	If you don't already have one, generate one in the `Cards` tab.  
+	To keep your card number safe, create a new `.txt` file with ONLY it inside.
+
+	Once that's done, head to the `Cards` tab, for `Player 1` click `Open...` and point to your text file.
+
+	<img src="/img/ddr/setup/4_cards.png">
+
+??? tip "Local e-amuse Emulator (Asphyxia)"
+
+	This is covered in the [Asphyxia CORE](../../../extras/asphyxia.md) page.
+
+---
+### Pre-launch requirements
+
+!!! info "These steps are required, otherwise your game won't run."
+
+#### VCRedist & DirectX
+
+!!! tip ""	
+
+	- Download and install the latest [VCRedist](https://github.com/abbodi1406/vcredist/releases/latest) (`VisualCppRedist_AIO_x86_x64.exe`)
+	- Download and install the [DirectX End-User Runtimes](https://www.microsoft.com/en-us/download/details.aspx?id=8109)
+
+#### K-lite Codec Pack
+
+!!! tip ""	
+
+	- Download and install the [K-lite Codec Pack](https://codecguide.com/download_kl.htm) (the Standard version is enough)
+
+---
+### Troubleshooting
+
+!!! warning "Have any other issue?"
+
+	Check out the [Troubleshooting](troubleshooting.md) and [Error Codes](../../../errorcodes/bemani.md) pages.

docs/games/ddr/troubleshooting.md

@@ -0,0 +1,33 @@
+!!! danger "Warning"
+
+	Please make sure you downloaded your data from an appropriate source.
+	This guide is unable to troubleshoot any problems related to bad or poorly managed data.
+
+---
+### Clock error
+
+!!! tip ""
+
+	In the test menu, navigate to `CLOCK`, and set it to match your computer's time.
+
+---
+### My game is running slow/lagging
+
+!!! tip ""
+
+	Try to eliminate any unnecessary background processes during play.
+
+---
+### Unable to login / Eamuse error / Network error
+
+!!! tip ""
+
+	Get the proper Asphyxia plugin from our [Discord server](https://discord.gg/cZRUmEPK78) in the #ddr channel > Resources post.
+	Make sure you didn't enable `-smartea` in spicecfg's options.
+
+---
+###  Where are the option for Dancers/Shading/Measure lines/Fast-Slow/Layering?
+
+!!! tip ""
+
+	These options are locked behind network requirements and will not be displayed unless you are connected to a network that has written support for these options. Patches are available to mitigate this (see [Patches](setup.md#patches)).

docs/games/ddr/world/setup.md

@@ -0,0 +1,6 @@
+# Game Setup (DDR WORLD)
+<div style="text-align: center;">
+    <img src="/img/ddr/world.png" width="50%">
+</div>
+
+--8<-- "docs/games/ddr/setup.md"

docs/games/ddr/world/troubleshooting.md

@@ -0,0 +1,6 @@
+# Troubleshooting (DDR WORLD)
+<div style="text-align: center;">
+    <img src="/img/ddr/world.png" width="50%">
+</div>
+
+--8<-- "docs/games/ddr/troubleshooting.md"

docs/games/ddrace/problems.md

@@ -1,65 +0,0 @@
-# DDR Ace Common Problems/Tips
-
-### Hardware Specs
-
-!!! tip ""
-	Bemani PC Type 4
-
-	CPU: Celeron M 440 1.86GHz
-
-	GPU: ATI Radeon HD 2400
-
-	RAM: 2 GB
-
-	OS: Windows XP Embedded
-
-### My Game Is Running Slow/Lagging
-
-!!! tip ""
-	Make sure you at least meet the above hardware requirements, try to eliminate any unnecessary background processes during play as well.
-
-### Ddr a's Video Background Are Missing in the Menus And/Or Some Songs Soft-Lock the Game on the Nth/Final/Extra Stage Screen
-
-!!! tip ""
-	DDR's Video backgrounds rely on two DLLs in the game's "com" folder. However, unlike most other Bemani AC Games, these DLLs must be registered (Windows must know that these files exist, and where to point to when they are called). Without these, the game will run, but songs that rely on FMV backgrounds will break and the menu's backgrounds will be blank.
-
-
-	There are two ways to fix this: You can either install the [K-lite Codec Pack](https://codecguide.com/download_kl.htm) (which gives the added bonus of enabling playback of weird esoteric video formats outside of the game) or register the DLLs for the game manually, if you wish to save space and aren't afraid of the command prompt.
-
-
-	You can download the K-lite codec pack from here: https://www.codecguide.com/download_kl.htm
-	The basic installer is all you need. Simply install the pack and then run DDR A.
-
-
-	To register the DLLs with Windows:
-	
-	1. Open an elevated command prompt (Right click Command Prompt -> Run As Administrator)
-	
-	2. Navigate to your Windows directory (Typically C:/ Windows), then to SysWOW64 (Or System32 if on a 32-bit version of Windows) by typing `cd C:/windows` inside the command prompt
-	
-	3. Type `regsvr32 [path to one of the two DLLs in your DDR A's "content/com/" folder]`
-
-		Ex: `regsvsr32 D:\MDX-2019042200\contents\com k-clvsd.dll`
-	
-	4. Repeat the command for the other DLL in the folder, and then close command prompt
-
-		Ex: `regvsr32 D:\MDX-2019042200\contents\com xactengine2_10.dll`
-	
-	5. If everything went smoothly, run the game again with your desired tools and enjoy a properly working DDR A!
-
-### I Want to Play in 4:3 (SD) Mode!
-
-!!! tip ""
-	If you're using SpiceTools, you can add `-ddrsd` to your `gamestart.bat` file and the game will boot into 4:3 mode.
-
-###  Where Is the Option For Dancers/Shading/Measure lines/Fast-Slow/Layering?
-
-!!! tip ""
-	These options are locked behind network requirements and they will not show unless connected to a network that has written support for these options. Patches exist to alleviate this.
-	
-###  Why Is My Game Not in English?
-
-!!! tip ""
-	English text is built in, change `<dest>J</dest>` in the `eamuse-config.xml` file inside `contents/prop` to `<dest>A</dest>`, then you can change language to English in the service menu's `GAME OPTIONS` (accessed via Spice's `Test` button). If English is not automatically set as pictured below. Make sure the code at the top left upon booting indicates `A:A:A` as desired.
-
-<img src="/img/ddrace/eng.png">

docs/games/ddrace/setup.md

@@ -1,74 +0,0 @@
-# DANCE DANCE REVOLUTION ACE 
-
-!!! danger "Warning"
-
-	Please make sure your data is from an appropriate source and unmodified before proceeding, this guide is unable to troubleshoot any problems related to bad or poorly managed data.
-
-	If you obtained data from a torrent file, make sure you're not seeding the data before proceeding as well.
-
-	Lastly, for demonstrative purposes, this guide uses SpiceTools, you should consult appropriate documentation and requirements of your desired tools as the setup process is likely to be extremely similar.
-
-### Getting Started
-
-!!! tip ""
-
-    This game still uses DirectSound so we can skip audio related setup needed for other games. After downloading your data, the first thing to do is make sure your files aren't set to READ ONLY, make sure to uncheck it from the main folder in the Windows Properties tab if so. Then, put your desired 32-bit tools inside the game's `contents` folder, and to create a `.bat` file. Pictured below is what your folder should look like, feel free to name your `.bat` file anything you desire, for the sake of convenience we've named ours `gamestart.bat`.
-
-<img src="/img/ddrace/1.png">
-
-
-### Configuring Your Tools
-
-!!! tip ""
-
-	Now that you have your files ready, open up your `.bat` file in your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) and edit it with your desired parameters, for the purpose of this guide we will demonstrate both a local network configuration and an online example below with SpiceTools, skip to whichever you're in need of accordingly and please keep in mind you can add whatever additional parameters you desire.
-
-!!! warning "If you're not using SpiceTools:"
-
-	The overall structure of your .bat file will differ from the guide, namely the initialization of SpiceTools won't be present and potential parameters may differ. As stated above, make sure to check the documentation of your tools to ensure you're using the correct parameters for your needs.
-
-### Configuring for a Local Network
-
-!!! tip ""
-
-	For our local network configuration example, on a single line in the `.bat` file we're going to type `spice.exe -ea -w` and save the file. 
-
-	What do these different parameters do?
-
-	- `-ea` enables an integrated e-amusement server within SpiceTools.
-	- `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up!
-
-	Pictured below, the contents of our `gamestart.bat` file in Notepad++.
-
-<img src="/img/ddrace/2.png">
-
-### Configuring for an Online Network
-
-!!! tip ""
-
-	For our online network example we're simply doing the above but with different parameters! On our single line, we're going to type `spice.exe -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. 
-
-	What do these different parameters do? 
-
-	- `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID.
-	- `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL.
-	- `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up!
-
-	Pictured below, the contents of our `gamestart.bat` file in Notepad++.
-
-<img src="/img/ddrace/3.png">
-
-!!! tip ""
-	One final note, since you're playing on a network, you will have one additional step of setting up your card file within your chosen tools, make sure to check your server's information on how to setup a card file.
-
-### Final Steps and Setting up the Game
-
-!!! tip ""
-
-	One last important note before booting the game is that you should install K-Lite Mega Codec (See [Common Problems/Tips](problems.md#ddr-as-video-background-are-missing-in-the-menus-andor-some-songs-soft-lock-the-game-on-the-nthfinalextra-stage-screen) for a guide!) before booting, the game will run without it, but some songs will lock up and the game will crash and all background videos will be black on most setups.
-	
-	With that, you're all done! The final step you'll have to do with your chosen tools is simply setting up your desired keybinds! Once you've done that, Boot the game with your `gamestart.bat` and the game should load and be ready to be enjoyed! Have fun!
-
-!!! warning "Have any other errors?"
-
-	Check out the [Common Problems/Tips](problems.md) section and [Error Code](../../errorcodes/bemani.md) section to resolve any issues not seen in this guide to greater depth.

mkdocs.yml

@@ -75,9 +75,18 @@ nav:
           - "First Time Setup": "games/hellopopn/setup.md"
           - "Common Problems/Tips": "games/hellopopn/problems.md"
       - "DDR":
-        - "DDR Ace":
-          - "First Time Setup": "games/ddrace/setup.md"
-          - "Common Problems/Tips": "games/ddrace/problems.md"
+        - "DDR A20":
+          - "Game Setup": "games/ddr/a20/setup.md"
+          - "Troubleshooting": "games/ddr/a20/troubleshooting.md"
+        - "DDR A20 PLUS":
+          - "Game Setup": "games/ddr/a20plus/setup.md"
+          - "Troubleshooting": "games/ddr/a20plus/troubleshooting.md"
+        - "DDR A3":
+          - "Game Setup": "games/ddr/a3/setup.md"
+          - "Troubleshooting": "games/ddr/a3/troubleshooting.md"
+        - "DDR WORLD":
+          - "Game Setup": "games/ddr/world/setup.md"
+          - "Troubleshooting": "games/ddr/world/troubleshooting.md"
       - "Jubeat":
         - "Jubeat Clan":
           - "First Time Setup": "games/jubeatclan/setup.md"
@@ -203,6 +212,7 @@ not_in_nav: |
   games/mu3
   games/mercury
   games/mai2
+  games/ddr
 
 theme:
   name: material