commit a1d69c973228c44cf5bf421a960b5f759d5ef446 Author: asterisk727 <59166650+asterisk727@users.noreply.github.com> Date: Mon Dec 29 19:22:46 2025 +0900 chore: initial commit diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..f6c1031 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,43 @@ +name: Build +on: + push: + branches: + - master + - main + +permissions: + contents: write + +jobs: + deploy: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: "3.x" + + - name: Install uv + run: | + curl -LsSf https://astral.sh/uv/install.sh | sh + echo "$HOME/.cargo/bin" >> $GITHUB_PATH + + - name: Cache uv environment + uses: actions/cache@v4 + with: + path: .venv + key: ${{ runner.os }}-uv-${{ hashFiles('uv.lock') }} + restore-keys: | + ${{ runner.os }}-uv- + + - name: Install dependencies + run: uv sync --frozen + + - name: Build and deploy site + run: uv run mkdocs gh-deploy --force diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8c50358 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.idea +mkdocs-material/ +/.vs +.venv/ diff --git a/CNAME b/CNAME new file mode 100644 index 0000000..f49715f --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +two-torial.xyz diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bdf230a --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright 2023-202x two-torial Team & contributors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e1a4f3 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +

+ +

+ +# + +TWO-TORIAL, a compendium of information and guides about arcade games. It also serves as a comprehensive resource, providing a structured approach to setting up arcade games from specific franchises. This guide aims to offer clear instructions, troubleshooting tips, and essential information for enthusiasts and newcomers alike. + + + +## About + +This repository houses a guide dedicated to assisting individuals in configuring and navigating the setup process for various arcade games within this specific gaming genre. It covers essential aspects of installation, configuration, and troubleshooting, aiming to streamline the experience for users. + +## Contributing + +We welcome contributions to TWO-TORIAL. To contribute, follow these steps: + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/LeBranch`) +3. Commit your Changes (`git commit -m 'Added le feature`) +4. Push to the Branch (`git push origin feature/LeBranch`) +5. Open a Pull Request + +For quick local iteration, you can setup your own [mkdocs](https://www.mkdocs.org/user-guide/installation/) environment: + +1. Install the latest [Python](https://www.python.org/) and [uv](https://docs.astral.sh/uv/#installation) +2. Change directory to the root of your forked project and run `uv sync` +3. From the same root directory run `uv run mkdocs serve` +4. You can also add `--dirty` at the end of the above command to speed up live reloads, but rendering errors could occur + +You can now access your live preview at `http://127.0.0.1:8000/` +The live preview will update in real time as changes are found in your files. + +## License + +TWO-TORIAL is licensed under the Apache License 2.0. You can find the full text of the license in the [LICENSE](LICENSE) file. + +## Additional Notes + +The TWO-TORIAL team does not provide any tools to circumvent software copy protection, nor distribute any copyright-protected game data. + +Documentation plays a crucial role in fostering understanding and accessibility within any domain. Detailed guides not only facilitate smoother experiences but also encourage the growth of communities by empowering individuals to engage more deeply. By documenting the intricacies of setup and configuration, this guide aims to support users in their journey through the realm of rhythm gaming. + +Feel free to tailor or modify this template according to your preferences or specific content requirements for the repository. diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..f49715f --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +two-torial.xyz diff --git a/docs/errorcodes/konami.md b/docs/errorcodes/konami.md new file mode 100644 index 0000000..a5311aa --- /dev/null +++ b/docs/errorcodes/konami.md @@ -0,0 +1,138 @@ +# KONAMI Error Codes + +!!! info "Synopsis" + + This section contains various Konami games error codes you might run across and potential steps to resolve them. + +## Universal + +### 5-0000-0000 + +!!! tip "" + + This error can be caused by: + + - Having multiple network adapters enabled - try disabling unused ones in Device Manager + - Game files being set as read-only - ensure all files are writable + +### 5-2000-0000 / 5-2002-0915 / 5-2600-0000 + +!!! tip "" + + These errors are network related. + + Check that: + + - Your internet connection is working + - Your data version is supported by the server + - The server is online and running + - Your `EA Service URL (-url)` option is correctly set + - Your `PCBID (-p)` option is correctly set + +## IIDX + +### 5-1500-0002 + +!!! tip "SOUND DATA CREATE ERROR" + + Data is corrupt, incomplete, or incorrectly modified. + Redownload data from trusted source. + +### 5-1503-0004 + +!!! tip "USBIO ERROR (NO ANSWER...)" + + The game times out when trying to communicate with I/O. + + - For home play: I/O emulation could be too slow due to background services (file sync, antivirus, Windows Updates) or bad hardware. Try running tools at higher process priority. + - For cabinets: Hardware issue with I/O board. Check cables and power supply. + +### 5-1505-0001 + +!!! tip "SSD DATA ERROR" + + Data is corrupt, incomplete, or incorrectly modified. + Redownload data from trusted source. + +### 5-1503-0042 + +!!! tip "CAMERA DEVICE ERROR" + + Missing/non-functional camera devices. Either connect necessary cameras, use the `-iidxdisablecams` Option or patch the game to bypass this check. Can be temporarily bypassed with `Test` button. + +### 5-1503-0043 + +!!! tip "MONITOR ERROR" + + The game isn´t finding a valid monitor. Most likely culprit is your refresh rate being wrong. + +### 5-1506-0001 + +!!! tip "CLOCK ERROR" + + Enter `Test` menu, go to `CLOCK`, then `SAVE AND EXIT`. + +## Sound Voltex + +### 5-1506-0000 + +!!! tip "ACIO ERROR" + + Caused by corrupt `libacio.dll`. Redownload from a trusted source. If the error persists, redownload entire game data. + +### 5-2009-0000 + +!!! tip "" + + Caused by modified DLL files in Sound Voltex Booth. Keep files unmodified and reinstall from a trusted source if needed. + +## pop'n music + +### 5-1509-0000 + +!!! tip "" + + Occurs during gameplay. Verify service URL and PCBID are set correctly. + +### 5-2002-2400 + +!!! tip "" + + Setup error in pop'n Usaneko. Follow [Game Setup](/games/konami/popn/usaneko/setup.md) and use proper `-url` and `-p` parameters in SpiceTools. + +## jubeat + +### 5-2500-0000 + +!!! tip "BACKUP DATA ERROR" + + Press your `Test` button to get past this. + +## GITADORA + +### 5-1506-0000 / 5-2501-0000 + +!!! tip "" + + These errors are typically caused by having multiple network adapters enabled, disable unused ones in Device Manager. + +### 5-1698-0000 + +!!! tip "APPLICATION ERROR" + + This error usually indicates a problem with your game DLLs. If the error persists, redownload entire game data. + +### 5-2500-0001 + +!!! tip "BACKUP DATA ERROR" + + Press your `Test` button to get past this. + +## NOSTALGIA + +### 5-1501-0000 + +!!! tip "" + + This error results from a bad AVS config. + Redownload data from trusted source. diff --git a/docs/errorcodes/sega.md b/docs/errorcodes/sega.md new file mode 100644 index 0000000..cf8abe2 --- /dev/null +++ b/docs/errorcodes/sega.md @@ -0,0 +1,304 @@ +# SEGA Error Codes + +!!! info "Synopsis" + + This section contains various SEGA games error codes you might run across and potential steps to resolve them. + +## Universal + +### 0000 + +!!! tip "Unexpected Error Occured" + + Data is corrupt, incomplete, or incorrectly modified. + Redownload data from trusted source. + +### 0032 + +!!! tip "Unexpected Error Occured" + + Generic network error with multiple symptoms, the most typical of which being enabling DHCP in Windows while the game expects a static IP. + + Try adding this to `config_hook.json`: + + ```json + { + "network": { + "property": { + "dhcp": true + } + } + } + ``` + + If you're copying into an existing `config_hook.json`, remove the outer braces and add a comma to the previous item, like so: + + ```json + { + "emoney": { + "enable": false + }, + "network": { + "property": { + "dhcp": true + } + } + } + ``` + + If your game files does not include `config_hook.json`, it is OK to create a new file. + Then edit the launch script (usually `launch.bat`) to tell the game about it: + + ``` + amdaemon.exe -f -c config_common.json config_server.json config_client.json {++config_hook.json++} + ``` + +### 0800 + +!!! tip "Unknown Error" + + Generic network error usually thrown because the game is not able to connect to a server. + + Make sure that you have correctly entered your network's address in `segatools.ini` under the `[dns]` section: + + ```ini + [dns] + ; Can also be an IP address: + ; default=192.168.34.23 + default=example.com + ``` + +### 0919 + +!!! tip "DVD Drive Remain Error" + + This error occurs if the game detects an enabled DVD drive on the system. + To resolve, either disable your computer's DVD drive, or enable DVD drive emulation in `segatools.ini`: + + ```ini hl_lines="2" + [dvd] + enable=1 + ``` + +### 0949 + +!!! tip "Keychip Not Found" + + Enable keychip emulation in `segatools.ini`: + + ```ini hl_lines="2" + [keychip] + enable=1 + ``` + + If on a real cabinet using a real keychip, confirm that the keychip is connected properly and working. + +### 4104 + +!!! tip "Unexpected Error Occured" + + Make sure that the game files are not on the `E:` or `Y:` drive. + If that is already the case, check if the config files passed to AM Daemon exists and are valid JSON files: + + ```hl_lines="5" + Runtime exception occurred. + File: D:\Jenkins\workspace\amdaemon_all_build\libs\amdproc\src\ConfigFileLoader.cpp + Line: 79 + Function: enum amdaemon::process::ConfigFileLoader::Result __cdecl `anonymous-namespace'::parse(const class std::basic_string,class std::allocator > &,class picojson::value &) + Message: Cannot open "config_nonexistent.json". + ``` + + ```hl_lines="5 6" + Runtime exception occurred. + File: D:\Jenkins\workspace\amdaemon_all_build\libs\amdproc\src\ConfigFileLoader.cpp + Line: 89 + Function: enum amdaemon::process::ConfigFileLoader::Result __cdecl `anonymous-namespace'::parse(const class std::basic_string,class std::allocator > &,class picojson::value &) + Message: Cannot parse ".\config_hook.json". + syntax error at line 6 near: } + ``` + +### 4105 + +!!! tip "Unexpected Error Occured" + + Check the AM Daemon window for any "runtime exception" messages, such as: + + ```hl_lines="6" + amsGfetcherThreadContextInit: Line1345 Error: load Icf failed. + Runtime exception occurred. + File: D:\Jenkins\workspace\amdaemon_all_build\libs\libamw\src\amw_netdeliver_context.cpp + Line: 91 + Function: enum am::util::ModuleContext<3>::Status __cdecl am::netdeliver::Context::initialize(void) + Message: amGfetcherInit(). ErrCode -1. + ``` + + Then continue by checking [AMDaemon error codes](#amdaemon). + +### 6401 + +!!! tip "I/O board is not connected to main board" + + This error occurs when the game times out trying to communicate with the I/O board. + + When using segatools, this happens because I/O emulation took too long, which is usually caused by long-running background tasks (e.g. Windows Defender, Windows Update, file-syncing software). + Try to see if this can be fixed by setting the game process and/or `amdaemon.exe` to high/realtime priority. + +### 6501 + +!!! tip "Aime Card Reader Not Found" + + This error occurs when an Aime card reader is not found. + Make sure you enabled Aime card reader emulation in `segatools.ini` if you don't have a physical reader connected: + + ```ini + [aime] + enable=1 + ``` + +### 6503 + +!!! tip "Failed to read Aime card" + + This error occurs when the Aime card cannot be read. + Make sure your connection to the ALL.Net server is good (the network icon in the bottom corner is green). + +### 8114 + +!!! tip "ALL.Net System error (RTC)" + + Make sure you're connected to an ALL.Net server for the first boot, or disable accounting by editing `config_hook.json`: + + ```json + { + "allnet_accounting": { + "enable": false + } + } + ``` + + If you're copying into an existing `config_hook.json`, remove the outer braces and add a comma to the previous item, like so: + + ```json + { + "emoney": { + "enable": false + }, + "allnet_accounting": { + "enable": false + } + } + ``` + + If your game files does not include `config_hook.json`, it is OK to create a new file. + Then edit the launch script (usually `launch.bat`) to tell the game about it: + + ``` + amdaemon.exe -f -c config_common.json config_server.json config_client.json {++config_hook.json++} + ``` + +## CHUNITHM + +### 3101, 3102 + +!!! tip "An unexpected error has occurred with the main device
Initialization failure with the main device" + + This error occurs when the game fails to communicate with the controller. + Check if your controller is connected properly and if ChuniIO DLLs are working. + +### 3201, 3202, 3203, 3204, 3205, 3206 + +!!! tip "Cannot confirm the connection with the side device sensor 1/2/3/4/5/6" + + This error occurs if the air sensors are not functional or blocked during system test. + To resolve this, enter and exit Test mode by pressing the F1 key (or 1 on older segatools) then stay clear of your controller. + If the error still happens, your air sensors may be faulty. + +### 3300 + +!!! tip "Duplicate servers in the same network" + + If multiple CHUNITHM machines are on the same LAN network, only one of them can be the server (dip switch 1 ON). Set all other machines to dip switch 1 OFF: + + ```ini hl_lines="2" + [system] + dipsw1=0 + ``` + +!!! warning "As of 2024-08-20, the [gpio] section in segatools has been renamed to [system]" + +### 3301 + +!!! tip "Duplicate STANDARD in the same group" + + If multiple CHUNITHM machines are on the same LAN network and cabinet group (A/B/C/D), one of them should set reference machine settings to STANDARD and the rest to FOLLOW THE STANDARD. + + Change this by going to Test menu > Game Settings (4th option) > Reference machine settings (2nd option). + +### 3400 + +!!! tip "Monitor Not Supported 120fps" + + This error occurs if your monitor is not set to `1920x1080@120 Hz` at 32-bit color mode. + Adjust display settings and try again. + +### 3401 + +!!! tip "Machine Not Supported 120fps" + + This error occurs if you're running the game in CVT mode at 120fps. + Use SP mode (dip switch 3 OFF) to run the game in 120fps. + In `segatools.ini` this would be: + + ```ini + [system] + dipsw3=0 + ``` + +!!! warning "As of 2024-08-20, the [gpio] section in segatools has been renamed to [system]" + +## AMDaemon + +### ampdGd1232a01aInit(). ErrCode -4 + +!!! tip "" + + This error occurs because of a VFD port number mismatch. + + Update segatools, or if you're using a real VFD, confirm that the VFD uses the same port as specified in `config_common.json` or `config_sp.json` (CHUNITHM) under `emoney.display_port`: + + ```json + "emoney" : + { + "display_port" : 2 + } + ``` + + The value should match the COM port that your real VFD is connected to. + +### amAppImageInit(). ErrCode -5 + +!!! tip "" + + Path to the configured AMFS directory is too long. + Ensure that the path is shorter than 16 characters (32 bytes). + +### RegCreateKeyExW(). ErrorCode -5 + +!!! tip "" + + This error occurs because the Windows registry cannot be written to as a normal user. + Start the game as administrator **once**, or update segatools. + +### amSysFileInitEx(). ErrCode -5 + +!!! tip "" + + The AMFS folder is read only. + Uncheck the read only property in file explorer for the AMFS folder. + +### amGfetcherInit(). ErrCode -1 + +!!! tip "" + + ICF1 is missing in the configured AMFS directory. + Get the correct ICF for your game (the game ID in the ICF must be correct). \ No newline at end of file diff --git a/docs/extras/asphyxia.md b/docs/extras/asphyxia.md new file mode 100644 index 0000000..7eef8fc --- /dev/null +++ b/docs/extras/asphyxia.md @@ -0,0 +1,152 @@ + +# Asphyxia + +!!! danger "Existing save data" + + If you have previously used Asphyxia, be sure to backup your **savedata** folder located next to the `plugins` directory. + This folder contains important data including your game profiles and scores that you may want to keep. + +## What is Asphyxia? + +!!! tip "" + + Asphyxia is a tool that handles online services for BEMANI games by simulating an e-amusement network, enabling features like score saving, profile management, game events and other online functionality. + + It consists of two main components: + + - Asphyxia **CORE**: The foundational framework that provides the base functionality but no game support by itself + - Asphyxia **PLUGINS**: Community-developed modules that implement game-specific features and support + +## Downloading Asphyxia + +!!! tip "" + + - Head to [Asphyxia CORE's releases](https://github.com/asphyxia-core/asphyxia-core.github.io/releases) page + - Download the latest `asphyxia-core-win-x64.zip` archive + - Prepare a permanent place for your Asphyxia files, **preferably an empty folder away from your game data** + - Extract the archive inside of it + + You should end up with a structure as follows: + + ``` + 📂 asphyxia + ┣━ 📂 plugins + ┃ ┣━ 📂 _example@identifier + ┃ ┃ ┗━ ... + ┃ ┣━ 📄 asphyxia-core.d.ts + ┃ ┣━ 📄 package.json + ┃ ┗━ 📄 tsconfig.json + ┗━ ▶️ asphyxia-core-x64.exe + ``` + +!!! info "You can delete the `_example@identifier` folder, it serves as an example plugin layout for developers" + +## Installing Plugins + +!!! info "Asphyxia requires a specific plugin for each game you want to use it with" + +!!! tip "" + + To get started with Asphyxia for your specific game(s), you'll need to install the appropriate plugin(s). + + While **we maintain a collection of plugins in our Discord server, we may not have support for every game and version**. + In such cases, **you will need to search for community-developed plugins online yourself**. + + To install plugins from our Discord: + + - Join our Discord server using the logo in the bottom right of the page + - Navigate to your game's channel + - Check the pinned `Resources` message for potential plugin links + - Download and extract the plugin + - Place the extracted folders (like `sdvx@asphyxia`) into your `plugins` directory + + If plugin files are scattered across multiple files/folders, create a single directory for them and move everything inside, following the `game@asphyxia` naming scheme. + + ``` + 📂 asphyxia + ┣━ 📂 plugins + ┃ ┣━ 📂 sdvx@asphyxia + ┃ ┣━ 📂 iidx@asphyxia + ┃ ┣━ 📂 etc. + ┃ ┣━ 📄 asphyxia-core.d.ts + ┃ ┣━ 📄 package.json + ┃ ┗━ 📄 tsconfig.json + ┗━ ▶️ asphyxia-core-x64.exe + ``` + +## Starting and Configuring Asphyxia + +!!! tip "" + + Launch `asphyxia-core-x64.exe` to start the server. + A browser window will automatically open with the Asphyxia WebUI interface. + +### Configuring Service URL + +!!! tip "" + + To configure the service URL for your BEMANI game: + + - Open `spicecfg.exe` + - Navigate to the `Options` tab + - Locate the `EA Service URL` field + - Enter the URL shown in Asphyxia WebUI's Dashboard (typically `localhost:8083`) + +### Game-specific configuration + +!!! info "Each tab corresponds to steps you need to follow for various games" + +=== "SDVX" + + !!! tip "Settings and WebUI Assets" + + - In the WebUI, select `SDVX` in the left sidebar + - Under `Plugin Settings`, find `Exceed Gear Data Directory` + - Enter the full path to your game's data folder (the folder containing `data`, `modules`, `prop`, etc.) + - (Optional) Toggle all four `Unlock` switches to unlock all game content by default + - Click `Apply` to save your changes + - Close Asphyxia by selecting `Process` > `Shutdown CORE` in the top-right corner of the WebUI + + Next, update the WebUI assets: + + - Launch `asphyxia-core-x64.exe` again + - Click `Update Webui Assets` in the left sidebar + - Click `Update` and confirm the datacode update in `ea3-config.xml` + - Wait for the console to show "Done" at the top + + !!! warning "About expected errors" + + While importing WebUI assets you may see errors like: + `- [ifs] MD5 mismatch - /data/graphics/ver06/psd_level.ifs` + + If you're using the correct plugin and game data, these can usually be ignored. + + !!! tip "Final setup" + + - Launch SDVX and create a new profile + - Close the game + - In the WebUI, navigate to `SDVX` → `Profiles` making sure your new profile appears + - Customize additional settings through the WebUI interface and make sure everything works as intended + +=== "IIDX" + + !!! tip "" + + IIDX setup is straightforward: + + - Launch the game with Asphyxia running + - Create a new profile in-game + - The profile will automatically appear in the WebUI + - You can customize additional settings through the WebUI interface and make sure everything works as intended + +## Final words + +!!! success "Setup Complete!" + + Remember to always make sure Asphyxia is running **before** starting your game! + + If you were following a guide, you can now return to it and proceed with the next steps. + +## Help + +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/extras/audio.md b/docs/extras/audio.md new file mode 100644 index 0000000..417d6df --- /dev/null +++ b/docs/extras/audio.md @@ -0,0 +1,228 @@ +!!! info "Synopsis" + + This guide explains the different audio modes commonly found in arcade games and their pros and cons, helping you choose the best option for your setup. + +!!! danger "Important notice" + + **Recordings and streams must only be shared privately:** + + - Through unlisted videos + - In private streams with friends + - Within trusted data communities + + Sharing content publicly puts you at serious risk of getting banned from arcade venues and communities. Please respect these guidelines. + + +## Audio modes + +### TL;DR + +| Mode | DirectSound | WASAPI Shared | WASAPI Exclusive | ASIO | +| ---------------------- | :----------------: | :----------------: | :---------------: | :--------------------------: | +| Latency | Highest | Medium | Low | Lowest when setup correctly | +| Compatibility | Highest | High | High | Low | +| Multiple audio streams | :material-check: | :material-check: | :material-close: | with extra steps | +| Audio capture | :material-check: | :material-check: | :material-close: | with extra steps | +| Recommended for | Legacy games | Most users | Low latency needs | Lower latency needs | + +### DirectSound + +!!! tip "" + + The legacy Windows audio system, still used by older games. + + ✔️ **Pros**: + + - Extremely high compatibility, especially with older games + - Multiple audio sources can play simultaneously + - Easy audio capture with OBS, Discord etc. + - Simple to set up and use + + ❌ **Cons**: + + - Highest latency of all modes + - Being phased out in favor of WASAPI + - Limited audio quality compared to modern modes + + 💡 **Pro tip**: Use spice2x's `-lowlatencysharedaudio` setting to reduce latency. + +### WASAPI Shared + +!!! tip "" + + The modern Windows standard audio mode. Recommended for most users. + + ✔️ **Pros**: + + - Works with most modern games and applications + - Multiple audio sources can play simultaneously + - Easy audio capture with OBS, Discord etc. + - Good balance of latency and compatibility + + ❌ **Cons**: + + - Higher latency than Exclusive mode + - Some games may require patches/configuration for Shared mode + + 💡 **Pro tip**: Use spice2x's `-lowlatencysharedaudio` setting to reduce latency. + +### WASAPI Exclusive + +??? warning "Hardware compatibility notice" + + Your audio device must explicitly support exclusive mode. Check your audio settings: + + + +!!! tip "" + + Gives one application complete control over the audio device. + + ✔️ **Pros**: + + - Significantly lower latency than Shared mode + - More consistent audio processing than Shared mode + - Better for rhythm games if you don't mind the cons + + ❌ **Cons**: + + - Only one application can output audio at a time + - No audio capture without special hardware/software + - Can cause system-wide audio interruptions + +### ASIO + +!!! warning "Hardware requirements" + + For optimal results, use a dedicated ASIO-compatible audio interface. Software solutions like [ASIO4ALL](https://asio4all.org/) or [FlexASIO](https://github.com/dechamps/FlexASIO) exist but have limitations: + + - Added processing overhead + - May not improve latency over WASAPI Exclusive + - Mostly useful when: + - Games are incompatible with your audio device + - ASIO is the only supported mode + - You need specific ASIO features + +!!! tip "" + + Professional audio standard designed for audio interfaces and music production. + + ✔️ **Pros**: + + - Lowest possible latency when properly configured + - Direct hardware control + - Precise buffer size adjustment + - Professional-grade audio quality + - Bypass Windows audio stack + - Capture is possible when routed through Voicemeeter at the cost of very little added latency + + ❌ **Cons**: + + - Requires specialized hardware for best results + - Complex setup process + - Usually limited to one application at a time + - No direct audio capture support + - System performance heavily impacts stability + - May require significant tweaking + +## ASIO Recording/Streaming + +!!! info "This guide assumes your game already uses ASIO and you want to record/stream with audio" + +### Required software + +!!! tip "" + + ASIO bypasses the Windows audio system that recording/streaming applications use, so you'll need additional software to route the audio: + + - [Voicemeeter Banana](https://vb-audio.com/Voicemeeter/banana.htm) - For audio routing + - [OBS Studio](https://obsproject.com/) - For recording and streaming + + Install both applications before continuing. + +### Game configuration + +!!! tip "" + + Set your game's ASIO output device to `Voicemeeter Virtual ASIO`: + + - For spice2x games: Look for settings like `-iidxasio` or `-sdvxasio` at the top of spicecfg's `Options` tab + - For other games: The location depends on your setup, but look for ASIO device selection + +### Voicemeeter configuration + +!!! tip "" + + First, configure recommended settings: + + 1. Click `Menu` in the top right + 2. Enable settings shown below to ensure Voicemeeter: + - Starts with Windows + - Auto-recovers from audio issues + + + + Next, set up ASIO output: + + 1. Click the `A1` button in the top right + 2. Select the `ASIO (Steinberg)` tab + 3. Choose your ASIO device + + Finally, configure audio routing: + + 1. Locate the 4th column in the interface + 2. Enable only the `A1` and `B1` toggles as shown: + + + +### OBS Studio Configuration + +!!! tip "" + + 1. Run OBS Studio's initial configuration wizard if you haven't already + + 2. Set up audio capture: + - In the Sources panel, click `+` and select `Audio Input Capture` + + - For the Device, select `VoiceMeeter Output (B1)` + + + 3. Enable audio monitoring: + - Click the gear icon in the Audio Mixer panel + - Find your Audio Input Capture source + - Change `Audio Monitoring` to `Monitor and Output` + + + 4. Configure OBS audio settings: + - Go to `File` > `Settings` + + - In the `Audio` tab: + - Set `Sample Rate` to match your ASIO/game settings + - For `Monitoring Device`, select any unused input such as a `VoiceMeeter In` + + - Save changes with `Apply` and `OK` + + 5. Add video capture: + - In Sources, add either `Display Capture` or `Game Capture` + - Adjust OBS video and output settings as needed + +### Using this setup + +!!! tip "" + + First, ensure Voicemeeter and OBS Studio are running. + + Next, configure your desired OBS output and video settings. + + - For streaming and recording, now use OBS as normal. + + - For Discord sharing: + - Right-click the OBS preview window + - Select `Fullscreen Projector (Preview)` + - Choose which monitor to show the projector on + - Press Alt+Tab to switch away from the projector window + - In Discord, share the projector window + +### Further reading + +* [spice2x wiki](https://github.com/spice2x/spice2x.github.io/wiki/Audio-modes-demystified) diff --git a/docs/extras/controllers.md b/docs/extras/controllers.md new file mode 100644 index 0000000..1d47452 --- /dev/null +++ b/docs/extras/controllers.md @@ -0,0 +1,375 @@ +!!! info "Synopsis" + + This guide provides an overview of popular arcade-style rhythm game controllers currently available to buy. + Controllers are ranked based on their popularity within the rhythm game community. + +## KONAMI + +### beatmania IIDX + +!!! info "Lightning cabinets typically use Sanwa buttons, 50g springs, 50g microswitches" + +??? tip "PHOENIXWAN+ LMT" + +
+ +
+ + [**Product page**](https://www.gamo2.com/en/index.php?dispatch=products.view&product_id=386){target="_blank"} + **Vendor**: [gamo2](https://www.gamo2.com/){target="_blank"} + **Price range**: $299 ~ $447.50 + Shipping/Taxes + **Recommended setup**: $425 (Sanwa 50g, Omron 50g, default LEDs) + + This controller is widely considered the gold standard for IIDX controllers. With high-quality construction materials, a few spring and switch options, and an arcade-like textured turntable. The PHOENIXWAN's proven reliability makes it the top choice for both new and experienced players. + +
+
+ +??? tip "DX6TH" + +
+ +
+ + [**Product page**](https://yuancon.store/controller/IIDX){target="_blank"} + **Vendor**: [YuanCon](https://yuancon.store/){target="_blank"} + **Price range**: $209 ~ $334 + Shipping/Taxes + **Recommended setup**: $334 (Sanwa 50g, defaults) + + The DX6TH is a good alternative to the PHOENIXWAN, offering decent build quality at a lower price point. However, its glossy acrylic turntable attracts dust and fingerprints easily, and doesn't match the premium feel of the PHOENIXWAN's LMT surface. + +
+
+ +### Sound Voltex + +!!! info "Valkyrie cabinets typically use Sanwa buttons, 20g springs, 100g microswitches" + +??? tip "FAUCETWO+" + +
+ +
+ + **Products**: [VW Skin](https://www.gamo2.com/en/index.php?dispatch=products.view&product_id=393){target="_blank"} - [EG Skin](https://www.gamo2.com/en/index.php?dispatch=products.view&product_id=394){target="_blank"} + **Vendor**: [gamo2](https://www.gamo2.com/){target="_blank"} + **Price range**: $169 ~ $466.20 + Shipping/Taxes + **Recommended setup**: $296 (Sanwa 20g, Omron 100g) + + The FAUCETWO+ probably is the most popular Sound Voltex controller on the market. It features improved knob durability compared to the original FAUCETWO, eliminating the need to regularly replace damping sheets. For microswitches, we recommend choosing Omron over LHS1F switches, as Omrons are generally more durable, cost-effective, and easier to source. + +
+
+ +??? tip "SDVX12" + +
+ +
+ + **Products**: [Black](https://yuancon.store/controller/controller){target="_blank"} - [White](https://yuancon.store/controller/sdvx%20controller){target="_blank"} - [Black&Blue](https://yuancon.store/controller/sdvxblack){target="_blank"} - [White&Purple](https://yuancon.store/controller/sdvxwhite){target="_blank"} - [Pink&Gold](https://yuancon.store/controller/sdvx){target="_blank"} - [Pink](https://yuancon.store/controller/sdvx%20controllers){target="_blank"} - [Gold](https://yuancon.store/controller/sdvxgold){target="_blank"} + **Vendor**: [YuanCon](https://yuancon.store/){target="_blank"} + **Price range**: $188 ~ $333 + Shipping/Taxes + **Recommended setup**: $333 (Sanwa 20g, LHS1F 100g) + + The SDVX12 is YuanCon's alternative to the FAUCETWO+. While well-built, its main limitation is restricted customization. You can only choose between Chinese buttons with 50g springs, or Sanwa buttons with 20g springs and LHS1F 100g microswitches. The LHS1F switches are generally less durable than the Omron switches available for the FAUCETWO+. + +
+
+ +??? tip "SDVX LITE 3" + +
+ +
+ + [**Product page**](https://yuancon.store/controller/sdvxlite){target="_blank"} + **Vendor**: [YuanCon](https://yuancon.store/){target="_blank"} + **Price range**: $138 ~ $283 + Shipping/Taxes + **Recommended setup**: $283 (Sanwa 20g, LHS1F 100g) + + The SDVX LITE 3 is a more compact and affordable version of the SDVX12. By trimming its sides, it remains arcade-accurate without wasting space. Like its larger counterpart, it has limited customization options (see SDVX12 description above). Despite this, its lower price point makes it an excellent entry-level choice for players of all skill levels. + +
+
+ +### pop'n music + +??? tip "POPOLLER" + +
+ +
+ + [**Product page**](https://www.gamo2.com/en/index.php?dispatch=products.view&product_id=379){target="_blank"} + **Vendor**: [gamo2](https://www.gamo2.com/){target="_blank"} + **Price range**: $229 ~ $279 + Shipping/Taxes + **Recommended setup**: $279 (SAMDUCKSA buttons) + + It should be noted a few users have reported SAMDUCKSA buttons spinning in place, your mileage may vary. + +
+
+ +### Dance Dance Revolution + +??? tip "L-TEK / iamats" + +
+ +
+ + [**Catalog**](https://www.iamats.com/product-category/all/?per_page=6&layout=grid&orderby=date){target="_blank"} + **Vendor**: [L-TEK](https://www.iamats.com/) + + L-TEK produces high-quality DDR dance pads at various price points. Due to their extensive product lineup, we recommend browsing their catalog directly to find the pad that best suits your needs and budget. + +
+
+ +??? tip "YuanCon Pad Single/Double" + +
+ +
+ + **Products**: [Single](https://yuancon.store/controller/yuanpads){target="_blank"} - [Double](https://yuancon.store/controller/yuanconpaddp){target="_blank"} + **Vendor**: [YuanCon](https://yuancon.store/) + **Price range**: $1199 ~ $2519 + High shipping/taxes + + YuanCon proposes single and double DDR pads. While seemingly very well built, they also are extremely expensive. + +
+
+ +### NOSTALGIA + +??? tip "NOSTROLLER" + +
+ +
+ + [**Product page**](https://www.gamo2.com/en/index.php?dispatch=products.view&product_id=372){target="_blank"} + **Vendor**: [gamo2](https://www.gamo2.com/){target="_blank"} + **Price**: $349 + Shipping/Taxes + + The NOSTROLLER is the only dedicated controller option for NOSTALGIA. While information about this controller is limited due to its niche market, it's worth noting that any MIDI keyboard with enough keys can also be configured to work with the game. + +
+
+ +## SEGA + +### CHUNITHM + +??? tip "TASOLLER+" + +
+ +
+ + [**Product page**](https://www.gamo2.com/en/index.php?dispatch=products.view&product_id=407){target="_blank"} + **Vendor**: [gamo2](https://www.gamo2.com/){target="_blank"} + **Price**: $349 + Shipping/Taxes + + The TASOLLER+ is widely regarded as the definitive CHUNITHM controller. Its premium aluminum construction, exceptional build quality, sleek aesthetics and customizable sensitivity and lighting make it the top choice for players looking for an authentic arcade experience at home. + +
+
+ +??? tip "Laverita 3" + +
+ +
+ + **Products**: [Without stand](https://yuancon.store/controller/laverita-3){target="_blank"} - [With stand](https://yuancon.store/controller/laverita-3-s){target="_blank"} + **Vendor**: [YuanCon](https://yuancon.store/){target="_blank"} + **Price**: $328 + Shipping/Taxes + **Note**: Shipping is much higher for the "with stand" version + + The Laverita 3 is YuanCon's alternative to the TASOLLER+. While it's a fully functional controller that gets the job done, its build quality doesn't quite match the premium feel of the TASOLLER+. Users should also note that the controller's performance can be affected by high humidity environments. + +
+
+ +### maimai + +??? tip "NDX" + +
+ +
+ + [**Product page**](https://yuancon.store/controller/ndx){target="_blank"} + **Vendor**: [YuanCon](https://yuancon.store/){target="_blank"} + **Price**: $899 + High shipping/Taxes + +
+
+ +### O.N.G.E.K.I. + +??? tip "ONTROLLER" + +
+ +
+ + [**Product page**](https://www.gamo2.com/en/index.php?dispatch=products.view&product_id=392){target="_blank"} + **Vendor**: [gamo2](https://www.gamo2.com/){target="_blank"} + **Price range**: $399 ~ $731 + Shipping/Taxes + + The ONTROLLER is currently the only arcade-accurate O.N.G.E.K.I. controller available on the market. While its high price point may be a barrier for some, the controller's excellent build quality and five available configurations make it an attractive option for players seeking an authentic arcade experience. + +
+
+ +??? tip "YUANGEKI" + +
+ +
+ + [**Product page**](https://yuancon.store/controller/yuangeki){target="_blank"} + **Vendor**: [YuanCon](https://yuancon.store/){target="_blank"} + **Price**: $222 + Shipping/Taxes + + The YUANGEKI is YuanCon's compact O.N.G.E.K.I. controller. While the side buttons are positioned closer together compared to the arcade layout, the controller offers solid performance at a more affordable price point. + +
+
+ +## NAMCO + +### Taiko no Tatsujin + +!!! info "Many of these controllers offer different configurations. Make sure to pick the correct one for the plaform(s) you plan to play on" + +#### Arcade-accurate + +??? tip "ZhongTaiko" + +
+ +
+ + [**Product page**](https://taiko.ac/products/zhongtaiko){target="_blank"} + **Vendor**: [ZhongTaiko](https://taiko.ac/){target="_blank"} + **Price range**: $399 ~ $599 + Shipping/Taxes + + ZhongTaiko offers the highest quality full-size Taiko controllers on the market. Their Pro version perfectly replicates the feel of arcade Nijiiro cabinets, while their more affordable Standard version still outperforms a lot of contenders in build quality and responsiveness. + +
+
+ + +??? tip "TDC17" + +
+ +
+ + [**Product page**](https://s.rythmagica.net/products/tdc17-arcade-size-taiko-drum-controller-for-switch-pc-xbox-ps4-more){target="_blank"} + **Vendor**: [rythmagica](https://s.rythmagica.net/){target="_blank"} + **Price range**: $261.95 ~ $307.95 + Shipping/Taxes + + The TDC17 is a solid arcade-style Taiko controller offering good build quality and responsiveness at a competitive price point. While it does not quite matching ZhongTaiko's quality, it provides a solid and authentic arcade experience for players seeking a high-end option at a great price point. + +
+
+ +??? tip "TAIKOLLER" + +
+ +
+ + [**Product page**](https://www.gamo2.com/en/index.php?dispatch=products.view&product_id=381){target="_blank"} + **Vendor**: [gamo2](https://www.gamo2.com/){target="_blank"} + **Price**: $329 + Shipping/Taxes + + The TAIKOLLER is gamo2's arcade-style Taiko controller. It is very similar to YuanCon's TAIKO FORCE LV6, while being cheaper for customers outside of China. + +
+
+ +??? tip "TAIKO FORCE LV6" + +
+ +
+ + [**Product page**](https://yuancon.store/controller/taiko){target="_blank"} + **Vendor**: [YuanCon](https://yuancon.store/){target="_blank"} + **Price range**: $466 ~ $554 + Shipping/Taxes + + The TAIKO FORCE LV6 is YuanCon's arcade-style Taiko controller. It is very similar to gamo2's TAIKOLLER. While the official store price is higher, it can be purchased at a significant discount through TaoBao (Chinese marketplace), though international buyers will need to use a proxy service. + +
+
+ +#### Tatacons (much smaller than arcade but plenty capable) + +??? tip "TDC10 Pro" + +
+ +
+ + [**Product page**](https://s.rythmagica.net/products/pro-taiko-drum-controller){target="_blank"} + **Vendor**: [rythmagica](https://s.rythmagica.net/){target="_blank"} + **Price**: $139.95 + Shipping/Taxes + + The TDC10 Pro is a smaller, more affordable version of the TDC17. It stands out as the highest quality Tatacon controller currently available, delivering excellent build quality and responsiveness at a competitive price point. For players seeking a compact but premium Taiko controller, this is THE choice. + +
+
+ +??? tip "HORI Official Tatacons" + +
+ +
+ + [**Catalog**](https://www.amazon.com/stores/page/C794C4D7-A76B-43B5-B6A8-3F34E1697D97/search?ingress=0&visitId=3c7c1ee1-ac90-448d-97b2-68e8024797e0&terms=taiko){target="_blank"} + **Vendor**: HORI + **Price range**: $68 ~ 157 + Shipping/Taxes + + HORI Tatacons are officially licensed controllers available for multiple platforms. While they are widely accessible, most models suffer from hit registration issues that require modifications to fix. Given these reliability concerns, we strongly recommend the TDC10 Pro as a better alternative. + +
+
+ +??? tip "IINE Tatacon" + +
+ +
+ + [**Product page**](https://iine.store/collections/controller/products/switch-controller){target="_blank"} + **Vendor**: [IINE](https://iine.store/){target="_blank"} + **Price**: $55.95 + Shipping/Taxes + + IINE's Tatacon is a budget alternative to HORI's official controllers. While more affordable, it shares similar hit registration problems that require modifications to resolve. For a reliable, high-quality experience, we recommend investing in the TDC10 Pro instead. + +
+
+ +#### In-betweens (not quite AC-size, not quite Tatacon) + +??? tip "IINE Taiko Pro Max" + +
+ +
+ + [**Product page**](https://iine.store/collections/controller/products/iine-professional-taiko-drum-pro-max?Color=Taiko+Drum+Pro+Max){target="_blank"} + **Vendor**: [IINE](https://iine.store/){target="_blank"} + **Price**: $180.95 + Shipping/Taxes + + IINE's Taiko Pro Max comes in at an odd spot between arcade-accurate controllers and Tatacons. It feels really cheap but might do the trick if the size and price point sound good to you. + +
+
diff --git a/docs/extras/datamods.md b/docs/extras/datamods.md new file mode 100644 index 0000000..96154cd --- /dev/null +++ b/docs/extras/datamods.md @@ -0,0 +1,120 @@ +!!! info "Synopsis" + + This guide will cover how to mod your KONAMI game's data folder in a non-destructive way. + No files will be removed or overwritten. + +## Pre-requisites + +!!! tip "" + + - A fully working and unmodified game + - The data to mod your game with + +!!! danger "ATTENTION" + + - Please make sure the mod you're installing is **compatible with YOUR specific game and game version** + - If connecting to an **online network**, make sure they **explicitly allow** the mod you're about to install + +## Installing mod files + +!!! tip "" + + - Create a `data_mods` folder next to the others in your game files if it doesn't exist + + + + - Place your mod files inside data_mods in a way that respects the following structure + `data_mods/mod_folder/` + + You can think of the mod folder coming to overwrite your game's data folder at runtime. + If you're confused, the following may help you understand what we mean. + + ``` hl_lines="6-11" + 📂data + ┣━📂graphic + ┣━📂info + ┣━📂movie + ┗━📂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 + 📂dev + 📂modules + 📂prop + ``` + +!!! info "Example: Omnimix for beatmania IIDX 31 EPOLIS" + + **Directory**: `contents/data_mods/` + + + **Directory**: `contents/data_mods/omnimix_31` + + +## Loading mods data files (ifs_layeredfs) + +!!! tip "" + + Overwriting game files with mods is heavily discouraged, as there is no clean way of undoing that. + This is where ifs_layeredfs comes in, to load modded data files without permanently modifying your game data. + + - Download the most recent release of [ifs_layeredfs](https://github.com/mon/ifs_layeredfs/releases/) + + + + - Open the archive + + + + - Your game is 32bit *(spice.exe to launch)*: go in the `32bit` folder + - Your game is 64bit *(spice64.exe to launch)*: go in the `64bit` folder + + + + - Copy the `ifs_hook.dll` file to your game's `modules` folder + + + + Follow the [Injecting DLL Hooks](#injecting-dll-hooks) section to load this DLL. + +## Installing Omnifix (for IIDX Omnimix only) + +!!! info "Compatibility" + + [Supported game versions](https://github.com/aixxe/omnifix?tab=readme-ov-file#compatibility) + For unsupported game versions, you'll have to patch Omnimix with [spice2x](patchsp2x.md) or [web](patchweb.md) patching. + +!!! tip "" + + Omnimix files require modification of your game DLL which can't be handled by ifs_layeredfs. + This is where Omnifix comes in, as a commonly agreed upon way of loading Omnimix for beatmania IIDX. + + - Download the latest release archive for [omnifix](https://github.com/aixxe/omnifix/releases/) much like you did with ifs_layeredfs + - Extract the `omnifix.dll` file contained in the archive to your game's `modules` folder + + Follow the [Injecting DLL Hooks](#injecting-dll-hooks) section to load this DLL. + + Note that Omnifix also offers optional [launch parameters](https://github.com/aixxe/omnifix?tab=readme-ov-file#options) you may want to consider. + +## Injecting DLL Hooks + +!!! tip "" + + Adding DLL files to your modules folder won't necessarily make them load automatically. + You sometimes need to tell spice2x to load each file individually, like with the DLLs mentioned in this guide. + + - Open your game's `spicecfg.exe` + - Head to the `options` tab + - Find the `Inject DLL Hooks` option under `Common` + - Add the name of the DLL file(s) you want to load inside the text box + + Example: `ifs_hook.dll omnifix.dll` + + You may list one or multiple DLL files separated by a space. + The order does matter, as it dictates in which order the DLL files are loaded. + **We recommend loading `ifs_hook.dll` before all else**. + + diff --git a/docs/extras/hexguide.md b/docs/extras/hexguide.md new file mode 100644 index 0000000..fa01b2f --- /dev/null +++ b/docs/extras/hexguide.md @@ -0,0 +1,85 @@ +# Game Patching (hex editing) + +!!! danger "Before proceeding" + + **This guide should ONLY be used as a last resort if all other methods fail.** + **It has a high chance of breaking your game, make backups.** + +## Preamble + +!!! tip "" + + We're going to patch Beatmania IIDX 25 CANNON BALLERS, however the process is similar for other BEMANI games. + + Here's what you'll need: + + - Your favorite hex editor, here we'll be using [HxD](https://mh-nexus.de/en/hxd/). + - A clean copy of your desired BEMANI game. + - A backup of your original `.dll` before editing. + +## Getting Started + +!!! tip "" + + Decide on what hex edits you want to apply, you may find that information from the community or our [Resources](/resources.md). + + It's time to open our hex editor. If you're using HxD, you'll be greeted with the screen below. + + + +!!! tip "" + + Open your game's `.dll` file in the hex editor. + + For the grand majority of hex edits, this is the main game file, such as `bm2dx.dll`, `soundvoltex.dll`, etc. + + Pictured below, we've opened up `bm2dx.dll` inside HxD. + + + +!!! danger "Attention" + + The edit we'll be applying is **EXCLUSIVE to this version of the game** and serves as an example. + + This means it will not work on any other version of the game, nor any other game! + Hex edits modify specific memory addresses that only apply to very specific game versions. + +!!! tip "" + + We'll be editing our game to `Unlock All Songs` and its edit is: + + - **Offset**: `0xB60B2` + - **Original**: `74 10` + - **Modified**: `90 90` + + In HxD we're going to hit `Ctrl+G` to open the `Goto` window. + + From here, we'll input the offset `B60B2` in the `Offset` section as shown below, and hit `OK`. + + + +!!! tip "" + + Our cursor should be taken to the offset at the exact location you want to edit. + + As you can see, the numbers in front of the cursor are `74` and `10` which corresponds to what we need to replace. + + **If there's a mismatch, it's likely the offset you've put in was wrong, so be sure to double check!** + + + +!!! tip "" + + Now all we need to do is select `74 10` and replace it with `90 90`. + + You can do this by either manually typing `90 90` or by copy and pasting. + + It should now look as shown below. + + + +!!! tip "" + + Lastly, simply save your file and repeat these steps for any other edits you want to apply! + + If at any point your game has issues due to your edits, restore your backup. \ No newline at end of file diff --git a/docs/extras/linux_konami.md b/docs/extras/linux_konami.md new file mode 100644 index 0000000..b0db4e2 --- /dev/null +++ b/docs/extras/linux_konami.md @@ -0,0 +1,333 @@ +!!! info "Synopsis" + + Konami arcade games and associated community tooling are built to run on Windows. + This guide will document the best currently known ways to get games working on Linux systems. + +!!! warning "Compatibility" + + **ONLY** the following game and versions are confirmed to work with the process described in this guide. + + | Game | Version(s) | Caveats (if any) | + |------|:----------:|:----------------:| + | Sound Voltex | `Exceed Gear` | Subscreen clicks don't work | + | DanceDanceRevolution | `World` | | + | Mahjong Fight Girl | | | + + This guide was primarily written targetting arch-based systems running KDE and pipewire. + **Instructions should still be distro and DE agnostic, but your mileage may vary.** + +## Pre-requisites + +!!! tip "" + + - A Linux system with: + - `pipewire` as an audio backend + - `wine` with wow64 included (default on arch since June 2025) + - `winetricks curl unzip` installed + - `gstreamer gst-plugins-good gst-plugins-ugly gst-libav` for codecs (package names may vary) + - Compatible game data placed inside a `📂contents` directory + - Your game's regular setup guide opened in another tab + +??? tip "Extra requirements for NixOS" + + `spice2x` requires an optional wine feature which NixOS does not enable by default. + Apart from that, a patch for `winetricks` is needed due to [weirdness with winetricks on NixOS with WoW64 wine](https://github.com/NixOS/nixpkgs/issues/338367). + + To fix this, copy this to your confiuration: + ```nix + environment.systemPackages = [ + ( + pkgs.wine-with-pcsclite.override { + wineBuild = "wineWow64"; + } + ) + ]; + + nixpkgs.overlays = [ + ( + final: prev: { + wine-with-pcsclite = prev.wine.overrideAttrs (old: { + buildInputs = old.buildInputs ++ [final.pcsclite]; + configureFlags = old.configureFlags ++ ["--with-pcsclite"]; + }); + winetricks = prev.winetricks.overrideAttrs (old: { + patches = [ + (final.fetchpatch { + # make WINE_BIN and WINESERVER_BIN overridable + # see https://github.com/NixOS/nixpkgs/issues/338367 + url = "https://github.com/Winetricks/winetricks/commit/1d441b422d9a9cc8b0a53fa203557957ca1adc44.patch"; + hash = "sha256-AYXV2qLHlxuyHC5VqUjDu4qi1TcAl2pMSAi8TEp8db4="; + }) + ]; + postInstall = + old.postInstall + + '' + sed -i \ + -e '2i : "''${WINESERVER_BIN:=/run/current-system/sw/bin/wineserver}"' \ + -e '2i : "''${WINE_BIN:=/run/current-system/sw/bin/.wine}"' \ + "$out/bin/winetricks" + ''; + }); + } + ) + ]; + ``` + +## Automated setup (for spice2x compatible games) + +!!! tip "" + + - Download the `sp2x-linux-setup.sh` script from [NotAkitake/sp2x-linux-setup](https://github.com/NotAkitake/sp2x-linux-setup/) + - Place it next to your `📂contents` directory contaning compatible game files + - Make the script executable `chmod +x sp2x-linux-setup.sh` + - Run the script and follow instructions + +## Manual setup + +!!! info "This section will mostly describe what the automated process above achieves" + +### Installing spice2x + +!!! tip "" + + This process is largely the **same as windows** and can be found in your game's setup guide. + Simply place the `spice.exe` or `spice64.exe` executable inside `📂contents`. + + We won't need `spicecfg.exe` however. + Instead we will later pass `-cfg` as a launch argument to the main spice2x executable later. + +!!! warning "NVIDIA Stubs" + + **For ALL graphics cards:** If your game's setup guide has a `Additional steps for AMD and Intel graphics cards` warning in its **Installing spice2x** section, **do what it says**. + +### Wine prefix + +!!! danger "Double check commands" + + We provide ready-made command for simplicity, however **don't blindy copy and execute them**. + **ALWAYS** double check command before running them, and substitute `REPLACE_THIS_PATH` with your own location. + +#### Initializing + +!!! tip "" + + - Create an empty `📂prefix` directory in the location of your choosing + **We advise creating a new prefix for every game and placing it next to `📂contents`**. + + - Run the following command to initialize a new wine prefix without being prompted for mono or gecko. + + ```sh + WINEARCH=win64 WINEPREFIX=REPLACE_THIS_PATH/prefix WINEDLLOVERRIDES="mscoree=d;mshtml=d" wineboot --init + ``` + +#### Common dependencies + +!!! tip "" + + Some dependencies are required across most games, install them to your prefix using winetricks as follows: + + ```sh + WINEARCH=win64 WINEPREFIX=REPLACE_THIS_PATH/prefix winetricks -q dxvk d3dcompiler_42 d3dcompiler_43 d3dcompiler_46 d3dcompiler_47 + ``` + +#### Game-specific dependencies + +!!! info "If there is no tab for your game, you may skip this step" + +!!! tip "" + + === "Default (none)" + + === "DDR" + + Install these to your prefix for background movies to play, otherwise the game will crash. + + ```sh + WINEARCH=win64 WINEPREFIX=REPLACE_THIS_PATH/prefix winetricks -q quartz devenum amstream windowscodecs + ``` + +### (optional) PipeWire audio sink + +!!! info "You can create an audio device games will accept that routes audio to your desired hardware" + + It **may not be necessary** for all games as it depends on your specific setup and game. + You could try following the rest of the guide without this virtual sink first to see whether you need it or not. + +!!! tip "" + + - Create the `.config/pipewire/pipewire.conf.d` directory in your home directory if it doesn't already exist + + ```sh + mkdir -p "$HOME/.config/pipewire/pipewire.conf.d" + ``` + + - Create a `spice2x-sink.conf` file in that directory containing: + + ```sh + context.modules = [ + { + name = libpipewire-module-loopback + args = { + audio.position = [ FL FR ] + capture.props = { + media.class = Audio/Sink + audio.format = S16LE + audio.rate = 44100 + audio.channels = 2 + node.name = spice2x41 + node.description = "spice2x @ 44100Hz" + } + playback.props = { + node.passive = true + node.name = spice2x41.output + node.description = "SPICE2X 44100Hz OUTPUT" + target.object = "alsa_output.pci-0000_04_00.6.HiFi__hw_Generic_1__sink" + audio.format = S16LE + } + } + } + ] + ``` + + The `audio.rate` may need to be set to 48000 on a per game-basis, but for the games covered here, 44100 is fine. + + The `target.object` set above means audio will be routed the first audio device it finds. + If you have multiple audio devices available and want to make sure it outputs to a specific one, run: + + ```sh + pw-cli list-objects | awk '/node.name/ {name=$0} /media.class/ && /Audio\/Sink/ {gsub(/.*= "|"/,"",name); print name}' + ``` + + Replace the `target.object` device with the output line corresponding to your desired output device. + For example: + + ```sh + target.object = "alsa_output.usb-Focusrite_Scarlett_Solo_4th_Gen_S1APY0Z3611B4E-00.HiFi__Line1__sink" + ``` + + - **Finally**, save and exit then restart pipewire. On systemd distros you may do it by running: + + ```sh + systemctl --user restart pipewire.service pipewire-pulse.socket + ``` + +### (optional) Launcher scripts + +!!! info "This section will help you create two bash scripts you may use to start and configure your game" + + They are not mandatory but very handy to have, rather than remembering commands to run spice executables with the right prefix, paths, arguments, etc.. + +!!! tip "Game start" + + Let's create the main launch script first, which will also be used by our second script. + + - Next to your contents directory, create a `launch.sh` file containing: + + ```bash hl_lines="6 19" + #!/usr/bin/env bash + # Game Launcher + + SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" + export WINEARCH=win64 + export WINEPREFIX="REPLACE_THIS_PATH/prefix" + + # Default arguments + ARGS="" + + # Optional: Add arguments per line + # ARGS="$ARGS -url localhost:8083" # Network URL + # ARGS="$ARGS -p 01FXXXXXXXXXXXXXXXXX" # PCBID + + # Append args to this script + ARGS="$ARGS $*" + + cd "$SCRIPT_DIR/contents" || exit + wine "spice64.exe" $ARGS + ``` + + - On the first highlighted line: make sure `WINEPREFIX` points to your game prefix created earlier + + - On the second highlighted line: replace `spice64.exe` with `spice.exe` if necessary + + - Make the script executable by running `chmod +x launch.sh` + +!!! tip "Game config" + + To get a graphical interface replicating what `spicecfg.exe` does, we can simply call our previous script and pass `-cfg` as an argument. + + - Next to your previous script, create a `config.sh` file containing: + + ```bash + #!/usr/bin/env bash + # Config Launcher + + SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" + "$SCRIPT_DIR/launch.sh" -cfg + ``` + + - On the last line, make sure the file name matches the previous script + + - Make the script executable by running `chmod +x config.sh` + +!!! warning "Try executing `config.sh`" + + The spice2x configuration window for your game should appear. + Your game should also be detected and show in the top right! + + If your game isn't detected, it's highly likely paths are wrong somewhere in your scripts. + +### Game-specific last steps + +!!! info "If there is no tab for your game, you may skip this step" + +!!! tip "" + + === "Default (none)" + + === "SDVX" + + - You need to patch `Shared Mode WASAPI` to ensure audio comes through wine. + Either use the previously created `config.sh` to start spicecfg, or use the command in the next section. + If you don't know how patches work, follow instructions in our [spice2x patching](./patchsp2x.md) guide. + + --- + + - You need to set your monitor orientation to portait before playing + + - **OR** If you want to play the game windowed and keep your display in landscape orientation: + + - Create a `wine_desktop.reg` file containing: + + ```reg + Windows Registry Editor Version 5.00 + + [HKEY_CURRENT_USER\Software\Wine\Explorer] + "Desktop"="Default" + + [HKEY_CURRENT_USER\Software\Wine\Explorer\Desktops] + "Default"="1080x1920" + ``` + + - Fix the paths in the command below and run it. Then feel free to delete the `.reg` file: + + ```sh + WINEARCH=win64 WINEPREFIX=REPLACE_THIS_PATH/prefix wine regedit REPLACE_THIS_PATH/wine_desktop.reg + ``` + +### What's next? + +!!! success "Linux-specific instructions are over" + + Head to your game's setup guide, straight to the "Configuring spice2x" section. + + - **IF** you opted to use the PipeWire audio sink, set it as your default audio device before starting the game + - Skip the `Configuring audio` section + - Skip any section asking you to install VCRedist and/or DirectX, our prefix takes care of that + - Use the previously created `config.sh` instead of spicecfg, and `launch.sh` to start the game + **OR** If you opted not to create scripts, instead use this, fixing the paths and spice executable name: + + ```sh + cd REPLACE_THIS_PATH/contents && WINEARCH=win64 WINEPREFIX=REPLACE_THIS_PATH/prefix wine "spice64.exe" -cfg + ``` + + And use the same command without the `-cfg` argument to start the game. diff --git a/docs/extras/patchsp2x.md b/docs/extras/patchsp2x.md new file mode 100644 index 0000000..669a2da --- /dev/null +++ b/docs/extras/patchsp2x.md @@ -0,0 +1,89 @@ +# Game Patching (spice2x) + +!!! info "TWO-TORIAL Patcher" + + URL: `https://sp2x.two-torial.xyz` + + [Known spice2x patchers](/resources.md#spice2x-patchers) + +!!! warning "Compatibility" + + This patching method only is for [spice2x supported games](https://github.com/spice2x/spice2x.github.io/wiki/List-of-supported-games). + + **Please make sure you're using the latest release for [spice2x](https://spice2x.github.io/) as the feature is fairly new.** + +!!! danger "Before proceeding" + + **It is highly recommended to use an unpatched DLL as your base!** + + If you've already patched your game through other methods *([web patching](patchweb.md) or [hex editing](hexguide.md))*, + **Please replace your game's DLL with the original**. + +## Getting Started + +!!! tip "" + + **The following guide works the same regardless of which spice2x compatible game you're using.** + + In this case we will be using a clean SDVX installation as a reference, with the following folder structure. + + + +#### Importing Patches from URL + +!!! tip "" + + Open `spicecfg.exe` and head to the `Patches` tab. + + + +!!! tip "" + + By default no patches will be available, we need to import some. + + - Click on `Import from URL`. + - Paste your preferred patcher's URL. + + **Note**: Check the [Resources](/resources.md) page for a list of recommended patchers. + + - Click on `Import`. + + ^^**If patching fails, it most likely is because the URL you provided doesn't support your game's version.**^^ + + + +### Picking Patches + +!!! danger "Important" + + **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**. + +!!! tip "" + + After a successful import, your patches should now show up inside spice2x. + + A new `Patches` folder has also been created, containing a `.json` file with your available patches for offline use. + + + +!!! tip "" + + Now you may pick and choose desired patches! + + For game-specific instructions, refer to their respective dedicated pages. + +### Auto apply / Overwrite game files + +!!! tip "Auto apply (recommended)" + + After picking your patches, it is **strongly recommended** to tick the `Auto apply patches on game start` box. + + Doing so will keep your game files intact until you start it, at which point your selected patches will apply. + Upon closing the game your game's files will be restored. + +!!! warning "Overwrite game files" + + You also have the option to `Overwrite game files`, which will **permanently modify your game files**. + + This is **NOT** recommended unless you have a good reason to do so. + A backup of your original dll will be created, however it is recommended to make your own! \ No newline at end of file diff --git a/docs/extras/patchweb.md b/docs/extras/patchweb.md new file mode 100644 index 0000000..19a2568 --- /dev/null +++ b/docs/extras/patchweb.md @@ -0,0 +1,76 @@ +# Game Patching (web) + +!!! info "Known web patchers: [Resources](/resources.md#web-patchers)" + +!!! warning "For BEMANI games consider [spice2x Patching](patchsp2x.md)" + + **This patching method is outdated for BEMANI games.** + + However if your game isn't supported, follow this guide. + +!!! danger "Before proceeding" + + **It is highly recommended to use an unpatched DLL or EXE as your base!** + + If you've already patched your game through other methods *([spice2x patching](patchsp2x.md) or [hex editing](hexguide.md))*, + **Please replace your game's DLL or EXE with the original**. + +### Getting started + +!!! tip "" + + For this example, we'll be using our [web patcher](https://patcher.two-torial.xyz). + Almost every other patcher looks and functions exactly the same as this one. + + **If your game is not supported by our web patcher, please check [Resources](/resources.md#web-patchers) and use another web patcher.** + + Go to your chosen patcher's website, you'll get something similar to this: + + + +!!! tip "" + + Click on any game you'd like the patches for. In this case, we'll use CHUNITHM VERSE. + + + + + +!!! tip "" + + Here, either: + + - Drag and drop the `.dll` or `.exe` file the site prompts you to use. + - **OR** click on `Choose a file` and select it that way. + + If you've used the correct file and the site is compatible, it will tell you. + + `X of X patches matched (100%)` means the patcher is compatible with your game. + **If this shows any less than 100%, DO NOT use it. Your `.dll` or `.exe` file might not be clean. Only proceed with a clean one.** + + **Please keep in mind that some patchers may not support the most recent versions of your game right away.** + + + +!!! tip "" + + Now, you can select the patches you'd like to apply. + + If you're unsure on what to do, refer to your specific game's guide as it might have more information there. + Otherwise feel free to join our Discord server, the link is at the top of the [home page](/index.md), and ask the community! + + + +!!! tip "" + + When you're done selecting patches, click on `Save Patched File` and your new file will start downloading. + + + +!!! danger "Backup your original `.dll` or `.exe` file first!" + +!!! tip "" + + Now you may replace your data's file with the patched one you just downloaded. + + Once you've done that, you're done. Enjoy! diff --git a/docs/extras/unity.md b/docs/extras/unity.md new file mode 100644 index 0000000..0d33dd7 --- /dev/null +++ b/docs/extras/unity.md @@ -0,0 +1,59 @@ +!!! danger "Before proceeding" + + This guide applies to games made in the Unity engine, such as maimai DX, O.N.G.E.K.I. and Card Maker. + + **It is highly recommended to use an unpatched Assembly DLL as your base!** + +!!! info "Patches have historically been hardcoded into the unprotected `Assembly-CSharp.dll`" + + The modern approach is to use BepInEx to load custom patches without tampering with Assembly-CSharp.
BepInEx can be used to load all mods, including those made for MelonLoader and MonoMod + +## Installing BepInEx + +!!! tip "" + + - Download the [BepInEx 5 stable release](https://github.com/BepInEx/BepInEx/releases/latest) (`BepInEx_win_x64_5.x.y.z.zip`). + !!! warning "Some maimai DX mods are only compatible with BepInEx 5.4.22" + + - Extract the `BepInEx` folder to the `App\package` folder (ignore other files such as `.doorstop_version`) + + - Modify `segatools.ini` with the following: + + ```ini + [unity] + enable=1 + targetAssembly=BepInEx\core\BepInEx.Preloader.dll + ``` + +## Installing Mods + +!!! tip "BepInEx plugins" + + Place them in `BepInEx\plugins`. + +!!! tip "Melonloader mods and plugins" + + - Download `MLLoader-UnityMono-BepInEx5` of the latest [BepInEx.MelonLoader.Loader](https://github.com/BepInEx/BepInEx.MelonLoader.Loader/releases/latest). + - Extract it into `App\package`. + - Place mods in `MLLoader\Mods`. + +!!! tip "MonoMod patches" + + !!! info "" + + These patches always follow the naming pattern: `Assembly-CSharp.Name.mm.dll`. + + - Extract [BepInEx.MonoMod.Loader](https://github.com/BepInEx/BepInEx.MonoMod.Loader/releases/latest) into `App\package`. + - Place patches in `BepInEx\monomod`. + +## Available Mods + +!!! tip "" + + - [mu3-mods](https://gitea.tendokyu.moe/akanyan/mu3-mods/wiki) open source BepInEx mods for O.N.G.E.K.I., includes many fixes and QOL changes that can be added selectively. + - [AquaMai](https://github.com/MewoLab/AquaMai) open source MelonLoader mod for maimai, includes fixes, QOL, and cheats that can be configured from a toml or [gui](https://github.com/MewoLab/MaiChartManager). + - [worldlinkd](https://github.com/MewoLab/worldlinkd) open source MelonLoader mod for maimai, which adds cross-network online c2c similar to online matching in CHUNITHM. + +!!! warning "AquaMai & worldlinkd" + + These mods may not work with the MelonLoader compatiblity layer for BepInEx, and as such it's recommended to follow their respective guides. \ No newline at end of file diff --git a/docs/extras/zerotier.md b/docs/extras/zerotier.md new file mode 100644 index 0000000..110fdb1 --- /dev/null +++ b/docs/extras/zerotier.md @@ -0,0 +1,133 @@ + + +# ZeroTier for Cabinet-to-Cabinet Play + +!!! danger "Warning for CHUNITHM" + + CHUNITHM has stricter network requirements than other SEGA games and needs a specific subnet. In this guide, we will use the subnet `192.168.196.0` as an example. However, to run CHUNITHM, you must change it to the subnet `192.168.139.0`. If you don't, cabinets set to "FOLLOW THE STANDARD" will fail to connect. You will also need to adjust the `IPv4 Auto-Assign` setting of your Zerotier network accordingly by changing `196` to `139`. + +## Installing + +!!! tip "" + + Go to the [ZeroTier download page](https://www.zerotier.com/download/). Download and run the Windows installer. + After installation, the program will open automatically in your taskbar. + +## Joining a network + +!!! tip "Connecting to a network" + + To join a network on ZeroTier, you will need its **16-digit Network ID**. + + - Start ZeroTier if it's not already running + - Right click on the ZeroTier icon in your taskbar + - Click on "Join New Network" + - Enter the Network ID + - Click on "Join" + + That's it! + +!!! info "Checking your connection" + + Open your Command Prompt, and run the command `ipconfig` + Your IP address will appear under `Ethernet adapter ZeroTier One [NETWORK ID]` next to `IPv4 Address` + + + + To check if you can successfully reach another computer on the network, run the command `ping [IPv4 Address]` replacing `[IPv4 Address]` with the IP address of the other computer, *not your own*. + +!!! tip "Configuration for segatools" + + Edit `segatools.ini` with the following content: + + ``` + [netnev] + enable=1 + addrSuffix= The last segment of your ZeroTier IP address (e.g., if your IP is 192.168.196.5, set addrSuffix = 5) + + [keychip] + subnet=192.168.196.0 + + [system] + dipsw1=1 ;Set this to 1 on the host machine and set this to 0 on all others + ``` + + !!! warning "Each person must have their own keychip" + + If you play on a remote network, you likely already have your own keychip. + If not, you can use these example keychips: `A61E-01D02321145` ; `A61E-01A30831145` ; `A61E-01E38091145` ; `A61E-01E46241145` + + When starting your game, make sure to allow any Windows Firewall pop-ups (such as for `amdaemon.exe`, `mu3.exe`, `chusanApp.exe`...) + + ??? info "If you didn't see a pop-up" + + This could mean one of two things. + + Either you have already allowed it, and cab-to-cab is working successfully. That's great! No need to change anything. + Or, you denied access, and cab-to-cab isn't working. In that case follow these steps: + + - Open the Windows Control Panel + - Click on `System and Security` + - Click on `Windows Defender Firewall` + - On the left side, click on `Advanced settings` + - In the new window, click on `Inbound Rules` and look for your game's executables + - Right click on one of them, then click on `Properties` + - Select `Allow the connection` then press `OK` + - Repeat this for all game executables + + Alternatively, you can disable your firewall for both *public* and *private networks*. Please note that this should only be a **temporary measure** for testing, as it poses a **^^security risk^^** to your computer. + +!!! tip "Configuration for spice2x" + + - Open `spicecfg.exe` + - Navigate to the `Development` tab + - Enter your ZeroTier IP in the `Preferred NetAdapter IP` field + - Enter `255.255.255.0` in the `Preferred NetAdapter Subnet` field + +## Creating a network + +!!! tip "" + + - Go to [my.zerotier.com](https://my.zerotier.com/) and create an account + - Create a network + - Click on its name in the list to configure it + +!!! info "About your Network ID" + + Your *Network ID* is displayed on your account's homepage, and in the configuration menu. + This allows you and others to [join your network](#joining-a-network). + + If your network is set to `Public` then **anyone** with it can join it. Treat it like a password. + +### Network configuration + +!!! info "Following tabs correspond to the ones found in the configuration menu, follow both "Basics" and "Advanced"" + +=== "Basics" + + !!! info "Name" + + Either keep the default random name, or rename it to your liking. + + !!! tip "Access Control" + + - **Private**: This is the default option and will require you to accept people who want to join your network + - **Public**: ^^Recommended^^, anyone with the *Network ID* can join without authorization + +=== "Advanced" + + !!! tip "Managed Routes" + + Delete the already existing entry. + Under "Add Routes", set "Destination" as `192.168.196.0/24` then press "Submit". + + !!! tip "IPv4 Auto-Assign" + + Delete the already existing entry. + Under "Add IPv4 Address Pools" set "Range Start" as `192.168.196.1` and "Range End" as `192.168.196.254` then press "Submit". + + !!! info "" + + You should end up with this: + + \ No newline at end of file diff --git a/docs/games/konami/beatstream/animutribe/setup.md b/docs/games/konami/beatstream/animutribe/setup.md new file mode 100644 index 0000000..ea7063e --- /dev/null +++ b/docs/games/konami/beatstream/animutribe/setup.md @@ -0,0 +1,61 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### Getting Started + +!!! tip "" + Before we even touch the game, let's fiddle with our audio settings to minimize any potential audio issues on startup. In Windows, go to `Playback Devices` and then right click on your default device and go to `Properties`. From there, hit the `Advanced` tab and set your `Default Format` to `44100 Hz` and check both of the options inside `Exclusive Mode` as pictured. + + + +!!! tip "" + + Once that's done,, it's time to work on setting up your data. + + 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 64-bit tools inside the game's `contents` folder, and to create a `.bat` file. Pictured below is what your folder should look like, feel free to name your `.bat` file whatever you desire, for the sake of convenience we've named ours `gamestart.bat`. + + + +### 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 `spice64.exe -ea -w` and save the file. + + What do these different parameters do? + + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + +### 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 `spice64.exe -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + +### 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. + +!!! tip "" + You're all done! If you have a touchscreen monitor make sure it's plugged in, it should work automatically, if it doesn't check out the advertised `Troubleshooting` section at the link below. + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section and [Error Code](/errorcodes/konami.md) section to resolve any issues not seen in this guide to greater depth. diff --git a/docs/games/konami/beatstream/animutribe/troubleshooting.md b/docs/games/konami/beatstream/animutribe/troubleshooting.md new file mode 100644 index 0000000..c8f0c1d --- /dev/null +++ b/docs/games/konami/beatstream/animutribe/troubleshooting.md @@ -0,0 +1,44 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### Hardware Specs + +!!! tip "" + Bemani PC Type 6 (ADE-704A) + + Based on an AMD Embedded R Series SoC. + + CPU: Intel Celeron B810 + + GPU: AMD Radeon E4690 + + OS: Windows 7 Embedded + +### My Game Doesn't Boot After Following the Guide! + +!!! tip "" + The most common problem present here is if you do not have an E:/ drive. To resolve this issue, you must modify your game with the `E:/drive fix` patch. + +### My Touchscreen Monitor Isn't Working + +!!! tip "" + Try adding the `-wintouch` parameter to your `.bat` file, if that doesn't work, check the log and make sure it works with windows. SpiceTools at this point works with the grand majority of touchscreen monitors but no doubt some outliers are out there! + +### 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. + +### Which Offset Is Which? + +!!! tip "" + If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-). \ No newline at end of file diff --git a/docs/games/konami/ddr/a20/setup.md b/docs/games/konami/ddr/a20/setup.md new file mode 100644 index 0000000..c55f489 --- /dev/null +++ b/docs/games/konami/ddr/a20/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/ddr/common/setup.md" \ No newline at end of file diff --git a/docs/games/konami/ddr/a20/troubleshooting.md b/docs/games/konami/ddr/a20/troubleshooting.md new file mode 100644 index 0000000..1db23cf --- /dev/null +++ b/docs/games/konami/ddr/a20/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/ddr/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/konami/ddr/a20plus/setup.md b/docs/games/konami/ddr/a20plus/setup.md new file mode 100644 index 0000000..3799d19 --- /dev/null +++ b/docs/games/konami/ddr/a20plus/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/ddr/common/setup.md" \ No newline at end of file diff --git a/docs/games/konami/ddr/a20plus/troubleshooting.md b/docs/games/konami/ddr/a20plus/troubleshooting.md new file mode 100644 index 0000000..cc4adb5 --- /dev/null +++ b/docs/games/konami/ddr/a20plus/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/ddr/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/konami/ddr/a3/setup.md b/docs/games/konami/ddr/a3/setup.md new file mode 100644 index 0000000..3a8d6be --- /dev/null +++ b/docs/games/konami/ddr/a3/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/ddr/common/setup.md" \ No newline at end of file diff --git a/docs/games/konami/ddr/a3/troubleshooting.md b/docs/games/konami/ddr/a3/troubleshooting.md new file mode 100644 index 0000000..1fc9911 --- /dev/null +++ b/docs/games/konami/ddr/a3/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/ddr/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/konami/ddr/common/setup.md b/docs/games/konami/ddr/common/setup.md new file mode 100644 index 0000000..8f3dbd2 --- /dev/null +++ b/docs/games/konami/ddr/common/setup.md @@ -0,0 +1,162 @@ +# Game Setup + +--8<-- "docs/snippets/common/data_warning.md" + +## About data + +!!! note "" + + Please keep the following in mind as you're going through this guide. + + DDR's codename is `MDX`. Starting with `DDR A20` this would be either: + + - `MDX-001` *(Other cabs, 32 bits)* + - `MDX-003` *(Gold cab, 64 bits)* + + The gold cab version contains more features, such as exclusive songs or the "GOLDEN LEAGUE" mode. + +## Preparing data + +--8<-- "docs/snippets/common/data_readonly.md" + + The **complete game data** should be approximately **20 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: + + ``` + 📂arkdata + 📂com + 📂data + 📂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 "Please make sure you're using the right update for your current data." + + DDR updates have `MDX` and one or two datecodes in their archive names. + + **Single datecode:** Contains one update (e.g., `MDX_NewDateCode.7z`) + **Two datecodes:** Updates from the older to newer version (e.g., `MDX_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 + +!!! info "If you already have spice2x installed, ensure you're using the latest version" + +??? tip "For MDX-001 (32 bits)" + + - 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 + ``` + +??? tip "For MDX-003 (64 bits)" + + - 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 + ``` + +## Configuring spice2x + +--8<-- "docs/snippets/konami/common/spicecfg_preamble.md" + +=== "Buttons" + +--8<-- "docs/snippets/konami/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 P1 and/or P2: + + - **Maintenance**: `Service, Test` + - **Game buttons**: `Up, Down, Left, Right` + - **Menu buttons**: ` Start, Up, Down, Left, Right` + - **Keypad**: `Keypad Insert Card`, `1 to 9` + +--8<-- "docs/snippets/konami/common/spicecfg_buttons_additionalinfo.md" + +=== "Analogs" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.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/common/spicecfg_options_nvprofile.md" + +=== "Advanced" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +=== "Development" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +## Connecting to a network + +--8<-- "docs/snippets/konami/common/setup_network.md" + +## Installing VCRedist & DirectX + +--8<-- "docs/snippets/common/setup_vcredist_directx.md" + +## Before playing + +--8<-- "docs/snippets/common/before_playing.md" + +## Help + +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/konami/ddr/common/troubleshooting.md b/docs/games/konami/ddr/common/troubleshooting.md new file mode 100644 index 0000000..050c438 --- /dev/null +++ b/docs/games/konami/ddr/common/troubleshooting.md @@ -0,0 +1,27 @@ +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +!!! info "For any issues not covered here, spice2x's [Known issues](https://github.com/spice2x/spice2x.github.io/wiki/Known-issues) page might prove useful" + +## Technical problems + +### Crashes + +??? tip "Game crashes on startup or when starting a song / No background and no music video" + + This is probably due to missing or incorrectly registered codecs. From version 25-08-17 of spice2x onwards, the codecs will be registered automatically when you launch the game, so please update your installation. If this does not resolve the issue, or if you do not wish to update, please follow the DDR section on the [spice2x wiki](https://github.com/spice2x/spice2x.github.io/wiki/DLL-Dependencies#ddr). + +### Performance + +!!! info "Check out spice2x's [PC optimization](https://github.com/spice2x/spice2x.github.io/wiki/PC-optimization) guide" + +??? tip "Game is running too slow/fast" + + Try to eliminate any unnecessary background processes during play and ensure your screen's framerate is set to 60 FPS. + +## Other + +??? tip "Where are the option for Dancers/Shading/Measure lines/Fast-Slow/Layering?" + + These options are locked behind network requirements and will not be displayed unless you are connected to a network that has written support for these options. Patches are available to mitigate this, see our [spice2x Patching guide](/extras/patchsp2x.md). \ No newline at end of file diff --git a/docs/games/konami/ddr/world/setup.md b/docs/games/konami/ddr/world/setup.md new file mode 100644 index 0000000..d987fee --- /dev/null +++ b/docs/games/konami/ddr/world/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/ddr/common/setup.md" \ No newline at end of file diff --git a/docs/games/konami/ddr/world/troubleshooting.md b/docs/games/konami/ddr/world/troubleshooting.md new file mode 100644 index 0000000..e4c12dc --- /dev/null +++ b/docs/games/konami/ddr/world/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/ddr/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/konami/gitadora/exchain/setup.md b/docs/games/konami/gitadora/exchain/setup.md new file mode 100644 index 0000000..6866b0f --- /dev/null +++ b/docs/games/konami/gitadora/exchain/setup.md @@ -0,0 +1,147 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +!!! danger "Warning:" + Please make sure your data is from an appropriate source and unmodified before proceeding, this guide is unable to troubleshoot any problems related to bad or poorly managed data. + + If you obtained data from a torrent file, make sure you're not seeding the data before proceeding as well. + + Lastly, for demonstrative purposes, this guide uses SpiceTools, you should consult appropriate documentation and requirements of your desired tools as the setup process is likely to be extremely similar. + +### Getting Started. + +!!! tip "" + Before we even touch the game, let's fiddle with our audio settings to minimize any potential audio issues on startup. In Windows, go to `Playback Devices` and then right click on your default device and go to `Properties`. From there, hit the `Advanced` tab and set your `Default Format` to `44100 Hz` and check both of the options inside `Exclusive Mode` as pictured. + + + +!!! tip "" + Once that's done, it's time to work on setting up your data. + + 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, the first thing to do is put your desired 64-bit tools inside the game's `contents` folder, and to create a `.bat` file. Pictured below is what your folder should look like, feel free to name your `.bat` file whatever you desire, for the sake of convenience we've named ours `gamestart.bat`. + + + +!!! tip "" + Why does this look different than the usual? This installation includes a `modules` folder that Spice automatically detects, keeping things clean and simple. + +### 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 for both launching the guitar version and drum version using 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 GUITAR** + + For our guitar local network configuration example, on a single line in the `.bat` file we're going to type `spice64.exe -e prop\eamuse-config2.xml -2ch -ea -w` and save the file. + + What do these different parameters do? + - `-e` sets a custom path for the eamuse config to boot the proper one (in this case, guitar via `prop\eamuse-config2.xml`) + - `-2ch` enables 2-channel audio for GITADORA + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +!!! tip "" + **FOR DRUM** + + For our drum local network configuration example, on a single line in the `.bat` file we're going to type `spice64.exe -2ch -ea -w` and save the file. + + What do these different parameters do? + - `-2ch` enables 2-channel audio for GITADORA + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +### Configuring for an Online Network + +!!! tip "" + **FOR GUITAR** + + For our guitar online network example we're simply doing the above but with different parameters! On our single line, we're going to type `spice64.exe -e prop\eamuse-config2.xml -2ch -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-e` sets a custom path for the eamuse config to boot the proper one (in this case, guitar via `prop\eamuse-config2.xml`) + - `-2ch` enables 2-channel audio for GITADORA + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +!!! tip "" + **FOR DRUM** + + For our drum online network example we're simply doing the above but with different parameters! On our single line, we're going to type `spice64.exe -2ch -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-2ch` enables 2-channel audio for GITADORA + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +!!! 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, oh no! + + + +!!! tip "" + This is normal, simply hit your `Test` keybind and continue on to this. + + + +!!! tip "" + From here, we will need to set a shop name to play, so select the `GAME OPTIONS` option. + + + +!!! tip "" + Then, select `SHOP SETTINGS`. + + + +!!! tip "" + Once inside, select `SHOP NAME SETTINGS` and name your shop whatever you desire! For the purpose of the guide, we named it `Guide` but highly encourage fun and/or lazy names. Once that's done, go down to `PREFECTURE` and set it to whatever you desire as well. Finally, go to `SAVE AND EXIT` to get back to the main menu. + + + +!!! tip "" + The last menu we'll go inside from the service menu is the clock menu. Go inside `CLOCK` and simply set the clock by hitting `SAVE AND EXIT` as pictured below. + + + +!!! tip "" + You're all done! From the service menu select `GAME MODE` and the game should load ready to be played! Have fun! + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section and [Error Code](/errorcodes/konami.md) section to resolve any issues not seen in this guide to greater depth. diff --git a/docs/games/konami/gitadora/exchain/troubleshooting.md b/docs/games/konami/gitadora/exchain/troubleshooting.md new file mode 100644 index 0000000..cb6e823 --- /dev/null +++ b/docs/games/konami/gitadora/exchain/troubleshooting.md @@ -0,0 +1,74 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Hardware Specs + +!!! tip "" + Bemani PC Type 4 + + CPU: AMD Athlon 64 X2 4400 + + GPU: ATI Radeon HD 2400 + + RAM: 1 GB + + OS: Windows 7 Embedded + +### 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. + +### Game Stuck On Title Screen (AMD Ryzen 3900X) + +!!! tip "" + If you have AMD Ryzen 3900X-series processor and the game gets stuck on the title screen (or a black screen) you are running into a known processor bug for games using Media Foundation to play videos. The workaround is to disable simultaneous multithreading (SMT) in the system's BIOS settings. See [this GitHub issue for Proton](https://github.com/ValveSoftware/Proton/issues/838#issuecomment-557081962) + +### Occasional Graphical Stuttering During Gameplay + +!!! tip "" + Disable fullscreen optimizations for spice64.exe instance. Right click on spice64.exe, click on Properties. Click on Compatibility tab, "Change settings for all users", and check "Disable fullscreen optimizations". + +### I get an IP Change Error! + +!!! tip "" + Apply the `Fix IP Change Error` patch. + +### Which Offset Is Which? + +!!! tip "" + If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-). Gitadora features BOTH a visual offset and an audio based one, so experiment accordingly. + +### Why Are My Videos Freezing (Usually Towards the End of the Song)? + +!!! tip "" + If you're using Windows 10, there is a bug that is caused by the difference between the ASF stream decoder between Windows 7 and Windows 10 wherein it fails to properly detect the end of file of the video stream which causes the video decoder to throw an exception, which is why the video freezes. At the time of writing, SpiceTools does not have a fix for this, but there are hooks available to resolve this issue. + +### I Tried Switching to SpiceTools to Follow the Guide and It Crashes! + +!!! tip "" + This is a known issue, make sure to replace all of the `.dll` files from the ``contents`` folder of the game with ones from a fresh install, other tools currently modify these files in a way that SpiceTools cannot deal with. + +### My Drum Pedal Isn't Working! + +!!! tip "" + Some drum kits utilize hi-hat control with the pedal resulting in different MIDI addresses that require additional bindings, make sure to follow your drum kit's manual to see these other bindings and bind them in your desired tool's accordingly. Gitadora does not do this, so the game utilizes just 1 binding for every level of sensitivity on the pedal and multiple bindings are typically required with most drum kits. + +### When I Run This Game All Other Background Audio Is Gone! What's Going On? + +!!! tip "" + Gitadora is a 64-bit game that utilizes a feature in Windows called [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) to obtain less audio latency than the former 32-bit versions of BEMANI games which used [DirectSound](https://en.wikipedia.org/wiki/DirectSound). Unfortunately, this cannot be changed. + +### Note on 2-channel and 4-channel Audio + +!!! tip "" + For most setups, the `-2ch` parameter will be mandatory to hear any functional audio. 4-channel setups aren't really working in general and there's buffer issues, please avoid using it. diff --git a/docs/games/konami/gitadora/fuzzup/setup.md b/docs/games/konami/gitadora/fuzzup/setup.md new file mode 100644 index 0000000..a817d53 --- /dev/null +++ b/docs/games/konami/gitadora/fuzzup/setup.md @@ -0,0 +1,253 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Installing spice2x + +!!! info "" + + If you already have spice2x installed, make sure it is up to date! + +!!! tip "" + + - Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release. + - Extract the `spice64.exe` and `spicecfg.exe` files from the archive to your game's directory. + + + +## General Configuration + +!!! info "" + + Since GITADORA has a separate mode for both Guitar and Drums, the configuration will be split into three sections.
This section will cover the general configuration that is not specific to either mode. + +!!! info "Open `spicecfg.exe`, each following sub-section corresponds to a tab at the top" + +### Buttons + +!!! tip "" + + Click on `Bind` then press the key you want associated with the action. + + With your keyboard, configure your keys for: + + - **Maintenance:** `Test` + - **P1 Keypad**: `Keypad 0 to 9, Keypad Insert Card` + +### Cards + +!!! info "Covered in the [Connecting to a Network](#connecting-to-a-network) section" + +### Patches + +!!! info "Go through the [spice2x Patching](/extras/patchsp2x.md) page to import patches" + +!!! danger "To prevent issues, avoid patching things you don't need or understand" + +### Options + +!!! danger "Be very careful changing options you don't understand as it may cause issues" + +!!! tip "Required" + + | Category | Option | Parameter | Setting | + |---------------|-----------------------------|-------------|---------| + | Game Options | GitaDora Two Channel Audio | -2ch | ON | + | Network | EA Service URL | -url | Covered in [Connecting to a Network](#connecting-to-a-network) | + +!!! tip "Highly Recommended for NVIDIA users ONLY" + + | Category | Option | Parameter | Setting | + |-------------------|-----------------------------------|---------------|---------| + | Graphics (Common) | NVIDIA profile optimization | -nvprofile | ON | + +## GuitarFreaks Configuration + +!!! info "" + + This section will cover the configuration specific to the **Guitar** mode.
If you are wanting to configure drums, skip to the [DrumMania Configuration](#drummania-configuration) section. + +#### Buttons + +!!! tip "Set up your guitar as right-handed. Lefty mode is software-based" + +!!! tip "" + + Click on `Bind` then press the key you want associated with the action. + + With your keyboard and controller plugged in, configure your keys for: + + - **Guitar P1 IO Panel:** `Guitar P1 Start, Up, Down, Left, Right, Help` + - **Guitar P1 Controls:** `Guitar P1 Pick Up, Pick Down, R, G, B, Y, P` + +### Analogs + +!!! tip "" + + Rather than setting your Wail to buttons, you should: + + - Find the Guitar P1 Wail X, Y, and Z analogs. + - Click `Bind`. + - In `Device`, pick your guitar. + - In `Control`, pick the corresponding axis. + - Move your guitar and ensure the Preview visualizer shows movement. + - Repeat for other applicable axes your guitar has. + +### Advanced + +!!! warning "Not setting these values will cause the game to not boot into either mode" + +!!! tip "Required" + + | Category | Option | Parameter | Setting | + |---------------|-----------------------------|-------------|---------| + | Paths | Path to ea3-config.xml | -e | `prop/ea3-config2.xml` | + | Paths | Path to avs-config.xml | -v | `prop/avs-config-jb.xml` | + +## DrumMania Configuration + +!!! info "" + + This section will cover the configuration specific to the **Drums** mode.
If you are wanting to configure guitar, refer to the [GuitarFreaks Configuration](#guitarfreaks-configuration) section. + +### Buttons + +!!! tip "" + + Click on `Bind` then press the key you want associated with the action. + + With your keyboard and controller plugged in, configure your keys for: + + - **Drum IO Panel:** `Drum Start, Up, Down, Left, Right, Help` + - **Drum Controls:** `Drum Hi-Hat, Snare, Hi-Tom, Low-Tom, Right Cymbal, Bass Pedal, Left Cytmbal, Left Pedal, Floor Tom` + +### Advanced + +!!! warning "Not setting these values will cause the game to not boot into either mode" + +!!! tip "Required" + + | Category | Option | Parameter | Setting | + |---------------|-------------------------|-------------|---------| + | Paths | Path to ea3-config.xml | -e | `prop/ea3-config.xml` | + | Paths | Path to avs-config.xml | -v | `prop/avs-config-ja.xml` | + +## Connecting to a Network + +!!! danger "Please choose one of the two solutions, not both!" + +??? tip "Remote (Online Network)" + + Open `spicecfg.exe` and head to the `Options` tab. + + In the `Network` category, set the following settings: + + - `EA Service URL` to the URL provided by your network. + - `PCBID` to the PCBID provided by your network. + + + + Next you need a card number. + If you don't already have one, generate one in the `Cards` tab. + To keep your card number safe, create a new `.txt` file with ONLY it inside. + + Once that's done, head to the `Cards` tab, for `Player 1` click `Open...` and point to your text file. + + + +??? tip "Local e-amuse Emulator (Asphyxia)" + + This is covered in the [Asphyxia CORE](/extras/asphyxia.md) page. + +## Pre-launch Requirements + +!!! info "These steps are required, otherwise your game won't run" + +### VCRedist & DirectX + +!!! tip "" + + - Download and install the latest [VCRedist](https://www.techpowerup.com/download/visual-c-redistributable-runtime-package-all-in-one/) + - Download and install the [DirectX End-User Runtimes](https://www.microsoft.com/en-us/download/details.aspx?id=8109) + +### Audio + +!!! info "GITADORA FUZZ-UP currently only supports WASAPI exclusive mode" + +!!! tip "" + + - Open `spicecfg.exe`. + - At the very top, click on `Shortcuts` then `Audio Playback Devices`. + - In the popup window, right click on your default audio device, and click on `Properties`. + - Go to the `Advanced` tab. + - Check both boxes under `Exclusive Mode`. + - Open the `Default Format` dropdown. + - Pick the `24 bit, 44100 Hz (Studio Quality)` option and click `Apply` then `OK`. + + + +## First Launch + +!!! danger "If you have any issues running the game at this point, refer to the [Troubleshooting](troubleshooting.md) page" + +!!! tip "" + + If you've followed all instructions correctly, you're finally ready to launch the game! + + First, ensure your guitar or drumkit is connected and run `spice64.exe`. Press `Yes` when it asks for elevated privileges. + + Upon launching your game, you will be greeted with this `BACKUP DATA ERROR` screen. + + + +!!! tip "" + + This is normal, simply hit your `Test` keybind to enter test mode. + + + +!!! tip "" + + From here, we will need to set a shop name to play, so select the `GAME OPTIONS` option. + + + +!!! tip "" + + Then, select `SHOP SETTINGS`. + + + +!!! tip "" + + Once inside, select `SHOP NAME SETTINGS` and name your shop whatever you desire! Once that's done, go down to `PREFECTURE` and set it to whatever you desire as well. Finally, go to `SAVE AND EXIT` to get back to the test menu. + + + +!!! tip "" + + The last menu we'll go inside from the test menu is the clock menu. Go inside `CLOCK` and simply set the clock by hitting `SAVE AND EXIT` as pictured below. + + + +!!! tip "" + + You're all done! From the test menu, select `GAME MODE` and the game should boot up! + +## Carding In + +!!! tip "" + + Once the game is done loading, you need to card in. + + - Press your `Keypad Insert Card` button. + - Enter your code using your keypad binds. + +## Troubleshooting + +!!! warning "Have any other issue?" + + Check out the [Troubleshooting](troubleshooting.md) and [Error Codes](/errorcodes/konami.md) pages. diff --git a/docs/games/konami/gitadora/fuzzup/troubleshooting.md b/docs/games/konami/gitadora/fuzzup/troubleshooting.md new file mode 100644 index 0000000..01433e9 --- /dev/null +++ b/docs/games/konami/gitadora/fuzzup/troubleshooting.md @@ -0,0 +1,61 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### I'm having performance issues! + +!!! tip "" + + If you're having performance issues of some kind, spice2x's [PC optimization](https://github.com/spice2x/spice2x.github.io/wiki/PC-optimization) guide is worth looking at. + +### My game is running too fast! + +!!! tip "" + + The most common reason for this is the game is running over its required refresh rate. + + To solve this, ensure the monitor running GITADORA FUZZ-UP is set to 60 Hz. This is a requirement for the game to run at the correct speed. The game is hardcoded to run at 60 Hz and there is no way to change this. + + In addition, make sure v-sync isn't disabled in your graphics card's settings. + + For NVIDIA users, enable `NVIDIA profile optimization (-nvprofile)` in the `Options` tab. + +### There's occasional graphical stuttering during gameplay! + +!!! tip "" + + To fix this, you need to disable fullscreen optimizations for `spice64.exe`. + + 1. Right click on `spice64.exe` and select `Properties`. + 2. Go to the `Compatibility` tab. + 3. Click the box at the bottom that says `Change settings for all users`. + 4. Check the box that says `Disable fullscreen optimizations`. + 5. Click `Apply` and then `OK`. + +### How do I adjust my offset? + +!!! tip "" + + Play through a chart you're comfortable with. + + If you're getting too many `Fast`, increase your offset `(+)`. + If you're getting too many `Slow`, decrease your offset `(-)`. + + GITADORA FUZZ-UP has two types of offset adjustments, visual and audio based, so be sure to fiddle with both to find desirable settings. + +### When I run the game, all other audio is gone! + +!!! tip "" + + GITADORA FUZZ-UP uses [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) for better audio latency. + + There is currently no patch available to run the game in shared mode, so you will need to use a separate audio device for the game if you want to hear other audio sources while playing. + +### I want to use 4-channel audio! Why isn't it working? + +!!! tip "" + + Unfortunately, most setups do not properly function with GITADORA FUZZ-UP's 4-channel audio, and the `-2ch` parameter will be mandatory to hear any audio. There are not many setups working with 4-channel audio, and there are buffer issues related to it. Please avoid using it. \ No newline at end of file diff --git a/docs/games/konami/gitadora/matixx/setup.md b/docs/games/konami/gitadora/matixx/setup.md new file mode 100644 index 0000000..56940d5 --- /dev/null +++ b/docs/games/konami/gitadora/matixx/setup.md @@ -0,0 +1,137 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### Getting Started. + +!!! tip "" + Before we even touch the game, let's fiddle with our audio settings to minimize any potential audio issues on startup. In Windows, go to `Playback Devices` and then right click on your default device and go to `Properties`. From there, hit the `Advanced` tab and set your `Default Format` to `44100 Hz` and check both of the options inside `Exclusive Mode` as pictured. + + + +!!! tip "" + Once that's done, it's time to work on setting up your data. + + 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, the first thing to do is put your desired 64-bit tools inside the game's `contents` folder, and to create a `.bat` file. Pictured below is what your folder should look like, feel free to name your `.bat` file whatever you desire, for the sake of convenience we've named ours `gamestart.bat`. + + + +### 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 for both launching the guitar version and drum version using 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 GUITAR** + + For our guitar local network configuration example, on a single line in the `.bat` file we're going to type `spice64.exe -e prop\eamuse-config2.xml -2ch -ea -w` and save the file. + + What do these different parameters do? + - `-e` sets a custom path for the eamuse config to boot the proper one (in this case, guitar via `prop\eamuse-config2.xml`) + - `-2ch` enables 2-channel audio for GITADORA + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +!!! tip "" + **FOR DRUM** + + For our drum local network configuration example, on a single line in the `.bat` file we're going to type `spice64.exe -2ch -ea -w` and save the file. + + What do these different parameters do? + - `-2ch` enables 2-channel audio for GITADORA + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +### Configuring for an Online Network + +!!! tip "" + **FOR GUITAR** + + For our guitar online network example we're simply doing the above but with different parameters! On our single line, we're going to type `spice64.exe -e prop\eamuse-config2.xml -2ch -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-e` sets a custom path for the eamuse config to boot the proper one (in this case, guitar via `prop\eamuse-config2.xml`) + - `-2ch` enables 2-channel audio for GITADORA + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +!!! tip "" + **FOR DRUM** + + For our drum online network example we're simply doing the above but with different parameters! On our single line, we're going to type `spice64.exe -2ch -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-2ch` enables 2-channel audio for GITADORA + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +!!! 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, oh no! + + + +!!! tip "" + This is normal, simply hit your `Test` keybind and continue on to this. + + + +!!! tip "" + From here, we will need to set a shop name to play, so select the `GAME OPTIONS` option. + + + +!!! tip "" + Then, select `SHOP SETTINGS`. + + + +!!! tip "" + Once inside, select `SHOP NAME SETTINGS` and name your shop whatever you desire! For the purpose of the guide, we named it `Guide` but highly encourage fun and/or lazy names. Once that's done, go down to `PREFECTURE` and set it to whatever you desire as well. Finally, go to `SAVE AND EXIT` to get back to the main menu. + + + +!!! tip "" + The last menu we'll go inside from the service menu is the clock menu. Go inside `CLOCK` and simply set the clock by hitting `SAVE AND EXIT` as pictured below. + + + +!!! tip "" + You're all done! From the service menu select `GAME MODE` and the game should load ready to be played! Have fun! + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section and [Error Code](/errorcodes/konami.md) section to resolve any issues not seen in this guide to greater depth. diff --git a/docs/games/konami/gitadora/matixx/troubleshooting.md b/docs/games/konami/gitadora/matixx/troubleshooting.md new file mode 100644 index 0000000..fd4d7c4 --- /dev/null +++ b/docs/games/konami/gitadora/matixx/troubleshooting.md @@ -0,0 +1,74 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Hardware Specs + +!!! tip "" + Bemani PC Type 4 + + CPU: AMD Athlon 64 X2 4400 + + GPU: ATI Radeon HD 2400 + + RAM: 1 GB + + OS: Windows 7 Embedded + +### 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. + +### Game Stuck On Title Screen (AMD Ryzen 3900X) + +!!! tip "" + If you have AMD Ryzen 3900X-series processor and the game gets stuck on the title screen (or a black screen) you are running into a known processor bug for games using Media Foundation to play videos. The workaround is to disable simultaneous multithreading (SMT) in the system's BIOS settings. See [this GitHub issue for Proton](https://github.com/ValveSoftware/Proton/issues/838#issuecomment-557081962) + +### Occasional Graphical Stuttering During Gameplay + +!!! tip "" + Disable fullscreen optimizations for spice64.exe instance. Right click on spice64.exe, click on Properties. Click on Compatibility tab, "Change settings for all users", and check "Disable fullscreen optimizations". + +### I get an IP Change Error! + +!!! tip "" + Apply the `Fix IP Change Error` patch. + +### Which Offset Is Which? + +!!! tip "" + If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-). Gitadora features BOTH a visual offset and an audio based one, so experiment accordingly. + +### Why Are My Videos Freezing (Usually Towards the End of the Song)? + +!!! tip "" + If you're using Windows 10, there is a bug that is caused by the difference between the ASF stream decoder between Windows 7 and Windows 10 wherein it fails to properly detect the end of file of the video stream which causes the video decoder to throw an exception, which is why the video freezes. At the time of writing, SpiceTools does not have a fix for this, but there are hooks available to resolve this issue. + +### I Tried Switching to SpiceTools to Follow the Guide and It Crashes! + +!!! tip "" + This is a known issue, make sure to replace all of the `.dll` files from the ``contents`` folder of the game with ones from a fresh install, other tools currently modify these files in a way that SpiceTools cannot deal with. + +### My Drum Pedal Isn't Working! + +!!! tip "" + Some drum kits utilize hi-hat control with the pedal resulting in different MIDI addresses that require additional bindings, make sure to follow your drum kit's manual to see these other bindings and bind them in your desired tool's accordingly. Gitadora does not do this, so the game utilizes just 1 binding for every level of sensitivity on the pedal and multiple bindings are typically required with most drum kits. + +### When I Run This Game All Other Background Audio Is Gone! What's Going On? + +!!! tip "" + Gitadora is a 64-bit game that utilizes a feature in Windows called [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) to obtain less audio latency than the former 32-bit versions of BEMANI games which used [DirectSound](https://en.wikipedia.org/wiki/DirectSound). Unfortunately, this cannot be changed. + +### Note on 2-channel and 4-channel Audio + +!!! tip "" + For most setups, the `-2ch` parameter will be mandatory to hear any functional audio. 4-channel setups aren't really working in general and there's buffer issues, please avoid using it. diff --git a/docs/games/konami/iidx/10thstyle/setup.md b/docs/games/konami/iidx/10thstyle/setup.md new file mode 100644 index 0000000..946f649 --- /dev/null +++ b/docs/games/konami/iidx/10thstyle/setup.md @@ -0,0 +1,295 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Preparing data + +!!! tip "" + + After downloading and extracting your data, we need to make sure your files aren't set to `Read-only`. + + - Right click the folder containing your data, then click on `Properties`. + - In the `General` tab go down to `Attributes`, untick `Read-only` and click `Apply`. + - A popup will appear, select `Apply changes to this folder, subfolder and files` and press `OK`. + - Finally, click `OK` again to exit out of properties. + +## Installing Bemanitools + +!!! tip "" + + - Download :material-package-down:[Bemanitools](https://github.com/djhackersdev/bemanitools/releases/download/5.48/bemanitools-5.48.zip). + + - Inside :material-zip-box:`bemanitools-5.48.zip` locate :material-zip-box:`iidx-09-to-12.zip`. + + - Extract everything inside the folder that contains the :material-file:`bm2dx.exe` which is located in :material-folder:`\D01\JAE`. + + Pictured below is what your folder should look like. We've removed any files not necessary for **10th style**. + + + +### Using iidxhook-10.conf & RtEffect.dll + +!!! tip "" + + - Download the :material-package-down:[Bemanitools supplements](https://github.com/djhackersdev/bemanitools-supplement/releases/download/1.6/bemanitools-supplement-1.6.zip) + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate inside :material-zip-box:`misc.zip` + + - Inside :material-folder:`misc\d3d8to9`, extract :material-file-cog-outline:`d3d8.dll` to :material-folder:`\D01\JAE`. + + This enables us to use the graphic options inside :material-file-code:`iidxhook-10.conf` which we will take advantage of. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate inside :material-zip-box:`iidx.zip` + + - Inside :material-folder:`iidx/misc`, extract :material-file-cog-outline:`RtEffect_stub.dll` to :material-folder:`\D01\JAE`. + + - Delete the already existing :material-file-remove-outline:`RtEffect.dll` and rename :material-file-edit-outline:`RtEffect_stub.dll` to :material-file-cog-outline:`RtEffect.dll`. + + This will eliminate any immediate crashes relating to needing specific old hardware. + +### Replacing bm2dx.exe + +!!! tip "" + + - Go to :material-folder:`D01\util` and copy :material-clipboard-file:`bm2dx_D01_JAE_no_checksum.exe` to `D01\JAE` + + - Delete the original :material-file-remove:`bm2dx.exe` + + - Rename :material-file-edit:`bm2dx_D01_JAE_no_checksum.exe` to :material-file:`bm2dx.exe` + + If you don't do this, you will end up getting a `HDD DATA ERROR (PROG CHKSUM)` which will result in the game not being able to run. + +## Configuring Bemanitools + +!!! info "To configure your keybinds, open your :material-file:`config.bat` file" + +### Buttons + +!!! tip "" + + Double click on the right on a button that you wish to bind, then press the key you want associated with the action. + + With your controller and/or keyboard plugged in, configure your keys for: + + - **Maintenance**: `Service, Test` + - **P1 Game buttons**: `1 to 7, Start, EFFECT, VEFX` + - **P1 Keypad**: `Keypad Insert Card` + + **Only if** you're playing using a keyboard: + + - **Turntable**: `TT+, TT-` **and optionally** `TT+/-` which alternates between `TT+` and `TT-` on each press. + +### Analogs (controller/cab only) + +!!! tip "" + + With a controller rather than binding buttons to `TT+` and `TT-`, you need to: + + - Head to the `Analogs` tab at the top. + - In `Device`, pick your controller. + - In `Control`, pick whichever one corresponds to the turntable. + - Turn your turntable ensuring that the preview turns along with it. + - Click `OK`, leaving the rest of the settings alone. + +### Lights (controller/cab only) + +!!! tip "" + + Your controller might support having its lights controlled by the game through bemanitools. + + If it does, here's how you may link different actions to your lights: + + - In `Device`, pick your controller. + - In `Game Light`, select the corresponding button that will be used for that light. + - Repeat for your other lights. + +### Configuring Bemanitools for a network + +!!! tip "Head over to the `Network` tab" + +!!! tip "" + Now we will set up our PIN pad and card. + + - Click on `Keyboard device` + - You may or may not have more than one option. To figure out which one is your actual keyboard, select a device inside that list and press a button on the numpad. + - Once you have found your correct device, the `Keyboard status` will change **(the number and location of the number does not matter, it only matters that it changed)**. + - Grab your card, create a :material-file-document-edit:`.txt` and name it however you like. In this example it's called :material-file-document-edit:`card.txt` + - Place the file in a location that is easily accessible and you won't forget. In this case it's in a seperate folder. + +!!! info "If you don't have a numpad, make sure to tick `Use top keyboard row for PIN pad input`. This will also change the `Card In` button to `Backspace`" + + + +## Connecting to a network + +!!! tip "" + + - Locate your :material-file-code:`iidxhook-10.conf` + + - Open it with your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) + + - Replace the `eamuse.server=localhost:80` with your desired network URL + + - Replace `eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX` **and** `eamuse.eamid=XXXXXXXXXXXXXXXXXXXX` with your PCBID of your network of choice. + + ``` + # URL (e.g. http://my.eamuse.server:80/whatever) or IPV4 (e.g. 127.0.0.1:80) of the target eamuse server. The port is optional but defaults to 80. + eamuse.server=localhost:80 + + # PCBID + eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX + + # EAMID + eamuse.eamid=XXXXXXXXXXXXXXXXXXXX + ``` + +## Game resolution and locking FPS + +!!! tip "" + We'd like to mention that there are two options when it comes to how the game renders. You can choose between `Linear` and `Point`. + + Below is an example of how both look like. + + ??? info "Linear" + + + ??? info "Point" + + + It comes down to your own prefrence what you decide on, `Linear` is less sharp but doesn't have pixel perfect edges. `Point` is sharp and is pixel perfect. + +!!! tip "" + Next up, we'll setup borderless window and configure the proper resolution. We're using a `1920x1080` monitor so we will use that. + + Repeat the previous step and open your :material-file-code:`iidxhook-10.conf`. We want to find these lines: + + ``` + # Run the game windowed + gfx.windowed=false + + # Windowed width, 0 for default size + gfx.window_width=0 + + # Windowed height, 0 for default size + gfx.window_height=0 + + # Up-/downscale the back buffer's width. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding height parameter. + gfx.scale_back_buffer_width=0 + + # Up-/downscale the back buffer's height. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding width parameter. + gfx.scale_back_buffer_height=0 + + # Filter type to use for up-/downscaling the back buffer. Only used if scaling feature was enabled by setting the scaling width and height parameters. Available types: none, linear, point (refer to D3DTEXTUREFILTERTYPE for explanation). + gfx.scale_back_buffer_filter=none + ``` + + If you can't seem to find them, press `CTRL` + `F` and search for `gfx.frame_rate_limit=0.0`. This will bring you to the first line we want to edit. + +!!! tip "" + Listed below are the values we want to change them to. + + ``` + gfx.frame_rate_limit=59.95 + gfx.windowed=true + gfx.window_width=1920 + gfx.window_height=1080 + gfx.scale_back_buffer_width=1920 + gfx.scale_back_buffer_height=1080 + gfx.scale_back_buffer_filter=point + ``` + Unless you'd like to have the game properly windowed you can safely ignore `gfx.framed=false`. + + Make sure to decide on whether you want `Linear` or `Point` rendering. + + ``` + gfx.scale_back_buffer_filter=linear + gfx.scale_back_buffer_filter=point + ``` + +## First launch + +!!! danger "If you have any issues running the game, refer to the [Troubleshooting](troubleshooting.md) page" + +### BACKUP DATA + +!!! 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 :material-file:`gamestart.bat`. + + If it's your first time running the game, you'll immediately be greeted with this screen. + + + + + +!!! tip "" + Press your `Start` key to confirm to get to the next error message. + +### CLOCK ERROR + + + +!!! tip "" + Press your `Start` key to confirm. This will bring you into it's service menu. + + + +!!! tip "" + 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. + + Navigate to `CLOCK`. You do not need to manually change it. Navigate to `SAVE AND EXIT`. + + + +### Enabling e-AMUSEMENT for Online Play + +!!! tip "" + From the service menu, go to `e-AMUSEMENT OPTIONS` then `e-AMUSEMENT SETTINGS`. + + + + + +!!! tip "" + It'll bring you to this screen, change it so that `e-AMUSEMENT` switches to `ON` and it will look like this: + + + + + +!!! tip "" + We will need to set a `SHOP NAME SETTING` and change our `PREFECTURE` otherwise the game will throw errors at us. + + + +!!! tip "" + + - Name your shop to whatever you'd like. Instructions on how to navigate are at the bottom of the screen. + - Navigate to `EXIT` and select it. + - Change your prefecture once or how many times you'd like, it doesn't matter as long as it's not the default one. + + + +!!! tip "" + Select `SAVE AND EXIT`. The game will now give you a message, which translated means: + + `e-AMUSEMENT settings have been changed. Please turn the power off and on again.` + + So, close the game and open it again. + + + +## Final Notes + +!!! success "You're all done! Make sure to insert two credits by pressing your `SERVICE` key. Have fun!" + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section. \ No newline at end of file diff --git a/docs/games/konami/iidx/10thstyle/troubleshooting.md b/docs/games/konami/iidx/10thstyle/troubleshooting.md new file mode 100644 index 0000000..4d0374c --- /dev/null +++ b/docs/games/konami/iidx/10thstyle/troubleshooting.md @@ -0,0 +1,62 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### My Game Is Running Crazy Fast! + +!!! tip "" + The most common reason for this is the game is running over its required 59.95hz, the game is hardcoded to run at 59.95hz and this cannot be changed. To solve this, check [Game resolution and locking FPS](setup.md#game-resolution-and-locking-fps) again. + +### I'm getting "NETWORK WARNING" instead of "NETWORK OK" + +!!! tip "" + This can be caused by: + + - Invalid PCBID + - Firewall blocking connections + - Invalid eamuse url or port specified + - Game is not run using the Administrator account + +### My background videos aren't working! + +!!! tip "" + + You need to install a codec. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate to :material-folder:`\iidx.zip\iidx\misc\` where :material-file:`CLVSD.ax` is located. + + - Extract :material-file:`CLVSD.ax` inside a :material-folder: folder that you know won't be moved or renamed. + + - Open the :material-console:command prompt as ***administrator***. Now type `regsvr32 "\CLVSD.ax"` into the command prompt. + + As an example, it could look like this: `regsvr32 "D:\BEMANI\IIDX\CLVSD.ax"` + + A prompt should appear telling you that it has been installed successfully. + This applies for all styles that require this codec, not just **10th style**. + + If an error occurs, you didn't run the command prompt as administrator or you messed up the location of the file. + +!!! danger "You **can not** move or delete :material-file:`CLVSD.ax` **at all**, otherwise it will revert the changes and you have to install it again" + +### My game crashes immediately! + +!!! warning "This can have multiple reasons. These fixes shouldn't be needed for 10th style since we're addressing them in the guide. We'll add them anyway just in case" + +#### Fix #1 (Wrong data structure) + +!!! tip "" + Make sure that your unpacked data looks like this: + + - JAx (Game binary revision folder where 'x' can be A, B, C, D, E, F, G) + - data + - sidcode.txt + + Any other files are optional and don't have to be removed as these are not required to run the game. + +#### Fix #2 (RtEffects.dll didn't get replaced) + +!!! tip "" + Refer to [Using iidxhook-10.conf & RtEffect.dll](setup.md#using-iidxhook-10conf-rteffectdll) again and check if you have followed all the instructions explained in it. \ No newline at end of file diff --git a/docs/games/konami/iidx/11_red/setup.md b/docs/games/konami/iidx/11_red/setup.md new file mode 100644 index 0000000..07c4ab4 --- /dev/null +++ b/docs/games/konami/iidx/11_red/setup.md @@ -0,0 +1,286 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Preparing data + +!!! tip "" + + After downloading and extracting your data, we need to make sure your files aren't set to `Read-only`. + + - Right click the folder containing your data, then click on `Properties`. + - In the `General` tab go down to `Attributes`, untick `Read-only` and click `Apply`. + - A popup will appear, select `Apply changes to this folder, subfolder and files` and press `OK`. + - Finally, click `OK` again to exit out of properties. + +## Installing Bemanitools + +!!! tip "" + + - Download :material-package-down:[Bemanitools](https://github.com/djhackersdev/bemanitools/releases/download/5.48/bemanitools-5.48.zip). + + - Inside :material-zip-box:`bemanitools-5.48.zip` locate :material-zip-box:`iidx-09-to-12.zip`. + + - Extract everything inside the folder that contains the :material-file:`bm2dx.exe` which is located in :material-folder:`\E11\JAA`. + + Pictured below is what your folder should look like. We've removed any files not necessary for **IIDX RED**. + + + +### Using iidxhook-11.conf & RtEffect.dll + +!!! tip "" + + - Download the :material-package-down:[Bemanitools supplements](https://github.com/djhackersdev/bemanitools-supplement/releases/download/1.6/bemanitools-supplement-1.6.zip) + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate inside :material-zip-box:`misc.zip` + + - Inside :material-folder:`misc\d3d8to9`, extract :material-file-cog-outline:`d3d8.dll` to :material-folder:`\E11\JAA`. + + This enables us to use the graphic options inside :material-file-code:`iidxhook-11.conf` which we will take advantage of. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate inside :material-zip-box:`iidx.zip` + + - Inside :material-folder:`iidx/misc`, extract :material-file-cog-outline:`RtEffect_stub.dll` to :material-folder:`\E11\JAA`. + + - Delete the already existing :material-file-remove-outline:`RtEffect.dll` and rename :material-file-edit-outline:`RtEffect_stub.dll` to :material-file-cog-outline:`RtEffect.dll`. + + This will eliminate any immediate crashes relating to needing specific old hardware. + +## Configuring Bemanitools + +!!! info "To configure your keybinds, open your :material-file:`config.bat` file" + +### Buttons + +!!! tip "" + + Double click on the right on a button that you wish to bind, then press the key you want associated with the action. + + With your controller and/or keyboard plugged in, configure your keys for: + + - **Maintenance**: `Service, Test` + - **P1 Game buttons**: `1 to 7, Start, EFFECT, VEFX` + - **P1 Keypad**: `Keypad Insert Card` + + **Only if** you're playing using a keyboard: + + - **Turntable**: `TT+, TT-` **and optionally** `TT+/-` which alternates between `TT+` and `TT-` on each press. + +### Analogs (controller/cab only) + +!!! tip "" + + With a controller rather than binding buttons to `TT+` and `TT-`, you need to: + + - Head to the `Analogs` tab at the top. + - In `Device`, pick your controller. + - In `Control`, pick whichever one corresponds to the turntable. + - Turn your turntable ensuring that the preview turns along with it. + - Click `OK`, leaving the rest of the settings alone. + +### Lights (controller/cab only) + +!!! tip "" + + Your controller might support having its lights controlled by the game through bemanitools. + + If it does, here's how you may link different actions to your lights: + + - In `Device`, pick your controller. + - In `Game Light`, select the corresponding button that will be used for that light. + - Repeat for your other lights. + +### Configuring Bemanitools for a network + +!!! tip "Head over to the `Network` tab" + +!!! tip "" + Now we will set up our PIN pad and card. + + - Click on `Keyboard device` + - You may or may not have more than one option. To figure out which one is your actual keyboard, select a device inside that list and press a button on the numpad. + - Once you have found your correct device, the `Keyboard status` will change **(the number and location of the number does not matter, it only matters that it changed)**. + - Grab your card, create a :material-file-document-edit:`.txt` and name it however you like. In this example it's called :material-file-document-edit:`card.txt` + - Place the file in a location that is easily accessible and you won't forget. In this case it's in a seperate folder. + +!!! info "If you don't have a numpad, make sure to tick `Use top keyboard row for PIN pad input`. This will also change the `Card In` button to `Backspace`" + + + +## Connecting to a network + +!!! tip "" + + - Locate your :material-file-code:`iidxhook-11.conf` + + - Open it with your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) + + - Replace the `eamuse.server=localhost:80` with your desired network URL + + - Replace `eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX` **and** `eamuse.eamid=XXXXXXXXXXXXXXXXXXXX` with your PCBID of your network of choice. + + ``` + # URL (e.g. http://my.eamuse.server:80/whatever) or IPV4 (e.g. 127.0.0.1:80) of the target eamuse server. The port is optional but defaults to 80. + eamuse.server=localhost:80 + + # PCBID + eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX + + # EAMID + eamuse.eamid=XXXXXXXXXXXXXXXXXXXX + ``` + +## Game resolution and locking FPS + +!!! tip "" + We'd like to mention that there are two options when it comes to how the game renders. You can choose between `Linear` and `Point`. + + Below is an example of how both look like. + + ??? info "Linear" + + + ??? info "Point" + + + It comes down to your own prefrence what you decide on, `Linear` is less sharp but doesn't have pixel perfect edges. `Point` is sharp and is pixel perfect. + +!!! tip "" + Next up, we'll setup borderless window and configure the proper resolution. We're using a `1920x1080` monitor so we will use that. + + Repeat the previous step and open your :material-file-code:`iidxhook-11.conf`. We want to find these lines: + + ``` + # Software limit the frame rate of the rendering loop in hz, e.g. 60 or 59.95 (0.0 = no software limit) + gfx.frame_rate_limit=0.0 + + # Run the game windowed + gfx.windowed=false + + # Windowed width, 0 for default size + gfx.window_width=0 + + # Windowed height, 0 for default size + gfx.window_height=0 + + # Up-/downscale the back buffer's width. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding height parameter. + gfx.scale_back_buffer_width=0 + + # Up-/downscale the back buffer's height. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding width parameter. + gfx.scale_back_buffer_height=0 + + # Filter type to use for up-/downscaling the back buffer. Only used if scaling feature was enabled by setting the scaling width and height parameters. Available types: none, linear, point (refer to D3DTEXTUREFILTERTYPE for explanation). + gfx.scale_back_buffer_filter=none + ``` + + If you can't seem to find them, press `CTRL` + `F` and search for `gfx.frame_rate_limit=0.0`. This will bring you to the first line we want to edit. + +!!! tip "" + Listed below are the values we want to change them to. + + ``` + gfx.frame_rate_limit=59.95 + gfx.windowed=true + gfx.window_width=1920 + gfx.window_height=1080 + gfx.scale_back_buffer_width=1920 + gfx.scale_back_buffer_height=1080 + gfx.scale_back_buffer_filter=point + ``` + Unless you'd like to have the game properly windowed you can safely ignore `gfx.framed=false`. + + Make sure to decide on whether you want `Linear` or `Point` rendering. + + ``` + gfx.scale_back_buffer_filter=linear + gfx.scale_back_buffer_filter=point + ``` + +## First launch + +!!! danger "If you have any issues running the game, refer to the [Troubleshooting](troubleshooting.md) page" + +### BACKUP DATA + +!!! 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 :material-file:`gamestart.bat`. + + If it's your first time running the game, you'll immediately be greeted with this screen. + + + + + +!!! tip "" + Press your `Start` key to confirm to get to the next error message. + +### CLOCK ERROR + + + +!!! tip "" + Press your `Start` key to confirm. This will bring you into it's service menu. + + + +!!! tip "" + 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. + + Navigate to `CLOCK`. You do not need to manually change it. Navigate to `SAVE AND EXIT`. + + + +### Enabling e-AMUSEMENT for Online Play + +!!! tip "" + From the service menu, go to `NETWORK OPTIONS` then `e-AMUSEMENT SETTINGS`. + + + + + +!!! tip "" + It'll bring you to this screen, change it so that `e-AMUSEMENT` switches to `ON` and it will look like this: + + + + + +!!! tip "" + We will need to set a `SHOP NAME SETTING` and change our `PREFECTURE` otherwise the game will throw errors at us. + + + +!!! tip "" + + - Name your shop to whatever you'd like. Instructions on how to navigate are at the bottom of the screen. + - Navigate to `EXIT` and select it. + - Change your prefecture once or how many times you'd like, it doesn't matter as long as it's not the default one. + + + +!!! tip "" + Select `SAVE AND EXIT`. The game will now give you a message, which translated means: + + `e-AMUSEMENT settings have been changed. Please turn the power off and on again.` + + So, close the game and open it again. + + + +## Final Notes + +!!! success "You're all done! Make sure to insert two credits by pressing your `SERVICE` key. Have fun!" + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section. diff --git a/docs/games/konami/iidx/11_red/troubleshooting.md b/docs/games/konami/iidx/11_red/troubleshooting.md new file mode 100644 index 0000000..48ada5f --- /dev/null +++ b/docs/games/konami/iidx/11_red/troubleshooting.md @@ -0,0 +1,62 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### My Game Is Running Crazy Fast! + +!!! tip "" + The most common reason for this is the game is running over its required 59.95hz, the game is hardcoded to run at 59.95hz and this cannot be changed. To solve this, check [Game resolution and locking FPS](setup.md#game-resolution-and-locking-fps) of the guide again. + +### I'm getting "NETWORK WARNING" instead of "NETWORK OK" + +!!! tip "" + This can be caused by: + + - Invalid PCBID + - Firewall blocking connections + - Invalid eamuse url or port specified + - Game is not run using the Administrator account + +### My background videos aren't working! + +!!! tip "" + + You need to install a codec. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate to :material-folder:`\iidx.zip\iidx\misc\` where :material-file:`CLVSD.ax` is located. + + - Extract :material-file:`CLVSD.ax` inside a :material-folder: folder that you know won't be moved or renamed. + + - Open the :material-console:command prompt as ***administrator***. Now type `regsvr32 "\CLVSD.ax"` into the command prompt. + + As an example, it could look like this: `regsvr32 "D:\BEMANI\IIDX\CLVSD.ax"` + + A prompt should appear telling you that it has been installed successfully. + This applies for all styles that require this codec, not just **IIDX RED**. + + If an error occurs, you didn't run the command prompt as administrator or you messed up the location of the file. + +!!! danger "You **can not** move or delete :material-file:`CLVSD.ax` **at all**, otherwise it will revert the changes and you have to install it again" + +### My game crashes immediately! + +!!! warning "This can have multiple reasons. These fixes shouldn't be needed for IIDX RED since we're addressing them in the guide. We'll add them anyway just in case" + +#### Fix #1 (Wrong data structure) + +!!! tip "" + Make sure that your unpacked data looks like this: + + - JAx (Game binary revision folder where 'x' can be A, B, C, D, E, F, G) + - data + - sidcode.txt + + Any other files are optional and don't have to be removed as these are not required to run the game. + +#### Fix #2 (RtEffects.dll didn't get replaced) + +!!! tip "" + Refer to [Using iidxhook-11.conf & RtEffect.dll](setup.md#using-iidxhook-11conf-rteffectdll) again and check if you have followed all the instructions explained in it. \ No newline at end of file diff --git a/docs/games/konami/iidx/12_happysky/setup.md b/docs/games/konami/iidx/12_happysky/setup.md new file mode 100644 index 0000000..2f8d8f0 --- /dev/null +++ b/docs/games/konami/iidx/12_happysky/setup.md @@ -0,0 +1,308 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Preparing data + +!!! tip "" + + After downloading and extracting your data, we need to make sure your files aren't set to `Read-only`. + + - Right click the folder containing your data, then click on `Properties`. + - In the `General` tab go down to `Attributes`, untick `Read-only` and click `Apply`. + - A popup will appear, select `Apply changes to this folder, subfolder and files` and press `OK`. + - Finally, click `OK` again to exit out of properties. + +## Installing Bemanitools + +!!! tip "" + + - Download :material-package-down:[Bemanitools](https://github.com/djhackersdev/bemanitools/releases/download/5.48/bemanitools-5.48.zip). + + - Inside :material-zip-box:`bemanitools-5.48.zip` locate :material-zip-box:`iidx-09-to-12.zip`. + + - Extract everything inside the folder that contains the :material-file:`bm2dx.exe` which is located in :material-folder:`\ECO\JAD`. + + Pictured below is what your folder should look like. We've removed any files not necessary for **HAPPY SKY**. + + + +### Using iidxhook-12.conf & RtEffect.dll + +!!! tip "" + + - Download the :material-package-down:[Bemanitools supplements](https://github.com/djhackersdev/bemanitools-supplement/releases/download/1.6/bemanitools-supplement-1.6.zip) + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate inside :material-zip-box:`misc.zip` + + - Inside :material-folder:`misc\d3d8to9`, extract :material-file-cog-outline:`d3d8.dll` to :material-folder:`\ECO\JAD`. + + This enables us to use the graphic options inside :material-file-code:`iidxhook-12.conf` which we will take advantage of. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate inside :material-zip-box:`iidx.zip` + + - Inside :material-folder:`iidx/misc`, extract :material-file-cog-outline:`RtEffect_stub.dll` to :material-folder:`\ECO\JAD`. + + - Delete the already existing :material-file-remove-outline:`RtEffect.dll` and rename :material-file-edit-outline:`RtEffect_stub.dll` to :material-file-cog-outline:`RtEffect.dll`. + + This will eliminate any immediate crashes relating to needing specific old hardware. + +### Installing CLVSD.ax + +!!! tip "" + + We need to install a codec so that background videos will work and won't cause an error. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate to :material-folder:`\iidx.zip\iidx\misc\` where :material-file:`CLVSD.ax` is located. + + - Extract :material-file:`CLVSD.ax` inside a :material-folder: folder that you know won't be moved or renamed. + + - Open the :material-console:command prompt as ***administrator***. Now type `regsvr32 "\CLVSD.ax"` into the command prompt. + + As an example, it could look like this: `regsvr32 "D:\BEMANI\IIDX\CLVSD.ax"` + + A prompt should appear telling you that it has been installed successfully. + This applies for all styles that require this codec, not just **HAPPY SKY**. + + If an error occurs, you didn't run the command prompt as administrator or you messed up the location of the file. + +!!! danger "You **can not** move or delete :material-file:`CLVSD.ax` **at all**, otherwise it will revert the changes and you have to install it again" + +## Configuring Bemanitools + +!!! info "To configure your keybinds, open your :material-file:`config.bat` file" + +### Buttons + +!!! tip "" + + Double click on the right on a button that you wish to bind, then press the key you want associated with the action. + + With your controller and/or keyboard plugged in, configure your keys for: + + - **Maintenance**: `Service, Test` + - **P1 Game buttons**: `1 to 7, Start, EFFECT, VEFX` + - **P1 Keypad**: `Keypad Insert Card` + + **Only if** you're playing using a keyboard: + + - **Turntable**: `TT+, TT-` **and optionally** `TT+/-` which alternates between `TT+` and `TT-` on each press. + +### Analogs (controller/cab only) + +!!! tip "" + + With a controller rather than binding buttons to `TT+` and `TT-`, you need to: + + - Head to the `Analogs` tab at the top. + - In `Device`, pick your controller. + - In `Control`, pick whichever one corresponds to the turntable. + - Turn your turntable ensuring that the preview turns along with it. + - Click `OK`, leaving the rest of the settings alone. + +### Lights (controller/cab only) + +!!! tip "" + + Your controller might support having its lights controlled by the game through bemanitools. + + If it does, here's how you may link different actions to your lights: + + - In `Device`, pick your controller. + - In `Game Light`, select the corresponding button that will be used for that light. + - Repeat for your other lights. + +### Configuring Bemanitools for a network + +!!! tip "Head over to the `Network` tab" + +!!! tip "" + Now we will set up our PIN pad and card. + + - Click on `Keyboard device` + - You may or may not have more than one option. To figure out which one is your actual keyboard, select a device inside that list and press a button on the numpad. + - Once you have found your correct device, the `Keyboard status` will change **(the number and location of the number does not matter, it only matters that it changed)**. + - Grab your card, create a :material-file-document-edit:`.txt` and name it however you like. In this example it's called :material-file-document-edit:`card.txt` + - Place the file in a location that is easily accessible and you won't forget. In this case it's in a seperate folder. + +!!! info "If you don't have a numpad, make sure to tick `Use top keyboard row for PIN pad input`. This will also change the `Card In` button to `Backspace`" + + + +## Connecting to a network + +!!! tip "" + + - Locate your :material-file-code:`iidxhook-12.conf` + + - Open it with your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) + + - Replace the `eamuse.server=localhost:80` with your desired network URL + + - Replace `eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX` **and** `eamuse.eamid=XXXXXXXXXXXXXXXXXXXX` with your PCBID of your network of choice. + + ``` + # URL (e.g. http://my.eamuse.server:80/whatever) or IPV4 (e.g. 127.0.0.1:80) of the target eamuse server. The port is optional but defaults to 80. + eamuse.server=localhost:80 + + # PCBID + eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX + + # EAMID + eamuse.eamid=XXXXXXXXXXXXXXXXXXXX + ``` + +## Game resolution and locking FPS + +!!! tip "" + We'd like to mention that there are two options when it comes to how the game renders. You can choose between `Linear` and `Point`. + + Below is an example of how both look like. + + ??? info "Linear" + + + ??? info "Point" + + + It comes down to your own prefrence what you decide on, `Linear` is less sharp but doesn't have pixel perfect edges. `Point` is sharp and is pixel perfect. + +!!! tip "" + Next up, we'll setup borderless window and configure the proper resolution. We're using a `1920x1080` monitor so we will use that. + + Repeat the previous step and open your :material-file-code:`iidxhook-12.conf`. We want to find these lines: + + ``` + # Software limit the frame rate of the rendering loop in hz, e.g. 60 or 59.95 (0.0 = no software limit) + gfx.frame_rate_limit=0.0 + + # Run the game windowed + gfx.windowed=false + + # Windowed width, 0 for default size + gfx.window_width=0 + + # Windowed height, 0 for default size + gfx.window_height=0 + + # Up-/downscale the back buffer's width. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding height parameter. + gfx.scale_back_buffer_width=0 + + # Up-/downscale the back buffer's height. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding width parameter. + gfx.scale_back_buffer_height=0 + + # Filter type to use for up-/downscaling the back buffer. Only used if scaling feature was enabled by setting the scaling width and height parameters. Available types: none, linear, point (refer to D3DTEXTUREFILTERTYPE for explanation). + gfx.scale_back_buffer_filter=none + ``` + + If you can't seem to find them, press `CTRL` + `F` and search for `gfx.frame_rate_limit=0.0`. This will bring you to the first line we want to edit. + +!!! tip "" + Listed below are the values we want to change them to. + + ``` + gfx.frame_rate_limit=59.95 + gfx.windowed=true + gfx.window_width=1920 + gfx.window_height=1080 + gfx.scale_back_buffer_width=1920 + gfx.scale_back_buffer_height=1080 + gfx.scale_back_buffer_filter=point + ``` + Unless you'd like to have the game properly windowed you can safely ignore `gfx.framed=false`. + + Make sure to decide on whether you want `Linear` or `Point` rendering. + + ``` + gfx.scale_back_buffer_filter=linear + gfx.scale_back_buffer_filter=point + ``` + +## First launch + +!!! danger "If you have any issues running the game, refer to the [Troubleshooting](troubleshooting.md) page" + +### BACKUP DATA + +!!! 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 :material-file:`gamestart.bat`. + + If it's your first time running the game, you'll immediately be greeted with this screen. + + + + + +!!! tip "" + Press your `Start` key to confirm to get to the next error message. + +### CLOCK ERROR + + + +!!! tip "" + Press your `Start` key to confirm. This will bring you into it's service menu. + + + +!!! tip "" + 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. + + Navigate to `CLOCK`. You do not need to manually change it. Navigate to `SAVE AND EXIT`. + + + +### Enabling e-AMUSEMENT for Online Play + +!!! tip "" + From the service menu, go to `NETWORK OPTIONS` then `e-AMUSEMENT SETTINGS`. + + + + + +!!! tip "" + It'll bring you to this screen, change it so that `e-AMUSEMENT` switches to `ON` and it will look like this: + + + + + +!!! tip "" + We will need to set a `SHOP NAME SETTING` and change our `PREFECTURE` otherwise the game will throw errors at us. + + + +!!! tip "" + + - Name your shop to whatever you'd like. Instructions on how to navigate are at the bottom of the screen. + - Navigate to `EXIT` and select it. + - Change your prefecture once or how many times you'd like, it doesn't matter as long as it's not the default one. + + + +!!! tip "" + Select `SAVE AND EXIT`. The game will now give you a message, which translated means: + + `e-AMUSEMENT settings have been changed. Please turn the power off and on again.` + + So, close the game and open it again. + + + +## Final Notes + +!!! success "You're all done! Make sure to insert two credits by pressing your `SERVICE` key. Have fun!" + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section. + diff --git a/docs/games/konami/iidx/12_happysky/troubleshooting.md b/docs/games/konami/iidx/12_happysky/troubleshooting.md new file mode 100644 index 0000000..6cce1f8 --- /dev/null +++ b/docs/games/konami/iidx/12_happysky/troubleshooting.md @@ -0,0 +1,62 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### My Game Is Running Crazy Fast! + +!!! tip "" + The most common reason for this is the game is running over its required 59.95hz, the game is hardcoded to run at 59.95hz and this cannot be changed. To solve this, check [Game resolution and locking FPS](setup.md#game-resolution-and-locking-fps) of the guide again. + +### I'm getting "NETWORK WARNING" instead of "NETWORK OK" + +!!! tip "" + This can be caused by: + + - Invalid PCBID + - Firewall blocking connections + - Invalid eamuse url or port specified + - Game is not run using the Administrator account + +### My background videos aren't working! + +!!! tip "" + + You need to install a codec. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate to :material-folder:`\iidx.zip\iidx\misc\` where :material-file:`CLVSD.ax` is located. + + - Extract :material-file:`CLVSD.ax` inside a :material-folder: folder that you know won't be moved or renamed. + + - Open the :material-console:command prompt as ***administrator***. Now type `regsvr32 "\CLVSD.ax"` into the command prompt. + + As an example, it could look like this: `regsvr32 "D:\BEMANI\IIDX\CLVSD.ax"` + + A prompt should appear telling you that it has been installed successfully. + This applies for all styles that require this codec, not just **HAPPY SKY**. + + If an error occurs, you didn't run the command prompt as administrator or you messed up the location of the file. + +!!! danger "You **can not** move or delete :material-file:`CLVSD.ax` **at all**, otherwise it will revert the changes and you have to install it again" + +### My game crashes immediately! + +!!! warning "This can have multiple reasons. These fixes shouldn't be needed for HAPPY SKY since we're addressing them in the guide. We'll add them anyway just in case" + +#### Fix #1 (Wrong data structure) + +!!! tip "" + Make sure that your unpacked data looks like this: + + - JAx (Game binary revision folder where 'x' can be A, B, C, D, E, F, G) + - data + - sidcode.txt + + Any other files are optional and don't have to be removed as these are not required to run the game. + +#### Fix #2 (RtEffects.dll didn't get replaced) + +!!! tip "" + Refer to [Using iidxhook-12.conf & RtEffect.dll](setup.md#using-iidxhook-12conf-rteffectdll) again and check if you have followed all the instructions explained in it. \ No newline at end of file diff --git a/docs/games/konami/iidx/13_distorted/setup.md b/docs/games/konami/iidx/13_distorted/setup.md new file mode 100644 index 0000000..e8c65f8 --- /dev/null +++ b/docs/games/konami/iidx/13_distorted/setup.md @@ -0,0 +1,307 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Preparing data + +!!! tip "" + + After downloading and extracting your data, we need to make sure your files aren't set to `Read-only`. + + - Right click the folder containing your data, then click on `Properties`. + - In the `General` tab go down to `Attributes`, untick `Read-only` and click `Apply`. + - A popup will appear, select `Apply changes to this folder, subfolder and files` and press `OK`. + - Finally, click `OK` again to exit out of properties. + +## Installing Bemanitools + +!!! tip "" + + - Download :material-package-down:[Bemanitools](https://github.com/djhackersdev/bemanitools/releases/download/5.48/bemanitools-5.48.zip). + + - Inside :material-zip-box:`bemanitools-5.48.zip` locate :material-zip-box:`iidx-13.zip`. + + - Extract everything inside the folder that contains the :material-file:`bm2dx.exe` which is located in :material-folder:`\FDD\JAG`. + + Pictured below is what your folder should look like. We've removed any files not necessary for **DistorteD**. + + + +### Using iidxhook-13.conf & RtEffect.dll + +!!! tip "" + + - Download the :material-package-down:[Bemanitools supplements](https://github.com/djhackersdev/bemanitools-supplement/releases/download/1.6/bemanitools-supplement-1.6.zip) + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate inside :material-zip-box:`misc.zip` + + - Inside :material-folder:`misc\d3d8to9`, extract :material-file-cog-outline:`d3d8.dll` to :material-folder:`\FDD\JAG`. + + This enables us to use the graphic options inside :material-file-code:`iidxhook-13.conf` which we will take advantage of. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate inside :material-zip-box:`iidx.zip` + + - Inside :material-folder:`iidx/misc`, extract :material-file-cog-outline:`RtEffect_stub.dll` to :material-folder:`\FDD\JAG`. + + - Delete the already existing :material-file-remove-outline:`RtEffect.dll` and rename :material-file-edit-outline:`RtEffect_stub.dll` to :material-file-cog-outline:`RtEffect.dll`. + + This will eliminate any immediate crashes relating to needing specific old hardware. + +### Installing CLVSD.ax + +!!! tip "" + + We need to install a codec so that background videos will work and won't cause an error. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate to :material-folder:`\iidx.zip\iidx\misc\` where :material-file:`CLVSD.ax` is located. + + - Extract :material-file:`CLVSD.ax` inside a :material-folder: folder that you know won't be moved or renamed. + + - Open the :material-console:command prompt as ***administrator***. Now type `regsvr32 "\CLVSD.ax"` into the command prompt. + + As an example, it could look like this: `regsvr32 "D:\BEMANI\IIDX\CLVSD.ax"` + + A prompt should appear telling you that it has been installed successfully. + This applies for all styles that require this codec, not just **DistorteD**. + + If an error occurs, you didn't run the command prompt as administrator or you messed up the location of the file. + +!!! danger "You **can not** move or delete :material-file:`CLVSD.ax` **at all**, otherwise it will revert the changes and you have to install it again" + +## Configuring Bemanitools + +!!! info "To configure your keybinds, open your :material-file:`config.bat` file" + +### Buttons + +!!! tip "" + + Double click on the right on a button that you wish to bind, then press the key you want associated with the action. + + With your controller and/or keyboard plugged in, configure your keys for: + + - **Maintenance**: `Service, Test` + - **P1 Game buttons**: `1 to 7, Start, EFFECT, VEFX` + - **P1 Keypad**: `Keypad Insert Card` + + **Only if** you're playing using a keyboard: + + - **Turntable**: `TT+, TT-` **and optionally** `TT+/-` which alternates between `TT+` and `TT-` on each press. + +### Analogs (controller/cab only) + +!!! tip "" + + With a controller rather than binding buttons to `TT+` and `TT-`, you need to: + + - Head to the `Analogs` tab at the top. + - In `Device`, pick your controller. + - In `Control`, pick whichever one corresponds to the turntable. + - Turn your turntable ensuring that the preview turns along with it. + - Click `OK`, leaving the rest of the settings alone. + +### Lights (controller/cab only) + +!!! tip "" + + Your controller might support having its lights controlled by the game through bemanitools. + + If it does, here's how you may link different actions to your lights: + + - In `Device`, pick your controller. + - In `Game Light`, select the corresponding button that will be used for that light. + - Repeat for your other lights. + +### Configuring Bemanitools for a network + +!!! tip "Head over to the `Network` tab" + +!!! tip "" + Now we will set up our PIN pad and card. + + - Click on `Keyboard device` + - You may or may not have more than one option. To figure out which one is your actual keyboard, select a device inside that list and press a button on the numpad. + - Once you have found your correct device, the `Keyboard status` will change **(the number and location of the number does not matter, it only matters that it changed)**. + - Grab your card, create a :material-file-document-edit:`.txt` and name it however you like. In this example it's called :material-file-document-edit:`card.txt` + - Place the file in a location that is easily accessible and you won't forget. In this case it's in a seperate folder. + +!!! info "If you don't have a numpad, make sure to tick `Use top keyboard row for PIN pad input`. This will also change the `Card In` button to `Backspace`" + + + +## Connecting to a network + +!!! tip "" + + - Locate your :material-file-code:`iidxhook-13.conf` + + - Open it with your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) + + - Replace the `eamuse.server=localhost:80` with your desired network URL + + - Replace `eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX` **and** `eamuse.eamid=XXXXXXXXXXXXXXXXXXXX` with your PCBID of your network of choice. + + ``` + # URL (e.g. http://my.eamuse.server:80/whatever) or IPV4 (e.g. 127.0.0.1:80) of the target eamuse server. The port is optional but defaults to 80. + eamuse.server=localhost:80 + + # PCBID + eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX + + # EAMID + eamuse.eamid=XXXXXXXXXXXXXXXXXXXX + ``` + +## Game resolution and locking FPS + +!!! tip "" + We'd like to mention that there are two options when it comes to how the game renders. You can choose between `Linear` and `Point`. + + Below is an example of how both look like. + + ??? info "Linear" + + + ??? info "Point" + + + It comes down to your own prefrence what you decide on, `Linear` is less sharp but doesn't have pixel perfect edges. `Point` is sharp and is pixel perfect. + +!!! tip "" + Next up, we'll setup borderless window and configure the proper resolution. We're using a `1920x1080` monitor so we will use that. + + Repeat the previous step and open your :material-file-code:`iidxhook-12.conf`. We want to find these lines: + + ``` + # Software limit the frame rate of the rendering loop in hz, e.g. 60 or 59.95 (0.0 = no software limit) + gfx.frame_rate_limit=0.0 + + # Run the game windowed + gfx.windowed=false + + # Windowed width, 0 for default size + gfx.window_width=0 + + # Windowed height, 0 for default size + gfx.window_height=0 + + # Up-/downscale the back buffer's width. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding height parameter. + gfx.scale_back_buffer_width=0 + + # Up-/downscale the back buffer's height. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding width parameter. + gfx.scale_back_buffer_height=0 + + # Filter type to use for up-/downscaling the back buffer. Only used if scaling feature was enabled by setting the scaling width and height parameters. Available types: none, linear, point (refer to D3DTEXTUREFILTERTYPE for explanation). + gfx.scale_back_buffer_filter=none + ``` + + If you can't seem to find them, press `CTRL` + `F` and search for `gfx.frame_rate_limit=0.0`. This will bring you to the first line we want to edit. + +!!! tip "" + Listed below are the values we want to change them to. + + ``` + gfx.frame_rate_limit=59.95 + gfx.windowed=true + gfx.window_width=1920 + gfx.window_height=1080 + gfx.scale_back_buffer_width=1920 + gfx.scale_back_buffer_height=1080 + gfx.scale_back_buffer_filter=linear + ``` + Unless you'd like to have the game properly windowed you can safely ignore `gfx.framed=false`. + + Make sure to decide on whether you want `Linear` or `Point` rendering. + + ``` + gfx.scale_back_buffer_filter=linear + gfx.scale_back_buffer_filter=point + ``` + +## First launch + +!!! danger "If you have any issues running the game, refer to the [Troubleshooting](troubleshooting.md) page" + +### BACKUP DATA + +!!! 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 :material-file:`gamestart.bat`. + + If it's your first time running the game, you'll immediately be greeted with this screen. + + + + + +!!! tip "" + Press your `Test` key to confirm to get to the next error message. + +### CLOCK ERROR + + + +!!! tip "" + Press your `Test` key to confirm. This will bring you into it's service menu. + + + +!!! tip "" + 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. + + Navigate to `CLOCK`. You do not need to manually change it. Navigate to `SAVE AND EXIT`. + + + +### Enabling e-AMUSEMENT for Online Play + +!!! tip "" + From the service menu, go to `NETWORK OPTIONS` then `e-AMUSEMENT SETTINGS`. + + + + + +!!! tip "" + It'll bring you to this screen, change it so that `e-AMUSEMENT` switches to `ON` and it will look like this: + + + + + +!!! tip "" + We will need to set a `SHOP NAME SETTING` and change our `PREFECTURE` otherwise the game will throw errors at us. + + + +!!! tip "" + + - Name your shop to whatever you'd like. Instructions on how to navigate are at the bottom of the screen. + - Navigate to `EXIT` and select it. + - Change your prefecture once or how many times you'd like, it doesn't matter as long as it's not the default one. + + + +!!! tip "" + Select `SAVE AND EXIT`. The game will now give you a message, which translated means: + + `e-AMUSEMENT settings have been changed. Please turn the power off and on again.` + + So, close the game and open it again. + + + +## Final Notes + +!!! success "You're all done! Make sure to insert two credits by pressing your `SERVICE` key. Have fun!" + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section. diff --git a/docs/games/konami/iidx/13_distorted/troubleshooting.md b/docs/games/konami/iidx/13_distorted/troubleshooting.md new file mode 100644 index 0000000..7866cc7 --- /dev/null +++ b/docs/games/konami/iidx/13_distorted/troubleshooting.md @@ -0,0 +1,62 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### My Game Is Running Crazy Fast! + +!!! tip "" + The most common reason for this is the game is running over its required 59.95hz, the game is hardcoded to run at 59.95hz and this cannot be changed. To solve this, check [Game resolution and locking FPS](setup.md#game-resolution-and-locking-fps) of the guide again. + +### I'm getting "NETWORK WARNING" instead of "NETWORK OK" + +!!! tip "" + This can be caused by: + + - Invalid PCBID + - Firewall blocking connections + - Invalid eamuse url or port specified + - Game is not run using the Administrator account + +### My background videos aren't working! + +!!! tip "" + + You need to install a codec. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate to :material-folder:`\iidx.zip\iidx\misc\` where :material-file:`CLVSD.ax` is located. + + - Extract :material-file:`CLVSD.ax` inside a :material-folder: folder that you know won't be moved or renamed. + + - Open the :material-console:command prompt as ***administrator***. Now type `regsvr32 "\CLVSD.ax"` into the command prompt. + + As an example, it could look like this: `regsvr32 "D:\BEMANI\IIDX\CLVSD.ax"` + + A prompt should appear telling you that it has been installed successfully. + This applies for all styles that require this codec, not just **DistorteD**. + + If an error occurs, you didn't run the command prompt as administrator or you messed up the location of the file. + +!!! danger "You **can not** move or delete :material-file:`CLVSD.ax` **at all**, otherwise it will revert the changes and you have to install it again" + +### My game crashes immediately! + +!!! warning "This can have multiple reasons. These fixes shouldn't be needed for DistorteD since we're addressing them in the guide. We'll add them anyway just in case" + +#### Fix #1 (Wrong data structure) + +!!! tip "" + Make sure that your unpacked data looks like this: + + - JAx (Game binary revision folder where 'x' can be A, B, C, D, E, F, G) + - data + - sidcode.txt + + Any other files are optional and don't have to be removed as these are not required to run the game. + +#### Fix #2 (RtEffects.dll didn't get replaced) + +!!! tip "" + Refer to [Using iidxhook-13.conf & RtEffect.dll](setup.md#using-iidxhook-13conf-rteffectdll) again and check if you have followed all the instructions explained in it. \ No newline at end of file diff --git a/docs/games/konami/iidx/14_gold/setup.md b/docs/games/konami/iidx/14_gold/setup.md new file mode 100644 index 0000000..80712d4 --- /dev/null +++ b/docs/games/konami/iidx/14_gold/setup.md @@ -0,0 +1,297 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Preparing data + +!!! tip "" + + After downloading and extracting your data, we need to make sure your files aren't set to `Read-only`. + + - Right click the folder containing your data, then click on `Properties`. + - In the `General` tab go down to `Attributes`, untick `Read-only` and click `Apply`. + - A popup will appear, select `Apply changes to this folder, subfolder and files` and press `OK`. + - Finally, click `OK` again to exit out of properties. + +## Installing Bemanitools + +!!! tip "" + + - Download :material-package-down:[Bemanitools](https://github.com/djhackersdev/bemanitools/releases/download/5.48/bemanitools-5.48.zip). + + - Inside :material-zip-box:`bemanitools-5.48.zip` locate :material-zip-box:`iidx-14-to-17.zip`. + + - Extract everything inside the folder that contains the :material-file:`bm2dx.exe` which is located in :material-folder:`\GLD\2007072301`. + + Pictured below is what your folder should look like. We've removed any files not necessary for **GOLD**. + + + +### Using iidxhook-14.conf + +!!! tip "" + + - Download the :material-package-down:[Bemanitools supplements](https://github.com/djhackersdev/bemanitools-supplement/releases/download/1.6/bemanitools-supplement-1.6.zip) + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate inside :material-zip-box:`misc.zip` + + - Inside :material-folder:`misc\d3d8to9`, extract :material-file-cog-outline:`d3d8.dll` to :material-folder:`\GLD\2007072301`. + + This enables us to use the graphic options inside :material-file-code:`iidxhook-14.conf` which we will take advantage of. + +### Installing CLVSD.ax + +!!! tip "" + + We need to install a codec so that background videos will work and won't cause an error. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate to :material-folder:`\iidx.zip\iidx\misc\` where :material-file:`CLVSD.ax` is located. + + - Extract :material-file:`CLVSD.ax` inside a :material-folder: folder that you know won't be moved or renamed. + + - Open the :material-console:command prompt as ***administrator***. Now type `regsvr32 "\CLVSD.ax"` into the command prompt. + + As an example, it could look like this: `regsvr32 "D:\BEMANI\IIDX\CLVSD.ax"` + + A prompt should appear telling you that it has been installed successfully. + This applies for all styles that require this codec, not just **GOLD**. + + If an error occurs, you didn't run the command prompt as administrator or you messed up the location of the file. + +!!! danger "You **can not** move or delete :material-file:`CLVSD.ax` **at all**, otherwise it will revert the changes and you have to install it again" + +## Configuring Bemanitools + +!!! info "To configure your keybinds, open your :material-file:`config.bat` file" + +### Buttons + +!!! tip "" + + Double click on the right on a button that you wish to bind, then press the key you want associated with the action. + + With your controller and/or keyboard plugged in, configure your keys for: + + - **Maintenance**: `Service, Test` + - **P1 Game buttons**: `1 to 7, Start, EFFECT, VEFX` + - **P1 Keypad**: `Keypad Insert Card` + + **Only if** you're playing using a keyboard: + + - **Turntable**: `TT+, TT-` **and optionally** `TT+/-` which alternates between `TT+` and `TT-` on each press. + +### Analogs (controller/cab only) + +!!! tip "" + + With a controller rather than binding buttons to `TT+` and `TT-`, you need to: + + - Head to the `Analogs` tab at the top. + - In `Device`, pick your controller. + - In `Control`, pick whichever one corresponds to the turntable. + - Turn your turntable ensuring that the preview turns along with it. + - Click `OK`, leaving the rest of the settings alone. + +### Lights (controller/cab only) + +!!! tip "" + + Your controller might support having its lights controlled by the game through bemanitools. + + If it does, here's how you may link different actions to your lights: + + - In `Device`, pick your controller. + - In `Game Light`, select the corresponding button that will be used for that light. + - Repeat for your other lights. + +### Configuring Bemanitools for a network + +!!! tip "Head over to the `Network` tab" + +!!! tip "" + Now we will set up our PIN pad and card. + + - Click on `Keyboard device` + - You may or may not have more than one option. To figure out which one is your actual keyboard, select a device inside that list and press a button on the numpad. + - Once you have found your correct device, the `Keyboard status` will change **(the number and location of the number does not matter, it only matters that it changed)**. + - Grab your card, create a :material-file-document-edit:`.txt` and name it however you like. In this example it's called :material-file-document-edit:`card.txt` + - Place the file in a location that is easily accessible and you won't forget. In this case it's in a seperate folder. + +!!! info "If you don't have a numpad, make sure to tick `Use top keyboard row for PIN pad input`. This will also change the `Card In` button to `Backspace`" + + + +## Connecting to a network + +!!! tip "" + + - Locate your :material-file-code:`iidxhook-14.conf` + + - Open it with your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) + + - Replace the `eamuse.server=localhost:80` with your desired network URL + + - Replace `eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX` **and** `eamuse.eamid=XXXXXXXXXXXXXXXXXXXX` with your PCBID of your network of choice. + + ``` + # URL (e.g. http://my.eamuse.server:80/whatever) or IPV4 (e.g. 127.0.0.1:80) of the target eamuse server. The port is optional but defaults to 80. + eamuse.server=localhost:80 + + # PCBID + eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX + + # EAMID + eamuse.eamid=XXXXXXXXXXXXXXXXXXXX + ``` + +## Game resolution and locking FPS + +!!! tip "" + We'd like to mention that there are two options when it comes to how the game renders. You can choose between `Linear` and `Point`. + + Below is an example of how both look like. + + ??? info "Linear" + + + ??? info "Point" + + + It comes down to your own prefrence what you decide on, `Linear` is less sharp but doesn't have pixel perfect edges. `Point` is sharp and is pixel perfect. + +!!! tip "" + Next up, we'll setup borderless window and configure the proper resolution. We're using a `1920x1080` monitor so we will use that. + + Repeat the previous step and open your :material-file-code:`iidxhook-14.conf`. We want to find these lines: + + ``` + # Software limit the frame rate of the rendering loop in hz, e.g. 60 or 59.95 (0.0 = no software limit) + gfx.frame_rate_limit=0.0 + + # Run the game windowed + gfx.windowed=false + + # Windowed width, 0 for default size + gfx.window_width=0 + + # Windowed height, 0 for default size + gfx.window_height=0 + + # Up-/downscale the back buffer's width. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding height parameter. + gfx.scale_back_buffer_width=0 + + # Up-/downscale the back buffer's height. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding width parameter. + gfx.scale_back_buffer_height=0 + + # Filter type to use for up-/downscaling the back buffer. Only used if scaling feature was enabled by setting the scaling width and height parameters. Available types: none, linear, point (refer to D3DTEXTUREFILTERTYPE for explanation). + gfx.scale_back_buffer_filter=none + ``` + + If you can't seem to find them, press `CTRL` + `F` and search for `gfx.frame_rate_limit=0.0`. This will bring you to the first line we want to edit. + +!!! tip "" + Listed below are the values we want to change them to. + + ``` + gfx.frame_rate_limit=59.95 + gfx.windowed=true + gfx.window_width=1920 + gfx.window_height=1080 + gfx.scale_back_buffer_width=1920 + gfx.scale_back_buffer_height=1080 + gfx.scale_back_buffer_filter=linear + ``` + Unless you'd like to have the game properly windowed you can safely ignore `gfx.framed=false`. + + Make sure to decide on whether you want `Linear` or `Point` rendering. + + ``` + gfx.scale_back_buffer_filter=linear + gfx.scale_back_buffer_filter=point + ``` + +## First launch + +!!! danger "If you have any issues running the game, refer to the [Troubleshooting](troubleshooting.md) page" + +### BACKUP DATA + +!!! 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 :material-file:`gamestart.bat`. + + If it's your first time running the game, you'll immediately be greeted with this screen. + + + +!!! warning "If you get `USB I/O ERROR ERROR(FM TRNS-OUT)` or `USB I/O ERROR ERROR(FM-DL TIMEOUT)`" + Reboot the game and it should get fixed. + + + +!!! tip "" + Press your `Test` key to confirm to get to the next error message. + +### CLOCK ERROR + + + +!!! tip "" + Press your `Test` key to confirm. The game will then perform a `MONITOR CHECK`. + + + + + +!!! tip "" + After the monitor check, the game will bring you into it's 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. + + Navigate to `CLOCK`. You do not need to manually change it. Navigate to `SAVE AND EXIT`. + + + +### Enabling e-AMUSEMENT for Online Play + +!!! tip "" + From the service menu, go to `NETWORK OPTIONS` then `e-AMUSEMENT SETTINGS`. + + + + + + + +!!! tip "" + We will need to set a `SHOP NAME SETTING` and change our `SETTING AREA` otherwise the game will throw errors at us. + + + +!!! tip "" + + - Name your shop to whatever you'd like. Instructions on how to navigate are at the bottom of the screen. + - Navigate to `EXIT` and select it. + - Change your `SETTING AREA` once or how many times you'd like, it doesn't matter as long as it's not the default one. + + + +!!! tip "" + Select `SAVE AND EXIT`. + + + +## Final Notes + +!!! success "You're all done! From the service menu select `GAMEMODE` and the game should load ready to be played. Make sure to insert two credits by pressing your `SERVICE` key. Have fun!" + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section. diff --git a/docs/games/konami/iidx/14_gold/troubleshooting.md b/docs/games/konami/iidx/14_gold/troubleshooting.md new file mode 100644 index 0000000..f6ae41c --- /dev/null +++ b/docs/games/konami/iidx/14_gold/troubleshooting.md @@ -0,0 +1,57 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### My Game Is Running Crazy Fast! + +!!! tip "" + The most common reason for this is the game is running over its required 59.95hz, the game is hardcoded to run at 59.95hz and this cannot be changed. To solve this, check [Game resolution and locking FPS](setup.md#game-resolution-and-locking-fps) of the guide again. + +### I'm getting "NETWORK WARNING" instead of "NETWORK OK" + +!!! tip "" + This can be caused by: + + - Invalid PCBID + - Firewall blocking connections + - Invalid eamuse url or port specified + - Game is not run using the Administrator account + +### My background videos aren't working! + +!!! tip "" + + You need to install a codec. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate to :material-folder:`\iidx.zip\iidx\misc\` where :material-file:`CLVSD.ax` is located. + + - Extract :material-file:`CLVSD.ax` inside a :material-folder: folder that you know won't be moved or renamed. + + - Open the :material-console:command prompt as ***administrator***. Now type `regsvr32 "\CLVSD.ax"` into the command prompt. + + As an example, it could look like this: `regsvr32 "D:\BEMANI\IIDX\CLVSD.ax"` + + A prompt should appear telling you that it has been installed successfully. + This applies for all styles that require this codec, not just **GOLD**. + + If an error occurs, you didn't run the command prompt as administrator or you messed up the location of the file. + +!!! danger "You **can not** move or delete :material-file:`CLVSD.ax` **at all**, otherwise it will revert the changes and you have to install it again" + +### My game crashes immediately! + +!!! warning "This can have multiple reasons. This fix shouldn't be needed for GOLD since we're addressing them in the guide. We'll add it anyway just in case" + +#### Wrong data structure + +!!! tip "" + Make sure that your unpacked data looks like this: + + - yyyymmddrr (y = year digit, m = month digit, d = day digit, r = revision digit) revision folder containing game binary and libraries + - data + - sidcode.txt + + Any other files are optional and don't have to be removed as these are not required to run the game. \ No newline at end of file diff --git a/docs/games/konami/iidx/16_empress/extras.md b/docs/games/konami/iidx/16_empress/extras.md new file mode 100644 index 0000000..189ce4d --- /dev/null +++ b/docs/games/konami/iidx/16_empress/extras.md @@ -0,0 +1,34 @@ + +# Extra Information + +## Output modes +!!! info "Output Mode" + + This game supports two output modes: `S-VIDEO` and `VGA`. + The difference between these two is: + + - `S-VIDEO` runs at 59.95hz + - `VGA` runs at 60.05hz + + By default, the output mode is set automatically by the game. + !!! tip "If for some reason you want to change the output mode of your game, do the following:" + Open your `iidxhook-xx.conf`. Find a line that says: + ``` + gfx.frame_rate_limit=xx.xx + ``` + + - Depending on the output mode of your choice, replace `xx.xx` with either 59.95 or 60.05 + + Now, in the service menu of your game: + + - Go to `GAME OPTIONS` + + + + - Go to the line that says `OUTPUT MODE` and change it to your desired mode + + - Select `SAVE AND EXIT` + + That's it! + + \ No newline at end of file diff --git a/docs/games/konami/iidx/16_empress/setup.md b/docs/games/konami/iidx/16_empress/setup.md new file mode 100644 index 0000000..8c80cb1 --- /dev/null +++ b/docs/games/konami/iidx/16_empress/setup.md @@ -0,0 +1,167 @@ + +# 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 **26 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: + + ``` + 📂yyyymmddrr (revision directory, y = year digit, m = month digit, d = day digit, r = revision digit) + 📂data + 📄sidcode.txt + ``` + +## Installing Bemanitools + +!!! tip "" + + - Download the latest Bemanitools release [here](https://github.com/djhackersdev/bemanitools/releases/latest) + + - Inside `bemanitools-x.xx.zip` locate `iidx-14-to-17.zip` + + - Extract all files from `iidx-14-to-17.zip` to your revision directory (yyyymmddrr) + +!!! note "You may delete the `gamestart-[14,15,17].bat` and `iidxhook-[14,15,17].conf` files as you only need the ones for 16 (Empress)" + +--8<-- "docs/snippets/konami/iidx/btools_d3d8to9.md" + +--8<-- "docs/snippets/konami/iidx/btools_clvsd.md" + +!!! tip "" + + In the end, here's what the expected data structure should look like: + + ``` hl_lines="2 3 4 7 8 10 11 12 13 14 18 19" + 📄bm2dx.exe + 📄config.bat + 📄config.exe + 📄d3d8.dll + 📄d3dx9_24.dll + 📄dbghelp.dll + 📄eamio.dll + 📄gamestart-16.bat + 📄gcidata.nsd + 📄geninput.dll + 📄iidxhook3.dll + 📄iidxhook-16.conf + 📄iidxio.dll + 📄inject.exe + 📄libacio.dll + 📄libavs-win32.dll + 📄libavs-win32-ea3.dll + 📄vefx.txt + 📄vefxio.dll + ``` + +## Configuring Bemanitools + +!!! info "Open the `config.bat` file. The following tabs correspond to the ones in the configuration window." + +=== "Buttons" + +--8<-- "docs/snippets/konami/iidx/btools_buttons.md" + +--8<-- "docs/snippets/konami/common/spicecfg_buttons_additionalinfo.md" + +=== "Lights" + +--8<-- "docs/snippets/konami/common/btools_lights.md" + +=== "Analogs" + +--8<-- "docs/snippets/konami/iidx/btools_analogs.md" + +=== "Network" + +--8<-- "docs/snippets/konami/common/btools_cards.md" + +## Connecting to a network + +--8<-- "docs/snippets/konami/iidx/btools_connecting_network.md" + +## Configuring graphics + +--8<-- "docs/snippets/konami/iidx/btools_graphics.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 `gamestart.bat` **as Administrator**. + + If it's your first time running the game, you'll soon be greeted with this screen. + + + + Press your `Test` key to initialize the backup data, a message will pop up stating it's been initialized. + + !!! warning "" + If right here you get `USB I/O ERROR ERROR(FM TRNS-OUT)` or `USB I/O ERROR ERROR(FM-DL TIMEOUT)` instead of the `BACKUP DATA ERROR`, reboot the game and it should get fixed. + + 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 `e-AMUSEMENT SETTINGS`. + + + + + 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 OPTIONS`. + + + + Here, you want to select a display type. + + !!! warning "This setting affects timing offset in the song." + + - `TYPE A`: No frame offset - Intended for CRT displays + - `TYPE B`: +1 frame offset - Intended for LCD displays + + We recommend starting with `TYPE B` and changing this later if you encounter any issues. + + - Go to `SAVE AND EXIT` then `GAME MODE` + +!!! success "You're all done! The game should load up properly now. Insert credits by pressing your `SERVICE` key!" + +## Help + +--8<-- "docs/snippets/common/help.md" + diff --git a/docs/games/konami/iidx/16_empress/troubleshooting.md b/docs/games/konami/iidx/16_empress/troubleshooting.md new file mode 100644 index 0000000..d28d791 --- /dev/null +++ b/docs/games/konami/iidx/16_empress/troubleshooting.md @@ -0,0 +1,45 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +!!! warning "If you get any error codes that weren't listed in the guides here, check out the [Bemanitools docs](https://github.com/djhackersdev/bemanitools/blob/master/doc/game-error-codes.md)" + +## Technical problems + +### Crashes + +!!! info "Riva Tuner Statistics Server (RTSS) and MSI Afterburner are known to cause odd crashes.
If you have them installed, close them both before starting any arcade game" + +??? tip "I'm using a laptop with a hybrid internal+dedicated GPU setup" + + Laptops often have odd issues running data. The game may open on the wrong monitor, run at the wrong resolution or framerate, or simply crashes. + + There is currently no known fix for this, other than maybe playing in windowed mode, or using a desktop PC instead. + +### Performance + +??? tip "Game is running too slow/fast" + + Your game is likely running at an incorrect framerate. The expected framerates is 59.95fps for S-VIDEO output mode, and 60.05fps for VGA output mode. + !!! info "For more information regarding output modes, check out the [Extra Information](extras.md) page" + Try these steps to resolve framerate issues: + + - Double-check that your selected output mode in the service menu matches the refresh rate in your `iidxhook-xx.conf` file. + - Close any software that can affect framerates (like RTSS) + - Close unnecessary background programs + - Ensure V-SYNC is not forcefully disabled in your graphics card control panel + + If issues persist: + + - Double-check that you followed all steps in the setup guide correctly + - Your data may be corrupt in one way or another, you could try starting from scratch using trusted data sources + +!!! info "For issues with desync, check out the [Bemanitools IIDX syncbook](https://github.com/djhackersdev/bemanitools/blob/master/doc/iidxhook/iidx-syncbook.md)" + +### Other + +??? tip "Background videos not working" + + The CLVSD codec is not registered. Follow the instructions in the [setup guide](setup.md#installing-bemanitools). + diff --git a/docs/games/konami/iidx/24_sinobuz/extras.md b/docs/games/konami/iidx/24_sinobuz/extras.md new file mode 100644 index 0000000..b440072 --- /dev/null +++ b/docs/games/konami/iidx/24_sinobuz/extras.md @@ -0,0 +1,49 @@ + +# Extra Information + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## More about ea3-config.xml + +!!! tip "" + + The `ea3-config.xml` file is located inside the `prop` folder. + + Below is an explanation on what different sections of this file do. + + The following lines change the PCBID and HARDID that your system reports to your e-amusement server. + There is ^^**no need to manually change this**^^ as `spice2x` will do it for us. + + ```xml + 00010203040506070809 + 00010203040506070809 + ``` + + The following line determines what version of the game you are running. + ^^**You should never change this**^^. It should always say `LDJ`. + + ```xml + LDJ + ``` + + ^^**You should never change this**^^. It should always say `A` for SINOBUZ. + + ```xml + A + ``` + + The following line determines your datecode. + ^^**Always keep it up to date**^^ with your game's current version. + + ```xml + 2017082800 + ``` + + The following line determine what remote service URL `spice2x` is supposed to connect to. + There is ^^**no need to manually change this**^^ as `spice2x` will do it for us. + + ```xml + http://localhost:8083 + ``` \ No newline at end of file diff --git a/docs/games/konami/iidx/24_sinobuz/setup.md b/docs/games/konami/iidx/24_sinobuz/setup.md new file mode 100644 index 0000000..30c300e --- /dev/null +++ b/docs/games/konami/iidx/24_sinobuz/setup.md @@ -0,0 +1,294 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Preparing data + +!!! tip "" + + After downloading and extracting your data, we need to make sure your files aren't set to `Read-only`. + + - Right click the folder containing your data, then click on `Properties`. + - In the `General` tab go down to `Attributes`, untick `Read-only` and click `Apply`. + - A popup will appear, select `Apply changes to this folder, subfolder and files` and press `OK`. + - Finally, click `OK` again to exit out of properties. + + You should end up with a file structure with a few folders only, as follows: + + + +??? warning "If your data doesn't look like this" + + If extra files are present next to your folders, such as executables, scripts, etc., **remove them**. + **This also means your data was tampered with and we strongly recommend getting new data from somewhere else.** + +## Installing spice2x + +!!! info "" + + If you already have spice2x installed, make sure it is up to date! + +!!! tip "" + + - Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release. + - Extract the `spice.exe` and `spicecfg.exe` files from the archive to your game's directory. + + + +## Configuring spice2x + +!!! info "Open `spicecfg.exe`, each following sub-section corresponds to a tab at the top" + +#### Buttons + +!!! tip "" + + Click on `Bind` then press the key you want associated with the action. + + With your controller and/or keyboard plugged in, configure your keys for: + + - **Maintenance**: `Service, Test` + - **P1 Game buttons**: `1 to 7, Start, EFFECT, VEFX` + - **P1 Keypad**: `1 to 9, Keypad Insert Card` + + **Only if** you're playing using a keyboard: + + - **Turntable**: `TT+, TT-` **and optionally** `TT+/-` which alternates between `TT+` and `TT-` on each press. + +### Analogs (controller/cab only) + +!!! tip "" + + With a controller rather than binding buttons to `TT+` and `TT-`, you need to: + + - For Turntable P1, click `Bind`. + - In `Device`, pick your controller. + - In `Control`, pick whichever one corresponds to the turntable. + - Turn your turntable ensuring that the Preview turns along with it. + - Click `Close`, leaving the rest of the settings alone. + +### Overlay + +!!! tip "" + + Modifying buttons in this section is not required but you are free to change what you want. + + Click on `Bind` then press the key you want associated with the action. + +### Lights (controller/cab only) + +!!! tip "" + + Your controller might support having its lights controlled by the game through spice2x. + + If it does, here's how you may link different actions to your lights: + + - Click `Bind`. + - In `Device`, pick your controller. + - In `Light Control`, select the corresponding light. + - Click `Close`. + - Repeat for your other lights. + +### Cards + +!!! info "Covered in the [Connecting to a network](#connecting-to-a-network) section" + +### Patches + +!!! info "Go through the [spice2x Patching](/extras/patchsp2x.md) page to import patches" + +!!! danger "To prevent issues, avoid patching things you don't need or understand" + +### API + +!!! warning "Leave everything at default unless you know what you're doing" + +### Options + +!!! info "If you don't know what an option does, hover over the its name with your mouse" + + + +!!! danger "Be very careful changing options you don't understand as it may cause issues" + +!!! tip "Required" + + | Category | Option | Parameter | Setting | + |---------------|-----------------------|-------------------|---------| + | Network | EA Service URL | -url | Covered in [Connecting to a network](#connecting-to-a-network) | + +!!! tip "Highly Recommended for NVIDIA users ONLY" + + | Category | Option | Parameter | Setting | + |-------------------|-----------------------------------|---------------| | + | Graphics (common) | NVIDIA profile optimization | -nvprofile | ON | + + +### Advanced & Development + +!!! warning "Leave everything at default unless you know what you're doing" + +## Connecting to a network + +!!! danger "Please choose one of the two solutions, not both!" + +??? tip "Remote (Online Network)" + + Open `spicecfg.exe` and head to the `Options` tab. + + In the `Network` category, set the following settings: + + - `EA Service URL` to the URL provided by your network. + - `PCBID` to the PCBID provided by your network. + + + + Next you need a card number. + If you don't already have one, generate one in the `Cards` tab. + To keep your card number safe, create a new `.txt` file with ONLY it inside. + + Once that's done, head to the `Cards` tab, for `Player 1` click `Open...` and point to your text file. + + + +??? tip "Local e-amuse Emulator (Asphyxia)" + + This is covered in the [Asphyxia CORE](/extras/asphyxia.md) page. + +## Pre-launch requirements + +!!! info "These steps are required, otherwise your game won't run" + +### VCRedist & DirectX + +!!! tip "" + + - Download and install the latest [VCRedist](https://www.techpowerup.com/download/visual-c-redistributable-runtime-package-all-in-one/) + - Download and install the [DirectX End-User Runtimes](https://www.microsoft.com/en-us/download/details.aspx?id=8109) + +### Audio + +!!! tip "" + + - Open `spicecfg.exe`. + - At the very top, click on `Shortcuts` then `Audio Playback Devices`. + - In the popup window, right click on your default audio device, and click on `Properties`. + - Go to the `Advanced` tab. + - Check both boxes under `Exclusive Mode`. + - Open the `Default Format` dropdown. + - Pick the `24 bit, 44100 Hz (CD Quality)` option and click `Apply` then `OK`. + + + +## First launch + +!!! danger "If you have any issues running the game, refer to the [Troubleshooting](troubleshooting.md) page" + +### BACKUP DATA + +!!! 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. + + + +### CLOCK ERROR + +!!! tip "" + + Press your `Test` key to initialize the backup data, a message will pop up stating it's been initialized. + + Next, you'll get another error. + + + +!!! tip "" + + Let the game run for a bit until the monitor check is complete and you should be taken to the service menu. + + + +!!! tip "" + + 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`. + + + +!!! tip "" + + Here, simply select `SAVE AND EXIT` and the clock will be set. + + You'll be back in the service menu. + +### DEFINITION TYPE + +!!! tip "" + + Go to `GAME OPTIONS` then `DEFINITION TYPE`. + +!!! tip "" + + Choose either `HD` or `HD*` depending on your preferences. + + `HD*` adds `+1.0` offset in-game, while `HD` doesn't. + + + +!!! tip "" + + Once done selecting, select `YES` then `SAVE AND EXIT`. + + + +### NETWORK OPTIONS + +!!! tip "" + + Go to `NETWORK OPTIONS` then `SHOP NAME SETTING`. + + + + +!!! tip "" + + We will need to set a shop name. + + - Name your shop to whatever you'd like. Instructions on how to navigate are at the bottom of the screen. + - Go to `EXIT` then `SAVE AND EXIT`. + + + + +!!! tip "" + + Select `GAME MODE`. + + You're all done! The game should load up properly now. + +## Carding in + +!!! tip "" + To card into the game: + + 1. Press your `Keypad Insert Card` button. + 2. Enter your code using your keypad binds. + +## Troubleshooting + +!!! warning "Have any other issue?" + + Check out the [Troubleshooting](troubleshooting.md) and [Error Codes](/errorcodes/konami.md) pages. + + For any more game-specific information, check out [Extra Information](extras.md). \ No newline at end of file diff --git a/docs/games/konami/iidx/24_sinobuz/troubleshooting.md b/docs/games/konami/iidx/24_sinobuz/troubleshooting.md new file mode 100644 index 0000000..b491ac4 --- /dev/null +++ b/docs/games/konami/iidx/24_sinobuz/troubleshooting.md @@ -0,0 +1,36 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### I'm having performance issues! + +!!! tip "" + + If you're having performance issues of some kind, spice2x's [PC optimization](https://github.com/spice2x/spice2x.github.io/wiki/PC-optimization) guide is worth looking at. + +### My game is running slow/fast, After finishing a song the game gets stuck loading! + +!!! tip "" + + The most common reason for this is the game is running over its required refresh rate. + To solve this, make sure v-sync isn't disabled in your graphics card's settings. + + For NVIDIA users, enable `NVIDIA profile optimization (-nvprofile)` in the `Options` tab. + +### How do I set my offset? + +!!! tip "" + + Play through a chart you're comfortable with. + + If you're getting too many `Fast`, increase your offset `(+)`. + If you're getting too many `Slow`, decrease your offset `(-)`. + +### My inputs aren't working / I can't get past error messages! + +!!! tip "" + + If **none** of your inputs are working, try updating [spice2x](https://spice2x.github.io/), you can also try using the beta versions if the stable releases don't work for you. \ No newline at end of file diff --git a/docs/games/konami/iidx/25_cannonballers/setup.md b/docs/games/konami/iidx/25_cannonballers/setup.md new file mode 100644 index 0000000..cedfbca --- /dev/null +++ b/docs/games/konami/iidx/25_cannonballers/setup.md @@ -0,0 +1,117 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Getting Started + +!!! tip "" + Before we even touch the game, let's fiddle with our audio settings to minimize any potential crashing on startup. In Windows, go to `Playback Devices` and then right click on your default device and go to `Properties`. From there, hit the `Advanced` tab and set your `Default Format` to `44100 Hz` and check both of the options inside `Exclusive Mode` as pictured. + + + +!!! tip "" + Once that's done, it's time to work on setting up your data. + + 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 **64-bit** tools inside the game's `contents` folder, and to create a `.bat` file. Pictured below is what your folder should look like, feel free to name your `.bat` file whatever you desire, for the sake of convenience we've named ours `gamestart.bat`. + + + +## 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 `spice64.exe -ea -w` and save the file. + + What do these different parameters do? + + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +## 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 `spice64.exe -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +!!! 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, oh no! + + + +!!! tip "" + Ignore this message, simply hit your `Test` keybind and continue onto this. + + + +!!! tip "" + Hit the `Test` keybinding again to initialize the backup data, a message will pop up stating it's been initialized. + + + +!!! tip "" + Lastly, you'll run into this error message as well, let's work on eliminating these messages. Let the game run for a bit until the monitor check is complete and you should be taken to the service menu pictured below. + + + +!!! tip "" + Start by navigating up to `CLOCK` and entering that menu. + + + +!!! tip "" + Simply hit save and exit and leave, the clock will be saved. Then, back in the service menu, go up to `GAME OPTIONS` + + + +!!! tip "" + Once inside that menu, navigate your way up to `DEFINITION TYPE` and choose either `HD` or `HD*` depending on your preferences, both run the game at 720p but have a timing difference addressed on the FAQ page. It might be worth noting that the `HD*` option is no longer present as of beatmania IIDX 26 ROOTAGE. + + + +!!! tip "" + The game will then count down asking you to confirm the selection before reverting, just hit `YES` assuming it loaded just fine on your computer. Then, exit out of that menu and head to `NETWORK OPTIONS` from back inside the service menu. + + + +!!! tip "" + From here, we will need to set a shop name to play, so select the `SHOP NAME SETTING` option. Once inside, name your shop whatever you desire! For the purpose of the guide, we named it `Guide` but highly encourage fun and/or lazy names. Once that's done go to `EXIT` and then `SAVE AND EXIT` inside of `NETWORK OPTIONS` once you've chosen your desired name, as pictured below. + + + + + +!!! tip "" + You're all done! From the service menu select `GAME MODE` and the game should load ready to be played! Have fun! + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section and [Error Code](/errorcodes/konami.md) section to resolve any issues not seen in this guide to greater depth. \ No newline at end of file diff --git a/docs/games/konami/iidx/25_cannonballers/troubleshooting.md b/docs/games/konami/iidx/25_cannonballers/troubleshooting.md new file mode 100644 index 0000000..2935b14 --- /dev/null +++ b/docs/games/konami/iidx/25_cannonballers/troubleshooting.md @@ -0,0 +1,70 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Hardware Specs + +!!! tip "" + Bemani PC (ADE-6291) + + Konami (2018) + + Based on an AMD Embedded R Series SoC. + + CPU: AMD RX-421BD + + GPU: Radeon R7 + + RAM: 4 GB + + OS: Windows 7 Embedded + +### 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. + +### Camera Device Error Message + +!!! tip "" + The game released with two USB cameras and naturally it's looking for them, if you do not have two cameras plugged into your computer then the game outputs this error, which can be ignored simply by hitting `Test` or waiting 60 seconds for it to be auto-dismissed. + + But if you're tired of this message every time you start up the game, the `CAMERA DEVICE ERROR` message can be removed via a patch. + +### 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. + +### HD and HD* + +!!! tip "" + This version of IIDX has two HD mode options, `HD` and `HD*` neither is inherently better than the other, the only difference is HD* is an additional + 1.0 offset in-game, the official reasoning is to account for a different set of monitors on arcade cabs. In beatmania IIDX 26 ROOTAGE this option is removed entirely and only HD is present. + +### Which Offset Is Which? + +!!! tip "" + If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-). + +### A Note About SSE 4.2 + +!!! tip "" + In the rare case you are running this game on *very* old hardware, IIDX 25 requires a processor supporting the [SSE 4.2 instruction set](https://en.wikipedia.org/wiki/SSE4#SSE4.2). But, in the event your processor does not have this, there is a patch available to bypass this. + +### When I Run This Game All Other Background Audio Is Gone! What's Going On? + +!!! tip "" + 64-bit versions of IIDX are now utilizing a feature in Windows called [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) to obtain less audio latency than the former 32-bit versions of the games which used [DirectSound](https://en.wikipedia.org/wiki/DirectSound). Unfortunately, this cannot be changed. + +### I'm Not Getting Any Audio/My Audio Is Completely Wrecked and I'm Using an External Dac! + +!!! tip "" + Several external DACs have issues with [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) and are unable to be used entirely, it's likely you'll be forced to use your motherboard's sound chip, or find a compatible DAC. \ No newline at end of file diff --git a/docs/games/konami/iidx/26_rootage/setup.md b/docs/games/konami/iidx/26_rootage/setup.md new file mode 100644 index 0000000..11eabce --- /dev/null +++ b/docs/games/konami/iidx/26_rootage/setup.md @@ -0,0 +1,117 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Getting Started + +!!! tip "" + Before we even touch the game, let's fiddle with our audio settings to minimize any potential crashing on startup. In Windows, go to `Playback Devices` and then right click on your default device and go to `Properties`. From there, hit the `Advanced` tab and set your `Default Format` to `44100 Hz` and check both of the options inside `Exclusive Mode` as pictured. + + + +!!! tip "" + Once that's done, it's time to work on setting up your data. + + 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 **64-bit** tools inside the game's `contents` folder, and to create a `.bat` file. Pictured below is what your folder should look like, feel free to name your `.bat` file whatever you desire, for the sake of convenience we've named ours `gamestart.bat`. + + + +## 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 `spice64.exe -ea -w` and save the file. + + What do these different parameters do? + + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +## 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 `spice64.exe -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +!!! 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, oh no! + + + +!!! tip "" + Ignore this message, simply hit your `Test` keybind and continue onto this. + + + +!!! tip "" + Hit the `Test` keybinding again to initialize the backup data, a message will pop up stating it's been initialized. + + + +!!! tip "" + Lastly, you'll run into this error message as well, let's work on eliminating these messages. Let the game run for a bit until the monitor check is complete and you should be taken to the service menu pictured below. + + + +!!! tip "" + Start by navigating up to `CLOCK` and entering that menu. + + + +!!! tip "" + Simply hit save and exit and leave, the clock will be saved. Then, back in the service menu, go up to `GAME OPTIONS` + + + +!!! tip "" + Once inside that menu, navigate your way up to `DEFINITION TYPE` and choose either `SD` or `HD` depending on your preferences. + + + +!!! tip "" + The game will then count down asking you to confirm the selection before reverting, just hit `YES` assuming it loaded just fine on your computer. Then, exit out of that menu and head to `NETWORK OPTIONS` from back inside the service menu. + + + +!!! tip "" + From here, we will need to set a shop name to play, so select the `SHOP NAME SETTING` option. Once inside, name your shop whatever you desire! For the purpose of the guide, we named it `Guide` but highly encourage fun and/or lazy names. Once that's done go to `EXIT` and then `SAVE AND EXIT` inside of `NETWORK OPTIONS` once you've chosen your desired name, as pictured below. + + + + + +!!! tip "" + You're all done! From the service menu select `GAME MODE` and the game should load ready to be played! Have fun! + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section and [Error Code](/errorcodes/konami.md) section to resolve any issues not seen in this guide to greater depth. \ No newline at end of file diff --git a/docs/games/konami/iidx/26_rootage/troubleshooting.md b/docs/games/konami/iidx/26_rootage/troubleshooting.md new file mode 100644 index 0000000..e437688 --- /dev/null +++ b/docs/games/konami/iidx/26_rootage/troubleshooting.md @@ -0,0 +1,70 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Hardware Specs + +!!! tip "" + Bemani PC (ADE-6291) + + Konami (2018) + + Based on an AMD Embedded R Series SoC. + + CPU: AMD RX-421BD + + GPU: Radeon R7 + + RAM: 4 GB + + OS: Windows 7 Embedded + +### 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. + +### Camera Device Error Message + +!!! tip "" + The game released with two USB cameras and naturally it's looking for them, if you do not have two cameras plugged into your computer then the game outputs this error, which can be ignored simply by hitting `Test` or waiting 60 seconds for it to be auto-dismissed. + + But if you're tired of this message every time you start up the game, the `CAMERA DEVICE ERROR` message can be removed via a patch. + +### 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. + +### HD and HD* + +!!! tip "" + This version of IIDX has removed having two HD mode options, leaving only HD. `HD` and `HD*` neither is inherently better than the other, the only difference is HD* is an additional + 1.0 offset in-game, now applied to the lone `HD` mode. The official reasoning is to account for a different set of monitors on arcade cabs. + +### Which Offset Is Which? + +!!! tip "" + If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-). + +### A Note About SSE 4.2 + +!!! tip "" + In the rare case you are running this game on *very* old hardware, IIDX 26 requires a processor supporting the [SSE 4.2 instruction set](https://en.wikipedia.org/wiki/SSE4#SSE4.2). But, in the event your processor does not have this, there is a patch available to bypass this. + +### When I Run This Game All Other Background Audio Is Gone! What's Going On? + +!!! tip "" + 64-bit versions of IIDX are now utilizing a feature in Windows called [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) to obtain less audio latency than the former 32-bit versions of the games which used [DirectSound](https://en.wikipedia.org/wiki/DirectSound). Unfortunately, this cannot be changed. + +### I'm Not Getting Any Audio/My Audio Is Completely Wrecked and I'm Using an External Dac! + +!!! tip "" + Several external DACs have issues with [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) and are unable to be used entirely, it's likely you'll be forced to use your motherboard's sound chip, or find a compatible DAC. \ No newline at end of file diff --git a/docs/games/konami/iidx/27_heroicverse/extras.md b/docs/games/konami/iidx/27_heroicverse/extras.md new file mode 100644 index 0000000..6d9dde8 --- /dev/null +++ b/docs/games/konami/iidx/27_heroicverse/extras.md @@ -0,0 +1,74 @@ + +# Extra Information + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Notes + +!!! tip "" + Booting the game in Lightning Mode requires a few things. To start off with, you will need to enable the `-iidxtdj` option in SpiceTools and you will also need to enable the `Enable Lightning Mode` patch. + + In doing so, and subsequently every time you choose to switch between the two modes, you will want to delete everything inside your `dev/nvram` folder, and redo the setup process again with initializing the backup date, setting the clock, shop name, and the definition type. + + SpiceTools as of 10/26/2020 has some updated features to work with this as well. Namely, the ability to toggle the Lightning Model subscreen via the `Toggle Subscreen` option in the Buttons tab. You can use your mouse to navigate the touchscreen as desired. Enter your pin, toggle buttons, etc. + + SpiceCompanion has also as of 10/26/2020 added a brand new Screen feature as well. Using SpiceCompanion, you can receive the subscreen on your phone/tablet/etc and then use your device as a touch device for the subscreen. Do note that at this time it will not work while the game is running in windowed mode. If you run into performance issues, go to the settings tab to adjust things like the Screen Quality, Screen Threads, and Screen Divide, this feature is heavily dependent on connection and you will notice as you bump up the quality that the ping will increase as well. It may take some fiddling to find the most ideal settings for your setup. + +## Lightning-specific Troubleshooting + +!!! tip "" + Below are the two main issues that have arisen for users utilizing this guide and general startup practices. + +## Hardware Specs + +!!! tip "" + + Bemani PC Type 11 (ARESPEAR C300) + + Konami (2019) + + Based on KONAMI ARESPEAR C300 gaming PC. + + CPU: Intel i5-9400F 2.9Ghz + + GPU: GIGABYTE GeForce GTX 1650 1530Mhz 4GB + + RAM: 8 GB DDR4 + + STORAGE: Innodisk 2.5" 3ME3 SATA SSD 256GB + + AUDIO: ASUS Xonar AE + + OS: Windows 10 IoT Enterprise + +## Enabling Lighting Mode Patch + +!!! tip "" + If you get a stack trace in your `log.txt` with the following line... + + `I:stackwalker: 00000001805FC970 (bm2dx): (unknown): dll_entry_main` + + Please enable the lightning mode patch in SpiceTool's patch manager. + +## Audio Related Crash + +!!! tip "" + If you get a stack trace in your `log.txt` that looks like this:.. + + `exception raised: EXCEPTION_ACCESS_VIOLATION` + + `[2020/10/22 18:20:21] I:signal: printing callstack` + + `[2020/10/22 18:20:21] I:stackwalker: 000000018026E906 (bm2dx): (unknown): (unknown)` + + For cab type 1 (LDJ), change your audio device to motherboard audio and/or use -audiobackend asio `-asiodriverid ... -audiodummy` + + For cab type 2 (TDJ, with `-iidxtdj` or another means), you have a few options: + + 1) Use `-iidxasio "Driver Name Here"` to set the ASIO driver used by IIDX's own ASIO handler. (Does not work with all ASIO drivers, they designed it to work best with a specific revision of the XONAR SOUNCARD(64)) + + 2) Use `-iidxsounddevice wasapi` to set IIDX to use WASAPI instead of its own ASIO handler. + + 3) Use `-iidxsounddevice wasapi` along with `-audiobackend asio ...` to have the game pipe audio through Spice's own ASIO handler which is more compatible with various ASIO drivers \ No newline at end of file diff --git a/docs/games/konami/iidx/27_heroicverse/setup.md b/docs/games/konami/iidx/27_heroicverse/setup.md new file mode 100644 index 0000000..d66ad5f --- /dev/null +++ b/docs/games/konami/iidx/27_heroicverse/setup.md @@ -0,0 +1,129 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Getting Started + +!!! tip "" + Before we even touch the game, let's fiddle with our audio settings to minimize any potential crashing on startup. In Windows, go to `Playback Devices` and then right click on your default device and go to `Properties`. From there, hit the `Advanced` tab and set your `Default Format` to `44100 Hz` and check both of the options inside `Exclusive Mode` as pictured. + + + +!!! tip "" + Once that's done, it's time to work on setting up your data. + + 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 **64-bit** tools inside the game's `contents` folder, Pictured below is what your folder should look like. + + + +## Configuring Your Tools + +!!! tip "" + Now that you have your files ready, open up `spicecfg.exe` and head to the `Options` where we'll set our 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:" + You will have to likely generate a .bat file given your existing tool's documentation. As stated above, make sure to check the documentation of your tools to ensure you're using the correct parameters for your needs and to consult appropriate support if you're unsure how to do this. + +## Configuring for a Local Network + +!!! tip "" + For our local network configuration example, inside `Options` tab we're going to click on the following: `E-Amusement Emulation: -ea` and `Windowed Mode: -w` to enable them. + + What do these different parameters do? + + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the selected options inside the `Options` tab in `spicecfg.exe`. + + + +## Configuring for an Online Network + +!!! tip "" + For our online network example we're simply doing the above but with different parameters! On the `Service URL: -url` parameter, we're going to input our chosen network URL like so: `http://yoururlhere.com/` + + To go alongside this, we'll also be inputting into the `PCBID: -p` parameter, the PCBID given to us from our network, like so: `XXXXXXXXXXXXXXXXXXXX` + + Lastly, we'll click on the `Windowed Mode: -w` parameter. + + What do these different parameters do? + + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the selected options inside the `Options` tab in `spicecfg.exe`. + + + +!!! 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 inside the `Buttons` and `Analogs` tabs! Make sure you setup the `Test` keybind as it will be critical for setting up the game. + + +!!! tip "" + Once you've done that, launch your game for the first time by double clicking the `spice64.exe` and the game should load with your chosen parameters from `spicecfg.exe`. + + If it's your first time running the game, you'll immediately be greeted with this screen, oh no! + + + +!!! tip "" + Ignore this message, simply hit your `Test` keybind and continue onto this. + + + +!!! tip "" + Hit the `Test` keybinding to initialize the backup data, a message will pop up stating it's been initialized. + + + +!!! tip "" + You'll also run into this error message as well, let's work on eliminating these messages. Let the game run for a bit until the monitor check is complete and you should be taken to the service menu pictured below. + + + +!!! tip "" + Start by navigating up to `CLOCK` and entering that menu. + + + +!!! tip "" + Simply hit save and exit and leave, the clock will be saved. Then, back in the service menu, go up to `GAME OPTIONS` + + + +!!! tip "" + Once inside that menu, navigate your way up to `DEFINITION TYPE` and choose either `SD` or `HD` depending on your preferences. + + + +!!! tip "" + The game will then count down asking you to confirm the selection before reverting, just hit `YES` assuming it loaded just fine on your computer. Then, exit out of that menu and head to `NETWORK OPTIONS` from back inside the service menu. + + If it doesn't transition to HD, after you've saved, you can simply reboot the game and all should be well. + + + +!!! tip "" + The final thing we need to set is here inside `NETWORK OPTIONS`, we will need to set a shop name to play, so select the `SHOP NAME SETTING` option. Once inside, name your shop whatever you desire! For the purpose of the guide, we named it `Guide` but highly encourage fun and/or lazy names. Once that's done go to `EXIT` and then `SAVE AND EXIT` inside of `NETWORK OPTIONS` once you've chosen your desired name, as pictured below. + + + + + +!!! tip "" + You're all done! From the service menu select `GAME MODE` and the game should load ready to be played! Have fun! + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section and [Error Code](/errorcodes/konami.md) section to resolve any issues not seen in this guide to greater depth. + + Lightning Mode specifics can be found in the [Extra Information](extras.md#lightning-specific-troubleshooting) \ No newline at end of file diff --git a/docs/games/konami/iidx/27_heroicverse/troubleshooting.md b/docs/games/konami/iidx/27_heroicverse/troubleshooting.md new file mode 100644 index 0000000..bbe8329 --- /dev/null +++ b/docs/games/konami/iidx/27_heroicverse/troubleshooting.md @@ -0,0 +1,63 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Hardware Specs + +!!! tip "" + + (These are the specs for non-lightning model cab running Heroic Verse) + + Bemani PC Type 9 (ADE-6291) + + Konami (2017) + + Based on an AMD Embedded R Series SoC. + + CPU: AMD RX-421BD 2.1/3.4GHz APU + + GPU: Radeon R7 800Mhz + + RAM: 4 GB + + STORAGE: innodisk 3ME2 mSATA SSD 256GB + + OS: Windows 7 Embedded + +### 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 or 120 Hz framerate, depending on if you're in LDJ or TDJ mode. The game is hardcoded to run at these specific framerates and this cannot be changed. To solve this, set your monitor's refresh rate to match if you're in LDJ 60 Hz or TDJ 120 Hz mode. You can always check on the game's monitor check if the game is fluctuating around 59.94hz, the NTSC standard or around 120.00hz. If it's not around there and your monitor is indeed set correctly for the given mode, 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. + +### Which Offset Is Which? + +!!! tip "" + If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-). + +### A Note About SSE 4.2 + +!!! tip "" + In the rare case you are running this game on *very* old hardware, IIDX 27 requires a processor supporting the [SSE 4.2 instruction set](https://en.wikipedia.org/wiki/SSE4#SSE4.2). But, in the event your processor does not have this, there is a patch available to bypass this. + +### When I Run This Game All Other Background Audio Is Gone! What's Going On? + +!!! tip "" + 64-bit versions of IIDX are now utilizing a feature in Windows called [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) to obtain less audio latency than the former 32-bit versions of the games which used [DirectSound](https://en.wikipedia.org/wiki/DirectSound). Unfortunately, this cannot be changed. + +### I'm Not Getting Any Audio/My Audio Is Completely Wrecked and I'm Using an External Dac! + +!!! tip "" + Several external DACs have issues with [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) and are unable to be used entirely, it's likely you'll be forced to use your motherboard's sound chip, or find a compatible DAC. \ No newline at end of file diff --git a/docs/games/konami/iidx/30_resident/extras.md b/docs/games/konami/iidx/30_resident/extras.md new file mode 100644 index 0000000..72f1efa --- /dev/null +++ b/docs/games/konami/iidx/30_resident/extras.md @@ -0,0 +1,88 @@ + +# 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 + A + A + 2023090500 + + ``` + + This is the line that determines if the game will run in Standard (60 FPS) or Lightning (120 FPS) mode. + + ```xml + A + ``` + + - ^^`A`^^ for Standard (LDJ-003, LDJ, 60 Hz) + - ^^`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 + +!!! tip "" + + The `ea3-config.xml` file is located inside the `prop` folder. + + Below is an explanation on what different sections of this file do. + + The following lines change the PCBID and HARDID that your system reports to your e-amusement server. + There is ^^**no need to manually change this**^^ as `spice2x` will do it for us. + + ```xml + 00010203040506070809 + 00010203040506070809 + ``` + + The following line determines what version of the game you are running. + ^^**You should never change this**^^. It should always say `LDJ`. + + ```xml + LDJ + ``` + + The following line determines the game's region. + ^^**You should never change this**^^. As you can change the language in-game. + + ```xml + J + ``` + + ^^**You should never change this**^^. It should always say `A` for Resident. + + ```xml + A + ``` + + The following line determines your datecode. + ^^**Always keep it up to date**^^ with your game's current version. + + ```xml + 2023090500 + ``` + + The following line determine what remote service URL `spice2x` is supposed to connect to. + There is ^^**no need to manually change this**^^ as `spice2x` will do it for us. + + ```xml + http://localhost:8083 + ``` \ No newline at end of file diff --git a/docs/games/konami/iidx/30_resident/setup.md b/docs/games/konami/iidx/30_resident/setup.md new file mode 100644 index 0000000..3ed6d2f --- /dev/null +++ b/docs/games/konami/iidx/30_resident/setup.md @@ -0,0 +1,231 @@ + +# Game Setup + +--8<-- "docs/snippets/common/data_warning.md" + +## Standard and Lightning modes + +!!! note "" + + Before proceeding with the setup, it's 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 + + - **Standard/Legacy (LDJ/LDJ-003/LDJ-012)**: + + - Runs at 60 FPS + - Requires a 60 Hz main monitor + - No subscreen + + The game data comes in three variants based on the `bm2dx.dll` file. + You can patch an LDJ dll to run in TDJ mode, but this will disable video recording. + + For simplicity, we'll use "TDJ" for Lightning Mode and "LDJ" for Standard Mode throughout our guides. + +## 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 diff --git a/docs/games/konami/iidx/30_resident/troubleshooting.md b/docs/games/konami/iidx/30_resident/troubleshooting.md new file mode 100644 index 0000000..c570ce9 --- /dev/null +++ b/docs/games/konami/iidx/30_resident/troubleshooting.md @@ -0,0 +1,97 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +!!! info "For any issues not covered here, spice2x's [Known issues](https://github.com/spice2x/spice2x.github.io/wiki/Known-issues) page might prove useful" + +## Technical problems + +### Crashes + +!!! info "Riva Tuner Statistics Server (RTSS) and MSI Afterburner are known to cause odd crashes.
If you have them installed, close them both before starting any arcade game" + +??? tip "`W:SuperstepSound: Audio device is not available!!!` in logs" + + - Open `log.txt` using an editor that supports `SHIFT-JIS` encoding for Japanese text (like [Notepad++](https://notepad-plus-plus.org/downloads/)) + + - Search for `Superstep` + + If you find a line with `Audio device is not available!!!`, it means the game refuses to boot due to a misconfigured or missing audio device. + Check the setup guide's **Configuring audio** section 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" + + Laptops often have odd issues running data. The game may open on the wrong monitor, run at the wrong resolution or framerate, or simply crashes. + + There is currently no known fix for this, other than maybe playing in windowed mode, or using a desktop PC instead. + +### Performance + +!!! info "Check out spice2x's [PC optimization](https://github.com/spice2x/spice2x.github.io/wiki/PC-optimization) guide" + +??? tip "Game is running too slow/fast / Monitor error 5-1503-0043" + + Your game is likely running at an incorrect framerate. The expected framerates are: + + - Legacy cab mode: 60 FPS + - Lightning Model cab mode: 120 FPS + + Try these steps to resolve framerate issues: + + - Make sure that your patch or DLL matches your cab mode + - Close any software that can affect framerates (like RTSS) + - Close unnecessary background programs + - Ensure V-SYNC is not forcefully disabled in your graphics card control panel + - For NVIDIA users: Enable `NVIDIA profile optimization (-nvprofile)` in spicecfg's `Options` tab + + If issues persist: + + - Double-check that you followed all steps in the setup guide correctly + - Your PC hardware might be insufficient to keep a steady 120 FPS, you can try switching to Legacy cab mode + - Your data may be corrupt in one way or another, you could try starting from scratch using trusted data sources + +### Audio + +!!! info "Check out our [Audio](/extras/audio.md) guide to understand audio modes better" + +!!! info "Ensure your default audio device's sample rate is set properly" + + - **44100 Hz** sample rate for **WASAPI Exclusive** and **ASIO** + - **48000 Hz** if your game is patched with `Shared Mode WASAPI` + +??? tip "I can't change my device's sample rate" + + If you're using gaming peripherals (Logitech/Razer/Steelseries) or external audio devices (audio interfaces/sound bars): + + - Check if you can modify the sample rate in the device's software/control panel + - If not, try uninstalling the device's software. This may restore control over Windows audio settings + + If you still can't change the sample rate: + + - Configure the game's audio mode to match your device's current sample rate instead + - Try using a different audio device + +??? tip "I can't hear anything else than the game" + + Your game's audio is setup to run in WASAPI Exclusive or ASIO modes. + + Check out our [Audio](/extras/audio.md) guide to understand audio modes better. + + If you're using WASAPI Exclusive, you'll want to [patch the game](/extras/patchsp2x.md) with `Shared Mode WASAPI` to hear other applications. + + If you're using ASIO, unless your audio interface mixes WASAPI and ASIO streams when outputting, you'll only be able to hear one application when ASIO is in use. + In this case, you'll need to route all audio through software such as [Voicemeeter](https://vb-audio.com/Voicemeeter/banana.htm), and have Voicemeeter output the mix to your ASIO device. + +??? tip "Game audio is too quiet" + + When using `TDJ mode` the audio is very quiet by default. To mitigate this, you can use the `Increase Game Volume` patch. + +### Subscreen + +!!! info "For more in-depth troubleshooting, refer to the spice2x [Subscreen troubleshooting](https://github.com/spice2x/spice2x.github.io/wiki/Configuring-touch-screens-as-subscreen#troubleshooting) page" + +??? tip "Touch input isn't being registered" + + If you're using a physical touch screen, make sure to close **all** spice2x overlays, including the FPS counter. + If you're using the virtual subscreen, ensure that the `-iidxnativetouch` option is not enabled. \ No newline at end of file diff --git a/docs/games/konami/iidx/31_epolis/extras.md b/docs/games/konami/iidx/31_epolis/extras.md new file mode 100644 index 0000000..68c4979 --- /dev/null +++ b/docs/games/konami/iidx/31_epolis/extras.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/iidx/common/31plus/extras.md" \ No newline at end of file diff --git a/docs/games/konami/iidx/31_epolis/setup.md b/docs/games/konami/iidx/31_epolis/setup.md new file mode 100644 index 0000000..da04eb4 --- /dev/null +++ b/docs/games/konami/iidx/31_epolis/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/iidx/common/31plus/setup.md" \ No newline at end of file diff --git a/docs/games/konami/iidx/31_epolis/troubleshooting.md b/docs/games/konami/iidx/31_epolis/troubleshooting.md new file mode 100644 index 0000000..e4c1d86 --- /dev/null +++ b/docs/games/konami/iidx/31_epolis/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/iidx/common/31plus/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/konami/iidx/32_pinkycrush/extras.md b/docs/games/konami/iidx/32_pinkycrush/extras.md new file mode 100644 index 0000000..1b68351 --- /dev/null +++ b/docs/games/konami/iidx/32_pinkycrush/extras.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/iidx/common/31plus/extras.md" \ No newline at end of file diff --git a/docs/games/konami/iidx/32_pinkycrush/setup.md b/docs/games/konami/iidx/32_pinkycrush/setup.md new file mode 100644 index 0000000..23bdd58 --- /dev/null +++ b/docs/games/konami/iidx/32_pinkycrush/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/iidx/common/31plus/setup.md" \ No newline at end of file diff --git a/docs/games/konami/iidx/32_pinkycrush/troubleshooting.md b/docs/games/konami/iidx/32_pinkycrush/troubleshooting.md new file mode 100644 index 0000000..b6a77b6 --- /dev/null +++ b/docs/games/konami/iidx/32_pinkycrush/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/iidx/common/31plus/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/konami/iidx/33_sparkleshower/extras.md b/docs/games/konami/iidx/33_sparkleshower/extras.md new file mode 100644 index 0000000..ebf5f8b --- /dev/null +++ b/docs/games/konami/iidx/33_sparkleshower/extras.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/iidx/common/31plus/extras.md" \ No newline at end of file diff --git a/docs/games/konami/iidx/33_sparkleshower/setup.md b/docs/games/konami/iidx/33_sparkleshower/setup.md new file mode 100644 index 0000000..da4dd06 --- /dev/null +++ b/docs/games/konami/iidx/33_sparkleshower/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/iidx/common/31plus/setup.md" \ No newline at end of file diff --git a/docs/games/konami/iidx/33_sparkleshower/troubleshooting.md b/docs/games/konami/iidx/33_sparkleshower/troubleshooting.md new file mode 100644 index 0000000..8d9005e --- /dev/null +++ b/docs/games/konami/iidx/33_sparkleshower/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/iidx/common/31plus/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/konami/iidx/9thstyle/setup.md b/docs/games/konami/iidx/9thstyle/setup.md new file mode 100644 index 0000000..3e02f84 --- /dev/null +++ b/docs/games/konami/iidx/9thstyle/setup.md @@ -0,0 +1,275 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Preparing data + +!!! tip "" + + After downloading and extracting your data, we need to make sure your files aren't set to `Read-only`. + + - Right click the folder containing your data, then click on `Properties`. + - In the `General` tab go down to `Attributes`, untick `Read-only` and click `Apply`. + - A popup will appear, select `Apply changes to this folder, subfolder and files` and press `OK`. + - Finally, click `OK` again to exit out of properties. + +## Installing Bemanitools + +!!! tip "" + + - Download :material-package-down:[Bemanitools](https://github.com/djhackersdev/bemanitools/releases/download/5.48/bemanitools-5.48.zip). + + - Inside :material-zip-box:`bemanitools-5.48.zip` locate :material-zip-box:`iidx-09-to-12.zip`. + + - Extract everything inside the folder that contains the :material-file:`bm2dx.exe` which is located in :material-folder:`\C02\D\C02\JAG`. + + Pictured below is what your folder should look like. We've removed any files not necessary for **9th style**. + + + +### Using iidxhook-09.conf + +!!! tip "" + + - Download the :material-package-down:[Bemanitools supplements](https://github.com/djhackersdev/bemanitools-supplement/releases/download/1.6/bemanitools-supplement-1.6.zip) + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate inside :material-zip-box:`misc.zip` + + - Inside :material-folder:`misc\d3d8to9`, extract :material-file-cog-outline:`d3d8.dll` to :material-folder:`\C02\D\C02\JAG`. + + This enables us to use the graphic options inside :material-file-code:`iidxhook-09.conf` which we will take advantage of. + +## Configuring Bemanitools + +!!! info "To configure your keybinds, open your :material-file:`config.bat` file" + +### Buttons + +!!! tip "" + + Double click on the right on a button that you wish to bind, then press the key you want associated with the action. + + With your controller and/or keyboard plugged in, configure your keys for: + + - **Maintenance**: `Service, Test` + - **P1 Game buttons**: `1 to 7, Start, EFFECT, VEFX` + - **P1 Keypad**: `Keypad Insert Card` + + **Only if** you're playing using a keyboard: + + - **Turntable**: `TT+, TT-` **and optionally** `TT+/-` which alternates between `TT+` and `TT-` on each press. + +### Analogs (controller/cab only) + +!!! tip "" + + With a controller rather than binding buttons to `TT+` and `TT-`, you need to: + + - Head to the `Analogs` tab at the top. + - In `Device`, pick your controller. + - In `Control`, pick whichever one corresponds to the turntable. + - Turn your turntable ensuring that the preview turns along with it. + - Click `OK`, leaving the rest of the settings alone. + +### Lights (controller/cab only) + +!!! tip "" + + Your controller might support having its lights controlled by the game through bemanitools. + + If it does, here's how you may link different actions to your lights: + + - In `Device`, pick your controller. + - In `Game Light`, select the corresponding button that will be used for that light. + - Repeat for your other lights. + +!!! info "If you'd like to play offline, you can head straight to [Game resolution and locking FPS](#game-resolution-and-locking-fps)" + +### Configuring Bemanitools for a network + +!!! tip "Head over to the `Network` tab" + +!!! tip "" + Now we will set up our PIN pad and card. + + - Click on `Keyboard device` + - You may or may not have more than one option. To figure out which one is your actual keyboard, select a device inside that list and press a button on the numpad. + - Once you have found your correct device, the `Keyboard status` will change **(the number and location of the number does not matter, it only matters that it changed)**. + - Grab your card, create a :material-file-document-edit:`.txt` and name it however you like. In this example it's called :material-file-document-edit:`card.txt` + - Place the file in a location that is easily accessible and you won't forget. In this case it's in a seperate folder. + +!!! info "If you don't have a numpad, make sure to tick `Use top keyboard row for PIN pad input`. This will also change the `Card In` button to `Backspace`" + + + +## Connecting to a network + +!!! tip "" + + - Locate your :material-file-code:`iidxhook-09.conf` + + - Open it with your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) + + - Replace the `eamuse.server=localhost:80` with your desired network URL + + - Replace `eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX` **and** `eamuse.eamid=XXXXXXXXXXXXXXXXXXXX` with your PCBID of your network of choice. + + ``` + # URL (e.g. http://my.eamuse.server:80/whatever) or IPV4 (e.g. 127.0.0.1:80) of the target eamuse server. The port is optional but defaults to 80. + eamuse.server=localhost:80 + + # PCBID + eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX + + # EAMID + eamuse.eamid=XXXXXXXXXXXXXXXXXXXX + ``` + +## Game resolution and locking FPS + +!!! tip "" + We'd like to mention that there are two options when it comes to how the game renders. You can choose between `Linear` and `Point`. + + Below is an example of how both look like. + + ??? info "Linear" + + + ??? info "Point" + + + It comes down to your own prefrence what you decide on, `Linear` is less sharp but doesn't have pixel perfect edges. `Point` is sharp and is pixel perfect. + +!!! tip "" + Next up, we'll setup borderless window and configure the proper resolution. We're using a `1920x1080` monitor so we will use that. + + Repeat the previous step and open your :material-file-code:`iidxhook-09.conf`. We want to find these lines: + + ``` + # Software limit the frame rate of the rendering loop in hz, e.g. 60 or 59.95 (0.0 = no software limit) + gfx.frame_rate_limit=0.0 + + # Run the game windowed + gfx.windowed=false + + # Windowed width, 0 for default size + gfx.window_width=0 + + # Windowed height, 0 for default size + gfx.window_height=0 + + # Up-/downscale the back buffer's width. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding height parameter. + gfx.scale_back_buffer_width=0 + + # Up-/downscale the back buffer's height. This does not change the game's rendering resolution but scales the final frame. Use this to target the native resolution of your monitor/TV, e.g. to avoid over-/underscan, bad image quality or latency caused by the monitors internal upscaler. 0 to disable this feature. Must be set in combination with the corresponding width parameter. + gfx.scale_back_buffer_height=0 + + # Filter type to use for up-/downscaling the back buffer. Only used if scaling feature was enabled by setting the scaling width and height parameters. Available types: none, linear, point (refer to D3DTEXTUREFILTERTYPE for explanation). + gfx.scale_back_buffer_filter=none + ``` + + If you can't seem to find them, press `CTRL` + `F` and search for `gfx.frame_rate_limit=0.0`. This will bring you to the first line we want to edit. + +!!! tip "" + Listed below are the values we want to change them to. + + ``` + gfx.frame_rate_limit=59.95 + gfx.windowed=true + gfx.window_width=1920 + gfx.window_height=1080 + gfx.scale_back_buffer_width=1920 + gfx.scale_back_buffer_height=1080 + gfx.scale_back_buffer_filter=linear + ``` + Unless you'd like to have the game properly windowed you can safely ignore `gfx.framed=false`. + + Make sure to decide on whether you want `Linear` or `Point` rendering. + + ``` + gfx.scale_back_buffer_filter=linear + gfx.scale_back_buffer_filter=point + ``` + +## First launch + +!!! danger "If you have any issues running the game, refer to the [Troubleshooting](troubleshooting.md) page" + +### CLOCK ERROR + +!!! 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 :material-file:`gamestart.bat`. + + If it's your first time running the game, you'll immediately be greeted with this screen. + + + + + +!!! tip "" + The game will automatically bring you into it's service menu. + + + +!!! tip "" + 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. + + Navigate to `CLOCK SETUP`. You do not need to manually change it. Navigate to `SAVE AND EXIT`. + + + +!!! info "If you'd like to play offline, you can head straight to [Final Notes](#final-notes)" + +### Enabling e-AMUSEMENT for Online Play + +!!! tip "" + From the service menu, go to `e-AMUSEMENT OPTIONS` then `e-AMUSEMENT SETTINGS`. + + + + + +!!! tip "" + It'll bring you to this screen, change it so that `e-AMUSEMENT` switches to `ON` and it will look like this: + + + + + +!!! tip "" + We will need to set a `SHOP NAME SETTING` and change our `PREFECTURE` otherwise the game will throw errors at us. + + + +!!! tip "" + + - Name your shop to whatever you'd like. Instructions on how to navigate are at the bottom of the screen. + - Navigate to `EXIT` and select it. + - Change your prefecture once or how many times you'd like, it doesn't matter as long as it's not the default one. + + + +!!! tip "" + Select `SAVE AND EXIT`. The game will now give you a message, which translated means: + + `e-AMUSEMENT settings have been changed. Please turn the power off and on again.` + + So, close the game and open it again. + + + +## Final Notes + +!!! success "You're all done! Make sure to insert two credits by pressing your `SERVICE` key. Have fun!" + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section. \ No newline at end of file diff --git a/docs/games/konami/iidx/9thstyle/troubleshooting.md b/docs/games/konami/iidx/9thstyle/troubleshooting.md new file mode 100644 index 0000000..e1a2405 --- /dev/null +++ b/docs/games/konami/iidx/9thstyle/troubleshooting.md @@ -0,0 +1,62 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### My Game Is Running Crazy Fast! + +!!! tip "" + The most common reason for this is the game is running over its required 59.95hz, the game is hardcoded to run at 59.95hz and this cannot be changed. To solve this, check [Game resolution and locking FPS](setup.md#game-resolution-and-locking-fps) again. + +### I'm getting "NETWORK WARNING" instead of "NETWORK OK" + +!!! tip "" + This can be caused by: + + - Invalid PCBID + - Firewall blocking connections + - Invalid eamuse url or port specified + - Game is not run using the Administrator account + +### My background videos aren't working! + +!!! tip "" + + You need to install a codec. + + - Open :material-zip-box:`bemanitools-supplement-v1.6.zip` and navigate to :material-folder:`\iidx.zip\iidx\misc\` where :material-file:`CLVSD.ax` is located. + + - Extract :material-file:`CLVSD.ax` inside a :material-folder: folder that you know won't be moved or renamed. + + - Open the :material-console:command prompt as ***administrator***. Now type `regsvr32 "\CLVSD.ax"` into the command prompt. + + As an example, it could look like this: `regsvr32 "D:\BEMANI\IIDX\CLVSD.ax"` + + A prompt should appear telling you that it has been installed successfully. + This applies for all styles that require this codec, not just **9th style**. + + If an error occurs, you didn't run the command prompt as administrator or you messed up the location of the file. + +!!! danger "You **can not** move or delete :material-file:`CLVSD.ax` **at all**, otherwise it will revert the changes and you have to install it again" + +### My game crashes immediately! + +!!! warning "This can have multiple reasons. These fixes shouldn't be needed for 9th style since we're addressing them in the guide. We'll add them anyway just in case" + +#### Fix #1 (Wrong data structure) + +!!! tip "" + Make sure that your unpacked data looks like this: + + - JAx (Game binary revision folder where 'x' can be A, B, C, D, E, F, G) + - data + - sidcode.txt + + Any other files are optional and don't have to be removed as these are not required to run the game. + +#### Fix #2 (RtEffects.dll didn't get replaced) + +!!! tip "" + Refer to [Preparing data](setup.md#preparing-data) again and check if you have followed all the instructions explained in it. \ 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 new file mode 100644 index 0000000..cbd64b6 --- /dev/null +++ b/docs/games/konami/iidx/common/31plus/extras.md @@ -0,0 +1,86 @@ +# 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 + +!!! tip "" + + The `ea3-config.xml` file is located inside the `prop` folder. + + Below is an explanation on what different sections of this file do. + + The following lines change the PCBID and HARDID that your system reports to your e-amusement server. + There is ^^**no need to manually change this**^^ as `spice2x` will do it for us. + + ```xml + 00010203040506070809 + 00010203040506070809 + ``` + + The following line determines what version of the game you are running. + ^^**You should never change this**^^. It should always say `LDJ`. + + ```xml + LDJ + ``` + + The following line determines the game's region. + ^^**You should never 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. + + ```xml + A + ``` + + The following line determines your datecode. + ^^**Always keep it up to date**^^ with your game's current version. + + ```xml + 2024100900 + ``` + + The following line determine what remote service URL `spice2x` is supposed to connect to. + There is ^^**no need to manually change this**^^ as `spice2x` will do it for us. + + ```xml + http://localhost:8083 + ``` \ No newline at end of file diff --git a/docs/games/konami/iidx/common/31plus/setup.md b/docs/games/konami/iidx/common/31plus/setup.md new file mode 100644 index 0000000..06ea51f --- /dev/null +++ b/docs/games/konami/iidx/common/31plus/setup.md @@ -0,0 +1,213 @@ +# Game Setup + +--8<-- "docs/snippets/common/data_warning.md" + +--8<-- "docs/snippets/common/cpu_avx2.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 **100 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 diff --git a/docs/games/konami/iidx/common/31plus/troubleshooting.md b/docs/games/konami/iidx/common/31plus/troubleshooting.md new file mode 100644 index 0000000..8d5481d --- /dev/null +++ b/docs/games/konami/iidx/common/31plus/troubleshooting.md @@ -0,0 +1,105 @@ +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +!!! info "For any issues not covered here, spice2x's [Known issues](https://github.com/spice2x/spice2x.github.io/wiki/Known-issues) page might prove useful" + +## Technical problems + +### Crashes + +!!! info "Riva Tuner Statistics Server (RTSS) and MSI Afterburner are known to cause odd crashes.
If you have them installed, close them both before starting any arcade game" + +??? tip "`W:SuperstepSound: Audio device is not available!!!` in logs" + + - Open `log.txt` using an editor that supports `SHIFT-JIS` encoding for Japanese text (like [Notepad++](https://notepad-plus-plus.org/downloads/)) + + - Search for `Superstep` + + If you find a line with `Audio device is not available!!!`, it means the game refuses to boot due to a misconfigured or missing audio device. + Check the setup guide's **Configuring audio** section as well as our general [Audio guide](/extras/audio.md) to understand the issue better. + +??? tip "`EXCEPTION_ILLEGAL_INSTRUCTION` in logs" + + - Open `log.txt` using an editor that supports `SHIFT-JIS` encoding for Japanese text (like [Notepad++](https://notepad-plus-plus.org/downloads/)) + + - Search for `EXCEPTION_ILLEGAL_INSTRUCTION` + + beatmania IIDX 31 and above require a CPU that is AVX2 capable. If you encounter this message, it may indicate that your CPU is too old and does not support AVX2. + A known workaround is renaming/deleting the `movies` folder to prevent the game from loading them altogether. + +??? tip "I'm using a laptop with a hybrid internal+dedicated GPU setup" + + Laptops often have odd issues running data. The game may open on the wrong monitor, run at the wrong resolution or framerate, or simply crashes. + + There is currently no known fix for this, other than maybe playing in windowed mode, or using a desktop PC instead. + +### Performance + +!!! info "Check out spice2x's [PC optimization](https://github.com/spice2x/spice2x.github.io/wiki/PC-optimization) guide" + +??? tip "Game is running too slow/fast / Monitor error 5-1503-0043" + + Your game is likely running at an incorrect framerate. The expected framerates are: + + - Legacy cab mode: 60 FPS + - Lightning Model cab mode: 120 FPS + + Try these steps to resolve framerate issues: + + - Make sure that your patch or DLL matches your cab mode + - Close any software that can affect framerates (like RTSS) + - Close unnecessary background programs + - Ensure V-SYNC is not forcefully disabled in your graphics card control panel + - For NVIDIA users: Enable `NVIDIA profile optimization (-nvprofile)` in spicecfg's `Options` tab + + If issues persist: + + - Double-check that you followed all steps in the setup guide correctly + - Your PC hardware might be insufficient to keep a steady 120 FPS, you can try switching to Legacy cab mode + - Your data may be corrupt in one way or another, you could try starting from scratch using trusted data sources + +### Audio + +!!! info "Check out our [Audio](/extras/audio.md) guide to understand audio modes better" + +!!! info "Ensure your default audio device's sample rate is set properly" + + - **44100 Hz** sample rate for **WASAPI Exclusive** and **ASIO** + - **48000 Hz** if your game is patched with `Shared Mode WASAPI` + +??? tip "I can't change my device's sample rate" + + If you're using gaming peripherals (Logitech/Razer/Steelseries) or external audio devices (audio interfaces/sound bars): + + - Check if you can modify the sample rate in the device's software/control panel + - If not, try uninstalling the device's software. This may restore control over Windows audio settings + + If you still can't change the sample rate: + + - Configure the game's audio mode to match your device's current sample rate instead + - Try using a different audio device + +??? tip "I can't hear anything else than the game" + + Your game's audio is setup to run in WASAPI Exclusive or ASIO modes. + + Check out our [Audio](/extras/audio.md) guide to understand audio modes better. + + If you're using WASAPI Exclusive, you'll want to [patch the game](/extras/patchsp2x.md) with `Shared Mode WASAPI` to hear other applications. + + If you're using ASIO, unless your audio interface mixes WASAPI and ASIO streams when outputting, you'll only be able to hear one application when ASIO is in use. + In this case, you'll need to route all audio through software such as [Voicemeeter](https://vb-audio.com/Voicemeeter/banana.htm), and have Voicemeeter output the mix to your ASIO device. + +??? tip "Game audio is too quiet" + + When using `TDJ mode` the audio is very quiet by default. To mitigate this, you can use the `Increase Game Volume` patch. + +### Subscreen + +!!! info "For more in-depth troubleshooting, refer to the spice2x [Subscreen troubleshooting](https://github.com/spice2x/spice2x.github.io/wiki/Configuring-touch-screens-as-subscreen#troubleshooting) page" + +??? tip "Touch input isn't being registered" + + If you're using a physical touch screen, make sure to close **all** spice2x overlays, including the FPS counter. + If you're using the virtual subscreen, ensure that the `-iidxnativetouch` option is not enabled. \ No newline at end of file diff --git a/docs/games/konami/jubeat/avenue/setup.md b/docs/games/konami/jubeat/avenue/setup.md new file mode 100644 index 0000000..1175553 --- /dev/null +++ b/docs/games/konami/jubeat/avenue/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/jubeat/common/setup.md" \ No newline at end of file diff --git a/docs/games/konami/jubeat/beyondtheavenue/setup.md b/docs/games/konami/jubeat/beyondtheavenue/setup.md new file mode 100644 index 0000000..1fc0e07 --- /dev/null +++ b/docs/games/konami/jubeat/beyondtheavenue/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/jubeat/common/setup.md" \ No newline at end of file diff --git a/docs/games/konami/jubeat/common/setup.md b/docs/games/konami/jubeat/common/setup.md new file mode 100644 index 0000000..a7a481e --- /dev/null +++ b/docs/games/konami/jubeat/common/setup.md @@ -0,0 +1,190 @@ +# 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/konami/common/data_update.md" + +## Installing spice2x + +--8<-- "docs/snippets/konami/common/spice2x32_install.md" + + ``` hl_lines="5-6" + 📂data + 📂modules + 📂prop + ⚙️msvcr100.dll + 🌶️spice.exe + 🌶️spicecfg.exe + ``` + +--8<-- "docs/snippets/konami/common/spice2x32_stubs.md" + +## Configuring spice2x + +--8<-- "docs/snippets/konami/common/spicecfg_preamble.md" + +=== "Buttons" + +--8<-- "docs/snippets/konami/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/konami/common/spicecfg_buttons_additionalinfo.md" + +=== "Analogs" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.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/common/spicecfg_options_nvprofile.md" + +=== "Advanced" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +=== "Development" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +## Configuring audio + +!!! tip "" + + - Open `spicecfg.exe` + - At the very top, click on `Shortcuts` then `Audio Playback Devices` + - In the popup window, right click on your default audio device, and click on `Properties` + - Go to the `Advanced` tab + - Open the `Default Format` dropdown + - Pick the `16 bit, 48000 Hz (DVD Quality)` option, click `Apply` then `OK` + + Optionally: go to the `Options` tab in `spicecfg.exe`, and at the very bottom enable `Low Latency Shared Audio` to help mitigate audio latency. + +## Connecting to a network + +--8<-- "docs/snippets/konami/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. + + + + 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. + + You will be greeted by a warning asking you to reboot the game, you can safely ignore it for the moment. + + *Instructions on how to navigate the menu are shown on the screen.* + + Go to `GAME OPTIONS`, then `SHOP SETTINGS`. + + + + 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, restart the game. + +!!! success "You're all done! The game should load up properly now" + +## Help + +--8<-- "docs/snippets/common/help.md" diff --git a/docs/games/konami/jubeat/festo/setup.md b/docs/games/konami/jubeat/festo/setup.md new file mode 100644 index 0000000..73f99db --- /dev/null +++ b/docs/games/konami/jubeat/festo/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/jubeat/common/setup.md" \ No newline at end of file diff --git a/docs/games/konami/mfg/setup.md b/docs/games/konami/mfg/setup.md new file mode 100644 index 0000000..4dbdc3a --- /dev/null +++ b/docs/games/konami/mfg/setup.md @@ -0,0 +1,110 @@ + +# 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 **5 GB or larger** + + Here's what the expected data structure should look like: + + ``` + 📂prop + 📂modules + 📂game + 📄game.inf + ``` + +--8<-- "docs/snippets/konami/common/data_bad.md" + +## Installing spice2x + +--8<-- "docs/snippets/konami/common/spice2x64_install.md" + + ``` hl_lines="5-6" + 📂prop + 📂modules + 📂game + 📄game.inf + 🌶️spice64.exe + 🌶️spicecfg.exe + ``` + +## Configuring spice2x + +--8<-- "docs/snippets/konami/common/spicecfg_preamble.md" + +=== "Buttons" + +--8<-- "docs/snippets/konami/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 keyboard plugged in, configure your keys for P1 and/or P2: + + - **Maintenance**: `Service, Test` + + Mahjong Fight Girl is a touchscreen game, so it does not need any extra button configuration beyond the above. + +--8<-- "docs/snippets/konami/common/spicecfg_buttons_additionalinfo.md" + +=== "Analogs" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +=== "Overlay" + +--8<-- "docs/snippets/konami/common/spicecfg_overlay.md" + +=== "Lights" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +=== "Cards" + +--8<-- "docs/snippets/konami/common/spicecfg_cards.md" + +=== "Patches" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +=== "API" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +=== "Options" + +--8<-- "docs/snippets/konami/common/spicecfg_options.md" + + !!! tip "Choose Cab Type" + + Mahjong Fight Girl has multiple cab types. **HG** is currently the only supported cab type. + +=== "Advanced" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +=== "Development" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +## Connecting to a network + +--8<-- "docs/snippets/konami/common/setup_network.md" + +## Installing VCRedist & DirectX + +--8<-- "docs/snippets/common/setup_vcredist_directx.md" + +## Before playing + +--8<-- "docs/snippets/common/before_playing.md" + +## Help + +--8<-- "docs/snippets/common/help.md" diff --git a/docs/games/konami/mfg/troubleshooting.md b/docs/games/konami/mfg/troubleshooting.md new file mode 100644 index 0000000..68268f2 --- /dev/null +++ b/docs/games/konami/mfg/troubleshooting.md @@ -0,0 +1,13 @@ + + +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +!!! info "For any issues not covered here, spice2x's [Known issues](https://github.com/spice2x/spice2x.github.io/wiki/Known-issues) page might prove useful" + +## Technical problems + +??? tip "I can't select anything on screen" + + Make sure your cab type in spicecfg is set to **HG** \ No newline at end of file diff --git a/docs/games/konami/museca/1plushalf/setup.md b/docs/games/konami/museca/1plushalf/setup.md new file mode 100644 index 0000000..4bd5f43 --- /dev/null +++ b/docs/games/konami/museca/1plushalf/setup.md @@ -0,0 +1,152 @@ + +# 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 **2.7 GB**. + + Here's what the expected data structure should look like: + + ``` + 📂data + 📂dev + 📂modules + 📂prop + ``` + +--8<-- "docs/snippets/konami/common/data_bad.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" + + !!! 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, Start` + - **Game buttons:** `Disk# Press (1 to 5), Foot Pedal` + - **P1 Keypad**: `Keypad 0 to 9, Keypad Insert Card` + + **Only if** you play with a keyboard: + + - **Disks:** `Disk#- (1 to 5), Disk#+ (1 to 5)` (`Disk#-` is counter-clockwise, while `Disk#+` is clockwise.) + +--8<-- "docs/snippets/konami/common/spicecfg_buttons_additionalinfo.md" + +=== "Analogs" + + !!! info "This tab is used to bind analog controls like the disks" + + !!! warning "Ignore this tab if you play with a keyboard" + + !!! tip "Bind your controller's disks" + + With a controller, instead of binding your disks in the `Buttons` tab, you need to: + + - Click `Bind` + - In `Device`, pick your controller + - In `Control`, pick the control that updates the preview when turning the corresponding disk + - Click `Close`, leaving the rest of the settings alone + - Repeat for your other disks + +=== "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/common/spicecfg_options.md" + +--8<-- "docs/snippets/konami/common/spicecfg_options_nvprofile.md" + +=== "Advanced" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +=== "Development" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +## Configuring Audio + +--8<-- "docs/snippets/konami/common/setup_audio_wasapiexcl_only.md" + +## Connecting to a network + +--8<-- "docs/snippets/konami/common/setup_network.md" + +## Monitor Orientation + +--8<-- "docs/snippets/konami/common/display_portraitfirst.md" + +## Installing VCRedist & DirectX + +--8<-- "docs/snippets/common/setup_vcredist_directx.md" + +## First launch + +!!! tip "" + + If you've followed all instructions correctly, you're finally ready to launch the game! + + Run `spice64.exe`, press `Yes` when it asks for elevated privileges. + + The game will go through a series of checks, let it run, if you've done everything properly they'll pass. + + + + If you're seeing this screen, it means you need to press the `Test` button to initialize the game's backup data. + + Once the game shows `BACKUP DATA: INITIALIZED`, restart the game. + +!!! success "You're all done! The game should load up properly now" + +## MÚSECA PLUS + +!!! info "Since MÚSECA is no longer receiving official updates, community mods like [MÚSECA PLUS](https://museca.plus/) exist to enhance the game with additional content and English translations" + +## Help + +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/konami/museca/1plushalf/troubleshooting.md b/docs/games/konami/museca/1plushalf/troubleshooting.md new file mode 100644 index 0000000..3eda4f2 --- /dev/null +++ b/docs/games/konami/museca/1plushalf/troubleshooting.md @@ -0,0 +1,66 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +!!! info "For any issues not covered here, spice2x's [Known issues](https://github.com/spice2x/spice2x.github.io/wiki/Known-issues) page might prove useful" + +## Technical Problems + +??? tip "I'm using a laptop with a hybrid internal+dedicated GPU setup" + + Laptops often have odd issues running data. The game may open on the wrong monitor, run at the wrong resolution or framerate, or simply crashes. + + There is currently no known fix for this, other than maybe playing in windowed mode, or using a desktop PC instead. + +### Performance + +!!! info "Check out spice2x's [PC optimization](https://github.com/spice2x/spice2x.github.io/wiki/PC-optimization) guide" + +??? tip "Game is running too slow/fast" + + Your game is likely running at an incorrect framerate. MÚSECA expects the game to run at 60 fps constantly. + + Try these steps to resolve framerate issues: + + - Verify your monitor's refresh ratae is set at exactly 60 Hz. + - Close any software that can affect framerates (like RTSS) + - Close unnecessary background programs + - Ensure V-SYNC is not forcefully disabled in your graphics card control panel + - For NVIDIA users: Enable `NVIDIA profile optimization (-nvprofile)` in spicecfg's `Options` tab + + If issues persist: + + - Double-check that you followed all steps in the [setup guide](setup.md) correctly + - Your PC hardware might be insufficient to keep a steady 60 FPS. Make sure your PC meets the requirements of this game. + - Your data may be corrupt in one way or another, you could try starting from scratch using trusted data sources. + + Your PC may not meet the specifications for MÚSECA. In the arcade, it runs on a Konami PC (ADE-6291): + + - CPU: AMD RX-421BD + + - GPU: Radeon R7 + + - RAM: 4 GB + + - OS: Windows 7 Embedded + +## Audio + +??? tip "I can't hear anything else than the game!" + + Museca only supports [WASAPI exclusive](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) for its audio. This means the game takes exclusive control of your audio device while running, which cannot be changed. + +??? tip "I'm not getting any audio/My audio is completely wrecked and I'm using an external DAC!" + + Many external DACs do not work with [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) and therefore won't function with Museca. Usually, you'll need to use your motherboard's onboard audio or a DAC confirmed to be compatible. + +## FAQ + +??? tip "How to run the game in windowed borderless mode?" + + You'll need to use 3rd party software like [Borderless Gaming](https://github.com/Codeusa/Borderless-Gaming/releases) in order to achieve this. + +??? tip "Can the game be run offline?" + + If your game version is PIX-2018073002, this version supports turning off E-Amusement. In order to do that, change the game code to `J:B:A` (`B` in `prop/ea3-config.xml`), disable/disconnect all network adapters and turn set the E-Amusement setting in the game's operator menu to OFF. diff --git a/docs/games/konami/nostalgia/forte/setup.md b/docs/games/konami/nostalgia/forte/setup.md new file mode 100644 index 0000000..85bf9dd --- /dev/null +++ b/docs/games/konami/nostalgia/forte/setup.md @@ -0,0 +1,91 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Getting Started + +!!! tip "" + Before we even touch the game, let's fiddle with our audio settings to minimize any potential audio issues on startup. In Windows, go to `Playback Devices` and then right click on your default device and go to `Properties`. From there, hit the `Advanced` tab and set your `Default Format` to `44100 Hz` and check both of the options inside `Exclusive Mode` as pictured. + + + +!!! tip "" + Once that's done, it's time to work on setting up your data. + + 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 64-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`. + + + +## 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 ONLY a local network configuration with SpiceTools. Why only local? Because none of the most typical places currently support Nostalgia. Regardless, 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 `spice64.exe -ea -w` and save the file. + + What do these different parameters do? + + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + +## 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 `spice64.exe -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + +## 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 should be automatically forced into the service menu with lots of scary flashing notifications as pictured below, let's work through them. + + + +!!! tip "" + Interestingly, only the red flashing ones really take any effort to deal with. You can start by entering and exiting the following menus: `SOUND OPTIONS`, `GAME OPTIONS`, `COIN OPTIONS`, `ECOMODE OPTIONS`, and `NETWORK OPTIONS`. + + Once you've done that, enter `CLOCK` and set the clock by hitting `SAVE AND EXIT` as pictured below. + + + +!!! tip "" + The final menu we must deal with is `VIRTUAL COIN`, enter the menu and select `OPERATION SETTINGS` as seen below. + + + +!!! tip "" + Once inside this menu, we'll need to deal with all 4 blinking options, let's start by entering the `TAX RATE SETTING` menu, shown below. + + + +!!! tip "" + Set the tax rate by simply selecting `SAVE AND EXIT` while will take us back into the `OPERATING SETTINGS`. Pictured below is the `TAX RATE SETTING` menu. + + + +!!! tip "" + Once back inside the `TAX RATE SETTING` menu, we must deal with the three blinking `PATTERN` options. Doing so is effortless, simply enter all three menus one by one and hit `SAVE AND EXIT` just as we did for the `TAX RATE SETTING` in the previous step. Pictured below is the inside of `PATTERN 1`. + + + +!!! tip "" + After saving and exiting all three `PATTERN` options, you're all done! From the service menu select `GAME MODE` and the game should load ready to be played! Have fun! + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section and [Error Code](/errorcodes/konami.md) section to resolve any issues not seen in this guide to greater depth. diff --git a/docs/games/konami/nostalgia/forte/troubleshooting.md b/docs/games/konami/nostalgia/forte/troubleshooting.md new file mode 100644 index 0000000..d9beb39 --- /dev/null +++ b/docs/games/konami/nostalgia/forte/troubleshooting.md @@ -0,0 +1,44 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Hardware Specs + +!!! tip "" + Konami PC Type 6 (ADE-704A) + + Based on an AMD Embedded R Series SoC. + + CPU: Intel Celeron B810 + + GPU: AMD Radeon E4690 + + OS: Windows 7 Embedded + +### 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. + +### Which Offset Is Which? + +!!! tip "" + If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-). + +### No Matter What I Do, the Game Crashes and I Have Multiple Monitors! + +!!! tip "" + This problem is somewhat irregular, but sometimes Nostalgia has issues booting with multiple monitors present, particularly when trying to boot the game windowed. Make sure you're running the latest SpiceTools which has attempted to resolve all instances of this issue. \ No newline at end of file diff --git a/docs/games/konami/nostalgia/op2/setup.md b/docs/games/konami/nostalgia/op2/setup.md new file mode 100644 index 0000000..079c269 --- /dev/null +++ b/docs/games/konami/nostalgia/op2/setup.md @@ -0,0 +1,91 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Getting Started + +!!! tip "" + Before we even touch the game, let's fiddle with our audio settings to minimize any potential audio issues on startup. In Windows, go to `Playback Devices` and then right click on your default device and go to `Properties`. From there, hit the `Advanced` tab and set your `Default Format` to `44100 Hz` and check both of the options inside `Exclusive Mode` as pictured. + + + +!!! tip "" + Once that's done, it's time to work on setting up your data. + + 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 64-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`. + + + +## 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 ONLY a local network configuration with SpiceTools. Why only local? Because none of the most typical places currently support Nostalgia. Regardless, 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 `spice64.exe -ea -w` and save the file. + + What do these different parameters do? + + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + +## 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 `spice64.exe -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + +## 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 should be automatically forced into the service menu with lots of scary flashing notifications as pictured below, let's work through them. + + + +!!! tip "" + Interestingly, only the red flashing ones really take any effort to deal with. You can start by entering and exiting the following menus: `SOUND OPTIONS`, `GAME OPTIONS`, `COIN OPTIONS`, `ECOMODE OPTIONS`, and `NETWORK OPTIONS`. + + Once you've done that, enter `CLOCK` and set the clock by hitting `SAVE AND EXIT` as pictured below. + + + +!!! tip "" + The final menu we must deal with is `VIRTUAL COIN`, enter the menu and select `OPERATION SETTINGS` as seen below. + + + +!!! tip "" + Once inside this menu, we'll need to deal with all 4 blinking options, let's start by entering the `TAX RATE SETTING` menu, shown below. + + + +!!! tip "" + Set the tax rate by simply selecting `SAVE AND EXIT` while will take us back into the `OPERATING SETTINGS`. Pictured below is the `TAX RATE SETTING` menu. + + + +!!! tip "" + Once back inside the `TAX RATE SETTING` menu, we must deal with the three blinking `PATTERN` options. Doing so is effortless, simply enter all three menus one by one and hit `SAVE AND EXIT` just as we did for the `TAX RATE SETTING` in the previous step. Pictured below is the inside of `PATTERN 1`. + + + +!!! tip "" + After saving and exiting all three `PATTERN` options, you're all done! From the service menu select `GAME MODE` and the game should load ready to be played! Have fun! + +!!! warning "Have any other errors?" + Check out the [Troubleshooting](troubleshooting.md) section and [Error Code](/errorcodes/konami.md) section to resolve any issues not seen in this guide to greater depth. \ No newline at end of file diff --git a/docs/games/konami/nostalgia/op2/troubleshooting.md b/docs/games/konami/nostalgia/op2/troubleshooting.md new file mode 100644 index 0000000..ca7cba1 --- /dev/null +++ b/docs/games/konami/nostalgia/op2/troubleshooting.md @@ -0,0 +1,46 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Hardware Specs + +!!! tip "" + Konami PC Type 6 (ADE-704A) + + Based on an AMD Embedded R Series SoC. + + CPU: Intel Celeron B810 + + GPU: AMD Radeon E4690 + + OS: Windows 7 Embedded + +### 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. + +### Which Offset Is Which? + +!!! tip "" + If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-). + +### No Matter What I Do, the Game Crashes and I Have Multiple Monitors! + +!!! tip "" + This problem is somewhat irregular, but sometimes Nostalgia has issues booting with multiple monitors present, particularly when trying to boot the game windowed. Make sure you're running the latest SpiceTools which has attempted to resolve all instances of this issue. + + diff --git a/docs/games/konami/popn/common/setup.md b/docs/games/konami/popn/common/setup.md new file mode 100644 index 0000000..302b8d0 --- /dev/null +++ b/docs/games/konami/popn/common/setup.md @@ -0,0 +1,124 @@ +# 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 **20 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" + + pop'n music updates have `M39` and one or two datecodes in their archive names. + + **Single datecode:** Contains one update (e.g., `M39_NewDateCode.7z`) + **Two datecodes:** Updates from the older to newer version (e.g., `M39_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/spice2x32_install.md" + + ``` hl_lines="5-6" + 📂data + 📂dev + 📂modules + 📂prop + 🌶️spice.exe + 🌶️spicecfg.exe + ``` + +## Configuring spice2x + +--8<-- "docs/snippets/konami/common/spicecfg_preamble.md" + +=== "Buttons" + +--8<-- "docs/snippets/konami/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**: `1 to 9` + - **P1 Keypad**: `1 to 9, Keypad Insert Card` + +--8<-- "docs/snippets/konami/common/spicecfg_buttons_additionalinfo.md" + +=== "Analogs" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.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" + + !!! tip "We recommend using [popnhax](https://github.com/CrazyRedMachine/popnhax) instead of spice2x patching" + +=== "API" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +=== "Advanced" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +=== "Options" + +--8<-- "docs/snippets/konami/common/spicecfg_options_nvprofile.md" + +=== "Development" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.md" + +## Connecting to a network + +--8<-- "docs/snippets/konami/common/setup_network.md" + +## Before playing + +--8<-- "docs/snippets/common/before_playing.md" + +!!! success "You're all done! The game should load up properly now" + +## Help + +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/konami/popn/common/troubleshooting.md b/docs/games/konami/popn/common/troubleshooting.md new file mode 100644 index 0000000..625b723 --- /dev/null +++ b/docs/games/konami/popn/common/troubleshooting.md @@ -0,0 +1,27 @@ +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +### My game crashes on launch + +!!! tip "" + + Some monitors and display adapters may not support the odd resolution that the game runs at, which is 1360x768 as opposed to the occasionally seen 1366x768. To resolve this, set a custom resolution in your graphics card's settings, or enable GPU resolution scaling. + +### My game is too slow/fast + +!!! tip "" + + Potential causes: + + 1. The game could be running over/under its required refresh rate (60) + To solve this, make sure v-sync isn't disabled in your graphics card's settings. + For NVIDIA users, enable `NVIDIA profile optimization (-nvprofile)` in the `Options` tab. + You can also set `Force Refresh Rate` to 60. + 2. It could be that your computer's performance isn't good enough to keep a steady framerate. + +### My game doesn't have audio + +!!! tip "" + + Enable the `HDMI Audio Fix` patch. \ No newline at end of file diff --git a/docs/games/konami/popn/kaimei_riddles/setup.md b/docs/games/konami/popn/kaimei_riddles/setup.md new file mode 100644 index 0000000..4c993b8 --- /dev/null +++ b/docs/games/konami/popn/kaimei_riddles/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/popn/common/setup.md" \ No newline at end of file diff --git a/docs/games/konami/popn/kaimei_riddles/troubleshooting.md b/docs/games/konami/popn/kaimei_riddles/troubleshooting.md new file mode 100644 index 0000000..b77117a --- /dev/null +++ b/docs/games/konami/popn/kaimei_riddles/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/popn/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/konami/popn/peace/setup.md b/docs/games/konami/popn/peace/setup.md new file mode 100644 index 0000000..77f74c6 --- /dev/null +++ b/docs/games/konami/popn/peace/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/popn/common/setup.md" \ No newline at end of file diff --git a/docs/games/konami/popn/peace/troubleshooting.md b/docs/games/konami/popn/peace/troubleshooting.md new file mode 100644 index 0000000..cd94970 --- /dev/null +++ b/docs/games/konami/popn/peace/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/popn/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/konami/popn/unilab/setup.md b/docs/games/konami/popn/unilab/setup.md new file mode 100644 index 0000000..a0c1e30 --- /dev/null +++ b/docs/games/konami/popn/unilab/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/popn/common/setup.md" \ No newline at end of file diff --git a/docs/games/konami/popn/unilab/troubleshooting.md b/docs/games/konami/popn/unilab/troubleshooting.md new file mode 100644 index 0000000..0c9e0fe --- /dev/null +++ b/docs/games/konami/popn/unilab/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/popn/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/konami/popn/usaneko/setup.md b/docs/games/konami/popn/usaneko/setup.md new file mode 100644 index 0000000..d98ffaf --- /dev/null +++ b/docs/games/konami/popn/usaneko/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/popn/common/setup.md" \ No newline at end of file diff --git a/docs/games/konami/popn/usaneko/troubleshooting.md b/docs/games/konami/popn/usaneko/troubleshooting.md new file mode 100644 index 0000000..e94b60e --- /dev/null +++ b/docs/games/konami/popn/usaneko/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/konami/popn/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/konami/reflecbeat/reflesia/setup.md b/docs/games/konami/reflecbeat/reflesia/setup.md new file mode 100644 index 0000000..0686fda --- /dev/null +++ b/docs/games/konami/reflecbeat/reflesia/setup.md @@ -0,0 +1,70 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Getting Started + +!!! tip "" + + This game still uses DirectSound so we can skip audio related setup needed for other games. After downloading your data, the first thing to do is put your desired 32-bit tools inside the game's `contents` folder, and to create a `.bat` file. Pictured below is what your folder should look like, feel free to name your `.bat` file anything you desire, for the sake of convenience we've named ours `gamestart.bat`. + + + + +## 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 -w` and save the file. + + What do these different parameters do? + + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + +## Configuring for an Online Network + +!!! tip "" + + For our online network example we're simply doing the above but with different parameters! On our single line, we're going to type `spice.exe -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + +!!! 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 "" + + It's important to note before booting the game that Reflec Beat uses portrait mode and attempting to boot the game fullscreen in most landscape environments will result in a crash. To alleviate this, we must set our *main* monitor to portrait mode and be ready to rotate it! To do so, right click on your desktop and go into `Display Settings`, then simply set the orientation to `Portrait`. + + In the event that you do not have the means to run the game in portrait mode and cannot rotate your monitor, it is recommended you boot the game in windowed mode. In SpiceTools, simply add the windowed mode parameter, this parameter is `-w` and can be placed right after any other desired parameters chosen in our `gamestart.bat` + + As for the touch stuff, by default SpiceTools should detect your mouse just fine, you can use the `-s` parameter to have your cursor show at all times above the game window. For touchscreen monitors, it's a bit tricky to write something encompassing them all. Many should be detected automatically, however some may require adding the `-wintouch` parameter for support. + + With that, you're all done! The final step you'll have to do with your chosen tools is simply setting up your desired keybinds! Once you've done that, Boot the game with your `gamestart.bat` and the game should load and be ready to be enjoyed! Have fun! + +## Troubleshooting + +!!! warning "Have any other errors?" + + Check out the [Troubleshooting](troubleshooting.md) and [Error Code](/errorcodes/konami.md) sections to resolve any issues not seen in this guide. diff --git a/docs/games/konami/reflecbeat/reflesia/troubleshooting.md b/docs/games/konami/reflecbeat/reflesia/troubleshooting.md new file mode 100644 index 0000000..d7439d2 --- /dev/null +++ b/docs/games/konami/reflecbeat/reflesia/troubleshooting.md @@ -0,0 +1,47 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Hardware Specs + +!!! tip "" + Konami PC (ADE-704A) + + CPU: Intel Celeron B810 1.6GHz + + GPU: E4690 Radeon MXM + + OS: Windows XP Embedded + +### My Game Doesn't Boot After Following the Guide! + +!!! tip "" + The most common problem present here is if you do not have an E:/ drive. To resolve this issue, you must apply the `E:/drive fix` patch. + +### 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/After Finishing a Song Loading Is Stuck + +!!! 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. + +### Which Offset Is Which? + +!!! tip "" + If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-). + +### Failed to Create Texture Error in SpiceTools + +!!! tip "" + If your error is along the lines of a failure to create a texture W:afputils: CTexture::create_texture テクスチャの作成に失敗しました。 then boot the game without touching anything, even your mouse, maybe give it a few tries, it's admittedly a strange issue with no exact science behind it discovered. + +### I Get a White Screen That Silently Closes After a Few Seconds + +!!! tip "" + Reflesia runs at 768x1360 opposed to more common resolutions. If your monitor doesn't have support for this, try making a custom resolution in your graphic's cards options. Also, make sure your monitor is in portrait mode as opposed to landscape. \ No newline at end of file diff --git a/docs/games/konami/sdvx/4_heavenlyhaven/setup.md b/docs/games/konami/sdvx/4_heavenlyhaven/setup.md new file mode 100644 index 0000000..28bff93 --- /dev/null +++ b/docs/games/konami/sdvx/4_heavenlyhaven/setup.md @@ -0,0 +1,74 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +### Getting Started + +!!! tip "" + + This game still uses DirectSound so we can skip audio related setup needed for other games. After downloading your data, the first thing to do is make sure your files aren't set to READ ONLY, make sure to uncheck it from the main folder in the Windows Properties tab if so. Then, put your desired 32-bit tools inside the game's `contents` folder, and to create a `.bat` file. Pictured below is what your folder should look like, feel free to name your `.bat` file anything you desire, for the sake of convenience we've named ours `gamestart.bat`. + + + + +### 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 -w` and save the file. + + What do these different parameters do? + + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +### Configuring for an Online Network + +!!! tip "" + + For our online network example we're simply doing the above but with different parameters! On our single line, we're going to type `spice.exe -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + + Pictured below, the contents of our `gamestart.bat` file in Notepad++. + + + +!!! 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 "" + + It's important to note before booting the game that Sound Voltex uses portrait mode and attempting to boot the game fullscreen in most landscape environments will result in a crash. To alleviate this, we must set our *main* monitor to portrait mode and be ready to rotate it! To do so, right click on your desktop and go into `Display Settings`, then simply set the orientation to `Portrait`. + + In the event that you do not have the means to run the game in portrait mode and cannot rotate your monitor, it is recommended you boot the game in windowed mode. In SpiceTools, simply add the windowed mode parameter, this parameter is `-w` and can be placed right after any other desired parameters chosen in our `gamestart.bat` + + With that, you're all done! The final step you'll have to do with your chosen tools is simply setting up your desired keybinds! Once you've done that, Boot the game with your `gamestart.bat` and the game should load and be ready to be enjoyed! Have fun! + +!!! warning "Have any other errors?" + + Check out the [Troubleshooting](troubleshooting.md) section and [Error Code](/errorcodes/konami.md) section to resolve any issues not seen in this guide to greater depth. diff --git a/docs/games/konami/sdvx/4_heavenlyhaven/troubleshooting.md b/docs/games/konami/sdvx/4_heavenlyhaven/troubleshooting.md new file mode 100644 index 0000000..b33a211 --- /dev/null +++ b/docs/games/konami/sdvx/4_heavenlyhaven/troubleshooting.md @@ -0,0 +1,44 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Hardware Specs + +!!! tip "" + Konami PC Type 4 + + CPU: Celeron M 440 1.86GHz + + GPU: ATI Radeon HD 2400 + + RAM: 2 GB + + OS: Windows XP Embedded + +### 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/After Finishing a Song Loading Is Stuck + +!!! 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. + +### Which Offset Is Which? + +!!! tip "" + If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-). Please note that Sound Voltex IV's offset is *purely visual* and the game does not have an audio-based offset adjustment. Sound Voltex V however, does. + +### Running the Game Windowed and Borderless + +!!! tip "" + Some players utilizing windowed mode use 3rd party software called [Borderless Gaming](https://github.com/Codeusa/Borderless-Gaming/releases) in order to achieve this, follow the program's instructions accordingly. + +### Where Are All the Navigators? + +!!! tip "" + Many navigators are locked behind network requirements and they will not show unless connected to a network that has written support for the events that they're typically locked behind. \ No newline at end of file diff --git a/docs/games/konami/sdvx/5_vividwave/setup.md b/docs/games/konami/sdvx/5_vividwave/setup.md new file mode 100644 index 0000000..c7ee71f --- /dev/null +++ b/docs/games/konami/sdvx/5_vividwave/setup.md @@ -0,0 +1,74 @@ + +# Game Setup + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Getting Started + +!!! tip "" + + Before we even touch the game, let's fiddle with our audio settings to minimize any potential crashing on startup. In Windows, go to `Playback Devices` and then right click on your default device and go to `Properties`. From there, hit the `Advanced` tab and set your `Default Format` to `44100 Hz` and check both of the options inside `Exclusive Mode` as pictured. + + + +!!! 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 64-bit tools inside the game's `contents` folder, and to create a `.bat` file. Pictured below is what your folder should look like, feel free to name your `.bat` file anything you desire, for the sake of convenience we've named ours `gamestart.bat`. + + + +!!! tip "" + Why does this look different than the usual? This installation includes a `modules` folder that Spice automatically detects, keeping things clean and simple. If your version of the game doesn't have this, it probably has the `contents` folder populated with many different dll files such as the main `soundvoltex.dll`. You should still place your tools here if so! + +## 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 `spice64.exe -ea -w` and save the file. + + What do these different parameters do? + + - `-ea` enables an integrated e-amusement server within SpiceTools. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + +## 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 `spice64.exe -p XXXXXXXXXXXXXXXXXXXX -url http://yoururlhere.com/ -w` and save the file. + + What do these different parameters do? + + - `-p` takes your PCBID on your network of choice, simply replace `XXXXXXXXXXXXXXXXXXXX` with your PCBID. + - `-url` allows you to specify a custom service URL to connect with, simply replace `http://yoururlhere.com/` with your chosen network's URL. + - `-w` will boot the game in windowed mode which will ease our initial setup and testing later, make sure to remove `-w` to run the game fullscreen once you're done setting up! + +!!! 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 "" + + It's important to note before booting the game that Sound Voltex uses portrait mode and attempting to boot the game fullscreen in most landscape environments will result in a crash. To alleviate this, we must set our *main* monitor to portrait mode and be ready to rotate it! To do so, right click on your desktop and go into `Display Settings`, then simply set the orientation to `Portrait`. + + In the event that you do not have the means to run the game in portrait mode and cannot rotate your monitor, it is recommended you boot the game in windowed mode. In SpiceTools, simply add the windowed mode parameter, this parameter is `-w` and can be placed right after any other desired parameters chosen in our `gamestart.bat` + + With that, you're all done! The final step you'll have to do with your chosen tools is simply setting up your desired keybinds! Once you've done that, Boot the game with your `gamestart.bat` and the game should load and be ready to be enjoyed! Have fun! + +!!! warning "Have any other errors?" + + Check out the [Troubleshooting](troubleshooting.md) section and [Error Code](/errorcodes/konami.md) section to resolve any issues not seen in this guide to greater depth. \ No newline at end of file diff --git a/docs/games/konami/sdvx/5_vividwave/troubleshooting.md b/docs/games/konami/sdvx/5_vividwave/troubleshooting.md new file mode 100644 index 0000000..dc7621f --- /dev/null +++ b/docs/games/konami/sdvx/5_vividwave/troubleshooting.md @@ -0,0 +1,72 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/old_guide.md" + +--8<-- "docs/snippets/common/data_warning.md" + +## Hardware Specs + +!!! tip "" + + Konami PC Type 4 + + CPU: Intel i3-4300 3.5GHz + + GPU: Nvidia GeForce GTX 1050 2GB + + RAM: 8GB DDR3L PC3-12800 (4GB*2) + + OS: Windows 7 Embedded + +### 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. + + At the time of writing, some individuals with more than capable PCs have had framerate issues, most notably with Ryzen CPUs. There's really no fix as the issues seem largely random, but it's worth noting regardless to consider trying different computers if you have them available. + +### My Game Is Running Crazy Fast/After Finishing a Song Loading Is Stuck + +!!! 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. + +### Which Offset Is Which? + +!!! tip "" + + If you're getting too many fasts, increase your offset (+). If you're getting too many slows, decrease your offset (-). Sound Voltex V has two types of offset adjustments, visual and audio based, so be sure to fiddle with both to find desirable settings. + +### Running the Game Windowed and Borderless + +!!! tip "" + + Some players utilizing windowed mode use 3rd party software called [Borderless Gaming](https://github.com/Codeusa/Borderless-Gaming/releases) in order to achieve this, follow the program's instructions accordingly. + +### Where Are All the Navigators? + +!!! tip "" + + Many navigators are locked behind network requirements and they will not show unless connected to a network that has written support for the events that they're typically locked behind. + +### A Note About SSE 4.2 + +!!! tip "" + + In the rare case you are running this game on *very* old hardware, SDVX V requires a processor supporting the [SSE 4.2 instruction set](https://en.wikipedia.org/wiki/SSE4#SSE4.2). But, in the event your processor does not have this, there is a patch available to bypass this. + +### When I Run This Game All Other Background Audio Is Gone! What's Going On? + +!!! tip "" + + 64-bit versions of SDVX are now utilizing a feature in Windows called [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) to obtain less audio latency than the former 32-bit versions of the games which used [DirectSound](https://en.wikipedia.org/wiki/DirectSound). You can use the `Shared Mode WASAPI` patch to deal with some hardware issues, it can also be used to hear background audio outside the game so that the game does not take total control. Many have reported that this edit only works when the audio is set to either 16-bit 44100Hz or 24-bit 44100Hz. + +### I'm Not Getting Any Audio/My Audio Is Completely Wrecked and I'm Using an External Dac! + +!!! tip "" + + Several external DACs have issues with [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) and are unable to be used entirely, it's likely you'll be forced to use your motherboard's sound chip, or find a compatible DAC. + + Alongside this, many setups have found some difficulty with audio due to various equipment being used. Consider applying the `Shared Mode WASAPI` patch. diff --git a/docs/games/konami/sdvx/6_exceedgear/extras.md b/docs/games/konami/sdvx/6_exceedgear/extras.md new file mode 100644 index 0000000..9dd400f --- /dev/null +++ b/docs/games/konami/sdvx/6_exceedgear/extras.md @@ -0,0 +1,110 @@ + +# Extra Information + +--8<-- "docs/snippets/common/data_warning.md" + +## Nemsys and Valkyrie modes + +!!! warning "Valkyrie mode requires a 120 Hz capable monitor, or to have patched your `.dll` with `Valkyrie Mode 60 Hz`" + +!!! tip "" + + To make use of the Valkyrie Mode (Subscreen, 120FPS, S-CRITICAL..) you need to go to the `contents\prop` folder and edit the `ea3-config.xml` file. + + We're interested in these lines: + + ```xml + + KFC + J + G + A + 2024052100 + + ``` + + This is the line that determines if the game will run in Nemsys (60 FPS) or Valkyrie (120 FPS) mode. + + ```xml + G + ``` + + Use: + + - ^^`F`^^ for Nemsys + - ^^`G`^^ for Valkyrie + +## Changing the game's language + +!!! tip "" + + Go to the `contents\prop` folder and edit the `ea3-config.xml` file. + + We're interested in these lines: + + ```xml + + KFC + J + G + A + 2024052100 + + ``` + + This is the line that determines which region, and therefore which language the game will use. + + ```xml + J + ``` + + Use: + + - ^^`J`^^ for Japan (Japanese) + - ^^`K`^^ for Korea (Korean + some censored jackets) + - ^^`A`^^ for Asia/Australia (English) + - ^^`U`^^ for America (English + some censoring in recent versions) + - ^^`Y`^^ for Indonesia + +## More about ea3-config.xml + +!!! tip "" + + The `ea3-config.xml` file is located inside the `prop` folder. + + Below is an explanation on what different sections of this file do. + + The following lines change the PCBID and HARDID that your system reports to your e-amusement server. + There is ^^**no need to manually change this**^^ as `spice2x` will do it for us. + + ```xml + 00010203040506070809 + 00010203040506070809 + ``` + + The following line determines what version of the game you are running. + ^^**You should never change this**^^. It should always say `KFC`. + + ```xml + KFC + ``` + + ^^**You should never change this**^^. It should always say `A` for Exceed Gear. + + ```xml + A + ``` + + The following line determines your datecode. + ^^**Always keep it up to date**^^ with your game's current version. + + ```xml + 2024052100 + ``` + + The following line determine what remote service URL `spice2x` is supposed to connect to. + There is ^^**no need to manually change this**^^ as `spice2x` will do it for us. + + ```xml + http://localhost:8083 + ``` \ No newline at end of file diff --git a/docs/games/konami/sdvx/6_exceedgear/setup.md b/docs/games/konami/sdvx/6_exceedgear/setup.md new file mode 100644 index 0000000..80c86ff --- /dev/null +++ b/docs/games/konami/sdvx/6_exceedgear/setup.md @@ -0,0 +1,190 @@ + +# 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 **20 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 + 📂ext + 📂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 + +!!! info "For a comprehensive list of all game updates in chronological order, visit [BemaniWiki](https://bemaniwiki.com/?SOUND+VOLTEX+EXCEED+GEAR#sdvxegvernew)" + +!!! danger "Make sure you're using the right update for your current game version" + + SDVX updates have `KFC` and one or two datecodes in their archive names. + + **Single datecode:** Contains one update (e.g., `KFC_NewDateCode.7z`) + **Two datecodes:** Updates from the older to newer version (e.g., `KFC-OldDateCode-NewDateCode.rar`) + + 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="6-7" + 📂data + 📂dev + 📂ext + 📂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/sdvx/spicecfg_buttons.md" + +--8<-- "docs/snippets/konami/common/spicecfg_buttons_additionalinfo.md" + +=== "Analogs" + +--8<-- "docs/snippets/konami/sdvx/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/common/spicecfg_options.md" + +--8<-- "docs/snippets/konami/common/spicecfg_options_nvprofile.md" + +=== "Advanced" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.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" + +## Monitor Orientation + +--8<-- "docs/snippets/konami/common/display_portraitfirst.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 finally ready to launch the game! + + Run `spice64.exe`, press `Yes` when it asks for elevated privileges. + + The game will go through a series of checks, let it run, if you've done everything properly they'll pass. + + + + If you're seeing this screen, it means you need to calibrate your knobs. + + Press your `Test` key to go to the service menu. + + Instructions on how to navigate the menu are shown at the bottom of the screen: + + - Press `BT-A` to go up + - Press `BT-B` to go down + - Press `Start` to select + + Select `I/O CHECK` and press `Start`. + + + + Select `CALIBRATION SETTINGS` and press `Start`. + + + + + Select `CALIBRATION` and press `Start`. + + First, your left knob (`VOL-L` for keyboard players) + + - **Slowly turn** your **LEFT knob counterclockwise** (`VOL-L Left`) until the line says `COUNT = OK` then press `Start`. + - **Slowly turn** your **LEFT knob clockwise** (`VOL-L Right`) until the line says `COUNT = OK` then press `Start`. + + Now same thing but for the right knob (`VOL-R` for keyboard players) + + - **Slowly turn** your **RIGHT knob counterclockwise** (`VOL-R Left`) until the line says `COUNT = OK` then press `Start`. + - **Slowly turn** your **RIGHT knob clockwise** (`VOL-R Right`) until the line says `COUNT = OK` then press `Start`. + + + + Select `SAVE AND EXIT` and press `Start`. + + + + Select `GAME MODE` and press `Start`. + +!!! success "You're all done! The game should load up properly now" + +## Help + +--8<-- "docs/snippets/common/help.md" diff --git a/docs/games/konami/sdvx/6_exceedgear/troubleshooting.md b/docs/games/konami/sdvx/6_exceedgear/troubleshooting.md new file mode 100644 index 0000000..fc8e21b --- /dev/null +++ b/docs/games/konami/sdvx/6_exceedgear/troubleshooting.md @@ -0,0 +1,141 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +!!! info "For any issues not covered here, spice2x's [Known issues](https://github.com/spice2x/spice2x.github.io/wiki/Known-issues) page might prove useful" + +## Technical problems + +### Crashes + +!!! info "Riva Tuner Statistics Server (RTSS) and MSI Afterburner are known to cause odd crashes.
If you have them installed, close them both before starting any arcade game" + +??? tip "`W:BM2D: CreateLayer() 指定したレイヤーは存在しません` then `EXCEPTION_ACCESS_VIOLATION` in logs" + + - Open `log.txt` using an editor that supports `SHIFT-JIS` encoding for Japanese text (like [Notepad++](https://notepad-plus-plus.org/downloads/)) + + - Look for this error message: `W:BM2D: CreateLayer() 指定したレイヤーは存在しません touch_effect` + *Note: While `touch_effect` is common, the missing resource name may vary* + + If you find it, and it's followed by: `W:signal: exception raised: EXCEPTION_ACCESS_VIOLATION` + + Then there's a **problem with your game data**. + + - Make sure there are no DLL files next to the main game directories (`data`, `prop`, etc.) + If there are, **move them all** under the `modules` directory + + For game version `2024-11-05` and newer, check the following files in your `modules` directory: + + - `afp-core.dll` should be 1,015 KB + - `afp-utils.dll` should be 179 KB + + If the sizes don't match: + + - Redownload `2024110500` and newer updates + - Re-apply all updates in chronological order, always copying **all** DLL files to the `modules` directory + + If the issue isn't resolved by now, **we recommend performing a fresh installation using trusted data sources**. + +??? tip "`W:SuperstepSound: Audio device is not available!!!` in logs" + + - Open `log.txt` using an editor that supports `SHIFT-JIS` encoding for Japanese text (like [Notepad++](https://notepad-plus-plus.org/downloads/)) + + - Search for `Superstep` + + If you find a line with `Audio device is not available!!!`, it means the game refuses to boot due to a misconfigured or missing audio device. + 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" + + Laptops often have odd issues running data. The game may open on the wrong monitor, run at the wrong resolution or framerate, or simply crashes. + + There is currently no known fix for this, other than maybe playing in windowed mode, or using a desktop PC instead. + +### Performance + +!!! info "Check out spice2x's [PC optimization](https://github.com/spice2x/spice2x.github.io/wiki/PC-optimization) guide" + +??? tip "Game is running too slow/fast" + + Your game is likely running at an incorrect framerate. The expected framerates are: + + - Nemsys mode: 60 FPS + - Valkyrie mode: 120 FPS + + Try these steps to resolve framerate issues: + + - Close any software that can affect framerates (like RTSS) + - Close unnecessary background programs + - Ensure V-SYNC is not forcefully disabled in your graphics card control panel + - For NVIDIA users: Enable `NVIDIA profile optimization (-nvprofile)` in spicecfg's `Options` tab + + If issues persist: + + - Double-check that you followed all steps in the [setup guide](setup.md) correctly + - Your PC hardware might be insufficient to keep a steady 120 FPS, you can try to either: + - [Patch](/extras/patchsp2x.md) the game with `Valkyrie Mode 60 Hz` to stick in Valkyrie mode but run at 60 FPS + - [Switch to Nemsys mode](extras.md#nemsys-and-valkyrie-modes) + - Your data may be corrupt in one way or another, you could try starting from scratch using trusted data sources. + +### Audio + +!!! info "Check out our [Audio](/extras/audio.md) guide to understand audio modes better" + +!!! info "Ensure your default audio device's sample rate is set properly" + + - **44100 Hz** sample rate for **WASAPI Exclusive** and **ASIO** + - **48000 Hz** if your game is patched with `Shared Mode WASAPI` + +??? tip "I can't change my device's sample rate" + + If you're using gaming peripherals (Logitech/Razer/Steelseries) or external audio devices (audio interfaces/sound bars): + + - Check if you can modify the sample rate in the device's software/control panel + - If not, try uninstalling the device's software. This may restore control over Windows audio settings + + If you still can't change the sample rate: + + - Configure the game's audio mode to match your device's current sample rate instead + - Try using a different audio device + +??? tip "I can't hear anything else than the game" + + Your game's audio is setup to run in WASAPI Exclusive or ASIO modes. + + Check out our [Audio](/extras/audio.md) guide to understand audio modes better. + + If you're using WASAPI Exclusive, you'll want to [patch the game](/extras/patchsp2x.md) with `Shared Mode WASAPI` to hear other applications. + + If you're using ASIO, unless your audio interface mixes WASAPI and ASIO streams when outputting, you'll only be able to hear one application when ASIO is in use. + In this case, you'll need to route all audio through software such as [Voicemeeter](https://vb-audio.com/Voicemeeter/banana.htm), and have Voicemeeter output the mix to your ASIO device. + +??? tip "Game audio is too quiet/loud" + + - Make sure to not be in a credit as your current progress will be lost + - Bind and press your `Test` key to enter the Test menu + - Go to `SOUND OPTIONS` and change the volume at will + - `SAVE AND EXIT` > `GAME MODE` to return to the game + +### Subscreen + +!!! info "For more in-depth troubleshooting, refer to the spice2x [Subscreen troubleshooting](https://github.com/spice2x/spice2x.github.io/wiki/Configuring-touch-screens-as-subscreen#troubleshooting) page" + +??? tip "Touch input isn't being registered" + + If you're using a physical touch screen, make sure to close **all** spice2x overlays, including the FPS counter. + If you're using the virtual subscreen, ensure that the `-sdvxnativetouch` option is not enabled. + +## FAQ + +??? tip "How to run the game in windowed borderless mode?" + + You'll need to use 3rd party software like [Borderless Gaming](https://github.com/Codeusa/Borderless-Gaming/releases) in order to achieve this. + +??? tip "Where are all the navigators? Why am I missing songs?" + + A lot of content is locked behind events and will not show up unless connected to a network that has written support for these events. + + It may also be that the content is only available in specific regions like Japan and your game is configured with another region. + + You can fix this by [patching](/extras/patchsp2x.md) `Fake Region` to `Japan (J)`. diff --git a/docs/games/konami/sdvx/7_nabla/extras.md b/docs/games/konami/sdvx/7_nabla/extras.md new file mode 100644 index 0000000..96dc135 --- /dev/null +++ b/docs/games/konami/sdvx/7_nabla/extras.md @@ -0,0 +1,114 @@ + +# Extra Information + +--8<-- "docs/snippets/common/data_warning.md" + +!!! warning "Starting with Nabla, Nemsys cabs (60 FPS mode) are no longer officially supported" + + However the F spec and BIO2/Valkyrie 60hz patches still seem to work for the time being, though beware things most likely will break in the future. + +# Nemsys and Valkyrie modes + +!!! warning "Valkyrie mode requires a 120 Hz capable monitor, or to have patched your `.dll` with `Valkyrie Mode 60 Hz`" + +!!! tip "" + + To make use of the Valkyrie Mode (Subscreen, 120FPS, S-CRITICAL..) you need to go to the `contents\prop` folder and edit the `ea3-config.xml` file. + + We're interested in these lines: + + ```xml + + KFC + J + G + A + 2025122401 + + ``` + + This is the line that determines if the game will run in Nemsys (60 FPS) or Valkyrie (120 FPS) mode. + + ```xml + G + ``` + + Use: + + - ^^`F`^^ for Nemsys + - ^^`G`^^ for Valkyrie + +## Changing the game's language + +!!! tip "" + + Go to the `contents\prop` folder and edit the `ea3-config.xml` file. + + We're interested in these lines: + + ```xml + + KFC + J + G + A + 2025122401 + + ``` + + This is the line that determines which region, and therefore which language the game will use. + + ```xml + J + ``` + + Use: + + - ^^`J`^^ for Japan (Japanese) + - ^^`K`^^ for Korea (Korean + some censored jackets) + - ^^`A`^^ for Asia/Australia (English) + - ^^`U`^^ for America (English + some censoring in recent versions) + - ^^`Y`^^ for Indonesia + +## More about ea3-config.xml + +!!! tip "" + + The `ea3-config.xml` file is located inside the `prop` folder. + + Below is an explanation on what different sections of this file do. + + The following lines change the PCBID and HARDID that your system reports to your e-amusement server. + There is ^^**no need to manually change this**^^ as `spice2x` will do it for us. + + ```xml + 00010203040506070809 + 00010203040506070809 + ``` + + The following line determines what version of the game you are running. + ^^**You should never change this**^^. It should always say `KFC`. + + ```xml + KFC + ``` + + ^^**You should never change this**^^. It should always say `A` for Nabla. + + ```xml + A + ``` + + The following line determines your datecode. + ^^**Always keep it up to date**^^ with your game's current version. + + ```xml + 2025122401 + ``` + + The following line determine what remote service URL `spice2x` is supposed to connect to. + There is ^^**no need to manually change this**^^ as `spice2x` will do it for us. + + ```xml + http://localhost:8083 + ``` \ No newline at end of file diff --git a/docs/games/konami/sdvx/7_nabla/setup.md b/docs/games/konami/sdvx/7_nabla/setup.md new file mode 100644 index 0000000..66ef34a --- /dev/null +++ b/docs/games/konami/sdvx/7_nabla/setup.md @@ -0,0 +1,190 @@ + +# 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 **20 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 + 📂ext + 📂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 + +!!! info "For a comprehensive list of all game updates in chronological order, visit [BemaniWiki](https://bemaniwiki.com/?SOUND+VOLTEX+%A2%E0#sdvxnblvernew)" + +!!! danger "Make sure you're using the right update for your current game version" + + SDVX updates have `KFC` and one or two datecodes in their archive names. + + **Single datecode:** Contains one update (e.g., `KFC_NewDateCode.7z`) + **Two datecodes:** Updates from the older to newer version (e.g., `KFC-OldDateCode-NewDateCode.rar`) + + 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="6-7" + 📂data + 📂dev + 📂ext + 📂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/sdvx/spicecfg_buttons.md" + +--8<-- "docs/snippets/konami/common/spicecfg_buttons_additionalinfo.md" + +=== "Analogs" + +--8<-- "docs/snippets/konami/sdvx/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/common/spicecfg_options.md" + +--8<-- "docs/snippets/konami/common/spicecfg_options_nvprofile.md" + +=== "Advanced" + +--8<-- "docs/snippets/konami/common/spicecfg_nochange.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" + +## Monitor Orientation + +--8<-- "docs/snippets/konami/common/display_portraitfirst.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 finally ready to launch the game! + + Run `spice64.exe`, press `Yes` when it asks for elevated privileges. + + The game will go through a series of checks, let it run, if you've done everything properly they'll pass. + + + + If you're seeing this screen, it means you need to calibrate your knobs. + + Press your `Test` key to go to the service menu. + + Instructions on how to navigate the menu are shown at the bottom of the screen: + + - Press `BT-A` to go up + - Press `BT-B` to go down + - Press `Start` to select + + Select `I/O CHECK` and press `Start`. + + + + Select `CALIBRATION SETTINGS` and press `Start`. + + + + + Select `CALIBRATION` and press `Start`. + + First, your left knob (`VOL-L` for keyboard players) + + - **Slowly turn** your **LEFT knob counterclockwise** (`VOL-L Left`) until the line says `COUNT = OK` then press `Start`. + - **Slowly turn** your **LEFT knob clockwise** (`VOL-L Right`) until the line says `COUNT = OK` then press `Start`. + + Now same thing but for the right knob (`VOL-R` for keyboard players) + + - **Slowly turn** your **RIGHT knob counterclockwise** (`VOL-R Left`) until the line says `COUNT = OK` then press `Start`. + - **Slowly turn** your **RIGHT knob clockwise** (`VOL-R Right`) until the line says `COUNT = OK` then press `Start`. + + + + Select `SAVE AND EXIT` and press `Start`. + + + + Select `GAME MODE` and press `Start`. + +!!! success "You're all done! The game should load up properly now" + +## Help + +--8<-- "docs/snippets/common/help.md" diff --git a/docs/games/konami/sdvx/7_nabla/troubleshooting.md b/docs/games/konami/sdvx/7_nabla/troubleshooting.md new file mode 100644 index 0000000..e7ce1b9 --- /dev/null +++ b/docs/games/konami/sdvx/7_nabla/troubleshooting.md @@ -0,0 +1,126 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +!!! info "For any issues not covered here, spice2x's [Known issues](https://github.com/spice2x/spice2x.github.io/wiki/Known-issues) page might prove useful" + +## Technical problems + +### Crashes + +!!! info "Riva Tuner Statistics Server (RTSS) and MSI Afterburner are known to cause odd crashes.
If you have them installed, close them both before starting any arcade game" + +??? tip "`W:BM2D: CreateLayer() 指定したレイヤーは存在しません` then `EXCEPTION_ACCESS_VIOLATION` in logs" + + - Open `log.txt` using an editor that supports `SHIFT-JIS` encoding for Japanese text (like [Notepad++](https://notepad-plus-plus.org/downloads/)) + + - Look for this error message: `W:BM2D: CreateLayer() 指定したレイヤーは存在しません touch_effect` + *Note: While `touch_effect` is common, the missing resource name may vary* + + If you find it, and it's followed by: `W:signal: exception raised: EXCEPTION_ACCESS_VIOLATION` + + Then there's a **problem with your game data**. + + - Make sure there are no DLL files next to the main game directories (`data`, `prop`, etc.) + If there are, **move them all** under the `modules` directory + + If the issue isn't resolved by now, **we recommend performing a fresh installation using trusted data sources**. + +??? tip "`W:SuperstepSound: Audio device is not available!!!` in logs" + + - Open `log.txt` using an editor that supports `SHIFT-JIS` encoding for Japanese text (like [Notepad++](https://notepad-plus-plus.org/downloads/)) + + - Search for `Superstep` + + If you find a line with `Audio device is not available!!!`, it means the game refuses to boot due to a misconfigured or missing audio device. + 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" + + Laptops often have odd issues running data. The game may open on the wrong monitor, run at the wrong resolution or framerate, or simply crashes. + + There is currently no known fix for this, other than maybe playing in windowed mode, or using a desktop PC instead. + +### Performance + +!!! info "Check out spice2x's [PC optimization](https://github.com/spice2x/spice2x.github.io/wiki/PC-optimization) guide" + +??? tip "Game is running too slow/fast" + + Your game is likely running at an incorrect framerate, it expects to run at 120 FPS. + + Try these steps to resolve framerate issues: + + - Close any software that can affect framerates (like RTSS) + - Close unnecessary background programs + - Ensure V-SYNC is not forcefully disabled in your graphics card control panel + - For NVIDIA users: Enable `NVIDIA profile optimization (-nvprofile)` in spicecfg's `Options` tab + + If issues persist: + + - Double-check that you followed all steps in the [setup guide](setup.md) correctly + - Your data may be corrupt in one way or another, you could try starting from scratch using trusted data sources. + - Your PC hardware might be insufficient to keep a steady 120 FPS + +### Audio + +!!! info "Check out our [Audio](/extras/audio.md) guide to understand audio modes better" + +!!! info "Ensure your default audio device's sample rate is set properly" + + - **44100 Hz** sample rate for **WASAPI Exclusive** and **ASIO** + - **48000 Hz** if your game is patched with `Shared Mode WASAPI` + +??? tip "I can't change my device's sample rate" + + If you're using gaming peripherals (Logitech/Razer/Steelseries) or external audio devices (audio interfaces/sound bars): + + - Check if you can modify the sample rate in the device's software/control panel + - If not, try uninstalling the device's software. This may restore control over Windows audio settings + + If you still can't change the sample rate: + + - Configure the game's audio mode to match your device's current sample rate instead + - Try using a different audio device + +??? tip "I can't hear anything else than the game" + + Your game's audio is setup to run in WASAPI Exclusive or ASIO modes. + + Check out our [Audio](/extras/audio.md) guide to understand audio modes better. + + If you're using WASAPI Exclusive, you'll want to [patch the game](/extras/patchsp2x.md) with `Shared Mode WASAPI` to hear other applications. + + If you're using ASIO, unless your audio interface mixes WASAPI and ASIO streams when outputting, you'll only be able to hear one application when ASIO is in use. + In this case, you'll need to route all audio through software such as [Voicemeeter](https://vb-audio.com/Voicemeeter/banana.htm), and have Voicemeeter output the mix to your ASIO device. + +??? tip "Game audio is too quiet/loud" + + - Make sure to not be in a credit as your current progress will be lost + - Bind and press your `Test` key to enter the Test menu + - Go to `SOUND OPTIONS` and change the volume at will + - `SAVE AND EXIT` > `GAME MODE` to return to the game + +### Subscreen + +!!! info "For more in-depth troubleshooting, refer to the spice2x [Subscreen troubleshooting](https://github.com/spice2x/spice2x.github.io/wiki/Configuring-touch-screens-as-subscreen#troubleshooting) page" + +??? tip "Touch input isn't being registered" + + If you're using a physical touch screen, make sure to close **all** spice2x overlays, including the FPS counter. + If you're using the virtual subscreen, ensure that the `-sdvxnativetouch` option is not enabled. + +## FAQ + +??? tip "How to run the game in windowed borderless mode?" + + You'll need to use 3rd party software like [Borderless Gaming](https://github.com/Codeusa/Borderless-Gaming/releases) in order to achieve this. + +??? tip "Where are all the navigators? Why am I missing songs?" + + A lot of content is locked behind events and will not show up unless connected to a network that has written support for these events. + + It may also be that the content is only available in specific regions like Japan and your game is configured with another region. + + You can fix this by [patching](/extras/patchsp2x.md) `Fake Region` to `Japan (J)`. diff --git a/docs/games/namco/taikonijiiro/setup.md b/docs/games/namco/taikonijiiro/setup.md new file mode 100644 index 0000000..679947f --- /dev/null +++ b/docs/games/namco/taikonijiiro/setup.md @@ -0,0 +1,191 @@ + +# Game Setup + +--8<-- "docs/snippets/common/data_warning.md" + +## Preparing data + +!!! tip "" + + Taiko is generally distributed as a single folder. For Nijiiro, this will be `SBWY 39.06`. The game folder should contain an `AMCUS`, `Data` and `Executable` folder. + + + +!!! danger "Nijiiro is a rolling release so please verify your game version by opening `AMCUS\AMConfig.ini` and verifying that it says `cacfg-game_ver=39.06`" + +!!! info "NAMCO data is also distributed as `.VHDX` and `.VHD` files. These files are useful for archival purposes, but are not required to run the game. Always download the unpacked data for home use" + +## Installing TaikoArcadeLoader (TAL) + +!!! tip "TaikoArcadeLoader:" + + `TaikoArcadeLoader` is a loader and hardware emulator for Nijiiro. It will allow us to launch the game, as well as configure inputs and network settings. More information can be found at the [TAL github page](https://github.com/esuo1198/TaikoArcadeLoader). + + - Download the latest version of TAL from [the actions tab](https://github.com/esuo1198/TaikoArcadeLoader/actions) of the TAL page. This will be a file named `TaikoArcadeLoader`. You will need to be logged into github to download this file. + + - Copy the files from `TaikoArcadeLoader.zip` to your `Executable/Release` folder. When asked, choose to replace the existing files with the newly copied files. + + + +## Configuring TaikoArcadeLoader + +!!! tip "" + + The configuration information for TaikoArcadeLoader is stored within `config.toml`. + + Open up `config.toml` with a text editor of your choice. We'll be using [Notepad++](https://notepad-plus-plus.org/). + +!!! info "`config.toml` is separated into several sections, indicated by the section name in `[square brackets]`" + Information for this can be found at the [TAL github page](https://github.com/esuo1198/TaikoArcadeLoader). + +!!! tip "The `[amauth]` section contains network related config" + + - `server =` can be left default if playing on a local server or offline but it is recommend to play on an [online network](#networks). + - `port =` do not change unless you know what you are doing. + - `chassis_id =` do not change unless you know what you are doing. + - `shop_id =` mostly visual. change if you want to. + - `game_ver =` mostly visual. change if you want to. + - `country_code =` do not change unless you know what you are doing. + + ```toml + [amauth] + server = "127.0.0.1" + port = "54430" + chassis_id = "284111080000" + shop_id = "TWO-TORIAL" + game_ver = "39.06" + country_code = "JPN" + ``` + +!!! tip "The `[graphics]` section contains patches" + + - `res =` change to your display's resolution. + - `windowed =` set to `true` if you want to run the game in windowed. + - `cursor =` mostly visual. change if you want to. + - `vsync =` set to `true` if your display is set to 120 Hz. + - `fpslimit =` do not change unless you know what you are doing. + - `model_res_rate =` do not change unless you know what you are doing. + + ```toml + [graphics] + res = { x = 1920, y = 1080 } + windowed = false + cursor = true + vsync = false + # fpslimit = 0 + model_res_rate = 1.0 + ``` + +!!! tip "The `[keyboard]` section contains keyboard related config" + + - `auto_ime =` if set to true, changes your keyboard layout to Qwerty until the game is closed. + - `jp_layout =` should be set to `true` for **actual** japanese keyboards. + + ```toml + [keyboard] + auto_ime = false + jp_layout = false + ``` + +## Configuring Inputs + +!!! tip "" + + Depending on the input method you choose, the configuration for them can change slightly. Below are all the input methods available and how to set them up. + +??? tip "Keyboard" + + Keyboard is the default input method. + + The default layout uses: + + - ++d++++f++ ++j++++k++ for the P1 drum input + - ++z++++x++ ++c++++v++ for the P2 drum input + - ++p++ to `Insert Card` + - ++f2++ to `SERVICE` + - ++enter++ to add coins + + If you wish to view or change all the default keybinds, you can do so in `keyconfig.toml` + +??? tip "Controller" + + The setup for both drum and normal controllers is the same. + + - In `config.toml` set `wait_period =` to `0` + - If you are using a controller that does not use keyboard inputs, you need to set SDL keybinds in `keyconfig.toml` + - When you're using an analog input for the drums, you need to set `analog_input = false` to `true` in `config.toml` + + A list of valid SDL inputs can be found at the bottom of `keyconfig.toml` + + !!! danger "If you're using 2 controllers, use [JoyToKey](https://joytokey.net/en/) and remove SDL inputs from `keyconfig.toml`" + +??? tip "Physical Card Readers" + + You can insert your card with physical card readers. If you happen to have one, you can set them up to use them for Taiko no Tatsujin Nijiiro. + + + ??? tip "AIC Pico" + - In `config.toml` set `card_reader =` to `false`. + - Update to the latest [firmware](https://github.com/whowechina/aic_pico) + - Inside `AMFWConfig.ini` change COM4 to the port of your AIC Pico + + ??? tip "ACR122U" + - In `config.toml` set `card_reader =` to `true`. + - Use AkaiiKitsune's [tal-cardreader plugin](https://gitea.farewell.dev/AkaiiKitsune/tal-cardreader) + +!!! note "If you don't have a physical card reader, you can skip over to the [Networks](#networks) section" + +## Networks + +!!! danger "Please choose one of the two solutions, not both!" + +??? tip "Online Hosted Servers (Recommended)" + + There are a few online hosted servers that support Nijiiro, however most of them are currently invite only. Ask your friends where they play, and maybe they'll invite you! + + **Elara Global Taiko Server** + + [EGTS](https://webui.egts.ca/guide) is the only public Nijiiro server that also comes with an Omnimix verison that includes custom songs and songs from other Taiko games. + +??? tip "Self Hosted Local Servers (Complex)" + + If you wish to run the game locally, but with the ability to create and save a profile, you can run a server on the same computer you are playing the game on. This server will need to be running before you launch the game, however it can be shut down when you are no longer playing. + + Any provided setup instructions are likely to become outdated rather quickly. + + Please refer to the included setup instructions on each projects respective web page. + + - [TLS](https://github.com/asesidaa/TaikoLocalServer/tree/Refactor) - A network service emulator for Nijiiro. Setup can be complex as you are required to build TLS from source using [VisualStudio](https://visualstudio.microsoft.com/) and `.sln` files. + +## Pre-launch requirements + +!!! info "These steps are required, otherwise your game won't run" + +#### VCRedist & DirectX + +!!! tip "" + + - Download and install the latest [VCRedist](https://www.techpowerup.com/download/visual-c-redistributable-runtime-package-all-in-one/) + - Download and install the [DirectX End-User Runtimes](https://www.microsoft.com/en-us/download/details.aspx?id=8109) + +## First Launch + +!!! tip "" + + Run `Taiko.exe` to start the game. + + Enter the I/O setup screen by pressing ++f1++ on the Attract screen then using the `arrow keys` and ++enter++, navigate to `I/O TEST` -> `TAIKO TEST`. Adjust these settings to your liking as they vary between controllers and keyboards. If you are unsure just leave the defaults as is. + + If you would like to adjust patch settings enter the test menu by pressing ++f1++ on the Attract screen then using the `arrow keys` and ++enter++, navigate to `MOD MANAGER`. + + + +!!! tip "" + + You're all done! The game should load up properly now. + +## Troubleshooting + +!!! warning "Have any other issue?" + + Check out the [Troubleshooting](troubleshooting.md) page. \ No newline at end of file diff --git a/docs/games/namco/taikonijiiro/troubleshooting.md b/docs/games/namco/taikonijiiro/troubleshooting.md new file mode 100644 index 0000000..212fcdf --- /dev/null +++ b/docs/games/namco/taikonijiiro/troubleshooting.md @@ -0,0 +1,123 @@ + +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +### Changing the Language + +!!! tip "" + + Nijiiro supports changing the language from the test menu. The officially supported languages are: + + - Japanese (Default) + - English + - Chinese (zh-TW) + - Korean + + An unofficial mod allows you to change the language to Chinese (simplified), this can be found on the [Discord](https://discord.gg/cZRUmEPK78). + + Using ++f1++, the `arrow keys` and ++enter++, navigate to `OTHERS` -> `LANGUAGE` + + + +### My game is frozen/black screen + +!!! tip "" + + You can fix this by running the game as admin. You can also try updating windows and gpu drivers. + +### My game takes a long time to boot + +!!! info "First boot after connecting to a network will be very long (>90s)" + +!!! tip "" + + The game files for Nijiiro consists of thousands of small `.bin` files and Windows Defender is known to spend a long time scanning through them during game boot up. + + One way to massively speed up boot times is to add the entire game folder as a Windows Defender Exception. + + Doing this will prevent Defender from scanning your game folder for viruses. + +!!! danger "Only do this if you trust the source of your data!" + +!!! tip "" + + - Open `Virus & threat protection`. + - Under `Virus & threat protection settings` click the `Manage Settings` button. + - Scroll down to `Exclusions` and click on `Add or remove exclusions`. + - Click the `Add an exclusion` button, select the `folder` option, navigate to the root of your game installation and click `Select Folder`. + + + +### My game is running crazy fast/slow + +!!! tip "" + + The game needs to be ran at 120 FPS or things will break. + + ??? tip "If you have a display that supports 120 Hz or higher" + - Set your display to 120 Hz. You may need to make a [custom resolution](https://customresolutionutility.net/). + - In `config.toml` set `vsync =` to `true`. + + ??? tip "If you have a display that is less than 120 Hz" + - In `config.toml` set `vsync =` to `false` and `windowed =` to `true`. + - Alternatively you can use [RTSS](https://www.guru3d.com/download/rtss-rivatuner-statistics-server-download/). + +### My game is not connected to a network but I set one up + +!!! tip "Disable shop close time or you won't always be able to connect to the network" + + Using ++f1++ `arrow keys` and ++enter++ navigate to `GAME OPTIONS` -> `CLOCK/CLOSE TIME SETTING` -> `SCHEDULE TYPE`. + + + + If you are still unable to connect that means you have incorrectly configured your `config.toml` or your server. + +### My game is still too big/small after setting the resolution in `config.toml` + +!!! tip "" + + This will happen if you incorrectly set your resolution or scale. + + You can check your display resolution by right clicking your desktop and selecting `Display settings`. + + You can set your scale to `100%` right above where it says your resolution. + + + +### My controller is dropping inputs / I can't hit good drumrolls + +!!! tip "" + + This a common issue on some controllers. + + In `config.toml` increase `wait_period =` by 1, then test it in-game and repeat until it feels correct. + +### Best settings for Nvidia GPUs + +!!! tip "" + + This will help with latency and other issues + + In `NVIDIA Control Panel` set the following settings for `Taiko.exe`. + + - Low Latency Mode `Ultra` + - Power management mode `Prefer maximum performance` + - Vertical sync `Fast` + +### Audio + +!!! tip "" + + By default the game will use WASAPI Shared + + To use WASAPI exclusive: + + - Inside `config.toml`, set `wasapi_shared =` to `false` + + To use ASIO: + + - Inside `config.toml`, set `wasapi_shared =` to `false` and set `asio =` to `true`. + - Change `asio_driver =` to `asio_driver = ""` + + For more information refer to the general [Audio](/extras/audio.md) guide. diff --git a/docs/games/sega/chunithm/air/c2c.md b/docs/games/sega/chunithm/air/c2c.md new file mode 100644 index 0000000..87fbd3e --- /dev/null +++ b/docs/games/sega/chunithm/air/c2c.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" diff --git a/docs/games/sega/chunithm/air/controllers.md b/docs/games/sega/chunithm/air/controllers.md new file mode 100644 index 0000000..a61ce8f --- /dev/null +++ b/docs/games/sega/chunithm/air/controllers.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" diff --git a/docs/games/sega/chunithm/air/setup.md b/docs/games/sega/chunithm/air/setup.md new file mode 100644 index 0000000..1e210ce --- /dev/null +++ b/docs/games/sega/chunithm/air/setup.md @@ -0,0 +1,4 @@ + + + +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" diff --git a/docs/games/sega/chunithm/air/troubleshooting.md b/docs/games/sega/chunithm/air/troubleshooting.md new file mode 100644 index 0000000..7f277a1 --- /dev/null +++ b/docs/games/sega/chunithm/air/troubleshooting.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" diff --git a/docs/games/sega/chunithm/airplus/c2c.md b/docs/games/sega/chunithm/airplus/c2c.md new file mode 100644 index 0000000..d699af5 --- /dev/null +++ b/docs/games/sega/chunithm/airplus/c2c.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" diff --git a/docs/games/sega/chunithm/airplus/controllers.md b/docs/games/sega/chunithm/airplus/controllers.md new file mode 100644 index 0000000..bc45855 --- /dev/null +++ b/docs/games/sega/chunithm/airplus/controllers.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" diff --git a/docs/games/sega/chunithm/airplus/setup.md b/docs/games/sega/chunithm/airplus/setup.md new file mode 100644 index 0000000..d7edfaa --- /dev/null +++ b/docs/games/sega/chunithm/airplus/setup.md @@ -0,0 +1,4 @@ + + + +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" diff --git a/docs/games/sega/chunithm/airplus/troubleshooting.md b/docs/games/sega/chunithm/airplus/troubleshooting.md new file mode 100644 index 0000000..d0e6b21 --- /dev/null +++ b/docs/games/sega/chunithm/airplus/troubleshooting.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" diff --git a/docs/games/sega/chunithm/amazon/c2c.md b/docs/games/sega/chunithm/amazon/c2c.md new file mode 100644 index 0000000..6619e79 --- /dev/null +++ b/docs/games/sega/chunithm/amazon/c2c.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" diff --git a/docs/games/sega/chunithm/amazon/controllers.md b/docs/games/sega/chunithm/amazon/controllers.md new file mode 100644 index 0000000..373375c --- /dev/null +++ b/docs/games/sega/chunithm/amazon/controllers.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" diff --git a/docs/games/sega/chunithm/amazon/setup.md b/docs/games/sega/chunithm/amazon/setup.md new file mode 100644 index 0000000..71798ae --- /dev/null +++ b/docs/games/sega/chunithm/amazon/setup.md @@ -0,0 +1,4 @@ + + + +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" diff --git a/docs/games/sega/chunithm/amazon/troubleshooting.md b/docs/games/sega/chunithm/amazon/troubleshooting.md new file mode 100644 index 0000000..37a2bf7 --- /dev/null +++ b/docs/games/sega/chunithm/amazon/troubleshooting.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" diff --git a/docs/games/sega/chunithm/amazonplus/c2c.md b/docs/games/sega/chunithm/amazonplus/c2c.md new file mode 100644 index 0000000..7142d32 --- /dev/null +++ b/docs/games/sega/chunithm/amazonplus/c2c.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" diff --git a/docs/games/sega/chunithm/amazonplus/controllers.md b/docs/games/sega/chunithm/amazonplus/controllers.md new file mode 100644 index 0000000..ce7b15f --- /dev/null +++ b/docs/games/sega/chunithm/amazonplus/controllers.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" diff --git a/docs/games/sega/chunithm/amazonplus/setup.md b/docs/games/sega/chunithm/amazonplus/setup.md new file mode 100644 index 0000000..e781622 --- /dev/null +++ b/docs/games/sega/chunithm/amazonplus/setup.md @@ -0,0 +1,4 @@ + + + +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" diff --git a/docs/games/sega/chunithm/amazonplus/troubleshooting.md b/docs/games/sega/chunithm/amazonplus/troubleshooting.md new file mode 100644 index 0000000..c82d5cb --- /dev/null +++ b/docs/games/sega/chunithm/amazonplus/troubleshooting.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" diff --git a/docs/games/sega/chunithm/chunithm/c2c.md b/docs/games/sega/chunithm/chunithm/c2c.md new file mode 100644 index 0000000..ea9edc1 --- /dev/null +++ b/docs/games/sega/chunithm/chunithm/c2c.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/c2c.md" diff --git a/docs/games/sega/chunithm/chunithm/controllers.md b/docs/games/sega/chunithm/chunithm/controllers.md new file mode 100644 index 0000000..03cf06e --- /dev/null +++ b/docs/games/sega/chunithm/chunithm/controllers.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/controllers.md" diff --git a/docs/games/sega/chunithm/chunithm/setup.md b/docs/games/sega/chunithm/chunithm/setup.md new file mode 100644 index 0000000..4c0fa03 --- /dev/null +++ b/docs/games/sega/chunithm/chunithm/setup.md @@ -0,0 +1,4 @@ + +!!! warning "Warning" + This guide is for the original version of CHUNITHM released in 2015. If you want to run a newer version, please find and follow the right guide. +--8<-- "docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/chunithm/troubleshooting.md b/docs/games/sega/chunithm/chunithm/troubleshooting.md new file mode 100644 index 0000000..e5afbc8 --- /dev/null +++ b/docs/games/sega/chunithm/chunithm/troubleshooting.md @@ -0,0 +1,3 @@ + + +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" diff --git a/docs/games/sega/chunithm/common/chuni/c2c.md b/docs/games/sega/chunithm/common/chuni/c2c.md new file mode 100644 index 0000000..17d3584 --- /dev/null +++ b/docs/games/sega/chunithm/common/chuni/c2c.md @@ -0,0 +1,45 @@ +# Cab-to-Cab over Internet + +--8<-- "docs/snippets/common/data_warning.md" + +!!! danger "You are most likely to have success with Multiplayer when all users are using the SAME data and options, from the same sources. Verify that each person can run the game normally before attempting to network them together" + +## Initial setup + +!!! tip "Network" + + Every machine needs to be on the same LAN. + If you wish to achieve that over the internet, follow the [ZeroTier setup guide](/extras/zerotier.md). + +!!! tip "GAME ASSIGNMENTS" + + - Open the Service Menu and navigate to `GAME ASSIGNMENTS` + + + - Make sure all machines are on the same group (Group A for example) + + + - Set one machine to `STANDARD`, and all other machines to `FOLLOW THE STANDARD` + + + + Exit the Service Menu and load into Attract Mode. If the game passes the Group Check then chances are you're good to go! You can now login to a credit and open a cab-to-cab link request to check if the connection is working properly. + +## How to link? + +!!! Info "If you're new to CHUNITHM and have never tried link-play before and you have no idea how, keep reading" + + - Login to a credit + + - If you're hosting a cab-to-cab session, choose a song first, then scroll to the far left and press `Confirm` + The cab-to-cab request is now open + + + - If you're connecting, navigate to the `Cabinet-to-Cabinet Play` tab and wait for other players to create a session + + + If you are able to see each other's session, congrats! You can now enjoy some cab-to-cab chain action! + +## Help + +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/common/chuni/controllers.md b/docs/games/sega/chunithm/common/chuni/controllers.md new file mode 100644 index 0000000..6fac4b2 --- /dev/null +++ b/docs/games/sega/chunithm/common/chuni/controllers.md @@ -0,0 +1,124 @@ +# Controllers + +--8<-- "docs/snippets/common/data_warning.md" + +!!! tip "" + + segatools, by default, only accepts keyboard input and does not recognize any + controllers. However, it can be configured with an IO DLL to add support for controllers. + + The controller you plan on using should also be provided with an IO DLL. If unsure, + check the support section for your controller, or contact the vendor directly. Alternate + options for the most common controllers are listed below. + + These IO DLLs should be copied to your game's `App\bin\` folder and referenced in + `segatools.ini` under the `[chuniio]` section. + +!!! tip "" + + To add your IO DLL, ncomment the `path=` line by removing the leading semicolon (`;`), + then add your DLL's file name after the `=`: + + ```ini hl_lines="4" + [chuniio] + ; To use a custom Chunithm IO DLL enter its path here. + ; Leave empty if you want to use Segatools built-in keyboard input. + path=controller.dll + ``` + + 1. Note that there is no leading semicolon. + +### Keyboard + +!!! tip "" + + Keyboard is the default input method, and while not recommended for playing the game, + it is useful for testing purposes. + + The default layout uses `SDFGHJKL` for slider input, and `Space Bar` for the AIRs. + + If you wish to change the default keybinds, an explanation on how to set these is included + above the `[io3]` section in your `segatools.ini`. + +### TASOLLER + +!!! tip "" + + - Install the [custom Host and LED firmware](https://pixeldrain.com/u/DajSPEoa) to your controller. + Instructions on how to do so is provided in the linked archive. + - Download the TASOLLER IO DLL corrosponding to your firmware version and extract to your `App\bin` folder. + - [chuniio-rs](https://gitea.tendokyu.moe/beerpsi/chuniio-rs/releases) (download `chuni.zip`) + - Edit your `App\bin\segatools.ini` to reference the extracted DLLs: + + ```ini + [chuniio] + path=chuniio_tasoller_v2.dll + ``` + + - Connect the controller to your computer, and then start the game. + +### TASOLLER PLUS + +!!! tip "" + + - Switch your TASOLLER PLUS to WINUSB mode. You can do so in TASOLLER Options + found on the djdao [support page](https://www.dj-dao.com/en/support/22.html). + - Download TASOLLER PLUS IO DLLs and extract to your `App\bin` folder. + - [chuniio-rs](https://gitea.tendokyu.moe/beerpsi/chuniio-rs/releases) (download `chuni.zip`) + - Edit your `App\bin\segatools.ini` to reference the extracted DLLs: + + ```ini + [chuniio] + path=chuniio_tasoller_plus.dll + ``` + + - Connect the controller to your computer, and then start the game. + +### YubiDeck + +!!! tip "" + + - Switch your YubiDeck to HID output mode. Instructions on how to do so are provided + in the [YubiDeck manual](https://drive.google.com/file/d/11KVlKbg3zGCRwI7R-30t2IJc6OQwDEgo/view). + - Download the latest **chuni** version of [YubiDeck IO DLLs](https://gitea.tendokyu.moe/beerpsi/chuniio-yubideck/releases) + and extract it to your `App\bin` folder. + - Edit your `App\bin\segatools.ini` to reference the extracted DLLs: + + ```ini + [chuniio] + path=chuniio_yubideck_v3.dll + ``` + + - Optionally, reference the included AimeIO DLL to use the controller's + built-in card reader: + + ```ini + [aimeio] + path=aimeio_yubideck_v3.dll + ``` + + - Connect the controller to your computer, and then start the game. + +### Laverita 3 + +!!! tip "" + + - Switch your Laverita to HID mode. You can do so in ConfigApp + - Download Laverita IO DLLs and extract to your `App\bin` folder. + - [chuniio-rs](https://gitea.tendokyu.moe/beerpsi/chuniio-rs/releases) (download `chuni.zip`) + - Edit your `App\bin\segatools.ini` to reference the extracted DLLs: + + ```ini + [chuniio] + path=chuniio_laverita_v3.dll + ``` + + - Connect the controller to your computer, and then start the game. + +### Arcade hardware and other controllers + +!!! tip "" + + If you're interested in using a cabinet slider and air sensors, or possibly even + making your own controller, the [Cons&Stuff website](https://consandstuff.github.io/) + and Discord community is a great place to start! diff --git a/docs/games/sega/chunithm/common/chuni/setup.md b/docs/games/sega/chunithm/common/chuni/setup.md new file mode 100644 index 0000000..36f4553 --- /dev/null +++ b/docs/games/sega/chunithm/common/chuni/setup.md @@ -0,0 +1,172 @@ +# Game Setup + +--8<-- "docs/snippets/common/data_warning.md" + +--8<-- "docs/snippets/sega/common/data_old.md" + +## Preparing data + +--8<-- "docs/snippets/sega/common/data_driveletter.md" + +--8<-- "docs/snippets/common/data_readonly.md" + +--8<-- "docs/snippets/sega/common/data_preparation.md" + + ``` + 📂bin + 📂data + 📂firm + 📂startup + 📄firewall.cfg + ▶️game.bat + ▶️oxGetHwInfo.exe + 📝oxGetHwInfo.ini + ``` + +--8<-- "docs/snippets/sega/common/data_bad.md" + +## Updating data + +--8<-- "docs/snippets/sega/common/data_updating.md" + +## Installing option data + +--8<-- "docs/snippets/sega/chunithm/data_options.md" + +## Installing unprotected executables + +!!! 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 `chuniApp.exe` and `aimeReaderHost.exe` for your game version. + + - Copy `chuniApp.exe` and `aimeReaderHost.exe` to data's `App\bin` folder + - Agree to overwrite when asked + +## Installing ICFs + +--8<-- "docs/snippets/sega/common/data_icfs.md" + +## Patching the game + +--8<-- "docs/snippets/sega/common/patching.md" + +| Patch | Recommendation | Description | +|------------------------------|----------------|-------------| +| Disable shop close lockout | Either | Disables the shop lockout from 12 to 8PM JST. | +| Force shared audio mode | Either | Force the game to use shared mode audio output, letting you listen to other audio sources while the game is running **at the cost of audio latency.** | +| Force 2 channel audio output | Either | Try enabling this patch if you don't get audio output at all. | +| Disable song select timer | Either | Disables the song select timer. | +| No encryption | ON | Disable encrypting network requests. **Required if you plan to run a local server.** | +| No TLS | ON | Disable checking if the server is `HTTPS` or not. **Required if you plan to run a local server.** | + +## Installing segatools + +--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 these files added to your `App\bin` directory: + + ``` + 📂DEVICE + ⚙️chunihook.dll + ▶️inject.exe + 📝segatools.ini + ▶️launch.bat + ``` + +## Configuring segatools + +!!! tip "" + +--8<-- "docs/snippets/sega/common/segatools_preamble_bin.md" + +=== "[vfs]" + +--8<-- "docs/snippets/sega/common/segatools_relativepaths.md" + +--8<-- "docs/snippets/sega/common/segatools_vfs.md" + +=== "[gfx]" + +--8<-- "docs/snippets/sega/chunithm/segatools_gfx.md" + +## Configuring audio + +--8<-- "docs/snippets/common/audio_48khz.md" + +## Connecting to a network + +--8<-- "docs/snippets/sega/common/network_preamble.md" + +--8<-- "docs/snippets/sega/common/network_remote.md" + +--8<-- "docs/snippets/sega/common/network_local_artemisonly.md" + +## Installing VCRedist & DirectX + +--8<-- "docs/snippets/common/setup_vcredist_directx.md" + +## Before playing + +--8<-- "docs/snippets/common/before_playing.md" + +## First launch + +--8<-- "docs/snippets/sega/common/service_jp_googlelens.md" + +!!! tip "" + + If you've followed all instructions correctly, you're now finally ready to launch the game! + + Start the game by running `App\bin\launch.bat`. Let the game load until it reaches the screen below. + + + + Press your `Test` button (default `F1`) to enter the service menu. Use the `Service` button + (default `F2`) to navigate the menu, and `Test` button to select an option. + + Navigate to **ゲーム設定** (`GAME ASSIGNMENTS`, the fourth option). + + + + Select **配信サーバー設定** (`DISTRIBUTION SEVER SETTING`, the first option) + and toggle this setting to **サーバー** (`SERVER`). + + Select **筐体グループ設定** (`CABINET GROUP SETTINGS`, the second option) + and toggle this setting to **OFF**. + + + + Select **終了** (`EXIT`, the last option) to exit to the main service menu. + + Select **はい** (`YES`) and select **閉じる** + + + + + + After this, your game will close. Open it back up, and enter the service menu again. + + Navigate to **閉店設定** (`CLOSE SETTING`, the tenth option). + + + + Navigate to **時** (`HOUR`, the second option) and use the `Service` button + to toggle the setting until it says **全時刻** (`ALL TIME`). + + + + 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. + + If you're stuck at the `Waiting for Distribution Server` screen below, close the game and relaunch. + + + +--8<-- "docs/snippets/sega/common/success.md" + +## Help + +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md b/docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md new file mode 100644 index 0000000..d8acd50 --- /dev/null +++ b/docs/games/sega/chunithm/common/chuni/setup_belowcrystal.md @@ -0,0 +1,157 @@ +# Game Setup + +--8<-- "docs/snippets/common/data_warning.md" + +--8<-- "docs/snippets/sega/common/data_old.md" + +## Preparing data + +--8<-- "docs/snippets/sega/common/data_driveletter.md" + +--8<-- "docs/snippets/common/data_readonly.md" + +--8<-- "docs/snippets/sega/common/data_preparation.md" + + ``` + 📂bin + 📂data + 📂firm + 📂startup + 📄firewall.cfg + ▶️game.bat + ▶️oxGetHwInfo.exe + 📝oxGetHwInfo.ini + ``` + +--8<-- "docs/snippets/sega/common/data_bad.md" + +## Updating data + +--8<-- "docs/snippets/sega/common/data_updating.md" + +## Installing option data + +--8<-- "docs/snippets/sega/chunithm/data_options.md" + +## Installing ICFs + +--8<-- "docs/snippets/sega/common/data_icfs.md" + +## Patching the game + +--8<-- "docs/snippets/sega/common/patching.md" + +| Patch | Recommendation | Description | +|------------------------------|----------------|-------------| +| Disable shop close lockout | Either | Disables the shop lockout from 12 to 8PM JST. | +| Force shared audio mode | Either | Force the game to use shared mode audio output, letting you listen to other audio sources while the game is running **at the cost of audio latency.** | +| Force 2 channel audio output | Either | Try enabling this patch if you don't get audio output at all. | +| Disable song select timer | Either | Disables the song select timer. | + +## Installing segatools + +--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 these files added to your `App\bin` directory: + + ``` + 📂DEVICE + ⚙️chunihook.dll + ▶️inject.exe + 📝segatools.ini + ▶️launch.bat + ``` + +## Configuring audio + +--8<-- "docs/snippets/common/audio_48khz.md" + +## Configuring segatools + +--8<-- "docs/snippets/sega/common/segatools_preamble_bin.md" + +=== "[vfs]" + +--8<-- "docs/snippets/sega/common/segatools_vfs.md" + +=== "[gfx]" + +--8<-- "docs/snippets/sega/chunithm/segatools_gfx.md" + +## Connecting to a network + +--8<-- "docs/snippets/sega/common/network_preamble.md" + +--8<-- "docs/snippets/sega/common/network_remote.md" + +--8<-- "docs/snippets/sega/common/network_local_artemisonly.md" + +## Installing VCRedist & DirectX + +--8<-- "docs/snippets/common/setup_vcredist_directx.md" + +## Before playing + +--8<-- "docs/snippets/common/before_playing.md" + +## First launch + +--8<-- "docs/snippets/sega/common/service_jp_googlelens.md" + +!!! tip "" + + If you've followed all instructions correctly, you're now finally ready to launch the game! + + Start the game by running `App\bin\launch.bat`. Let the game load until it reaches the screen below. + + + + Press your `Test` button (default `F1`) to enter the service menu. Use the `Service` button + (default `F2`) to navigate the menu, and `Test` button to select an option. + + Navigate to **ゲーム設定** (`GAME ASSIGNMENTS`, the fourth option). + + + + Select **配信サーバー設定** (`DISTRIBUTION SEVER SETTING`, the first option) + and toggle this setting to **サーバー** (`SERVER`). + + Select **筐体グループ設定** (`CABINET GROUP SETTINGS`, the second option) + and toggle this setting to **OFF**. + + + + Select **終了** (`EXIT`, the last option) to exit to the main service menu. + + Select **はい** (`YES`) and select **閉じる** + + + + + + After this, your game will close. Open it back up, and enter the service menu again. + + Navigate to **閉店設定** (`CLOSE SETTING`, the tenth option). + + + + Navigate to **時** (`HOUR`, the second option) and use the `Service` button + to toggle the setting until it says **全時刻** (`ALL TIME`). + + + + 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/success.md" + +## Help + +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/common/chuni/troubleshooting.md b/docs/games/sega/chunithm/common/chuni/troubleshooting.md new file mode 100644 index 0000000..1eb5b28 --- /dev/null +++ b/docs/games/sega/chunithm/common/chuni/troubleshooting.md @@ -0,0 +1,80 @@ +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +### My game takes a long time to boot! + +!!! tip "" + + CHUNITHM game files consist of thousands of small XML files, which Windows Defender + takes a long time to scan through. Add your game folder to the Windows Defender + exclusion list. + +!!! danger + + Doing this will prevent Windows Defender from scanning your game folder for viruses. + Only do this if you trust the source of the data. + +### My game is running too slow/fast + +!!! tip "" + + The game could be running under or over its required refresh rate. + + - Make sure V-Sync isn't disabled in your graphics settings (called "Vertical sync" + in NVIDIA Control Panel and "Wait for Vertical Refresh" in AMD Control Panel.) + - Make sure your monitor's refresh rate is set to 60Hz. + + It could also be that your computer's performance isn't good enough to keep + a steady framerate. + +### My game is stuttering + +!!! tip "" + + For NVIDIA users, create an override for `chuniApp.exe` in NVIDIA Control Panel + and change "Power management mode" to "**Prefer maximum performance**". + +### My game crashes when I tab out of fullscreen! + +!!! tip "" + + As the game is intended to run on arcade hardware, it doesn't like being minimized. + + One workaround for this is to use DXVK. Download the latest version from [releases](https://github.com/doitsujin/dxvk/releases/latest). + This will be a `dxvk-x.y.z.tar.gz` file, which you can open using [7zip](https://www.7-zip.org/). + Navigate to the `x32` folder, and copy the `d3d9.dll` file to your game's `App\bin` folder, agreeing + to overwrite when asked. + + You should now be able to tab out of fullscreen without crashing the game. + +!!! warning + + The game will not ignore inputs when out of focus. + + This means any controller inputs will still be accepted, so try not to lean onto + your slider whilst tabbed out! + + This also means that you can accidentally enter the service menu by hitting your + `Test` key even if the game is minimised. If you were in the middle of a credit, + **your scores will be lost.** + +### When I run the game all other audio is gone! + +!!! tip "" + + CHUNITHM uses [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) + for audio to get better latency. + + You can apply the "Shared Audio" patch on a CHUNITHM web patcher (see [Resources](/resources.md#web-patchers)) + to hear audio outside of the game at the cost of audio latency. + +### Cabinet-to-Cabinet(c2c) Fixes + +!!! tip "" + + c2c can have many problems but you can fix most of them by applying the "Patch for head-to-head play" and disabling "Set all timers to 999" on a CHUNITHM web patcher (see [Resources](/resources.md#web-patchers)). + + If the above does not work then please ensure both machines have the exact same data and can communicate with each other if they cannot then you can try disabling firewalls or changing the c2c group. + + If clicking the c2c button does nothing, you can fix it by resetting the network settings in Windows. diff --git a/docs/games/sega/chunithm/common/chusan/c2c.md b/docs/games/sega/chunithm/common/chusan/c2c.md new file mode 100644 index 0000000..c1b1464 --- /dev/null +++ b/docs/games/sega/chunithm/common/chusan/c2c.md @@ -0,0 +1,45 @@ +# Cab-to-Cab over Internet + +--8<-- "docs/snippets/common/data_warning.md" + +!!! danger "You are most likely to have success with Multiplayer when all users are using the SAME data and options, from the same sources. Verify that each person can run the game normally before attempting to network them together" + +## Initial setup + +!!! tip "Network" + + Every machine needs to be on the same LAN. + If you wish to achieve that over the internet, follow the [ZeroTier setup guide](/extras/zerotier.md). + +!!! tip "GAME ASSIGNMENTS" + + - Open the Service Menu and navigate to `GAME ASSIGNMENTS` + + + - Make sure all machines are on the same group (Group A for example) + + + - Set one machine to `STANDARD`, and all other machines to `FOLLOW THE STANDARD` + + + + Exit the Service Menu and load into Attract Mode. If the game passes the Group Check then chances are you're good to go! You can now login to a credit and open a cab-to-cab link request to check if the connection is working properly! + +## How to link? + +!!! Info "If you're new to CHUNITHM and have never tried link-play before and you have no idea how, keep reading" + + - Login to a credit + + - If you're hosting a cab-to-cab session, choose a song first, then scroll to the far left and press `Confirm` + The cab-to-cab request is now open + + + - If you're connecting, navigate to the `Cabinet-to-Cabinet Play` tab and wait for other players to create a session + + + If you are able to see each other's session, congrats! You can now enjoy some cab-to-cab chain action! + +## Help + +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/common/chusan/controllers.md b/docs/games/sega/chunithm/common/chusan/controllers.md new file mode 100644 index 0000000..ba7e338 --- /dev/null +++ b/docs/games/sega/chunithm/common/chusan/controllers.md @@ -0,0 +1,376 @@ +# Controllers + +--8<-- "docs/snippets/common/data_warning.md" + +!!! tip "" + + segatools, by default, only accepts keyboard input and does not recognize any + controllers. However, it can be configured with IO DLLs to add support for controllers. + + The controller you plan on using should also be provided with these IO DLLs. If unsure, + check the support section for your controller, or contact the vendor directly. Alternate + options for the most common controllers are listed below. + + These IO DLLs should be copied to your game's `App\bin\` folder and referenced in + `segatools.ini` under the `[chuniio]` section. + +!!! tip "" + + If you have a single DLL, uncomment the `path=` line by removing the leading semicolon (`;`), + then add your DLL's file name after the `=`: + + ```ini hl_lines="5" + [chuniio] + ; Uncomment this if you have custom chuniio implementation comprised of a single 32bit DLL. + ; (will use chu2to3 engine internally) + ;(1)! + path=controller.dll + ``` + + 1. Note that there is no leading semicolon. + +!!! tip "" + + If you have two DLLs, ending in `_x86.dll` and `_x64.dll` (or `_chusan.dll` and `_amdaemon.dll`), + uncomment the `path32=` and `path64=` lines by removing the leading semicolon (`;`), then + add your DLLs after the `=`: + + ```ini hl_lines="5 6" + [chuniio] + ; Uncomment both of these if you have custom chuniio implementation comprised of two DLLs. + ; x86 chuniio to path32, x64 to path64. Both are necessary. + ;(1)! + path32=controller_x86.dll + path64=controller_x64.dll + ``` + + 1. Note that there is no leading semicolon. + +### Keyboard + +!!! tip "" + + Keyboard is the default input method, and while not recommended for playing the game, + it is useful for testing purposes. + + The default layout uses `SDFGHJKL` for slider input, and `Space Bar` for the AIRs. + + If you wish to change the default keybinds, an explanation on how to set these is included + above the `[io3]` section in your `segatools.ini`. + +### Brokenithm + +!!! tip "" + + Brokenithm allows you to use a mobile device as a CHUNITHM controller. It uses the bottom + half of the screen as the ground slider, and sliding into the upper half activates the air + sensors. + +#### Android + +!!! warning + + Your computer and your Android device must be on the same local network. + +!!! tip "" + + - Download the latest version of [Brokenithm-Android](https://github.com/tindy2013/Brokenithm-Android/releases/latest) + and install it on your Android device. + - Download the latest version of [Brokenithm-Android-Server](https://github.com/tindy2013/Brokenithm-Android-Server/releases/latest) + and extract **only `brokenithm_server.exe`** to your `App\bin\` folder. + - Download the latest version of [Brokenithm-Evolved IO DLLs](https://gitea.tendokyu.moe/Dniel97/Brokenithm-Evolved/releases) and extract the DLL files to your `App\bin\` folder. + - Edit your `App\bin\segatools.ini` to reference the extracted DLLs: + + ```ini hl_lines="2" + [aimeio] + path=aime_brokenithm.dll + ``` + + ```ini hl_lines="2 3" + [chuniio] + path32=brokenithm_x86.dll + path64=brokenithm_x64.dll + ``` + + - Run `brokenithm_server.exe`. A command prompt window should open, saying that + it is waiting for a device on port 52468. + - Open the Brokenithm app on your Android device. Enter your computer's IP address + in the Address box on the top right, then tap Start. + - Run the game as normal. + +??? info "Getting your computer's IP address" + + Open **Settings** -> **Network and Internet** and select **Properties**. Scroll down to + the bottom and check the address under the **IPv4 address** field: + + + + That is your computer's IP address. + +??? info "Automatically launching the Brokenithm server when starting the game" + + **This will only work if you extracted `brokenithm_server.exe` to `App\bin\` as previously instructed.** + + You can edit the launch script to launch the Brokenithm server when starting the game. + Edit `App\bin\launch.bat` to add a line above the existing commands: + + ```batch hl_lines="5" + @echo off + + pushd %~dp0 + + start /min brokenithm_server + start /min inject_x64 -d -k chusanhook_x64.dll amdaemon.exe -c config_common.json config_server.json config_client.json config_cvt.json config_sp.json config_hook.json + inject_x86 -d -k chusanhook_x86.dll chusanApp.exe + taskkill /f /im amdaemon.exe > nul 2>&1 + + echo. + echo Game processes have terminated + pause + ``` + +??? info "Improving latency" + + You can improve latency by running Brokenithm with your Android device tethered to + your computer. However, this requires a little extra setup: + + - Connect your Android device to your computer with a USB cable. + - If you haven't enabled Developer options on your device, do it by navigating to + the "About" page in your phone's settings, then tap "Build number" seven times. + This varies by device, so if unsure, look up the instructions for your specific + one. + - Navigate to Developer options and enable USB debugging. + - On your computer, download and extract [Android SDK Platform Tools](https://dl.google.com/android/repository/platform-tools-latest-windows.zip) + to your `App\bin\` folder. + - Navigate to the `App\bin\platform-tools` folder in File Explorer, click on the + address bar, type `cmd`, and hit Enter to open a command prompt. + - In the command prompt, type the following command: + + ```batch + adb reverse tcp:52468 tcp:52468 + ``` + + - Start brokenithm_server in TCP mode with the -T command line flag, `brokenithm_server.exe -T`. + - On your Android device, open Brokenithm, and change the address to `0.0.0.0`. + - If the text box to the left of the "SETTINGS" button say "UDP", tap on it + once to switch to "TCP" mode. + - Tap on "START", and you will now be connected via the USB cable. + - You can now start the game as normal. + + The next time you play the game, you only need to run the `adb reverse ...` command + again. To do this automatically when the game starts, add a line to the `launch.bat` + script **before** the `brokenithm_server` line: + + ```batch hl_lines="5 6" + @echo off + + pushd %~dp0 + + start /min platform-tools\adb reverse tcp:52468 tcp:52468 + start /min brokenithm_server -T + start /min inject_x64 -d -k chusanhook_x64.dll amdaemon.exe -c config_common.json config_server.json config_client.json config_cvt.json config_sp.json config_hook.json + inject_x86 -d -k chusanhook_x86.dll chusanApp.exe + taskkill /f /im amdaemon.exe > nul 2>&1 + + echo. + echo Game processes have terminated + pause + ``` + +#### iOS/iPadOS + +!!! tip "" + + - Install Brokenithm on your iOS/iPadOS device by joining the [Brokenithm TestFlight](https://testflight.apple.com/join/U6kwvETm) ^^(iOS 18 only)^^. + - If your iOS/iPadOS device doesn't have iOS 18, you will need to sideload a different [IPA](https://redive.estertion.win/ipas/Brokenithm-iOS-build-10.ipa) with [Sideloadly](https://sideloadly.io/). + - If you have iTunes and/or iCloud installed from the Microsoft Store on your computer, **uninstall it.** + - Install the **non-Microsoft Store** version of iTunes from the [website](https://www.apple.com/itunes/download/win64). + - Download the latest version of [Brokenithm-Evolved-iOS server](https://redive.estertion.win/ipas/Brokenithm/Brokenithm-Evolved-iOS-v0.3.7z) + and extract it to `App\bin\Brokenithm-Server`. + - Download the latest version of [Brokenithm-Evolved IO DLLs](https://gitea.tendokyu.moe/Dniel97/Brokenithm-Evolved/releases) and extract the DLL files to your `App\bin\` folder. + - Edit your `App\bin\segatools.ini` to reference the extracted DLLs: + + ```ini hl_lines="2" + [aimeio] + path=aime_brokenithm.dll + ``` + + ```ini hl_lines="2 3" + [chuniio] + path32=brokenithm_x86.dll + path64=brokenithm_x64.dll + ``` + + - Run `App\bin\Brokenithm-Server\Brokenithm-Evolved-iOS.exe`. A command prompt window + should open, saying that it is waiting for a device. + - On your iOS/iPadOS device, open Brokenithm, and connect it to your computer with a + USB cable. + - Run the game as normal. + +??? info "Automatically launching the Brokenithm server when starting the game" + + **This will only work if you extracted the server to `App\bin\Brokenithm-Server` as previously instructed.** + + You can edit the launch script to launch the Brokenithm server when starting the game. + Edit `App\bin\launch.bat` to add a line above the existing commands: + + ```batch hl_lines="5" + @echo off + + pushd %~dp0 + + start /min Brokenithm-Server\Brokenithm-Evolved-iOS.exe + start /min inject_x64 -d -k chusanhook_x64.dll amdaemon.exe -c config_common.json config_server.json config_client.json config_cvt.json config_sp.json config_hook.json + inject_x86 -d -k chusanhook_x86.dll chusanApp.exe + taskkill /f /im amdaemon.exe > nul 2>&1 + + echo. + echo Game processes have terminated + pause + ``` + +### TASOLLER + +!!! warning + + This guide only covers TASOLLERs running the v2.0 touch firmware. If you've purchased the + controller after January 2022, the update should have already been applied. + + If you've purchased the controller before then, you will need to update the touch + firmware by following the instructions on [DJ-DAO's support page](https://www.dj-dao.com/en/support/11.html). + +!!! tip "" + + - Install the [custom IO4 firmware](https://gitea.tendokyu.moe/tasoller/host-aprom/releases) to your controller. + - Follow the `segatools.ini` config on the [gitea page](https://gitea.tendokyu.moe/tasoller/host-aprom). + - Connect the controller to your computer, and then start the game. + +??? tip "Legacy" + + - Backup TASOLLER setup if IO4 cfw is not working. + - Install the [custom Host and LED firmware](https://pixeldrain.com/u/DajSPEoa) to your controller. + Instructions on how to do so is provided in the linked archive. + - Download TASOLLER IO DLLs and extract to your `App\bin` folder. + - [chuniio-rs](https://gitea.tendokyu.moe/beerpsi/chuniio-rs/releases) (download `chusan.zip`) + - Edit your `App\bin\segatools.ini` to reference the extracted DLLs: + + ```ini + [chuniio] + path32=chuniio_tasoller_v2_x86.dll + path64=chuniio_tasoller_v2_x64.dll + ``` + + - Connect the controller to your computer, and then start the game. + +### TASOLLER PLUS + +!!! tip "" + + - Switch your TASOLLER PLUS to WINUSB mode. You can do so in TASOLLER Options + found on the djdao [support page](https://www.dj-dao.com/en/support/22.html). + - Download TASOLLER PLUS IO DLLs and extract to your `App\bin` folder. + - [chuniio-rs](https://gitea.tendokyu.moe/beerpsi/chuniio-rs/releases) (download `chusan.zip`) + - Edit your `App\bin\segatools.ini` to reference the extracted DLLs: + + ```ini + [chuniio] + path32=chuniio_tasoller_plus_x86.dll + path64=chuniio_tasoller_plus_x64.dll + ``` + + - Connect the controller to your computer, and then start the game. + +### YubiDeck + +!!! tip "" + + - Switch your YubiDeck to HID output mode. Instructions on how to do so are provided + in the [YubiDeck manual](https://drive.google.com/file/d/11KVlKbg3zGCRwI7R-30t2IJc6OQwDEgo/view). + - Download the latest version of [YubiDeck IO DLLs](https://gitea.tendokyu.moe/beerpsi/chuniio-yubideck/releases) + and extract it to your `App\bin` folder. + - Edit your `App\bin\segatools.ini` to reference the extracted DLLs: + + ```ini + [chuniio] + path32=chuniio_yubideck_chusan.dll + path64=chuniio_yubideck_amdaemon.dll + ``` + + - Optionally, reference the included AimeIO DLL to use the controller's + built-in card reader: + + ```ini + [aimeio] + path=aimeio_yubideck.dll + ``` + + - Connect the controller to your computer, and then start the game. + +### Laverita 3 + +!!! tip "" + + - Switch your Laverita to IO mode. You can do so in ConfigApp + found in the yuancon [discord](https://discord.gg/4ncuRrq). + - Change the COM port of your controller. You can do so in + Device manager by looking for `USB Serial Device` you may need to unplug and replug your controller to properly idetify which one is the Laverita. + - Double click on it + - Go to Port Settings + - Click on Advanced + - From the dropdown select COM1 + - Restart to ensure changes took effect and saved + - Edit your `App\bin\segatools.ini` to disable io emulation and set led: + + ```ini + [led] + ; Output billboard LED strip data to a named pipe called "\\.\pipe\chuni_led" + cabLedOutputPipe=0 + ; Output billboard LED strip data to serial + cabLedOutputSerial=1 + + ; Output slider LED data to the named pipe + controllerLedOutputPipe=0 + ; Output slider LED data to the serial port + controllerLedOutputSerial=1 + ; Use the OpeNITHM protocol for serial LED output + controllerLedOutputOpeNITHM=0 + + ; Serial port to send data to if using serial output. Default is COM5. + serialPort=COM1 + ; Baud rate for serial data (set to 115200 if using OpeNITHM) + serialBaud=9600 + + [slider] + ; Enable slider emulation. If you have real AC slider, set this to 0. + ; Slider serial port must be COM1. + enable=0 + + [io4] + enable=0 + ``` + + - Then start the game. + +??? tip "Legacy" + + - Backup Laverita 3 setup if IO4 mode is not working. + - Switch your Laverita to HID mode. You can do so in ConfigApp + - Download Laverita IO DLLs and extract to your `App\bin` folder. + - [chuniio-rs](https://gitea.tendokyu.moe/beerpsi/chuniio-rs/releases) (download `chusan.zip`) + - Edit your `App\bin\segatools.ini` to reference the extracted DLLs: + + ```ini + [chuniio] + path32=chuniio_laverita_v3_x86.dll + path64=chuniio_laverita_v3_x64.dll + ``` + + - Connect the controller to your computer, and then start the game. + +### Arcade hardware and other controllers + +!!! tip "" + + If you're interested in using a cabinet slider and air sensors, or possibly even + making your own controller, the [Cons&Stuff website](https://consandstuff.github.io/) + and Discord community is a great place to start! diff --git a/docs/games/sega/chunithm/common/chusan/setup.md b/docs/games/sega/chunithm/common/chusan/setup.md new file mode 100644 index 0000000..b45a215 --- /dev/null +++ b/docs/games/sega/chunithm/common/chusan/setup.md @@ -0,0 +1,184 @@ +# Game Setup + +--8<-- "docs/snippets/common/data_warning.md" + +--8<-- "docs/snippets/sega/common/data_old.md" + +## Preparing data + +--8<-- "docs/snippets/sega/common/data_driveletter.md" + +--8<-- "docs/snippets/common/data_readonly.md" + +--8<-- "docs/snippets/sega/common/data_preparation.md" + + ``` + 📂bin + 📂data + 📂firm + 📂license + 📄firewall.cfg + ▶️game.bat + ▶️pwGetHwinfo.exe + 📝pxGetHwInfo.ini + 📄system_config.json + ``` + +--8<-- "docs/snippets/sega/common/data_bad.md" + +## Updating data + +--8<-- "docs/snippets/sega/common/data_updating.md" + +## Installing option data + +--8<-- "docs/snippets/sega/chunithm/data_options.md" + +## Installing unprotected executables + +!!! 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 + +## Installing ICFs + +--8<-- "docs/snippets/sega/common/data_icfs.md" + +## Patching the game + +--8<-- "docs/snippets/sega/common/patching.md" + +| Patch | Recommendation | Description | +|------------------------------|----------------|-------------| +| Force shared audio mode | Either | Force the game to use shared mode audio output, letting you listen to other audio sources while the game is running **at the cost of audio latency.** +| Force 2 channel audio output | Either | Try enabling this patch if you don't get audio output at all. | +| Disable song select timer | Either | Disables the song select timer. | +| No encryption | ON | Disable encrypting network requests. **Required if you plan to run a local server.** | +| No TLS | ON | Disable checking if the server is `HTTPS` or not. **Required if you plan to run a local server.** | +| Bypass 1080p monitor check | Either | Disable checking if the monitor is 1080p when enabling 120FPS. Enable if you cannot set your monitor to 1080p. | +| Bypass 120 Hz monitor check | Either | Disable checking if the monitor is **exactly 120 Hz** when enabling 120FPS. Enable if you cannot set your monitor to 120 Hz. | + +## Installing segatools + +--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 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 + ▶️launch.bat + ``` + +## Configuring segatools + +--8<-- "docs/snippets/sega/common/segatools_preamble_bin.md" + +=== "[vfs]" + +--8<-- "docs/snippets/sega/common/segatools_relativepaths.md" + +--8<-- "docs/snippets/sega/common/segatools_vfs.md" + +=== "[system]" + + !!! tip "" + + - If you have a 120 Hz monitor, set `dipsw2` and `dipsw3` to 0: + + ```ini + [system] + dipsw2=0 + dipsw3=0 + ``` + + - If you have a 60 Hz monitor, set `dipsw2` and `dipsw3` to 1: + + ```ini + [system] + dipsw2=1 + dipsw3=1 + ``` + +=== "[gfx]" + +--8<-- "docs/snippets/sega/chunithm/segatools_gfx.md" + +## Configuring audio + +--8<-- "docs/snippets/common/audio_48khz.md" + +## Connecting to a network + +--8<-- "docs/snippets/sega/common/network_preamble.md" + +--8<-- "docs/snippets/sega/common/network_remote.md" + +--8<-- "docs/snippets/sega/common/network_local.md" + +## Installing VCRedist & DirectX + +--8<-- "docs/snippets/common/setup_vcredist_directx.md" + +## Before playing + +--8<-- "docs/snippets/common/before_playing.md" + +## First launch + +--8<-- "docs/snippets/sega/common/service_jp_googlelens.md" + +!!! tip "" + + If you've followed all instructions correctly, you're now finally ready to launch the game! + + Start the game by running `App\bin\launch.bat`. Let the game load until it reaches the screen below. + + + + Press your `Test` button (default `F1`) to enter the service menu. Use the `Service` button + (default `F2`) to navigate the menu, and `Test` button to select an option. + + Navigate to **ゲーム設定** (`GAME ASSIGNMENTS`, the fourth option). + + + + Select **グループ内基準機設定** (`SET STANDARD IN GROUP`, the second option) + and toggle this setting to **基準機** (`STANDARD`). + + + + Select **終了** (`EXIT`, the last option) to exit to the main service menu. + + Navigate to **閉店設定** (`CLOSE SETTING`, the tenth option). + + + + Navigate to **時** (`HOUR`, the second option) and use the `Service` button + to toggle the setting until it says **全時刻** (`ALL TIME`). + + + + 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. + + If you're stuck at the `Waiting for Distribution Server` screen below, close the game and relaunch. + + + +--8<-- "docs/snippets/sega/common/success.md" + +## Help + +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/common/chusan/troubleshooting.md b/docs/games/sega/chunithm/common/chusan/troubleshooting.md new file mode 100644 index 0000000..d9c1283 --- /dev/null +++ b/docs/games/sega/chunithm/common/chusan/troubleshooting.md @@ -0,0 +1,117 @@ +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +### My game crashes on launch! + +!!! tip "" + + Could be due to **many** things, the most common of which are: + + - `amdaemon` crashing in the background. Make sure that the `config_*.json` files + have valid syntax, your ICF files are correct. + - Using the incorrect dipswitch settings for your refresh rate (e.g. `dipsw3=0` on + a 60 Hz screen). Refer to the game setup guide to fix it. + - Enabling 120FPS on a monitor that is not **exactly 120 Hz** or **exactly 1080p**. + If you cannot set your monitor's refresh rate to 120 Hz, apply the "Bypass 120 Hz + monitor check"/"Bypass 1080p monitor check" on a CHUNITHM web patcher (see [Resources](/resources.md#web-patchers)). + +??? info "Capturing logs from `amdaemon` for troubleshooting" + + To assist with troubleshooting, a script can be used to capture logs from `amdaemon`. Create a file named + `amdaemontest.bat` in `App\bin`, then paste the code block below into the file. + + ```batch + @echo off + cls + echo Attempting to run AM Daemon ... + echo Window should close after 30 seconds + echo Log will be generated at amdaemontest.txt + call :sub >amdaemontest.txt + exit /b + + :sub + pushd %~dp0 + start /b "AM Daemon" /min inject_x64 -d -k chusanhook_x64.dll amdaemon.exe -c config_common.json config_server.json config_client.json config_cvt.json config_sp.json config_hook.json + ping 127.0.0.1 -n 31 > nul && taskkill /im amdaemon.exe + ``` + + Double-click it to run. The script should run for 30 seconds, and you will get a file + named `amdaemontest.txt` in `App\bin`, which you can send to help people troubleshoot your issue. + +### My game takes a long time to boot! + +!!! tip "" + + CHUNITHM game files consist of thousands of small XML files, which Windows Defender + takes a long time to scan through. Add your game folder to the Windows Defender + exclusion list. + +!!! danger + + Doing this will prevent Windows Defender from scanning your game folder for viruses. + Only do this if you trust the source of the data. + +### My game is running too slow/fast + +!!! tip "" + + The game could be running under or over its required refresh rate. + + - Make sure V-Sync isn't disabled in your graphics settings (called "Vertical sync" + in NVIDIA Control Panel and "Wait for Vertical Refresh" in AMD Control Panel.) + - Make sure your monitor's refresh rate is set to 60 Hz or 120 Hz. + + It could also be that your computer's performance isn't good enough to keep + a steady framerate. + +### My game is stuttering + +!!! tip "" + + For NVIDIA users, create an override for `chusanApp.exe` in NVIDIA Control Panel + and change "Power management mode" to "**Prefer maximum performance**". + +### My game crashes when I tab out of fullscreen! + +!!! tip "" + + As the game is intended to run on arcade hardware, it doesn't like being minimized. + + One workaround for this is to use DXVK. Download the latest version from [releases](https://github.com/doitsujin/dxvk/releases/latest). + This will be a `dxvk-x.y.z.tar.gz` file, which you can open using [7zip](https://www.7-zip.org/). + Navigate to the `x32` folder, and copy the `d3d9.dll` file to your game's `App\bin` folder, agreeing + to overwrite when asked. + + You should now be able to tab out of fullscreen without crashing the game. + +!!! warning + + The game will not ignore inputs when out of focus. + + This means any controller inputs will still be accepted, so try not to lean onto + your slider whilst tabbed out! + + This also means that you can accidentally enter the service menu by hitting your + `Test` key even if the game is minimised. If you were in the middle of a credit, + **your scores will be lost.** + +### When I run the game all other audio is gone! + +!!! tip "" + + CHUNITHM uses [WASAPI exclusive mode](https://docs.microsoft.com/en-us/windows/win32/coreaudio/exclusive-mode-streams) + for audio to get better latency. + + You can apply the "Shared Audio" patch on a CHUNITHM web patcher (see [Resources](/resources.md#web-patchers)) + to hear audio outside of the game at the cost of audio latency. + +### Cabinet-to-Cabinet(c2c) Fixes + +!!! tip "" + + c2c can have many problems but you can fix most of them by applying the "Patch for head-to-head play" and disabling "Set all timers to 999" on a CHUNITHM web patcher (see [Resources](/resources.md#web-patchers)). + + If the above does not work then please ensure both machines have the exact same data and can communicate with each other if they cannot then you can try disabling firewalls or changing the c2c group. + + If clicking the c2c button does nothing, you can fix it by resetting the network settings in Windows. diff --git a/docs/games/sega/chunithm/crystal/c2c.md b/docs/games/sega/chunithm/crystal/c2c.md new file mode 100644 index 0000000..0a748b0 --- /dev/null +++ b/docs/games/sega/chunithm/crystal/c2c.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..46997ae --- /dev/null +++ b/docs/games/sega/chunithm/crystal/controllers.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..5d58cec --- /dev/null +++ b/docs/games/sega/chunithm/crystal/setup.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..95f6e2e --- /dev/null +++ b/docs/games/sega/chunithm/crystal/troubleshooting.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..047b623 --- /dev/null +++ b/docs/games/sega/chunithm/crystalplus/c2c.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..313b2be --- /dev/null +++ b/docs/games/sega/chunithm/crystalplus/controllers.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..3ff6e2d --- /dev/null +++ b/docs/games/sega/chunithm/crystalplus/setup.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..767b590 --- /dev/null +++ b/docs/games/sega/chunithm/crystalplus/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/luminous/c2c.md b/docs/games/sega/chunithm/luminous/c2c.md new file mode 100644 index 0000000..53a9121 --- /dev/null +++ b/docs/games/sega/chunithm/luminous/c2c.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/luminous/controllers.md b/docs/games/sega/chunithm/luminous/controllers.md new file mode 100644 index 0000000..7008cf3 --- /dev/null +++ b/docs/games/sega/chunithm/luminous/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/luminous/setup.md b/docs/games/sega/chunithm/luminous/setup.md new file mode 100644 index 0000000..d55a289 --- /dev/null +++ b/docs/games/sega/chunithm/luminous/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/setup.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/luminous/troubleshooting.md b/docs/games/sega/chunithm/luminous/troubleshooting.md new file mode 100644 index 0000000..e9b4756 --- /dev/null +++ b/docs/games/sega/chunithm/luminous/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/luminousplus/c2c.md b/docs/games/sega/chunithm/luminousplus/c2c.md new file mode 100644 index 0000000..a24a074 --- /dev/null +++ b/docs/games/sega/chunithm/luminousplus/c2c.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/luminousplus/controllers.md b/docs/games/sega/chunithm/luminousplus/controllers.md new file mode 100644 index 0000000..f6add40 --- /dev/null +++ b/docs/games/sega/chunithm/luminousplus/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/luminousplus/setup.md b/docs/games/sega/chunithm/luminousplus/setup.md new file mode 100644 index 0000000..eb5cff4 --- /dev/null +++ b/docs/games/sega/chunithm/luminousplus/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/setup.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/luminousplus/troubleshooting.md b/docs/games/sega/chunithm/luminousplus/troubleshooting.md new file mode 100644 index 0000000..85f8236 --- /dev/null +++ b/docs/games/sega/chunithm/luminousplus/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/new/c2c.md b/docs/games/sega/chunithm/new/c2c.md new file mode 100644 index 0000000..6b17963 --- /dev/null +++ b/docs/games/sega/chunithm/new/c2c.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/new/controllers.md b/docs/games/sega/chunithm/new/controllers.md new file mode 100644 index 0000000..60679d8 --- /dev/null +++ b/docs/games/sega/chunithm/new/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/new/setup.md b/docs/games/sega/chunithm/new/setup.md new file mode 100644 index 0000000..ea0a88d --- /dev/null +++ b/docs/games/sega/chunithm/new/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/setup.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/new/troubleshooting.md b/docs/games/sega/chunithm/new/troubleshooting.md new file mode 100644 index 0000000..e67e47b --- /dev/null +++ b/docs/games/sega/chunithm/new/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/newplus/c2c.md b/docs/games/sega/chunithm/newplus/c2c.md new file mode 100644 index 0000000..d3418b7 --- /dev/null +++ b/docs/games/sega/chunithm/newplus/c2c.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/newplus/controllers.md b/docs/games/sega/chunithm/newplus/controllers.md new file mode 100644 index 0000000..a308d20 --- /dev/null +++ b/docs/games/sega/chunithm/newplus/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/newplus/setup.md b/docs/games/sega/chunithm/newplus/setup.md new file mode 100644 index 0000000..9a0d6c4 --- /dev/null +++ b/docs/games/sega/chunithm/newplus/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/setup.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/newplus/troubleshooting.md b/docs/games/sega/chunithm/newplus/troubleshooting.md new file mode 100644 index 0000000..492f50d --- /dev/null +++ b/docs/games/sega/chunithm/newplus/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/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 new file mode 100644 index 0000000..b5592fc --- /dev/null +++ b/docs/games/sega/chunithm/paradise/c2c.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..ad50168 --- /dev/null +++ b/docs/games/sega/chunithm/paradise/controllers.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..cc1598f --- /dev/null +++ b/docs/games/sega/chunithm/paradise/setup.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..e1f570a --- /dev/null +++ b/docs/games/sega/chunithm/paradise/troubleshooting.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..475d2c0 --- /dev/null +++ b/docs/games/sega/chunithm/paradiselost/c2c.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..7d826d2 --- /dev/null +++ b/docs/games/sega/chunithm/paradiselost/controllers.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..27ec028 --- /dev/null +++ b/docs/games/sega/chunithm/paradiselost/setup.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..2919df9 --- /dev/null +++ b/docs/games/sega/chunithm/paradiselost/troubleshooting.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..614c322 --- /dev/null +++ b/docs/games/sega/chunithm/plus/c2c.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..34a0182 --- /dev/null +++ b/docs/games/sega/chunithm/plus/controllers.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..8fc7f97 --- /dev/null +++ b/docs/games/sega/chunithm/plus/setup.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..da4eb8d --- /dev/null +++ b/docs/games/sega/chunithm/plus/troubleshooting.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..6e0b8c0 --- /dev/null +++ b/docs/games/sega/chunithm/star/c2c.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..3f8a7ac --- /dev/null +++ b/docs/games/sega/chunithm/star/controllers.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..cf1955e --- /dev/null +++ b/docs/games/sega/chunithm/star/setup.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..d125510 --- /dev/null +++ b/docs/games/sega/chunithm/star/troubleshooting.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..d2123bf --- /dev/null +++ b/docs/games/sega/chunithm/starplus/c2c.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..811ee15 --- /dev/null +++ b/docs/games/sega/chunithm/starplus/controllers.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..72d843b --- /dev/null +++ b/docs/games/sega/chunithm/starplus/setup.md @@ -0,0 +1,2 @@ + +--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 new file mode 100644 index 0000000..0f84bf9 --- /dev/null +++ b/docs/games/sega/chunithm/starplus/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chuni/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/sun/c2c.md b/docs/games/sega/chunithm/sun/c2c.md new file mode 100644 index 0000000..211a09c --- /dev/null +++ b/docs/games/sega/chunithm/sun/c2c.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/sun/controllers.md b/docs/games/sega/chunithm/sun/controllers.md new file mode 100644 index 0000000..7e784e5 --- /dev/null +++ b/docs/games/sega/chunithm/sun/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/sun/setup.md b/docs/games/sega/chunithm/sun/setup.md new file mode 100644 index 0000000..f18d0f5 --- /dev/null +++ b/docs/games/sega/chunithm/sun/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/setup.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/sun/troubleshooting.md b/docs/games/sega/chunithm/sun/troubleshooting.md new file mode 100644 index 0000000..f184bd0 --- /dev/null +++ b/docs/games/sega/chunithm/sun/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/sunplus/c2c.md b/docs/games/sega/chunithm/sunplus/c2c.md new file mode 100644 index 0000000..592c593 --- /dev/null +++ b/docs/games/sega/chunithm/sunplus/c2c.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/sunplus/controllers.md b/docs/games/sega/chunithm/sunplus/controllers.md new file mode 100644 index 0000000..fefd58a --- /dev/null +++ b/docs/games/sega/chunithm/sunplus/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/sunplus/setup.md b/docs/games/sega/chunithm/sunplus/setup.md new file mode 100644 index 0000000..e0b25c7 --- /dev/null +++ b/docs/games/sega/chunithm/sunplus/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/setup.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/sunplus/troubleshooting.md b/docs/games/sega/chunithm/sunplus/troubleshooting.md new file mode 100644 index 0000000..b5e6104 --- /dev/null +++ b/docs/games/sega/chunithm/sunplus/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/verse/c2c.md b/docs/games/sega/chunithm/verse/c2c.md new file mode 100644 index 0000000..2f413cd --- /dev/null +++ b/docs/games/sega/chunithm/verse/c2c.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/verse/controllers.md b/docs/games/sega/chunithm/verse/controllers.md new file mode 100644 index 0000000..bd0361f --- /dev/null +++ b/docs/games/sega/chunithm/verse/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/verse/setup.md b/docs/games/sega/chunithm/verse/setup.md new file mode 100644 index 0000000..ee5e9e5 --- /dev/null +++ b/docs/games/sega/chunithm/verse/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/setup.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/verse/troubleshooting.md b/docs/games/sega/chunithm/verse/troubleshooting.md new file mode 100644 index 0000000..4c38041 --- /dev/null +++ b/docs/games/sega/chunithm/verse/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/chunithm/x-verse-x/c2c.md b/docs/games/sega/chunithm/x-verse-x/c2c.md new file mode 100644 index 0000000..38cf89c --- /dev/null +++ b/docs/games/sega/chunithm/x-verse-x/c2c.md @@ -0,0 +1,3 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/c2c.md" + diff --git a/docs/games/sega/chunithm/x-verse-x/controllers.md b/docs/games/sega/chunithm/x-verse-x/controllers.md new file mode 100644 index 0000000..ef6e878 --- /dev/null +++ b/docs/games/sega/chunithm/x-verse-x/controllers.md @@ -0,0 +1,3 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/controllers.md" + diff --git a/docs/games/sega/chunithm/x-verse-x/setup.md b/docs/games/sega/chunithm/x-verse-x/setup.md new file mode 100644 index 0000000..f18d42c --- /dev/null +++ b/docs/games/sega/chunithm/x-verse-x/setup.md @@ -0,0 +1,3 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/setup.md" + diff --git a/docs/games/sega/chunithm/x-verse-x/troubleshooting.md b/docs/games/sega/chunithm/x-verse-x/troubleshooting.md new file mode 100644 index 0000000..31962c2 --- /dev/null +++ b/docs/games/sega/chunithm/x-verse-x/troubleshooting.md @@ -0,0 +1,3 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/troubleshooting.md" + diff --git a/docs/games/sega/chunithm/x-verse/c2c.md b/docs/games/sega/chunithm/x-verse/c2c.md new file mode 100644 index 0000000..bef03e0 --- /dev/null +++ b/docs/games/sega/chunithm/x-verse/c2c.md @@ -0,0 +1,3 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/c2c.md" + diff --git a/docs/games/sega/chunithm/x-verse/controllers.md b/docs/games/sega/chunithm/x-verse/controllers.md new file mode 100644 index 0000000..2cd7a99 --- /dev/null +++ b/docs/games/sega/chunithm/x-verse/controllers.md @@ -0,0 +1,3 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/controllers.md" + diff --git a/docs/games/sega/chunithm/x-verse/setup.md b/docs/games/sega/chunithm/x-verse/setup.md new file mode 100644 index 0000000..177a6dc --- /dev/null +++ b/docs/games/sega/chunithm/x-verse/setup.md @@ -0,0 +1,3 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/setup.md" + diff --git a/docs/games/sega/chunithm/x-verse/troubleshooting.md b/docs/games/sega/chunithm/x-verse/troubleshooting.md new file mode 100644 index 0000000..c45d0d8 --- /dev/null +++ b/docs/games/sega/chunithm/x-verse/troubleshooting.md @@ -0,0 +1,3 @@ + +--8<-- "docs/games/sega/chunithm/common/chusan/troubleshooting.md" + diff --git a/docs/games/sega/maimaidx/buddies/controllers.md b/docs/games/sega/maimaidx/buddies/controllers.md new file mode 100644 index 0000000..d8dd268 --- /dev/null +++ b/docs/games/sega/maimaidx/buddies/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/buddies/setup.md b/docs/games/sega/maimaidx/buddies/setup.md new file mode 100644 index 0000000..036b3ac --- /dev/null +++ b/docs/games/sega/maimaidx/buddies/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/setup.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/buddies/troubleshooting.md b/docs/games/sega/maimaidx/buddies/troubleshooting.md new file mode 100644 index 0000000..d91a47e --- /dev/null +++ b/docs/games/sega/maimaidx/buddies/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/buddiesplus/controllers.md b/docs/games/sega/maimaidx/buddiesplus/controllers.md new file mode 100644 index 0000000..f04e207 --- /dev/null +++ b/docs/games/sega/maimaidx/buddiesplus/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/buddiesplus/setup.md b/docs/games/sega/maimaidx/buddiesplus/setup.md new file mode 100644 index 0000000..664d0c8 --- /dev/null +++ b/docs/games/sega/maimaidx/buddiesplus/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/setup.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/buddiesplus/troubleshooting.md b/docs/games/sega/maimaidx/buddiesplus/troubleshooting.md new file mode 100644 index 0000000..f892eab --- /dev/null +++ b/docs/games/sega/maimaidx/buddiesplus/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/circle/controllers.md b/docs/games/sega/maimaidx/circle/controllers.md new file mode 100644 index 0000000..5884854 --- /dev/null +++ b/docs/games/sega/maimaidx/circle/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/circle/setup.md b/docs/games/sega/maimaidx/circle/setup.md new file mode 100644 index 0000000..e1b9864 --- /dev/null +++ b/docs/games/sega/maimaidx/circle/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/setup.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/circle/troubleshooting.md b/docs/games/sega/maimaidx/circle/troubleshooting.md new file mode 100644 index 0000000..980fd18 --- /dev/null +++ b/docs/games/sega/maimaidx/circle/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/common/controllers.md b/docs/games/sega/maimaidx/common/controllers.md new file mode 100644 index 0000000..175ba44 --- /dev/null +++ b/docs/games/sega/maimaidx/common/controllers.md @@ -0,0 +1,83 @@ +# Controllers + +--8<-- "docs/snippets/common/data_warning.md" + +!!! tip "" + + segatools, by default, only accepts keyboard input and does not recognize any + controllers. However, it can be configured with IO DLLs to add support for controllers. + + The controller you plan on using should also be provided with these IO DLLs. If unsure, + check the support section for your controller, or contact the vendor directly. Alternate + options for the most common controllers are listed below. + + These IO DLLs should be copied to your game's `App\Package` folder and referenced in + `segatools.ini` under the `[mai2io]` section. + +!!! tip "" + + If you have a single DLL, uncomment the `path=` line by removing the leading semicolon (`;`), + then add your DLL's file name after the `=`: + + ```ini hl_lines="5" + [mai2io] + ; To use a custom maimai DX IO DLL enter its path here. + ; Leave empty if you want to use Segatools built-in keyboard input. + ;(1)! + path=controller.dll + ``` + + 1. Note that there is no leading semicolon. + +### Keyboard/Touchscreen + +!!! tip "" + + Keyboard/Touchscreen is the default input method + + The default layout uses `QWEDCXZA` for physical buttons (each key representing the physical button's location relative to the center screen) + + If you wish to change the default keybinds, an explanation on how to set these is included + above the `[io4]` section in your `segatools.ini`. + + Touch input should automatically work after connecting a touch-screen display + +### ADX Controller + +!!! tip "" + + First, you will need to purchase a compatible monitor if your controller did not come with one. A list of compatible monitors can be found on [this spreadsheet](https://docs.google.com/spreadsheets/d/1WN50pyJEPpXR32UTsEzsKe4Qm-EUAQgwmkCBX3kWB1Q) + + Plug your controller in and open `Device Manager`. + + Under the `Ports (COM & LPT)` section, ensure the correct ports are set for both the Touch Panel and Button LED. + + - (Touch Panel) USB Serial Device: `COM3` + - (Button LED) USB-SERIAL CH340: `COM21` + + If they are different change the port of the device by `Right Clicking on the Device -> Properties -> Port Settings -> COM Port Number` + + Finally ensure the `mai2.ini` file in your data's `App/Package` folder has the following values set under the `[AM]` section + ``` + [AM] + Target=0 + DummyTouchPanel=0 + DummyLED=0 + ``` + + This gets your controller working with keyboard inputs. Its highly recommended that you also view [this setup guide](https://github.com/maimai-dx/ADX-Controller-Guide/blob/master/document/Setup.md) which provides more detailed instructions, improved drivers, and help with adjusting touch panel sensitivity. + +!!! warning + You **DO NOT** need to follow the Network Setup steps in the linked guide above if you've already done so while setting up game data + + You **DO NOT** need to follow the Aime Reader setup in the linked guide above if you do not own one. + + + +### Arcade hardware and other controllers + +!!! tip "" + + If you're interested in using a cabinet, or possibly even + making your own controller, the [Cons&Stuff website](https://consandstuff.github.io/) + and Discord community is a great place to start! diff --git a/docs/games/sega/maimaidx/common/setup.md b/docs/games/sega/maimaidx/common/setup.md new file mode 100644 index 0000000..c22bd87 --- /dev/null +++ b/docs/games/sega/maimaidx/common/setup.md @@ -0,0 +1,194 @@ +# Game Setup + +--8<-- "docs/snippets/common/data_warning.md" + +--8<-- "docs/snippets/sega/common/data_old.md" + +## Preparing data + +--8<-- "docs/snippets/sega/common/data_driveletter.md" + +--8<-- "docs/snippets/common/data_readonly.md" + +--8<-- "docs/snippets/sega/common/data_preparation.md" + + ``` + 📂license + 📂package + 📄firewall.cfg + ▶️game.bat + ▶️pwGetHwinfo.exe + 📝pxGetHwInfo.ini + 📄system_config.json + ``` +--8<-- "docs/snippets/sega/common/data_bad.md" + +## Updating data + +--8<-- "docs/snippets/sega/common/data_updating.md" + +## Installing option data + +!!! tip "" + + SEGA games receive content updates through option folders rather than direct game file updates. + + - 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 + + After downloading option files, extract them into your game's `Option` folder. + + ``` + 📂amfs + 📂App + 📂AppData + 📂Option + ┣━📂H005 + ┣━📂H011 + ┣━📂H031 + ┗━ etc. + ``` + +!!! 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 + +!!! tip "" + + 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 of the following folders and files: + + ``` + ▶️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 all of the above to your data's `App\package` folder + - Agree to overwrite when asked + +!!! warning "Assembly-CSharp Notes" + + `Assembly-CSharp.dll` **must** match your game version. + All other files can be reused between game versions. + +## Installing ICFs + +--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: + + ```ini + [Debug] + Debug=1 + + [AM] + Target=0 + IgnoreError=1 + DummyTouchPanel=1 + DummyLED=1 + DummyCodeCamera=1 + DummyPhotoCamera=1 + + [Sound] + Sound8Ch=0 + ``` + +## Installing segatools + +--8<-- "docs/snippets/sega/common/segatools_install.md" + - Find `mai2.zip` and extract it to your data's `App\package` folder + + You should now have these files added to your `App\package` directory: + + ``` + 📂DEVICE + ▶️inject.exe + ⚙️mai2hook.dll + 📝segatools.ini + ▶️launch.bat + ``` + +## Configuring segatools + +--8<-- "docs/snippets/sega/common/segatools_preamble_package.md" + +=== "[vfs]" + +--8<-- "docs/snippets/sega/common/segatools_relativepaths.md" + +--8<-- "docs/snippets/sega/common/segatools_vfs.md" + +??? tip "AquaMai" + + Find more information about AquaMai on their [GitHub page](https://github.com/MewoLab/AquaMai). + Also check our [Unity modding](/extras/unity.md) guide. + +## Configuring audio + +--8<-- "docs/snippets/common/audio_48khz.md" + +## Connecting to a network + +--8<-- "docs/snippets/sega/common/network_preamble.md" + +--8<-- "docs/snippets/sega/common/network_remote.md" + +--8<-- "docs/snippets/sega/common/network_local.md" + +## Installing VCRedist & DirectX + +--8<-- "docs/snippets/common/setup_vcredist_directx.md" + +## Before playing + +--8<-- "docs/snippets/common/before_playing.md" + +## First launch + +--8<-- "docs/snippets/sega/common/service_jp_googlelens.md" + +!!! tip "" + + If you've followed all instructions correctly, you're now finally ready to launch the game! + + Start the game by running `App\package\launch.bat`. Let the game load until you reach a screen with the message below. + + + + Press your `Test` button (default `F1`) to enter the service menu. Use the `Service` button + (default `F2`) to navigate the menu, and `Test` button to select an option. + + Navigate to **ゲーム設定** (`GAME ASSIGNMENTS`, the 7th option). + + + + Select **店内マッチングの設定** (`IN-STORE MATCHING SETUP`, the first option) + and toggle this setting to **OFF**. + + + + Select **終了** (`EXIT`, the last option) to exit to the main service menu. + +--8<-- "docs/snippets/sega/common/success.md" + +## Help + +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/common/troubleshooting.md b/docs/games/sega/maimaidx/common/troubleshooting.md new file mode 100644 index 0000000..dcf8dd2 --- /dev/null +++ b/docs/games/sega/maimaidx/common/troubleshooting.md @@ -0,0 +1,68 @@ +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +### My game crashes on launch/stuck on "Starting System Process" + +!!! tip "" + + Could be due to **many** things, the most common of which are: + + - `amdaemon` crashing in the background. Make sure that the `config_*.json` files + have valid syntax, your ICF files are correct. + +??? info "Capturing logs from `amdaemon` for troubleshooting" + + To assist with troubleshooting, a script can be used to capture logs from `amdaemon`. Create a file named + `amdaemontest.bat` in `App\bin`, then paste the code block below into the file. + + ```batch + @echo off + cls + echo Attempting to run AM Daemon ... + echo Window should close after 30 seconds + echo Log will be generated at amdaemontest.txt + call :sub >amdaemontest.txt + exit /b + + :sub + pushd %~dp0 + start /b "AM Daemon" /min inject -d -k mai2hook.dll amdaemon.exe -f -c config_common.json config_server.json + ping 127.0.0.1 -n 31 > nul && taskkill /F /im amdaemon.exe + ``` + + Double-click it to run. The script should run for 30 seconds, and you will get a file + named `amdaemontest.txt` in `App\bin`, which you can send to help people troubleshoot your issue. + +### My game is stuck on a black screen at launch! + +!!! tip "" + + This could also be due to **many** things, the most common of which are: + + - You have one or more incorrect/broken DLL(s) in `App\Package\Sinmai_Data\Managed` + + This is likely to be `Assembly-CSharp.dll`, `Assembly-CSharp-firstpass.dll`, and/or `AMDaemon.NET.dll`. + You can try replacing the DLLs or re-downloading data from elsewhere. + + - An ill-formed keychip is defined in `segatools.ini` + +### My game is stuck on a blue and black screen! + +!!! tip "" + You need to run the data using unprotected/unpacked files. Please refer to the setup guide to find which ones you need and obtain them. + + If you believe you've already done this. You might be missing a try installing the latest [vcredist](https://www.techpowerup.com/download/visual-c-redistributable-runtime-package-all-in-one/) + +### My game is running too slow/fast or the notes are out of sync! + +!!! tip "" + + The game could be running under or over its required refresh rate. + + - Make sure V-Sync isn't disabled in your graphics settings (called "Vertical sync" + in NVIDIA Control Panel and "Wait for Vertical Refresh" in AMD Control Panel.) + - Limit `Sinmai.exe` to run at 60 FPS using a tool like [RivaTuner](https://www.guru3d.com/download/rtss-rivatuner-statistics-server-download) or a patch. + + It could also be that your computer's performance isn't good enough to keep + a steady framerate. diff --git a/docs/games/sega/maimaidx/prism/controllers.md b/docs/games/sega/maimaidx/prism/controllers.md new file mode 100644 index 0000000..f84d251 --- /dev/null +++ b/docs/games/sega/maimaidx/prism/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/prism/setup.md b/docs/games/sega/maimaidx/prism/setup.md new file mode 100644 index 0000000..34dad91 --- /dev/null +++ b/docs/games/sega/maimaidx/prism/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/setup.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/prism/troubleshooting.md b/docs/games/sega/maimaidx/prism/troubleshooting.md new file mode 100644 index 0000000..6033683 --- /dev/null +++ b/docs/games/sega/maimaidx/prism/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/prismplus/controllers.md b/docs/games/sega/maimaidx/prismplus/controllers.md new file mode 100644 index 0000000..4a5184c --- /dev/null +++ b/docs/games/sega/maimaidx/prismplus/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/prismplus/setup.md b/docs/games/sega/maimaidx/prismplus/setup.md new file mode 100644 index 0000000..f0ed472 --- /dev/null +++ b/docs/games/sega/maimaidx/prismplus/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/setup.md" \ No newline at end of file diff --git a/docs/games/sega/maimaidx/prismplus/troubleshooting.md b/docs/games/sega/maimaidx/prismplus/troubleshooting.md new file mode 100644 index 0000000..1baac9c --- /dev/null +++ b/docs/games/sega/maimaidx/prismplus/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/maimaidx/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/ongeki/brightmemory/c2c.md b/docs/games/sega/ongeki/brightmemory/c2c.md new file mode 100644 index 0000000..8e65ef2 --- /dev/null +++ b/docs/games/sega/ongeki/brightmemory/c2c.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/ongeki/common/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/ongeki/brightmemory/controllers.md b/docs/games/sega/ongeki/brightmemory/controllers.md new file mode 100644 index 0000000..f0634f5 --- /dev/null +++ b/docs/games/sega/ongeki/brightmemory/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/ongeki/common/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/ongeki/brightmemory/setup.md b/docs/games/sega/ongeki/brightmemory/setup.md new file mode 100644 index 0000000..96c9fa3 --- /dev/null +++ b/docs/games/sega/ongeki/brightmemory/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/ongeki/common/setup.md" \ No newline at end of file diff --git a/docs/games/sega/ongeki/brightmemory/troubleshooting.md b/docs/games/sega/ongeki/brightmemory/troubleshooting.md new file mode 100644 index 0000000..043d6e4 --- /dev/null +++ b/docs/games/sega/ongeki/brightmemory/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/ongeki/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/ongeki/common/c2c.md b/docs/games/sega/ongeki/common/c2c.md new file mode 100644 index 0000000..0910f9e --- /dev/null +++ b/docs/games/sega/ongeki/common/c2c.md @@ -0,0 +1,45 @@ +# Cab-to-Cab over Internet + +--8<-- "docs/snippets/common/data_warning.md" + +!!! danger "You are most likely to have success with Multiplayer when all users are using the SAME data and options, from the same sources. Verify that each person can run the game normally before attempting to network them together" + +## Initial setup + +!!! tip "Network" + + Every machine needs to be on the same LAN. + If you wish to achieve that over the internet, follow the [ZeroTier setup guide](/extras/zerotier.md). + +!!! tip "GAME ASSIGNMENTS" + + - Open the Service Menu and navigate to **ゲーム設定** (`GAME ASSIGNMENTS`, the 6th option) + + + - Make sure all machines are on the same group (Group A for example) + + + - Set one machine to `STANDARD`, and all other machines to `FOLLOW THE STANDARD` + + + + Exit the Service Menu and load into Attract Mode. If the game passes the Group Check then chances are you're good to go! You can now login to a credit and open a cab-to-cab link request to check if the connection is working properly. + +## How to link? + +!!! Info "If you're new to O.N.G.E.K.I. and have never tried link-play before and you have no idea how, keep reading" + + - Login to a credit + + - If you're hosting a cab-to-cab session, choose a song first, then scroll to the far left and press `Confirm` + The cab-to-cab request is now open + + + - If you're connecting, navigate to the `Cabinet-to-Cabinet Play` tab and wait for other players to create a session + + + If you are able to see each other's session, congrats! You can now enjoy some cab-to-cab chain action! + +## Help + +--8<-- "docs/snippets/common/help.md" \ No newline at end of file diff --git a/docs/games/sega/ongeki/common/controllers.md b/docs/games/sega/ongeki/common/controllers.md new file mode 100644 index 0000000..9dfad34 --- /dev/null +++ b/docs/games/sega/ongeki/common/controllers.md @@ -0,0 +1,126 @@ +# Controllers + +--8<-- "docs/snippets/common/data_warning.md" + +!!! tip "" + + segatools, by default, only accepts keyboard input and XInput Controllers. + However, it can be configured with IO DLLs to add support for other controllers. + + The controller you plan on using should also be provided with these IO DLLs. If unsure, + check the support section for your controller, or contact the vendor directly. Alternate + options for the most common controllers are listed below. + + These IO DLLs should be copied to your game's `App\package` folder and referenced in + `segatools.ini` under the `[mu3io]` section. + +!!! tip "" + + If you have a single DLL, uncomment the `path=` line by removing the leading semicolon (`;`), + then add your DLL's file name after the `=`: + + ```ini hl_lines="5" + [mu3io] + ; To use a custom O.N.G.E.K.I. IO DLL enter its path here. + ; Leave empty if you want to use Segatools built-in keyboard/gamepad input. + ;(1)! + path=controller.dll + ``` + + 1. Note that there is no leading semicolon. + +## Keyboard and Mouse + +!!! tip "" + + Keyboard and Mouse is the default input method. + + To enable mouse lever emulation ensure that the `mouse` option is set to `1` in the `[io4]` + section of your `segatools.ini`: + + ```ini hl_lines="3" + [io4] + ; Set "1" to enable mouse lever emulation, "0" to use XInput + mouse=1 + ``` + + The default layout use `ASD` for the left 3 buttons, and `JKL` for the right 3 buttons. + `Mouse Left/Right Click` are used for the left and right bumper buttons. + + If you wish to change the default keybinds, an explanation on how to set these is included + above the `[io4]` section in your `segatools.ini`. + +## XInput Controller + +!!! tip "" + + XInput controllers are supported by segatools. To enable XInput, ensure that the `mouse` option + is set to `0` in the `[io4]` section of your `segatools.ini`: + + ```ini hl_lines="3" + [io4] + ; Set "1" to enable mouse lever emulation, "0" to use XInput + mouse=0 + ``` + + If you wish to change the default keybinds, an explanation on how to set these is included + above the `[io4]` section in your `segatools.ini`. + +## Mageki + +!!! tip "" + + Mageki allows you to use a mobile device as a O.N.G.E.K.I. controller. It replicates the layout + of an arcade O.N.G.E.K.I. controller on your mobile device. + + Mageki supports both Android and iOS devices. For installation instructions, please refer to + the [English User Manual on the Mageki GitHub Repository](https://github.com/Sanheiii/Mageki/wiki/Mageki-User-Manual). + +!!! warning "Configuring ongeki-io and MU3-input.dll" + + When moving the zipped contents of `MU3Input`, move all folders **EXCEPT** the `segatools.ini` file into your `App\package` folder in a way that matches its file structure. + Modify the `[mu3io]` and `[aimeio]` sections of your existing `segatools.ini` file to look like the following: + + ```ini hl_lines="2 5" + [mu3io] + path=MU3Input.dll + + [aimeio] + path=MU3Input.dll + ``` + If these sections do not exist, add them to the end of your `segatools.ini` file. + +!!! info "IOConfig doesn't launch for me/This application requires the Windows App Runtime" + + Download and extract the contents of the [Windows App Runtime Version 1.5 Redistributable](https://aka.ms/windowsappsdk/1.5/1.5.240802000/Microsoft.WindowsAppRuntime.Redist.1.5.zip) + In the `WindowsAppSDK-Installer-x64` folder run `WindowsAppRuntimeInstall-x64.exe` + + If IOConfig still fails to launch, try using the [SelfContained version of ongeki-io](https://github.com/Sanheiii/ongeki-io/releases) + +## ONTROLLER + +!!! tip "" + + - Navigate to [Mu3IO.NET releases](https://github.com/jujuforce/Mu3IO.NET/releases/) and download `mu3io.dll`. Put this file in your `App\package` folder. + - Edit your `segatools.ini` to reference the DLL: + + ```ini hl_lines="4" + [mu3io] + ; To use a custom O.N.G.E.K.I. IO DLL enter its path here. + ; Leave empty if you want to use Segatools built-in keyboard/gamepad input. + path=mu3io.dll + ``` + +## YUANGEKI + +!!! tip "" + + This controller does not support IO4 mode. Instead, refer to the [Keyboard and Mouse](#keyboard-and-mouse) section. + +## Arcade hardware and other controllers + +!!! tip "" + + If you're interested in using a cabinet slider and air sensors, or possibly even + making your own controller, the [Cons&Stuff website](https://consandstuff.github.io/) + and Discord community is a great place to start! diff --git a/docs/games/sega/ongeki/common/setup.md b/docs/games/sega/ongeki/common/setup.md new file mode 100644 index 0000000..659ad51 --- /dev/null +++ b/docs/games/sega/ongeki/common/setup.md @@ -0,0 +1,214 @@ +# Game Setup + +--8<-- "docs/snippets/common/data_warning.md" + +--8<-- "docs/snippets/sega/common/data_old.md" + +## Preparing data + +--8<-- "docs/snippets/sega/common/data_driveletter.md" + +--8<-- "docs/snippets/common/data_readonly.md" + +--8<-- "docs/snippets/sega/common/data_preparation.md" + + ``` + 📂license + 📂package + 📄firewall.cfg + ▶️game.bat + ▶️pxGetHwinfo.exe + 📝pxGetHwInfo.ini + ▶️RotateDisplay.exe + 📄system_config.json + ``` + +--8<-- "docs/snippets/sega/common/data_bad.md" + +## Updating data + +--8<-- "docs/snippets/sega/common/data_updating.md" + +## Installing option data + +!!! tip "" + + SEGA games receive content updates through option folders rather than direct game file updates. + + 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. + + After downloading option files, extract them into your game's `Option` folder. + + ``` + 📂amfs + 📂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. + + - 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 + ┃ ┣━⚙️chiffre.dll + ┃ ┣━⚙️libhttp.dll + ┃ ┗━⚙️QR_Image.dll + ┗━📂Managed + ┣━⚙️AMDaemon.NET.dll + ┣━⚙️Assembly-CSharp-firstpass.dll + ┗━⚙️Assembly-CSharp.dll + 📝mu3.ini + ``` + + - Copy all of the above to your data's `App\package` folder + - Agree to overwrite when asked + +!!! warning "Assembly-CSharp Notes" + + `Assembly-CSharp.dll` **must** match your game version. + All other files can be reused between game versions. + +## Installing ICFs + +--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: + + ```ini + [AM] + IgnoreError=1 + OptionDev=0 + DummyAime=0 + DummyCredit=1 + DummyJVS=0 + + [Sound] + WasapiExclusive=0 + ``` + +!!! 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 + +--8<-- "docs/snippets/sega/common/segatools_install.md" + - Find `mu3.zip` and extract it to your data's `App\package` folder + + You should now have these files added to your `App\package` directory: + + ``` + 📂DEVICE + ▶️inject.exe + ⚙️mu3hook.dll + 📝segatools.ini + ▶️launch.bat + ``` + +## Configuring segatools + +--8<-- "docs/snippets/sega/common/segatools_preamble_package.md" + +=== "[vfs]" + +--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. + +## Configuring audio + +--8<-- "docs/snippets/common/audio_48khz.md" + +## Connecting to a network + +--8<-- "docs/snippets/sega/common/network_preamble.md" + +--8<-- "docs/snippets/sega/common/network_remote.md" + +--8<-- "docs/snippets/sega/common/network_local.md" + +## Installing VCRedist & DirectX + +--8<-- "docs/snippets/common/setup_vcredist_directx.md" + +## Before playing + +--8<-- "docs/snippets/common/before_playing.md" + +## First launch + +--8<-- "docs/snippets/sega/common/service_jp_googlelens.md" + +!!! tip "" + + If you've followed all instructions correctly, you're now finally ready to launch the game! + + Start the game by running `App\package\launch.bat`. Let the game load until you reach a screen with the message below. + + + + Press your `Test` button (default `F1`) to enter the service menu. Use the `Service` button + (default `F2`) to navigate the menu, and `Test` button to select an option. + + Navigate to **ゲーム設定** (`GAME ASSIGNMENTS`, the 6th option). + + + + + Select **グループ内基準機の設定** (`SET STANDARD IN GROUP`, the second option) + and toggle this setting to **基準機** (`STANDARD`). + + + + + Select **終了** (`EXIT`, the last option) to exit to the main service menu. + + + + Navigate to **閉店設定** (`CLOSE SETTING`, the 10th option). + + + + + Navigate to **時** (`HOUR`, the 2nd option) and use the `Service` button + to toggle the setting until it says **全時刻** (`ALL TIME`). + + + + + 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/success.md" + +## Help + +--8<-- "docs/snippets/common/help.md" diff --git a/docs/games/sega/ongeki/common/troubleshooting.md b/docs/games/sega/ongeki/common/troubleshooting.md new file mode 100644 index 0000000..727babd --- /dev/null +++ b/docs/games/sega/ongeki/common/troubleshooting.md @@ -0,0 +1,76 @@ +# Troubleshooting + +--8<-- "docs/snippets/common/data_warning.md" + +### My game crashes on launch/stuck on "Starting System Process" + +!!! tip "" + + Could be due to **many** things, the most common of which are: + + - `amdaemon` crashing in the background. Make sure that the `config_*.json` files + have valid syntax, your ICF files are correct. + +??? info "Capturing logs from `amdaemon` for troubleshooting" + + To assist with troubleshooting, a script can be used to capture logs from `amdaemon`. Create a file named + `amdaemontest.bat` in `App\bin`, then paste the code block below into the file. + + ```batch + @echo off + cls + echo Attempting to run AM Daemon ... + echo Window should close after 30 seconds + echo Log will be generated at amdaemontest.txt + call :sub >amdaemontest.txt + exit /b + + :sub + pushd %~dp0 + start /b "AM Daemon" /min inject -d -k mu3hook.dll amdaemon.exe -f -c config_common.json config_server.json + ping 127.0.0.1 -n 31 > nul && taskkill /F /im amdaemon.exe + ``` + + Double-click it to run. The script should run for 30 seconds, and you will get a file + named `amdaemontest.txt` in `App\bin`, which you can send to help people troubleshoot your issue. + +### My game is stuck on a black screen at launch! +!!! tip "" + + This could also be due to **many** things, the most common of which are: + + - You have one or more incorrect/broken DLL(s) in `App\package\mu3_Data\Managed` + + This is likely to be `Assembly-CSharp.dll`, `Assembly-CSharp-firstpass.dll`, and/or `AMDaemon.NET.dll`. + You can try replacing the DLLs or re-downloading data from elsewhere. + - An ill-formed keychip is defined in `segatools.ini` + +### My game is running too slow/fast or the notes are out of sync! + +!!! tip "" + + The game could be running under or over its required refresh rate. + + - Make sure V-Sync isn't disabled in your graphics settings (called "Vertical sync" + in NVIDIA Control Panel and "Wait for Vertical Refresh" in AMD Control Panel.) + - Limit `mu3.exe` to run at 60 FPS using a tool like [RivaTuner](https://www.guru3d.com/download/rtss-rivatuner-statistics-server-download) or a patch. + + It could also be that your computer's performance isn't good enough to keep + a steady framerate. + +### My lever controls aren't working! +!!! tip "" + + You may need to calibrate your lever. + + From the `TEST MENU` select **レバー設定** (`LEVER SETTINGS`) and then move the lever left to + right ensuring that the game detects the full range of motion. + + Then save by selecting **終了** (`EXIT`) and then **保存する** (`SAVE`). + +### My game is stuttering + +!!! tip "" + + For NVIDIA users, create an override for `mu3.exe` in NVIDIA Control Panel + and change "Power management mode" to "**Prefer maximum performance**". \ No newline at end of file diff --git a/docs/games/sega/ongeki/refresh/c2c.md b/docs/games/sega/ongeki/refresh/c2c.md new file mode 100644 index 0000000..d8a86cc --- /dev/null +++ b/docs/games/sega/ongeki/refresh/c2c.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/ongeki/common/c2c.md" \ No newline at end of file diff --git a/docs/games/sega/ongeki/refresh/controllers.md b/docs/games/sega/ongeki/refresh/controllers.md new file mode 100644 index 0000000..d6a81ca --- /dev/null +++ b/docs/games/sega/ongeki/refresh/controllers.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/ongeki/common/controllers.md" \ No newline at end of file diff --git a/docs/games/sega/ongeki/refresh/setup.md b/docs/games/sega/ongeki/refresh/setup.md new file mode 100644 index 0000000..0262153 --- /dev/null +++ b/docs/games/sega/ongeki/refresh/setup.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/ongeki/common/setup.md" \ No newline at end of file diff --git a/docs/games/sega/ongeki/refresh/troubleshooting.md b/docs/games/sega/ongeki/refresh/troubleshooting.md new file mode 100644 index 0000000..ef1d173 --- /dev/null +++ b/docs/games/sega/ongeki/refresh/troubleshooting.md @@ -0,0 +1,2 @@ + +--8<-- "docs/games/sega/ongeki/common/troubleshooting.md" \ No newline at end of file diff --git a/docs/games/sega/wacca/reverse/controllers.md b/docs/games/sega/wacca/reverse/controllers.md new file mode 100644 index 0000000..4769329 --- /dev/null +++ b/docs/games/sega/wacca/reverse/controllers.md @@ -0,0 +1,88 @@ + +# Controllers + +--8<-- "docs/snippets/common/data_warning.md" + +!!! tip "" + + segatools, by default, only accepts keyboard input and XInput Controllers. + However, it can be configured with IO DLLs to add support for other controllers. + + The controller you plan on using should also be provided with these IO DLLs. If unsure, + check the support section for your controller, or contact the vendor directly. Alternate + options for the most common controllers are listed below. + + These IO DLLs should be copied to your game's `App\bin` folder and referenced in + `segatools.ini` under the `[mercuryio]` section. + +!!! tip "" + + If you have a single DLL, uncomment the `path=` line by removing the leading semicolon (`;`), + then add your DLL's file name after the `=`: + + ```ini hl_lines="5" + [mercuryio] + ; To use a custom WACCA IO DLL enter its path here. + ; Leave empty if you want to use Segatools built-in keyboard input. + ;(1)! + path=controller.dll + ``` + + 1. Note that there is no leading semicolon. + +## Touch screen / Mobile device + +!!! tip "" + + Both Any2WACCAi and Toucca allows you to use a touch screen or a mobile device as a WACCA controller. + It replicates the layout of an arcade WACCA cab. + +!!! info "Installation instructions" + + [Any2WACCAi](https://gitea.tendokyu.moe/Dniel97/SEGAguide/wiki/SDFE#any2waccai-installation) + [Toucca](https://github.com/BlueGlassBlock/toucca/?tab=readme-ov-file#setup) + + !!! warning "com0com issues" + + If you're getting errors such as `Could not find file 'COM5'`, and particularly if you're on Windows 11, com0com v3 may be causing issues. + Install [com0com v2](https://sourceforge.net/projects/com0com/files/com0com/2.2.2.0/com0com-2.2.2.0-x64-fre-signed.zip/download) instead. + +## WACVR + +!!! tip "" + + WACVR allows you to use a VR Headset to replicate a WACCA cab and use it as a controller. + +!!! tip "Setting up WACVR" + + Download WACVR from [here](https://github.com/xiaopeng12138/WACVR/releases/latest) and extract to a folder of your choice. + Copy the `mercuryio.dll` file to the the `App/bin` folder in your data folder. + + Edit your `segatools.ini` like this: + + ```ini hl_lines="4" + [mercuryio] + ; To use a custom WACCA IO DLL enter its path here. + ; Leave empty if you want to use Segatools built-in keyboard input. + path=mercuryio.dll + ``` + + Start up your VR software as well as SteamVR, then launch WACCA and `WACVR.exe`. + WACVR should set up with WACCA automatically. + +!!! warning + + If you're experiencing a warped screen in WACVR, make sure your monitor is set to portrait mode and + check the `Full display capture` box in WACVR. + +## Arcade hardware and other controllers + +!!! tip "" + + If you want to run the game on a real cab, check the [reDIVE World website](https://redive.world/) + +!!! tip "" + + If you're interested in using a cabinet slider, or possibly even + making your own controller, the [Cons&Stuff website](https://consandstuff.github.io/) + and Discord community is a great place to start! \ No newline at end of file diff --git a/docs/games/sega/wacca/reverse/setup.md b/docs/games/sega/wacca/reverse/setup.md new file mode 100644 index 0000000..6bc4454 --- /dev/null +++ b/docs/games/sega/wacca/reverse/setup.md @@ -0,0 +1,140 @@ + +# Game Setup + +--8<-- "docs/snippets/common/data_warning.md" + +--8<-- "docs/snippets/sega/common/data_old.md" + +!!! warning "Wireless Device" + + The Chinese SDJE Version requires a custom piece of hardware that will likely not work with known tools. + + If you're having issues with a "Wireless Device" during boot or network testing, you likely need a different version of the game data. + +## Preparing data + +--8<-- "docs/snippets/sega/common/data_driveletter.md" + +--8<-- "docs/snippets/common/data_readonly.md" + +--8<-- "docs/snippets/sega/common/data_preparation.md" + + ``` + 📂bin + 📂pxbin + 📂WindowsNoEditor + 📄firewall.cfg + ▶️game.bat + ▶️pxGetHwinfo.exe + 📝pxGetHwInfo.ini + 📄system_config.json + ``` + +--8<-- "docs/snippets/sega/common/data_bad.md" + +## Updating data + +--8<-- "docs/snippets/sega/common/data_updating.md" + +## Installing ICFs + +--8<-- "docs/snippets/sega/common/data_icfs.md" + +## Patching the game + +--8<-- "docs/snippets/sega/common/patching.md" + +## Installing segatools + +--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 these files added to your `App\bin` directory: + + ``` + 📂DEVICE + ▶️inject.exe + ⚙️mercuryhook.dll + 📝segatools.ini + ▶️launch.bat + ``` + +## Configuring segatools + +--8<-- "docs/snippets/sega/common/segatools_preamble_bin.md" + +=== "[vfs]" + +--8<-- "docs/snippets/sega/common/segatools_relativepaths.md" + +--8<-- "docs/snippets/sega/common/segatools_vfs.md" + +## Configuring audio + +--8<-- "docs/snippets/common/audio_48khz.md" + +## Connecting to a network + +--8<-- "docs/snippets/sega/common/network_preamble.md" + +--8<-- "docs/snippets/sega/common/network_remote.md" + +--8<-- "docs/snippets/sega/common/network_local.md" + +## Installing FTDI LEDs driver + +!!! tip "" + + - 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 + +--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! + + Set your display orientation to portrait mode. + + Start the game by running `App\bin\launch.bat`. + + Press your `Test` button (default `F1`) to enter the service menu. Use the `Service` button + (default `F2`) to navigate the menu, and `Test` button to select an option. + + You can also use the Volume buttons (default `UP` and `DOWN` keys) to navigate + and the `ENTER` key to select. + + Navigate to **SYSTEM SETTING**. + + + + Navigate to **CLOSING TIME SETTINGS**. + + + + Navigate to **ALL DAYS OF THE WEEK** and use the `Service` button + to toggle the setting until it says **OFF**. + + + + Select **APPLY SETTINGS AND RE-BOOT** to save the settings. + + Note that this will close your game and you will have to start it again + with `launch.bat`. + +--8<-- "docs/snippets/sega/common/success.md" + +## Help + +--8<-- "docs/snippets/common/help.md" diff --git a/docs/games/taito/tetoteconnect/setup.md b/docs/games/taito/tetoteconnect/setup.md new file mode 100644 index 0000000..08ef0f4 --- /dev/null +++ b/docs/games/taito/tetoteconnect/setup.md @@ -0,0 +1,131 @@ + +# 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 **5 GB or larger**. + + Here's what the expected data structure should look like: + + ``` + 📂[SYSTEM] + 📂MonoBleedingEdge + 📂System Volume Information + 📂Vision_Data + ▶️game.exe + 📄game.inf + ▶️RunVisionProd.bat + ▶️Setting.bat + ▶️UnityCrashHandler64.exe + ⚙️UnityPlayer.dll + ▶️Vision.exe + ⚙️WinPixEventRuntime.dll + ``` + +## Installing BepInEx + +!!! tip "" + + - Download the most recent [BepInEx 5 release](https://github.com/BepInEx/BepInEx/releases) (`BepInEx_win_x64_5.x.y.z.zip`) + + !!! warning "We need BepInEx 5 since as of writing, BepInEx 6 does not support the required plugin" + + - Extract the archive to the root folder of your game data + + You should now have these files added to your directory: + + ``` + 📂BepInEx + 📄.doorstop_version + 📄changelog.txt + 📝doorstop_config.ini + ⚙️winhttp.dll + ``` + +## Installing tetoco + +!!! tip "" + + - Head over to [tetoco releases](https://github.com/Redcrafter/tetoco/releases) + - Download `tetoco.dll` + - Create a folder called `plugins` in the `BepInEx` folder + - Move the dll file to that newly created folder + + You should end up with a file structure as follows: + + ``` + 📂BepInEx + ┗ 📂plugins + ┗⚙️tetoco.dll + ``` + +## Installing VCRedist & DirectX + +--8<-- "docs/snippets/common/setup_vcredist_directx.md" + +## Monitor orientation + +!!! info "With tetoco installed, the game won't automatically rotate to portrait mode when starting it" + + The game can be played in landscape mode but a lot of the play area will be lost, it's best to set your monitor to portrait mode before launching the game. + +??? tip "Manually rotating" + + - Right click on your Desktop + - Select `Display settings` + - Look for `Display orientation` and set it to `Portrait` or `Portrait (flipped)` + - Rotate your monitor 90° + +??? tip "Automatically rotating" + + Right click on [this link](https://raw.githubusercontent.com/gmiwoj/Windows-Display-Orientation-Script/main/windows-display-orientation-script.ps1) + then `Save Link As` and place the `windows-display-orientation-script.ps1` file in your game's directory. + + Create a new `start.bat` file, and set its content to this, it will set your monitor as **Portrait (flipped)**, and automatically rotate it back once you close the game. + + ```ini + powershell.exe -ExecutionPolicy Bypass -File "windows-display-orientation-script.ps1" 0 90 + Vision.exe + powershell.exe -ExecutionPolicy Bypass -File "windows-display-orientation-script.ps1" 0 0 + ``` + + Alternatively, you can set it to **Portrait** *(not flipped)* by changing `90` to `270`. + + ```ini + powershell.exe -ExecutionPolicy Bypass -File "windows-display-orientation-script.ps1" 0 270 + Vision.exe + powershell.exe -ExecutionPolicy Bypass -File "windows-display-orientation-script.ps1" 0 0 + ``` + +## First launch + +!!! tip "" + + If you've followed all instructions correctly, you're ready to launch the game. + + Start the game by running `Vision.exe`, or `start.bat` if you followed [the automatic monitor rotation part](#monitor-orientation). + +!!! tip "" + + You're all done! The game should load up properly now. + + You can use the **Login as Local** button to use your local save profile. + + The `T` key can be pressed to access the service menu. + +## Connecting to a network + +!!! info "By default, tetoco uses its own local network and saves data locally" + + Please follow this step only if you have a network to connect to. + +??? tip "Remote (Online Network)" + + - Open the automatically created configuration file `BepInEx\config\tetoco.cfg` + - Set `UseLocalServer` to **false** + - Then, set `RemoteServer` to the address provided by your network + - Finally, set the `CardId` provided by your network \ No newline at end of file diff --git a/docs/img/common/audio_16_441.webp b/docs/img/common/audio_16_441.webp new file mode 100644 index 0000000..bd41aaa Binary files /dev/null and b/docs/img/common/audio_16_441.webp differ diff --git a/docs/img/common/audio_16_48.webp b/docs/img/common/audio_16_48.webp new file mode 100644 index 0000000..4856576 Binary files /dev/null and b/docs/img/common/audio_16_48.webp differ diff --git a/docs/img/common/audio_24_441.webp b/docs/img/common/audio_24_441.webp new file mode 100644 index 0000000..3619547 Binary files /dev/null and b/docs/img/common/audio_24_441.webp differ diff --git a/docs/img/common/audio_24_48.webp b/docs/img/common/audio_24_48.webp new file mode 100644 index 0000000..ab436e1 Binary files /dev/null and b/docs/img/common/audio_24_48.webp differ diff --git a/docs/img/common/audio_exclusive.webp b/docs/img/common/audio_exclusive.webp new file mode 100644 index 0000000..151076e Binary files /dev/null and b/docs/img/common/audio_exclusive.webp differ diff --git a/docs/img/common/orientation_landscape.webp b/docs/img/common/orientation_landscape.webp new file mode 100644 index 0000000..50c22c9 Binary files /dev/null and b/docs/img/common/orientation_landscape.webp differ diff --git a/docs/img/common/orientation_portrait.webp b/docs/img/common/orientation_portrait.webp new file mode 100644 index 0000000..d4bede2 Binary files /dev/null and b/docs/img/common/orientation_portrait.webp differ diff --git a/docs/img/common/spice2x_cards.webp b/docs/img/common/spice2x_cards.webp new file mode 100644 index 0000000..26d126b Binary files /dev/null and b/docs/img/common/spice2x_cards.webp differ diff --git a/docs/img/common/spice2x_network.webp b/docs/img/common/spice2x_network.webp new file mode 100644 index 0000000..036977c Binary files /dev/null and b/docs/img/common/spice2x_network.webp differ diff --git a/docs/img/common/spice2x_option_hover.webp b/docs/img/common/spice2x_option_hover.webp new file mode 100644 index 0000000..3e0a206 Binary files /dev/null and b/docs/img/common/spice2x_option_hover.webp differ diff --git a/docs/img/extras/asphyxia/logo.webp b/docs/img/extras/asphyxia/logo.webp new file mode 100644 index 0000000..cd3fa29 Binary files /dev/null and b/docs/img/extras/asphyxia/logo.webp differ diff --git a/docs/img/extras/audio/obs_audiosettings.webp b/docs/img/extras/audio/obs_audiosettings.webp new file mode 100644 index 0000000..b357122 Binary files /dev/null and b/docs/img/extras/audio/obs_audiosettings.webp differ diff --git a/docs/img/extras/audio/obs_capturedevice.webp b/docs/img/extras/audio/obs_capturedevice.webp new file mode 100644 index 0000000..55e5b56 Binary files /dev/null and b/docs/img/extras/audio/obs_capturedevice.webp differ diff --git a/docs/img/extras/audio/obs_inputcapture.webp b/docs/img/extras/audio/obs_inputcapture.webp new file mode 100644 index 0000000..9e16e04 Binary files /dev/null and b/docs/img/extras/audio/obs_inputcapture.webp differ diff --git a/docs/img/extras/audio/obs_monitorandoutput.webp b/docs/img/extras/audio/obs_monitorandoutput.webp new file mode 100644 index 0000000..23809a7 Binary files /dev/null and b/docs/img/extras/audio/obs_monitorandoutput.webp differ diff --git a/docs/img/extras/audio/obs_settings.webp b/docs/img/extras/audio/obs_settings.webp new file mode 100644 index 0000000..d1146f0 Binary files /dev/null and b/docs/img/extras/audio/obs_settings.webp differ diff --git a/docs/img/extras/audio/voicemeeter_menuopts.webp b/docs/img/extras/audio/voicemeeter_menuopts.webp new file mode 100644 index 0000000..ce93048 Binary files /dev/null and b/docs/img/extras/audio/voicemeeter_menuopts.webp differ diff --git a/docs/img/extras/audio/voicemeeter_outputs.webp b/docs/img/extras/audio/voicemeeter_outputs.webp new file mode 100644 index 0000000..fe82671 Binary files /dev/null and b/docs/img/extras/audio/voicemeeter_outputs.webp differ diff --git a/docs/img/extras/controllers/chuni/gamo2_tasollerplus.webp b/docs/img/extras/controllers/chuni/gamo2_tasollerplus.webp new file mode 100644 index 0000000..7ce8d77 Binary files /dev/null and b/docs/img/extras/controllers/chuni/gamo2_tasollerplus.webp differ diff --git a/docs/img/extras/controllers/chuni/yuancon_laverita.webp b/docs/img/extras/controllers/chuni/yuancon_laverita.webp new file mode 100644 index 0000000..aaa5e23 Binary files /dev/null and b/docs/img/extras/controllers/chuni/yuancon_laverita.webp differ diff --git a/docs/img/extras/controllers/ddr/l-tek.webp b/docs/img/extras/controllers/ddr/l-tek.webp new file mode 100644 index 0000000..3411f99 Binary files /dev/null and b/docs/img/extras/controllers/ddr/l-tek.webp differ diff --git a/docs/img/extras/controllers/ddr/yuancon_pad.webp b/docs/img/extras/controllers/ddr/yuancon_pad.webp new file mode 100644 index 0000000..c4a15c0 Binary files /dev/null and b/docs/img/extras/controllers/ddr/yuancon_pad.webp differ diff --git a/docs/img/extras/controllers/iidx/gamo2_pwan.webp b/docs/img/extras/controllers/iidx/gamo2_pwan.webp new file mode 100644 index 0000000..edb9966 Binary files /dev/null and b/docs/img/extras/controllers/iidx/gamo2_pwan.webp differ diff --git a/docs/img/extras/controllers/iidx/yuancon_dx6th.webp b/docs/img/extras/controllers/iidx/yuancon_dx6th.webp new file mode 100644 index 0000000..04ad140 Binary files /dev/null and b/docs/img/extras/controllers/iidx/yuancon_dx6th.webp differ diff --git a/docs/img/extras/controllers/maimai/yuancon_ndx.webp b/docs/img/extras/controllers/maimai/yuancon_ndx.webp new file mode 100644 index 0000000..32803df Binary files /dev/null and b/docs/img/extras/controllers/maimai/yuancon_ndx.webp differ diff --git a/docs/img/extras/controllers/nost/gamo2_nostroller.webp b/docs/img/extras/controllers/nost/gamo2_nostroller.webp new file mode 100644 index 0000000..06088f6 Binary files /dev/null and b/docs/img/extras/controllers/nost/gamo2_nostroller.webp differ diff --git a/docs/img/extras/controllers/ongeki/gamo2_ontroller.webp b/docs/img/extras/controllers/ongeki/gamo2_ontroller.webp new file mode 100644 index 0000000..9e6d462 Binary files /dev/null and b/docs/img/extras/controllers/ongeki/gamo2_ontroller.webp differ diff --git a/docs/img/extras/controllers/ongeki/yuancon_yuangeki.webp b/docs/img/extras/controllers/ongeki/yuancon_yuangeki.webp new file mode 100644 index 0000000..a6fbc12 Binary files /dev/null and b/docs/img/extras/controllers/ongeki/yuancon_yuangeki.webp differ diff --git a/docs/img/extras/controllers/popn/gamo2_popoller.webp b/docs/img/extras/controllers/popn/gamo2_popoller.webp new file mode 100644 index 0000000..d24060b Binary files /dev/null and b/docs/img/extras/controllers/popn/gamo2_popoller.webp differ diff --git a/docs/img/extras/controllers/popn/yuancon_popn.webp b/docs/img/extras/controllers/popn/yuancon_popn.webp new file mode 100644 index 0000000..658b35e Binary files /dev/null and b/docs/img/extras/controllers/popn/yuancon_popn.webp differ diff --git a/docs/img/extras/controllers/sdvx/gamo2_faucetwo.webp b/docs/img/extras/controllers/sdvx/gamo2_faucetwo.webp new file mode 100644 index 0000000..9d69b15 Binary files /dev/null and b/docs/img/extras/controllers/sdvx/gamo2_faucetwo.webp differ diff --git a/docs/img/extras/controllers/sdvx/yuancon_sdvx12.webp b/docs/img/extras/controllers/sdvx/yuancon_sdvx12.webp new file mode 100644 index 0000000..fc907a7 Binary files /dev/null and b/docs/img/extras/controllers/sdvx/yuancon_sdvx12.webp differ diff --git a/docs/img/extras/controllers/sdvx/yuancon_sdvxlite3.webp b/docs/img/extras/controllers/sdvx/yuancon_sdvxlite3.webp new file mode 100644 index 0000000..ef1673b Binary files /dev/null and b/docs/img/extras/controllers/sdvx/yuancon_sdvxlite3.webp differ diff --git a/docs/img/extras/controllers/taiko/gamo2_taikoller.webp b/docs/img/extras/controllers/taiko/gamo2_taikoller.webp new file mode 100644 index 0000000..1ecaf1b Binary files /dev/null and b/docs/img/extras/controllers/taiko/gamo2_taikoller.webp differ diff --git a/docs/img/extras/controllers/taiko/hori_tatacon.webp b/docs/img/extras/controllers/taiko/hori_tatacon.webp new file mode 100644 index 0000000..7dca4ba Binary files /dev/null and b/docs/img/extras/controllers/taiko/hori_tatacon.webp differ diff --git a/docs/img/extras/controllers/taiko/iine_taikopromax.webp b/docs/img/extras/controllers/taiko/iine_taikopromax.webp new file mode 100644 index 0000000..f57ebdc Binary files /dev/null and b/docs/img/extras/controllers/taiko/iine_taikopromax.webp differ diff --git a/docs/img/extras/controllers/taiko/iine_tatacon.webp b/docs/img/extras/controllers/taiko/iine_tatacon.webp new file mode 100644 index 0000000..ad5e159 Binary files /dev/null and b/docs/img/extras/controllers/taiko/iine_tatacon.webp differ diff --git a/docs/img/extras/controllers/taiko/rythmagica_tdc10pro.webp b/docs/img/extras/controllers/taiko/rythmagica_tdc10pro.webp new file mode 100644 index 0000000..48bf2c1 Binary files /dev/null and b/docs/img/extras/controllers/taiko/rythmagica_tdc10pro.webp differ diff --git a/docs/img/extras/controllers/taiko/rythmagica_tdc17.webp b/docs/img/extras/controllers/taiko/rythmagica_tdc17.webp new file mode 100644 index 0000000..5a61fb2 Binary files /dev/null and b/docs/img/extras/controllers/taiko/rythmagica_tdc17.webp differ diff --git a/docs/img/extras/controllers/taiko/yuancon_taikoforcelv6.webp b/docs/img/extras/controllers/taiko/yuancon_taikoforcelv6.webp new file mode 100644 index 0000000..1306923 Binary files /dev/null and b/docs/img/extras/controllers/taiko/yuancon_taikoforcelv6.webp differ diff --git a/docs/img/extras/controllers/taiko/zhong_taiko.webp b/docs/img/extras/controllers/taiko/zhong_taiko.webp new file mode 100644 index 0000000..2f79308 Binary files /dev/null and b/docs/img/extras/controllers/taiko/zhong_taiko.webp differ diff --git a/docs/img/extras/datamods/1.webp b/docs/img/extras/datamods/1.webp new file mode 100644 index 0000000..1c2dad4 Binary files /dev/null and b/docs/img/extras/datamods/1.webp differ diff --git a/docs/img/extras/datamods/2.webp b/docs/img/extras/datamods/2.webp new file mode 100644 index 0000000..e71cd9e Binary files /dev/null and b/docs/img/extras/datamods/2.webp differ diff --git a/docs/img/extras/datamods/3.webp b/docs/img/extras/datamods/3.webp new file mode 100644 index 0000000..230fdca Binary files /dev/null and b/docs/img/extras/datamods/3.webp differ diff --git a/docs/img/extras/datamods/4.webp b/docs/img/extras/datamods/4.webp new file mode 100644 index 0000000..2ef73cd Binary files /dev/null and b/docs/img/extras/datamods/4.webp differ diff --git a/docs/img/extras/datamods/5.webp b/docs/img/extras/datamods/5.webp new file mode 100644 index 0000000..f8817c0 Binary files /dev/null and b/docs/img/extras/datamods/5.webp differ diff --git a/docs/img/extras/datamods/6.webp b/docs/img/extras/datamods/6.webp new file mode 100644 index 0000000..c4f9b4d Binary files /dev/null and b/docs/img/extras/datamods/6.webp differ diff --git a/docs/img/extras/datamods/7.webp b/docs/img/extras/datamods/7.webp new file mode 100644 index 0000000..907ef1a Binary files /dev/null and b/docs/img/extras/datamods/7.webp differ diff --git a/docs/img/extras/datamods/8.webp b/docs/img/extras/datamods/8.webp new file mode 100644 index 0000000..83c262b Binary files /dev/null and b/docs/img/extras/datamods/8.webp differ diff --git a/docs/img/extras/hexguide/1.webp b/docs/img/extras/hexguide/1.webp new file mode 100644 index 0000000..f1c533c Binary files /dev/null and b/docs/img/extras/hexguide/1.webp differ diff --git a/docs/img/extras/hexguide/2.webp b/docs/img/extras/hexguide/2.webp new file mode 100644 index 0000000..924b533 Binary files /dev/null and b/docs/img/extras/hexguide/2.webp differ diff --git a/docs/img/extras/hexguide/3.webp b/docs/img/extras/hexguide/3.webp new file mode 100644 index 0000000..20a13a2 Binary files /dev/null and b/docs/img/extras/hexguide/3.webp differ diff --git a/docs/img/extras/hexguide/4.webp b/docs/img/extras/hexguide/4.webp new file mode 100644 index 0000000..1ff64e8 Binary files /dev/null and b/docs/img/extras/hexguide/4.webp differ diff --git a/docs/img/extras/hexguide/5.webp b/docs/img/extras/hexguide/5.webp new file mode 100644 index 0000000..783732a Binary files /dev/null and b/docs/img/extras/hexguide/5.webp differ diff --git a/docs/img/extras/patchsp2x/1.webp b/docs/img/extras/patchsp2x/1.webp new file mode 100644 index 0000000..b395ca7 Binary files /dev/null and b/docs/img/extras/patchsp2x/1.webp differ diff --git a/docs/img/extras/patchsp2x/2.webp b/docs/img/extras/patchsp2x/2.webp new file mode 100644 index 0000000..6038291 Binary files /dev/null and b/docs/img/extras/patchsp2x/2.webp differ diff --git a/docs/img/extras/patchsp2x/3.webp b/docs/img/extras/patchsp2x/3.webp new file mode 100644 index 0000000..1c3e28c Binary files /dev/null and b/docs/img/extras/patchsp2x/3.webp differ diff --git a/docs/img/extras/patchsp2x/4.webp b/docs/img/extras/patchsp2x/4.webp new file mode 100644 index 0000000..b4a1dd3 Binary files /dev/null and b/docs/img/extras/patchsp2x/4.webp differ diff --git a/docs/img/extras/patchweb/1.webp b/docs/img/extras/patchweb/1.webp new file mode 100644 index 0000000..aff3651 Binary files /dev/null and b/docs/img/extras/patchweb/1.webp differ diff --git a/docs/img/extras/patchweb/2.webp b/docs/img/extras/patchweb/2.webp new file mode 100644 index 0000000..b45c260 Binary files /dev/null and b/docs/img/extras/patchweb/2.webp differ diff --git a/docs/img/extras/patchweb/3.webp b/docs/img/extras/patchweb/3.webp new file mode 100644 index 0000000..d1c5503 Binary files /dev/null and b/docs/img/extras/patchweb/3.webp differ diff --git a/docs/img/extras/patchweb/4.webp b/docs/img/extras/patchweb/4.webp new file mode 100644 index 0000000..a1382ca Binary files /dev/null and b/docs/img/extras/patchweb/4.webp differ diff --git a/docs/img/extras/patchweb/5.webp b/docs/img/extras/patchweb/5.webp new file mode 100644 index 0000000..7416ec9 Binary files /dev/null and b/docs/img/extras/patchweb/5.webp differ diff --git a/docs/img/extras/patchweb/6.webp b/docs/img/extras/patchweb/6.webp new file mode 100644 index 0000000..900ab19 Binary files /dev/null and b/docs/img/extras/patchweb/6.webp differ diff --git a/docs/img/extras/zerotier/config_advanced.webp b/docs/img/extras/zerotier/config_advanced.webp new file mode 100644 index 0000000..6282cbb Binary files /dev/null and b/docs/img/extras/zerotier/config_advanced.webp differ diff --git a/docs/img/extras/zerotier/ipconfig.webp b/docs/img/extras/zerotier/ipconfig.webp new file mode 100644 index 0000000..3bf8277 Binary files /dev/null and b/docs/img/extras/zerotier/ipconfig.webp differ diff --git a/docs/img/extras/zerotier/logo.webp b/docs/img/extras/zerotier/logo.webp new file mode 100644 index 0000000..64b8736 Binary files /dev/null and b/docs/img/extras/zerotier/logo.webp differ diff --git a/docs/img/favicon.ico b/docs/img/favicon.ico new file mode 100644 index 0000000..0261e10 Binary files /dev/null and b/docs/img/favicon.ico differ diff --git a/docs/img/konami/beatstream/animutribe/1.webp b/docs/img/konami/beatstream/animutribe/1.webp new file mode 100644 index 0000000..44ef455 Binary files /dev/null and b/docs/img/konami/beatstream/animutribe/1.webp differ diff --git a/docs/img/konami/beatstream/animutribe/logo.webp b/docs/img/konami/beatstream/animutribe/logo.webp new file mode 100644 index 0000000..dc4124f Binary files /dev/null and b/docs/img/konami/beatstream/animutribe/logo.webp differ diff --git a/docs/img/konami/ddr/a20/logo.webp b/docs/img/konami/ddr/a20/logo.webp new file mode 100644 index 0000000..c3c087d Binary files /dev/null and b/docs/img/konami/ddr/a20/logo.webp differ diff --git a/docs/img/konami/ddr/a20plus/logo.webp b/docs/img/konami/ddr/a20plus/logo.webp new file mode 100644 index 0000000..599c5da Binary files /dev/null and b/docs/img/konami/ddr/a20plus/logo.webp differ diff --git a/docs/img/konami/ddr/a3/logo.webp b/docs/img/konami/ddr/a3/logo.webp new file mode 100644 index 0000000..f0a7ce3 Binary files /dev/null and b/docs/img/konami/ddr/a3/logo.webp differ diff --git a/docs/img/konami/ddr/world/logo.webp b/docs/img/konami/ddr/world/logo.webp new file mode 100644 index 0000000..1ba6538 Binary files /dev/null and b/docs/img/konami/ddr/world/logo.webp differ diff --git a/docs/img/konami/gitadora/exchain/1.webp b/docs/img/konami/gitadora/exchain/1.webp new file mode 100644 index 0000000..96bc134 Binary files /dev/null and b/docs/img/konami/gitadora/exchain/1.webp differ diff --git a/docs/img/konami/gitadora/exchain/logo.webp b/docs/img/konami/gitadora/exchain/logo.webp new file mode 100644 index 0000000..e12a1b5 Binary files /dev/null and b/docs/img/konami/gitadora/exchain/logo.webp differ diff --git a/docs/img/konami/gitadora/fuzzup/logo.webp b/docs/img/konami/gitadora/fuzzup/logo.webp new file mode 100644 index 0000000..26439a1 Binary files /dev/null and b/docs/img/konami/gitadora/fuzzup/logo.webp differ diff --git a/docs/img/konami/gitadora/fuzzup/spice.webp b/docs/img/konami/gitadora/fuzzup/spice.webp new file mode 100644 index 0000000..dfe4b72 Binary files /dev/null and b/docs/img/konami/gitadora/fuzzup/spice.webp differ diff --git a/docs/img/konami/gitadora/matixx/1.webp b/docs/img/konami/gitadora/matixx/1.webp new file mode 100644 index 0000000..e1c2b3d Binary files /dev/null and b/docs/img/konami/gitadora/matixx/1.webp differ diff --git a/docs/img/konami/gitadora/matixx/2d.webp b/docs/img/konami/gitadora/matixx/2d.webp new file mode 100644 index 0000000..ead8926 Binary files /dev/null and b/docs/img/konami/gitadora/matixx/2d.webp differ diff --git a/docs/img/konami/gitadora/matixx/2g.webp b/docs/img/konami/gitadora/matixx/2g.webp new file mode 100644 index 0000000..d2f9cf3 Binary files /dev/null and b/docs/img/konami/gitadora/matixx/2g.webp differ diff --git a/docs/img/konami/gitadora/matixx/3d.webp b/docs/img/konami/gitadora/matixx/3d.webp new file mode 100644 index 0000000..f1ff369 Binary files /dev/null and b/docs/img/konami/gitadora/matixx/3d.webp differ diff --git a/docs/img/konami/gitadora/matixx/3g.webp b/docs/img/konami/gitadora/matixx/3g.webp new file mode 100644 index 0000000..8023717 Binary files /dev/null and b/docs/img/konami/gitadora/matixx/3g.webp differ diff --git a/docs/img/konami/gitadora/matixx/4.webp b/docs/img/konami/gitadora/matixx/4.webp new file mode 100644 index 0000000..054c350 Binary files /dev/null and b/docs/img/konami/gitadora/matixx/4.webp differ diff --git a/docs/img/konami/gitadora/matixx/5.webp b/docs/img/konami/gitadora/matixx/5.webp new file mode 100644 index 0000000..e5fde49 Binary files /dev/null and b/docs/img/konami/gitadora/matixx/5.webp differ diff --git a/docs/img/konami/gitadora/matixx/6.webp b/docs/img/konami/gitadora/matixx/6.webp new file mode 100644 index 0000000..6f684a0 Binary files /dev/null and b/docs/img/konami/gitadora/matixx/6.webp differ diff --git a/docs/img/konami/gitadora/matixx/7.webp b/docs/img/konami/gitadora/matixx/7.webp new file mode 100644 index 0000000..9717c3f Binary files /dev/null and b/docs/img/konami/gitadora/matixx/7.webp differ diff --git a/docs/img/konami/gitadora/matixx/8.webp b/docs/img/konami/gitadora/matixx/8.webp new file mode 100644 index 0000000..69c3382 Binary files /dev/null and b/docs/img/konami/gitadora/matixx/8.webp differ diff --git a/docs/img/konami/gitadora/matixx/9.webp b/docs/img/konami/gitadora/matixx/9.webp new file mode 100644 index 0000000..2a29e2f Binary files /dev/null and b/docs/img/konami/gitadora/matixx/9.webp differ diff --git a/docs/img/konami/gitadora/matixx/logo.webp b/docs/img/konami/gitadora/matixx/logo.webp new file mode 100644 index 0000000..77916ce Binary files /dev/null and b/docs/img/konami/gitadora/matixx/logo.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/1.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/1.webp new file mode 100644 index 0000000..a804e78 Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/1.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/10.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/10.webp new file mode 100644 index 0000000..2cbb4db Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/10.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/11.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/11.webp new file mode 100644 index 0000000..e38aec9 Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/11.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/12.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/12.webp new file mode 100644 index 0000000..006d5c4 Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/12.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/2.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/2.webp new file mode 100644 index 0000000..294974d Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/2.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/3.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/3.webp new file mode 100644 index 0000000..09d9645 Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/3.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/4.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/4.webp new file mode 100644 index 0000000..632e77e Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/4.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/5.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/5.webp new file mode 100644 index 0000000..05672d0 Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/5.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/6.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/6.webp new file mode 100644 index 0000000..008714e Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/6.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/7.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/7.webp new file mode 100644 index 0000000..4043da7 Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/7.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/8.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/8.webp new file mode 100644 index 0000000..7f6538f Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/8.webp differ diff --git a/docs/img/konami/iidx/10thstyle/firstlaunch/9.webp b/docs/img/konami/iidx/10thstyle/firstlaunch/9.webp new file mode 100644 index 0000000..a54636c Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/firstlaunch/9.webp differ diff --git a/docs/img/konami/iidx/10thstyle/iidx10_linear.webp b/docs/img/konami/iidx/10thstyle/iidx10_linear.webp new file mode 100644 index 0000000..b1b4a16 Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/iidx10_linear.webp differ diff --git a/docs/img/konami/iidx/10thstyle/iidx10_point.webp b/docs/img/konami/iidx/10thstyle/iidx10_point.webp new file mode 100644 index 0000000..b152f66 Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/iidx10_point.webp differ diff --git a/docs/img/konami/iidx/10thstyle/logo.webp b/docs/img/konami/iidx/10thstyle/logo.webp new file mode 100644 index 0000000..5b4b9a8 Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/logo.webp differ diff --git a/docs/img/konami/iidx/10thstyle/setup/1.webp b/docs/img/konami/iidx/10thstyle/setup/1.webp new file mode 100644 index 0000000..0d69ab1 Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/setup/1.webp differ diff --git a/docs/img/konami/iidx/10thstyle/setup/2.webp b/docs/img/konami/iidx/10thstyle/setup/2.webp new file mode 100644 index 0000000..8cde67c Binary files /dev/null and b/docs/img/konami/iidx/10thstyle/setup/2.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/1.webp b/docs/img/konami/iidx/11_red/firstlaunch/1.webp new file mode 100644 index 0000000..9bc4820 Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/1.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/10.webp b/docs/img/konami/iidx/11_red/firstlaunch/10.webp new file mode 100644 index 0000000..ee35a5f Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/10.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/11.webp b/docs/img/konami/iidx/11_red/firstlaunch/11.webp new file mode 100644 index 0000000..405c0d9 Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/11.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/12.webp b/docs/img/konami/iidx/11_red/firstlaunch/12.webp new file mode 100644 index 0000000..fc84df0 Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/12.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/2.webp b/docs/img/konami/iidx/11_red/firstlaunch/2.webp new file mode 100644 index 0000000..294974d Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/2.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/3.webp b/docs/img/konami/iidx/11_red/firstlaunch/3.webp new file mode 100644 index 0000000..09d9645 Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/3.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/4.webp b/docs/img/konami/iidx/11_red/firstlaunch/4.webp new file mode 100644 index 0000000..7aeeb7e Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/4.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/5.webp b/docs/img/konami/iidx/11_red/firstlaunch/5.webp new file mode 100644 index 0000000..bdb5563 Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/5.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/6.webp b/docs/img/konami/iidx/11_red/firstlaunch/6.webp new file mode 100644 index 0000000..aed7671 Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/6.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/7.webp b/docs/img/konami/iidx/11_red/firstlaunch/7.webp new file mode 100644 index 0000000..03fe667 Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/7.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/8.webp b/docs/img/konami/iidx/11_red/firstlaunch/8.webp new file mode 100644 index 0000000..042565f Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/8.webp differ diff --git a/docs/img/konami/iidx/11_red/firstlaunch/9.webp b/docs/img/konami/iidx/11_red/firstlaunch/9.webp new file mode 100644 index 0000000..f4875d9 Binary files /dev/null and b/docs/img/konami/iidx/11_red/firstlaunch/9.webp differ diff --git a/docs/img/konami/iidx/11_red/iidx11_linear.webp b/docs/img/konami/iidx/11_red/iidx11_linear.webp new file mode 100644 index 0000000..40c5f3a Binary files /dev/null and b/docs/img/konami/iidx/11_red/iidx11_linear.webp differ diff --git a/docs/img/konami/iidx/11_red/iidx11_point.webp b/docs/img/konami/iidx/11_red/iidx11_point.webp new file mode 100644 index 0000000..b5066e3 Binary files /dev/null and b/docs/img/konami/iidx/11_red/iidx11_point.webp differ diff --git a/docs/img/konami/iidx/11_red/logo.webp b/docs/img/konami/iidx/11_red/logo.webp new file mode 100644 index 0000000..c2fa26d Binary files /dev/null and b/docs/img/konami/iidx/11_red/logo.webp differ diff --git a/docs/img/konami/iidx/11_red/setup/1.webp b/docs/img/konami/iidx/11_red/setup/1.webp new file mode 100644 index 0000000..6eebf25 Binary files /dev/null and b/docs/img/konami/iidx/11_red/setup/1.webp differ diff --git a/docs/img/konami/iidx/11_red/setup/2.webp b/docs/img/konami/iidx/11_red/setup/2.webp new file mode 100644 index 0000000..8cde67c Binary files /dev/null and b/docs/img/konami/iidx/11_red/setup/2.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/1.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/1.webp new file mode 100644 index 0000000..4805113 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/1.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/10.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/10.webp new file mode 100644 index 0000000..ee35a5f Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/10.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/11.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/11.webp new file mode 100644 index 0000000..405c0d9 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/11.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/12.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/12.webp new file mode 100644 index 0000000..fc84df0 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/12.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/2.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/2.webp new file mode 100644 index 0000000..294974d Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/2.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/3.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/3.webp new file mode 100644 index 0000000..09d9645 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/3.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/4.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/4.webp new file mode 100644 index 0000000..465d6b9 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/4.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/5.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/5.webp new file mode 100644 index 0000000..bdb5563 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/5.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/6.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/6.webp new file mode 100644 index 0000000..f617092 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/6.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/7.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/7.webp new file mode 100644 index 0000000..03fe667 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/7.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/8.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/8.webp new file mode 100644 index 0000000..042565f Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/8.webp differ diff --git a/docs/img/konami/iidx/12_happysky/firstlaunch/9.webp b/docs/img/konami/iidx/12_happysky/firstlaunch/9.webp new file mode 100644 index 0000000..f4875d9 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/firstlaunch/9.webp differ diff --git a/docs/img/konami/iidx/12_happysky/iidx12_linear.webp b/docs/img/konami/iidx/12_happysky/iidx12_linear.webp new file mode 100644 index 0000000..71465f0 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/iidx12_linear.webp differ diff --git a/docs/img/konami/iidx/12_happysky/iidx12_point.webp b/docs/img/konami/iidx/12_happysky/iidx12_point.webp new file mode 100644 index 0000000..f512cb0 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/iidx12_point.webp differ diff --git a/docs/img/konami/iidx/12_happysky/logo.webp b/docs/img/konami/iidx/12_happysky/logo.webp new file mode 100644 index 0000000..67a060b Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/logo.webp differ diff --git a/docs/img/konami/iidx/12_happysky/setup/1.webp b/docs/img/konami/iidx/12_happysky/setup/1.webp new file mode 100644 index 0000000..0e30c26 Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/setup/1.webp differ diff --git a/docs/img/konami/iidx/12_happysky/setup/2.webp b/docs/img/konami/iidx/12_happysky/setup/2.webp new file mode 100644 index 0000000..8cde67c Binary files /dev/null and b/docs/img/konami/iidx/12_happysky/setup/2.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/1.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/1.webp new file mode 100644 index 0000000..63fd88b Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/1.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/10.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/10.webp new file mode 100644 index 0000000..ee35a5f Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/10.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/11.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/11.webp new file mode 100644 index 0000000..405c0d9 Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/11.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/12.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/12.webp new file mode 100644 index 0000000..fc84df0 Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/12.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/2.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/2.webp new file mode 100644 index 0000000..8beec01 Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/2.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/3.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/3.webp new file mode 100644 index 0000000..79079b4 Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/3.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/4.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/4.webp new file mode 100644 index 0000000..e86cda0 Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/4.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/5.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/5.webp new file mode 100644 index 0000000..05672d0 Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/5.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/6.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/6.webp new file mode 100644 index 0000000..f617092 Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/6.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/7.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/7.webp new file mode 100644 index 0000000..03fe667 Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/7.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/8.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/8.webp new file mode 100644 index 0000000..042565f Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/8.webp differ diff --git a/docs/img/konami/iidx/13_distorted/firstlaunch/9.webp b/docs/img/konami/iidx/13_distorted/firstlaunch/9.webp new file mode 100644 index 0000000..f4875d9 Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/firstlaunch/9.webp differ diff --git a/docs/img/konami/iidx/13_distorted/iidx13_linear.webp b/docs/img/konami/iidx/13_distorted/iidx13_linear.webp new file mode 100644 index 0000000..271b84f Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/iidx13_linear.webp differ diff --git a/docs/img/konami/iidx/13_distorted/iidx13_point.webp b/docs/img/konami/iidx/13_distorted/iidx13_point.webp new file mode 100644 index 0000000..bac56db Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/iidx13_point.webp differ diff --git a/docs/img/konami/iidx/13_distorted/logo.webp b/docs/img/konami/iidx/13_distorted/logo.webp new file mode 100644 index 0000000..c6c7d0d Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/logo.webp differ diff --git a/docs/img/konami/iidx/13_distorted/setup/1.webp b/docs/img/konami/iidx/13_distorted/setup/1.webp new file mode 100644 index 0000000..1590fc1 Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/setup/1.webp differ diff --git a/docs/img/konami/iidx/13_distorted/setup/2.webp b/docs/img/konami/iidx/13_distorted/setup/2.webp new file mode 100644 index 0000000..8cde67c Binary files /dev/null and b/docs/img/konami/iidx/13_distorted/setup/2.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/1.webp b/docs/img/konami/iidx/14_gold/firstlaunch/1.webp new file mode 100644 index 0000000..aaceb2f Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/1.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/10.webp b/docs/img/konami/iidx/14_gold/firstlaunch/10.webp new file mode 100644 index 0000000..0ad7b26 Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/10.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/11.webp b/docs/img/konami/iidx/14_gold/firstlaunch/11.webp new file mode 100644 index 0000000..03bc49a Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/11.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/12.webp b/docs/img/konami/iidx/14_gold/firstlaunch/12.webp new file mode 100644 index 0000000..40047fc Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/12.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/13.webp b/docs/img/konami/iidx/14_gold/firstlaunch/13.webp new file mode 100644 index 0000000..7a87563 Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/13.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/2.webp b/docs/img/konami/iidx/14_gold/firstlaunch/2.webp new file mode 100644 index 0000000..1ff2ef1 Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/2.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/3.webp b/docs/img/konami/iidx/14_gold/firstlaunch/3.webp new file mode 100644 index 0000000..0310098 Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/3.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/4.webp b/docs/img/konami/iidx/14_gold/firstlaunch/4.webp new file mode 100644 index 0000000..9ab7a7f Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/4.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/5.webp b/docs/img/konami/iidx/14_gold/firstlaunch/5.webp new file mode 100644 index 0000000..58125b6 Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/5.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/6.webp b/docs/img/konami/iidx/14_gold/firstlaunch/6.webp new file mode 100644 index 0000000..ad4cf3b Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/6.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/7.webp b/docs/img/konami/iidx/14_gold/firstlaunch/7.webp new file mode 100644 index 0000000..ba17a74 Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/7.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/8.webp b/docs/img/konami/iidx/14_gold/firstlaunch/8.webp new file mode 100644 index 0000000..ffebd32 Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/8.webp differ diff --git a/docs/img/konami/iidx/14_gold/firstlaunch/9.webp b/docs/img/konami/iidx/14_gold/firstlaunch/9.webp new file mode 100644 index 0000000..329d855 Binary files /dev/null and b/docs/img/konami/iidx/14_gold/firstlaunch/9.webp differ diff --git a/docs/img/konami/iidx/14_gold/iidx14_linear.webp b/docs/img/konami/iidx/14_gold/iidx14_linear.webp new file mode 100644 index 0000000..abe6c45 Binary files /dev/null and b/docs/img/konami/iidx/14_gold/iidx14_linear.webp differ diff --git a/docs/img/konami/iidx/14_gold/iidx14_point.webp b/docs/img/konami/iidx/14_gold/iidx14_point.webp new file mode 100644 index 0000000..d35fbbe Binary files /dev/null and b/docs/img/konami/iidx/14_gold/iidx14_point.webp differ diff --git a/docs/img/konami/iidx/14_gold/logo.webp b/docs/img/konami/iidx/14_gold/logo.webp new file mode 100644 index 0000000..6c835be Binary files /dev/null and b/docs/img/konami/iidx/14_gold/logo.webp differ diff --git a/docs/img/konami/iidx/14_gold/setup/1.webp b/docs/img/konami/iidx/14_gold/setup/1.webp new file mode 100644 index 0000000..a3f1bef Binary files /dev/null and b/docs/img/konami/iidx/14_gold/setup/1.webp differ diff --git a/docs/img/konami/iidx/14_gold/setup/2.webp b/docs/img/konami/iidx/14_gold/setup/2.webp new file mode 100644 index 0000000..8cde67c Binary files /dev/null and b/docs/img/konami/iidx/14_gold/setup/2.webp differ diff --git a/docs/img/konami/iidx/16_empress/11.webp b/docs/img/konami/iidx/16_empress/11.webp new file mode 100644 index 0000000..f6bcf40 Binary files /dev/null and b/docs/img/konami/iidx/16_empress/11.webp differ diff --git a/docs/img/konami/iidx/16_empress/logo.webp b/docs/img/konami/iidx/16_empress/logo.webp new file mode 100644 index 0000000..003bd59 Binary files /dev/null and b/docs/img/konami/iidx/16_empress/logo.webp differ diff --git a/docs/img/konami/iidx/24_sinobuz/data.webp b/docs/img/konami/iidx/24_sinobuz/data.webp new file mode 100644 index 0000000..6df556a Binary files /dev/null and b/docs/img/konami/iidx/24_sinobuz/data.webp differ diff --git a/docs/img/konami/iidx/24_sinobuz/logo.webp b/docs/img/konami/iidx/24_sinobuz/logo.webp new file mode 100644 index 0000000..fac6a16 Binary files /dev/null and b/docs/img/konami/iidx/24_sinobuz/logo.webp differ diff --git a/docs/img/konami/iidx/24_sinobuz/spice2xdata.webp b/docs/img/konami/iidx/24_sinobuz/spice2xdata.webp new file mode 100644 index 0000000..fdf7d13 Binary files /dev/null and b/docs/img/konami/iidx/24_sinobuz/spice2xdata.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/1.webp b/docs/img/konami/iidx/25_cannonballers/1.webp new file mode 100644 index 0000000..a9cd963 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/1.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/10.webp b/docs/img/konami/iidx/25_cannonballers/10.webp new file mode 100644 index 0000000..9541234 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/10.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/11.webp b/docs/img/konami/iidx/25_cannonballers/11.webp new file mode 100644 index 0000000..dc0fef8 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/11.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/12.webp b/docs/img/konami/iidx/25_cannonballers/12.webp new file mode 100644 index 0000000..7487f74 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/12.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/13.webp b/docs/img/konami/iidx/25_cannonballers/13.webp new file mode 100644 index 0000000..8f227a5 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/13.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/1a.webp b/docs/img/konami/iidx/25_cannonballers/1a.webp new file mode 100644 index 0000000..65a71b4 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/1a.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/2.webp b/docs/img/konami/iidx/25_cannonballers/2.webp new file mode 100644 index 0000000..d680009 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/2.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/3.webp b/docs/img/konami/iidx/25_cannonballers/3.webp new file mode 100644 index 0000000..191bc79 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/3.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/4.webp b/docs/img/konami/iidx/25_cannonballers/4.webp new file mode 100644 index 0000000..d2f792e Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/4.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/5.webp b/docs/img/konami/iidx/25_cannonballers/5.webp new file mode 100644 index 0000000..6797918 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/5.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/6.webp b/docs/img/konami/iidx/25_cannonballers/6.webp new file mode 100644 index 0000000..24170c5 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/6.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/7.webp b/docs/img/konami/iidx/25_cannonballers/7.webp new file mode 100644 index 0000000..48e13ab Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/7.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/8.webp b/docs/img/konami/iidx/25_cannonballers/8.webp new file mode 100644 index 0000000..572c131 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/8.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/9.webp b/docs/img/konami/iidx/25_cannonballers/9.webp new file mode 100644 index 0000000..a84b431 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/9.webp differ diff --git a/docs/img/konami/iidx/25_cannonballers/logo.webp b/docs/img/konami/iidx/25_cannonballers/logo.webp new file mode 100644 index 0000000..6588e89 Binary files /dev/null and b/docs/img/konami/iidx/25_cannonballers/logo.webp differ diff --git a/docs/img/konami/iidx/26_rootage/1.webp b/docs/img/konami/iidx/26_rootage/1.webp new file mode 100644 index 0000000..044e6b1 Binary files /dev/null and b/docs/img/konami/iidx/26_rootage/1.webp differ diff --git a/docs/img/konami/iidx/26_rootage/logo.webp b/docs/img/konami/iidx/26_rootage/logo.webp new file mode 100644 index 0000000..417297c Binary files /dev/null and b/docs/img/konami/iidx/26_rootage/logo.webp differ diff --git a/docs/img/konami/iidx/27_heroicverse/1.webp b/docs/img/konami/iidx/27_heroicverse/1.webp new file mode 100644 index 0000000..34b5fba Binary files /dev/null and b/docs/img/konami/iidx/27_heroicverse/1.webp differ diff --git a/docs/img/konami/iidx/27_heroicverse/cfg_ea.webp b/docs/img/konami/iidx/27_heroicverse/cfg_ea.webp new file mode 100644 index 0000000..3df9e83 Binary files /dev/null and b/docs/img/konami/iidx/27_heroicverse/cfg_ea.webp differ diff --git a/docs/img/konami/iidx/27_heroicverse/cfg_on.webp b/docs/img/konami/iidx/27_heroicverse/cfg_on.webp new file mode 100644 index 0000000..a5b9aab Binary files /dev/null and b/docs/img/konami/iidx/27_heroicverse/cfg_on.webp differ diff --git a/docs/img/konami/iidx/27_heroicverse/logo.webp b/docs/img/konami/iidx/27_heroicverse/logo.webp new file mode 100644 index 0000000..c19bb69 Binary files /dev/null and b/docs/img/konami/iidx/27_heroicverse/logo.webp differ diff --git a/docs/img/konami/iidx/30_resident/logo.webp b/docs/img/konami/iidx/30_resident/logo.webp new file mode 100644 index 0000000..0fb147f Binary files /dev/null and b/docs/img/konami/iidx/30_resident/logo.webp differ diff --git a/docs/img/konami/iidx/31_epolis/logo.webp b/docs/img/konami/iidx/31_epolis/logo.webp new file mode 100644 index 0000000..b1ce9fb Binary files /dev/null and b/docs/img/konami/iidx/31_epolis/logo.webp differ diff --git a/docs/img/konami/iidx/32_pinkycrush/logo.webp b/docs/img/konami/iidx/32_pinkycrush/logo.webp new file mode 100644 index 0000000..ef194b9 Binary files /dev/null and b/docs/img/konami/iidx/32_pinkycrush/logo.webp differ diff --git a/docs/img/konami/iidx/33_sparkleshower/logo.webp b/docs/img/konami/iidx/33_sparkleshower/logo.webp new file mode 100644 index 0000000..7927750 Binary files /dev/null and b/docs/img/konami/iidx/33_sparkleshower/logo.webp differ diff --git a/docs/img/konami/iidx/9thstyle/9th_linear.webp b/docs/img/konami/iidx/9thstyle/9th_linear.webp new file mode 100644 index 0000000..18b6edf Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/9th_linear.webp differ diff --git a/docs/img/konami/iidx/9thstyle/9th_point.webp b/docs/img/konami/iidx/9thstyle/9th_point.webp new file mode 100644 index 0000000..2f381f5 Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/9th_point.webp differ diff --git a/docs/img/konami/iidx/9thstyle/firstlaunch/1.webp b/docs/img/konami/iidx/9thstyle/firstlaunch/1.webp new file mode 100644 index 0000000..1ea3324 Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/firstlaunch/1.webp differ diff --git a/docs/img/konami/iidx/9thstyle/firstlaunch/10.webp b/docs/img/konami/iidx/9thstyle/firstlaunch/10.webp new file mode 100644 index 0000000..e38aec9 Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/firstlaunch/10.webp differ diff --git a/docs/img/konami/iidx/9thstyle/firstlaunch/11.webp b/docs/img/konami/iidx/9thstyle/firstlaunch/11.webp new file mode 100644 index 0000000..006d5c4 Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/firstlaunch/11.webp differ diff --git a/docs/img/konami/iidx/9thstyle/firstlaunch/2.webp b/docs/img/konami/iidx/9thstyle/firstlaunch/2.webp new file mode 100644 index 0000000..b3bc5a4 Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/firstlaunch/2.webp differ diff --git a/docs/img/konami/iidx/9thstyle/firstlaunch/3.webp b/docs/img/konami/iidx/9thstyle/firstlaunch/3.webp new file mode 100644 index 0000000..3f8257a Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/firstlaunch/3.webp differ diff --git a/docs/img/konami/iidx/9thstyle/firstlaunch/4.webp b/docs/img/konami/iidx/9thstyle/firstlaunch/4.webp new file mode 100644 index 0000000..c035bcb Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/firstlaunch/4.webp differ diff --git a/docs/img/konami/iidx/9thstyle/firstlaunch/5.webp b/docs/img/konami/iidx/9thstyle/firstlaunch/5.webp new file mode 100644 index 0000000..74a101a Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/firstlaunch/5.webp differ diff --git a/docs/img/konami/iidx/9thstyle/firstlaunch/6.webp b/docs/img/konami/iidx/9thstyle/firstlaunch/6.webp new file mode 100644 index 0000000..4043da7 Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/firstlaunch/6.webp differ diff --git a/docs/img/konami/iidx/9thstyle/firstlaunch/7.webp b/docs/img/konami/iidx/9thstyle/firstlaunch/7.webp new file mode 100644 index 0000000..7f6538f Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/firstlaunch/7.webp differ diff --git a/docs/img/konami/iidx/9thstyle/firstlaunch/8.webp b/docs/img/konami/iidx/9thstyle/firstlaunch/8.webp new file mode 100644 index 0000000..a54636c Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/firstlaunch/8.webp differ diff --git a/docs/img/konami/iidx/9thstyle/firstlaunch/9.webp b/docs/img/konami/iidx/9thstyle/firstlaunch/9.webp new file mode 100644 index 0000000..2cbb4db Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/firstlaunch/9.webp differ diff --git a/docs/img/konami/iidx/9thstyle/logo.webp b/docs/img/konami/iidx/9thstyle/logo.webp new file mode 100644 index 0000000..1b993dd Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/logo.webp differ diff --git a/docs/img/konami/iidx/9thstyle/setup/1.webp b/docs/img/konami/iidx/9thstyle/setup/1.webp new file mode 100644 index 0000000..8d23ada Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/setup/1.webp differ diff --git a/docs/img/konami/iidx/9thstyle/setup/2.webp b/docs/img/konami/iidx/9thstyle/setup/2.webp new file mode 100644 index 0000000..97cccf8 Binary files /dev/null and b/docs/img/konami/iidx/9thstyle/setup/2.webp differ diff --git a/docs/img/konami/iidx/common/firstlaunch/1.webp b/docs/img/konami/iidx/common/firstlaunch/1.webp new file mode 100644 index 0000000..69c3aed Binary files /dev/null and b/docs/img/konami/iidx/common/firstlaunch/1.webp differ diff --git a/docs/img/konami/iidx/common/firstlaunch/2.webp b/docs/img/konami/iidx/common/firstlaunch/2.webp new file mode 100644 index 0000000..95b8683 Binary files /dev/null and b/docs/img/konami/iidx/common/firstlaunch/2.webp differ diff --git a/docs/img/konami/iidx/common/firstlaunch/3.webp b/docs/img/konami/iidx/common/firstlaunch/3.webp new file mode 100644 index 0000000..2e96957 Binary files /dev/null and b/docs/img/konami/iidx/common/firstlaunch/3.webp differ diff --git a/docs/img/konami/iidx/common/firstlaunch/4.webp b/docs/img/konami/iidx/common/firstlaunch/4.webp new file mode 100644 index 0000000..c065fd1 Binary files /dev/null and b/docs/img/konami/iidx/common/firstlaunch/4.webp differ diff --git a/docs/img/konami/iidx/common/firstlaunch/5.webp b/docs/img/konami/iidx/common/firstlaunch/5.webp new file mode 100644 index 0000000..dc0fef8 Binary files /dev/null and b/docs/img/konami/iidx/common/firstlaunch/5.webp differ diff --git a/docs/img/konami/iidx/common/firstlaunch/6.webp b/docs/img/konami/iidx/common/firstlaunch/6.webp new file mode 100644 index 0000000..7487f74 Binary files /dev/null and b/docs/img/konami/iidx/common/firstlaunch/6.webp differ diff --git a/docs/img/konami/iidx/common/firstlaunch/7.webp b/docs/img/konami/iidx/common/firstlaunch/7.webp new file mode 100644 index 0000000..8f227a5 Binary files /dev/null and b/docs/img/konami/iidx/common/firstlaunch/7.webp differ diff --git a/docs/img/konami/iidx/common/firstlaunch/gameoptions/1.webp b/docs/img/konami/iidx/common/firstlaunch/gameoptions/1.webp new file mode 100644 index 0000000..9541234 Binary files /dev/null and b/docs/img/konami/iidx/common/firstlaunch/gameoptions/1.webp differ diff --git a/docs/img/konami/iidx/common/oldhd/firstlaunch/1.webp b/docs/img/konami/iidx/common/oldhd/firstlaunch/1.webp new file mode 100644 index 0000000..6797918 Binary files /dev/null and b/docs/img/konami/iidx/common/oldhd/firstlaunch/1.webp differ diff --git a/docs/img/konami/iidx/common/oldhd/firstlaunch/10.webp b/docs/img/konami/iidx/common/oldhd/firstlaunch/10.webp new file mode 100644 index 0000000..e60183d Binary files /dev/null and b/docs/img/konami/iidx/common/oldhd/firstlaunch/10.webp differ diff --git a/docs/img/konami/iidx/common/oldhd/firstlaunch/2.webp b/docs/img/konami/iidx/common/oldhd/firstlaunch/2.webp new file mode 100644 index 0000000..24170c5 Binary files /dev/null and b/docs/img/konami/iidx/common/oldhd/firstlaunch/2.webp differ diff --git a/docs/img/konami/iidx/common/oldhd/firstlaunch/3.webp b/docs/img/konami/iidx/common/oldhd/firstlaunch/3.webp new file mode 100644 index 0000000..48e13ab Binary files /dev/null and b/docs/img/konami/iidx/common/oldhd/firstlaunch/3.webp differ diff --git a/docs/img/konami/iidx/common/oldhd/firstlaunch/4.webp b/docs/img/konami/iidx/common/oldhd/firstlaunch/4.webp new file mode 100644 index 0000000..572c131 Binary files /dev/null and b/docs/img/konami/iidx/common/oldhd/firstlaunch/4.webp differ diff --git a/docs/img/konami/iidx/common/oldhd/firstlaunch/5.webp b/docs/img/konami/iidx/common/oldhd/firstlaunch/5.webp new file mode 100644 index 0000000..a84b431 Binary files /dev/null and b/docs/img/konami/iidx/common/oldhd/firstlaunch/5.webp differ diff --git a/docs/img/konami/iidx/common/oldhd/firstlaunch/6.webp b/docs/img/konami/iidx/common/oldhd/firstlaunch/6.webp new file mode 100644 index 0000000..9541234 Binary files /dev/null and b/docs/img/konami/iidx/common/oldhd/firstlaunch/6.webp differ diff --git a/docs/img/konami/iidx/common/oldhd/firstlaunch/7.webp b/docs/img/konami/iidx/common/oldhd/firstlaunch/7.webp new file mode 100644 index 0000000..dc0fef8 Binary files /dev/null and b/docs/img/konami/iidx/common/oldhd/firstlaunch/7.webp differ diff --git a/docs/img/konami/iidx/common/oldhd/firstlaunch/8.webp b/docs/img/konami/iidx/common/oldhd/firstlaunch/8.webp new file mode 100644 index 0000000..7487f74 Binary files /dev/null and b/docs/img/konami/iidx/common/oldhd/firstlaunch/8.webp differ diff --git a/docs/img/konami/iidx/common/oldhd/firstlaunch/9.webp b/docs/img/konami/iidx/common/oldhd/firstlaunch/9.webp new file mode 100644 index 0000000..8f227a5 Binary files /dev/null and b/docs/img/konami/iidx/common/oldhd/firstlaunch/9.webp differ diff --git a/docs/img/konami/iidx/common/setup/data.webp b/docs/img/konami/iidx/common/setup/data.webp new file mode 100644 index 0000000..578abeb Binary files /dev/null and b/docs/img/konami/iidx/common/setup/data.webp differ diff --git a/docs/img/konami/iidx/common/setup/spice2x64data.webp b/docs/img/konami/iidx/common/setup/spice2x64data.webp new file mode 100644 index 0000000..916d674 Binary files /dev/null and b/docs/img/konami/iidx/common/setup/spice2x64data.webp differ diff --git a/docs/img/konami/jubeat/avenue/logo.webp b/docs/img/konami/jubeat/avenue/logo.webp new file mode 100644 index 0000000..39892f6 Binary files /dev/null and b/docs/img/konami/jubeat/avenue/logo.webp differ diff --git a/docs/img/konami/jubeat/beyondtheavenue/logo.webp b/docs/img/konami/jubeat/beyondtheavenue/logo.webp new file mode 100644 index 0000000..8958e7c Binary files /dev/null and b/docs/img/konami/jubeat/beyondtheavenue/logo.webp differ diff --git a/docs/img/konami/jubeat/common/firstlaunch/backup_data_error.webp b/docs/img/konami/jubeat/common/firstlaunch/backup_data_error.webp new file mode 100644 index 0000000..ea2fa65 Binary files /dev/null and b/docs/img/konami/jubeat/common/firstlaunch/backup_data_error.webp differ diff --git a/docs/img/konami/jubeat/common/firstlaunch/shop_settings.webp b/docs/img/konami/jubeat/common/firstlaunch/shop_settings.webp new file mode 100644 index 0000000..cf9514c Binary files /dev/null and b/docs/img/konami/jubeat/common/firstlaunch/shop_settings.webp differ diff --git a/docs/img/konami/jubeat/festo/logo.webp b/docs/img/konami/jubeat/festo/logo.webp new file mode 100644 index 0000000..219b1aa Binary files /dev/null and b/docs/img/konami/jubeat/festo/logo.webp differ diff --git a/docs/img/konami/mfg/logo.webp b/docs/img/konami/mfg/logo.webp new file mode 100644 index 0000000..ccc9c06 Binary files /dev/null and b/docs/img/konami/mfg/logo.webp differ diff --git a/docs/img/konami/museca/backupdata.webp b/docs/img/konami/museca/backupdata.webp new file mode 100644 index 0000000..534ca98 Binary files /dev/null and b/docs/img/konami/museca/backupdata.webp differ diff --git a/docs/img/konami/museca/logo.webp b/docs/img/konami/museca/logo.webp new file mode 100644 index 0000000..1a4275b Binary files /dev/null and b/docs/img/konami/museca/logo.webp differ diff --git a/docs/img/konami/nostalgia/common/1.webp b/docs/img/konami/nostalgia/common/1.webp new file mode 100644 index 0000000..f357efb Binary files /dev/null and b/docs/img/konami/nostalgia/common/1.webp differ diff --git a/docs/img/konami/nostalgia/common/2.webp b/docs/img/konami/nostalgia/common/2.webp new file mode 100644 index 0000000..35ab06c Binary files /dev/null and b/docs/img/konami/nostalgia/common/2.webp differ diff --git a/docs/img/konami/nostalgia/common/3.webp b/docs/img/konami/nostalgia/common/3.webp new file mode 100644 index 0000000..38b3b64 Binary files /dev/null and b/docs/img/konami/nostalgia/common/3.webp differ diff --git a/docs/img/konami/nostalgia/common/4.webp b/docs/img/konami/nostalgia/common/4.webp new file mode 100644 index 0000000..5ccfcf0 Binary files /dev/null and b/docs/img/konami/nostalgia/common/4.webp differ diff --git a/docs/img/konami/nostalgia/common/5.webp b/docs/img/konami/nostalgia/common/5.webp new file mode 100644 index 0000000..c3f0bd4 Binary files /dev/null and b/docs/img/konami/nostalgia/common/5.webp differ diff --git a/docs/img/konami/nostalgia/common/6.webp b/docs/img/konami/nostalgia/common/6.webp new file mode 100644 index 0000000..c9dd376 Binary files /dev/null and b/docs/img/konami/nostalgia/common/6.webp differ diff --git a/docs/img/konami/nostalgia/common/7.webp b/docs/img/konami/nostalgia/common/7.webp new file mode 100644 index 0000000..39e4358 Binary files /dev/null and b/docs/img/konami/nostalgia/common/7.webp differ diff --git a/docs/img/konami/nostalgia/common/8.webp b/docs/img/konami/nostalgia/common/8.webp new file mode 100644 index 0000000..02f9701 Binary files /dev/null and b/docs/img/konami/nostalgia/common/8.webp differ diff --git a/docs/img/konami/nostalgia/forte/logo.webp b/docs/img/konami/nostalgia/forte/logo.webp new file mode 100644 index 0000000..356b24b Binary files /dev/null and b/docs/img/konami/nostalgia/forte/logo.webp differ diff --git a/docs/img/konami/nostalgia/op2/logo.webp b/docs/img/konami/nostalgia/op2/logo.webp new file mode 100644 index 0000000..981d4ff Binary files /dev/null and b/docs/img/konami/nostalgia/op2/logo.webp differ diff --git a/docs/img/konami/popn/kaimei_riddles/logo.webp b/docs/img/konami/popn/kaimei_riddles/logo.webp new file mode 100644 index 0000000..21269c3 Binary files /dev/null and b/docs/img/konami/popn/kaimei_riddles/logo.webp differ diff --git a/docs/img/konami/popn/peace/logo.webp b/docs/img/konami/popn/peace/logo.webp new file mode 100644 index 0000000..7d82881 Binary files /dev/null and b/docs/img/konami/popn/peace/logo.webp differ diff --git a/docs/img/konami/popn/unilab/logo.webp b/docs/img/konami/popn/unilab/logo.webp new file mode 100644 index 0000000..062bb17 Binary files /dev/null and b/docs/img/konami/popn/unilab/logo.webp differ diff --git a/docs/img/konami/popn/usaneko/logo.webp b/docs/img/konami/popn/usaneko/logo.webp new file mode 100644 index 0000000..5cfce3a Binary files /dev/null and b/docs/img/konami/popn/usaneko/logo.webp differ diff --git a/docs/img/konami/reflecbeat/reflesia/data.webp b/docs/img/konami/reflecbeat/reflesia/data.webp new file mode 100644 index 0000000..74b5ecb Binary files /dev/null and b/docs/img/konami/reflecbeat/reflesia/data.webp differ diff --git a/docs/img/konami/reflecbeat/reflesia/logo.webp b/docs/img/konami/reflecbeat/reflesia/logo.webp new file mode 100644 index 0000000..5e02906 Binary files /dev/null and b/docs/img/konami/reflecbeat/reflesia/logo.webp differ diff --git a/docs/img/konami/sdvx/4_heavenlyhaven/logo.webp b/docs/img/konami/sdvx/4_heavenlyhaven/logo.webp new file mode 100644 index 0000000..58a95c7 Binary files /dev/null and b/docs/img/konami/sdvx/4_heavenlyhaven/logo.webp differ diff --git a/docs/img/konami/sdvx/4_heavenlyhaven/setup/1.webp b/docs/img/konami/sdvx/4_heavenlyhaven/setup/1.webp new file mode 100644 index 0000000..b9f8c19 Binary files /dev/null and b/docs/img/konami/sdvx/4_heavenlyhaven/setup/1.webp differ diff --git a/docs/img/konami/sdvx/4_heavenlyhaven/setup/2.webp b/docs/img/konami/sdvx/4_heavenlyhaven/setup/2.webp new file mode 100644 index 0000000..ea577a5 Binary files /dev/null and b/docs/img/konami/sdvx/4_heavenlyhaven/setup/2.webp differ diff --git a/docs/img/konami/sdvx/4_heavenlyhaven/setup/3.webp b/docs/img/konami/sdvx/4_heavenlyhaven/setup/3.webp new file mode 100644 index 0000000..f0260cc Binary files /dev/null and b/docs/img/konami/sdvx/4_heavenlyhaven/setup/3.webp differ diff --git a/docs/img/konami/sdvx/5_vividwave/1.webp b/docs/img/konami/sdvx/5_vividwave/1.webp new file mode 100644 index 0000000..3cab56b Binary files /dev/null and b/docs/img/konami/sdvx/5_vividwave/1.webp differ diff --git a/docs/img/konami/sdvx/5_vividwave/logo.webp b/docs/img/konami/sdvx/5_vividwave/logo.webp new file mode 100644 index 0000000..15e0701 Binary files /dev/null and b/docs/img/konami/sdvx/5_vividwave/logo.webp differ diff --git a/docs/img/konami/sdvx/6_exceedgear/calibration/1.webp b/docs/img/konami/sdvx/6_exceedgear/calibration/1.webp new file mode 100644 index 0000000..97e3b77 Binary files /dev/null and b/docs/img/konami/sdvx/6_exceedgear/calibration/1.webp differ diff --git a/docs/img/konami/sdvx/6_exceedgear/calibration/2.webp b/docs/img/konami/sdvx/6_exceedgear/calibration/2.webp new file mode 100644 index 0000000..3bc8dd1 Binary files /dev/null and b/docs/img/konami/sdvx/6_exceedgear/calibration/2.webp differ diff --git a/docs/img/konami/sdvx/6_exceedgear/calibration/3.webp b/docs/img/konami/sdvx/6_exceedgear/calibration/3.webp new file mode 100644 index 0000000..bf122fd Binary files /dev/null and b/docs/img/konami/sdvx/6_exceedgear/calibration/3.webp differ diff --git a/docs/img/konami/sdvx/6_exceedgear/calibration/4.webp b/docs/img/konami/sdvx/6_exceedgear/calibration/4.webp new file mode 100644 index 0000000..d84df9d Binary files /dev/null and b/docs/img/konami/sdvx/6_exceedgear/calibration/4.webp differ diff --git a/docs/img/konami/sdvx/6_exceedgear/calibration/5.webp b/docs/img/konami/sdvx/6_exceedgear/calibration/5.webp new file mode 100644 index 0000000..772518e Binary files /dev/null and b/docs/img/konami/sdvx/6_exceedgear/calibration/5.webp differ diff --git a/docs/img/konami/sdvx/6_exceedgear/calibration/6.webp b/docs/img/konami/sdvx/6_exceedgear/calibration/6.webp new file mode 100644 index 0000000..94671a2 Binary files /dev/null and b/docs/img/konami/sdvx/6_exceedgear/calibration/6.webp differ diff --git a/docs/img/konami/sdvx/6_exceedgear/logo.webp b/docs/img/konami/sdvx/6_exceedgear/logo.webp new file mode 100644 index 0000000..0175660 Binary files /dev/null and b/docs/img/konami/sdvx/6_exceedgear/logo.webp differ diff --git a/docs/img/konami/sdvx/6_exceedgear/setup/data.webp b/docs/img/konami/sdvx/6_exceedgear/setup/data.webp new file mode 100644 index 0000000..7d4550b Binary files /dev/null and b/docs/img/konami/sdvx/6_exceedgear/setup/data.webp differ diff --git a/docs/img/konami/sdvx/6_exceedgear/setup/dllamd.webp b/docs/img/konami/sdvx/6_exceedgear/setup/dllamd.webp new file mode 100644 index 0000000..0fc8072 Binary files /dev/null and b/docs/img/konami/sdvx/6_exceedgear/setup/dllamd.webp differ diff --git a/docs/img/konami/sdvx/7_nabla/logo.webp b/docs/img/konami/sdvx/7_nabla/logo.webp new file mode 100644 index 0000000..662208c Binary files /dev/null and b/docs/img/konami/sdvx/7_nabla/logo.webp differ diff --git a/docs/img/namco/taikonijiiro/logo.webp b/docs/img/namco/taikonijiiro/logo.webp new file mode 100644 index 0000000..d9142f3 Binary files /dev/null and b/docs/img/namco/taikonijiiro/logo.webp differ diff --git a/docs/img/namco/taikonijiiro/setup/1.webp b/docs/img/namco/taikonijiiro/setup/1.webp new file mode 100644 index 0000000..8889a1f Binary files /dev/null and b/docs/img/namco/taikonijiiro/setup/1.webp differ diff --git a/docs/img/namco/taikonijiiro/setup/2.webp b/docs/img/namco/taikonijiiro/setup/2.webp new file mode 100644 index 0000000..ccc8bf0 Binary files /dev/null and b/docs/img/namco/taikonijiiro/setup/2.webp differ diff --git a/docs/img/namco/taikonijiiro/setup/io.webp b/docs/img/namco/taikonijiiro/setup/io.webp new file mode 100644 index 0000000..62b474d Binary files /dev/null and b/docs/img/namco/taikonijiiro/setup/io.webp differ diff --git a/docs/img/namco/taikonijiiro/setup/mod.webp b/docs/img/namco/taikonijiiro/setup/mod.webp new file mode 100644 index 0000000..ad36bb5 Binary files /dev/null and b/docs/img/namco/taikonijiiro/setup/mod.webp differ diff --git a/docs/img/namco/taikonijiiro/troubleshooting/close.webp b/docs/img/namco/taikonijiiro/troubleshooting/close.webp new file mode 100644 index 0000000..f2fcdb7 Binary files /dev/null and b/docs/img/namco/taikonijiiro/troubleshooting/close.webp differ diff --git a/docs/img/namco/taikonijiiro/troubleshooting/defender.webp b/docs/img/namco/taikonijiiro/troubleshooting/defender.webp new file mode 100644 index 0000000..5b6d4a0 Binary files /dev/null and b/docs/img/namco/taikonijiiro/troubleshooting/defender.webp differ diff --git a/docs/img/namco/taikonijiiro/troubleshooting/fps.webp b/docs/img/namco/taikonijiiro/troubleshooting/fps.webp new file mode 100644 index 0000000..f86d528 Binary files /dev/null and b/docs/img/namco/taikonijiiro/troubleshooting/fps.webp differ diff --git a/docs/img/namco/taikonijiiro/troubleshooting/game.jpg b/docs/img/namco/taikonijiiro/troubleshooting/game.jpg new file mode 100644 index 0000000..9599793 Binary files /dev/null and b/docs/img/namco/taikonijiiro/troubleshooting/game.jpg differ diff --git a/docs/img/namco/taikonijiiro/troubleshooting/lang.webp b/docs/img/namco/taikonijiiro/troubleshooting/lang.webp new file mode 100644 index 0000000..fb9e5c4 Binary files /dev/null and b/docs/img/namco/taikonijiiro/troubleshooting/lang.webp differ diff --git a/docs/img/namco/taikonijiiro/troubleshooting/scale.webp b/docs/img/namco/taikonijiiro/troubleshooting/scale.webp new file mode 100644 index 0000000..603d6ba Binary files /dev/null and b/docs/img/namco/taikonijiiro/troubleshooting/scale.webp differ diff --git a/docs/img/sega/chunithm/air/logo.webp b/docs/img/sega/chunithm/air/logo.webp new file mode 100644 index 0000000..4debbaf Binary files /dev/null and b/docs/img/sega/chunithm/air/logo.webp differ diff --git a/docs/img/sega/chunithm/airplus/logo.webp b/docs/img/sega/chunithm/airplus/logo.webp new file mode 100644 index 0000000..872c53a Binary files /dev/null and b/docs/img/sega/chunithm/airplus/logo.webp differ diff --git a/docs/img/sega/chunithm/amazon/logo.webp b/docs/img/sega/chunithm/amazon/logo.webp new file mode 100644 index 0000000..cce2d8d Binary files /dev/null and b/docs/img/sega/chunithm/amazon/logo.webp differ diff --git a/docs/img/sega/chunithm/amazonplus/logo.webp b/docs/img/sega/chunithm/amazonplus/logo.webp new file mode 100644 index 0000000..1cfb87d Binary files /dev/null and b/docs/img/sega/chunithm/amazonplus/logo.webp differ diff --git a/docs/img/sega/chunithm/chunithm/logo.webp b/docs/img/sega/chunithm/chunithm/logo.webp new file mode 100644 index 0000000..3c02668 Binary files /dev/null and b/docs/img/sega/chunithm/chunithm/logo.webp differ diff --git a/docs/img/sega/chunithm/common/c2c/client.webp b/docs/img/sega/chunithm/common/c2c/client.webp new file mode 100644 index 0000000..0e07d7b Binary files /dev/null and b/docs/img/sega/chunithm/common/c2c/client.webp differ diff --git a/docs/img/sega/chunithm/common/c2c/followstandard.webp b/docs/img/sega/chunithm/common/c2c/followstandard.webp new file mode 100644 index 0000000..3a990a3 Binary files /dev/null and b/docs/img/sega/chunithm/common/c2c/followstandard.webp differ diff --git a/docs/img/sega/chunithm/common/c2c/group.webp b/docs/img/sega/chunithm/common/c2c/group.webp new file mode 100644 index 0000000..9ea136f Binary files /dev/null and b/docs/img/sega/chunithm/common/c2c/group.webp differ diff --git a/docs/img/sega/chunithm/common/c2c/host.webp b/docs/img/sega/chunithm/common/c2c/host.webp new file mode 100644 index 0000000..c51e46a Binary files /dev/null and b/docs/img/sega/chunithm/common/c2c/host.webp differ diff --git a/docs/img/sega/chunithm/common/c2c/service.webp b/docs/img/sega/chunithm/common/c2c/service.webp new file mode 100644 index 0000000..65ec538 Binary files /dev/null and b/docs/img/sega/chunithm/common/c2c/service.webp differ diff --git a/docs/img/sega/chunithm/common/c2c/standard.webp b/docs/img/sega/chunithm/common/c2c/standard.webp new file mode 100644 index 0000000..8acb1f8 Binary files /dev/null and b/docs/img/sega/chunithm/common/c2c/standard.webp differ diff --git a/docs/img/sega/chunithm/common/controllers/0_ipaddress.webp b/docs/img/sega/chunithm/common/controllers/0_ipaddress.webp new file mode 100644 index 0000000..c03f927 Binary files /dev/null and b/docs/img/sega/chunithm/common/controllers/0_ipaddress.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chuni/servicemenu/0_asettings.webp b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/0_asettings.webp new file mode 100644 index 0000000..7ec6133 Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/0_asettings.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chuni/servicemenu/1_gamesettings.webp b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/1_gamesettings.webp new file mode 100644 index 0000000..8df214e Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/1_gamesettings.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chuni/servicemenu/2_reference.webp b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/2_reference.webp new file mode 100644 index 0000000..650f939 Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/2_reference.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chuni/servicemenu/3_referenceconfirm.webp b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/3_referenceconfirm.webp new file mode 100644 index 0000000..e8e7222 Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/3_referenceconfirm.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chuni/servicemenu/4_referenceconfirm.webp b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/4_referenceconfirm.webp new file mode 100644 index 0000000..5a70b83 Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/4_referenceconfirm.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chuni/servicemenu/5_closingsetting.webp b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/5_closingsetting.webp new file mode 100644 index 0000000..d83aaf9 Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/5_closingsetting.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chuni/servicemenu/6_alltime.webp b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/6_alltime.webp new file mode 100644 index 0000000..a345d9f Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/6_alltime.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chuni/servicemenu/7_distserver.webp b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/7_distserver.webp new file mode 100644 index 0000000..5c2653c Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chuni/servicemenu/7_distserver.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chusan/servicemenu/0_asettings.webp b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/0_asettings.webp new file mode 100644 index 0000000..7ec6133 Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/0_asettings.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chusan/servicemenu/1_gamesettings.webp b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/1_gamesettings.webp new file mode 100644 index 0000000..4811cad Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/1_gamesettings.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chusan/servicemenu/2_reference.webp b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/2_reference.webp new file mode 100644 index 0000000..9c4e44c Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/2_reference.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chusan/servicemenu/3_closingsetting.webp b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/3_closingsetting.webp new file mode 100644 index 0000000..d5ea82a Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/3_closingsetting.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chusan/servicemenu/4_alltime.webp b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/4_alltime.webp new file mode 100644 index 0000000..a345d9f Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/4_alltime.webp differ diff --git a/docs/img/sega/chunithm/common/setup/chusan/servicemenu/5_distserver.webp b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/5_distserver.webp new file mode 100644 index 0000000..5c2653c Binary files /dev/null and b/docs/img/sega/chunithm/common/setup/chusan/servicemenu/5_distserver.webp differ diff --git a/docs/img/sega/chunithm/crystal/logo.webp b/docs/img/sega/chunithm/crystal/logo.webp new file mode 100644 index 0000000..7f67d8f Binary files /dev/null and b/docs/img/sega/chunithm/crystal/logo.webp differ diff --git a/docs/img/sega/chunithm/crystalplus/logo.webp b/docs/img/sega/chunithm/crystalplus/logo.webp new file mode 100644 index 0000000..e86a57d Binary files /dev/null and b/docs/img/sega/chunithm/crystalplus/logo.webp differ diff --git a/docs/img/sega/chunithm/luminous/logo.webp b/docs/img/sega/chunithm/luminous/logo.webp new file mode 100644 index 0000000..b2910a0 Binary files /dev/null and b/docs/img/sega/chunithm/luminous/logo.webp differ diff --git a/docs/img/sega/chunithm/luminousplus/logo.webp b/docs/img/sega/chunithm/luminousplus/logo.webp new file mode 100644 index 0000000..5b55e2c Binary files /dev/null and b/docs/img/sega/chunithm/luminousplus/logo.webp differ diff --git a/docs/img/sega/chunithm/new/logo.webp b/docs/img/sega/chunithm/new/logo.webp new file mode 100644 index 0000000..28d44eb Binary files /dev/null and b/docs/img/sega/chunithm/new/logo.webp differ diff --git a/docs/img/sega/chunithm/newplus/logo.webp b/docs/img/sega/chunithm/newplus/logo.webp new file mode 100644 index 0000000..bf86b20 Binary files /dev/null and b/docs/img/sega/chunithm/newplus/logo.webp differ diff --git a/docs/img/sega/chunithm/paradise/logo.webp b/docs/img/sega/chunithm/paradise/logo.webp new file mode 100644 index 0000000..bf867cf Binary files /dev/null and b/docs/img/sega/chunithm/paradise/logo.webp differ diff --git a/docs/img/sega/chunithm/paradiselost/logo.webp b/docs/img/sega/chunithm/paradiselost/logo.webp new file mode 100644 index 0000000..92738a4 Binary files /dev/null and b/docs/img/sega/chunithm/paradiselost/logo.webp differ diff --git a/docs/img/sega/chunithm/plus/logo.webp b/docs/img/sega/chunithm/plus/logo.webp new file mode 100644 index 0000000..b6c7cea Binary files /dev/null and b/docs/img/sega/chunithm/plus/logo.webp differ diff --git a/docs/img/sega/chunithm/star/logo.webp b/docs/img/sega/chunithm/star/logo.webp new file mode 100644 index 0000000..8a9a733 Binary files /dev/null and b/docs/img/sega/chunithm/star/logo.webp differ diff --git a/docs/img/sega/chunithm/starplus/logo.webp b/docs/img/sega/chunithm/starplus/logo.webp new file mode 100644 index 0000000..91d19f8 Binary files /dev/null and b/docs/img/sega/chunithm/starplus/logo.webp differ diff --git a/docs/img/sega/chunithm/sun/logo.webp b/docs/img/sega/chunithm/sun/logo.webp new file mode 100644 index 0000000..068cd0e Binary files /dev/null and b/docs/img/sega/chunithm/sun/logo.webp differ diff --git a/docs/img/sega/chunithm/sunplus/logo.webp b/docs/img/sega/chunithm/sunplus/logo.webp new file mode 100644 index 0000000..29ddeb4 Binary files /dev/null and b/docs/img/sega/chunithm/sunplus/logo.webp differ diff --git a/docs/img/sega/chunithm/verse/logo.webp b/docs/img/sega/chunithm/verse/logo.webp new file mode 100644 index 0000000..9068327 Binary files /dev/null and b/docs/img/sega/chunithm/verse/logo.webp differ diff --git a/docs/img/sega/chunithm/x-verse-x/logo.webp b/docs/img/sega/chunithm/x-verse-x/logo.webp new file mode 100644 index 0000000..5f35fb0 Binary files /dev/null and b/docs/img/sega/chunithm/x-verse-x/logo.webp differ diff --git a/docs/img/sega/chunithm/x-verse/logo.webp b/docs/img/sega/chunithm/x-verse/logo.webp new file mode 100644 index 0000000..0743eb2 Binary files /dev/null and b/docs/img/sega/chunithm/x-verse/logo.webp differ diff --git a/docs/img/sega/maimaidx/buddies/logo.webp b/docs/img/sega/maimaidx/buddies/logo.webp new file mode 100644 index 0000000..7c40a28 Binary files /dev/null and b/docs/img/sega/maimaidx/buddies/logo.webp differ diff --git a/docs/img/sega/maimaidx/buddiesplus/logo.webp b/docs/img/sega/maimaidx/buddiesplus/logo.webp new file mode 100644 index 0000000..0ab3b89 Binary files /dev/null and b/docs/img/sega/maimaidx/buddiesplus/logo.webp differ diff --git a/docs/img/sega/maimaidx/circle/logo.webp b/docs/img/sega/maimaidx/circle/logo.webp new file mode 100644 index 0000000..84871f5 Binary files /dev/null and b/docs/img/sega/maimaidx/circle/logo.webp differ diff --git a/docs/img/sega/maimaidx/common/setup/distribution_servers_check.webp b/docs/img/sega/maimaidx/common/setup/distribution_servers_check.webp new file mode 100644 index 0000000..3db5895 Binary files /dev/null and b/docs/img/sega/maimaidx/common/setup/distribution_servers_check.webp differ diff --git a/docs/img/sega/maimaidx/common/setup/service_game_settings.webp b/docs/img/sega/maimaidx/common/setup/service_game_settings.webp new file mode 100644 index 0000000..5e46bc5 Binary files /dev/null and b/docs/img/sega/maimaidx/common/setup/service_game_settings.webp differ diff --git a/docs/img/sega/maimaidx/common/setup/service_menu.webp b/docs/img/sega/maimaidx/common/setup/service_menu.webp new file mode 100644 index 0000000..5102b77 Binary files /dev/null and b/docs/img/sega/maimaidx/common/setup/service_menu.webp differ diff --git a/docs/img/sega/maimaidx/prism/logo.webp b/docs/img/sega/maimaidx/prism/logo.webp new file mode 100644 index 0000000..b8dffcf Binary files /dev/null and b/docs/img/sega/maimaidx/prism/logo.webp differ diff --git a/docs/img/sega/maimaidx/prismplus/logo.webp b/docs/img/sega/maimaidx/prismplus/logo.webp new file mode 100644 index 0000000..7fc5896 Binary files /dev/null and b/docs/img/sega/maimaidx/prismplus/logo.webp differ diff --git a/docs/img/sega/ongeki/brightmemory/logo.webp b/docs/img/sega/ongeki/brightmemory/logo.webp new file mode 100644 index 0000000..fa51f95 Binary files /dev/null and b/docs/img/sega/ongeki/brightmemory/logo.webp differ diff --git a/docs/img/sega/ongeki/common/c2c/client.webp b/docs/img/sega/ongeki/common/c2c/client.webp new file mode 100644 index 0000000..a92338d Binary files /dev/null and b/docs/img/sega/ongeki/common/c2c/client.webp differ diff --git a/docs/img/sega/ongeki/common/c2c/followstandard.webp b/docs/img/sega/ongeki/common/c2c/followstandard.webp new file mode 100644 index 0000000..e4fd547 Binary files /dev/null and b/docs/img/sega/ongeki/common/c2c/followstandard.webp differ diff --git a/docs/img/sega/ongeki/common/c2c/group.webp b/docs/img/sega/ongeki/common/c2c/group.webp new file mode 100644 index 0000000..9227fe4 Binary files /dev/null and b/docs/img/sega/ongeki/common/c2c/group.webp differ diff --git a/docs/img/sega/ongeki/common/c2c/host.webp b/docs/img/sega/ongeki/common/c2c/host.webp new file mode 100644 index 0000000..f4b7e45 Binary files /dev/null and b/docs/img/sega/ongeki/common/c2c/host.webp differ diff --git a/docs/img/sega/ongeki/common/c2c/service.webp b/docs/img/sega/ongeki/common/c2c/service.webp new file mode 100644 index 0000000..f2f61d9 Binary files /dev/null and b/docs/img/sega/ongeki/common/c2c/service.webp differ diff --git a/docs/img/sega/ongeki/common/c2c/standard.webp b/docs/img/sega/ongeki/common/c2c/standard.webp new file mode 100644 index 0000000..6b456cf Binary files /dev/null and b/docs/img/sega/ongeki/common/c2c/standard.webp differ diff --git a/docs/img/sega/ongeki/common/setup/servicemenu/0_ongeki_groupcheck.webp b/docs/img/sega/ongeki/common/setup/servicemenu/0_ongeki_groupcheck.webp new file mode 100644 index 0000000..2ba688e Binary files /dev/null and b/docs/img/sega/ongeki/common/setup/servicemenu/0_ongeki_groupcheck.webp differ diff --git a/docs/img/sega/ongeki/common/setup/servicemenu/1_gamesettings.webp b/docs/img/sega/ongeki/common/setup/servicemenu/1_gamesettings.webp new file mode 100644 index 0000000..43c6cc0 Binary files /dev/null and b/docs/img/sega/ongeki/common/setup/servicemenu/1_gamesettings.webp differ diff --git a/docs/img/sega/ongeki/common/setup/servicemenu/2_reference.webp b/docs/img/sega/ongeki/common/setup/servicemenu/2_reference.webp new file mode 100644 index 0000000..280ed98 Binary files /dev/null and b/docs/img/sega/ongeki/common/setup/servicemenu/2_reference.webp differ diff --git a/docs/img/sega/ongeki/common/setup/servicemenu/3_closesetting.webp b/docs/img/sega/ongeki/common/setup/servicemenu/3_closesetting.webp new file mode 100644 index 0000000..649de68 Binary files /dev/null and b/docs/img/sega/ongeki/common/setup/servicemenu/3_closesetting.webp differ diff --git a/docs/img/sega/ongeki/common/setup/servicemenu/4_alltime.webp b/docs/img/sega/ongeki/common/setup/servicemenu/4_alltime.webp new file mode 100644 index 0000000..b98a524 Binary files /dev/null and b/docs/img/sega/ongeki/common/setup/servicemenu/4_alltime.webp differ diff --git a/docs/img/sega/ongeki/refresh/logo.webp b/docs/img/sega/ongeki/refresh/logo.webp new file mode 100644 index 0000000..23f49ea Binary files /dev/null and b/docs/img/sega/ongeki/refresh/logo.webp differ diff --git a/docs/img/sega/wacca/reverse/logo.webp b/docs/img/sega/wacca/reverse/logo.webp new file mode 100644 index 0000000..21b6028 Binary files /dev/null and b/docs/img/sega/wacca/reverse/logo.webp differ diff --git a/docs/img/sega/wacca/reverse/setup/servicemenu/1_systemsetting.webp b/docs/img/sega/wacca/reverse/setup/servicemenu/1_systemsetting.webp new file mode 100644 index 0000000..87e3457 Binary files /dev/null and b/docs/img/sega/wacca/reverse/setup/servicemenu/1_systemsetting.webp differ diff --git a/docs/img/sega/wacca/reverse/setup/servicemenu/2_closingtime.webp b/docs/img/sega/wacca/reverse/setup/servicemenu/2_closingtime.webp new file mode 100644 index 0000000..9a950d4 Binary files /dev/null and b/docs/img/sega/wacca/reverse/setup/servicemenu/2_closingtime.webp differ diff --git a/docs/img/sega/wacca/reverse/setup/servicemenu/3_closingtimesetting.webp b/docs/img/sega/wacca/reverse/setup/servicemenu/3_closingtimesetting.webp new file mode 100644 index 0000000..c7b588c Binary files /dev/null and b/docs/img/sega/wacca/reverse/setup/servicemenu/3_closingtimesetting.webp differ diff --git a/docs/img/taito/tetoteconnect/logo.webp b/docs/img/taito/tetoteconnect/logo.webp new file mode 100644 index 0000000..c049137 Binary files /dev/null and b/docs/img/taito/tetoteconnect/logo.webp differ diff --git a/docs/img/two-torial/banner.webp b/docs/img/two-torial/banner.webp new file mode 100644 index 0000000..6bfce3c Binary files /dev/null and b/docs/img/two-torial/banner.webp differ diff --git a/docs/img/two-torial/github-banner.webp b/docs/img/two-torial/github-banner.webp new file mode 100644 index 0000000..d13105a Binary files /dev/null and b/docs/img/two-torial/github-banner.webp differ diff --git a/docs/img/two-torial/website-logo.svg b/docs/img/two-torial/website-logo.svg new file mode 100644 index 0000000..57510e8 --- /dev/null +++ b/docs/img/two-torial/website-logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..859af4f --- /dev/null +++ b/docs/index.md @@ -0,0 +1,46 @@ + + + + +
+A compendium of information and guides about arcade games. +By the community, for the community. + +[Join our Discord server! :fontawesome-brands-discord:](https://discord.gg/cZRUmEPK78){ .md-button } +
+ +
+ +!!! info "Troubleshooting forums are available in our Discord server if you need direct help!" + +!!! warning "This site is by no means all-encompassing" + + **We're only a group of volunteers aiming to bring you the most up-to-date information.** + + But we're only humans, we make mistakes, and therefore: + + - Please **use a certain degree of caution** while manipulating your game files and **make backups** + - Don't tamper with things if you don't know what you're doing + + If you can do that, these guides will probably be of use to you. + If not, **don't tell us we didn't warn you!** + +!!! info "How to use the site?" + + On the left side is a navigation bar containing every guide: + + - **Games** category for game-specific guides on how to setup data, troubleshoot issues, etc. + - **Error Codes** for a listing of known errors and what to do about them + - **Game Patching** category for ways to patch/modify your game + - **Extras** for anything that doesn't fit in the above categories + - **Other Resources** for links to useful sites such as patchers, external guides, etc. + +!!! info "Do you want to help us out?" + + Please check out our GitHub Repo by clicking the link at the top of right of the page. + Information on how to contribute is available there. diff --git a/docs/resources.md b/docs/resources.md new file mode 100644 index 0000000..5fef034 --- /dev/null +++ b/docs/resources.md @@ -0,0 +1,88 @@ +# Resources + +## spice2x Patchers + +!!! tip "See [spice2x Patching](./extras/patchsp2x.md)" + + - **TWO-TORIAL** - `https://sp2x.two-torial.xyz/` - **Our patcher for spice2x compatible games** + - **DJTrackers** - `https://djtrackers.com/bemanipatcher/2x` - **Alternative patcher for anything we don't support** + +## Web Patchers + +!!! tip "See [Web Patching](./extras/patchweb.md)" + + - [TWO-TORIAL](https://patcher.two-torial.xyz/) - **Our [open-source](https://github.com/two-torial/webpatcher) web patcher** *(based on mon's)* **for games incompatible with spice2x** + - [mon's](https://mon.im/bemanipatcher/) - The longest lasting web patcher, supports a variety of **n-1 and older** games + +## General + +!!! tip "" + + - [spice2x Wiki](https://github.com/spice2x/spice2x.github.io/wiki) - The best resource for spice2x + - [Bemaniwiki](https://bemaniwiki.com/) - A bemani wiki written in japanese + - [wikiwiki](https://wikiwiki.jp/) - A japanese game wiki, good for comparing against SilentBlue + - [Namuwiki](https://namu.wiki/) - A korean wiki for bemani and more + - [RemyWiki](https://remywiki.com/Main_Page) - Bemani arcade games wiki with lots of useful info + - [SilentBlue](https://silentblue.remywiki.com/Main_Page) - By RemyWiki's creators, but for SEGA games + +## Cons & Cabs + +!!! tip "" + + - [GameRepair.info](https://gamerepair.info/) - Repository of arcade part repair & misc information + - [Cons&Stuff](https://consandstuff.github.io/) - Community resource for DIY controllers + - [Rhythm Game Cabs](https://discord.gg/MNcMGCE8sk) - Discord server for arcade cabs + +## IIDX + +!!! tip "" + + - [iidx.org](https://iidx.org/) - The go to guide for mechanics and skill related things + - [CPI](https://cpi.makecir.com/) - (JP) Clear Power Indicator for SP☆12, also proposes recommendations based on your plays + - [sp12](https://sp12.iidx.app/) - IIDX SP☆12 reference site/difficulty tier list + - [beatmania.app](https://beatmania.app/!/) - IIDX INFINITAS difficulty tier list + - [atwiki](https://w.atwiki.jp/bemani2sp/sp/) - IIDX wiki in JP (includes tier lists) + - [textage.cc](https://textage.cc/score/) - Chart viewing resource + - [QPro Viewer by DJ HITOMI](https://qpro.inf.li/) - QPRO customization viewer + - [DJ DAO IIDX troubleshooting guide](https://github.com/minsang-github/rhythmgame-docs/wiki/DJ-DAO-IIDX-controller-troubleshooting) - Step-by-step guide for FPS, FP7, PEE, RES, RED controllers + +## SDVX + +!!! tip "" + + - [sdvx.org](https://www.sdvx.org/) - The go to guide for mechanics and skill related things + - [SDVX Index](https://sdvxindex.com/) - SDVX chart viewer and reference + - [SDVX Tier Lists](https://sdvx.maya2silence.com/) - SDVX difficulty tier lists + - [sdvx.in](https://sdvx.in/) - Worse looking alternative to SDVX Index (but also has other games available at the top) + - [SDVX Unlock Guide](https://docs.google.com/spreadsheets/d/1VBYWSUaKqHUOyfCtvkHFYBSnEPwxhTh8-m4UlU8zUL0/) - Translated guide for unlocks + - [SDVX Konasute on Steam Deck](https://sdvx.burrito.software/) - Guide to getting Konasute working on a Steam Deck + +## GITADORA + +!!! tip "" + + - [573Controller](https://github.com/limyz/573controller) - DIY guitar solution for converting official cab guitars to USB home-use + - [Drummania English Menu Translation](https://twitter.com/approvedtx/status/1174028743989317632?s=21) - Handy for beginners, lots of options! + +## CHUNITHM + +!!! tip "" + + - [sdvx.in](https://sdvx.in/chunithm.html) - Chart viewer for CHUNITHM + - [CHUNITHM Humen](https://www.youtube.com/@chunithm_humen) - Screen captures of all CHUNITHM charts + - Codex's [English Chunithm Guide](https://chunithm.org) - + Handy CHUNITHM resource for players of all skill levels + +## O.N.G.E.K.I + +!!! tip "" + + - [sdvx.in](https://sdvx.in/ongeki.html) - Chart viewer for O.N.G.E.K.I + - [O.N.G.E.K.I. Humen](https://www.youtube.com/@ongeki_humen) and [MLN Rev](https://www.youtube.com/@MLN_Rev) - Screen captures of all O.N.G.E.K.I. charts + - Lilyshy's [English O.N.G.E.K.I. Guide](https://docs.google.com/document/d/1HKCW7DWjYRnVjCmPzrQwDKC0wKTi41X-Y-dP1-ygliU/view) - Handy O.N.G.E.K.I. resource for players of all skill levels + +## Polaris Chord + +!!! tip "" + - [Polaris Touch](http://girlsband.party/polaris-touch.html) - Much like Brokenithm, but adapted for Polaris Chord + - [Polaris Touch Godot](https://github.com/GEEKiDoS/polaris-touch-godot) - Like Polaris Touch, but as a native Android app \ No newline at end of file diff --git a/docs/robots.txt b/docs/robots.txt new file mode 100644 index 0000000..72ce85d --- /dev/null +++ b/docs/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Disallow: / \ No newline at end of file diff --git a/docs/snippets/common/audio_48khz.md b/docs/snippets/common/audio_48khz.md new file mode 100644 index 0000000..062d13c --- /dev/null +++ b/docs/snippets/common/audio_48khz.md @@ -0,0 +1,12 @@ +!!! tip "" + + - Open sound settings + - On Windows 10: Right-click on the volume icon in your taskbar and select `Sounds` + - On Windows 11: Right-click on the volume icon in your taskbar and select `Sound settings` then scroll down and click on `More sound settings` + - Navigate to the `Playback` tab, right click on your default audio device, and click on `Properties` + - Go to the `Advanced` tab + - Check both boxes under `Exclusive Mode` + - Open the `Default Format` dropdown + - Pick either `16 bit, 48000Hz (DVD Quality)` or `24 bit, 48000Hz (Studio Quality)`, click `Apply`, then `OK` + + \ No newline at end of file diff --git a/docs/snippets/common/before_playing.md b/docs/snippets/common/before_playing.md new file mode 100644 index 0000000..f61ed78 --- /dev/null +++ b/docs/snippets/common/before_playing.md @@ -0,0 +1,6 @@ +!!! tip "A few things to remember before each play session" + + - Close of any applications running in the background which could affect performance + - Double-check your monitor is oriented properly for this game + - Double-check your sample rate is correct for this game + - Connect your controller \ No newline at end of file diff --git a/docs/snippets/common/data_readonly.md b/docs/snippets/common/data_readonly.md new file mode 100644 index 0000000..c6af465 --- /dev/null +++ b/docs/snippets/common/data_readonly.md @@ -0,0 +1,10 @@ +!!! tip "" + + Ensure your game files are not marked as read-only: + + - Right click the directory containing your files + - Click on `Properties` + - Under the `General` tab, find `Attributes` and uncheck `Read-only` + - Click `Apply` + - When prompted, select `Apply changes to this folder, subfolders and files` + - Click `OK` to confirm, then `OK` again to close Properties \ No newline at end of file diff --git a/docs/snippets/common/data_warning.md b/docs/snippets/common/data_warning.md new file mode 100644 index 0000000..90263ae --- /dev/null +++ b/docs/snippets/common/data_warning.md @@ -0,0 +1,4 @@ +!!! danger "You must obtain clean, unmodified and complete data to proceed with our guides" + + **Corrupted or incomplete files will cause unpredictable issues we can't cover.** + **TWO-TORIAL does not provide or distribute game data. Do not ask.** \ No newline at end of file diff --git a/docs/snippets/common/help.md b/docs/snippets/common/help.md new file mode 100644 index 0000000..6644414 --- /dev/null +++ b/docs/snippets/common/help.md @@ -0,0 +1,6 @@ +!!! warning "Something's wrong?" + + Make sure you've followed all steps correctly and also read other relevant guides. + + Still stuck? You can join our Discord community server for support! + Click on the Discord logo at the bottom right of the page. \ No newline at end of file diff --git a/docs/snippets/common/old_guide.md b/docs/snippets/common/old_guide.md new file mode 100644 index 0000000..3df1585 --- /dev/null +++ b/docs/snippets/common/old_guide.md @@ -0,0 +1,6 @@ +!!! danger "This guide is in need of a revision, it is not up to our current standards" + + The information it provides is still likely good but we can't guarantee it. + + TWO-TORIAL is a community-driven project with limited resources. + If you want to help us out, you're more than welcome to contribute! \ No newline at end of file diff --git a/docs/snippets/common/reminder_beforeplaying.md b/docs/snippets/common/reminder_beforeplaying.md new file mode 100644 index 0000000..c0d0df3 --- /dev/null +++ b/docs/snippets/common/reminder_beforeplaying.md @@ -0,0 +1,6 @@ +!!! tip "A few things to remember before each play session" + + - Close of any applications running in the background which could affect performance + - Double-check your monitor orientation is correct for this game + - Double-check your sample rate is correct for this game + - Connect your controller \ No newline at end of file diff --git a/docs/snippets/common/setup_vcredist_directx.md b/docs/snippets/common/setup_vcredist_directx.md new file mode 100644 index 0000000..c25ec04 --- /dev/null +++ b/docs/snippets/common/setup_vcredist_directx.md @@ -0,0 +1,6 @@ +!!! tip "" + + Download and install: + + - [VCRedist All-in-one](https://www.techpowerup.com/download/visual-c-redistributable-runtime-package-all-in-one/) + - [DirectX End-User Runtimes](https://www.microsoft.com/en-us/download/details.aspx?id=8109) diff --git a/docs/snippets/konami/common/btools_cards.md b/docs/snippets/konami/common/btools_cards.md new file mode 100644 index 0000000..c2f1a6f --- /dev/null +++ b/docs/snippets/konami/common/btools_cards.md @@ -0,0 +1,17 @@ + !!! info "This tab lets you configure which cards are used to save your game profile to" + + !!! warning "If you haven't generated a card number before, you can grab one from [here](https://kawashi.ro/card)" + + !!! tip "" + + Now we will set up our PIN pad and card. + + - Click on `Keyboard device` for whichever player's card reader you want to use + - You may or may not have more than one option. To figure out which one is your actual keyboard, select a device inside that list and press a button on the numpad + - Once you have found your correct device, the `Keypad status` will change **(the number and location of the number does not matter, it only matters that it changed)** + - Create a `.txt` file in a location that is easily accessible, and name it however you like + - Inside the file, paste in your card number. Example: `E0045812F8AFB2DE` + - Point to the file you created by clicking `Browse...` and selecting it + + !!! info "If you don't have a numpad, tick `Use top keyboard row for PIN pad input`. This will also change the `Card In` button to `Backspace`" + diff --git a/docs/snippets/konami/common/btools_lights.md b/docs/snippets/konami/common/btools_lights.md new file mode 100644 index 0000000..4777c20 --- /dev/null +++ b/docs/snippets/konami/common/btools_lights.md @@ -0,0 +1,8 @@ + !!! info "This tab allows you to configure controller lights to sync with the game" + Not all controllers support this, but it does not affect gameplay and is completely optional. + + !!! tip "" + + - In `Device`, pick your controller + - In `Game Light`, select the corresponding button that will be used for that light + - Repeat for your other lights \ No newline at end of file diff --git a/docs/snippets/konami/common/cpu_avx2.md b/docs/snippets/konami/common/cpu_avx2.md new file mode 100644 index 0000000..9e6ff4a --- /dev/null +++ b/docs/snippets/konami/common/cpu_avx2.md @@ -0,0 +1,7 @@ +!!! danger "AVX2 capable CPU required" + + This game requires your CPU to be compatible with AVX2 instructions. + + If your CPU is too old, the game will crash with an `EXCEPTION_ILLEGAL_INSTRUCTION` error. + + A known workaround is renaming/deleting the `movies` folder to prevent the game from loading them altogether. \ No newline at end of file diff --git a/docs/snippets/konami/common/data_bad.md b/docs/snippets/konami/common/data_bad.md new file mode 100644 index 0000000..3259081 --- /dev/null +++ b/docs/snippets/konami/common/data_bad.md @@ -0,0 +1,10 @@ +!!! danger "If your data does not look like this" + + 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 + + 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.** \ No newline at end of file diff --git a/docs/snippets/konami/common/data_update.md b/docs/snippets/konami/common/data_update.md new file mode 100644 index 0000000..fb5eb3e --- /dev/null +++ b/docs/snippets/konami/common/data_update.md @@ -0,0 +1,12 @@ +!!! tip "" + + - Extract the update to your game directory, ensure directories align and overwrite files when prompted + - Open `prop\ea3-config.xml` and find the `` line: + ```xml + NewDateCode + ``` + - Update the datecode to match your new game version and save + - If `prop\bootstrap.xml` exists, also update its `` line: + ```xml + NewDateCode + ``` \ No newline at end of file diff --git a/docs/snippets/konami/common/display_portraitfirst.md b/docs/snippets/konami/common/display_portraitfirst.md new file mode 100644 index 0000000..2d7fe97 --- /dev/null +++ b/docs/snippets/konami/common/display_portraitfirst.md @@ -0,0 +1,16 @@ +!!! info "This game requires your main monitor to be set to `Portait` or `Portait (flipped)` mode" + +??? tip "You will play in Portait mode (Recommended)" + + - Right click on your Desktop + - Select `Display settings` + - Look for `Display orientation` and set it to `Portrait` or `Portrait (flipped)` + - Rotate your monitor 90° + +??? tip "You cannot play in Portait mode" + + In this case, your only option is to: + + - Open `spicecfg`, go to the `Options` tab + - Set the game to `Windowed Mode (-w)` + - Set your desired `Window Resolution (-windowsize)` for the game \ No newline at end of file diff --git a/docs/snippets/konami/common/setup_audio.md b/docs/snippets/konami/common/setup_audio.md new file mode 100644 index 0000000..5893333 --- /dev/null +++ b/docs/snippets/konami/common/setup_audio.md @@ -0,0 +1,31 @@ +!!! info "Check out our general [Audio](/extras/audio.md) guide to understand audio modes better, at least the TL;DR" + +!!! tip "" + + - Open `spicecfg.exe` + - At the very top, click on `Shortcuts` then `Audio Playback Devices` + - In the popup window, right click on your default audio device, and click on `Properties` + - Go to the `Advanced` tab + + Then, depending follow instructions for your desired audio mode: + +??? tip "Setup for WASAPI Exclusive (default)" + + - Check both boxes under `Exclusive Mode` + - Open the `Default Format` dropdown + - Pick the `16 bit, 44100 Hz (CD Quality)` option, click `Apply` then `OK` + +??? tip "Setup for WASAPI Shared" + + - Open the `Default Format` dropdown + - Pick the `16 bit, 48000 Hz (DVD Quality)` option, click `Apply` then `OK` + - Return to `spicecfg`, go to the `Patches` tab + - Following the [patching guide](/extras/patchsp2x.md) and patch `Shared Mode WASAPI` + + Optionally: go to the `Options` tab, and at the very bottom enable `Low Latency Shared Audio` to help mitigate the latency penalty from using Shared audio. + +??? tip "Setup for ASIO (requires specialized hardware)" + + - Check both boxes under `Exclusive Mode` + - Open the `Default Format` dropdown + - Pick the `16 bit, 44100 Hz (CD Quality)` option, click `Apply` then `OK` \ No newline at end of file diff --git a/docs/snippets/konami/common/setup_audio_wasapiexcl_only.md b/docs/snippets/konami/common/setup_audio_wasapiexcl_only.md new file mode 100644 index 0000000..d1c08f9 --- /dev/null +++ b/docs/snippets/konami/common/setup_audio_wasapiexcl_only.md @@ -0,0 +1,13 @@ +!!! info "Check out our general [Audio](/extras/audio.md) guide to understand audio modes better, at least the TL;DR" + +!!! danger "This game only supports WASAPI Exclusive mode. Some audio devices may not support this" + +!!! tip "" + + - Open `spicecfg.exe` + - At the very top, click on `Shortcuts` then `Audio Playback Devices` + - In the popup window, right click on your default audio device, and click on `Properties` + - Go to the `Advanced` tab + - Check both boxes under `Exclusive Mode` + - Open the `Default Format` dropdown + - Pick the `16 bit, 44100 Hz (CD Quality)` option, click `Apply` then `OK` diff --git a/docs/snippets/konami/common/setup_network.md b/docs/snippets/konami/common/setup_network.md new file mode 100644 index 0000000..b554310 --- /dev/null +++ b/docs/snippets/konami/common/setup_network.md @@ -0,0 +1,26 @@ +!!! danger "Pick one or the other, not both!" + +??? tip "Option 1: Remote (Online Network)" + + Remote networks typically require an invitation to join. + You'll need to connect with members of the community who can provide you with an invite. + + Your network should provide you with the necessary information to proceed: + + - Open `spicecfg.exe` and head to the `Options` tab + + Under the `Network` category, set the following settings provided by your network: + + - `EA Service URL (-url)` + - `PCBID (-p)` + + + +??? tip "Option 2: Local e-amuse Emulator (Asphyxia)" + + For instructions on setting up Asphyxia, please refer to our [Asphyxia setup guide](/extras/asphyxia.md). + + After Asphyxia is setup with the proper plugin for your game: + + - Open `spicecfg.exe` and head to the `Options` tab + - Under the `Network` category, set your `EA Service URL (-url)` to point to your asphyxia server, typically `localhost:8083` \ No newline at end of file diff --git a/docs/snippets/konami/common/spice2x32_install.md b/docs/snippets/konami/common/spice2x32_install.md new file mode 100644 index 0000000..ff013eb --- /dev/null +++ b/docs/snippets/konami/common/spice2x32_install.md @@ -0,0 +1,6 @@ +!!! info "If you already have spice2x installed, ensure you're using the latest version" + +!!! tip "" + + - 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 \ No newline at end of file diff --git a/docs/snippets/konami/common/spice2x32_stubs.md b/docs/snippets/konami/common/spice2x32_stubs.md new file mode 100644 index 0000000..02e0d43 --- /dev/null +++ b/docs/snippets/konami/common/spice2x32_stubs.md @@ -0,0 +1,6 @@ +??? warning "Additional steps for AMD and Intel graphics cards" + + Since KONAMI games are designed for NVIDIA GPU's, AMD and Intel users need additional files: + + - Locate the `spice2x\stubs\32\` folder in the spice2x archive + - Extract all `.dll` files from there into your game's `modules` folder \ No newline at end of file diff --git a/docs/snippets/konami/common/spice2x64_install.md b/docs/snippets/konami/common/spice2x64_install.md new file mode 100644 index 0000000..48e4ab1 --- /dev/null +++ b/docs/snippets/konami/common/spice2x64_install.md @@ -0,0 +1,6 @@ +!!! info "If you already have spice2x installed, ensure you're using the latest version" + +!!! tip "" + + - 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 \ No newline at end of file diff --git a/docs/snippets/konami/common/spice2x64_stubs.md b/docs/snippets/konami/common/spice2x64_stubs.md new file mode 100644 index 0000000..84a6eb4 --- /dev/null +++ b/docs/snippets/konami/common/spice2x64_stubs.md @@ -0,0 +1,6 @@ +??? warning "Additional steps for AMD and Intel graphics cards" + + Since KONAMI games are designed for NVIDIA GPU's, AMD and Intel users need additional files: + + - Locate the `spice2x\stubs\64\` folder in the spice2x archive + - Extract all `.dll` files from there into your game's `modules` folder \ No newline at end of file diff --git a/docs/snippets/konami/common/spicecfg_buttons.md b/docs/snippets/konami/common/spicecfg_buttons.md new file mode 100644 index 0000000..caa5425 --- /dev/null +++ b/docs/snippets/konami/common/spicecfg_buttons.md @@ -0,0 +1,6 @@ + !!! info "This tab is used to bind your keyboard and controller buttons" + + !!! info "Bind vs Naive" + + **Bind** - Use for controllers and hardware devices. **More responsive** and detects any HID device. + **Naive** - Use for device agnostic keyboard binds. **Less responsive** but works with simulated keystrokes. \ No newline at end of file diff --git a/docs/snippets/konami/common/spicecfg_buttons_additionalinfo.md b/docs/snippets/konami/common/spicecfg_buttons_additionalinfo.md new file mode 100644 index 0000000..365e848 --- /dev/null +++ b/docs/snippets/konami/common/spicecfg_buttons_additionalinfo.md @@ -0,0 +1,5 @@ + !!! info "Additional info" + + - Use page navigation at the bottom to bind multiple buttons to the same input + - Check **Bind Many** to bind multiple controls in sequence + - Click **Edit** after binding for advanced options (invert, MIDI sensitivity, etc.) \ No newline at end of file diff --git a/docs/snippets/konami/common/spicecfg_cards.md b/docs/snippets/konami/common/spicecfg_cards.md new file mode 100644 index 0000000..04f9c34 --- /dev/null +++ b/docs/snippets/konami/common/spicecfg_cards.md @@ -0,0 +1,24 @@ + !!! info "This tab lets you configure which cards are used to save your game profile to" + + ??? tip "If you own a physical e-amuse/FeliCa card and a compatible NFC card reader" + + Setup instructions vary depending on your specific reader model. + + Navigate to the `Advanced` tab and scroll down to the `NFC Card Readers` section. + Browse the available options and hover over each one to view descriptions and configuration guidance. + + **There is no need for you to specify cards for either player in this tab when using a card reader.** + + ??? tip "If you don't, you can use a virtual card number instead" + + If you already have generated a card number before, you may use this one. + + To generate a new card number for Player 1 or 2: + + - Click on `Open...` + - Choose where to save your card number + - Give it a file name (e.g. `card0.txt`) + - Click save + - Finally, click on `Generate` + + This will automatically generate a valid card number for you and keep it in the file you specified. \ No newline at end of file diff --git a/docs/snippets/konami/common/spicecfg_lights.md b/docs/snippets/konami/common/spicecfg_lights.md new file mode 100644 index 0000000..7bb9fa8 --- /dev/null +++ b/docs/snippets/konami/common/spicecfg_lights.md @@ -0,0 +1,11 @@ + !!! info "This tab allows you to configure controller lights to sync with the game" + + Not all controllers support this, but it does not affect gameplay and is completely optional. + + !!! tip "" + + - Click `Bind` + - In `Device`, pick your controller + - In `Light Control`, select the corresponding light + - Click `Close` + - Repeat for your other lights \ No newline at end of file diff --git a/docs/snippets/konami/common/spicecfg_nochange.md b/docs/snippets/konami/common/spicecfg_nochange.md new file mode 100644 index 0000000..c6ce0b1 --- /dev/null +++ b/docs/snippets/konami/common/spicecfg_nochange.md @@ -0,0 +1 @@ + !!! warning "No need to change anything here" \ No newline at end of file diff --git a/docs/snippets/konami/common/spicecfg_options_nvprofile.md b/docs/snippets/konami/common/spicecfg_options_nvprofile.md new file mode 100644 index 0000000..8ae6c68 --- /dev/null +++ b/docs/snippets/konami/common/spicecfg_options_nvprofile.md @@ -0,0 +1,3 @@ + !!! tip "NVIDIA GPU users ONLY" + + Enable `NVIDIA profile optimization (-nvprofile)` to let spice2x create an optimized profile for your game. \ No newline at end of file diff --git a/docs/snippets/konami/common/spicecfg_overlay.md b/docs/snippets/konami/common/spicecfg_overlay.md new file mode 100644 index 0000000..31c6ebf --- /dev/null +++ b/docs/snippets/konami/common/spicecfg_overlay.md @@ -0,0 +1,5 @@ + !!! info "This tab is used to bind keys to toggle spice2x and game-related overlays" + + !!! tip "Binding extra buttons here is optional, defaults are fine" + + Click on `Bind` or `Naive` then press the key you want associated with the action. \ No newline at end of file diff --git a/docs/snippets/konami/common/spicecfg_patches.md b/docs/snippets/konami/common/spicecfg_patches.md new file mode 100644 index 0000000..9999ec6 --- /dev/null +++ b/docs/snippets/konami/common/spicecfg_patches.md @@ -0,0 +1 @@ + !!! info "Go through the [spice2x Patching](/extras/patchsp2x.md) to import and pick patches" \ No newline at end of file diff --git a/docs/snippets/konami/common/spicecfg_preamble.md b/docs/snippets/konami/common/spicecfg_preamble.md new file mode 100644 index 0000000..ca0c3a1 --- /dev/null +++ b/docs/snippets/konami/common/spicecfg_preamble.md @@ -0,0 +1,5 @@ +!!! info "Following tabs correspond to the ones found in `spicecfg`" + + Additional information is available at [spice2x's wiki](https://github.com/spice2x/spice2x.github.io/wiki/). + +!!! danger "Avoid changing or patching anything you don't need or understand unless explicitly told to" \ No newline at end of file diff --git a/docs/snippets/konami/iidx/btools_analogs.md b/docs/snippets/konami/iidx/btools_analogs.md new file mode 100644 index 0000000..f5aae17 --- /dev/null +++ b/docs/snippets/konami/iidx/btools_analogs.md @@ -0,0 +1,13 @@ + !!! info "This tab is used to bind analog controls like the turntable" + + !!! warning "Ignore this tab if you play with a keyboard" + + !!! tip "Bind your controller's turntable" + + With a controller rather than binding buttons to `TT+` and `TT-`, you need to: + + - Head to the `Analogs` tab at the top + - In `Device`, pick your controller + - In `Control`, pick whichever one corresponds to the turntable + - Turn your turntable ensuring that the preview turns along with it + - Click `OK`, leaving the rest of the settings alone \ No newline at end of file diff --git a/docs/snippets/konami/iidx/btools_buttons.md b/docs/snippets/konami/iidx/btools_buttons.md new file mode 100644 index 0000000..5337c2b --- /dev/null +++ b/docs/snippets/konami/iidx/btools_buttons.md @@ -0,0 +1,15 @@ + !!! info "This tab is used to bind your keyboard and controller buttons" + + !!! tip "" + + Double click on the right on a button that you wish to bind, then press the key you want associated with the action. + + With your controller and/or keyboard plugged in, configure your keys for: + + - **Maintenance**: `Service, Test` + - **P1 Game buttons**: `1 to 7, Start, EFFECT, VEFX` + - **P1 Keypad**: `Keypad Insert Card` + + **Only if** you're playing using a keyboard: + + - **Turntable**: `TT+, TT-` **and optionally** `TT+/-` which alternates between `TT+` and `TT-` on each press. \ No newline at end of file diff --git a/docs/snippets/konami/iidx/btools_clvsd.md b/docs/snippets/konami/iidx/btools_clvsd.md new file mode 100644 index 0000000..df71ddc --- /dev/null +++ b/docs/snippets/konami/iidx/btools_clvsd.md @@ -0,0 +1,18 @@ +!!! tip "" + + For background movies to work, you need to install and register a codec. + + This also applies for IIDX 12 to 18, if you'd done it before you shouldn't need to again and may skip this step. + + - Inside `bemanitools-supplement-vx.x.zip` locate and open `iidx.zip` + + - Inside `iidx\misc\`, extract `CLVSD.ax` to any directory where the file can stay long term + As an example we will be using your Documents folder, but it really could be anywhere you prefer. + + - Open a command prompt as ***administrator***, and run `regsvr32 "CHOSEN_PATH\CLVSD.ax"` + For the Documents folder, the command would be `regsvr32 "C:\Users\YOUR_USERNAME\Documents\CLVSD.ax"` + + You should get confirmation that the file has been registered successfully. + + If an error occurs, you most likely didn't start your command prompt as administrator, or the location to CLVSD.ax was incorrect. + diff --git a/docs/snippets/konami/iidx/btools_connecting_network.md b/docs/snippets/konami/iidx/btools_connecting_network.md new file mode 100644 index 0000000..ed1808e --- /dev/null +++ b/docs/snippets/konami/iidx/btools_connecting_network.md @@ -0,0 +1,42 @@ +!!! danger "Pick one or the other, not both!" + +??? tip "Option 1: Remote (Online Network)" + + Remote networks typically require an invitation to join. + You'll need to connect with members of the community who can provide you with an invite. + + Your network should provide you with the necessary information to proceed: + + - Open `iidxhook-xx.conf` (xx being your game version) with a text editor + + - In the line `eamuse.server=localhost:80`, replace `localhost:80` with your provided network url + + - In the lines `eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX` **and** `eamuse.eamid=XXXXXXXXXXXXXXXXXXXX`, replace the part after `=` with your provided PCBID + + - Example: + ``` + # URL (e.g. http://my.eamuse.server:80/whatever) or IPV4 (e.g. 127.0.0.1:80) of the target eamuse server. The port is optional but defaults to 80. + eamuse.server=http://be.ma.ni/ + + # PCBID + eamuse.pcbid=ABMYPRECIOUSPCBIDCDE + + # EAMID + eamuse.eamid=ABMYPRECIOUSPCBIDCDE + ``` + +??? tip "Option 2: Local e-amuse Emulator (Asphyxia)" + + For instructions on setting up Asphyxia, please refer to our [Asphyxia setup guide](/extras/asphyxia.md). + + After Asphyxia is setup with the proper plugin for your game: + + - Open `iidxhook-xx.conf` (xx being your game version) with a text editor + + - In the line `eamuse.server=localhost:80`, replace `localhost:80` to point to your asphyxia server, typically `localhost:8083` + + - Example: + ``` + # URL (e.g. http://my.eamuse.server:80/whatever) or IPV4 (e.g. 127.0.0.1:80) of the target eamuse server. The port is optional but defaults to 80. + eamuse.server=localhost:8083 + ``` \ No newline at end of file diff --git a/docs/snippets/konami/iidx/btools_d3d8to9.md b/docs/snippets/konami/iidx/btools_d3d8to9.md new file mode 100644 index 0000000..ff0bdf7 --- /dev/null +++ b/docs/snippets/konami/iidx/btools_d3d8to9.md @@ -0,0 +1,9 @@ +!!! tip "" + + - Download the latest Bemanitools supplements release [here](https://github.com/djhackersdev/bemanitools-supplement/releases/latest) + + - Inside `bemanitools-supplement-vx.x.zip` locate `misc.zip` + + - Inside `misc\d3d8to9\`, extract `d3d8.dll` to your revision directory + + This lets you configure graphics options inside `iidxhook-xx.conf` (xx being your game version number) diff --git a/docs/snippets/konami/iidx/btools_graphics.md b/docs/snippets/konami/iidx/btools_graphics.md new file mode 100644 index 0000000..d2b29d6 --- /dev/null +++ b/docs/snippets/konami/iidx/btools_graphics.md @@ -0,0 +1,26 @@ +!!! tip "" + + - Open your `iidxhook-xx.conf` (xx being your game version) + + - Locate and change the options we're interested in: + + ``` + gfx.framed=false # Only matters if windowed. False for borderless, True for decorations (title bar, etc..) + gfx.frame_rate_limit=0.0 # Set this to 59.95 + gfx.windowed=false # False for fullscreen, True for windowed + gfx.window_width=0 # Set to your desired game width (recommended: monitor width) + gfx.window_height=0 # Set to your desired game height (recommended: monitor height) + gfx.scale_back_buffer_width=0 # Set to your desired game width (recommended: monitor width) + gfx.scale_back_buffer_height=0 # Set to your desired game height (recommended: monitor height) + gfx.scale_back_buffer_filter=none # Set to point or linear (pick one from examples below) + ``` + + Here are visual examples of the two filter options: + + ??? info "point (sharp, pixel perfect)" + + + + ??? info "linear (less sharp, not pixel perfect)" + + diff --git a/docs/snippets/konami/iidx/ldj_vs_tdj.md b/docs/snippets/konami/iidx/ldj_vs_tdj.md new file mode 100644 index 0000000..d42c4dd --- /dev/null +++ b/docs/snippets/konami/iidx/ldj_vs_tdj.md @@ -0,0 +1,20 @@ +!!! note "" + + Before proceeding with the setup, it's 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 + + - **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. + + 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_advanced_camhook.md b/docs/snippets/konami/iidx/spicecfg_advanced_camhook.md new file mode 100644 index 0000000..6973210 --- /dev/null +++ b/docs/snippets/konami/iidx/spicecfg_advanced_camhook.md @@ -0,0 +1,11 @@ + !!! tip "Optional: Camera hook" + + With a webcam connected, you can: + + - Enable `IIDX Cam Hook (-iidxtdjcamhook)` + - Make sure `IIDX Disable Cameras (-iidxdisablecams)` from the `Options` tab is disabled + - Optionally enable `IIDX Camera Order Flip (-iidxflipcams)` if you have two cameras connected and the wrong one is being used + + This allows spice2x to try and interface with your webcam to enable camera functionality in the game. + + You can then bind a button to the `Camera Control` overlay in the Overlay tab to adjust camera settings. \ No newline at end of file diff --git a/docs/snippets/konami/iidx/spicecfg_analogs.md b/docs/snippets/konami/iidx/spicecfg_analogs.md new file mode 100644 index 0000000..5ac4354 --- /dev/null +++ b/docs/snippets/konami/iidx/spicecfg_analogs.md @@ -0,0 +1,12 @@ + !!! info "This tab is used to bind analog controls like the turntable" + + !!! warning "Ignore this tab if you play with a keyboard" + + !!! tip "Bind your controller's turntable" + + With a controller, instead of binding `TT+` or `TT-` in the `Buttons` tab, you need to: + + - Click `Bind` + - In `Device`, pick your controller + - In `Control`, pick the control that updates the preview when turning the turntable, typically `X` + - Click `Close`, leaving the rest of the settings alone \ No newline at end of file diff --git a/docs/snippets/konami/iidx/spicecfg_buttons.md b/docs/snippets/konami/iidx/spicecfg_buttons.md new file mode 100644 index 0000000..1b2c764 --- /dev/null +++ b/docs/snippets/konami/iidx/spicecfg_buttons.md @@ -0,0 +1,13 @@ + !!! 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 P1 and/or P2: + + - **Maintenance**: `Service, Test` + - **Game buttons**: `SW1 to SW7, Start, EFFECT, VEFX` + - **Keypad**: `Keypad Insert Card`, `1 to 9` + + **Only if** you play with a keyboard: + + - **Turntable**: `TT+, TT-` **and optionally** `TT+/-` which alternates between `TT+` and `TT-` on each press. \ No newline at end of file diff --git a/docs/snippets/konami/iidx/spicecfg_options_disablecams.md b/docs/snippets/konami/iidx/spicecfg_options_disablecams.md new file mode 100644 index 0000000..050123b --- /dev/null +++ b/docs/snippets/konami/iidx/spicecfg_options_disablecams.md @@ -0,0 +1,3 @@ + !!! tip "Important" + + Enable `IIDX Disable Cameras (-iidxdisablecams)` **unless** you have a webcam connected and wish to use it with the camera hook from the advanced tab. \ 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 new file mode 100644 index 0000000..3f317fd --- /dev/null +++ b/docs/snippets/konami/iidx/spicecfg_options_tdj.md @@ -0,0 +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 diff --git a/docs/snippets/konami/sdvx/spicecfg_analogs.md b/docs/snippets/konami/sdvx/spicecfg_analogs.md new file mode 100644 index 0000000..a7a6446 --- /dev/null +++ b/docs/snippets/konami/sdvx/spicecfg_analogs.md @@ -0,0 +1,13 @@ + !!! info "This tab is used to bind analog controls like knobs" + + !!! warning "Ignore this tab if you play with a keyboard" + + !!! tip "Bind your controller's knobs" + + With a controller, instead of binding to `VOL-L` and `VOL-R` in the `Buttons` tab, you need to: + + - Click `Bind` + - In `Device`, pick your controller + - In `Control`, pick the control that updates the preview when turning the corresponding knob + - Click `Close`, leaving the rest of the settings alone + - Repeat for your other knob \ No newline at end of file diff --git a/docs/snippets/konami/sdvx/spicecfg_buttons.md b/docs/snippets/konami/sdvx/spicecfg_buttons.md new file mode 100644 index 0000000..3c59880 --- /dev/null +++ b/docs/snippets/konami/sdvx/spicecfg_buttons.md @@ -0,0 +1,13 @@ + !!! 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:** `BT-A, BT-B, BT-C, BT-D, FX-L, FX-R, Start` + - **P1 Keypad**: `Keypad 0 to 9, Keypad Insert Card` + + **Only if** you play with a keyboard: + + - **Knobs:** `VOL-L Left, VOL-L Right, VOL-R Left, Vol-R Right` \ No newline at end of file diff --git a/docs/snippets/sega/chunithm/data_options.md b/docs/snippets/sega/chunithm/data_options.md new file mode 100644 index 0000000..5e610b7 --- /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. + + ``` + 📂amfs + 📂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/segatools_gfx.md b/docs/snippets/sega/chunithm/segatools_gfx.md new file mode 100644 index 0000000..97b3114 --- /dev/null +++ b/docs/snippets/sega/chunithm/segatools_gfx.md @@ -0,0 +1,10 @@ + !!! tip "Display settings" + + - 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 "Finding your monitor index" + + 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/common/data_bad.md b/docs/snippets/sega/common/data_bad.md new file mode 100644 index 0000000..f88d095 --- /dev/null +++ b/docs/snippets/sega/common/data_bad.md @@ -0,0 +1,10 @@ +!!! danger "If your data doesn't look like this" + + 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 + + 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.** \ No newline at end of file diff --git a/docs/snippets/sega/common/data_driveletter.md b/docs/snippets/sega/common/data_driveletter.md new file mode 100644 index 0000000..80b8fb7 --- /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/data_icfs.md b/docs/snippets/sega/common/data_icfs.md new file mode 100644 index 0000000..8e46c2a --- /dev/null +++ b/docs/snippets/sega/common/data_icfs.md @@ -0,0 +1,15 @@ +!!! tip "" + + Install Configuration Files (ICFs) tell the game what version it is. + **Without this your game cannot go online!** + + **If your unprotected executables came with an `amfs` folder, and already has a file named `ICF1` in it, skip this step.** + + Otherwise, obtain copies of `ICF1` for your game version and place it in + the `amfs` folder. If it is named something else, rename it to exactly + `ICF1` **without any file extensions.** + +!!! info "Showing file extensions" + + By default, file extensions on Windows are hidden. Enable them by navigating to + the `View` tab in File Explorer and select `File name extensions`. \ No newline at end of file diff --git a/docs/snippets/sega/common/data_modding.md b/docs/snippets/sega/common/data_modding.md new file mode 100644 index 0000000..d17a681 --- /dev/null +++ b/docs/snippets/sega/common/data_modding.md @@ -0,0 +1,3 @@ +??? 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/data_old.md b/docs/snippets/sega/common/data_old.md new file mode 100644 index 0000000..83c981f --- /dev/null +++ b/docs/snippets/sega/common/data_old.md @@ -0,0 +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. + SEGA games **DO NOT** like being extracted over old data! \ No newline at end of file diff --git a/docs/snippets/sega/common/data_preparation.md b/docs/snippets/sega/common/data_preparation.md new file mode 100644 index 0000000..d4eec80 --- /dev/null +++ b/docs/snippets/sega/common/data_preparation.md @@ -0,0 +1,18 @@ + Here's what the expected original data structure should look like: + + ``` + 📂amfs + 📂App + 📂Option + ``` + + Create another empty folder named `AppData` next to them: + + ``` + 📂amfs + 📂App + 📂AppData + 📂Option + ``` + + The `App` folder should have a file structure as follows: \ No newline at end of file diff --git a/docs/snippets/sega/common/data_updating.md b/docs/snippets/sega/common/data_updating.md new file mode 100644 index 0000000..dd1c25d --- /dev/null +++ b/docs/snippets/sega/common/data_updating.md @@ -0,0 +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 diff --git a/docs/snippets/sega/common/network_local.md b/docs/snippets/sega/common/network_local.md new file mode 100644 index 0000000..fe3186e --- /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/common/network_local_artemisonly.md b/docs/snippets/sega/common/network_local_artemisonly.md new file mode 100644 index 0000000..6ab069b --- /dev/null +++ b/docs/snippets/sega/common/network_local_artemisonly.md @@ -0,0 +1,3 @@ +??? tip "Option 2: Local (ARTEMiS)" + + Refer to the official guide for [ARTEMiS](https://gitea.tendokyu.moe/Hay1tsme/artemis/src/branch/develop/docs/INSTALL_WINDOWS.md) to set up a local server. \ No newline at end of file diff --git a/docs/snippets/sega/common/network_preamble.md b/docs/snippets/sega/common/network_preamble.md new file mode 100644 index 0000000..59bacbb --- /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/network_remote.md b/docs/snippets/sega/common/network_remote.md new file mode 100644 index 0000000..ecbc990 --- /dev/null +++ b/docs/snippets/sega/common/network_remote.md @@ -0,0 +1,27 @@ +??? tip "Option 1: Remote (Online Network)" + + - Head to the `[dns]` section inside `segatools.ini` + - Set `default` to the address provided by your network + **Do not add `http://` or `https://` to the address!** + + ```ini + [dns] + default=network.example + ``` + + - Then, head to the `[keychip]` section and add & set `id` to the keychip ID provided by your network + **Do not change the subnet from its default unless told to by your network!** + + ```ini + [keychip] + subnet=192.168.XXX.XXX + id=A69E-XXXXXXXXXXX + ``` + + - Create a file named `aime.txt` inside `App\bin\DEVICE` and type in a 20-digit access code + If you don't already have one, simply make one up, just know **it must not start with the number 3!** + + ``` + 📄aime.txt + 01234567890123456789 + ``` \ No newline at end of file diff --git a/docs/snippets/sega/common/patching.md b/docs/snippets/sega/common/patching.md new file mode 100644 index 0000000..8eee287 --- /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 0000000..6e6a9d5 --- /dev/null +++ b/docs/snippets/sega/common/segatools_install.md @@ -0,0 +1,7 @@ +!!! info "If you already have segatools installed, ensure you're using the latest version" + +!!! 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_bin.md b/docs/snippets/sega/common/segatools_preamble_bin.md new file mode 100644 index 0000000..013a211 --- /dev/null +++ b/docs/snippets/sega/common/segatools_preamble_bin.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] + dipsw1=1 + dipsw1=1 ; WRONG! + ``` \ No newline at end of file diff --git a/docs/snippets/sega/common/segatools_preamble_package.md b/docs/snippets/sega/common/segatools_preamble_package.md new file mode 100644 index 0000000..3290a66 --- /dev/null +++ b/docs/snippets/sega/common/segatools_preamble_package.md @@ -0,0 +1,15 @@ +!!! info "" + + You'll need to manually edit `App\package\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] + dipsw1=1 + dipsw1=1 ; WRONG! + ``` \ 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 0000000..b401975 --- /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_vfs.md b/docs/snippets/sega/common/segatools_vfs.md new file mode 100644 index 0000000..f02724c --- /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 0000000..21ddd46 --- /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/success.md b/docs/snippets/sega/common/success.md new file mode 100644 index 0000000..045fa47 --- /dev/null +++ b/docs/snippets/sega/common/success.md @@ -0,0 +1,3 @@ +!!! success "You're all done! The game should load up properly now" + +!!! tip "You can add coins using the `Coin` key (default `F3`) and card in by holding the `Enter` key" \ No newline at end of file diff --git a/docs/style.css b/docs/style.css new file mode 100644 index 0000000..5ae5786 --- /dev/null +++ b/docs/style.css @@ -0,0 +1,130 @@ +/* ========================================================================== + Global styles + ========================================================================== */ + +/* Headings + ========================================================================== */ + +h1 { + text-align: center; + margin-block-end: 1em; +} + +h1::after { + content: ''; + display: block; + inline-size: 60%; + block-size: 2px; + margin-block: 0.5em; + margin-inline: auto; + background: linear-gradient(90deg, + transparent, + var(--md-primary-fg-color), + transparent); +} + +h2 { + font-weight: bold; + margin-block-start: 2em; +} + +h2::after { + content: ''; + display: block; + inline-size: 100%; + block-size: 1px; + margin-block: 0.25em; + margin-inline: auto; + background: linear-gradient(90deg, + color-mix(in srgb, var(--md-typeset-color) 65%, white), + transparent); +} + +/* Horizontal rule + ========================================================================== */ + +hr { + inline-size: 60%; + block-size: 2px; + margin-block: 0.5em !important; + margin-inline: auto !important; + background: linear-gradient(90deg, + transparent, + var(--md-primary-fg-color), + transparent); + border: 0; +} + +/* Header logo + ========================================================================== */ + +.header-logo { + display: block; + max-height: 150px; + max-width: min(60%, 500px); + width: auto; + height: auto; + margin-inline: auto; + object-fit: contain; +} + +@media (max-width: 768px) { + .header-logo { + max-width: min(80%, 400px); + max-height: 120px; + } +} + +@media (max-width: 480px) { + .header-logo { + max-width: 90%; + max-height: 100px; + } +} + +/* Portrait image + ========================================================================== */ + +.portrait { + display: block; + max-height: 500px; +} + +/* ========================================================================== + MkDocs styles + ========================================================================== */ + +.md-typeset .tabbed-labels--linked>label>a { + padding: .78125em 0.5em .625em; +} + +/* ========================================================================== + Page specific styles + ========================================================================== */ + +/* Controllers page + ========================================================================== */ + +.controller-flex { + display: flex; + align-items: center; + gap: 1.5rem; + margin-block-end: 2em; +} + +.controller-preview { + block-size: 300px; +} + +@media (orientation: portrait) { + .controller-flex { + flex-direction: column; + align-items: flex-start; + } + + .controller-preview { + inline-size: 100%; + object-fit: contain; + margin-inline: auto; + } +} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..0dd365f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,403 @@ +site_name: two-torial.xyz +copyright: two-torial Team +site_description: Arcade Games Troubleshooting Guide +site_author: two-torial Team +repo_url: https://github.com/two-torial/two-torial/ +repo_name: GitHub + +nav: + - Home: index.md + - Games: + - KONAMI: + - "beatmania IIDX": + - "9th style": + - "Game Setup": "games/konami/iidx/9thstyle/setup.md" + - "Troubleshooting": "games/konami/iidx/9thstyle/troubleshooting.md" + - "10th style": + - "Game Setup": "games/konami/iidx/10thstyle/setup.md" + - "Troubleshooting": "games/konami/iidx/10thstyle/troubleshooting.md" + - "11 RED": + - "Game Setup": "games/konami/iidx/11_red/setup.md" + - "Troubleshooting": "games/konami/iidx/11_red/troubleshooting.md" + - "12 HAPPY SKY": + - "Game Setup": "games/konami/iidx/12_happysky/setup.md" + - "Troubleshooting": "games/konami/iidx/12_happysky/troubleshooting.md" + - "13 DistorteD": + - "Game Setup": "games/konami/iidx/13_distorted/setup.md" + - "Troubleshooting": "games/konami/iidx/13_distorted/troubleshooting.md" + - "14 GOLD": + - "Game Setup": "games/konami/iidx/14_gold/setup.md" + - "Troubleshooting": "games/konami/iidx/14_gold/troubleshooting.md" + - "16 EMPRESS": + - "Game Setup": "games/konami/iidx/16_empress/setup.md" + - "Extra Information": "games/konami/iidx/16_empress/extras.md" + - "Troubleshooting": "games/konami/iidx/16_empress/troubleshooting.md" + - "24 SINOBUZ": + - "Game Setup": "games/konami/iidx/24_sinobuz/setup.md" + - "Extra Information": "games/konami/iidx/24_sinobuz/extras.md" + - "Troubleshooting": "games/konami/iidx/24_sinobuz/troubleshooting.md" + - "25 CANNON BALLERS": + - "Game Setup": "games/konami/iidx/25_cannonballers/setup.md" + - "Troubleshooting": "games/konami/iidx/25_cannonballers/troubleshooting.md" + - "26 Rootage": + - "Game Setup": "games/konami/iidx/26_rootage/setup.md" + - "Troubleshooting": "games/konami/iidx/26_rootage/troubleshooting.md" + - "27 HEROIC VERSE": + - "Game Setup": "games/konami/iidx/27_heroicverse/setup.md" + - "Extra Information": "games/konami/iidx/27_heroicverse/extras.md" + - "Troubleshooting": "games/konami/iidx/27_heroicverse/troubleshooting.md" + - "30 RESIDENT": + - "Game Setup": "games/konami/iidx/30_resident/setup.md" + - "Extra Information": "games/konami/iidx/30_resident/extras.md" + - "Troubleshooting": "games/konami/iidx/30_resident/troubleshooting.md" + - "31 EPOLIS": + - "Game Setup": "games/konami/iidx/31_epolis/setup.md" + - "Extra Information": "games/konami/iidx/31_epolis/extras.md" + - "Troubleshooting": "games/konami/iidx/31_epolis/troubleshooting.md" + - "32 Pinky Crush": + - "Game Setup": "games/konami/iidx/32_pinkycrush/setup.md" + - "Extra Information": "games/konami/iidx/32_pinkycrush/extras.md" + - "Troubleshooting": "games/konami/iidx/32_pinkycrush/troubleshooting.md" + - "33 Sparkle Shower": + - "Game Setup": "games/konami/iidx/33_sparkleshower/setup.md" + - "Extra Information": "games/konami/iidx/33_sparkleshower/extras.md" + - "Troubleshooting": "games/konami/iidx/33_sparkleshower/troubleshooting.md" + - "Sound Voltex": + - "IV HEAVENLY HAVEN": + - "Game Setup": "games/konami/sdvx/4_heavenlyhaven/setup.md" + - "Troubleshooting": "games/konami/sdvx/4_heavenlyhaven/troubleshooting.md" + - "V VIVID WAVE": + - "Game Setup": "games/konami/sdvx/5_vividwave/setup.md" + - "Troubleshooting": "games/konami/sdvx/5_vividwave/troubleshooting.md" + - "VI EXCEED GEAR": + - "Game Setup": "games/konami/sdvx/6_exceedgear/setup.md" + - "Extra Information": "games/konami/sdvx/6_exceedgear/extras.md" + - "Troubleshooting": "games/konami/sdvx/6_exceedgear/troubleshooting.md" + - "VII NABLA": + - "Game Setup": "games/konami/sdvx/7_nabla/setup.md" + - "Extra Information": "games/konami/sdvx/7_nabla/extras.md" + - "Troubleshooting": "games/konami/sdvx/7_nabla/troubleshooting.md" + - "pop'n music": + - "Usaneko": + - "Game Setup": "games/konami/popn/usaneko/setup.md" + - "Troubleshooting": "games/konami/popn/usaneko/troubleshooting.md" + - "peace": + - "Game Setup": "games/konami/popn/peace/setup.md" + - "Troubleshooting": "games/konami/popn/peace/troubleshooting.md" + - "Kaimei Riddles": + - "Game Setup": "games/konami/popn/kaimei_riddles/setup.md" + - "Troubleshooting": "games/konami/popn/kaimei_riddles/troubleshooting.md" + - "UniLab": + - "Game Setup": "games/konami/popn/unilab/setup.md" + - "Troubleshooting": "games/konami/popn/unilab/troubleshooting.md" + - "Dance Dance Revolution": + - "A20": + - "Game Setup": "games/konami/ddr/a20/setup.md" + - "Troubleshooting": "games/konami/ddr/a20/troubleshooting.md" + - "A20 PLUS": + - "Game Setup": "games/konami/ddr/a20plus/setup.md" + - "Troubleshooting": "games/konami/ddr/a20plus/troubleshooting.md" + - "A3": + - "Game Setup": "games/konami/ddr/a3/setup.md" + - "Troubleshooting": "games/konami/ddr/a3/troubleshooting.md" + - "WORLD": + - "Game Setup": "games/konami/ddr/world/setup.md" + - "Troubleshooting": "games/konami/ddr/world/troubleshooting.md" + - "jubeat": + - "festo": + - "Game Setup": "games/konami/jubeat/festo/setup.md" + - "Ave.": + - "Game Setup": "games/konami/jubeat/avenue/setup.md" + - "beyond the Ave.": + - "Game Setup": "games/konami/jubeat/beyondtheavenue/setup.md" + - "GITADORA": + - "Matixx": + - "Game Setup": "games/konami/gitadora/matixx/setup.md" + - "Troubleshooting": "games/konami/gitadora/matixx/troubleshooting.md" + - "EXCHAIN": + - "Game Setup": "games/konami/gitadora/exchain/setup.md" + - "Troubleshooting": "games/konami/gitadora/exchain/troubleshooting.md" + - "Fuzz-Up": + - "Game Setup": "games/konami/gitadora/fuzzup/setup.md" + - "Troubleshooting": "games/konami/gitadora/fuzzup/troubleshooting.md" + - "Reflec Beat": + - "悠久のリフレシア (Reflesia)": + - "Game Setup": "games/konami/reflecbeat/reflesia/setup.md" + - "Troubleshooting": "games/konami/reflecbeat/reflesia/troubleshooting.md" + - "NOSTALGIA": + - "FORTE": + - "Game Setup": "games/konami/nostalgia/forte/setup.md" + - "Troubleshooting": "games/konami/nostalgia/forte/troubleshooting.md" + - "Op.2": + - "Game Setup": "games/konami/nostalgia/op2/setup.md" + - "Troubleshooting": "games/konami/nostalgia/op2/troubleshooting.md" + - "BeatStream": + - "アニムトライヴ (Animutribe)": + - "Game Setup": "games/konami/beatstream/animutribe/setup.md" + - "Troubleshooting": "games/konami/beatstream/animutribe/troubleshooting.md" + - "MÚSECA": + - "MÚSECA 1+1/2": + - "Game Setup": "games/konami/museca/1plushalf/setup.md" + - "Troubleshooting": "games/konami/museca/1plushalf/troubleshooting.md" + - "Mahjong Fight Girl": + - "Game Setup": "games/konami/mfg/setup.md" + - "Troubleshooting": "games/konami/mfg/troubleshooting.md" + - SEGA: + - "CHUNITHM": + - "CHUNITHM": + - "Game Setup": "games/sega/chunithm/chunithm/setup.md" + - "Controllers": "games/sega/chunithm/chunithm/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/chunithm/c2c.md" + - "Troubleshooting": "games/sega/chunithm/chunithm/troubleshooting.md" + - "PLUS": + - "Game Setup": "games/sega/chunithm/plus/setup.md" + - "Controllers": "games/sega/chunithm/plus/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/plus/c2c.md" + - "Troubleshooting": "games/sega/chunithm/plus/troubleshooting.md" + - "AIR": + - "Game Setup": "games/sega/chunithm/air/setup.md" + - "Controllers": "games/sega/chunithm/air/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/air/c2c.md" + - "Troubleshooting": "games/sega/chunithm/air/troubleshooting.md" + - "AIR PLUS": + - "Game Setup": "games/sega/chunithm/airplus/setup.md" + - "Controllers": "games/sega/chunithm/airplus/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/airplus/c2c.md" + - "Troubleshooting": "games/sega/chunithm/airplus/troubleshooting.md" + - "STAR": + - "Game Setup": "games/sega/chunithm/star/setup.md" + - "Controllers": "games/sega/chunithm/star/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/star/c2c.md" + - "Troubleshooting": "games/sega/chunithm/star/troubleshooting.md" + - "STAR PLUS": + - "Game Setup": "games/sega/chunithm/starplus/setup.md" + - "Controllers": "games/sega/chunithm/starplus/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/starplus/c2c.md" + - "Troubleshooting": "games/sega/chunithm/starplus/troubleshooting.md" + - "AMAZON": + - "Game Setup": "games/sega/chunithm/amazon/setup.md" + - "Controllers": "games/sega/chunithm/amazon/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/amazon/c2c.md" + - "Troubleshooting": "games/sega/chunithm/amazon/troubleshooting.md" + - "AMAZON PLUS": + - "Game Setup": "games/sega/chunithm/amazonplus/setup.md" + - "Controllers": "games/sega/chunithm/amazonplus/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/amazonplus/c2c.md" + - "Troubleshooting": "games/sega/chunithm/amazonplus/troubleshooting.md" + - "CRYSTAL": + - "Game Setup": "games/sega/chunithm/crystal/setup.md" + - "Controllers": "games/sega/chunithm/crystal/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/crystal/c2c.md" + - "Troubleshooting": "games/sega/chunithm/crystal/troubleshooting.md" + - "CRYSTAL PLUS": + - "Game Setup": "games/sega/chunithm/crystalplus/setup.md" + - "Controllers": "games/sega/chunithm/crystalplus/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/crystalplus/c2c.md" + - "Troubleshooting": "games/sega/chunithm/crystalplus/troubleshooting.md" + - "PARADISE": + - "Game Setup": "games/sega/chunithm/paradise/setup.md" + - "Controllers": "games/sega/chunithm/paradise/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/paradise/c2c.md" + - "Troubleshooting": "games/sega/chunithm/paradise/troubleshooting.md" + - "PARADISE LOST": + - "Game Setup": "games/sega/chunithm/paradiselost/setup.md" + - "Controllers": "games/sega/chunithm/paradiselost/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/paradiselost/c2c.md" + - "Troubleshooting": "games/sega/chunithm/paradiselost/troubleshooting.md" + - "NEW": + - "Game Setup": "games/sega/chunithm/new/setup.md" + - "Controllers": "games/sega/chunithm/new/controllers.md" + - "Cab-to-Cab": "games/sega/chunithm/new/c2c.md" + - "Troubleshooting": "games/sega/chunithm/new/troubleshooting.md" + - "NEW PLUS": + - "Game Setup": "games/sega/chunithm/newplus/setup.md" + - "Controllers": "games/sega/chunithm/newplus/controllers.md" + - "Troubleshooting": "games/sega/chunithm/newplus/troubleshooting.md" + - "Cab-to-Cab": "games/sega/chunithm/newplus/c2c.md" + - "SUN": + - "Game Setup": "games/sega/chunithm/sun/setup.md" + - "Controllers": "games/sega/chunithm/sun/controllers.md" + - "Troubleshooting": "games/sega/chunithm/sun/troubleshooting.md" + - "Cab-to-Cab": "games/sega/chunithm/sun/c2c.md" + - "SUN PLUS": + - "Game Setup": "games/sega/chunithm/sunplus/setup.md" + - "Controllers": "games/sega/chunithm/sunplus/controllers.md" + - "Troubleshooting": "games/sega/chunithm/sunplus/troubleshooting.md" + - "Cab-to-Cab": "games/sega/chunithm/sunplus/c2c.md" + - "LUMINOUS": + - "Game Setup": "games/sega/chunithm/luminous/setup.md" + - "Controllers": "games/sega/chunithm/luminous/controllers.md" + - "Troubleshooting": "games/sega/chunithm/luminous/troubleshooting.md" + - "Cab-to-Cab": "games/sega/chunithm/luminous/c2c.md" + - "LUMINOUS PLUS": + - "Game Setup": "games/sega/chunithm/luminousplus/setup.md" + - "Controllers": "games/sega/chunithm/luminousplus/controllers.md" + - "Troubleshooting": "games/sega/chunithm/luminousplus/troubleshooting.md" + - "Cab-to-Cab": "games/sega/chunithm/luminousplus/c2c.md" + - "VERSE": + - "Game Setup": "games/sega/chunithm/verse/setup.md" + - "Controllers": "games/sega/chunithm/verse/controllers.md" + - "Troubleshooting": "games/sega/chunithm/verse/troubleshooting.md" + - "Cab-to-Cab": "games/sega/chunithm/verse/c2c.md" + - "X-VERSE": + - "Game Setup": "games/sega/chunithm/x-verse/setup.md" + - "Controllers": "games/sega/chunithm/x-verse/controllers.md" + - "Troubleshooting": "games/sega/chunithm/x-verse/troubleshooting.md" + - "Cab-to-Cab": "games/sega/chunithm/x-verse/c2c.md" + - "X-VERSE-X": + - "Game Setup": "games/sega/chunithm/x-verse-x/setup.md" + - "Controllers": "games/sega/chunithm/x-verse-x/controllers.md" + - "Troubleshooting": "games/sega/chunithm/x-verse-x/troubleshooting.md" + - "Cab-to-Cab": "games/sega/chunithm/x-verse-x/c2c.md" + - "maimai DX": + - "BUDDiES": + - "Game Setup": "games/sega/maimaidx/buddies/setup.md" + - "Controllers": "games/sega/maimaidx/buddies/controllers.md" + - "Troubleshooting": "games/sega/maimaidx/buddies/troubleshooting.md" + - "BUDDiES PLUS": + - "Game Setup": "games/sega/maimaidx/buddiesplus/setup.md" + - "Controllers": "games/sega/maimaidx/buddiesplus/controllers.md" + - "Troubleshooting": "games/sega/maimaidx/buddiesplus/troubleshooting.md" + - "PRiSM": + - "Game Setup": "games/sega/maimaidx/prism/setup.md" + - "Controllers": "games/sega/maimaidx/prism/controllers.md" + - "Troubleshooting": "games/sega/maimaidx/prism/troubleshooting.md" + - "PRiSM PLUS": + - "Game Setup": "games/sega/maimaidx/prismplus/setup.md" + - "Controllers": "games/sega/maimaidx/prismplus/controllers.md" + - "Troubleshooting": "games/sega/maimaidx/prismplus/troubleshooting.md" + - "CiRCLE": + - "Game Setup": "games/sega/maimaidx/circle/setup.md" + - "Controllers": "games/sega/maimaidx/circle/controllers.md" + - "Troubleshooting": "games/sega/maimaidx/circle/troubleshooting.md" + - "O.N.G.E.K.I.": + - "bright MEMORY": + - "Game Setup": "games/sega/ongeki/brightmemory/setup.md" + - "Controllers": "games/sega/ongeki/brightmemory/controllers.md" + - "Troubleshooting": "games/sega/ongeki/brightmemory/troubleshooting.md" + - "Cab-to-Cab": "games/sega/ongeki/brightmemory/c2c.md" + - "Re:Fresh": + - "Game Setup": "games/sega/ongeki/refresh/setup.md" + - "Controllers": "games/sega/ongeki/refresh/controllers.md" + - "Troubleshooting": "games/sega/ongeki/refresh/troubleshooting.md" + - "Cab-to-Cab": "games/sega/ongeki/refresh/c2c.md" + - "WACCA": + - "Reverse": + - "Game Setup": "games/sega/wacca/reverse/setup.md" + - "Controllers": "games/sega/wacca/reverse/controllers.md" + - NAMCO: + - "Taiko no Tatsujin: Nijiiro": + - "Game Setup": "games/namco/taikonijiiro/setup.md" + - "Troubleshooting": "games/namco/taikonijiiro/troubleshooting.md" + - TAITO: + - "Tetote X Connect": + - "Game Setup": "games/taito/tetoteconnect/setup.md" + - Error Codes: + - KONAMI: "errorcodes/konami.md" + - SEGA: "errorcodes/sega.md" + - Game Patching: + - "Using spice2x": "extras/patchsp2x.md" + - "Using Web": "extras/patchweb.md" + - "Manually": "extras/hexguide.md" + - Extras: + - "Asphyxia": "extras/asphyxia.md" + - "Audio": "extras/audio.md" + - "Cab-to-Cab (ZeroTier)": "extras/zerotier.md" + - "Controllers": "extras/controllers.md" + - "Modding (Konami)": "extras/datamods.md" + - "Modding (Unity)": "extras/unity.md" + - "Linux (Konami)": "extras/linux_konami.md" + - Other Resources: resources.md + +not_in_nav: | + snippets + games/konami/iidx/common + games/konami/sdvx/common + games/konami/ddr/common + games/konami/popn/common + games/konami/jubeat/common + games/sega/chunithm/common + games/sega/maimaidx/common + games/sega/ongeki/common + +validation: + links: + absolute_links: relative_to_docs + +theme: + name: material + custom_dir: overrides + logo: img/two-torial/website-logo.svg + favicon: img/favicon.ico + icon: + repo: fontawesome/brands/github + navigation_depth: 3 + palette: + # Toggle for auto mode + - media: "(prefers-color-scheme)" + primary: deep purple + accent: deep purple + toggle: + icon: material/brightness-auto + name: Switch to light mode + # Toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: deep purple + accent: deep purple + toggle: + icon: material/brightness-7 + name: Switch to dark mode + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: deep purple + accent: deep purple + toggle: + icon: material/brightness-4 + name: Switch to system preference + features: + - content.code.annotate + - content.code.copy + +markdown_extensions: + - admonition + - attr_list + - md_in_html + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - pymdownx.details + - pymdownx.tabbed: + alternate_style: true + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.caret + - pymdownx.critic + - pymdownx.keys + - pymdownx.mark + - pymdownx.tilde + +plugins: + - search + - git-revision-date-localized + +extra_css: + - style.css + +extra: + analytics: + provider: custom + property: https://tuah-torial.goatcounter.com/count + social: + - icon: fontawesome/brands/discord + link: https://discord.gg/cZRUmEPK78 + name: Discord + - icon: fontawesome/brands/github + link: https://github.com/two-torial + name: GitHub \ No newline at end of file diff --git a/overrides/partials/integrations/analytics/custom.html b/overrides/partials/integrations/analytics/custom.html new file mode 100644 index 0000000..e5cfc05 --- /dev/null +++ b/overrides/partials/integrations/analytics/custom.html @@ -0,0 +1,37 @@ + +{# + The below code block is for handling "instant navigation" in Material MkDocs. + It is currently not applicable to us, but if we wish to switch to it in the future, + this will properly handle URL changes for analytics. +#} +{% if "navigation.instant" in config.theme.features %} + +{% endif %} + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..1442a3a --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,11 @@ +[project] +name = "two-torial" +version = "0.1.0" +requires-python = ">=3.13" +dependencies = [ + "click==8.2.1", # Pinned due to recent versions breaking hot reload during development + "fontawesome-markdown>=0.2.6", + "mkdocs>=1.6.1", + "mkdocs-git-revision-date-localized-plugin>=1.4.7", + "mkdocs-material>=9.6.21", +] diff --git a/uv.lock b/uv.lock new file mode 100644 index 0000000..0678224 --- /dev/null +++ b/uv.lock @@ -0,0 +1,518 @@ +version = 1 +revision = 3 +requires-python = ">=3.13" + +[[package]] +name = "babel" +version = "2.17.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/7d/6b/d52e42361e1aa00709585ecc30b3f9684b3ab62530771402248b1b1d6240/babel-2.17.0.tar.gz", hash = "sha256:0c54cffb19f690cdcc52a3b50bcbf71e07a808d1c80d549f2459b9d2cf0afb9d", size = 9951852, upload-time = "2025-02-01T15:17:41.026Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b7/b8/3fe70c75fe32afc4bb507f75563d39bc5642255d1d94f1f23604725780bf/babel-2.17.0-py3-none-any.whl", hash = "sha256:4d0b53093fdfb4b21c92b5213dba5a1b23885afa8383709427046b21c366e5f2", size = 10182537, upload-time = "2025-02-01T15:17:37.39Z" }, +] + +[[package]] +name = "backrefs" +version = "5.9" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/eb/a7/312f673df6a79003279e1f55619abbe7daebbb87c17c976ddc0345c04c7b/backrefs-5.9.tar.gz", hash = "sha256:808548cb708d66b82ee231f962cb36faaf4f2baab032f2fbb783e9c2fdddaa59", size = 5765857, upload-time = "2025-06-22T19:34:13.97Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/19/4d/798dc1f30468134906575156c089c492cf79b5a5fd373f07fe26c4d046bf/backrefs-5.9-py310-none-any.whl", hash = "sha256:db8e8ba0e9de81fcd635f440deab5ae5f2591b54ac1ebe0550a2ca063488cd9f", size = 380267, upload-time = "2025-06-22T19:34:05.252Z" }, + { url = "https://files.pythonhosted.org/packages/55/07/f0b3375bf0d06014e9787797e6b7cc02b38ac9ff9726ccfe834d94e9991e/backrefs-5.9-py311-none-any.whl", hash = "sha256:6907635edebbe9b2dc3de3a2befff44d74f30a4562adbb8b36f21252ea19c5cf", size = 392072, upload-time = "2025-06-22T19:34:06.743Z" }, + { url = "https://files.pythonhosted.org/packages/9d/12/4f345407259dd60a0997107758ba3f221cf89a9b5a0f8ed5b961aef97253/backrefs-5.9-py312-none-any.whl", hash = "sha256:7fdf9771f63e6028d7fee7e0c497c81abda597ea45d6b8f89e8ad76994f5befa", size = 397947, upload-time = "2025-06-22T19:34:08.172Z" }, + { url = "https://files.pythonhosted.org/packages/10/bf/fa31834dc27a7f05e5290eae47c82690edc3a7b37d58f7fb35a1bdbf355b/backrefs-5.9-py313-none-any.whl", hash = "sha256:cc37b19fa219e93ff825ed1fed8879e47b4d89aa7a1884860e2db64ccd7c676b", size = 399843, upload-time = "2025-06-22T19:34:09.68Z" }, + { url = "https://files.pythonhosted.org/packages/fc/24/b29af34b2c9c41645a9f4ff117bae860291780d73880f449e0b5d948c070/backrefs-5.9-py314-none-any.whl", hash = "sha256:df5e169836cc8acb5e440ebae9aad4bf9d15e226d3bad049cf3f6a5c20cc8dc9", size = 411762, upload-time = "2025-06-22T19:34:11.037Z" }, + { url = "https://files.pythonhosted.org/packages/41/ff/392bff89415399a979be4a65357a41d92729ae8580a66073d8ec8d810f98/backrefs-5.9-py39-none-any.whl", hash = "sha256:f48ee18f6252b8f5777a22a00a09a85de0ca931658f1dd96d4406a34f3748c60", size = 380265, upload-time = "2025-06-22T19:34:12.405Z" }, +] + +[[package]] +name = "certifi" +version = "2025.10.5" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/4c/5b/b6ce21586237c77ce67d01dc5507039d444b630dd76611bbca2d8e5dcd91/certifi-2025.10.5.tar.gz", hash = "sha256:47c09d31ccf2acf0be3f701ea53595ee7e0b8fa08801c6624be771df09ae7b43", size = 164519, upload-time = "2025-10-05T04:12:15.808Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e4/37/af0d2ef3967ac0d6113837b44a4f0bfe1328c2b9763bd5b1744520e5cfed/certifi-2025.10.5-py3-none-any.whl", hash = "sha256:0f212c2744a9bb6de0c56639a6f68afe01ecd92d91f14ae897c4fe7bbeeef0de", size = 163286, upload-time = "2025-10-05T04:12:14.03Z" }, +] + +[[package]] +name = "charset-normalizer" +version = "3.4.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/83/2d/5fd176ceb9b2fc619e63405525573493ca23441330fcdaee6bef9460e924/charset_normalizer-3.4.3.tar.gz", hash = "sha256:6fce4b8500244f6fcb71465d4a4930d132ba9ab8e71a7859e6a5d59851068d14", size = 122371, upload-time = "2025-08-09T07:57:28.46Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/65/ca/2135ac97709b400c7654b4b764daf5c5567c2da45a30cdd20f9eefe2d658/charset_normalizer-3.4.3-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:14c2a87c65b351109f6abfc424cab3927b3bdece6f706e4d12faaf3d52ee5efe", size = 205326, upload-time = "2025-08-09T07:56:24.721Z" }, + { url = "https://files.pythonhosted.org/packages/71/11/98a04c3c97dd34e49c7d247083af03645ca3730809a5509443f3c37f7c99/charset_normalizer-3.4.3-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:41d1fc408ff5fdfb910200ec0e74abc40387bccb3252f3f27c0676731df2b2c8", size = 146008, upload-time = "2025-08-09T07:56:26.004Z" }, + { url = "https://files.pythonhosted.org/packages/60/f5/4659a4cb3c4ec146bec80c32d8bb16033752574c20b1252ee842a95d1a1e/charset_normalizer-3.4.3-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:1bb60174149316da1c35fa5233681f7c0f9f514509b8e399ab70fea5f17e45c9", size = 159196, upload-time = "2025-08-09T07:56:27.25Z" }, + { url = "https://files.pythonhosted.org/packages/86/9e/f552f7a00611f168b9a5865a1414179b2c6de8235a4fa40189f6f79a1753/charset_normalizer-3.4.3-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:30d006f98569de3459c2fc1f2acde170b7b2bd265dc1943e87e1a4efe1b67c31", size = 156819, upload-time = "2025-08-09T07:56:28.515Z" }, + { url = "https://files.pythonhosted.org/packages/7e/95/42aa2156235cbc8fa61208aded06ef46111c4d3f0de233107b3f38631803/charset_normalizer-3.4.3-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:416175faf02e4b0810f1f38bcb54682878a4af94059a1cd63b8747244420801f", size = 151350, upload-time = "2025-08-09T07:56:29.716Z" }, + { url = "https://files.pythonhosted.org/packages/c2/a9/3865b02c56f300a6f94fc631ef54f0a8a29da74fb45a773dfd3dcd380af7/charset_normalizer-3.4.3-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:6aab0f181c486f973bc7262a97f5aca3ee7e1437011ef0c2ec04b5a11d16c927", size = 148644, upload-time = "2025-08-09T07:56:30.984Z" }, + { url = "https://files.pythonhosted.org/packages/77/d9/cbcf1a2a5c7d7856f11e7ac2d782aec12bdfea60d104e60e0aa1c97849dc/charset_normalizer-3.4.3-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:fdabf8315679312cfa71302f9bd509ded4f2f263fb5b765cf1433b39106c3cc9", size = 160468, upload-time = "2025-08-09T07:56:32.252Z" }, + { url = "https://files.pythonhosted.org/packages/f6/42/6f45efee8697b89fda4d50580f292b8f7f9306cb2971d4b53f8914e4d890/charset_normalizer-3.4.3-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:bd28b817ea8c70215401f657edef3a8aa83c29d447fb0b622c35403780ba11d5", size = 158187, upload-time = "2025-08-09T07:56:33.481Z" }, + { url = "https://files.pythonhosted.org/packages/70/99/f1c3bdcfaa9c45b3ce96f70b14f070411366fa19549c1d4832c935d8e2c3/charset_normalizer-3.4.3-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:18343b2d246dc6761a249ba1fb13f9ee9a2bcd95decc767319506056ea4ad4dc", size = 152699, upload-time = "2025-08-09T07:56:34.739Z" }, + { url = "https://files.pythonhosted.org/packages/a3/ad/b0081f2f99a4b194bcbb1934ef3b12aa4d9702ced80a37026b7607c72e58/charset_normalizer-3.4.3-cp313-cp313-win32.whl", hash = "sha256:6fb70de56f1859a3f71261cbe41005f56a7842cc348d3aeb26237560bfa5e0ce", size = 99580, upload-time = "2025-08-09T07:56:35.981Z" }, + { url = "https://files.pythonhosted.org/packages/9a/8f/ae790790c7b64f925e5c953b924aaa42a243fb778fed9e41f147b2a5715a/charset_normalizer-3.4.3-cp313-cp313-win_amd64.whl", hash = "sha256:cf1ebb7d78e1ad8ec2a8c4732c7be2e736f6e5123a4146c5b89c9d1f585f8cef", size = 107366, upload-time = "2025-08-09T07:56:37.339Z" }, + { url = "https://files.pythonhosted.org/packages/8e/91/b5a06ad970ddc7a0e513112d40113e834638f4ca1120eb727a249fb2715e/charset_normalizer-3.4.3-cp314-cp314-macosx_10_13_universal2.whl", hash = "sha256:3cd35b7e8aedeb9e34c41385fda4f73ba609e561faedfae0a9e75e44ac558a15", size = 204342, upload-time = "2025-08-09T07:56:38.687Z" }, + { url = "https://files.pythonhosted.org/packages/ce/ec/1edc30a377f0a02689342f214455c3f6c2fbedd896a1d2f856c002fc3062/charset_normalizer-3.4.3-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:b89bc04de1d83006373429975f8ef9e7932534b8cc9ca582e4db7d20d91816db", size = 145995, upload-time = "2025-08-09T07:56:40.048Z" }, + { url = "https://files.pythonhosted.org/packages/17/e5/5e67ab85e6d22b04641acb5399c8684f4d37caf7558a53859f0283a650e9/charset_normalizer-3.4.3-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:2001a39612b241dae17b4687898843f254f8748b796a2e16f1051a17078d991d", size = 158640, upload-time = "2025-08-09T07:56:41.311Z" }, + { url = "https://files.pythonhosted.org/packages/f1/e5/38421987f6c697ee3722981289d554957c4be652f963d71c5e46a262e135/charset_normalizer-3.4.3-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:8dcfc373f888e4fb39a7bc57e93e3b845e7f462dacc008d9749568b1c4ece096", size = 156636, upload-time = "2025-08-09T07:56:43.195Z" }, + { url = "https://files.pythonhosted.org/packages/a0/e4/5a075de8daa3ec0745a9a3b54467e0c2967daaaf2cec04c845f73493e9a1/charset_normalizer-3.4.3-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:18b97b8404387b96cdbd30ad660f6407799126d26a39ca65729162fd810a99aa", size = 150939, upload-time = "2025-08-09T07:56:44.819Z" }, + { url = "https://files.pythonhosted.org/packages/02/f7/3611b32318b30974131db62b4043f335861d4d9b49adc6d57c1149cc49d4/charset_normalizer-3.4.3-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:ccf600859c183d70eb47e05a44cd80a4ce77394d1ac0f79dbd2dd90a69a3a049", size = 148580, upload-time = "2025-08-09T07:56:46.684Z" }, + { url = "https://files.pythonhosted.org/packages/7e/61/19b36f4bd67f2793ab6a99b979b4e4f3d8fc754cbdffb805335df4337126/charset_normalizer-3.4.3-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:53cd68b185d98dde4ad8990e56a58dea83a4162161b1ea9272e5c9182ce415e0", size = 159870, upload-time = "2025-08-09T07:56:47.941Z" }, + { url = "https://files.pythonhosted.org/packages/06/57/84722eefdd338c04cf3030ada66889298eaedf3e7a30a624201e0cbe424a/charset_normalizer-3.4.3-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:30a96e1e1f865f78b030d65241c1ee850cdf422d869e9028e2fc1d5e4db73b92", size = 157797, upload-time = "2025-08-09T07:56:49.756Z" }, + { url = "https://files.pythonhosted.org/packages/72/2a/aff5dd112b2f14bcc3462c312dce5445806bfc8ab3a7328555da95330e4b/charset_normalizer-3.4.3-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:d716a916938e03231e86e43782ca7878fb602a125a91e7acb8b5112e2e96ac16", size = 152224, upload-time = "2025-08-09T07:56:51.369Z" }, + { url = "https://files.pythonhosted.org/packages/b7/8c/9839225320046ed279c6e839d51f028342eb77c91c89b8ef2549f951f3ec/charset_normalizer-3.4.3-cp314-cp314-win32.whl", hash = "sha256:c6dbd0ccdda3a2ba7c2ecd9d77b37f3b5831687d8dc1b6ca5f56a4880cc7b7ce", size = 100086, upload-time = "2025-08-09T07:56:52.722Z" }, + { url = "https://files.pythonhosted.org/packages/ee/7a/36fbcf646e41f710ce0a563c1c9a343c6edf9be80786edeb15b6f62e17db/charset_normalizer-3.4.3-cp314-cp314-win_amd64.whl", hash = "sha256:73dc19b562516fc9bcf6e5d6e596df0b4eb98d87e4f79f3ae71840e6ed21361c", size = 107400, upload-time = "2025-08-09T07:56:55.172Z" }, + { url = "https://files.pythonhosted.org/packages/8a/1f/f041989e93b001bc4e44bb1669ccdcf54d3f00e628229a85b08d330615c5/charset_normalizer-3.4.3-py3-none-any.whl", hash = "sha256:ce571ab16d890d23b5c278547ba694193a45011ff86a9162a71307ed9f86759a", size = 53175, upload-time = "2025-08-09T07:57:26.864Z" }, +] + +[[package]] +name = "click" +version = "8.2.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "colorama", marker = "sys_platform == 'win32'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/60/6c/8ca2efa64cf75a977a0d7fac081354553ebe483345c734fb6b6515d96bbc/click-8.2.1.tar.gz", hash = "sha256:27c491cc05d968d271d5a1db13e3b5a184636d9d930f148c50b038f0d0646202", size = 286342, upload-time = "2025-05-20T23:19:49.832Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/85/32/10bb5764d90a8eee674e9dc6f4db6a0ab47c8c4d0d83c27f7c39ac415a4d/click-8.2.1-py3-none-any.whl", hash = "sha256:61a3265b914e850b85317d0b3109c7f8cd35a670f963866005d6ef1d5175a12b", size = 102215, upload-time = "2025-05-20T23:19:47.796Z" }, +] + +[[package]] +name = "colorama" +version = "0.4.6" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d8/53/6f443c9a4a8358a93a6792e2acffb9d9d5cb0a5cfd8802644b7b1c9a02e4/colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44", size = 27697, upload-time = "2022-10-25T02:36:22.414Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d1/d6/3965ed04c63042e047cb6a3e6ed1a63a35087b6a609aa3a15ed8ac56c221/colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6", size = 25335, upload-time = "2022-10-25T02:36:20.889Z" }, +] + +[[package]] +name = "fontawesome-markdown" +version = "0.2.6" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markdown" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/c7/29/cbd664c42a119ee14d73a6991e4689beec529313ada5c4586c9c33f72e2b/fontawesome-markdown-0.2.6.tar.gz", hash = "sha256:95a12f1629a595afc4aabc886ffdb8b5fa0ae8f77e8f3437b7b1942d91f91f4b", size = 5762, upload-time = "2016-12-05T14:27:19.682Z" } + +[[package]] +name = "ghp-import" +version = "2.1.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "python-dateutil" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/d9/29/d40217cbe2f6b1359e00c6c307bb3fc876ba74068cbab3dde77f03ca0dc4/ghp-import-2.1.0.tar.gz", hash = "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343", size = 10943, upload-time = "2022-05-02T15:47:16.11Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f7/ec/67fbef5d497f86283db54c22eec6f6140243aae73265799baaaa19cd17fb/ghp_import-2.1.0-py3-none-any.whl", hash = "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619", size = 11034, upload-time = "2022-05-02T15:47:14.552Z" }, +] + +[[package]] +name = "gitdb" +version = "4.0.12" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "smmap" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/72/94/63b0fc47eb32792c7ba1fe1b694daec9a63620db1e313033d18140c2320a/gitdb-4.0.12.tar.gz", hash = "sha256:5ef71f855d191a3326fcfbc0d5da835f26b13fbcba60c32c21091c349ffdb571", size = 394684, upload-time = "2025-01-02T07:20:46.413Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a0/61/5c78b91c3143ed5c14207f463aecfc8f9dbb5092fb2869baf37c273b2705/gitdb-4.0.12-py3-none-any.whl", hash = "sha256:67073e15955400952c6565cc3e707c554a4eea2e428946f7a4c162fab9bd9bcf", size = 62794, upload-time = "2025-01-02T07:20:43.624Z" }, +] + +[[package]] +name = "gitpython" +version = "3.1.45" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "gitdb" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/9a/c8/dd58967d119baab745caec2f9d853297cec1989ec1d63f677d3880632b88/gitpython-3.1.45.tar.gz", hash = "sha256:85b0ee964ceddf211c41b9f27a49086010a190fd8132a24e21f362a4b36a791c", size = 215076, upload-time = "2025-07-24T03:45:54.871Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/01/61/d4b89fec821f72385526e1b9d9a3a0385dda4a72b206d28049e2c7cd39b8/gitpython-3.1.45-py3-none-any.whl", hash = "sha256:8908cb2e02fb3b93b7eb0f2827125cb699869470432cc885f019b8fd0fccff77", size = 208168, upload-time = "2025-07-24T03:45:52.517Z" }, +] + +[[package]] +name = "idna" +version = "3.10" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/f1/70/7703c29685631f5a7590aa73f1f1d3fa9a380e654b86af429e0934a32f7d/idna-3.10.tar.gz", hash = "sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9", size = 190490, upload-time = "2024-09-15T18:07:39.745Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/76/c6/c88e154df9c4e1a2a66ccf0005a88dfb2650c1dffb6f5ce603dfbd452ce3/idna-3.10-py3-none-any.whl", hash = "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3", size = 70442, upload-time = "2024-09-15T18:07:37.964Z" }, +] + +[[package]] +name = "jinja2" +version = "3.1.6" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markupsafe" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/df/bf/f7da0350254c0ed7c72f3e33cef02e048281fec7ecec5f032d4aac52226b/jinja2-3.1.6.tar.gz", hash = "sha256:0137fb05990d35f1275a587e9aee6d56da821fc83491a0fb838183be43f66d6d", size = 245115, upload-time = "2025-03-05T20:05:02.478Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/62/a1/3d680cbfd5f4b8f15abc1d571870c5fc3e594bb582bc3b64ea099db13e56/jinja2-3.1.6-py3-none-any.whl", hash = "sha256:85ece4451f492d0c13c5dd7c13a64681a86afae63a5f347908daf103ce6d2f67", size = 134899, upload-time = "2025-03-05T20:05:00.369Z" }, +] + +[[package]] +name = "markdown" +version = "3.9" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/8d/37/02347f6d6d8279247a5837082ebc26fc0d5aaeaf75aa013fcbb433c777ab/markdown-3.9.tar.gz", hash = "sha256:d2900fe1782bd33bdbbd56859defef70c2e78fc46668f8eb9df3128138f2cb6a", size = 364585, upload-time = "2025-09-04T20:25:22.885Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/70/ae/44c4a6a4cbb496d93c6257954260fe3a6e91b7bed2240e5dad2a717f5111/markdown-3.9-py3-none-any.whl", hash = "sha256:9f4d91ed810864ea88a6f32c07ba8bee1346c0cc1f6b1f9f6c822f2a9667d280", size = 107441, upload-time = "2025-09-04T20:25:21.784Z" }, +] + +[[package]] +name = "markupsafe" +version = "3.0.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/7e/99/7690b6d4034fffd95959cbe0c02de8deb3098cc577c67bb6a24fe5d7caa7/markupsafe-3.0.3.tar.gz", hash = "sha256:722695808f4b6457b320fdc131280796bdceb04ab50fe1795cd540799ebe1698", size = 80313, upload-time = "2025-09-27T18:37:40.426Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/38/2f/907b9c7bbba283e68f20259574b13d005c121a0fa4c175f9bed27c4597ff/markupsafe-3.0.3-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:e1cf1972137e83c5d4c136c43ced9ac51d0e124706ee1c8aa8532c1287fa8795", size = 11622, upload-time = "2025-09-27T18:36:41.777Z" }, + { url = "https://files.pythonhosted.org/packages/9c/d9/5f7756922cdd676869eca1c4e3c0cd0df60ed30199ffd775e319089cb3ed/markupsafe-3.0.3-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:116bb52f642a37c115f517494ea5feb03889e04df47eeff5b130b1808ce7c219", size = 12029, upload-time = "2025-09-27T18:36:43.257Z" }, + { url = "https://files.pythonhosted.org/packages/00/07/575a68c754943058c78f30db02ee03a64b3c638586fba6a6dd56830b30a3/markupsafe-3.0.3-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:133a43e73a802c5562be9bbcd03d090aa5a1fe899db609c29e8c8d815c5f6de6", size = 24374, upload-time = "2025-09-27T18:36:44.508Z" }, + { url = "https://files.pythonhosted.org/packages/a9/21/9b05698b46f218fc0e118e1f8168395c65c8a2c750ae2bab54fc4bd4e0e8/markupsafe-3.0.3-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ccfcd093f13f0f0b7fdd0f198b90053bf7b2f02a3927a30e63f3ccc9df56b676", size = 22980, upload-time = "2025-09-27T18:36:45.385Z" }, + { url = "https://files.pythonhosted.org/packages/7f/71/544260864f893f18b6827315b988c146b559391e6e7e8f7252839b1b846a/markupsafe-3.0.3-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:509fa21c6deb7a7a273d629cf5ec029bc209d1a51178615ddf718f5918992ab9", size = 21990, upload-time = "2025-09-27T18:36:46.916Z" }, + { url = "https://files.pythonhosted.org/packages/c2/28/b50fc2f74d1ad761af2f5dcce7492648b983d00a65b8c0e0cb457c82ebbe/markupsafe-3.0.3-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:a4afe79fb3de0b7097d81da19090f4df4f8d3a2b3adaa8764138aac2e44f3af1", size = 23784, upload-time = "2025-09-27T18:36:47.884Z" }, + { url = "https://files.pythonhosted.org/packages/ed/76/104b2aa106a208da8b17a2fb72e033a5a9d7073c68f7e508b94916ed47a9/markupsafe-3.0.3-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:795e7751525cae078558e679d646ae45574b47ed6e7771863fcc079a6171a0fc", size = 21588, upload-time = "2025-09-27T18:36:48.82Z" }, + { url = "https://files.pythonhosted.org/packages/b5/99/16a5eb2d140087ebd97180d95249b00a03aa87e29cc224056274f2e45fd6/markupsafe-3.0.3-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:8485f406a96febb5140bfeca44a73e3ce5116b2501ac54fe953e488fb1d03b12", size = 23041, upload-time = "2025-09-27T18:36:49.797Z" }, + { url = "https://files.pythonhosted.org/packages/19/bc/e7140ed90c5d61d77cea142eed9f9c303f4c4806f60a1044c13e3f1471d0/markupsafe-3.0.3-cp313-cp313-win32.whl", hash = "sha256:bdd37121970bfd8be76c5fb069c7751683bdf373db1ed6c010162b2a130248ed", size = 14543, upload-time = "2025-09-27T18:36:51.584Z" }, + { url = "https://files.pythonhosted.org/packages/05/73/c4abe620b841b6b791f2edc248f556900667a5a1cf023a6646967ae98335/markupsafe-3.0.3-cp313-cp313-win_amd64.whl", hash = "sha256:9a1abfdc021a164803f4d485104931fb8f8c1efd55bc6b748d2f5774e78b62c5", size = 15113, upload-time = "2025-09-27T18:36:52.537Z" }, + { url = "https://files.pythonhosted.org/packages/f0/3a/fa34a0f7cfef23cf9500d68cb7c32dd64ffd58a12b09225fb03dd37d5b80/markupsafe-3.0.3-cp313-cp313-win_arm64.whl", hash = "sha256:7e68f88e5b8799aa49c85cd116c932a1ac15caaa3f5db09087854d218359e485", size = 13911, upload-time = "2025-09-27T18:36:53.513Z" }, + { url = "https://files.pythonhosted.org/packages/e4/d7/e05cd7efe43a88a17a37b3ae96e79a19e846f3f456fe79c57ca61356ef01/markupsafe-3.0.3-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:218551f6df4868a8d527e3062d0fb968682fe92054e89978594c28e642c43a73", size = 11658, upload-time = "2025-09-27T18:36:54.819Z" }, + { url = "https://files.pythonhosted.org/packages/99/9e/e412117548182ce2148bdeacdda3bb494260c0b0184360fe0d56389b523b/markupsafe-3.0.3-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:3524b778fe5cfb3452a09d31e7b5adefeea8c5be1d43c4f810ba09f2ceb29d37", size = 12066, upload-time = "2025-09-27T18:36:55.714Z" }, + { url = "https://files.pythonhosted.org/packages/bc/e6/fa0ffcda717ef64a5108eaa7b4f5ed28d56122c9a6d70ab8b72f9f715c80/markupsafe-3.0.3-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:4e885a3d1efa2eadc93c894a21770e4bc67899e3543680313b09f139e149ab19", size = 25639, upload-time = "2025-09-27T18:36:56.908Z" }, + { url = "https://files.pythonhosted.org/packages/96/ec/2102e881fe9d25fc16cb4b25d5f5cde50970967ffa5dddafdb771237062d/markupsafe-3.0.3-cp313-cp313t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:8709b08f4a89aa7586de0aadc8da56180242ee0ada3999749b183aa23df95025", size = 23569, upload-time = "2025-09-27T18:36:57.913Z" }, + { url = "https://files.pythonhosted.org/packages/4b/30/6f2fce1f1f205fc9323255b216ca8a235b15860c34b6798f810f05828e32/markupsafe-3.0.3-cp313-cp313t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:b8512a91625c9b3da6f127803b166b629725e68af71f8184ae7e7d54686a56d6", size = 23284, upload-time = "2025-09-27T18:36:58.833Z" }, + { url = "https://files.pythonhosted.org/packages/58/47/4a0ccea4ab9f5dcb6f79c0236d954acb382202721e704223a8aafa38b5c8/markupsafe-3.0.3-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:9b79b7a16f7fedff2495d684f2b59b0457c3b493778c9eed31111be64d58279f", size = 24801, upload-time = "2025-09-27T18:36:59.739Z" }, + { url = "https://files.pythonhosted.org/packages/6a/70/3780e9b72180b6fecb83a4814d84c3bf4b4ae4bf0b19c27196104149734c/markupsafe-3.0.3-cp313-cp313t-musllinux_1_2_riscv64.whl", hash = "sha256:12c63dfb4a98206f045aa9563db46507995f7ef6d83b2f68eda65c307c6829eb", size = 22769, upload-time = "2025-09-27T18:37:00.719Z" }, + { url = "https://files.pythonhosted.org/packages/98/c5/c03c7f4125180fc215220c035beac6b9cb684bc7a067c84fc69414d315f5/markupsafe-3.0.3-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:8f71bc33915be5186016f675cd83a1e08523649b0e33efdb898db577ef5bb009", size = 23642, upload-time = "2025-09-27T18:37:01.673Z" }, + { url = "https://files.pythonhosted.org/packages/80/d6/2d1b89f6ca4bff1036499b1e29a1d02d282259f3681540e16563f27ebc23/markupsafe-3.0.3-cp313-cp313t-win32.whl", hash = "sha256:69c0b73548bc525c8cb9a251cddf1931d1db4d2258e9599c28c07ef3580ef354", size = 14612, upload-time = "2025-09-27T18:37:02.639Z" }, + { url = "https://files.pythonhosted.org/packages/2b/98/e48a4bfba0a0ffcf9925fe2d69240bfaa19c6f7507b8cd09c70684a53c1e/markupsafe-3.0.3-cp313-cp313t-win_amd64.whl", hash = "sha256:1b4b79e8ebf6b55351f0d91fe80f893b4743f104bff22e90697db1590e47a218", size = 15200, upload-time = "2025-09-27T18:37:03.582Z" }, + { url = "https://files.pythonhosted.org/packages/0e/72/e3cc540f351f316e9ed0f092757459afbc595824ca724cbc5a5d4263713f/markupsafe-3.0.3-cp313-cp313t-win_arm64.whl", hash = "sha256:ad2cf8aa28b8c020ab2fc8287b0f823d0a7d8630784c31e9ee5edea20f406287", size = 13973, upload-time = "2025-09-27T18:37:04.929Z" }, + { url = "https://files.pythonhosted.org/packages/33/8a/8e42d4838cd89b7dde187011e97fe6c3af66d8c044997d2183fbd6d31352/markupsafe-3.0.3-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:eaa9599de571d72e2daf60164784109f19978b327a3910d3e9de8c97b5b70cfe", size = 11619, upload-time = "2025-09-27T18:37:06.342Z" }, + { url = "https://files.pythonhosted.org/packages/b5/64/7660f8a4a8e53c924d0fa05dc3a55c9cee10bbd82b11c5afb27d44b096ce/markupsafe-3.0.3-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:c47a551199eb8eb2121d4f0f15ae0f923d31350ab9280078d1e5f12b249e0026", size = 12029, upload-time = "2025-09-27T18:37:07.213Z" }, + { url = "https://files.pythonhosted.org/packages/da/ef/e648bfd021127bef5fa12e1720ffed0c6cbb8310c8d9bea7266337ff06de/markupsafe-3.0.3-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:f34c41761022dd093b4b6896d4810782ffbabe30f2d443ff5f083e0cbbb8c737", size = 24408, upload-time = "2025-09-27T18:37:09.572Z" }, + { url = "https://files.pythonhosted.org/packages/41/3c/a36c2450754618e62008bf7435ccb0f88053e07592e6028a34776213d877/markupsafe-3.0.3-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:457a69a9577064c05a97c41f4e65148652db078a3a509039e64d3467b9e7ef97", size = 23005, upload-time = "2025-09-27T18:37:10.58Z" }, + { url = "https://files.pythonhosted.org/packages/bc/20/b7fdf89a8456b099837cd1dc21974632a02a999ec9bf7ca3e490aacd98e7/markupsafe-3.0.3-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:e8afc3f2ccfa24215f8cb28dcf43f0113ac3c37c2f0f0806d8c70e4228c5cf4d", size = 22048, upload-time = "2025-09-27T18:37:11.547Z" }, + { url = "https://files.pythonhosted.org/packages/9a/a7/591f592afdc734f47db08a75793a55d7fbcc6902a723ae4cfbab61010cc5/markupsafe-3.0.3-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:ec15a59cf5af7be74194f7ab02d0f59a62bdcf1a537677ce67a2537c9b87fcda", size = 23821, upload-time = "2025-09-27T18:37:12.48Z" }, + { url = "https://files.pythonhosted.org/packages/7d/33/45b24e4f44195b26521bc6f1a82197118f74df348556594bd2262bda1038/markupsafe-3.0.3-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:0eb9ff8191e8498cca014656ae6b8d61f39da5f95b488805da4bb029cccbfbaf", size = 21606, upload-time = "2025-09-27T18:37:13.485Z" }, + { url = "https://files.pythonhosted.org/packages/ff/0e/53dfaca23a69fbfbbf17a4b64072090e70717344c52eaaaa9c5ddff1e5f0/markupsafe-3.0.3-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:2713baf880df847f2bece4230d4d094280f4e67b1e813eec43b4c0e144a34ffe", size = 23043, upload-time = "2025-09-27T18:37:14.408Z" }, + { url = "https://files.pythonhosted.org/packages/46/11/f333a06fc16236d5238bfe74daccbca41459dcd8d1fa952e8fbd5dccfb70/markupsafe-3.0.3-cp314-cp314-win32.whl", hash = "sha256:729586769a26dbceff69f7a7dbbf59ab6572b99d94576a5592625d5b411576b9", size = 14747, upload-time = "2025-09-27T18:37:15.36Z" }, + { url = "https://files.pythonhosted.org/packages/28/52/182836104b33b444e400b14f797212f720cbc9ed6ba34c800639d154e821/markupsafe-3.0.3-cp314-cp314-win_amd64.whl", hash = "sha256:bdc919ead48f234740ad807933cdf545180bfbe9342c2bb451556db2ed958581", size = 15341, upload-time = "2025-09-27T18:37:16.496Z" }, + { url = "https://files.pythonhosted.org/packages/6f/18/acf23e91bd94fd7b3031558b1f013adfa21a8e407a3fdb32745538730382/markupsafe-3.0.3-cp314-cp314-win_arm64.whl", hash = "sha256:5a7d5dc5140555cf21a6fefbdbf8723f06fcd2f63ef108f2854de715e4422cb4", size = 14073, upload-time = "2025-09-27T18:37:17.476Z" }, + { url = "https://files.pythonhosted.org/packages/3c/f0/57689aa4076e1b43b15fdfa646b04653969d50cf30c32a102762be2485da/markupsafe-3.0.3-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:1353ef0c1b138e1907ae78e2f6c63ff67501122006b0f9abad68fda5f4ffc6ab", size = 11661, upload-time = "2025-09-27T18:37:18.453Z" }, + { url = "https://files.pythonhosted.org/packages/89/c3/2e67a7ca217c6912985ec766c6393b636fb0c2344443ff9d91404dc4c79f/markupsafe-3.0.3-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:1085e7fbddd3be5f89cc898938f42c0b3c711fdcb37d75221de2666af647c175", size = 12069, upload-time = "2025-09-27T18:37:19.332Z" }, + { url = "https://files.pythonhosted.org/packages/f0/00/be561dce4e6ca66b15276e184ce4b8aec61fe83662cce2f7d72bd3249d28/markupsafe-3.0.3-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:1b52b4fb9df4eb9ae465f8d0c228a00624de2334f216f178a995ccdcf82c4634", size = 25670, upload-time = "2025-09-27T18:37:20.245Z" }, + { url = "https://files.pythonhosted.org/packages/50/09/c419f6f5a92e5fadde27efd190eca90f05e1261b10dbd8cbcb39cd8ea1dc/markupsafe-3.0.3-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:fed51ac40f757d41b7c48425901843666a6677e3e8eb0abcff09e4ba6e664f50", size = 23598, upload-time = "2025-09-27T18:37:21.177Z" }, + { url = "https://files.pythonhosted.org/packages/22/44/a0681611106e0b2921b3033fc19bc53323e0b50bc70cffdd19f7d679bb66/markupsafe-3.0.3-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:f190daf01f13c72eac4efd5c430a8de82489d9cff23c364c3ea822545032993e", size = 23261, upload-time = "2025-09-27T18:37:22.167Z" }, + { url = "https://files.pythonhosted.org/packages/5f/57/1b0b3f100259dc9fffe780cfb60d4be71375510e435efec3d116b6436d43/markupsafe-3.0.3-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:e56b7d45a839a697b5eb268c82a71bd8c7f6c94d6fd50c3d577fa39a9f1409f5", size = 24835, upload-time = "2025-09-27T18:37:23.296Z" }, + { url = "https://files.pythonhosted.org/packages/26/6a/4bf6d0c97c4920f1597cc14dd720705eca0bf7c787aebc6bb4d1bead5388/markupsafe-3.0.3-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:f3e98bb3798ead92273dc0e5fd0f31ade220f59a266ffd8a4f6065e0a3ce0523", size = 22733, upload-time = "2025-09-27T18:37:24.237Z" }, + { url = "https://files.pythonhosted.org/packages/14/c7/ca723101509b518797fedc2fdf79ba57f886b4aca8a7d31857ba3ee8281f/markupsafe-3.0.3-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:5678211cb9333a6468fb8d8be0305520aa073f50d17f089b5b4b477ea6e67fdc", size = 23672, upload-time = "2025-09-27T18:37:25.271Z" }, + { url = "https://files.pythonhosted.org/packages/fb/df/5bd7a48c256faecd1d36edc13133e51397e41b73bb77e1a69deab746ebac/markupsafe-3.0.3-cp314-cp314t-win32.whl", hash = "sha256:915c04ba3851909ce68ccc2b8e2cd691618c4dc4c4232fb7982bca3f41fd8c3d", size = 14819, upload-time = "2025-09-27T18:37:26.285Z" }, + { url = "https://files.pythonhosted.org/packages/1a/8a/0402ba61a2f16038b48b39bccca271134be00c5c9f0f623208399333c448/markupsafe-3.0.3-cp314-cp314t-win_amd64.whl", hash = "sha256:4faffd047e07c38848ce017e8725090413cd80cbc23d86e55c587bf979e579c9", size = 15426, upload-time = "2025-09-27T18:37:27.316Z" }, + { url = "https://files.pythonhosted.org/packages/70/bc/6f1c2f612465f5fa89b95bead1f44dcb607670fd42891d8fdcd5d039f4f4/markupsafe-3.0.3-cp314-cp314t-win_arm64.whl", hash = "sha256:32001d6a8fc98c8cb5c947787c5d08b0a50663d139f1305bac5885d98d9b40fa", size = 14146, upload-time = "2025-09-27T18:37:28.327Z" }, +] + +[[package]] +name = "mergedeep" +version = "1.3.4" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/3a/41/580bb4006e3ed0361b8151a01d324fb03f420815446c7def45d02f74c270/mergedeep-1.3.4.tar.gz", hash = "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8", size = 4661, upload-time = "2021-02-05T18:55:30.623Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2c/19/04f9b178c2d8a15b076c8b5140708fa6ffc5601fb6f1e975537072df5b2a/mergedeep-1.3.4-py3-none-any.whl", hash = "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307", size = 6354, upload-time = "2021-02-05T18:55:29.583Z" }, +] + +[[package]] +name = "mkdocs" +version = "1.6.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "click" }, + { name = "colorama", marker = "sys_platform == 'win32'" }, + { name = "ghp-import" }, + { name = "jinja2" }, + { name = "markdown" }, + { name = "markupsafe" }, + { name = "mergedeep" }, + { name = "mkdocs-get-deps" }, + { name = "packaging" }, + { name = "pathspec" }, + { name = "pyyaml" }, + { name = "pyyaml-env-tag" }, + { name = "watchdog" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/bc/c6/bbd4f061bd16b378247f12953ffcb04786a618ce5e904b8c5a01a0309061/mkdocs-1.6.1.tar.gz", hash = "sha256:7b432f01d928c084353ab39c57282f29f92136665bdd6abf7c1ec8d822ef86f2", size = 3889159, upload-time = "2024-08-30T12:24:06.899Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/22/5b/dbc6a8cddc9cfa9c4971d59fb12bb8d42e161b7e7f8cc89e49137c5b279c/mkdocs-1.6.1-py3-none-any.whl", hash = "sha256:db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e", size = 3864451, upload-time = "2024-08-30T12:24:05.054Z" }, +] + +[[package]] +name = "mkdocs-get-deps" +version = "0.2.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mergedeep" }, + { name = "platformdirs" }, + { name = "pyyaml" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/98/f5/ed29cd50067784976f25ed0ed6fcd3c2ce9eb90650aa3b2796ddf7b6870b/mkdocs_get_deps-0.2.0.tar.gz", hash = "sha256:162b3d129c7fad9b19abfdcb9c1458a651628e4b1dea628ac68790fb3061c60c", size = 10239, upload-time = "2023-11-20T17:51:09.981Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9f/d4/029f984e8d3f3b6b726bd33cafc473b75e9e44c0f7e80a5b29abc466bdea/mkdocs_get_deps-0.2.0-py3-none-any.whl", hash = "sha256:2bf11d0b133e77a0dd036abeeb06dec8775e46efa526dc70667d8863eefc6134", size = 9521, upload-time = "2023-11-20T17:51:08.587Z" }, +] + +[[package]] +name = "mkdocs-git-revision-date-localized-plugin" +version = "1.4.7" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "babel" }, + { name = "gitpython" }, + { name = "mkdocs" }, + { name = "pytz" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/5e/f8/a17ec39a4fc314d40cc96afdc1d401e393ebd4f42309d454cc940a2cf38a/mkdocs_git_revision_date_localized_plugin-1.4.7.tar.gz", hash = "sha256:10a49eff1e1c3cb766e054b9d8360c904ce4fe8c33ac3f6cc083ac6459c91953", size = 450473, upload-time = "2025-05-28T18:26:20.697Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/53/b6/106fcc15287e7228658fbd0ad9e8b0d775becced0a089cc39984641f4a0f/mkdocs_git_revision_date_localized_plugin-1.4.7-py3-none-any.whl", hash = "sha256:056c0a90242409148f1dc94d5c9d2c25b5b8ddd8de45489fa38f7fa7ccad2bc4", size = 25382, upload-time = "2025-05-28T18:26:18.907Z" }, +] + +[[package]] +name = "mkdocs-material" +version = "9.6.21" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "babel" }, + { name = "backrefs" }, + { name = "colorama" }, + { name = "jinja2" }, + { name = "markdown" }, + { name = "mkdocs" }, + { name = "mkdocs-material-extensions" }, + { name = "paginate" }, + { name = "pygments" }, + { name = "pymdown-extensions" }, + { name = "requests" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ff/d5/ab83ca9aa314954b0a9e8849780bdd01866a3cfcb15ffb7e3a61ca06ff0b/mkdocs_material-9.6.21.tar.gz", hash = "sha256:b01aa6d2731322438056f360f0e623d3faae981f8f2d8c68b1b973f4f2657870", size = 4043097, upload-time = "2025-09-30T19:11:27.517Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/cf/4f/98681c2030375fe9b057dbfb9008b68f46c07dddf583f4df09bf8075e37f/mkdocs_material-9.6.21-py3-none-any.whl", hash = "sha256:aa6a5ab6fb4f6d381588ac51da8782a4d3757cb3d1b174f81a2ec126e1f22c92", size = 9203097, upload-time = "2025-09-30T19:11:24.063Z" }, +] + +[[package]] +name = "mkdocs-material-extensions" +version = "1.3.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/79/9b/9b4c96d6593b2a541e1cb8b34899a6d021d208bb357042823d4d2cabdbe7/mkdocs_material_extensions-1.3.1.tar.gz", hash = "sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443", size = 11847, upload-time = "2023-11-22T19:09:45.208Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5b/54/662a4743aa81d9582ee9339d4ffa3c8fd40a4965e033d77b9da9774d3960/mkdocs_material_extensions-1.3.1-py3-none-any.whl", hash = "sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31", size = 8728, upload-time = "2023-11-22T19:09:43.465Z" }, +] + +[[package]] +name = "packaging" +version = "25.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/a1/d4/1fc4078c65507b51b96ca8f8c3ba19e6a61c8253c72794544580a7b6c24d/packaging-25.0.tar.gz", hash = "sha256:d443872c98d677bf60f6a1f2f8c1cb748e8fe762d2bf9d3148b5599295b0fc4f", size = 165727, upload-time = "2025-04-19T11:48:59.673Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/20/12/38679034af332785aac8774540895e234f4d07f7545804097de4b666afd8/packaging-25.0-py3-none-any.whl", hash = "sha256:29572ef2b1f17581046b3a2227d5c611fb25ec70ca1ba8554b24b0e69331a484", size = 66469, upload-time = "2025-04-19T11:48:57.875Z" }, +] + +[[package]] +name = "paginate" +version = "0.5.7" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ec/46/68dde5b6bc00c1296ec6466ab27dddede6aec9af1b99090e1107091b3b84/paginate-0.5.7.tar.gz", hash = "sha256:22bd083ab41e1a8b4f3690544afb2c60c25e5c9a63a30fa2f483f6c60c8e5945", size = 19252, upload-time = "2024-08-25T14:17:24.139Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/90/96/04b8e52da071d28f5e21a805b19cb9390aa17a47462ac87f5e2696b9566d/paginate-0.5.7-py2.py3-none-any.whl", hash = "sha256:b885e2af73abcf01d9559fd5216b57ef722f8c42affbb63942377668e35c7591", size = 13746, upload-time = "2024-08-25T14:17:22.55Z" }, +] + +[[package]] +name = "pathspec" +version = "0.12.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ca/bc/f35b8446f4531a7cb215605d100cd88b7ac6f44ab3fc94870c120ab3adbf/pathspec-0.12.1.tar.gz", hash = "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712", size = 51043, upload-time = "2023-12-10T22:30:45Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/cc/20/ff623b09d963f88bfde16306a54e12ee5ea43e9b597108672ff3a408aad6/pathspec-0.12.1-py3-none-any.whl", hash = "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08", size = 31191, upload-time = "2023-12-10T22:30:43.14Z" }, +] + +[[package]] +name = "platformdirs" +version = "4.4.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/23/e8/21db9c9987b0e728855bd57bff6984f67952bea55d6f75e055c46b5383e8/platformdirs-4.4.0.tar.gz", hash = "sha256:ca753cf4d81dc309bc67b0ea38fd15dc97bc30ce419a7f58d13eb3bf14c4febf", size = 21634, upload-time = "2025-08-26T14:32:04.268Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/40/4b/2028861e724d3bd36227adfa20d3fd24c3fc6d52032f4a93c133be5d17ce/platformdirs-4.4.0-py3-none-any.whl", hash = "sha256:abd01743f24e5287cd7a5db3752faf1a2d65353f38ec26d98e25a6db65958c85", size = 18654, upload-time = "2025-08-26T14:32:02.735Z" }, +] + +[[package]] +name = "pygments" +version = "2.19.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/b0/77/a5b8c569bf593b0140bde72ea885a803b82086995367bf2037de0159d924/pygments-2.19.2.tar.gz", hash = "sha256:636cb2477cec7f8952536970bc533bc43743542f70392ae026374600add5b887", size = 4968631, upload-time = "2025-06-21T13:39:12.283Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c7/21/705964c7812476f378728bdf590ca4b771ec72385c533964653c68e86bdc/pygments-2.19.2-py3-none-any.whl", hash = "sha256:86540386c03d588bb81d44bc3928634ff26449851e99741617ecb9037ee5ec0b", size = 1225217, upload-time = "2025-06-21T13:39:07.939Z" }, +] + +[[package]] +name = "pymdown-extensions" +version = "10.16.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markdown" }, + { name = "pyyaml" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/55/b3/6d2b3f149bc5413b0a29761c2c5832d8ce904a1d7f621e86616d96f505cc/pymdown_extensions-10.16.1.tar.gz", hash = "sha256:aace82bcccba3efc03e25d584e6a22d27a8e17caa3f4dd9f207e49b787aa9a91", size = 853277, upload-time = "2025-07-28T16:19:34.167Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e4/06/43084e6cbd4b3bc0e80f6be743b2e79fbc6eed8de9ad8c629939fa55d972/pymdown_extensions-10.16.1-py3-none-any.whl", hash = "sha256:d6ba157a6c03146a7fb122b2b9a121300056384eafeec9c9f9e584adfdb2a32d", size = 266178, upload-time = "2025-07-28T16:19:31.401Z" }, +] + +[[package]] +name = "python-dateutil" +version = "2.9.0.post0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "six" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/66/c0/0c8b6ad9f17a802ee498c46e004a0eb49bc148f2fd230864601a86dcf6db/python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 342432, upload-time = "2024-03-01T18:36:20.211Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ec/57/56b9bcc3c9c6a792fcbaf139543cee77261f3651ca9da0c93f5c1221264b/python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427", size = 229892, upload-time = "2024-03-01T18:36:18.57Z" }, +] + +[[package]] +name = "pytz" +version = "2025.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/f8/bf/abbd3cdfb8fbc7fb3d4d38d320f2441b1e7cbe29be4f23797b4a2b5d8aac/pytz-2025.2.tar.gz", hash = "sha256:360b9e3dbb49a209c21ad61809c7fb453643e048b38924c765813546746e81c3", size = 320884, upload-time = "2025-03-25T02:25:00.538Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/81/c4/34e93fe5f5429d7570ec1fa436f1986fb1f00c3e0f43a589fe2bbcd22c3f/pytz-2025.2-py2.py3-none-any.whl", hash = "sha256:5ddf76296dd8c44c26eb8f4b6f35488f3ccbf6fbbd7adee0b7262d43f0ec2f00", size = 509225, upload-time = "2025-03-25T02:24:58.468Z" }, +] + +[[package]] +name = "pyyaml" +version = "6.0.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/05/8e/961c0007c59b8dd7729d542c61a4d537767a59645b82a0b521206e1e25c2/pyyaml-6.0.3.tar.gz", hash = "sha256:d76623373421df22fb4cf8817020cbb7ef15c725b9d5e45f17e189bfc384190f", size = 130960, upload-time = "2025-09-25T21:33:16.546Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d1/11/0fd08f8192109f7169db964b5707a2f1e8b745d4e239b784a5a1dd80d1db/pyyaml-6.0.3-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:8da9669d359f02c0b91ccc01cac4a67f16afec0dac22c2ad09f46bee0697eba8", size = 181669, upload-time = "2025-09-25T21:32:23.673Z" }, + { url = "https://files.pythonhosted.org/packages/b1/16/95309993f1d3748cd644e02e38b75d50cbc0d9561d21f390a76242ce073f/pyyaml-6.0.3-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:2283a07e2c21a2aa78d9c4442724ec1eb15f5e42a723b99cb3d822d48f5f7ad1", size = 173252, upload-time = "2025-09-25T21:32:25.149Z" }, + { url = "https://files.pythonhosted.org/packages/50/31/b20f376d3f810b9b2371e72ef5adb33879b25edb7a6d072cb7ca0c486398/pyyaml-6.0.3-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ee2922902c45ae8ccada2c5b501ab86c36525b883eff4255313a253a3160861c", size = 767081, upload-time = "2025-09-25T21:32:26.575Z" }, + { url = "https://files.pythonhosted.org/packages/49/1e/a55ca81e949270d5d4432fbbd19dfea5321eda7c41a849d443dc92fd1ff7/pyyaml-6.0.3-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a33284e20b78bd4a18c8c2282d549d10bc8408a2a7ff57653c0cf0b9be0afce5", size = 841159, upload-time = "2025-09-25T21:32:27.727Z" }, + { url = "https://files.pythonhosted.org/packages/74/27/e5b8f34d02d9995b80abcef563ea1f8b56d20134d8f4e5e81733b1feceb2/pyyaml-6.0.3-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0f29edc409a6392443abf94b9cf89ce99889a1dd5376d94316ae5145dfedd5d6", size = 801626, upload-time = "2025-09-25T21:32:28.878Z" }, + { url = "https://files.pythonhosted.org/packages/f9/11/ba845c23988798f40e52ba45f34849aa8a1f2d4af4b798588010792ebad6/pyyaml-6.0.3-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:f7057c9a337546edc7973c0d3ba84ddcdf0daa14533c2065749c9075001090e6", size = 753613, upload-time = "2025-09-25T21:32:30.178Z" }, + { url = "https://files.pythonhosted.org/packages/3d/e0/7966e1a7bfc0a45bf0a7fb6b98ea03fc9b8d84fa7f2229e9659680b69ee3/pyyaml-6.0.3-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:eda16858a3cab07b80edaf74336ece1f986ba330fdb8ee0d6c0d68fe82bc96be", size = 794115, upload-time = "2025-09-25T21:32:31.353Z" }, + { url = "https://files.pythonhosted.org/packages/de/94/980b50a6531b3019e45ddeada0626d45fa85cbe22300844a7983285bed3b/pyyaml-6.0.3-cp313-cp313-win32.whl", hash = "sha256:d0eae10f8159e8fdad514efdc92d74fd8d682c933a6dd088030f3834bc8e6b26", size = 137427, upload-time = "2025-09-25T21:32:32.58Z" }, + { url = "https://files.pythonhosted.org/packages/97/c9/39d5b874e8b28845e4ec2202b5da735d0199dbe5b8fb85f91398814a9a46/pyyaml-6.0.3-cp313-cp313-win_amd64.whl", hash = "sha256:79005a0d97d5ddabfeeea4cf676af11e647e41d81c9a7722a193022accdb6b7c", size = 154090, upload-time = "2025-09-25T21:32:33.659Z" }, + { url = "https://files.pythonhosted.org/packages/73/e8/2bdf3ca2090f68bb3d75b44da7bbc71843b19c9f2b9cb9b0f4ab7a5a4329/pyyaml-6.0.3-cp313-cp313-win_arm64.whl", hash = "sha256:5498cd1645aa724a7c71c8f378eb29ebe23da2fc0d7a08071d89469bf1d2defb", size = 140246, upload-time = "2025-09-25T21:32:34.663Z" }, + { url = "https://files.pythonhosted.org/packages/9d/8c/f4bd7f6465179953d3ac9bc44ac1a8a3e6122cf8ada906b4f96c60172d43/pyyaml-6.0.3-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:8d1fab6bb153a416f9aeb4b8763bc0f22a5586065f86f7664fc23339fc1c1fac", size = 181814, upload-time = "2025-09-25T21:32:35.712Z" }, + { url = "https://files.pythonhosted.org/packages/bd/9c/4d95bb87eb2063d20db7b60faa3840c1b18025517ae857371c4dd55a6b3a/pyyaml-6.0.3-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:34d5fcd24b8445fadc33f9cf348c1047101756fd760b4dacb5c3e99755703310", size = 173809, upload-time = "2025-09-25T21:32:36.789Z" }, + { url = "https://files.pythonhosted.org/packages/92/b5/47e807c2623074914e29dabd16cbbdd4bf5e9b2db9f8090fa64411fc5382/pyyaml-6.0.3-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:501a031947e3a9025ed4405a168e6ef5ae3126c59f90ce0cd6f2bfc477be31b7", size = 766454, upload-time = "2025-09-25T21:32:37.966Z" }, + { url = "https://files.pythonhosted.org/packages/02/9e/e5e9b168be58564121efb3de6859c452fccde0ab093d8438905899a3a483/pyyaml-6.0.3-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:b3bc83488de33889877a0f2543ade9f70c67d66d9ebb4ac959502e12de895788", size = 836355, upload-time = "2025-09-25T21:32:39.178Z" }, + { url = "https://files.pythonhosted.org/packages/88/f9/16491d7ed2a919954993e48aa941b200f38040928474c9e85ea9e64222c3/pyyaml-6.0.3-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c458b6d084f9b935061bc36216e8a69a7e293a2f1e68bf956dcd9e6cbcd143f5", size = 794175, upload-time = "2025-09-25T21:32:40.865Z" }, + { url = "https://files.pythonhosted.org/packages/dd/3f/5989debef34dc6397317802b527dbbafb2b4760878a53d4166579111411e/pyyaml-6.0.3-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:7c6610def4f163542a622a73fb39f534f8c101d690126992300bf3207eab9764", size = 755228, upload-time = "2025-09-25T21:32:42.084Z" }, + { url = "https://files.pythonhosted.org/packages/d7/ce/af88a49043cd2e265be63d083fc75b27b6ed062f5f9fd6cdc223ad62f03e/pyyaml-6.0.3-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:5190d403f121660ce8d1d2c1bb2ef1bd05b5f68533fc5c2ea899bd15f4399b35", size = 789194, upload-time = "2025-09-25T21:32:43.362Z" }, + { url = "https://files.pythonhosted.org/packages/23/20/bb6982b26a40bb43951265ba29d4c246ef0ff59c9fdcdf0ed04e0687de4d/pyyaml-6.0.3-cp314-cp314-win_amd64.whl", hash = "sha256:4a2e8cebe2ff6ab7d1050ecd59c25d4c8bd7e6f400f5f82b96557ac0abafd0ac", size = 156429, upload-time = "2025-09-25T21:32:57.844Z" }, + { url = "https://files.pythonhosted.org/packages/f4/f4/a4541072bb9422c8a883ab55255f918fa378ecf083f5b85e87fc2b4eda1b/pyyaml-6.0.3-cp314-cp314-win_arm64.whl", hash = "sha256:93dda82c9c22deb0a405ea4dc5f2d0cda384168e466364dec6255b293923b2f3", size = 143912, upload-time = "2025-09-25T21:32:59.247Z" }, + { url = "https://files.pythonhosted.org/packages/7c/f9/07dd09ae774e4616edf6cda684ee78f97777bdd15847253637a6f052a62f/pyyaml-6.0.3-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:02893d100e99e03eda1c8fd5c441d8c60103fd175728e23e431db1b589cf5ab3", size = 189108, upload-time = "2025-09-25T21:32:44.377Z" }, + { url = "https://files.pythonhosted.org/packages/4e/78/8d08c9fb7ce09ad8c38ad533c1191cf27f7ae1effe5bb9400a46d9437fcf/pyyaml-6.0.3-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c1ff362665ae507275af2853520967820d9124984e0f7466736aea23d8611fba", size = 183641, upload-time = "2025-09-25T21:32:45.407Z" }, + { url = "https://files.pythonhosted.org/packages/7b/5b/3babb19104a46945cf816d047db2788bcaf8c94527a805610b0289a01c6b/pyyaml-6.0.3-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6adc77889b628398debc7b65c073bcb99c4a0237b248cacaf3fe8a557563ef6c", size = 831901, upload-time = "2025-09-25T21:32:48.83Z" }, + { url = "https://files.pythonhosted.org/packages/8b/cc/dff0684d8dc44da4d22a13f35f073d558c268780ce3c6ba1b87055bb0b87/pyyaml-6.0.3-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a80cb027f6b349846a3bf6d73b5e95e782175e52f22108cfa17876aaeff93702", size = 861132, upload-time = "2025-09-25T21:32:50.149Z" }, + { url = "https://files.pythonhosted.org/packages/b1/5e/f77dc6b9036943e285ba76b49e118d9ea929885becb0a29ba8a7c75e29fe/pyyaml-6.0.3-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:00c4bdeba853cc34e7dd471f16b4114f4162dc03e6b7afcc2128711f0eca823c", size = 839261, upload-time = "2025-09-25T21:32:51.808Z" }, + { url = "https://files.pythonhosted.org/packages/ce/88/a9db1376aa2a228197c58b37302f284b5617f56a5d959fd1763fb1675ce6/pyyaml-6.0.3-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:66e1674c3ef6f541c35191caae2d429b967b99e02040f5ba928632d9a7f0f065", size = 805272, upload-time = "2025-09-25T21:32:52.941Z" }, + { url = "https://files.pythonhosted.org/packages/da/92/1446574745d74df0c92e6aa4a7b0b3130706a4142b2d1a5869f2eaa423c6/pyyaml-6.0.3-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:16249ee61e95f858e83976573de0f5b2893b3677ba71c9dd36b9cf8be9ac6d65", size = 829923, upload-time = "2025-09-25T21:32:54.537Z" }, + { url = "https://files.pythonhosted.org/packages/f0/7a/1c7270340330e575b92f397352af856a8c06f230aa3e76f86b39d01b416a/pyyaml-6.0.3-cp314-cp314t-win_amd64.whl", hash = "sha256:4ad1906908f2f5ae4e5a8ddfce73c320c2a1429ec52eafd27138b7f1cbe341c9", size = 174062, upload-time = "2025-09-25T21:32:55.767Z" }, + { url = "https://files.pythonhosted.org/packages/f1/12/de94a39c2ef588c7e6455cfbe7343d3b2dc9d6b6b2f40c4c6565744c873d/pyyaml-6.0.3-cp314-cp314t-win_arm64.whl", hash = "sha256:ebc55a14a21cb14062aa4162f906cd962b28e2e9ea38f9b4391244cd8de4ae0b", size = 149341, upload-time = "2025-09-25T21:32:56.828Z" }, +] + +[[package]] +name = "pyyaml-env-tag" +version = "1.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pyyaml" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/eb/2e/79c822141bfd05a853236b504869ebc6b70159afc570e1d5a20641782eaa/pyyaml_env_tag-1.1.tar.gz", hash = "sha256:2eb38b75a2d21ee0475d6d97ec19c63287a7e140231e4214969d0eac923cd7ff", size = 5737, upload-time = "2025-05-13T15:24:01.64Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/04/11/432f32f8097b03e3cd5fe57e88efb685d964e2e5178a48ed61e841f7fdce/pyyaml_env_tag-1.1-py3-none-any.whl", hash = "sha256:17109e1a528561e32f026364712fee1264bc2ea6715120891174ed1b980d2e04", size = 4722, upload-time = "2025-05-13T15:23:59.629Z" }, +] + +[[package]] +name = "requests" +version = "2.32.5" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "certifi" }, + { name = "charset-normalizer" }, + { name = "idna" }, + { name = "urllib3" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/c9/74/b3ff8e6c8446842c3f5c837e9c3dfcfe2018ea6ecef224c710c85ef728f4/requests-2.32.5.tar.gz", hash = "sha256:dbba0bac56e100853db0ea71b82b4dfd5fe2bf6d3754a8893c3af500cec7d7cf", size = 134517, upload-time = "2025-08-18T20:46:02.573Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/1e/db/4254e3eabe8020b458f1a747140d32277ec7a271daf1d235b70dc0b4e6e3/requests-2.32.5-py3-none-any.whl", hash = "sha256:2462f94637a34fd532264295e186976db0f5d453d1cdd31473c85a6a161affb6", size = 64738, upload-time = "2025-08-18T20:46:00.542Z" }, +] + +[[package]] +name = "six" +version = "1.17.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/94/e7/b2c673351809dca68a0e064b6af791aa332cf192da575fd474ed7d6f16a2/six-1.17.0.tar.gz", hash = "sha256:ff70335d468e7eb6ec65b95b99d3a2836546063f63acc5171de367e834932a81", size = 34031, upload-time = "2024-12-04T17:35:28.174Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b7/ce/149a00dd41f10bc29e5921b496af8b574d8413afcd5e30dfa0ed46c2cc5e/six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274", size = 11050, upload-time = "2024-12-04T17:35:26.475Z" }, +] + +[[package]] +name = "smmap" +version = "5.0.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/44/cd/a040c4b3119bbe532e5b0732286f805445375489fceaec1f48306068ee3b/smmap-5.0.2.tar.gz", hash = "sha256:26ea65a03958fa0c8a1c7e8c7a58fdc77221b8910f6be2131affade476898ad5", size = 22329, upload-time = "2025-01-02T07:14:40.909Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/04/be/d09147ad1ec7934636ad912901c5fd7667e1c858e19d355237db0d0cd5e4/smmap-5.0.2-py3-none-any.whl", hash = "sha256:b30115f0def7d7531d22a0fb6502488d879e75b260a9db4d0819cfb25403af5e", size = 24303, upload-time = "2025-01-02T07:14:38.724Z" }, +] + +[[package]] +name = "two-torial" +version = "0.1.0" +source = { virtual = "." } +dependencies = [ + { name = "click" }, + { name = "fontawesome-markdown" }, + { name = "mkdocs" }, + { name = "mkdocs-git-revision-date-localized-plugin" }, + { name = "mkdocs-material" }, +] + +[package.metadata] +requires-dist = [ + { name = "click", specifier = "==8.2.1" }, + { name = "fontawesome-markdown", specifier = ">=0.2.6" }, + { name = "mkdocs", specifier = ">=1.6.1" }, + { name = "mkdocs-git-revision-date-localized-plugin", specifier = ">=1.4.7" }, + { name = "mkdocs-material", specifier = ">=9.6.21" }, +] + +[[package]] +name = "urllib3" +version = "2.5.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/15/22/9ee70a2574a4f4599c47dd506532914ce044817c7752a79b6a51286319bc/urllib3-2.5.0.tar.gz", hash = "sha256:3fc47733c7e419d4bc3f6b3dc2b4f890bb743906a30d56ba4a5bfa4bbff92760", size = 393185, upload-time = "2025-06-18T14:07:41.644Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a7/c2/fe1e52489ae3122415c51f387e221dd0773709bad6c6cdaa599e8a2c5185/urllib3-2.5.0-py3-none-any.whl", hash = "sha256:e6b01673c0fa6a13e374b50871808eb3bf7046c4b125b216f6bf1cc604cff0dc", size = 129795, upload-time = "2025-06-18T14:07:40.39Z" }, +] + +[[package]] +name = "watchdog" +version = "6.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/db/7d/7f3d619e951c88ed75c6037b246ddcf2d322812ee8ea189be89511721d54/watchdog-6.0.0.tar.gz", hash = "sha256:9ddf7c82fda3ae8e24decda1338ede66e1c99883db93711d8fb941eaa2d8c282", size = 131220, upload-time = "2024-11-01T14:07:13.037Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/68/98/b0345cabdce2041a01293ba483333582891a3bd5769b08eceb0d406056ef/watchdog-6.0.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:490ab2ef84f11129844c23fb14ecf30ef3d8a6abafd3754a6f75ca1e6654136c", size = 96480, upload-time = "2024-11-01T14:06:42.952Z" }, + { url = "https://files.pythonhosted.org/packages/85/83/cdf13902c626b28eedef7ec4f10745c52aad8a8fe7eb04ed7b1f111ca20e/watchdog-6.0.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:76aae96b00ae814b181bb25b1b98076d5fc84e8a53cd8885a318b42b6d3a5134", size = 88451, upload-time = "2024-11-01T14:06:45.084Z" }, + { url = "https://files.pythonhosted.org/packages/fe/c4/225c87bae08c8b9ec99030cd48ae9c4eca050a59bf5c2255853e18c87b50/watchdog-6.0.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:a175f755fc2279e0b7312c0035d52e27211a5bc39719dd529625b1930917345b", size = 89057, upload-time = "2024-11-01T14:06:47.324Z" }, + { url = "https://files.pythonhosted.org/packages/a9/c7/ca4bf3e518cb57a686b2feb4f55a1892fd9a3dd13f470fca14e00f80ea36/watchdog-6.0.0-py3-none-manylinux2014_aarch64.whl", hash = "sha256:7607498efa04a3542ae3e05e64da8202e58159aa1fa4acddf7678d34a35d4f13", size = 79079, upload-time = "2024-11-01T14:06:59.472Z" }, + { url = "https://files.pythonhosted.org/packages/5c/51/d46dc9332f9a647593c947b4b88e2381c8dfc0942d15b8edc0310fa4abb1/watchdog-6.0.0-py3-none-manylinux2014_armv7l.whl", hash = "sha256:9041567ee8953024c83343288ccc458fd0a2d811d6a0fd68c4c22609e3490379", size = 79078, upload-time = "2024-11-01T14:07:01.431Z" }, + { url = "https://files.pythonhosted.org/packages/d4/57/04edbf5e169cd318d5f07b4766fee38e825d64b6913ca157ca32d1a42267/watchdog-6.0.0-py3-none-manylinux2014_i686.whl", hash = "sha256:82dc3e3143c7e38ec49d61af98d6558288c415eac98486a5c581726e0737c00e", size = 79076, upload-time = "2024-11-01T14:07:02.568Z" }, + { url = "https://files.pythonhosted.org/packages/ab/cc/da8422b300e13cb187d2203f20b9253e91058aaf7db65b74142013478e66/watchdog-6.0.0-py3-none-manylinux2014_ppc64.whl", hash = "sha256:212ac9b8bf1161dc91bd09c048048a95ca3a4c4f5e5d4a7d1b1a7d5752a7f96f", size = 79077, upload-time = "2024-11-01T14:07:03.893Z" }, + { url = "https://files.pythonhosted.org/packages/2c/3b/b8964e04ae1a025c44ba8e4291f86e97fac443bca31de8bd98d3263d2fcf/watchdog-6.0.0-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:e3df4cbb9a450c6d49318f6d14f4bbc80d763fa587ba46ec86f99f9e6876bb26", size = 79078, upload-time = "2024-11-01T14:07:05.189Z" }, + { url = "https://files.pythonhosted.org/packages/62/ae/a696eb424bedff7407801c257d4b1afda455fe40821a2be430e173660e81/watchdog-6.0.0-py3-none-manylinux2014_s390x.whl", hash = "sha256:2cce7cfc2008eb51feb6aab51251fd79b85d9894e98ba847408f662b3395ca3c", size = 79077, upload-time = "2024-11-01T14:07:06.376Z" }, + { url = "https://files.pythonhosted.org/packages/b5/e8/dbf020b4d98251a9860752a094d09a65e1b436ad181faf929983f697048f/watchdog-6.0.0-py3-none-manylinux2014_x86_64.whl", hash = "sha256:20ffe5b202af80ab4266dcd3e91aae72bf2da48c0d33bdb15c66658e685e94e2", size = 79078, upload-time = "2024-11-01T14:07:07.547Z" }, + { url = "https://files.pythonhosted.org/packages/07/f6/d0e5b343768e8bcb4cda79f0f2f55051bf26177ecd5651f84c07567461cf/watchdog-6.0.0-py3-none-win32.whl", hash = "sha256:07df1fdd701c5d4c8e55ef6cf55b8f0120fe1aef7ef39a1c6fc6bc2e606d517a", size = 79065, upload-time = "2024-11-01T14:07:09.525Z" }, + { url = "https://files.pythonhosted.org/packages/db/d9/c495884c6e548fce18a8f40568ff120bc3a4b7b99813081c8ac0c936fa64/watchdog-6.0.0-py3-none-win_amd64.whl", hash = "sha256:cbafb470cf848d93b5d013e2ecb245d4aa1c8fd0504e863ccefa32445359d680", size = 79070, upload-time = "2024-11-01T14:07:10.686Z" }, + { url = "https://files.pythonhosted.org/packages/33/e8/e40370e6d74ddba47f002a32919d91310d6074130fe4e17dabcafc15cbf1/watchdog-6.0.0-py3-none-win_ia64.whl", hash = "sha256:a1914259fa9e1454315171103c6a30961236f508b9b623eae470268bbcc6a22f", size = 79067, upload-time = "2024-11-01T14:07:11.845Z" }, +]