chore: initial commit

This commit is contained in:
asterisk727
2025-12-29 19:22:46 +09:00
commit a1d69c9732
675 changed files with 14674 additions and 0 deletions
+43
View File
@@ -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
+4
View File
@@ -0,0 +1,4 @@
.idea
mkdocs-material/
/.vs
.venv/
+1
View File
@@ -0,0 +1 @@
two-torial.xyz
+13
View File
@@ -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.
+45
View File
@@ -0,0 +1,45 @@
<p align="center">
<img src="https://github.com/two-torial/two-torial/blob/master/docs/img/two-torial/github-banner.webp?raw=true">
</p>
#
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.
<https://two-torial.xyz/>
## 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.
+1
View File
@@ -0,0 +1 @@
two-torial.xyz
+138
View File
@@ -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.
+304
View File
@@ -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<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > &,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<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > &,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<br>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).
+152
View File
@@ -0,0 +1,152 @@
<img class="header-logo" src="/img/extras/asphyxia/logo.webp">
# 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"
+228
View File
@@ -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:
<img src="/img/common/audio_exclusive.webp">
!!! 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
<img src="/img/extras/audio/voicemeeter_menuopts.webp">
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:
<img src="/img/extras/audio/voicemeeter_outputs.webp">
### 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`
<img src="/img/extras/audio/obs_inputcapture.webp">
- For the Device, select `VoiceMeeter Output (B1)`
<img src="/img/extras/audio/obs_capturedevice.webp">
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`
<img src="/img/extras/audio/obs_monitorandoutput.webp">
4. Configure OBS audio settings:
- Go to `File` > `Settings`
<img src="/img/extras/audio/obs_settings.webp">
- 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`
<img src="/img/extras/audio/obs_audiosettings.webp">
- 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)
+375
View File
@@ -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"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/iidx/gamo2_pwan.webp">
<div>
[**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.
</div>
</div>
??? tip "DX6TH"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/iidx/yuancon_dx6th.webp">
<div>
[**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.
</div>
</div>
### Sound Voltex
!!! info "Valkyrie cabinets typically use Sanwa buttons, 20g springs, 100g microswitches"
??? tip "FAUCETWO+"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/sdvx/gamo2_faucetwo.webp">
<div>
**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.
</div>
</div>
??? tip "SDVX12"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/sdvx/yuancon_sdvx12.webp">
<div>
**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+.
</div>
</div>
??? tip "SDVX LITE 3"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/sdvx/yuancon_sdvxlite3.webp">
<div>
[**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.
</div>
</div>
### pop'n music
??? tip "POPOLLER"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/popn/gamo2_popoller.webp">
<div>
[**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.
</div>
</div>
### Dance Dance Revolution
??? tip "L-TEK / iamats"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/ddr/l-tek.webp">
<div>
[**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.
</div>
</div>
??? tip "YuanCon Pad Single/Double"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/ddr/yuancon_pad.webp">
<div>
**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.
</div>
</div>
### NOSTALGIA
??? tip "NOSTROLLER"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/nost/gamo2_nostroller.webp">
<div>
[**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.
</div>
</div>
## SEGA
### CHUNITHM
??? tip "TASOLLER+"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/chuni/gamo2_tasollerplus.webp">
<div>
[**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.
</div>
</div>
??? tip "Laverita 3"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/chuni/yuancon_laverita.webp">
<div>
**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.
</div>
</div>
### maimai
??? tip "NDX"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/maimai/yuancon_ndx.webp">
<div>
[**Product page**](https://yuancon.store/controller/ndx){target="_blank"}
**Vendor**: [YuanCon](https://yuancon.store/){target="_blank"}
**Price**: $899 + High shipping/Taxes
</div>
</div>
### O.N.G.E.K.I.
??? tip "ONTROLLER"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/ongeki/gamo2_ontroller.webp">
<div>
[**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.
</div>
</div>
??? tip "YUANGEKI"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/ongeki/yuancon_yuangeki.webp">
<div>
[**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.
</div>
</div>
## 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"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/taiko/zhong_taiko.webp">
<div>
[**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.
</div>
</div>
??? tip "TDC17"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/taiko/rythmagica_tdc17.webp">
<div>
[**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.
</div>
</div>
??? tip "TAIKOLLER"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/taiko/gamo2_taikoller.webp">
<div>
[**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.
</div>
</div>
??? tip "TAIKO FORCE LV6"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/taiko/yuancon_taikoforcelv6.webp">
<div>
[**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.
</div>
</div>
#### Tatacons (much smaller than arcade but plenty capable)
??? tip "TDC10 Pro"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/taiko/rythmagica_tdc10pro.webp">
<div>
[**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.
</div>
</div>
??? tip "HORI Official Tatacons"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/taiko/hori_tatacon.webp">
<div>
[**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.
</div>
</div>
??? tip "IINE Tatacon"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/taiko/iine_tatacon.webp">
<div>
[**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.
</div>
</div>
#### In-betweens (not quite AC-size, not quite Tatacon)
??? tip "IINE Taiko Pro Max"
<div class="controller-flex">
<img class="controller-preview" src="/img/extras/controllers/taiko/iine_taikopromax.webp">
<div>
[**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.
</div>
</div>
+120
View File
@@ -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
<img src="/img/extras/datamods/1.webp">
- Place your mod files inside data_mods in a way that respects the following structure
`data_mods/mod_folder/<data folders/<data_files>`
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/`
<img src="/img/extras/datamods/2.webp">
**Directory**: `contents/data_mods/omnimix_31`
<img src="/img/extras/datamods/3.webp">
## 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/)
<img src="/img/extras/datamods/4.webp">
- Open the archive
<img src="/img/extras/datamods/5.webp">
- 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
<img src="/img/extras/datamods/6.webp">
- Copy the `ifs_hook.dll` file to your game's `modules` folder
<img src="/img/extras/datamods/7.webp">
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**.
<img src="/img/extras/datamods/8.webp">
+85
View File
@@ -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.
<img src="/img/extras/hexguide/1.webp">
!!! 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.
<img src="/img/extras/hexguide/2.webp">
!!! 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`.
<img src="/img/extras/hexguide/3.webp">
!!! 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!**
<img src="/img/extras/hexguide/4.webp">
!!! 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.
<img src="/img/extras/hexguide/5.webp">
!!! 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.
+333
View File
@@ -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.
+89
View File
@@ -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.
<img src="/img/extras/patchsp2x/1.webp">
#### Importing Patches from URL
!!! tip ""
Open `spicecfg.exe` and head to the `Patches` tab.
<img src="/img/extras/patchsp2x/2.webp">
!!! 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.**^^
<img src="/img/extras/patchsp2x/3.webp">
### 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.
<img src="/img/extras/patchsp2x/4.webp">
!!! 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!
+76
View File
@@ -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:
<img src="/img/extras/patchweb/1.webp">
!!! tip ""
Click on any game you'd like the patches for. In this case, we'll use CHUNITHM VERSE.
<img src="/img/extras/patchweb/2.webp">
<img src="/img/extras/patchweb/3.webp">
!!! 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.**
<img src="/img/extras/patchweb/4.webp">
!!! 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!
<img src="/img/extras/patchweb/5.webp">
!!! tip ""
When you're done selecting patches, click on `Save Patched File` and your new file will start downloading.
<img src="/img/extras/patchweb/6.webp">
!!! 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!
+59
View File
@@ -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.<br>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.
+133
View File
@@ -0,0 +1,133 @@
<img class="header-logo" src="/img/extras/zerotier/logo.webp">
# 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`
<img src="/img/extras/zerotier/ipconfig.webp">
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:
<img align=left src="/img/extras/zerotier/config_advanced.webp">
@@ -0,0 +1,61 @@
<img class="header-logo" src="/img/konami/beatstream/animutribe/logo.webp">
# 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.
<img src="/img/common/audio_24_441.webp">
!!! 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`.
<img src="/img/konami/beatstream/animutribe/1.webp">
### Configuring Your Tools
!!! tip ""
Now that you have your files ready, open up your `.bat` file in your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) and edit it with your desired parameters, for the purpose of this guide we will demonstrate both a local network configuration and an online example below with SpiceTools, skip to whichever you're in need of accordingly and please keep in mind you can add whatever additional parameters you desire.
!!! warning "If you're not using SpiceTools:"
The overall structure of your .bat file will differ from the guide, namely the initialization of SpiceTools won't be present and potential parameters may differ. As stated above, make sure to check the documentation of your tools to ensure you're using the correct parameters for your needs.
### Configuring for a Local Network
!!! tip ""
For our local network configuration example, on a single line in the `.bat` file we're going to type `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.
@@ -0,0 +1,44 @@
<img class="header-logo" src="/img/konami/beatstream/animutribe/logo.webp">
# 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 (-).
+2
View File
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/ddr/a20/logo.webp">
--8<-- "docs/games/konami/ddr/common/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/ddr/a20/logo.webp">
--8<-- "docs/games/konami/ddr/common/troubleshooting.md"
+2
View File
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/ddr/a20plus/logo.webp">
--8<-- "docs/games/konami/ddr/common/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/ddr/a20plus/logo.webp">
--8<-- "docs/games/konami/ddr/common/troubleshooting.md"
+2
View File
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/ddr/a3/logo.webp">
--8<-- "docs/games/konami/ddr/common/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/ddr/a3/logo.webp">
--8<-- "docs/games/konami/ddr/common/troubleshooting.md"
+162
View File
@@ -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"
@@ -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).
+2
View File
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/ddr/world/logo.webp">
--8<-- "docs/games/konami/ddr/common/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/ddr/world/logo.webp">
--8<-- "docs/games/konami/ddr/common/troubleshooting.md"
+147
View File
@@ -0,0 +1,147 @@
<img class="header-logo" src="/img/konami/gitadora/exchain/logo.webp">
# 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.
<img src="/img/common/audio_24_441.webp">
!!! 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`.
<img src="/img/konami/gitadora/exchain/1.webp">
!!! 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++.
<img src="/img/konami/gitadora/matixx/2g.webp">
!!! 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++.
<img src="/img/konami/gitadora/matixx/2d.webp">
### 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++.
<img src="/img/konami/gitadora/matixx/3g.webp">
!!! 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++.
<img src="/img/konami/gitadora/matixx/3d.webp">
!!! tip ""
One final note, since you're playing on a network, you will have one additional step of setting up your card file within your chosen tools, make sure to check your server's information on how to setup a card file.
### Final Steps and Setting up the Game
!!! tip ""
The last steps you'll have to do with your chosen tools is simply setting up your desired keybinds! Make sure you setup the `Test` keybind as it will be critical for setting up the game. Once you've done that, launch your game for the first time by double clicking the `.bat` you setup and the game should load.
If it's your first time running the game, you'll immediately be greeted with this screen, oh no!
<img src="/img/konami/gitadora/matixx/4.webp">
!!! tip ""
This is normal, simply hit your `Test` keybind and continue on to this.
<img src="/img/konami/gitadora/matixx/5.webp">
!!! tip ""
From here, we will need to set a shop name to play, so select the `GAME OPTIONS` option.
<img src="/img/konami/gitadora/matixx/6.webp">
!!! tip ""
Then, select `SHOP SETTINGS`.
<img src="/img/konami/gitadora/matixx/7.webp">
!!! 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.
<img src="/img/konami/gitadora/matixx/8.webp">
!!! 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.
<img src="/img/konami/gitadora/matixx/9.webp">
!!! 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.
@@ -0,0 +1,74 @@
<img class="header-logo" src="/img/konami/gitadora/exchain/logo.webp">
# 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.
+253
View File
@@ -0,0 +1,253 @@
<img class="header-logo" src="/img/konami/gitadora/fuzzup/logo.webp">
# 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.
<img src="/img/konami/gitadora/fuzzup/spice.webp">
## General Configuration
!!! info ""
Since GITADORA has a separate mode for both Guitar and Drums, the configuration will be split into three sections.<br>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.<br>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.<br>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.
<img src="/img/common/spice2x_network.webp">
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.
<img src="/img/common/spice2x_cards.webp">
??? 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`.
<img src="/img/common/audio_24_441.webp">
## 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.
<img src="/img/konami/gitadora/matixx/4.webp">
!!! tip ""
This is normal, simply hit your `Test` keybind to enter test mode.
<img src="/img/konami/gitadora/matixx/5.webp">
!!! tip ""
From here, we will need to set a shop name to play, so select the `GAME OPTIONS` option.
<img src="/img/konami/gitadora/matixx/6.webp">
!!! tip ""
Then, select `SHOP SETTINGS`.
<img src="/img/konami/gitadora/matixx/7.webp">
!!! 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.
<img src="/img/konami/gitadora/matixx/8.webp">
!!! 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.
<img src="/img/konami/gitadora/matixx/9.webp">
!!! 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.
@@ -0,0 +1,61 @@
<img class="header-logo" src="/img/konami/gitadora/fuzzup/logo.webp">
# 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.
+137
View File
@@ -0,0 +1,137 @@
<img class="header-logo" src="/img/konami/gitadora/matixx/logo.webp">
# 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.
<img src="/img/common/audio_24_441.webp">
!!! 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`.
<img src="/img/konami/gitadora/matixx/1.webp">
### Configuring Your Tools
!!! tip ""
Now that you have your files ready, open up your `.bat` file in your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) and edit it with your desired parameters, for the purpose of this guide we will demonstrate both a local network configuration and an online example below 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++.
<img src="/img/konami/gitadora/matixx/2g.webp">
!!! 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++.
<img src="/img/konami/gitadora/matixx/2d.webp">
### 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++.
<img src="/img/konami/gitadora/matixx/3g.webp">
!!! 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++.
<img src="/img/konami/gitadora/matixx/3d.webp">
!!! tip ""
One final note, since you're playing on a network, you will have one additional step of setting up your card file within your chosen tools, make sure to check your server's information on how to setup a card file.
### Final Steps and Setting up the Game
!!! tip ""
The last steps you'll have to do with your chosen tools is simply setting up your desired keybinds! Make sure you setup the `Test` keybind as it will be critical for setting up the game. Once you've done that, launch your game for the first time by double clicking the `.bat` you setup and the game should load.
If it's your first time running the game, you'll immediately be greeted with this screen, oh no!
<img src="/img/konami/gitadora/matixx/4.webp">
!!! tip ""
This is normal, simply hit your `Test` keybind and continue on to this.
<img src="/img/konami/gitadora/matixx/5.webp">
!!! tip ""
From here, we will need to set a shop name to play, so select the `GAME OPTIONS` option.
<img src="/img/konami/gitadora/matixx/6.webp">
!!! tip ""
Then, select `SHOP SETTINGS`.
<img src="/img/konami/gitadora/matixx/7.webp">
!!! 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.
<img src="/img/konami/gitadora/matixx/8.webp">
!!! 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.
<img src="/img/konami/gitadora/matixx/9.webp">
!!! 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.
@@ -0,0 +1,74 @@
<img class="header-logo" src="/img/konami/gitadora/matixx/logo.webp">
# 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.
+295
View File
@@ -0,0 +1,295 @@
<img class="header-logo" src="/img/konami/iidx/10thstyle/logo.webp">
# 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**.
<img src="/img/konami/iidx/10thstyle/setup/1.webp">
### 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`"
<img src="/img/konami/iidx/10thstyle/setup/2.webp">
## 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"
<img src="/img/konami/iidx/10thstyle/iidx10_linear.webp">
??? info "Point"
<img src="/img/konami/iidx/10thstyle/iidx10_point.webp">
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.
<img src="/img/konami/iidx/10thstyle/firstlaunch/1.webp">
<img src="/img/konami/iidx/10thstyle/firstlaunch/2.webp">
!!! tip ""
Press your `Start` key to confirm to get to the next error message.
### CLOCK ERROR
<img src="/img/konami/iidx/10thstyle/firstlaunch/3.webp">
!!! tip ""
Press your `Start` key to confirm. This will bring you into it's service menu.
<img src="/img/konami/iidx/10thstyle/firstlaunch/4.webp">
!!! 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`.
<img src="/img/konami/iidx/10thstyle/firstlaunch/5.webp">
### Enabling e-AMUSEMENT for Online Play
!!! tip ""
From the service menu, go to `e-AMUSEMENT OPTIONS` then `e-AMUSEMENT SETTINGS`.
<img src="/img/konami/iidx/10thstyle/firstlaunch/6.webp">
<img src="/img/konami/iidx/10thstyle/firstlaunch/7.webp">
!!! tip ""
It'll bring you to this screen, change it so that `e-AMUSEMENT` switches to `ON` and it will look like this:
<img src="/img/konami/iidx/10thstyle/firstlaunch/8.webp">
<img src="/img/konami/iidx/10thstyle/firstlaunch/9.webp">
!!! tip ""
We will need to set a `SHOP NAME SETTING` and change our `PREFECTURE` otherwise the game will throw errors at us.
<img src="/img/konami/iidx/10thstyle/firstlaunch/10.webp">
!!! 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.
<img src="/img/konami/iidx/10thstyle/firstlaunch/11.webp">
!!! 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.
<img src="/img/konami/iidx/10thstyle/firstlaunch/12.webp">
## 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.
@@ -0,0 +1,62 @@
<img class="header-logo" src="/img/konami/iidx/10thstyle/logo.webp">
# 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 "<location of the file>\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.
+286
View File
@@ -0,0 +1,286 @@
<img class="header-logo" src="/img/konami/iidx/11_red/logo.webp">
# 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**.
<img src="/img/konami/iidx/11_red/setup/1.webp">
### 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`"
<img src="/img/konami/iidx/11_red/setup/2.webp">
## 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"
<img src="/img/konami/iidx/11_red/iidx11_linear.webp">
??? info "Point"
<img src="/img/konami/iidx/11_red/iidx11_point.webp">
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.
<img src="/img/konami/iidx/11_red/firstlaunch/1.webp">
<img src="/img/konami/iidx/11_red/firstlaunch/2.webp">
!!! tip ""
Press your `Start` key to confirm to get to the next error message.
### CLOCK ERROR
<img src="/img/konami/iidx/11_red/firstlaunch/3.webp">
!!! tip ""
Press your `Start` key to confirm. This will bring you into it's service menu.
<img src="/img/konami/iidx/11_red/firstlaunch/4.webp">
!!! 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`.
<img src="/img/konami/iidx/11_red/firstlaunch/5.webp">
### Enabling e-AMUSEMENT for Online Play
!!! tip ""
From the service menu, go to `NETWORK OPTIONS` then `e-AMUSEMENT SETTINGS`.
<img src="/img/konami/iidx/11_red/firstlaunch/6.webp">
<img src="/img/konami/iidx/11_red/firstlaunch/7.webp">
!!! tip ""
It'll bring you to this screen, change it so that `e-AMUSEMENT` switches to `ON` and it will look like this:
<img src="/img/konami/iidx/11_red/firstlaunch/8.webp">
<img src="/img/konami/iidx/11_red/firstlaunch/9.webp">
!!! tip ""
We will need to set a `SHOP NAME SETTING` and change our `PREFECTURE` otherwise the game will throw errors at us.
<img src="/img/konami/iidx/11_red/firstlaunch/10.webp">
!!! 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.
<img src="/img/konami/iidx/11_red/firstlaunch/11.webp">
!!! 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.
<img src="/img/konami/iidx/11_red/firstlaunch/12.webp">
## 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.
@@ -0,0 +1,62 @@
<img class="header-logo" src="/img/konami/iidx/11_red/logo.webp">
# 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 "<location of the file>\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.
+308
View File
@@ -0,0 +1,308 @@
<img class="header-logo" src="/img/konami/iidx/12_happysky/logo.webp">
# 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**.
<img src="/img/konami/iidx/12_happysky/setup/1.webp">
### 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 "<location of the file>\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`"
<img src="/img/konami/iidx/12_happysky/setup/2.webp">
## 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"
<img src="/img/konami/iidx/12_happysky/iidx12_linear.webp">
??? info "Point"
<img src="/img/konami/iidx/12_happysky/iidx12_point.webp">
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.
<img src="/img/konami/iidx/12_happysky/firstlaunch/1.webp">
<img src="/img/konami/iidx/12_happysky/firstlaunch/2.webp">
!!! tip ""
Press your `Start` key to confirm to get to the next error message.
### CLOCK ERROR
<img src="/img/konami/iidx/12_happysky/firstlaunch/3.webp">
!!! tip ""
Press your `Start` key to confirm. This will bring you into it's service menu.
<img src="/img/konami/iidx/12_happysky/firstlaunch/4.webp">
!!! 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`.
<img src="/img/konami/iidx/12_happysky/firstlaunch/5.webp">
### Enabling e-AMUSEMENT for Online Play
!!! tip ""
From the service menu, go to `NETWORK OPTIONS` then `e-AMUSEMENT SETTINGS`.
<img src="/img/konami/iidx/12_happysky/firstlaunch/6.webp">
<img src="/img/konami/iidx/12_happysky/firstlaunch/7.webp">
!!! tip ""
It'll bring you to this screen, change it so that `e-AMUSEMENT` switches to `ON` and it will look like this:
<img src="/img/konami/iidx/12_happysky/firstlaunch/8.webp">
<img src="/img/konami/iidx/12_happysky/firstlaunch/9.webp">
!!! tip ""
We will need to set a `SHOP NAME SETTING` and change our `PREFECTURE` otherwise the game will throw errors at us.
<img src="/img/konami/iidx/12_happysky/firstlaunch/10.webp">
!!! 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.
<img src="/img/konami/iidx/12_happysky/firstlaunch/11.webp">
!!! 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.
<img src="/img/konami/iidx/12_happysky/firstlaunch/12.webp">
## 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.
@@ -0,0 +1,62 @@
<img class="header-logo" src="/img/konami/iidx/12_happysky/logo.webp">
# 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 "<location of the file>\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.
@@ -0,0 +1,307 @@
<img class="header-logo" src="/img/konami/iidx/13_distorted/logo.webp">
# 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**.
<img src="/img/konami/iidx/13_distorted/setup/1.webp">
### 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 "<location of the file>\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`"
<img src="/img/konami/iidx/13_distorted/setup/2.webp">
## 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"
<img src="/img/konami/iidx/13_distorted/iidx13_linear.webp">
??? info "Point"
<img src="/img/konami/iidx/13_distorted/iidx13_point.webp">
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.
<img src="/img/konami/iidx/13_distorted/firstlaunch/1.webp">
<img src="/img/konami/iidx/13_distorted/firstlaunch/2.webp">
!!! tip ""
Press your `Test` key to confirm to get to the next error message.
### CLOCK ERROR
<img src="/img/konami/iidx/13_distorted/firstlaunch/3.webp">
!!! tip ""
Press your `Test` key to confirm. This will bring you into it's service menu.
<img src="/img/konami/iidx/13_distorted/firstlaunch/4.webp">
!!! 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`.
<img src="/img/konami/iidx/13_distorted/firstlaunch/5.webp">
### Enabling e-AMUSEMENT for Online Play
!!! tip ""
From the service menu, go to `NETWORK OPTIONS` then `e-AMUSEMENT SETTINGS`.
<img src="/img/konami/iidx/13_distorted/firstlaunch/6.webp">
<img src="/img/konami/iidx/13_distorted/firstlaunch/7.webp">
!!! tip ""
It'll bring you to this screen, change it so that `e-AMUSEMENT` switches to `ON` and it will look like this:
<img src="/img/konami/iidx/13_distorted/firstlaunch/8.webp">
<img src="/img/konami/iidx/13_distorted/firstlaunch/9.webp">
!!! tip ""
We will need to set a `SHOP NAME SETTING` and change our `PREFECTURE` otherwise the game will throw errors at us.
<img src="/img/konami/iidx/13_distorted/firstlaunch/10.webp">
!!! 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.
<img src="/img/konami/iidx/13_distorted/firstlaunch/11.webp">
!!! 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.
<img src="/img/konami/iidx/13_distorted/firstlaunch/12.webp">
## 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.
@@ -0,0 +1,62 @@
<img class="header-logo" src="/img/konami/iidx/13_distorted/logo.webp">
# 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 "<location of the file>\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.
+297
View File
@@ -0,0 +1,297 @@
<img class="header-logo" src="/img/konami/iidx/14_gold/logo.webp">
# 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**.
<img src="/img/konami/iidx/14_gold/setup/1.webp">
### 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 "<location of the file>\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`"
<img src="/img/konami/iidx/14_gold/setup/2.webp">
## 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"
<img src="/img/konami/iidx/14_gold/iidx14_linear.webp">
??? info "Point"
<img src="/img/konami/iidx/14_gold/iidx14_point.webp">
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.
<img src="/img/konami/iidx/14_gold/firstlaunch/1.webp">
!!! 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.
<img src="/img/konami/iidx/14_gold/firstlaunch/2.webp">
!!! tip ""
Press your `Test` key to confirm to get to the next error message.
### CLOCK ERROR
<img src="/img/konami/iidx/14_gold/firstlaunch/3.webp">
!!! tip ""
Press your `Test` key to confirm. The game will then perform a `MONITOR CHECK`.
<img src="/img/konami/iidx/14_gold/firstlaunch/4.webp">
<img src="/img/konami/iidx/14_gold/firstlaunch/5.webp">
!!! 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`.
<img src="/img/konami/iidx/14_gold/firstlaunch/6.webp">
### Enabling e-AMUSEMENT for Online Play
!!! tip ""
From the service menu, go to `NETWORK OPTIONS` then `e-AMUSEMENT SETTINGS`.
<img src="/img/konami/iidx/14_gold/firstlaunch/7.webp">
<img src="/img/konami/iidx/14_gold/firstlaunch/8.webp">
<img src="/img/konami/iidx/14_gold/firstlaunch/9.webp">
!!! tip ""
We will need to set a `SHOP NAME SETTING` and change our `SETTING AREA` otherwise the game will throw errors at us.
<img src="/img/konami/iidx/14_gold/firstlaunch/10.webp">
!!! 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.
<img src="/img/konami/iidx/14_gold/firstlaunch/11.webp">
!!! tip ""
Select `SAVE AND EXIT`.
<img src="/img/konami/iidx/14_gold/firstlaunch/12.webp">
## 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.
@@ -0,0 +1,57 @@
<img class="header-logo" src="/img/konami/iidx/14_gold/logo.webp">
# 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 "<location of the file>\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.
@@ -0,0 +1,34 @@
<img class="header-logo" src="/img/konami/iidx/16_empress/logo.webp">
# 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`
<img src="/img/konami/iidx/16_empress/11.webp">
- Go to the line that says `OUTPUT MODE` and change it to your desired mode
- Select `SAVE AND EXIT`
That's it!
+167
View File
@@ -0,0 +1,167 @@
<img class="header-logo" src="/img/konami/iidx/16_empress/logo.webp">
# 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.
<img src="/img/konami/iidx/14_gold/firstlaunch/2.webp">
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.
<img src="/img/konami/iidx/14_gold/firstlaunch/3.webp">
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.
<img src="/img/konami/iidx/14_gold/firstlaunch/5.webp">
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`.
<img src="/img/konami/iidx/14_gold/firstlaunch/6.webp">
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`.
<img src="/img/konami/iidx/14_gold/firstlaunch/9.webp">
<img src="/img/konami/iidx/14_gold/firstlaunch/10.webp">
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`.
<img src="/img/konami/iidx/16_empress/11.webp">
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"
@@ -0,0 +1,45 @@
<img class="header-logo" src="/img/konami/iidx/16_empress/logo.webp">
# 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.<br>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).
@@ -0,0 +1,49 @@
<img class="header-logo" src="/img/konami/iidx/24_sinobuz/logo.webp">
# 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
<pcbid __type="str">00010203040506070809</pcbid>
<hardid __type="str">00010203040506070809</hardid>
```
The following line determines what version of the game you are running.
^^**You should never change this**^^. It should always say `LDJ`.
```xml
<model __type="str">LDJ</model>
```
^^**You should never change this**^^. It should always say `A` for SINOBUZ.
```xml
<rev __type="str">A</rev>
```
The following line determines your datecode.
^^**Always keep it up to date**^^ with your game's current version.
```xml
<ext __type="str">2017082800</ext>
```
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
<services __type="str">http://localhost:8083</services>
```
+294
View File
@@ -0,0 +1,294 @@
<img class="header-logo" src="/img/konami/iidx/24_sinobuz/logo.webp">
# 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:
<img src="/img/konami/iidx/24_sinobuz/data.webp">
??? 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.
<img src="/img/konami/iidx/24_sinobuz/spice2xdata.webp">
## 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"
<img src="/img/common/spice2x_option_hover.webp">
!!! 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.
<img src="/img/common/spice2x_network.webp">
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.
<img src="/img/common/spice2x_cards.webp">
??? 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`.
<img src="/img/common/audio_24_441.webp">
## 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.
<img src="/img/konami/iidx/common/oldhd/firstlaunch/1.webp">
### 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.
<img src="/img/konami/iidx/common/oldhd/firstlaunch/2.webp">
!!! tip ""
Let the game run for a bit until the monitor check is complete and you should be taken to the service menu.
<img src="/img/konami/iidx/common/oldhd/firstlaunch/3.webp">
!!! 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`.
<img src="/img/konami/iidx/common/oldhd/firstlaunch/4.webp">
!!! 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.
<img src="/img/konami/iidx/common/oldhd/firstlaunch/5.webp">
!!! tip ""
Once done selecting, select `YES` then `SAVE AND EXIT`.
<img src="/img/konami/iidx/common/oldhd/firstlaunch/6.webp">
### NETWORK OPTIONS
!!! tip ""
Go to `NETWORK OPTIONS` then `SHOP NAME SETTING`.
<img src="/img/konami/iidx/common/oldhd/firstlaunch/7.webp">
<img src="/img/konami/iidx/common/oldhd/firstlaunch/8.webp">
!!! 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`.
<img src="/img/konami/iidx/common/oldhd/firstlaunch/9.webp">
<img src="/img/konami/iidx/common/oldhd/firstlaunch/10.webp">
!!! 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).
@@ -0,0 +1,36 @@
<img class="header-logo" src="/img/konami/iidx/24_sinobuz/logo.webp">
# 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.
@@ -0,0 +1,117 @@
<img class="header-logo" src="/img/konami/iidx/25_cannonballers/logo.webp">
# 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.
<img src="/img/common/audio_24_441.webp">
!!! 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`.
<img src="/img/konami/iidx/25_cannonballers/1.webp">
## Configuring Your Tools
!!! tip ""
Now that you have your files ready, open up your `.bat` file in your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) and edit it with your desired parameters, for the purpose of this guide we will demonstrate both a local network configuration and an online example below with SpiceTools, skip to whichever you're in need of accordingly and please keep in mind you can add whatever additional parameters you desire.
!!! warning "If you're not using SpiceTools:"
The overall structure of your .bat file will differ from the guide, namely the initialization of SpiceTools won't be present and potential parameters may differ. As stated above, make sure to check the documentation of your tools to ensure you're using the correct parameters for your needs.
## Configuring for a Local Network
!!! tip ""
For our local network configuration example, on a single line in the `.bat` file we're going to type `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++.
<img src="/img/konami/iidx/25_cannonballers/2.webp">
## Configuring for an Online Network
!!! tip ""
For our online network example we're simply doing the above but with different parameters! On our single line, we're going to type `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++.
<img src="/img/konami/iidx/25_cannonballers/3.webp">
!!! tip ""
One final note, since you're playing on a network, you will have one additional step of setting up your card file within your chosen tools, make sure to check your server's information on how to setup a card file.
## Final Steps and Setting up the Game
!!! tip ""
The last steps you'll have to do with your chosen tools is simply setting up your desired keybinds! Make sure you setup the `Test` keybind as it will be critical for setting up the game. Once you've done that, launch your game for the first time by double clicking the `.bat` you setup and the game should load.
If it's your first time running the game, you'll immediately be greeted with this screen, oh no!
<img src="/img/konami/iidx/25_cannonballers/4.webp">
!!! tip ""
Ignore this message, simply hit your `Test` keybind and continue onto this.
<img src="/img/konami/iidx/25_cannonballers/5.webp">
!!! tip ""
Hit the `Test` keybinding again to initialize the backup data, a message will pop up stating it's been initialized.
<img src="/img/konami/iidx/25_cannonballers/6.webp">
!!! 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.
<img src="/img/konami/iidx/25_cannonballers/7.webp">
!!! tip ""
Start by navigating up to `CLOCK` and entering that menu.
<img src="/img/konami/iidx/25_cannonballers/8.webp">
!!! tip ""
Simply hit save and exit and leave, the clock will be saved. Then, back in the service menu, go up to `GAME OPTIONS`
<img src="/img/konami/iidx/25_cannonballers/9.webp">
!!! 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.
<img src="/img/konami/iidx/25_cannonballers/10.webp">
!!! 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.
<img src="/img/konami/iidx/25_cannonballers/11.webp">
!!! 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.
<img src="/img/konami/iidx/25_cannonballers/12.webp">
<img src="/img/konami/iidx/25_cannonballers/13.webp">
!!! 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.
@@ -0,0 +1,70 @@
<img class="header-logo" src="/img/konami/iidx/25_cannonballers/logo.webp">
# 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.
+117
View File
@@ -0,0 +1,117 @@
<img class="header-logo" src="/img/konami/iidx/26_rootage/logo.webp">
# 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.
<img src="/img/common/audio_24_441.webp">
!!! 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`.
<img src="/img/konami/iidx/25_cannonballers/1.webp">
## Configuring Your Tools
!!! tip ""
Now that you have your files ready, open up your `.bat` file in your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) and edit it with your desired parameters, for the purpose of this guide we will demonstrate both a local network configuration and an online example below with SpiceTools, skip to whichever you're in need of accordingly and please keep in mind you can add whatever additional parameters you desire.
!!! warning "If you're not using SpiceTools:"
The overall structure of your .bat file will differ from the guide, namely the initialization of SpiceTools won't be present and potential parameters may differ. As stated above, make sure to check the documentation of your tools to ensure you're using the correct parameters for your needs.
## Configuring for a Local Network
!!! tip ""
For our local network configuration example, on a single line in the `.bat` file we're going to type `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++.
<img src="/img/konami/iidx/25_cannonballers/2.webp">
## Configuring for an Online Network
!!! tip ""
For our online network example we're simply doing the above but with different parameters! On our single line, we're going to type `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++.
<img src="/img/konami/iidx/25_cannonballers/3.webp">
!!! tip ""
One final note, since you're playing on a network, you will have one additional step of setting up your card file within your chosen tools, make sure to check your server's information on how to setup a card file.
## Final Steps and Setting up the Game
!!! tip ""
The last steps you'll have to do with your chosen tools is simply setting up your desired keybinds! Make sure you setup the `Test` keybind as it will be critical for setting up the game. Once you've done that, launch your game for the first time by double clicking the `.bat` you setup and the game should load.
If it's your first time running the game, you'll immediately be greeted with this screen, oh no!
<img src="/img/konami/iidx/25_cannonballers/4.webp">
!!! tip ""
Ignore this message, simply hit your `Test` keybind and continue onto this.
<img src="/img/konami/iidx/25_cannonballers/5.webp">
!!! tip ""
Hit the `Test` keybinding again to initialize the backup data, a message will pop up stating it's been initialized.
<img src="/img/konami/iidx/25_cannonballers/6.webp">
!!! 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.
<img src="/img/konami/iidx/25_cannonballers/7.webp">
!!! tip ""
Start by navigating up to `CLOCK` and entering that menu.
<img src="/img/konami/iidx/25_cannonballers/8.webp">
!!! tip ""
Simply hit save and exit and leave, the clock will be saved. Then, back in the service menu, go up to `GAME OPTIONS`
<img src="/img/konami/iidx/25_cannonballers/9.webp">
!!! tip ""
Once inside that menu, navigate your way up to `DEFINITION TYPE` and choose either `SD` or `HD` depending on your preferences.
<img src="/img/konami/iidx/26_rootage/1.webp">
!!! 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.
<img src="/img/konami/iidx/25_cannonballers/11.webp">
!!! 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.
<img src="/img/konami/iidx/25_cannonballers/12.webp">
<img src="/img/konami/iidx/25_cannonballers/13.webp">
!!! 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.
@@ -0,0 +1,70 @@
<img class="header-logo" src="/img/konami/iidx/26_rootage/logo.webp">
# 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.
@@ -0,0 +1,74 @@
<img class="header-logo" src="/img/konami/iidx/27_heroicverse/logo.webp">
# 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
@@ -0,0 +1,129 @@
<img class="header-logo" src="/img/konami/iidx/27_heroicverse/logo.webp">
# 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.
<img src="/img/common/audio_24_441.webp">
!!! 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.
<img src="/img/konami/iidx/27_heroicverse/1.webp">
## 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`.
<img src="/img/konami/iidx/27_heroicverse/cfg_ea.webp">
## 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`.
<img src="/img/konami/iidx/27_heroicverse/cfg_on.webp">
!!! tip ""
One final note, since you're playing on a network, you will have one additional step of setting up your card file within your chosen tools, make sure to check your server's information on how to setup a card file.
## Final Steps and Setting up the Game
!!! tip ""
The last steps you'll have to do with your chosen tools is simply setting up your desired keybinds 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!
<img src="/img/konami/iidx/25_cannonballers/4.webp">
!!! tip ""
Ignore this message, simply hit your `Test` keybind and continue onto this.
<img src="/img/konami/iidx/25_cannonballers/5.webp">
!!! tip ""
Hit the `Test` keybinding to initialize the backup data, a message will pop up stating it's been initialized.
<img src="/img/konami/iidx/25_cannonballers/6.webp">
!!! 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.
<img src="/img/konami/iidx/25_cannonballers/7.webp">
!!! tip ""
Start by navigating up to `CLOCK` and entering that menu.
<img src="/img/konami/iidx/25_cannonballers/8.webp">
!!! tip ""
Simply hit save and exit and leave, the clock will be saved. Then, back in the service menu, go up to `GAME OPTIONS`
<img src="/img/konami/iidx/25_cannonballers/9.webp">
!!! tip ""
Once inside that menu, navigate your way up to `DEFINITION TYPE` and choose either `SD` or `HD` depending on your preferences.
<img src="/img/konami/iidx/26_rootage/1.webp">
!!! 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.
<img src="/img/konami/iidx/25_cannonballers/11.webp">
!!! 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.
<img src="/img/konami/iidx/25_cannonballers/12.webp">
<img src="/img/konami/iidx/25_cannonballers/13.webp">
!!! 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)
@@ -0,0 +1,63 @@
<img class="header-logo" src="/img/konami/iidx/27_heroicverse/logo.webp">
# 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.
@@ -0,0 +1,88 @@
<img class="header-logo" src="/img/konami/iidx/30_resident/logo.webp">
# 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
<soft>
<model __type="str">LDJ</model>
<dest __type="str">J</dest>
<spec __type="str">A</spec>
<rev __type="str">A</rev>
<ext __type="str">2023090500</ext>
</soft>
```
This is the line that determines if the game will run in Standard (60 FPS) or Lightning (120 FPS) mode.
```xml
<spec __type="str">A</spec>
```
- ^^`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
<pcbid __type="str">00010203040506070809</pcbid>
<hardid __type="str">00010203040506070809</hardid>
```
The following line determines what version of the game you are running.
^^**You should never change this**^^. It should always say `LDJ`.
```xml
<model __type="str">LDJ</model>
```
The following line determines the game's region.
^^**You should never change this**^^. As you can change the language in-game.
```xml
<dest __type="str">J</dest>
```
^^**You should never change this**^^. It should always say `A` for Resident.
```xml
<rev __type="str">A</rev>
```
The following line determines your datecode.
^^**Always keep it up to date**^^ with your game's current version.
```xml
<ext __type="str">2023090500</ext>
```
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
<services __type="str">http://localhost:8083</services>
```
+231
View File
@@ -0,0 +1,231 @@
<img class="header-logo" src="/img/konami/iidx/30_resident/logo.webp">
# 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.
<img src="/img/konami/iidx/common/firstlaunch/1.webp">
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.
<img src="/img/konami/iidx/common/firstlaunch/2.webp">
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.
<img src="/img/konami/iidx/common/firstlaunch/3.webp">
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`.
<img src="/img/konami/iidx/common/firstlaunch/4.webp">
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`.
<img src="/img/konami/iidx/common/firstlaunch/5.webp">
<img src="/img/konami/iidx/common/firstlaunch/6.webp">
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`.
<img src="/img/konami/iidx/common/firstlaunch/7.webp">
Select `GAME MODE`.
<img src="/img/konami/iidx/common/firstlaunch/3.webp">
!!! 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"
@@ -0,0 +1,97 @@
<img class="header-logo" src="/img/konami/iidx/30_resident/logo.webp">
# 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.<br>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.
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/iidx/31_epolis/logo.webp">
--8<-- "docs/games/konami/iidx/common/31plus/extras.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/iidx/31_epolis/logo.webp">
--8<-- "docs/games/konami/iidx/common/31plus/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/iidx/31_epolis/logo.webp">
--8<-- "docs/games/konami/iidx/common/31plus/troubleshooting.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/iidx/32_pinkycrush/logo.webp">
--8<-- "docs/games/konami/iidx/common/31plus/extras.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/iidx/32_pinkycrush/logo.webp">
--8<-- "docs/games/konami/iidx/common/31plus/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/iidx/32_pinkycrush/logo.webp">
--8<-- "docs/games/konami/iidx/common/31plus/troubleshooting.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/iidx/33_sparkleshower/logo.webp">
--8<-- "docs/games/konami/iidx/common/31plus/extras.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/iidx/33_sparkleshower/logo.webp">
--8<-- "docs/games/konami/iidx/common/31plus/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/iidx/33_sparkleshower/logo.webp">
--8<-- "docs/games/konami/iidx/common/31plus/troubleshooting.md"
+275
View File
@@ -0,0 +1,275 @@
<img class="header-logo" src="/img/konami/iidx/9thstyle/logo.webp">
# 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**.
<img src="/img/konami/iidx/9thstyle/setup/1.webp">
### 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`"
<img src="/img/konami/iidx/9thstyle/setup/2.webp">
## 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"
<img src="/img/konami/iidx/9thstyle/9th_linear.webp">
??? info "Point"
<img src="/img/konami/iidx/9thstyle/9th_point.webp">
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.
<img src="/img/konami/iidx/9thstyle/firstlaunch/1.webp">
<img src="/img/konami/iidx/9thstyle/firstlaunch/2.webp">
!!! tip ""
The game will automatically bring you into it's service menu.
<img src="/img/konami/iidx/9thstyle/firstlaunch/3.webp">
!!! 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`.
<img src="/img/konami/iidx/9thstyle/firstlaunch/4.webp">
!!! 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`.
<img src="/img/konami/iidx/9thstyle/firstlaunch/5.webp">
<img src="/img/konami/iidx/9thstyle/firstlaunch/6.webp">
!!! tip ""
It'll bring you to this screen, change it so that `e-AMUSEMENT` switches to `ON` and it will look like this:
<img src="/img/konami/iidx/9thstyle/firstlaunch/7.webp">
<img src="/img/konami/iidx/9thstyle/firstlaunch/8.webp">
!!! tip ""
We will need to set a `SHOP NAME SETTING` and change our `PREFECTURE` otherwise the game will throw errors at us.
<img src="/img/konami/iidx/9thstyle/firstlaunch/9.webp">
!!! 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.
<img src="/img/konami/iidx/9thstyle/firstlaunch/10.webp">
!!! 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.
<img src="/img/konami/iidx/9thstyle/firstlaunch/11.webp">
## 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.
@@ -0,0 +1,62 @@
<img class="header-logo" src="/img/konami/iidx/9thstyle/logo.webp">
# 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 "<location of the file>\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.
@@ -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
<soft>
<model __type="str">LDJ</model>
<dest __type="str">J</dest>
<spec __type="str">E</spec>
<rev __type="str">A</rev>
<ext __type="str">2024100900</ext>
</soft>
```
This is the line that determines if the game will run in Standard (60 FPS) or Lightning (120 FPS) mode.
```xml
<spec __type="str">E</spec>
```
- ^^`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
<pcbid __type="str">00010203040506070809</pcbid>
<hardid __type="str">00010203040506070809</hardid>
```
The following line determines what version of the game you are running.
^^**You should never change this**^^. It should always say `LDJ`.
```xml
<model __type="str">LDJ</model>
```
The following line determines the game's region.
^^**You should never change this**^^. As you can change the language in-game.
```xml
<dest __type="str">J</dest>
```
^^**You should never change this**^^. It should always say `A` for Pinky Crush.
```xml
<rev __type="str">A</rev>
```
The following line determines your datecode.
^^**Always keep it up to date**^^ with your game's current version.
```xml
<ext __type="str">2024100900</ext>
```
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
<services __type="str">http://localhost:8083</services>
```
@@ -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.
<img src="/img/konami/iidx/common/firstlaunch/1.webp">
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.
<img src="/img/konami/iidx/common/firstlaunch/2.webp">
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.
<img src="/img/konami/iidx/common/firstlaunch/3.webp">
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`.
<img src="/img/konami/iidx/common/firstlaunch/4.webp">
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`.
<img src="/img/konami/iidx/common/firstlaunch/5.webp">
<img src="/img/konami/iidx/common/firstlaunch/6.webp">
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`.
<img src="/img/konami/iidx/common/firstlaunch/7.webp">
Select `GAME MODE`.
<img src="/img/konami/iidx/common/firstlaunch/3.webp">
!!! 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"
@@ -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.<br>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.
+2
View File
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/jubeat/avenue/logo.webp">
--8<-- "docs/games/konami/jubeat/common/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/jubeat/beyondtheavenue/logo.webp">
--8<-- "docs/games/konami/jubeat/common/setup.md"
+190
View File
@@ -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.
<img src="/img/konami/jubeat/common/firstlaunch/backup_data_error.webp">
Press your `Test` key to initialize the backup data, another message with the same error will pop up.
Press your `Test` key again to open the service menu.
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`.
<img src="/img/konami/jubeat/common/firstlaunch/shop_settings.webp">
You will need to set a shop name.
- Name your shop to whatever you'd like. Again, navigation instructions are on the screen.
- Press the `EXIT` button.
Then, set the shop area to whatever region you'd like.
Select `SAVE AND EXIT` then `EXIT`.
Finally, restart the game.
!!! success "You're all done! The game should load up properly now"
## Help
--8<-- "docs/snippets/common/help.md"
+2
View File
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/jubeat/festo/logo.webp">
--8<-- "docs/games/konami/jubeat/common/setup.md"
+110
View File
@@ -0,0 +1,110 @@
<img class="header-logo" src="/img/konami/mfg/logo.webp">
# 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"
+13
View File
@@ -0,0 +1,13 @@
<img class="header-logo" src="/img/konami/mfg/logo.webp">
# 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**
+152
View File
@@ -0,0 +1,152 @@
<img class="header-logo" src="/img/konami/museca/logo.webp">
# 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.
<img src="/img/konami/museca/backupdata.webp">
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"
@@ -0,0 +1,66 @@
<img class="header-logo" src="/img/konami/museca/logo.webp">
# 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` (`<spec>B</spec>` 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.
@@ -0,0 +1,91 @@
<img class="header-logo" src="/img/konami/nostalgia/forte/logo.webp">
# 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.
<img src="/img/common/audio_24_441.webp">
!!! 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`.
<img src="/img/konami/nostalgia/common/1.webp">
## Configuring Your Tools
!!! tip ""
Now that you have your files ready, open up your `.bat` file in your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) and edit it with your desired parameters, for the purpose of this guide we will demonstrate 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.
<img src="/img/konami/nostalgia/common/2.webp">
!!! 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.
<img src="/img/konami/nostalgia/common/3.webp">
!!! tip ""
The final menu we must deal with is `VIRTUAL COIN`, enter the menu and select `OPERATION SETTINGS` as seen below.
<img src="/img/konami/nostalgia/common/4.webp">
!!! 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.
<img src="/img/konami/nostalgia/common/5.webp">
!!! 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.
<img src="/img/konami/nostalgia/common/6.webp">
!!! 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`.
<img src="/img/konami/nostalgia/common/6.webp">
!!! 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.
@@ -0,0 +1,44 @@
<img class="header-logo" src="/img/konami/nostalgia/forte/logo.webp">
# 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.
+91
View File
@@ -0,0 +1,91 @@
<img class="header-logo" src="/img/konami/nostalgia/op2/logo.webp">
# 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.
<img src="/img/common/audio_24_441.webp">
!!! 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`.
<img src="/img/konami/nostalgia/common/8.webp">
## Configuring Your Tools
!!! tip ""
Now that you have your files ready, open up your `.bat` file in your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) and edit it with your desired parameters, for the purpose of this guide we will demonstrate 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.
<img src="/img/konami/nostalgia/common/2.webp">
!!! 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.
<img src="/img/konami/nostalgia/common/3.webp">
!!! tip ""
The final menu we must deal with is `VIRTUAL COIN`, enter the menu and select `OPERATION SETTINGS` as seen below.
<img src="/img/konami/nostalgia/common/4.webp">
!!! 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.
<img src="/img/konami/nostalgia/common/5.webp">
!!! 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.
<img src="/img/konami/nostalgia/common/6.webp">
!!! 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`.
<img src="/img/konami/nostalgia/common/6.webp">
!!! 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.
@@ -0,0 +1,46 @@
<img class="header-logo" src="/img/konami/nostalgia/op2/logo.webp">
# 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.
+124
View File
@@ -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"
@@ -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.
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/popn/kaimei_riddles/logo.webp">
--8<-- "docs/games/konami/popn/common/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/popn/kaimei_riddles/logo.webp">
--8<-- "docs/games/konami/popn/common/troubleshooting.md"
+2
View File
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/popn/peace/logo.webp">
--8<-- "docs/games/konami/popn/common/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/popn/peace/logo.webp">
--8<-- "docs/games/konami/popn/common/troubleshooting.md"
+2
View File
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/popn/unilab/logo.webp">
--8<-- "docs/games/konami/popn/common/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/popn/unilab/logo.webp">
--8<-- "docs/games/konami/popn/common/troubleshooting.md"
+2
View File
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/popn/usaneko/logo.webp">
--8<-- "docs/games/konami/popn/common/setup.md"
@@ -0,0 +1,2 @@
<img class="header-logo" src="/img/konami/popn/usaneko/logo.webp">
--8<-- "docs/games/konami/popn/common/troubleshooting.md"
@@ -0,0 +1,70 @@
<img class="header-logo" src="/img/konami/reflecbeat/reflesia/logo.webp">
# 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`.
<img src="/img/konami/reflecbeat/reflesia/data.webp">
## Configuring Your Tools
!!! tip ""
Now that you have your files ready, open up your `.bat` file in your desired text editor (we're using [Notepad++](https://notepad-plus-plus.org/)) and edit it with your desired parameters, for the purpose of this guide we will demonstrate both a local network configuration and an online example below with SpiceTools, skip to whichever you're in need of accordingly and please keep in mind you can add whatever additional parameters you desire.
!!! warning "If you're not using SpiceTools:"
The overall structure of your .bat file will differ from the guide, namely the initialization of SpiceTools won't be present and potential parameters may differ. As stated above, make sure to check the documentation of your tools to ensure you're using the correct parameters for your needs.
## Configuring for a Local Network
!!! tip ""
For our local network configuration example, on a single line in the `.bat` file we're going to type `spice.exe -ea -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.
@@ -0,0 +1,47 @@
<img class="header-logo" src="/img/konami/reflecbeat/reflesia/logo.webp">
# 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.

Some files were not shown because too many files have changed in this diff Show More