Merge pull request #135 from auxbh/feature/jubeat

Update the jubeat guide to new standards

docs/errorcodes/bemani.md

@@ -94,7 +94,7 @@
 
     Setup error in pop'n Usaneko. Follow [Game Setup](/games/bemani/popn/usaneko/setup.md) and use proper `-url` and `-p` parameters in SpiceTools.
 
-## Jubeat
+## jubeat
     
 ### 5-2500-0000
 

docs/extras/datamods.md

@@ -33,7 +33,7 @@
 
     If you're confused, the following may help you understand what this means.
 
-    ```
+    ``` hl_lines="6-11"
     📂data
     ┣━📂graphic
     ┣━📂info
@@ -41,10 +41,10 @@
     ┗━📂sound
     📂data_mods 
     ┗━📂mod_folder
-       ┣━📂graphic <--- Files that modify data/graphic go here
-       ┣━📂info <--- Files that modify data/info go here
-       ┣━📂movie <--- Files that modify data/movie go here
-       ┗━📂sound <--- Files that modify data/sound go here
+       ┣━📂graphic - Files that modify data/graphic go here
+       ┣━📂info    - Files that modify data/info go here
+       ┣━📂movie   - Files that modify data/movie go here
+       ┗━📂sound   - Files that modify data/sound go here
     📂dev
     📂modules
     📂prop

docs/games/bemani/ddr/common/setup.md

