Merge pull request #105 from obvRedwolf/feature/sinobuz

Modernize IIDX 24 guide.

docs/games/bemani/iidx/24_sinobuz/extras.md

@@ -0,0 +1,48 @@
+# beatmania IIDX 24 SINOBUZ
+<img class="header-logo" src="/img/bemani/iidx/24_sinobuz/logo.png">
+
+!!! danger "Please make sure you downloaded your data from an appropriate source.<br>This guide is unable to troubleshoot any problems related to bad or poorly managed data."
+
+---
+### More about ea3-config.xml
+
+!!! tip ""
+
+    The `ea3-config.xml` file is located inside the `prop` folder. 
+
+    Below is an explanation on what different sections of this file do.
+
+    The following lines change the PCBID and HARDID that your system reports to your e-amusement server.  
+    There is ^^**no need to manually change this**^^ as `spice2x` will do it for us.
+    
+    ```xml
+    <pcbid __type="str">00010203040506070809</pcbid>
+    <hardid __type="str">00010203040506070809</hardid>
+    ```
+
+    The following line determines what version of the game you are running.  
+    ^^**You should never change this**^^. It should always say `LDJ`.
+
+    ```xml
+    <model __type="str">LDJ</model>
+    ```
+
+    ^^**You should never change this**^^. It should always say `A` for SINOBUZ.
+
+    ```xml
+    <rev __type="str">A</rev>
+    ```
+
+    The following line determines your datecode.  
+    ^^**Always keep it up to date**^^ with your game's current version.
+
+    ```xml
+    <ext __type="str">2017082800</ext>
+    ```
+
+    The following line determine what remote service URL `spice2x` is supposed to connect to.  
+    There is ^^**no need to manually change this**^^ as `spice2x` will do it for us.
+
+	```xml
+	<services __type="str">http://localhost:8083</services>
+    ```

docs/games/bemani/iidx/24_sinobuz/setup.md

@@ -1,113 +1,299 @@
 # beatmania IIDX 24 SINOBUZ
 <img class="header-logo" src="/img/bemani/iidx/24_sinobuz/logo.png">
 
-!!! 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.
+!!! danger "Please make sure you downloaded your data from an appropriate source.<br>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.
+---
+### Preparing data
 
-	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.
+!!! 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/bemani/iidx/24_sinobuz/data.png">
+
+??? warning "If your data doesn't look like this"
+
+	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.**
+
+---
+### Installing Spice2x
+
+!!! info ""
+
+	If you already have Spice2x installed, make sure it is up to date!
+
+!!! tip ""
+
+	- 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/bemani/iidx/24_sinobuz/spice2xdata.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 Game buttons**: `1 to 7, Start, EFFECT, VEFX` 
+	- **P1 Keypad**: `1 to 9, Keypad Insert Card` 
+
+	**Only if** you're playing using a keyboard:
+
+	- **Turntable**: `TT+, TT-` **and optionally** `TT+/-` which alternates between `TT+` and `TT-` on each press.
+  
+#### Analogs (controller/cab only)
+
+!!! tip ""
+
+	With a controller rather than binding buttons to `TT+` and `TT-`, you need to:
+
+	- For Turntable P1, click `Bind`.
+	- In `Device`, pick your controller.
+	- In `Control`, pick whichever one corresponds to the turntable.
+	- Turn your turntable ensuring that the Preview turns along with it.
+	- Click `Close`, leaving the rest of the settings alone.
+
+#### 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/common/spice2x_option_hover.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: 
 	
-!!! note "Note:"
-	This game uses **32-bit** tools!
-
-
-### Getting Started
-
-!!! tip ""
+	- `EA Service URL` to the URL provided by your network.
+	- `PCBID` to the PCBID provided by your network.
 	
-	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 whatever you desire, for the sake of convenience we've named ours `gamestart.bat`.
+	<img src="/img/common/spice2x_network.png">
 
-<img src="/img/bemani/iidx/24_sinobuz/1.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.
 
-### Configuring Your Tools
+	Once that's done, head to the `Cards` tab, for `Player 1` click `Open...` and point to your text file.
+
+	<img src="/img/common/spice2x_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)
+
+#### Audio
 
 !!! 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.
+	- Open `spicecfg.exe`.
+	- At the very top, click on `Shortcuts` then `Audio Playback Devices`.
+	- In the popup window, right click on your default audio device, and click on `Properties`.
+	- Go to the `Advanced` tab.
+	- Check both boxes under `Exclusive Mode`.
+	- Open the `Default Format` dropdown.
+	- Pick the `24 bit, 44100 Hz (CD Quality)` option and click `Apply` then `OK`.
 
-### Configuring for a Local Network
+	<img src="/img/common/audio_24_441.png">
+
+---
+### First launch
+
+!!! danger "If you have any issues running the game, refer to the [Troubleshooting](troubleshooting.md) page."
+
+#### BACKUP DATA
 
 !!! 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?
