From 9ff151cd26dc743ab56e007c6e80fc1c8baafb97 Mon Sep 17 00:00:00 2001 From: auxbh Date: Thu, 29 May 2025 08:14:32 +0200 Subject: [PATCH] Change snippets usage and fixes --- .../games/sega/chunithm/common/chuni/setup.md | 17 ++++++++++++++ .../common/chuni/setupcrystalbelow.md | 17 ++++++++++++++ .../sega/chunithm/common/chusan/setup.md | 17 ++++++++++++++ docs/games/sega/maimaidx/common/setup.md | 23 ++++++++++++++++--- docs/games/sega/ongeki/common/setup.md | 12 ++++++++++ docs/games/sega/wacca/reverse/setup.md | 23 ++++++------------- ...s.md => segatools_relative_directories.md} | 12 ---------- docs/snippets/sega/common/segatools_stubs.md | 5 ---- 8 files changed, 90 insertions(+), 36 deletions(-) rename docs/snippets/sega/common/{segatools_vfs.md => segatools_relative_directories.md} (72%) diff --git a/docs/games/sega/chunithm/common/chuni/setup.md b/docs/games/sega/chunithm/common/chuni/setup.md index 76fc992a..66157fa0 100644 --- a/docs/games/sega/chunithm/common/chuni/setup.md +++ b/docs/games/sega/chunithm/common/chuni/setup.md @@ -69,10 +69,27 @@ ## 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" === "[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]" diff --git a/docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md b/docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md index 53cbe044..3b4f7e53 100644 --- a/docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md +++ b/docs/games/sega/chunithm/common/chuni/setupcrystalbelow.md @@ -63,10 +63,27 @@ ## 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" === "[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]" diff --git a/docs/games/sega/chunithm/common/chusan/setup.md b/docs/games/sega/chunithm/common/chusan/setup.md index e5b4f69d..602b63ed 100644 --- a/docs/games/sega/chunithm/common/chusan/setup.md +++ b/docs/games/sega/chunithm/common/chusan/setup.md @@ -71,10 +71,27 @@ ## 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" === "[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" === "[system]" diff --git a/docs/games/sega/maimaidx/common/setup.md b/docs/games/sega/maimaidx/common/setup.md index 31c52b53..106a6435 100644 --- a/docs/games/sega/maimaidx/common/setup.md +++ b/docs/games/sega/maimaidx/common/setup.md @@ -17,7 +17,7 @@ 📂package 📄firewall.cfg 📄game.bat - ▶️pwGetHwinfo.ini + ▶️pwGetHwinfo.exe 📄pxGetHwInfo.ini 📄system_config.json ``` @@ -131,11 +131,28 @@ ## 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" === "[vfs]" ---8<-- "docs/snippets/sega/common/segatools_vfs.md" + !!! 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_relative_directories.md" ??? tip "AquaMai" @@ -146,7 +163,7 @@ ## Setting launch options !!! tip "" - Right click `App\package\start.bat`, select `Edit`. Locate the line that launches `sinmai` and edit it according to your preferences: + 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 diff --git a/docs/games/sega/ongeki/common/setup.md b/docs/games/sega/ongeki/common/setup.md index 8cc53b2a..4edff74f 100644 --- a/docs/games/sega/ongeki/common/setup.md +++ b/docs/games/sega/ongeki/common/setup.md @@ -133,6 +133,18 @@ === "[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" ??? tip "mu3-mods" diff --git a/docs/games/sega/wacca/reverse/setup.md b/docs/games/sega/wacca/reverse/setup.md index c9f135ff..815b7008 100644 --- a/docs/games/sega/wacca/reverse/setup.md +++ b/docs/games/sega/wacca/reverse/setup.md @@ -66,11 +66,16 @@ ## 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" === "[vfs]" -!!! tip "" + !!! 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: @@ -81,21 +86,7 @@ appdata=../../AppData ``` - ??? 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. + --8<-- "docs/snippets/sega/common/segatools_relative_directories.md" ## Connecting to a network diff --git a/docs/snippets/sega/common/segatools_vfs.md b/docs/snippets/sega/common/segatools_relative_directories.md similarity index 72% rename from docs/snippets/sega/common/segatools_vfs.md rename to docs/snippets/sega/common/segatools_relative_directories.md index a853e711..7bbe82ba 100644 --- a/docs/snippets/sega/common/segatools_vfs.md +++ b/docs/snippets/sega/common/segatools_relative_directories.md @@ -1,15 +1,3 @@ - !!! 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 - ``` - ??? 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. diff --git a/docs/snippets/sega/common/segatools_stubs.md b/docs/snippets/sega/common/segatools_stubs.md index 99fde821..166c04c9 100644 --- a/docs/snippets/sega/common/segatools_stubs.md +++ b/docs/snippets/sega/common/segatools_stubs.md @@ -1,8 +1,3 @@ -!!! 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`. - 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