diff --git a/docs/games/bemani/iidx/24_sinobuz/setup.md b/docs/games/bemani/iidx/24_sinobuz/setup.md index 0f3beb41..855aa497 100644 --- a/docs/games/bemani/iidx/24_sinobuz/setup.md +++ b/docs/games/bemani/iidx/24_sinobuz/setup.md @@ -16,7 +16,7 @@ - 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. + You should end up with a file structure with a few folders only, as follows: diff --git a/docs/games/bemani/iidx/27_heroicverse/extras.md b/docs/games/bemani/iidx/27_heroicverse/extras.md index 800b34b1..6406fa9f 100644 --- a/docs/games/bemani/iidx/27_heroicverse/extras.md +++ b/docs/games/bemani/iidx/27_heroicverse/extras.md @@ -55,7 +55,7 @@ ## Audio Related Crash !!! tip "" - If you get a stack trace in your `log.txt` that looks like this... + If you get a stack trace in your `log.txt` that looks like this:.. `exception raised: EXCEPTION_ACCESS_VIOLATION` diff --git a/docs/games/bemani/iidx/30_resident/setup.md b/docs/games/bemani/iidx/30_resident/setup.md index bc060da1..089a2627 100644 --- a/docs/games/bemani/iidx/30_resident/setup.md +++ b/docs/games/bemani/iidx/30_resident/setup.md @@ -31,7 +31,7 @@ - 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. + You should end up with a file structure with a few folders only, as follows: diff --git a/docs/games/bemani/iidx/common/31plus/setup.md b/docs/games/bemani/iidx/common/31plus/setup.md index 809a7a1f..ed692434 100644 --- a/docs/games/bemani/iidx/common/31plus/setup.md +++ b/docs/games/bemani/iidx/common/31plus/setup.md @@ -109,7 +109,7 @@ --8<-- "docs/snippets/bemani/common/spicecfg_nochange.md" -## Configuring Audio +## Configuring audio --8<-- "docs/snippets/bemani/common/setup_audio.md" diff --git a/docs/games/bemani/popn/common/setup.md b/docs/games/bemani/popn/common/setup.md index 6f29cdd9..dc96a82f 100644 --- a/docs/games/bemani/popn/common/setup.md +++ b/docs/games/bemani/popn/common/setup.md @@ -15,7 +15,7 @@ - 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. + You should end up with a file structure with a few folders only, as follows: diff --git a/docs/games/bemani/sdvx/6_exceedgear/setup.md b/docs/games/bemani/sdvx/6_exceedgear/setup.md index 490d5c70..17fd561c 100644 --- a/docs/games/bemani/sdvx/6_exceedgear/setup.md +++ b/docs/games/bemani/sdvx/6_exceedgear/setup.md @@ -104,7 +104,7 @@ --8<-- "docs/snippets/bemani/common/spicecfg_nochange.md" -## Configuring Audio +## Configuring audio --8<-- "docs/snippets/bemani/common/setup_audio.md" diff --git a/docs/games/bemani/sdvx/6_exceedgear/troubleshooting.md b/docs/games/bemani/sdvx/6_exceedgear/troubleshooting.md index 5f19c2fc..9bd9475e 100644 --- a/docs/games/bemani/sdvx/6_exceedgear/troubleshooting.md +++ b/docs/games/bemani/sdvx/6_exceedgear/troubleshooting.md @@ -44,7 +44,7 @@ - Search for `Superstep` If you find a line with `Audio device is not available!!!`, it means the game hasn't found refuses to boot due to misconfigured audio. - Check the setup guide's [Configuring Audio section](setup.md#configuring-audio) as well as our general [Audio guide](/extras/audio.md) to understand the issue better. + Check the setup guide's [Configuring audio section](setup.md#configuring-audio) as well as our general [Audio guide](/extras/audio.md) to understand the issue better. ??? tip "I'm using a laptop with a hybrid internal+dedicated GPU setup" diff --git a/docs/games/sega/chunithm/air/setup.md b/docs/games/sega/chunithm/air/setup.md index eeada7a3..1e210ce5 100644 --- a/docs/games/sega/chunithm/air/setup.md +++ b/docs/games/sega/chunithm/air/setup.md @@ -1,4 +1,4 @@ ---8<-- "docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" diff --git a/docs/games/sega/chunithm/airplus/setup.md b/docs/games/sega/chunithm/airplus/setup.md index 9dd47ea8..d7edfaae 100644 --- a/docs/games/sega/chunithm/airplus/setup.md +++ b/docs/games/sega/chunithm/airplus/setup.md @@ -1,4 +1,4 @@ ---8<-- "docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" diff --git a/docs/games/sega/chunithm/amazon/setup.md b/docs/games/sega/chunithm/amazon/setup.md index d61ed45b..71798ae0 100644 --- a/docs/games/sega/chunithm/amazon/setup.md +++ b/docs/games/sega/chunithm/amazon/setup.md @@ -1,4 +1,4 @@ ---8<-- "docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" diff --git a/docs/games/sega/chunithm/amazonplus/setup.md b/docs/games/sega/chunithm/amazonplus/setup.md index 45c2e25c..e7816226 100644 --- a/docs/games/sega/chunithm/amazonplus/setup.md +++ b/docs/games/sega/chunithm/amazonplus/setup.md @@ -1,4 +1,4 @@ ---8<-- "docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" diff --git a/docs/games/sega/chunithm/chunithm/setup.md b/docs/games/sega/chunithm/chunithm/setup.md index 09580b62..8635b8fa 100644 --- a/docs/games/sega/chunithm/chunithm/setup.md +++ b/docs/games/sega/chunithm/chunithm/setup.md @@ -1,4 +1,4 @@ ---8<-- "docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" diff --git a/docs/games/sega/chunithm/common/chuni/setup.md b/docs/games/sega/chunithm/common/chuni/setup.md index e9dfffbc..205450dd 100644 --- a/docs/games/sega/chunithm/common/chuni/setup.md +++ b/docs/games/sega/chunithm/common/chuni/setup.md @@ -2,15 +2,15 @@ --8<-- "docs/snippets/common/data_warning.md" ---8<-- "docs/snippets/sega/common/old_data.md" +--8<-- "docs/snippets/sega/common/data_old.md" ## Preparing data ---8<-- "docs/snippets/sega/common/drive_warning.md" +--8<-- "docs/snippets/sega/common/data_driveletter.md" --8<-- "docs/snippets/common/data_readonly.md" ---8<-- "docs/snippets/sega/common/preparing_data.md" +--8<-- "docs/snippets/sega/common/data_preparation.md" ``` 📂bin @@ -25,25 +25,25 @@ --8<-- "docs/snippets/sega/common/data_bad.md" -## Updating the base game +## Updating data ---8<-- "docs/snippets/sega/common/updating.md" +--8<-- "docs/snippets/sega/common/data_updating.md" ## Installing option data ---8<-- "docs/snippets/sega/chunithm/option_data.md" +--8<-- "docs/snippets/sega/chunithm/data_options.md" ## Installing unprotected executables ---8<-- "docs/snippets/sega/chunithm/unprotected_executables.md" +--8<-- "docs/snippets/sega/chunithm/unprotected_exes.md" ## Installing ICFs ---8<-- "docs/snippets/sega/common/icfs.md" +--8<-- "docs/snippets/sega/common/data_icfs.md" ## Patching the game ---8<-- "docs/snippets/sega/chunithm/patching.md" +--8<-- "docs/snippets/sega/common/patching.md" | Patch | Recommendation | Description | |------------------------------|----------------|-------------| @@ -56,49 +56,28 @@ ## Installing segatools -!!! tip "" +--8<-- "docs/snippets/sega/common/segatools_install.md" + - Find `chuni.zip` and extract it to your data's `App\bin` folder - - Head over to [segatools releases](https://gitea.tendokyu.moe/Dniel97/segatools/releases) - and download `segatools.zip`. **Do not download the source code.** - - Extracting the archive should give you a few more zip files. Find **`chuni.zip`** - and extract it to the `App\bin` folder in your game data. - - You should now have a few more files inside the folder, as shown: + You should now have these files added to your `App\bin` directory: ``` 📂DEVICE - [...] 📄chunihook.dll - [...] ▶️inject.exe - [...] 📄segatools.ini ▶️start.bat - [...] ``` ## Configuring segatools !!! tip "" - Since there is no graphical configuration tool for segatools, you will have to edit the - configuration file by hand. It is found in `App\bin\segatools.ini`. - ---8<-- "docs/snippets/sega/common/segatools_stubs.md" +--8<-- "docs/snippets/sega/common/segatools_preamble.md" === "[vfs]" - !!! tip "" - - If you've been matching the file structure as described in the [Preparing data](#preparing-data) - section, you can fill in this section with the values below: - - ```ini - [vfs] - amfs=../../amfs - option=../../Option - appdata=../../AppData - ``` +--8<-- "docs/snippets/sega/common/segatools_relativepaths.md" --8<-- "docs/snippets/sega/common/segatools_vfs.md" @@ -106,29 +85,29 @@ --8<-- "docs/snippets/sega/chunithm/segatools_gfx.md" +## Configuring audio + +--8<-- "docs/snippets/common/audio_48khz.md" + ## Connecting to a network -!!! danger "Pick one or the other, not both!" +--8<-- "docs/snippets/sega/common/network_preamble.md" ---8<-- "docs/snippets/sega/common/online_network.md" +--8<-- "docs/snippets/sega/common/network_remote.md" ---8<-- "docs/snippets/sega/chunithm/only_artemis.md" +--8<-- "docs/snippets/sega/common/network_local_artemisonly.md" ## Installing VCRedist & DirectX --8<-- "docs/snippets/common/setup_vcredist_directx.md" -## Audio properties - ---8<-- "docs/snippets/common/audio_properties.md" - ## Before playing --8<-- "docs/snippets/common/before_playing.md" ## First launch ---8<-- "docs/snippets/sega/common/first_launch_info.md" +--8<-- "docs/snippets/sega/common/service_jp_googlelens.md" !!! tip "" @@ -175,14 +154,12 @@ Select **終了** (`EXIT`, the last option) to exit to the main service menu, then select **終了** (also the last option) in the main menu to exit the service menu. -!!! tip "" - If you're stuck at the `Waiting for Distribution Server` screen below, close the game and relaunch. ---8<-- "docs/snippets/sega/common/finish.md" +--8<-- "docs/snippets/sega/common/success.md" ## Help ---8<-- "docs/snippets/common/help.md" +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md b/docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md similarity index 68% rename from docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md rename to docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md index 40712517..14c7f798 100644 --- a/docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md +++ b/docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md @@ -2,15 +2,15 @@ --8<-- "docs/snippets/common/data_warning.md" ---8<-- "docs/snippets/sega/common/old_data.md" +--8<-- "docs/snippets/sega/common/data_old.md" ## Preparing data ---8<-- "docs/snippets/sega/common/drive_warning.md" +--8<-- "docs/snippets/sega/common/data_driveletter.md" --8<-- "docs/snippets/common/data_readonly.md" ---8<-- "docs/snippets/sega/common/preparing_data.md" +--8<-- "docs/snippets/sega/common/data_preparation.md" ``` 📂bin @@ -25,21 +25,21 @@ --8<-- "docs/snippets/sega/common/data_bad.md" -## Updating the base game +## Updating data ---8<-- "docs/snippets/sega/common/updating.md" +--8<-- "docs/snippets/sega/common/data_updating.md" ## Installing option data ---8<-- "docs/snippets/sega/chunithm/option_data.md" +--8<-- "docs/snippets/sega/chunithm/data_options.md" ## Installing ICFs ---8<-- "docs/snippets/sega/common/icfs.md" +--8<-- "docs/snippets/sega/common/data_icfs.md" ## Patching the game ---8<-- "docs/snippets/sega/chunithm/patching.md" +--8<-- "docs/snippets/sega/common/patching.md" | Patch | Recommendation | Description | |------------------------------|----------------|-------------| @@ -52,48 +52,29 @@ !!! tip "" - - Head over to [segatools releases](https://gitea.tendokyu.moe/Dniel97/segatools/releases) - and download `segatools.zip`. **Do not download the source code.** - - Extracting the archive should give you a few more zip files. Find **`chuni.zip`** - and extract it to the `App\bin` folder in your game data. +--8<-- "docs/snippets/sega/common/segatools_install.md" + - Find `chuni.zip` and extract it to your data's `App\bin` folder - You should now have a few more files inside the folder, as shown: + You should now have these files added to your `App\bin` directory: ``` 📂DEVICE - [...] 📄chunihook.dll - [...] ▶️inject.exe - [...] 📄segatools.ini ▶️start.bat - [...] ``` +## Configuring audio + +--8<-- "docs/snippets/common/audio_48khz.md" + ## Configuring segatools -!!! tip "" - - Since there is no graphical configuration tool for segatools, you will have to edit the - configuration file by hand. It is found in `App\bin\segatools.ini`. - ---8<-- "docs/snippets/sega/common/segatools_stubs.md" +--8<-- "docs/snippets/sega/common/segatools_preamble.md" === "[vfs]" - !!! tip "" - - If you've been matching the file structure as described in the [Preparing data](#preparing-data) - section, you can fill in this section with the values below: - - ```ini - [vfs] - amfs=../../amfs - option=../../Option - appdata=../../AppData - ``` - --8<-- "docs/snippets/sega/common/segatools_vfs.md" === "[gfx]" @@ -102,27 +83,23 @@ ## Connecting to a network -!!! danger "Pick one or the other, not both!" +--8<-- "docs/snippets/sega/common/network_preamble.md" ---8<-- "docs/snippets/sega/common/online_network.md" +--8<-- "docs/snippets/sega/common/network_remote.md" ---8<-- "docs/snippets/sega/chunithm/only_artemis.md" +--8<-- "docs/snippets/sega/common/network_local_artemisonly.md" ## Installing VCRedist & DirectX --8<-- "docs/snippets/common/setup_vcredist_directx.md" -## Audio properties - ---8<-- "docs/snippets/common/audio_properties.md" - ## Before playing --8<-- "docs/snippets/common/before_playing.md" ## First launch ---8<-- "docs/snippets/sega/common/first_launch_info.md" +--8<-- "docs/snippets/sega/common/service_jp_googlelens.md" !!! tip "" @@ -175,8 +152,8 @@ ---8<-- "docs/snippets/sega/common/finish.md" +--8<-- "docs/snippets/sega/common/success.md" ## Help ---8<-- "docs/snippets/common/help.md" +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/common/chusan/setup.md b/docs/games/sega/chunithm/common/chusan/setup.md index 7a3e1485..537be022 100644 --- a/docs/games/sega/chunithm/common/chusan/setup.md +++ b/docs/games/sega/chunithm/common/chusan/setup.md @@ -2,15 +2,15 @@ --8<-- "docs/snippets/common/data_warning.md" ---8<-- "docs/snippets/sega/common/old_data.md" +--8<-- "docs/snippets/sega/common/data_old.md" ## Preparing data ---8<-- "docs/snippets/sega/common/drive_warning.md" +--8<-- "docs/snippets/sega/common/data_driveletter.md" --8<-- "docs/snippets/common/data_readonly.md" ---8<-- "docs/snippets/sega/common/preparing_data.md" +--8<-- "docs/snippets/sega/common/data_preparation.md" ``` 📂bin @@ -26,25 +26,25 @@ --8<-- "docs/snippets/sega/common/data_bad.md" -## Updating the base game +## Updating data ---8<-- "docs/snippets/sega/common/updating.md" +--8<-- "docs/snippets/sega/common/data_updating.md" ## Installing option data ---8<-- "docs/snippets/sega/chunithm/option_data.md" +--8<-- "docs/snippets/sega/chunithm/data_options.md" ## Installing unprotected executables ---8<-- "docs/snippets/sega/chunithm/unprotected_executables.md" +--8<-- "docs/snippets/sega/chunithm/unprotected_exes.md" ## Installing ICFs ---8<-- "docs/snippets/sega/common/icfs.md" +--8<-- "docs/snippets/sega/common/data_icfs.md" ## Patching the game ---8<-- "docs/snippets/sega/chunithm/patching.md" +--8<-- "docs/snippets/sega/common/patching.md" | Patch | Recommendation | Description | |------------------------------|----------------|-------------| @@ -60,51 +60,29 @@ !!! tip "" - - Head over to [segatools releases](https://gitea.tendokyu.moe/Dniel97/segatools/releases) - and download `segatools.zip`. **Do not download the source code.** - - Extracting the archive should give you a few more zip files. Find **`chusan.zip`** - and extract it to the `App\bin` folder in your game data. +--8<-- "docs/snippets/sega/common/segatools_install.md" + - Find `chusan.zip` and extract it to your data's `App\bin` folder - You should now have a few more files inside the folder, as shown: + You should now have these files added to your `App\bin` directory: ``` 📂DEVICE - [...] 📄chusanhook_x64.dll 📄chusanhook_x86.dll - [...] 📄config_hook.json - [...] ▶️inject_x64.exe ▶️inject_x86.exe - [...] 📄segatools.ini ▶️start.bat - [...] ``` ## Configuring segatools -!!! tip "" - - Since there is no graphical configuration tool for segatools, you will have to edit the - configuration file by hand. It is found in `App\bin\segatools.ini`. - ---8<-- "docs/snippets/sega/common/segatools_stubs.md" +--8<-- "docs/snippets/sega/common/segatools_preamble.md" === "[vfs]" - !!! tip "" - - If you've been matching the file structure as described in the [Preparing data](#preparing-data) - section, you can fill in this section with the values below: - - ```ini - [vfs] - amfs=../../amfs - option=../../Option - appdata=../../AppData - ``` +--8<-- "docs/snippets/sega/common/segatools_relativepaths.md" --8<-- "docs/snippets/sega/common/segatools_vfs.md" @@ -132,25 +110,25 @@ --8<-- "docs/snippets/sega/chunithm/segatools_gfx.md" +## Configuring audio + +--8<-- "docs/snippets/common/audio_48khz.md" + ## Connecting to a network -!!! danger "Pick one or the other, not both!" +--8<-- "docs/snippets/sega/common/network_preamble.md" ---8<-- "docs/snippets/sega/common/online_network.md" +--8<-- "docs/snippets/sega/common/network_remote.md" ---8<-- "docs/snippets/sega/common/local_network.md" +--8<-- "docs/snippets/sega/common/network_local.md" ## Installing VCRedist & DirectX --8<-- "docs/snippets/common/setup_vcredist_directx.md" -## Audio properties +## OpenSSL Fix (Intel 10th Gen+) ---8<-- "docs/snippets/common/audio_properties.md" - -## Fixing OpenSSL on Intel 10th Gen and newer CPUs - ---8<-- "docs/snippets/sega/common/openssl.md" +--8<-- "docs/snippets/sega/common/cpu_intel_openssl.md" ## Before playing @@ -158,7 +136,7 @@ ## First launch ---8<-- "docs/snippets/sega/common/first_launch_info.md" +--8<-- "docs/snippets/sega/common/service_jp_googlelens.md" !!! tip "" @@ -193,14 +171,13 @@ Select **終了** (`EXIT`, the last option) to exit to the main service menu, then select **終了** (also the last option) in the main menu to exit the service menu. -!!! tip "" If you're stuck at the `Waiting for Distribution Server` screen below, close the game and relaunch. ---8<-- "docs/snippets/sega/common/finish.md" +--8<-- "docs/snippets/sega/common/success.md" ## Help ---8<-- "docs/snippets/common/help.md" +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/crystal/c2c.md b/docs/games/sega/chunithm/crystal/c2c.md index 9a9947a2..0a748b08 100644 --- a/docs/games/sega/chunithm/crystal/c2c.md +++ b/docs/games/sega/chunithm/crystal/c2c.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/crystal/controllers.md b/docs/games/sega/chunithm/crystal/controllers.md index ee5500e1..46997aea 100644 --- a/docs/games/sega/chunithm/crystal/controllers.md +++ b/docs/games/sega/chunithm/crystal/controllers.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/crystal/setup.md b/docs/games/sega/chunithm/crystal/setup.md index de63898b..5d58cec5 100644 --- a/docs/games/sega/chunithm/crystal/setup.md +++ b/docs/games/sega/chunithm/crystal/setup.md @@ -1,4 +1,2 @@ - - ---8<-- "docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/crystal/troubleshooting.md b/docs/games/sega/chunithm/crystal/troubleshooting.md index f8bea1aa..95f6e2e2 100644 --- a/docs/games/sega/chunithm/crystal/troubleshooting.md +++ b/docs/games/sega/chunithm/crystal/troubleshooting.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/crystalplus/c2c.md b/docs/games/sega/chunithm/crystalplus/c2c.md index 13970753..047b6236 100644 --- a/docs/games/sega/chunithm/crystalplus/c2c.md +++ b/docs/games/sega/chunithm/crystalplus/c2c.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/crystalplus/controllers.md b/docs/games/sega/chunithm/crystalplus/controllers.md index 7e049eba..313b2be0 100644 --- a/docs/games/sega/chunithm/crystalplus/controllers.md +++ b/docs/games/sega/chunithm/crystalplus/controllers.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/crystalplus/setup.md b/docs/games/sega/chunithm/crystalplus/setup.md index 860c1d4c..3ff6e2de 100644 --- a/docs/games/sega/chunithm/crystalplus/setup.md +++ b/docs/games/sega/chunithm/crystalplus/setup.md @@ -1,4 +1,2 @@ - - ---8<-- "docs/games/sega/chunithm/common/chuni/setup.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/crystalplus/troubleshooting.md b/docs/games/sega/chunithm/crystalplus/troubleshooting.md index ccdb99ba..767b590a 100644 --- a/docs/games/sega/chunithm/crystalplus/troubleshooting.md +++ b/docs/games/sega/chunithm/crystalplus/troubleshooting.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/paradise/c2c.md b/docs/games/sega/chunithm/paradise/c2c.md index 6cdf4c7f..b5592fce 100644 --- a/docs/games/sega/chunithm/paradise/c2c.md +++ b/docs/games/sega/chunithm/paradise/c2c.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/paradise/controllers.md b/docs/games/sega/chunithm/paradise/controllers.md index 42db43bf..ad501685 100644 --- a/docs/games/sega/chunithm/paradise/controllers.md +++ b/docs/games/sega/chunithm/paradise/controllers.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/paradise/setup.md b/docs/games/sega/chunithm/paradise/setup.md index 51565d8e..cc1598f9 100644 --- a/docs/games/sega/chunithm/paradise/setup.md +++ b/docs/games/sega/chunithm/paradise/setup.md @@ -1,4 +1,2 @@ - - ---8<-- "docs/games/sega/chunithm/common/chuni/setup.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/paradise/troubleshooting.md b/docs/games/sega/chunithm/paradise/troubleshooting.md index 438ca546..e1f570a4 100644 --- a/docs/games/sega/chunithm/paradise/troubleshooting.md +++ b/docs/games/sega/chunithm/paradise/troubleshooting.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/paradiselost/c2c.md b/docs/games/sega/chunithm/paradiselost/c2c.md index 99ad9070..475d2c0b 100644 --- a/docs/games/sega/chunithm/paradiselost/c2c.md +++ b/docs/games/sega/chunithm/paradiselost/c2c.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/paradiselost/controllers.md b/docs/games/sega/chunithm/paradiselost/controllers.md index d7cf5b21..7d826d27 100644 --- a/docs/games/sega/chunithm/paradiselost/controllers.md +++ b/docs/games/sega/chunithm/paradiselost/controllers.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/paradiselost/setup.md b/docs/games/sega/chunithm/paradiselost/setup.md index eade449e..27ec0284 100644 --- a/docs/games/sega/chunithm/paradiselost/setup.md +++ b/docs/games/sega/chunithm/paradiselost/setup.md @@ -1,4 +1,2 @@ - - ---8<-- "docs/games/sega/chunithm/common/chuni/setup.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/paradiselost/troubleshooting.md b/docs/games/sega/chunithm/paradiselost/troubleshooting.md index 4b7bbf86..2919df95 100644 --- a/docs/games/sega/chunithm/paradiselost/troubleshooting.md +++ b/docs/games/sega/chunithm/paradiselost/troubleshooting.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/plus/c2c.md b/docs/games/sega/chunithm/plus/c2c.md index b7b79983..614c322f 100644 --- a/docs/games/sega/chunithm/plus/c2c.md +++ b/docs/games/sega/chunithm/plus/c2c.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/plus/controllers.md b/docs/games/sega/chunithm/plus/controllers.md index 92422c92..34a0182a 100644 --- a/docs/games/sega/chunithm/plus/controllers.md +++ b/docs/games/sega/chunithm/plus/controllers.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/plus/setup.md b/docs/games/sega/chunithm/plus/setup.md index a53cccc5..8fc7f975 100644 --- a/docs/games/sega/chunithm/plus/setup.md +++ b/docs/games/sega/chunithm/plus/setup.md @@ -1,4 +1,2 @@ - - ---8<-- "docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/plus/troubleshooting.md b/docs/games/sega/chunithm/plus/troubleshooting.md index 8bae9589..da4eb8d0 100644 --- a/docs/games/sega/chunithm/plus/troubleshooting.md +++ b/docs/games/sega/chunithm/plus/troubleshooting.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/star/c2c.md b/docs/games/sega/chunithm/star/c2c.md index d043451e..6e0b8c0d 100644 --- a/docs/games/sega/chunithm/star/c2c.md +++ b/docs/games/sega/chunithm/star/c2c.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/star/controllers.md b/docs/games/sega/chunithm/star/controllers.md index cb8582f1..3f8a7ac1 100644 --- a/docs/games/sega/chunithm/star/controllers.md +++ b/docs/games/sega/chunithm/star/controllers.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/star/setup.md b/docs/games/sega/chunithm/star/setup.md index 12975c35..cf1955e2 100644 --- a/docs/games/sega/chunithm/star/setup.md +++ b/docs/games/sega/chunithm/star/setup.md @@ -1,4 +1,2 @@ - - ---8<-- "docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/star/troubleshooting.md b/docs/games/sega/chunithm/star/troubleshooting.md index f868f693..d1255104 100644 --- a/docs/games/sega/chunithm/star/troubleshooting.md +++ b/docs/games/sega/chunithm/star/troubleshooting.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/starplus/c2c.md b/docs/games/sega/chunithm/starplus/c2c.md index 8359743f..d2123bf2 100644 --- a/docs/games/sega/chunithm/starplus/c2c.md +++ b/docs/games/sega/chunithm/starplus/c2c.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/starplus/controllers.md b/docs/games/sega/chunithm/starplus/controllers.md index b85a021b..811ee155 100644 --- a/docs/games/sega/chunithm/starplus/controllers.md +++ b/docs/games/sega/chunithm/starplus/controllers.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/starplus/setup.md b/docs/games/sega/chunithm/starplus/setup.md index c5774304..72d843b5 100644 --- a/docs/games/sega/chunithm/starplus/setup.md +++ b/docs/games/sega/chunithm/starplus/setup.md @@ -1,4 +1,2 @@ - - ---8<-- "docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md" +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/starplus/troubleshooting.md b/docs/games/sega/chunithm/starplus/troubleshooting.md index 04b13f82..0f84bf9e 100644 --- a/docs/games/sega/chunithm/starplus/troubleshooting.md +++ b/docs/games/sega/chunithm/starplus/troubleshooting.md @@ -1,3 +1,2 @@ - ---8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/common/setup.md b/docs/games/sega/maimaidx/common/setup.md index 84dba28a..0ee10eab 100644 --- a/docs/games/sega/maimaidx/common/setup.md +++ b/docs/games/sega/maimaidx/common/setup.md @@ -2,15 +2,15 @@ --8<-- "docs/snippets/common/data_warning.md" ---8<-- "docs/snippets/sega/common/old_data.md" +--8<-- "docs/snippets/sega/common/data_old.md" ## Preparing data ---8<-- "docs/snippets/sega/common/drive_warning.md" +--8<-- "docs/snippets/sega/common/data_driveletter.md" --8<-- "docs/snippets/common/data_readonly.md" ---8<-- "docs/snippets/sega/common/preparing_data.md" +--8<-- "docs/snippets/sega/common/data_preparation.md" ``` 📂license @@ -23,42 +23,36 @@ ``` --8<-- "docs/snippets/sega/common/data_bad.md" -## Updating the base game +## Updating data -!!! tip "" - - Extract your patch's files to your existing data in a way that matches its - file structure. Agree to overwrite files if necessary. +--8<-- "docs/snippets/sega/common/data_updating.md" ## Installing option data !!! tip "" - maimai DX content updates are distributed through option folders instead of patching - the base game. + SEGA games receive content updates through option folders rather than direct game file updates. - Options are named with a letter followed by three numbers. + - maimai DX JPN(SDEZ): each new release of maimai DX increments the first letter of the Options (ie. `H???` for BUDDiES, `I???` BUDDiES+) + - maimai DX EXP(SDGA): Options will always begin with the letter `A` (i.e `A???`) + - `???` represents a sequence of numbers - For JPN(SDEZ) data, each new release of maimai DX increments the first letter of the Option (ie. BUDDiES is `H???` and BUDDiES+ is `I???`). - - For EXP(SDGA) data, Options will always begin with the letter `A` (i.e `A???`) - - Extract any options you've downloaded into the `Option` folder. You should end up with - a file structure as follows. **Do not be worried if you have fewer or more option folders.** + After downloading option files, extract them into your game's `Option` folder. ``` - 📂H005 - 📂H011 - 📂H021 - 📂H031 - 📂H032 - 📂H041 - 📂H051 - 📂H061 - 📂H100 + 📂amf + 📂App + 📂AppData + 📂Option + ┣━📂H005 + ┣━📂H011 + ┣━📂H031 + ┗━ etc.. ``` - !!! warning "Do not mix option data between versions" +!!! info "Option numbers don't always follow a sequential pattern
It's common to see the numbers jump, for example `H005` then `H011`" + +!!! warning "Do not mix option data between game versions" ## Installing unprotected executables @@ -66,35 +60,40 @@ maimai DX executables are protected and will not run on a regular computer. - Obtain unprotected (also called "unpacked" or "decrypted" by the community) - copies of the following files and the associated configuration file: + - Obtain unprotected (also called "unpacked" or "decrypted" by the community) copies of of the following folders and files: - - amdaemon.exe - - Sinmai.exe - - Sinmai_Data/Plugins/amdaemon_api.dll - - Sinmai_Data/Plugins/Cake.dll (JPN/SDEZ only) - - Sinmai_Data/Managed/AMDaemon.NET.dll - - Sinmai_Data/Managed/Assembly-CSharp.dll - - mai2.ini + ``` + 📄amdaemon.exe + 📄Sinmai.exe + 📂Sinmai_Data + ┣━📂Plugins + ┃ ┣━📄amdaemon_api.dll + ┃ ┗━📄Cake.dll (JPN/SDEZ only) + ┗━📂Managed + ┣━📄AMDaemon.NET.dll + ┗━📄Assembly-CSharp.dll + 📄mai2.ini + ``` - Copy the files and folders into the `App/Package` folder of your game data. Agree to overwrite - when asked. + - Copy all of the above to your data's `App/Package` folder + - Agree to overwrite when asked - !!! Warning "Assembly-CSharp Notes" +!!! warning "Assembly-CSharp Notes" - `Assembly-CSharp.dll` **must** match your game version. All others can be - reused from other game versions. + `Assembly-CSharp.dll` **must** match your game version. + All other files can be reused between game versions. ## Installing ICFs ---8<-- "docs/snippets/sega/common/icfs.md" +--8<-- "docs/snippets/sega/common/data_icfs.md" ## mai2.ini !!! tip "" + Ensure that the `App\Package` folder contains `mai2.ini`. - If this configuration file is missing, create one using the contents below. + If this configuration file is missing, create one using the contents below: ```ini [Debug] @@ -114,109 +113,55 @@ ## Installing segatools -!!! tip "" +--8<-- "docs/snippets/sega/common/segatools_install.md" + - Find `mai2.zip` and extract it to your data's `App\Package` folder - - Head over to [segatools releases](https://gitea.tendokyu.moe/TeamTofuShop/segatools/releases/tag/2024-03-13) - and download the `segatools.zip` from `2024-03-13`. **Do not download the source code or latest release.** - - Extracting the archive should give you a few more zip files. Find `mai2.zip` - and extract it to the `App/Package` folder in your game data. - - You should now have a few more files inside the folder, as shown: + You should now have these files added to your `App\Package` directory: ``` 📂DEVICE - [...] ▶️inject.exe 📄mai2hook.dll 📄segatools.ini ▶️start.bat - [...] ``` -!!! warning - - The latest release of segatools currently has issues with maimai, and for the time being an older version of segatools is preferred. - ## Configuring segatools !!! tip "" - Since there is no graphical configuration tool for segatools, you will have to edit the - configuration file by hand. It is found in `App\Package\segatools.ini`. - ---8<-- "docs/snippets/sega/common/segatools_stubs.md" +--8<-- "docs/snippets/sega/common/segatools_preamble.md" === "[vfs]" - !!! tip "" +--8<-- "docs/snippets/sega/common/segatools_relativepaths.md" - If you've been matching the file structure as described in the [Preparing data](#preparing-data) - section, you can fill in this section with the values below: - - ```ini - [vfs] - amfs=../../amfs - option=../../Option - appdata=../../AppData - ``` - ---8<-- "docs/snippets/sega/common/segatools_relative_directories.md" +--8<-- "docs/snippets/sega/common/segatools_vfs.md" ??? tip "AquaMai" - It's strongly recommended to use MelonLoader mods to improve QOL. - You can find info about the available mods for maimai here [AquaMai](https://github.com/MewoLab/AquaMai). - For general modding check [Unity modding](/extras/unity.md) page. + Find more information about AquaMai on their [GitHub page](https://github.com/MewoLab/AquaMai). + Also check our [Unity modding](/extras/unity.md) guide. -## Setting launch options +## Configuring audio -!!! tip "" - Right click `App\Package\start.bat`, select `Edit`. Locate the line that launches `sinmai` and edit it according to your preferences: - - ```bat hl_lines="6" - @echo off - - pushd %~dp0 - - start "AM Daemon" /min inject -d -k mai2hook.dll amdaemon.exe -f -c config_common.json config_server.json config_client.json - inject -d -k mai2hook.dll sinmai -screen-fullscreen 0 -popupwindow -screen-width 2160 -screen-height 1920 -silent-crashes - - taskkill /f /im amdaemon.exe > nul 2>&1 - - echo. - echo Game processes have terminated - pause - ``` - -??? tip "Launch options" - * `-screen-fullscreen 0`: windowed - * `-screen-fullscreen 0 -popupwindow`: borderless windowed - * `-screen-fullscreen 1`: exclusive fullscreen - * `-screen-width -screen-height `: resolution - * `-monitor `: the monitor to run the game on - ??? info "Getting the monitor index" - Navigate to Windows display settings. Each monitor should be assigned a number. - The monitor index is that number. For example, monitor 2 means `-monitor 2`. +--8<-- "docs/snippets/common/audio_48khz.md" ## Connecting to a network -!!! danger "Pick one or the other, not both!" +--8<-- "docs/snippets/sega/common/network_preamble.md" ---8<-- "docs/snippets/sega/common/online_network.md" +--8<-- "docs/snippets/sega/common/network_remote.md" ---8<-- "docs/snippets/sega/common/local_network.md" +--8<-- "docs/snippets/sega/common/network_local.md" ## Installing VCRedist & DirectX --8<-- "docs/snippets/common/setup_vcredist_directx.md" -## Audio properties +## OpenSSL Fix (Intel 10th Gen+) ---8<-- "docs/snippets/common/audio_properties.md" - -## Fixing OpenSSL on Intel 10th Gen and newer CPUs - ---8<-- "docs/snippets/sega/common/openssl.md" +--8<-- "docs/snippets/sega/common/cpu_intel_openssl.md" ## Before playing @@ -224,7 +169,7 @@ ## First launch ---8<-- "docs/snippets/sega/common/first_launch_info.md" +--8<-- "docs/snippets/sega/common/service_jp_googlelens.md" !!! tip "" @@ -248,9 +193,7 @@ Select **終了** (`EXIT`, the last option) to exit to the main service menu. ---8<-- "docs/snippets/sega/common/custom_mods.md" - ---8<-- "docs/snippets/sega/common/finish.md" +--8<-- "docs/snippets/sega/common/success.md" ## Help diff --git a/docs/games/sega/ongeki/common/setup.md b/docs/games/sega/ongeki/common/setup.md index be77090c..f0875583 100644 --- a/docs/games/sega/ongeki/common/setup.md +++ b/docs/games/sega/ongeki/common/setup.md @@ -2,15 +2,15 @@ --8<-- "docs/snippets/common/data_warning.md" ---8<-- "docs/snippets/sega/common/old_data.md" +--8<-- "docs/snippets/sega/common/data_old.md" ## Preparing data ---8<-- "docs/snippets/sega/common/drive_warning.md" +--8<-- "docs/snippets/sega/common/data_driveletter.md" --8<-- "docs/snippets/common/data_readonly.md" ---8<-- "docs/snippets/sega/common/preparing_data.md" +--8<-- "docs/snippets/sega/common/data_preparation.md" ``` 📂license @@ -25,77 +25,77 @@ --8<-- "docs/snippets/sega/common/data_bad.md" -## Updating the base game +## Updating data ---8<-- "docs/snippets/sega/common/updating.md" +--8<-- "docs/snippets/sega/common/data_updating.md" ## Installing option data !!! tip "" - O.N.G.E.K.I. content updates are distributed through option folders instead of patching - the base game. They are named `A???`, with each `?` being a number. Custom options - distributed by the community might use letters instead, to distinguish them from - official ones. + SEGA games receive content updates through option folders rather than direct game file updates. - Extract any options you've downloaded into the `Option` folder. You should end up with - a file structure as follows. **Do not be worried if you have fewer or more option folders.** + For O.N.G.E.K.I., official options are named `A???`, where `???` represents a sequence of numbers. + Community-created options often use letters instead of numbers to differentiate them from official releases. - In some cases, your data may have options in `App\package\option`. If so, move - all contents inside to the `Option` folder where `App` and `AppData` are and delete the `App\package\option` folder. + After downloading option files, extract them into your game's `Option` folder. ``` - 📂A001 - 📂A002 - 📂A003 - 📂A004 - 📂A005 - 📂A006 - 📂A007 - 📂A008 - 📂A009 - 📂A010 - 📂A011 - 📂A012 + 📂amf + 📂App + 📂AppData + 📂Option + ┣━📂A001 + ┣━📂A002 + ┣━📂A012 + ┗━ etc.. ``` +!!! info "Option numbers don't always follow a sequential pattern
It's common to see the numbers jump, for example `A001` then `A012`" + ## Installing unprotected executables !!! tip "" - O.N.G.E.K.I. executables are protected and will not run on a regular computer. + maimai DX executables are protected and will not run on a regular computer. - Obtain unprotected (also called "unpacked" or "decrypted" by the community) - copies of the following files and the associated configuration file: + - Obtain unprotected (also called "unpacked" or "decrypted" by the community) copies of of the following folders and files: - - `amdaemon.exe` - - `mu3.exe` - - `mu3_Data\Plugins\amdaemon_api.dll` - - `mu3_Data\Plugins\chiffre.dll` - - `mu3_Data\Plugins\libhttp.dll` - - `mu3_Data\Plugins\QR_Image.dll` - - `mu3_Data\Managed\AMDaemon.NET.dll` - - `mu3_Data\Managed\Assembly-CSharp-firstpass.dll` - - `mu3_Data\Managed\Assembly-CSharp.dll` - - `mu3.ini` + ``` + 📄amdaemon.exe + 📄mu3.exe + 📂mu3_Data + ┣━📂Plugins + ┃ ┣━📄amdaemon_api.dll + ┃ ┣━📄chiffre.dll + ┃ ┣━📄libhttp.dll + ┃ ┗━📄QR_Image.dll + ┗━📂Managed + ┣━📄AMDaemon.NET.dll + ┣━📄Assembly-CSharp-firstpass.dll + ┗━📄Assembly-CSharp.dll + 📄mu3.ini + ``` - Copy the files and folders into the `App/Package` folder of your game data. Agree to overwrite - when asked. + - Copy all of the above to your data's `App/Package` folder + - Agree to overwrite when asked - !!! Warning "Assembly-CSharp Note" +!!! warning "Assembly-CSharp Notes" - `Assembly-CSharp.dll` **must** match your game version. + `Assembly-CSharp.dll` **must** match your game version. + All other files can be reused between game versions. ## Installing ICFs ---8<-- "docs/snippets/sega/common/icfs.md" +--8<-- "docs/snippets/sega/common/data_icfs.md" ## mu3.ini !!! tip "" + Ensure that the `App\package` folder contains `mu3.ini`. - If this configuration file is missing, create one using the contents below. + If this configuration file is missing, create one using the contents below: ```ini [AM] @@ -109,110 +109,59 @@ WasapiExclusive=0 ``` - !!! danger "Warning" - If you are following the folder structure of this guide, you must ensure that `OptionDev` is set to `0` - in your `mu3.ini`, or else your Option data will not load. +!!! danger "Warning" + When using the folder structure proposed in this guide, setting `OptionDev=0` in `mu3.ini` is required for the game to properly load Option data. ## Installing segatools -!!! tip "" +--8<-- "docs/snippets/sega/common/segatools_install.md" + - Find `mu3.zip` and extract it to your data's `App\Package` folder - - Head over to [segatools releases](https://gitea.tendokyu.moe/Dniel97/segatools/releases) - and download `segatools.zip`. **Do not download the source code.** - - Extracting the archive should give you a few more zip files. Find **`mu3.zip`** - and extract it to the `App\package` folder in your game data. - - You should now have a few more files inside the folder, as shown: + You should now have these files added to your `App\Package` directory: ``` 📂DEVICE - [...] ▶️inject.exe - [...] 📄mu3hook.dll 📄segatools.ini ▶️start.bat - [...] ``` ## Configuring segatools ---8<-- "docs/snippets/sega/common/segatools_stubs.md" +--8<-- "docs/snippets/sega/common/segatools_preamble.md" === "[vfs]" - !!! tip "" - - If you've been matching the file structure as described in the [Preparing data](#preparing-data) - section, you can fill in this section with the values below: - - ```ini - [vfs] - amfs=../../amfs - option=../../Option - appdata=../../AppData - ``` +--8<-- "docs/snippets/sega/common/segatools_relativepaths.md" --8<-- "docs/snippets/sega/common/segatools_vfs.md" ??? tip "mu3-mods" + + Find more info about O.N.G.E.K.I. mods here [mu3-mods](https://gitea.tendokyu.moe/akanyan/mu3-mods/wiki). + Also check our [Unity modding](/extras/unity.md) guide. - It's strongly recommended to use BepInEx mods to improve QOL. - You can find info about the available mods for O.N.G.E.K.I. here [mu3-mods](https://gitea.tendokyu.moe/akanyan/mu3-mods/wiki). - For general modding check [Unity modding](/extras/unity.md) page. +## Configuring audio -## Setting launch options - -!!! tip "" - Right click `App\package\start.bat`, select `Edit`. Locate the line that launches `mu3` and edit it according to your preferences: - - ```bat hl_lines="6" - @echo off - - pushd %~dp0 - - start "AM Daemon" /min inject -d -k mu3hook.dll amdaemon.exe -f -c config_common.json config_server.json config_client.json - inject -d -k mu3hook.dll mu3 -screen-fullscreen 0 -popupwindow -screen-width 1080 -screen-height 1920 - taskkill /f /im amdaemon.exe > nul 2>&1 - - echo. - echo Game processes have terminated - pause - ``` - -??? tip "Launch options" - * `-screen-fullscreen 0`: windowed - * `-screen-fullscreen 0 -popupwindow`: borderless windowed - * `-screen-fullscreen 1`: exclusive fullscreen - * `-screen-width -screen-height `: resolution - ??? warning "Note about resolution" - - The service menu will only render correctly at 1080x1920. - - This can be fixed with a patch. - * `-monitor `: the monitor to run the game on - ??? info "Getting the monitor index" - Navigate to Windows display settings. Each monitor should be assigned a number. - The monitor index is that number. For example, monitor 2 means `-monitor 2`. +--8<-- "docs/snippets/common/audio_48khz.md" ## Connecting to a network -!!! danger "Pick one or the other, not both!" +--8<-- "docs/snippets/sega/common/network_preamble.md" ---8<-- "docs/snippets/sega/common/online_network.md" +--8<-- "docs/snippets/sega/common/network_remote.md" ---8<-- "docs/snippets/sega/common/local_network.md" +--8<-- "docs/snippets/sega/common/network_local.md" ## Installing VCRedist & DirectX --8<-- "docs/snippets/common/setup_vcredist_directx.md" -## Audio properties +## OpenSSL Fix (Intel 10th Gen+) ---8<-- "docs/snippets/common/audio_properties.md" - -## Fixing OpenSSL on Intel 10th Gen and newer CPUs - ---8<-- "docs/snippets/sega/common/openssl.md" +--8<-- "docs/snippets/sega/common/cpu_intel_openssl.md" ## Before playing @@ -220,7 +169,7 @@ ## First launch ---8<-- "docs/snippets/sega/common/first_launch_info.md" +--8<-- "docs/snippets/sega/common/service_jp_googlelens.md" !!! tip "" @@ -262,9 +211,7 @@ Select **終了** (`EXIT`, the last option) to exit to the main service menu, then select **終了** (also the last option) in the main menu to exit the service menu. ---8<-- "docs/snippets/sega/common/custom_mods.md" - ---8<-- "docs/snippets/sega/common/finish.md" +--8<-- "docs/snippets/sega/common/success.md" ## Help diff --git a/docs/games/sega/wacca/reverse/setup.md b/docs/games/sega/wacca/reverse/setup.md index dc9ae44f..0d379e50 100644 --- a/docs/games/sega/wacca/reverse/setup.md +++ b/docs/games/sega/wacca/reverse/setup.md @@ -3,23 +3,17 @@ --8<-- "docs/snippets/common/data_warning.md" ---8<-- "docs/snippets/sega/common/old_data.md" +--8<-- "docs/snippets/sega/common/data_old.md" ## Preparing data ---8<-- "docs/snippets/sega/common/drive_warning.md" +--8<-- "docs/snippets/sega/common/data_driveletter.md" --8<-- "docs/snippets/common/data_readonly.md" - You should end up with a file structure as follows. +--8<-- "docs/snippets/sega/common/data_preparation.md" - ``` - 📂amfs - 📂App - 📂AppData - ``` - - The `App` folder should have a file structure as follows. + The `App` folder should have a file structure as follows: ``` 📂bin @@ -34,83 +28,66 @@ --8<-- "docs/snippets/sega/common/data_bad.md" -## Updating the base game - -!!! tip "" - - Extract all updates in order. Agree to overwrite files if necessary. - - For example, if you have `3.00.00`; install `3.01.00`, then `3.02.00`, etc. +## Updating data +--8<-- "docs/snippets/sega/common/data_updating.md" ## Installing ICFs ---8<-- "docs/snippets/sega/common/icfs.md" +--8<-- "docs/snippets/sega/common/data_icfs.md" ## Patching the game -!!! info "Go through the [Web Patching](/extras/patchweb.md) guide to learn how to use a web patcher." +--8<-- "docs/snippets/sega/common/patching.md" ## Installing segatools !!! tip "" - - Head over to [segatools releases](https://gitea.tendokyu.moe/Dniel97/segatools/releases) - and download `segatools.zip`. **Do not download the source code.** - - Extracting the archive should give you a few more zip files. Find **`mercury.zip`** - and extract it to the `App\bin` folder in your game data. +--8<-- "docs/snippets/sega/common/segatools_install.md" + - Find `mercury.zip` and extract it to your data's `App\bin` folder - You should now have a few more files inside the folder, as shown: + You should now have these files added to your `App\bin` directory: ``` 📂DEVICE - [...] ▶️inject.exe 📄mercuryhook.dll 📄segatools.ini ▶️start.bat - [...] ``` ## Configuring segatools -!!! tip "" - - Since there is no graphical configuration tool for segatools, you will have to edit the - configuration file by hand. It is found in `App\bin\segatools.ini`. - ---8<-- "docs/snippets/sega/common/segatools_stubs.md" +--8<-- "docs/snippets/sega/common/segatools_preamble.md" === "[vfs]" - !!! tip "" +--8<-- "docs/snippets/sega/common/segatools_relativepaths.md" - If you've been matching the file structure as described in the [Preparing data](#preparing-data) - section, you can fill in this section with the values below: +--8<-- "docs/snippets/sega/common/segatools_vfs.md" - ```ini - [vfs] - amfs=../../amfs - appdata=../../AppData - ``` +## Configuring audio - --8<-- "docs/snippets/sega/common/segatools_relative_directories.md" +--8<-- "docs/snippets/common/audio_48khz.md" ## Connecting to a network -!!! danger "Pick one or the other, not both!" +--8<-- "docs/snippets/sega/common/network_preamble.md" ---8<-- "docs/snippets/sega/common/online_network.md" +--8<-- "docs/snippets/sega/common/network_remote.md" ---8<-- "docs/snippets/sega/common/local_network.md" +--8<-- "docs/snippets/sega/common/network_local.md" -## Install FTDI LEDs driver +## Installing FTDI LEDs driver !!! tip "" - Download FTDI drivers from [here](https://ftdichip.com/wp-content/uploads/2023/09/CDM-v2.12.36.4-WHQL-Certified.zip) - and extract them to a folder of your choice, then copy `CDM-v2.12.36.4-WHQL-Certified/amd64/ftd2xx64.dll` to - `/App/WindowsNoEditor/Mercury/Binaries/Win64` and then rename the file to `ftd2xx.dll`. + - Download the [FTDI drivers](https://ftdichip.com/wp-content/uploads/2023/09/CDM-v2.12.36.4-WHQL-Certified.zip) + - Extract them + - Copy `CDM-v2.12.36.4-WHQL-Certified/amd64/ftd2xx64.dll` + to `/App/WindowsNoEditor/Mercury/Binaries/Win64/` + - Rename the file to `ftd2xx.dll` ## Installing VCRedist & DirectX @@ -154,7 +131,7 @@ Note that this will close your game and you will have to start it again with `start.bat`. ---8<-- "docs/snippets/sega/common/finish.md" +--8<-- "docs/snippets/sega/common/success.md" ## Help diff --git a/docs/games/taito/tetoteconnect/setup.md b/docs/games/taito/tetoteconnect/setup.md index 57c3adbd..82de1acc 100644 --- a/docs/games/taito/tetoteconnect/setup.md +++ b/docs/games/taito/tetoteconnect/setup.md @@ -16,7 +16,7 @@ and press `OK`. - Finally, click `OK` again to exit out of properties. - You should end up with a file structure as follows. + You should end up with a file structure as follows: @@ -43,7 +43,7 @@ - Create a folder called `plugins` in the `BepInEx` folder, and move the dll file to that newly created folder. - You should end up with a file structure as follows. + You should end up with a file structure as follows: ``` 📂BepInEx diff --git a/docs/snippets/common/audio_properties.md b/docs/snippets/common/audio_48khz.md similarity index 100% rename from docs/snippets/common/audio_properties.md rename to docs/snippets/common/audio_48khz.md diff --git a/docs/snippets/sega/chunithm/data_options.md b/docs/snippets/sega/chunithm/data_options.md new file mode 100644 index 00000000..476dce39 --- /dev/null +++ b/docs/snippets/sega/chunithm/data_options.md @@ -0,0 +1,23 @@ +!!! tip "" + + SEGA games receive content updates through option folders rather than direct game file updates. + + For CHUNITHM, official options are named `A???`, where `???` represents a sequence of numbers. + Community-created options often use letters instead of numbers to differentiate them from official releases. + + After downloading option files, extract them into your game's `Option` folder. + + ``` + 📂amf + 📂App + 📂AppData + 📂Option + ┣━📂A001 + ┣━📂A121 + ┣━📂A131 + ┗━ etc.. + ``` + +!!! info "Option numbers don't always follow a sequential pattern
It's common to see the numbers jump, for example `A113` then `A121`" + +!!! warning "The `A001` option folder may be required for network connectivity" \ No newline at end of file diff --git a/docs/snippets/sega/chunithm/option_data.md b/docs/snippets/sega/chunithm/option_data.md deleted file mode 100644 index 9e189736..00000000 --- a/docs/snippets/sega/chunithm/option_data.md +++ /dev/null @@ -1,25 +0,0 @@ -!!! tip "" - - CHUNITHM content updates are distributed through option folders instead of patching - the base game. They are named `A???`, with each `?` being a number. Custom options - distributed by the community might use letters instead, to distinguish them from - official ones. - - Extract any options you've downloaded into the `Option` folder. You should end up with - a file structure as follows. **Do not be worried if you have fewer or more option folders.** - - ``` - 📂A001 - 📂A121 - 📂A131 - 📂A132 - 📂A133 - 📂A140 - 📂A141 - 📂A142 - 📂A143 - 📂A151 - 📂A152 - ``` - -!!! warning "If you plan to connect to a network (Hosted or Local), the `A001` option folder for your specific game version is required. This option contains a special Event file that lets the game connect." \ No newline at end of file diff --git a/docs/snippets/sega/chunithm/patching.md b/docs/snippets/sega/chunithm/patching.md deleted file mode 100644 index de74621c..00000000 --- a/docs/snippets/sega/chunithm/patching.md +++ /dev/null @@ -1,7 +0,0 @@ -!!! info "Go through the [Web Patching](/extras/patchweb.md) guide to learn how to use a web patcher." - - There are **many** patches for CHUNITHM. - - We will only bring up the ones we think could be genuinely useful. - -!!! danger "As a general rule of thumb, if you're not sure what a patch does or you're not absolutely certain you need it, leave it alone, regardless of recommendations below." \ No newline at end of file diff --git a/docs/snippets/sega/chunithm/segatools_gfx.md b/docs/snippets/sega/chunithm/segatools_gfx.md index 65541944..97b31148 100644 --- a/docs/snippets/sega/chunithm/segatools_gfx.md +++ b/docs/snippets/sega/chunithm/segatools_gfx.md @@ -1,10 +1,10 @@ - !!! tip "" + !!! tip "Display settings" - - Set `windowed` to `0` to run in fullscreen mode and `1` to run in windowed mode. - - If you have multiple monitors and you're running in fullscreen mode (`windowed=0`), - set `monitor` to the index of the monitor you want to run the game on. + - Use `windowed=0` for fullscreen mode or `windowed=1` for windowed mode + - For multi-monitor setups in fullscreen mode, specify your target display using the `monitor` index setting - ??? info "Getting the monitor index" + ??? info "Finding your monitor index" - Navigate to Windows display settings. Each monitor should be assigned a number. - The monitor index is that number minus one. For example, monitor 2 means monitor index 1. \ No newline at end of file + Open Windows display settings to find your monitor numbers. + Your monitor's index is one less than the displayed number. + For example, if Windows shows "Display 2", use monitor index 1. \ No newline at end of file diff --git a/docs/snippets/sega/chunithm/unprotected_executables.md b/docs/snippets/sega/chunithm/unprotected_executables.md deleted file mode 100644 index 6c17e570..00000000 --- a/docs/snippets/sega/chunithm/unprotected_executables.md +++ /dev/null @@ -1,9 +0,0 @@ -!!! tip "" - - CHUNITHM executables are protected and will not run on a regular computer. - - Obtain unprotected (also called "unpacked" or "decrypted" by the community) - copies of `chusanApp.exe` and `amdaemon.exe` for your game version. - - Copy `chusanApp.exe` and `amdaemon.exe` to the `bin` folder of your game data. Agree - to overwrite when asked. \ No newline at end of file diff --git a/docs/snippets/sega/chunithm/unprotected_exes.md b/docs/snippets/sega/chunithm/unprotected_exes.md new file mode 100644 index 00000000..369f170d --- /dev/null +++ b/docs/snippets/sega/chunithm/unprotected_exes.md @@ -0,0 +1,8 @@ +!!! tip "" + + CHUNITHM executables are protected and will not run on a regular computer. + + Obtain unprotected (also called "unpacked" or "decrypted" by the community) copies of `chusanApp.exe` and `amdaemon.exe` for your game version. + + - Copy `chusanApp.exe` and `amdaemon.exe` to data's `App\bin` folder + - Agree to overwrite when asked \ No newline at end of file diff --git a/docs/snippets/sega/common/openssl.md b/docs/snippets/sega/common/cpu_intel_openssl.md similarity index 100% rename from docs/snippets/sega/common/openssl.md rename to docs/snippets/sega/common/cpu_intel_openssl.md diff --git a/docs/snippets/sega/common/data_bad.md b/docs/snippets/sega/common/data_bad.md index 2946249b..42e1a898 100644 --- a/docs/snippets/sega/common/data_bad.md +++ b/docs/snippets/sega/common/data_bad.md @@ -2,8 +2,8 @@ If your data looks like the third example: - - Create an `App` folder and move all files and folders from the image inside of it. - - Create empty folders named `amfs`, `Option` and `AppData` next to the `App` folder. + - Create an `App` folder and move all files and folders from the image inside of it + - Create empty folders named `amfs`, `Option` and `AppData` next to the `App` folder If extra directories or files are still present (executables, scripts, etc.), **remove them**. diff --git a/docs/snippets/sega/common/data_driveletter.md b/docs/snippets/sega/common/data_driveletter.md new file mode 100644 index 00000000..80b8fb7b --- /dev/null +++ b/docs/snippets/sega/common/data_driveletter.md @@ -0,0 +1 @@ +!!! danger "Game data cannot run on `E:\` or `Y:\` drives, use a different drive letter" \ No newline at end of file diff --git a/docs/snippets/sega/common/icfs.md b/docs/snippets/sega/common/data_icfs.md similarity index 100% rename from docs/snippets/sega/common/icfs.md rename to docs/snippets/sega/common/data_icfs.md diff --git a/docs/snippets/sega/common/custom_mods.md b/docs/snippets/sega/common/data_modding.md similarity index 71% rename from docs/snippets/sega/common/custom_mods.md rename to docs/snippets/sega/common/data_modding.md index 00ef0852..d17a681f 100644 --- a/docs/snippets/sega/common/custom_mods.md +++ b/docs/snippets/sega/common/data_modding.md @@ -1,2 +1,3 @@ -??? tip "Custom Mods" +??? tip "Modding" + Mods are covered on the [Unity modding](/extras/unity.md) page. \ No newline at end of file diff --git a/docs/snippets/sega/common/old_data.md b/docs/snippets/sega/common/data_old.md similarity index 63% rename from docs/snippets/sega/common/old_data.md rename to docs/snippets/sega/common/data_old.md index cd889ee3..83c981fd 100644 --- a/docs/snippets/sega/common/old_data.md +++ b/docs/snippets/sega/common/data_old.md @@ -1,4 +1,4 @@ !!! danger "If you're coming from a previous version of the game" - You'll want to create a new folder for the game and start from scratch. + You'll want to create a new folder for the game and start from scratch. SEGA games **DO NOT** like being extracted over old data! \ No newline at end of file diff --git a/docs/snippets/sega/common/preparing_data.md b/docs/snippets/sega/common/data_preparation.md similarity index 52% rename from docs/snippets/sega/common/preparing_data.md rename to docs/snippets/sega/common/data_preparation.md index 3466fc1a..e9cdd6c1 100644 --- a/docs/snippets/sega/common/preparing_data.md +++ b/docs/snippets/sega/common/data_preparation.md @@ -6,7 +6,7 @@ 📂Option ``` - Create another empty folder named `AppData` next to them. It should now look like below: + Create another empty folder named `AppData` next to them: ``` 📂amf diff --git a/docs/snippets/sega/common/updating.md b/docs/snippets/sega/common/data_updating.md similarity index 50% rename from docs/snippets/sega/common/updating.md rename to docs/snippets/sega/common/data_updating.md index 8e58f1d6..dd1c25d2 100644 --- a/docs/snippets/sega/common/updating.md +++ b/docs/snippets/sega/common/data_updating.md @@ -1,4 +1,4 @@ !!! tip "" - Extract your patch's files to your existing data in a way that matches its - file structure. Agree to overwrite files if necessary. \ No newline at end of file + Extract your patch's files to your existing data in a way that matches its file structure. + Agree to overwrite files if necessary. \ No newline at end of file diff --git a/docs/snippets/sega/common/drive_warning.md b/docs/snippets/sega/common/drive_warning.md deleted file mode 100644 index ed53ae86..00000000 --- a/docs/snippets/sega/common/drive_warning.md +++ /dev/null @@ -1 +0,0 @@ -!!! danger "There are currently issues with running game data in the `E:\` or `Y:\` drive.
Please extract the data into other drives." \ No newline at end of file diff --git a/docs/snippets/sega/common/first_launch_info.md b/docs/snippets/sega/common/first_launch_info.md deleted file mode 100644 index c4617355..00000000 --- a/docs/snippets/sega/common/first_launch_info.md +++ /dev/null @@ -1,4 +0,0 @@ -!!! tip - - Without an English patch, the service menu will be in Japanese. If you don't know Japanese, [Google Lens](https://lens.google/) - is a handy tool for navigating this menu. \ No newline at end of file diff --git a/docs/snippets/sega/common/local_network.md b/docs/snippets/sega/common/local_network.md deleted file mode 100644 index 73bd5d6a..00000000 --- a/docs/snippets/sega/common/local_network.md +++ /dev/null @@ -1,5 +0,0 @@ -??? tip "Option 2: Local (ARTEMiS/AquaDX)" - - Both of these local networks require non-trivial setup. Refer to the official guides for [ARTEMiS](https://gitea.tendokyu.moe/Hay1tsme/artemis/src/branch/develop/docs/INSTALL_WINDOWS.md) - and [AquaDX](https://github.com/hykilpikonna/AquaDX?tab=readme-ov-file#usage-v1-developmental-preview) - to set up a local server. \ No newline at end of file diff --git a/docs/snippets/sega/common/network_local.md b/docs/snippets/sega/common/network_local.md new file mode 100644 index 00000000..fe3186e2 --- /dev/null +++ b/docs/snippets/sega/common/network_local.md @@ -0,0 +1,3 @@ +??? tip "Option 2: Local (ARTEMiS/AquaDX)" + + Refer to the official guides for [ARTEMiS](https://gitea.tendokyu.moe/Hay1tsme/artemis/src/branch/develop/docs/INSTALL_WINDOWS.md) and [AquaDX](https://github.com/hykilpikonna/AquaDX?tab=readme-ov-file#usage-v1-developmental-preview) to set up a local server. \ No newline at end of file diff --git a/docs/snippets/sega/chunithm/only_artemis.md b/docs/snippets/sega/common/network_local_artemisonly.md similarity index 100% rename from docs/snippets/sega/chunithm/only_artemis.md rename to docs/snippets/sega/common/network_local_artemisonly.md diff --git a/docs/snippets/sega/common/network_preamble.md b/docs/snippets/sega/common/network_preamble.md new file mode 100644 index 00000000..59bacbbc --- /dev/null +++ b/docs/snippets/sega/common/network_preamble.md @@ -0,0 +1 @@ +!!! danger "Pick one or the other, not both!" \ No newline at end of file diff --git a/docs/snippets/sega/common/online_network.md b/docs/snippets/sega/common/network_remote.md similarity index 100% rename from docs/snippets/sega/common/online_network.md rename to docs/snippets/sega/common/network_remote.md diff --git a/docs/snippets/sega/common/patching.md b/docs/snippets/sega/common/patching.md new file mode 100644 index 00000000..8eee2870 --- /dev/null +++ b/docs/snippets/sega/common/patching.md @@ -0,0 +1,3 @@ +!!! info "Go through the [Web Patching](/extras/patchweb.md) guide to learn how to use a web patcher" + +!!! danger "Avoid patching anything you don't need or understand unless explicitly told to" \ No newline at end of file diff --git a/docs/snippets/sega/common/segatools_install.md b/docs/snippets/sega/common/segatools_install.md new file mode 100644 index 00000000..b3bc3483 --- /dev/null +++ b/docs/snippets/sega/common/segatools_install.md @@ -0,0 +1,5 @@ +!!! tip "" + + - Head over to [segatools releases](https://gitea.tendokyu.moe/TeamTofuShop/segatools/releases) + - Download `segatools.zip` + - Extract the archive \ No newline at end of file diff --git a/docs/snippets/sega/common/segatools_preamble.md b/docs/snippets/sega/common/segatools_preamble.md new file mode 100644 index 00000000..a5ee935e --- /dev/null +++ b/docs/snippets/sega/common/segatools_preamble.md @@ -0,0 +1,15 @@ +!!! info "" + + You'll need to manually edit `App\bin\segatools.ini` as segatools has no graphical configuration tool. + + We recommend using a text editor with syntax highlighting such as [Notepad++](https://notepad-plus-plus.org/). + + The following sections match those found in `segatools.ini` - skip any sections not listed below. + + If a key already exists in a section, simply change its value after `=`, do not add another key. + + ```ini + [system] + dipsw2=1 + dipsw2=1 ; WRONG! + ``` \ No newline at end of file diff --git a/docs/snippets/sega/common/segatools_relative_directories.md b/docs/snippets/sega/common/segatools_relative_directories.md deleted file mode 100644 index 7bbe82ba..00000000 --- a/docs/snippets/sega/common/segatools_relative_directories.md +++ /dev/null @@ -1,15 +0,0 @@ - ??? info "Relative Directories" - - The `../` in the above example represents the parent directory in a relative path. It is used to navigate up one level in the directory hierarchy. - - For example, your segatools.ini is located at `/App/bin/segatools.ini` and your Option folder is located next to the App folder. - - Since segatools.ini is in the `/bin/` folder, typing `../` would move you up to the App folder. Since the Option folder is next to the App folder, the second `../` takes you to `App`'s parent folder, which is the folder containing `App`, `Option`, etc. - - The benefits of using this method include: - - - Avoiding issues that arise when folders have spaces in their names. - - - Being able to move your game folder without redefining the locations of your VFS folders. - - - A cleaner and easier to read segatools.ini, making spotting issues simpler. \ No newline at end of file diff --git a/docs/snippets/sega/common/segatools_relativepaths.md b/docs/snippets/sega/common/segatools_relativepaths.md new file mode 100644 index 00000000..1a0a4bd3 --- /dev/null +++ b/docs/snippets/sega/common/segatools_relativepaths.md @@ -0,0 +1,18 @@ + ??? info "Relative Paths" + + Relative paths make your configuration portable and easier to maintain. + + Say your game folder structure looks like this: + + ``` + 📂Game Folder + ┣━📂App + ┃ ┗━📄segatools.ini + ┗━📂Option + ``` + + If `segatools.ini` needs to access the `Option` folder, you can use `../../Option/`: + + - `../` moves up from `bin` to `App` + - `../` moves up again from `App` to the root `Game Folder` + - Then it can access the `Option` folder \ No newline at end of file diff --git a/docs/snippets/sega/common/segatools_stubs.md b/docs/snippets/sega/common/segatools_stubs.md deleted file mode 100644 index 166c04c9..00000000 --- a/docs/snippets/sega/common/segatools_stubs.md +++ /dev/null @@ -1,15 +0,0 @@ - It is recommended that you follow along using a text editor with syntax highlighting such as [Notepad++](https://notepad-plus-plus.org/). - - Each following sub-section will correspond to a section in `segatools.ini`. If any - section is not mentioned, you can skip them. - -!!! warning - - If a key already exists in the section, delete everything after `=` and replace it with your - setting. Do not add another key. - - ```ini - [system] - dipsw2=1 - dipsw2=1 ; WRONG! - ``` \ No newline at end of file diff --git a/docs/snippets/sega/common/segatools_vfs.md b/docs/snippets/sega/common/segatools_vfs.md new file mode 100644 index 00000000..f02724c4 --- /dev/null +++ b/docs/snippets/sega/common/segatools_vfs.md @@ -0,0 +1,12 @@ + !!! tip "" + + If you've followed our recommended file structure, use these values: + + ```ini + [vfs] + amfs=../../amfs + option=../../Option + appdata=../../AppData + ``` + + If not, point those to their respective folders. \ No newline at end of file diff --git a/docs/snippets/sega/common/service_jp_googlelens.md b/docs/snippets/sega/common/service_jp_googlelens.md new file mode 100644 index 00000000..21ddd46e --- /dev/null +++ b/docs/snippets/sega/common/service_jp_googlelens.md @@ -0,0 +1,4 @@ +!!! note "" + + Without an English patch, the service menu will be in Japanese. + If you don't know Japanese, [Google Lens](https://lens.google/) is a handy tool for navigating this menu. \ No newline at end of file diff --git a/docs/snippets/sega/common/finish.md b/docs/snippets/sega/common/success.md similarity index 100% rename from docs/snippets/sega/common/finish.md rename to docs/snippets/sega/common/success.md