+	If you've followed all instructions correctly, you're now finally ready to launch the game!
 
-	- `-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/bemani/iidx/24_sinobuz/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/bemani/iidx/24_sinobuz/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 ""
-	The last steps you'll have to do with your chosen tools is simply setting up your desired keybinds! Make sure you setup the `Test` keybind as it will be critical for setting up the game. Once you've done that, launch your game for the first time by double clicking the `.bat` you setup and the game should load.
+	**First plug your controller if you have one** and run `spice.exe`, press `Yes` when it asks for elevated privileges.
 
 	If it's your first time running the game, you'll immediately be greeted with this screen.
 
-<img src="/img/bemani/iidx/24_sinobuz/4.png">
+<img src="/img/bemani/iidx/common/oldhd/firstlaunch/1.png">
+
+#### CLOCK ERROR
+
+!!! tip "" 
+
+	Press your `Test` key to initialize the backup data, a message will pop up stating it's been initialized.
+
+	Next, you'll get another error.
+
+<img src="/img/bemani/iidx/common/oldhd/firstlaunch/2.png">
 
 !!! tip ""
-	Hit the `Test` keybinding to initialize the backup data, a message will pop up stating it's been initialized.
 
-<img src="/img/bemani/iidx/24_sinobuz/5.png">
+	Let the game run for a bit until the monitor check is complete and you should be taken to the service menu.
+
+<img src="/img/bemani/iidx/common/oldhd/firstlaunch/3.png">
 
 !!! tip ""
-	Lastly, you'll run into this error message as well, let's work on eliminating these messages. Let the game run for a bit until the monitor check is complete and you should be taken to the service menu pictured below.
 
-<img src="/img/bemani/iidx/24_sinobuz/6.png">
+	Instructions on how to navigate the menu are shown at the bottom of the screen.
+
+	- Press `1` and `2` to go up and down.
+	- Press `6` to select/execute.
+  
+	Start by going up to `CLOCK`.
+
+<img src="/img/bemani/iidx/common/oldhd/firstlaunch/4.png">
 
 !!! tip ""
-	Start by navigating up to `CLOCK` and entering that menu.
 
-<img src="/img/bemani/iidx/24_sinobuz/7.png">
+	Here, simply select `SAVE AND EXIT` and the clock will be set.
+
+	You'll be back in the service menu.
+#### DEFINITION TYPE
 
 !!! tip ""
-	Simply hit save and exit and leave, the clock will be saved. Then, back in the service menu, go up to `GAME OPTIONS`
 
-<img src="/img/bemani/iidx/24_sinobuz/8.png">
+	Go to `GAME OPTIONS` then `DEFINITION TYPE`.
 
 !!! tip ""
-	Once inside that menu, navigate your way up to `DEFINITION TYPE` and choose either `HD` or `HD*` depending on your preferences, both run the game at 720p but have a timing difference addressed on the FAQ page. It might be worth noting that the `HD*` option is no longer present as of beatmania IIDX 26 ROOTAGE.
 
-<img src="/img/bemani/iidx/24_sinobuz/9.png">
+	Choose either `HD` or `HD*` depending on your preferences.
+
+	`HD*` adds `+1.0` offset in-game, while `HD` doesn't.
+
+<img src="/img/bemani/iidx/common/oldhd/firstlaunch/5.png">
 
 !!! tip ""
-	The game will then count down asking you to confirm the selection before reverting, just hit `YES` assuming it loaded just fine on your computer. Then, exit out of that menu and head to `NETWORK OPTIONS` from back inside the service menu.
 
-<img src="/img/bemani/iidx/24_sinobuz/10.png">
+	Once done selecting, select `YES` then `SAVE AND EXIT`.
+
+<img src="/img/bemani/iidx/common/oldhd/firstlaunch/6.png">
+
+#### NETWORK OPTIONS
 
 !!! tip ""
-	From here, we will need to set a shop name to play, so select the `SHOP NAME SETTING` option. Once inside, name your shop whatever you desire! For the purpose of the guide, we named it `Guide` but highly encourage fun and/or lazy names. Once that's done go to `EXIT` and then `SAVE AND EXIT` inside of `NETWORK OPTIONS` once you've chosen your desired name, as pictured below.
 
-<img src="/img/bemani/iidx/24_sinobuz/11.png">
+	Go to `NETWORK OPTIONS` then `SHOP NAME SETTING`.
 
-<img src="/img/bemani/iidx/24_sinobuz/12.png">
+<img src="/img/bemani/iidx/common/oldhd/firstlaunch/7.png">
+<img src="/img/bemani/iidx/common/oldhd/firstlaunch/8.png">
 
 !!! tip ""
-	You're all done! From the service menu select `GAME MODE` and the game should load ready to be played! Have fun!
 
-!!! warning "Have any other errors?"
-	Check out the [Troubleshooting](troubleshooting.md) section and [Error Code](/errorcodes/bemani.md) section to resolve any issues not seen in this guide to greater depth.
+	We will need to set a shop name.
+	
+	- Name your shop to whatever you'd like. Instructions on how to navigate are at the bottom of the screen.
+	- Go to `EXIT` then `SAVE AND EXIT`.
+
+<img src="/img/bemani/iidx/common/oldhd/firstlaunch/9.png">
+<img src="/img/bemani/iidx/common/oldhd/firstlaunch/10.png">
+
+!!! tip ""
+
+	Select `GAME MODE`.
+	
+	You're all done! The game should load up properly now.
+
+---
+### Carding in
+
+!!! tip ""
+	To card into the game:
+	
+	1. Press your `Keypad Insert Card` button.
+	2. Enter your code using your keypad binds.
+
+---
+### Troubleshooting
+
+!!! warning "Have any other issue?"
+
+	Check out the [Troubleshooting](troubleshooting.md) and [Error Codes](/errorcodes/bemani.md) pages.
+
+	For any more game-specific information, check out [Extra Information](extras.md).

docs/games/bemani/iidx/24_sinobuz/troubleshooting.md

@@ -1,53 +1,38 @@
 # beatmania IIDX 24 SINOBUZ
 <img class="header-logo" src="/img/bemani/iidx/24_sinobuz/logo.png">
 
-### Hardware Specs
+!!! danger "Please make sure you downloaded your data from an appropriate source.<br>This guide is unable to troubleshoot any problems related to bad or poorly managed data."
 
-!!! danger "Warning:"
-	The specs may not be correct. If something isn't correct or it's fine, [let me know](https://github.com/two-torial/two-torial/issues/1).
+---
+### I'm having performance issues!
 
 !!! tip ""
-	Bemani PC (ADE-704A)
 
-	Konami (2012-2017)
+    If you're having performance issues of some kind, spice2x's [PC optimization](https://github.com/spice2x/spice2x.github.io/wiki/PC-optimization) guide is worth looking at.
 
-	This board has a E4690 Radeon MXM card.
-
-	CPU: Intel Celeron B810
-
-	GPU: AMD Radeon E4690
-	
-	NIC: Realtek RTL8168/8111
-	
-	Chipset: Intel HM65
-
-	RAM: 4 GB
-
-	OS: Windows XP Embedded with Service Pack 2
-	
-### My Game Is Running Slow/Lagging
+---
+### My game is running slow/fast, After finishing a song the game gets stuck loading!
 
 !!! tip ""
-	Make sure you at least meet the above hardware requirements, try to eliminate any unnecessary background processes during play as well.
 
-### My Game Is Running Crazy Fast!
+	The most common reason for this is the game is running over its required refresh rate.  
+	To solve this, make sure v-sync isn't disabled in your graphics card's settings.
+
+	For NVIDIA users, enable  `NVIDIA profile optimization (-nvprofile)` in the `Options` tab. 
+
+---
+### How do I set my offset?
 
 !!! tip ""
-	The most common reason for this is the game is running over its required 60hz, the game is hardcoded to run at 60hz and this cannot be changed. To solve this, set your monitor's refresh rate to 60hz. You can always check on the game's monitor check if the game is fluctuating around 59.94hz, the NTSC standard. If it's not around there and your monitor is indeed set to 60hz, consider trying a different panel or forcing vsync on in your GPU's graphics settings.
 
-### Occasional Game Stutters During Play
+	Play through a chart you're comfortable with.
+
+	If you're getting too many `Fast`, increase your offset `(+)`.   
+	If you're getting too many `Slow`, decrease your offset `(-)`.
+
+---
+### My inputs aren't working / I can't get past error messages!
 
 !!! tip ""
-	Sometimes you might have occasional stutters during play, while solutions can vary wildly from general performance issues to bad hard drives, try adding SpiceTools `-realtime` parameter to your .bat file.
-
-### HD and HD*
-
-!!! tip ""
-	This version of IIDX has two HD mode options, `HD` and `HD*` neither is inherently better than the other, the only difference is HD* is an additional + 1.0 offset in-game, the official reasoning is to account for a different set of monitors on arcade cabs. In beatmania IIDX 26 ROOTAGE this option is removed entirely and only HD is present.
-
-### Which Offset Is Which?
-
-!!! tip ""
-	If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-).
-
 
+	If **none** of your inputs are working, try updating [spice2x](https://spice2x.github.io/), you can also try using the beta versions if the stable releases don't work for you.

mkdocs.yml

@@ -30,6 +30,7 @@ nav:
           - "Troubleshooting": "games/bemani/iidx/14_gold/troubleshooting.md"
         - "24 SINOBUZ":
           - "Game Setup": "games/bemani/iidx/24_sinobuz/setup.md"
+          - "Extra Information": "games/bemani/iidx/24_sinobuz/extras.md"
           - "Troubleshooting": "games/bemani/iidx/24_sinobuz/troubleshooting.md"
         - "25 CANNON BALLERS":
           - "Game Setup": "games/bemani/iidx/25_cannonballers/setup.md"