@@ -63,14 +63,14 @@
     - Visit [spice2x.github.io](https://spice2x.github.io) to download the latest release
     - Extract both `spice.exe` and `spicecfg.exe` from the archive into your game's directory
   
-    ```
+    ``` hl_lines="6-7"
     📂arkdata
     📂com
     📂data
     📂modules
     📂prop
-    🌶️spice.exe <---
-    🌶️spicecfg.exe <---
+    🌶️spice.exe
+    🌶️spicecfg.exe
     ```
 
 ??? tip "For MDX-003 (64 bits)"
@@ -78,14 +78,14 @@
     - Visit [spice2x.github.io](https://spice2x.github.io) to download the latest release
     - Extract both `spice64.exe` and `spicecfg.exe` from the archive into your game's directory
   
-    ```
+    ``` hl_lines="6-7"
     📂arkdata
     📂com
     📂data
     📂modules
     📂prop
-    🌶️spice64.exe <---
-    🌶️spicecfg.exe <---
+    🌶️spice64.exe
+    🌶️spicecfg.exe
     ```
 
 ## Configuring spice2x

docs/games/bemani/iidx/common/31plus/setup.md

@@ -50,13 +50,13 @@
 
 --8<-- "docs/snippets/bemani/common/spice2x64_install.md"
 
-    ```
+    ``` hl_lines="5-6"
     📂data
     📂dev
     📂modules
     📂prop
-    🌶️spice64.exe <---
-    🌶️spicecfg.exe <---
+    🌶️spice64.exe
+    🌶️spicecfg.exe
     ```
 
 --8<-- "docs/snippets/bemani/common/spice2x64_stubs.md"

docs/games/bemani/jubeat/avenue/setup.md

@@ -0,0 +1,2 @@
+<img class="header-logo" src="/img/bemani/jubeat/avenue/logo.webp">
+--8<-- "docs/games/bemani/jubeat/common/setup.md"

docs/games/bemani/jubeat/beyondtheavenue/setup.md

@@ -0,0 +1,2 @@
+<img class="header-logo" src="/img/bemani/jubeat/beyondtheavenue/logo.webp">
+--8<-- "docs/games/bemani/jubeat/common/setup.md"

docs/games/bemani/jubeat/clan/setup.md

@@ -1,81 +0,0 @@
-<img class="header-logo" src="/img/bemani/jubeat/clan/logo.webp">
-# Game Setup
-
---8<-- "docs/snippets/common/old_guide.md"
-
---8<-- "docs/snippets/common/data_warning.md"
-
-## Getting Started
-
-!!! tip ""
-    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 main 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/bemani/jubeat/clan/1.webp">
-
-## 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` and save the file. 
-
-    What do these different parameters do?
-
-    - `-ea` enables an integrated e-amusement server within SpiceTools.
-
-    Pictured below, the contents of our `gamestart.bat` file in Notepad++.
-
-<img src="/img/bemani/jubeat/clan/2.webp">
-
-## 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/` 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.
-
-    Pictured below, the contents of our `gamestart.bat` file in Notepad++.
-
-<img src="/img/bemani/jubeat/clan/3.webp">
-
-!!! 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.
-
-    If it's your first time running the game, you'll immediately be greeted with this screen (cropped to save your sanity with scrolling repeatedly on the page), oh no!
-
-<img src="/img/bemani/jubeat/clan/5.webp">
-
-!!! tip ""
-    This is okay, you can use your mouse or touchscreen to simply hit `TEST` to initialize the backup data, the game will prompt you to reboot, but let's save ourselves some time and instead go into the `GAME OPTIONS` menu instead, as shown below. If you rebooted, you will see a message telling you to set the "Shop Settings" which is what we're going to now do, as shown below.
-
-<img src="/img/bemani/jubeat/clan/7.webp">
-
-!!! tip ""
-    Enter the `GAME OPTIONS` menu and proceed to the `SHOP SETTINGS` menu.
-
-<img src="/img/bemani/jubeat/clan/8.webp">
-
-!!! tip ""
-    From here, we will need to set the `SHOP NAME SETTINGS`. This is a simple process, simply navigate using the controls in the menu to set any name you desire! For the purpose of the guide, we named it `Guide` but highly encourage fun and/or lazy names. Lastly, if you're not connected to an online network, you'll need to set the `SHOP AREA` as well, navigate to any option you prefer, they're all predefined so you can't get creative here, pictured below is what we set ours to.
-
-<img src="/img/bemani/jubeat/clan/9.webp">
-
-!!! tip ""
-    With that, you're all done! Simply exit the service menu or reboot then enjoy the game, 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.

docs/games/bemani/jubeat/clan/troubleshooting.md

@@ -1,39 +0,0 @@
-<img class="header-logo" src="/img/bemani/jubeat/clan/logo.webp">
-# Troubleshooting
-
---8<-- "docs/snippets/common/old_guide.md"
-
---8<-- "docs/snippets/common/data_warning.md"
-
-## Hardware Specs
-
-!!! tip ""
-    Bemani PC (ADE-704A)
-
-    This board has a E4690 Radeon MXM card.
-
-    CPU: Intel Celeron B810
-
-    GPU: AMD Radeon E4690
-
-    Chipset: Intel HM65
-
-### 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.
-
-### My Game Is Running Crazy Fast!
-
-!!! tip ""
-    The most common reason for this is the game is running over its required 60 Hz, the game is hardcoded to run at 60 Hz and this cannot be changed. To solve this, set your monitor's refresh rate to 60 Hz. 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 60 Hz, consider trying a different panel or forcing vsync on in your GPU's graphics settings.
-
-### Occasional Game Stutters During Play
-
-!!! 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.
-
-### My Touchscreen Isn't Working!
-
-!!! tip ""
-    There's a myriad of reasons for this. With SpiceTools in most cases, try using the `-wintouch` parameter if rawinput is not working for your monitor. 

docs/games/bemani/jubeat/common/setup.md

@@ -0,0 +1,175 @@
+# Game Setup
+
+--8<-- "docs/snippets/common/data_warning.md"
+
+## Preparing data
+
+--8<-- "docs/snippets/common/data_readonly.md"
+
+    The **complete game data** should be approximately **10 GB or larger**.  
+    If your data is significantly smaller, you likely have an update archive instead of the full game data.
+
+    Here's what the expected data structure should look like: 
+
+    ```
+    📂data
+    📂modules
+    📂prop
+    ⚙️msvcr100.dll
+    ```
+
+!!! danger "If your data does not look like this"
+
+    If you have **other** `.dll` files next to your `data`, `prop`, etc., folders:
+
+    - Create a `modules` folder if it does not exist already
+    - Move all `.dll` files into it
+
+    If extra directories or files are still present (executables, scripts, etc.), **remove them**.
+
+    **This also indicates tampered data, we strongly recommend obtaining clean data from elsewhere.**
+
+!!! info "If your data is already up-to-date, you can skip ahead to the [Installing spice2x](#installing-spice2x) section"
+
+## Updating data
+
+!!! danger "Make sure you're using the right update for your current game version"
+
+    jubeat updates have `L44` and one or two datecodes in their archive names.
+
+    **Single datecode:** Contains one update (e.g., `L44_NewDateCode.7z`)  
+    **Two datecodes:** Updates from the older to newer version (e.g., `L44_OldDateCode-NewDateCode.rar`)
+
+    A date code should look something like this: `YYYYMMDDXX`
+
+    In the two-datecode example:
+
+    - `OldDateCode` is the older date, the game version required to apply this update
+    - `NewDateCode` is the newer date, and is the version you'll arrive at after applying the update
+
+--8<-- "docs/snippets/bemani/common/data_update.md"
+
+## Installing spice2x
+
+--8<-- "docs/snippets/bemani/common/spice2x32_install.md"
+
+    ``` hl_lines="5-6"
+    📂data
+    📂modules
+    📂prop
+    ⚙️msvcr100.dll
+    🌶️spice.exe
+    🌶️spicecfg.exe
+    ```
+
+--8<-- "docs/snippets/bemani/common/spice2x32_stubs.md"
+
+## Configuring spice2x
+
+--8<-- "docs/snippets/bemani/common/spicecfg_preamble.md"
+
+=== "Buttons"
+
+--8<-- "docs/snippets/bemani/common/spicecfg_buttons.md"
+
+    !!! tip "Binding your buttons"
+
+        Click on `Bind` or `Naive` 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`
+        - **Game buttons**: `Button 1 to Button 16`
+        - **Keypad**: `Keypad Insert Card`
+
+    !!! tip "Using a touch screen" 
+
+        spice2x supports using a touch screen instead of the 16 game buttons. In that case, you don't need to bind these buttons.
+  
+--8<-- "docs/snippets/bemani/common/spicecfg_buttons_additionalinfo.md"
+
+=== "Analogs"
+
+--8<-- "docs/snippets/bemani/common/spicecfg_nochange.md"
+
+=== "Overlay"
+
+--8<-- "docs/snippets/bemani/common/spicecfg_overlay.md"
+
+=== "Lights"
+
+--8<-- "docs/snippets/bemani/common/spicecfg_lights.md"
+
+=== "Cards"
+
+--8<-- "docs/snippets/bemani/common/spicecfg_cards.md"
+
+=== "Patches"
+
+--8<-- "docs/snippets/bemani/common/spicecfg_patches.md"
+
+=== "API"
+
+--8<-- "docs/snippets/bemani/common/spicecfg_nochange.md"
+
+=== "Options"
+
+--8<-- "docs/snippets/bemani/common/spicecfg_options_nvprofile.md"
+
+=== "Advanced"
+
+--8<-- "docs/snippets/bemani/common/spicecfg_nochange.md"
+
+=== "Development"
+
+--8<-- "docs/snippets/bemani/common/spicecfg_nochange.md"
+
+## Connecting to a network
+
+--8<-- "docs/snippets/bemani/common/setup_network.md"
+
+## Installing VCRedist & DirectX
+
+--8<-- "docs/snippets/common/setup_vcredist_directx.md"
+
+## Before playing
+
+--8<-- "docs/snippets/common/before_playing.md"
+
+## First launch
+
+!!! tip ""
+
+    If you've followed all instructions correctly, you're now finally ready to launch the game!
+
+    **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/jubeat/common/firstlaunch/backup_data_error.webp">
+
+    Press your `Test` key to initialize the backup data, another message with the same error will pop up.  
+    Press your `Test` key again to open the service menu.
+
+    Instructions on how to navigate the menu are shown on the screen.
+  
+    Go to `GAME OPTIONS`, then `SHOP SETTINGS`.
+
+    <img src="/img/bemani/jubeat/common/firstlaunch/shop_settings.webp">
+
+    You will need to set a shop name.
+    
+    - Name your shop to whatever you'd like. Again, navigation instructions are on the screen.
+    - Press the `EXIT` button.
+
+    Then, set the shop area to whatever region you'd like.
+
+    Select `SAVE AND EXIT` then `EXIT`.
+
+    Finally, select `GAME MODE`.
+    
+!!! success "You're all done! The game should load up properly now"
+
+## Help
+
+--8<-- "docs/snippets/common/help.md"

docs/games/bemani/jubeat/festo/setup.md

@@ -0,0 +1,2 @@
+<img class="header-logo" src="/img/bemani/jubeat/festo/logo.webp">
+--8<-- "docs/games/bemani/jubeat/common/setup.md"

docs/games/bemani/museca/1plushalf/setup.md

@@ -24,13 +24,13 @@
 
 --8<-- "docs/snippets/bemani/common/spice2x64_install.md"
 
-    ```
+    ``` hl_lines="5-6"
     📂data
     📂dev
     📂modules
     📂prop
-    🌶️spice64.exe <---
-    🌶️spicecfg.exe <---
+    🌶️spice64.exe
+    🌶️spicecfg.exe
     ```
 
 --8<-- "docs/snippets/bemani/common/spice2x64_stubs.md"

docs/games/bemani/popn/common/setup.md

@@ -44,13 +44,13 @@
 
 --8<-- "docs/snippets/bemani/common/spice2x32_install.md"
 
-    ```
+    ``` hl_lines="5-6"
     📂data
     📂dev
     📂modules
     📂prop
-    🌶️spice.exe <---
-    🌶️spicecfg.exe <---
+    🌶️spice.exe
+    🌶️spicecfg.exe
     ```
 
 ## Configuring spice2x

docs/games/bemani/sdvx/6_exceedgear/setup.md

@@ -46,14 +46,14 @@
 
 --8<-- "docs/snippets/bemani/common/spice2x64_install.md"
 
-    ```
+    ``` hl_lines="6-7"
     📂data
     📂dev
     📂ext
     📂modules
     📂prop
-    🌶️spice64.exe <---
-    🌶️spicecfg.exe <---
+    🌶️spice64.exe
+    🌶️spicecfg.exe
     ```
 
 --8<-- "docs/snippets/bemani/common/spice2x64_stubs.md"

docs/snippets/bemani/common/data_bad.md

@@ -1,6 +1,6 @@
 !!! danger "If your data does not look like this"
 
-    If you have `.dll` files next to your `data`, `prop`, etc. folders:
+    If you have `.dll` files next to your `data`, `prop`, etc., folders:
 
     - Create a `modules` folder if it does not exist already
     - Move all `.dll` files into it

mkdocs.yml

@@ -91,10 +91,13 @@ nav:
         - "WORLD":
           - "Game Setup": "games/bemani/ddr/world/setup.md"
           - "Troubleshooting": "games/bemani/ddr/world/troubleshooting.md"
-      - "Jubeat":
-        - "Clan":
-          - "Game Setup": "games/bemani/jubeat/clan/setup.md"
-          - "Troubleshooting": "games/bemani/jubeat/clan/troubleshooting.md"
+      - "jubeat":
+        - "festo":
+          - "Game Setup": "games/bemani/jubeat/festo/setup.md"
+        - "Ave.":
+          - "Game Setup": "games/bemani/jubeat/avenue/setup.md"
+        - "beyond the Ave.":
+          - "Game Setup": "games/bemani/jubeat/beyondtheavenue/setup.md"
       - "GITADORA":
         - "Matixx":
           - "Game Setup": "games/bemani/gitadora/matixx/setup.md"
@@ -282,6 +285,7 @@ not_in_nav: |
   games/bemani/sdvx/common
   games/bemani/ddr/common
   games/bemani/popn/common
+  games/bemani/jubeat/common
   games/sega/chunithm/common
   games/sega/maimaidx/common
   games/sega/ongeki/common