diff --git a/docs/games/konami/iidx/30_resident/setup.md b/docs/games/konami/iidx/30_resident/setup.md index ee4c09b..1da48ac 100644 --- a/docs/games/konami/iidx/30_resident/setup.md +++ b/docs/games/konami/iidx/30_resident/setup.md @@ -1,212 +1,2 @@ -# Game Setup - ---8<-- "docs/snippets/common/data_warning.md" - -## Standard and Lightning modes - ---8<-- "docs/snippets/konami/iidx/ldj_vs_tdj.md" - -## Preparing data - ---8<-- "docs/snippets/common/data_readonly.md" - - The **complete game data** should be approximately **95 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 - 📂dev - 📂modules - 📂prop - ``` - ---8<-- "docs/snippets/konami/common/data_bad.md" - -!!! 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" - - IIDX updates have `LDJ` and one or two datecodes in their archive names. - - **Single datecode:** Contains one update (e.g., `LDJ_NewDateCode.7z`) - **Two datecodes:** Updates from the older to newer version (e.g., `LDJ_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/konami/common/data_update.md" - -## Installing spice2x - ---8<-- "docs/snippets/konami/common/spice2x64_install.md" - - ``` hl_lines="5-6" - 📂data - 📂dev - 📂modules - 📂prop - 🌶️spice64.exe - 🌶️spicecfg.exe - ``` - ---8<-- "docs/snippets/konami/common/spice2x64_stubs.md" - -## Configuring spice2x - ---8<-- "docs/snippets/konami/common/spicecfg_preamble.md" - -=== "Buttons" - ---8<-- "docs/snippets/konami/common/spicecfg_buttons.md" - ---8<-- "docs/snippets/konami/iidx/spicecfg_buttons.md" - ---8<-- "docs/snippets/konami/common/spicecfg_buttons_additionalinfo.md" - -=== "Analogs" - ---8<-- "docs/snippets/konami/iidx/spicecfg_analogs.md" - -=== "Overlay" - ---8<-- "docs/snippets/konami/common/spicecfg_overlay.md" - -=== "Lights" - ---8<-- "docs/snippets/konami/common/spicecfg_lights.md" - -=== "Cards" - ---8<-- "docs/snippets/konami/common/spicecfg_cards.md" - -=== "Patches" - ---8<-- "docs/snippets/konami/common/spicecfg_patches.md" - -=== "API" - ---8<-- "docs/snippets/konami/common/spicecfg_nochange.md" - -=== "Options" - ---8<-- "docs/snippets/konami/iidx/spicecfg_options_disablecams.md" - ---8<-- "docs/snippets/konami/common/spicecfg_options_nvprofile.md" - ---8<-- "docs/snippets/konami/iidx/spicecfg_options_tdj.md" - -=== "Advanced" - ---8<-- "docs/snippets/konami/iidx/spicecfg_advanced_camhook.md" - -=== "Development" - ---8<-- "docs/snippets/konami/common/spicecfg_nochange.md" - -## Configuring audio - ---8<-- "docs/snippets/konami/common/setup_audio.md" - -## Connecting to a network - ---8<-- "docs/snippets/konami/common/setup_network.md" - -## Configuring your game - -!!! info "Read through the [Extra Information](extras.md) page" - -## 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 `spice64.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. - - - - 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. - - - - Press your `Test` key again and let the game run for a bit until the monitor check is complete. - - You will now be taken to the service menu. - - - - 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`. - - - - Here, simply select `SAVE AND EXIT` and the clock will be set. - - You'll be back in the service menu. - - Go to `NETWORK OPTIONS` then `SHOP NAME SETTING`. - - - - - You will need to set a shop name. - - - Name your shop to whatever you'd like. Again, navigation instructions are at the bottom of the screen. - - Go to `EXIT` then `SAVE AND EXIT`. - - - - Select `GAME MODE`. - - - -!!! success "You're all done! The game should load up properly now" - -## Carding in - -!!! info "Before carding in, you have the option to change the game's language by pressing your `EFFECT` key" - -??? tip "For LDJ (Standard mode)" - - LDJ should accept keypad number binds: - - - Press your `Keypad Insert Card` button. - - Enter your code using your keypad binds. - -??? tip "For TDJ (Lightning mode)" - - TDJ will ignore keypad number binds, you need to: - - - Press your `Keypad Insert Card` button. - - Press your `Toggle Sub Screen` overlay button *(PgUp by default)* to bring up the sub screen. - - Enter your code by clicking on the subscreen's keypad. - - If your code is accepted, you may now close the overlay. - -## Help - ---8<-- "docs/snippets/common/help.md" \ No newline at end of file +--8<-- "docs/games/konami/iidx/common/31plus/setup.md" \ No newline at end of file diff --git a/docs/games/konami/iidx/common/31plus/extras.md b/docs/games/konami/iidx/common/31plus/extras.md index cbd64b6..e9ff65b 100644 --- a/docs/games/konami/iidx/common/31plus/extras.md +++ b/docs/games/konami/iidx/common/31plus/extras.md @@ -1,45 +1,17 @@ # Extra Information -## Standard and Lightning modes - -!!! warning "Lightning mode requires a 120 Hz capable monitor" - -!!! tip "" - - To make use of the Lightning Mode, which unlocks the subscreen and 120FPS, we need to go to the `contents\prop` folder and edit the `ea3-config.xml` file. - - We're interested in these lines: - - ```xml - - LDJ - J - E - A - 2024100900 - - ``` - - This is the line that determines if the game will run in Standard (60 FPS) or Lightning (120 FPS) mode. - - ```xml - E - ``` - - - ^^`E`^^ for Standard (LDJ-012, LDJ, 60 Hz) - - ^^`D`^^ for Lightning (LDJ-010, TDJ, 120 Hz) - ## Changing the game's language !!! tip "" This is done in-game before card-in by pressing your `EFFECT` key. -## More about ea3-config.xml +## About ea3-config.xml !!! tip "" The `ea3-config.xml` file is located inside the `prop` folder. + It defines several *prop*erties that tell the game how its should be configured. Below is an explanation on what different sections of this file do. @@ -59,20 +31,35 @@ ``` The following line determines the game's region. - ^^**You should never change this**^^. As you can change the language in-game. + ^^**You shouldn't need to change this**^^ as you can change the language in-game. ```xml J ``` - ^^**You should never change this**^^. It should always say `A` for Pinky Crush. + The following line determines whether the game is in Standard or Lightning mode. + + ```xml + E + ``` + + - ^^`E`^^ for Standard (LDJ-012, LDJ, 60 Hz) + - ^^`D`^^ for Lightning (LDJ-010, TDJ, 120 Hz) + + Editing this line **by itself will not change which mode** your game runs in! + + Your dll must already be in the right mode **in addition** to setting this property properly. [(Read More)](../setup/#standard-and-lightning-modes) + + ^^**Always keep it up to date**^^ with what mode your game is configured to run in. + + ^^**The following line should never be changed**^^. It should always say `A`. ```xml A ``` The following line determines your datecode. - ^^**Always keep it up to date**^^ with your game's current version. + It is best practice to ^^**keep it up to date**^^ with your game's current version. ```xml 2024100900 diff --git a/docs/snippets/konami/iidx/ldj_vs_tdj.md b/docs/snippets/konami/iidx/ldj_vs_tdj.md index d42c4dd..1c3b71d 100644 --- a/docs/snippets/konami/iidx/ldj_vs_tdj.md +++ b/docs/snippets/konami/iidx/ldj_vs_tdj.md @@ -1,20 +1,28 @@ -!!! note "" +!!! warning "Lightning mode requires a 120 Hz capable monitor" - Before proceeding with the setup, it's important to understand the two cabinet types for IIDX: +!!! warning "Standard and Lightning modes" + + The game data comes in two variants based on the `bm2dx.dll` file. + Before proceeding with the setup, it's very important to understand the two cabinet types for IIDX: - **Lightning (TDJ/LDJ-010)**: - Runs at 120 FPS - Requires a 120 Hz main monitor - - Optional second touchscreen 60 Hz monitor called a subscreen + - Second 60 Hz touchscreen monitor called a subscreen + - Disables physical keypad input; a virtual keypad is on the subscreen + - Optional video recording feature - **Standard/Legacy (LDJ/LDJ-012)**: - Runs at 60 FPS - Requires a 60 Hz main monitor - No subscreen - - The game data comes in two variants based on the `bm2dx.dll` file. - You can patch an LDJ dll to run in TDJ mode, but this will disable video recording. + - Accepts physical keypad input + + You can patch a LDJ dll to behave like a TDJ dll. This will enable all TDJ features **except** video recording. + If you want to run in TDJ mode, you **must** also enable the `-iidxtdj` spice2x option [here](#__tabbed_1_8). + + You can also patch a TDJ dll to behave like a LDJ dll. For simplicity, we'll use "TDJ" for Lightning Mode and "LDJ" for Standard Mode throughout our guides. \ No newline at end of file diff --git a/docs/snippets/konami/iidx/spicecfg_options_tdj.md b/docs/snippets/konami/iidx/spicecfg_options_tdj.md index 3f317fd..35a76aa 100644 --- a/docs/snippets/konami/iidx/spicecfg_options_tdj.md +++ b/docs/snippets/konami/iidx/spicecfg_options_tdj.md @@ -1,3 +1,3 @@ - !!! tip "Optional: Enabling TDJ (Lightning mode)" - - You may want to enable `IITX TDJ Mode (-iidxtdj)` if your main monitor is 120 Hz capable. \ No newline at end of file + !!! warning "Enabling TDJ (Lightning mode)" + + You must enable `IITX TDJ Mode (-iidxtdj)` if you are trying to run the game in TDJ mode ([Read More](#standard-and-lightning-modes)) \ No newline at end of file