mirror of
https://github.com/yxrei/bemani-guide.git
synced 2024-11-23 22:41:03 +01:00
Merge pull request #10 from scrib-bler/feature/chunithm
Merge Scribblers Chunithm Sun Plus guide
This commit is contained in:
yurei
GitHub
commit
34b40d3800
257
docs/games/chunithmsunplus/controllers.md
Normal file
257
docs/games/chunithmsunplus/controllers.md
Normal file
@ -0,0 +1,257 @@
|
||||
# CHUNITHM SUN PLUS Controller Setup
|
||||
|
||||
<img src="/img/chunithmsunplus/sunplus.png">
|
||||
|
||||
## How Controller Input works with segatools
|
||||
|
||||
!!! note "segatools:"
|
||||
`segatools`, the loader used to run CHUNITHM, does not come with any built-in controller support. By default it will only accept keyboard input.
|
||||
The controller you plan on using with the game should also be provided with IO files, in the form of `*.dll`. If unsure, you can check the support section of the site you purchased your controller from, or email the vendor directly.
|
||||
Alternate options for the most common controllers are listed below.
|
||||
These `dll` files should be copied to your `\App\bin\` folder, alongside `chusanApp.exe`, and referenced in your `segatools.ini`.
|
||||
|
||||
!!! tip ""
|
||||
The input files you wish to use need to be referenced in the `[chuniio]` section of `segatools.ini`.
|
||||
If the `dll` files you plan to use consist of 2 files, with names ending in `_x86.dll` and `_x64.dll`, uncomment the `path32` and `path64` lines by removing the `;` from the beginning. Add your file names after the `=`.
|
||||
|
||||
<img src="/img/chunithmsunplus/chuniio_twodll.png">
|
||||
|
||||
!!! tip ""
|
||||
If the input file you wish to use consists of a single `*.dll`, uncomment only the `path` line, and enter the dll name after the `=`.
|
||||
|
||||
<img src="/img/chunithmsunplus/chuniio_onedll.png">
|
||||
|
||||
!!! note "Controllers:"
|
||||
Below is a quick introduction and setup guide for the commonly used input methods.
|
||||
|
||||
***
|
||||
|
||||
## Keyboard
|
||||
|
||||
!!! tip ""
|
||||
Keyboard is the default input method, and while not recommended for playing the game, it is useful for testing purposes.
|
||||
The default layout uses `SDFGHJKL` for the slider input, and `Space Bar` for the AIRs.
|
||||
If you wish to change the default keybinds, an explanation for how to set these is included above the `[io3]` section in your `segatools.ini`.
|
||||
|
||||
***
|
||||
|
||||
## Brokenithm
|
||||
|
||||
!!! note "Brokenithm:"
|
||||
Brokenithm allows you to use an Android tablet or iPad as a controller for CHUNITHM. It uses the bottom half of the screen as the touch slider, and sliding from the bottom section into the top section of the screen activates the AIR sensors.
|
||||
|
||||
***
|
||||
|
||||
### Brokenithm Android
|
||||
|
||||
!!! tip ""
|
||||
Download the latest version of [Brokenithm-Android](https://github.com/tindy2013/Brokenithm-Android) from the [releases section](https://github.com/tindy2013/Brokenithm-Android/releases). Copy the `app-release.apk` to your Android device and install it.
|
||||
|
||||
Download the latest version of [Brokenithm-Android-Server](https://github.com/tindy2013/Brokenithm-Android-Server) from the [releases section](https://github.com/tindy2013/Brokenithm-Android-Server/releases) and extract just the `brokenithm_server.exe` to your `\App\bin\` folder.
|
||||
|
||||
Download the latest version of the [Brokenithm-Evolved](https://gitea.tendokyu.moe/Dniel97/Brokenithm-Evolved/) IO dll files from the [releases tab](https://gitea.tendokyu.moe/Dniel97/Brokenithm-Evolved/releases). Extract the 3 dll files to your `\App\bin\` folder.
|
||||
|
||||
Open your `segatools.ini` with a text editor, and modify the `[aimeio]` section as shown.
|
||||
```ini
|
||||
[aimeio]
|
||||
; Uncomment this if you have custom (x64) aime implementation.
|
||||
; Leave empty if you want to use Segatools built-in keyboard input.
|
||||
path=aime_brokenithm.dll
|
||||
```
|
||||
Modify the `[chuniio]` section as shown.
|
||||
```ini
|
||||
[chuniio]
|
||||
; Uncomment this if you have custom chuniio implementation comprised of a single 32bit DLL.
|
||||
; (will use chu2to3 engine internally)
|
||||
;path=
|
||||
|
||||
; Uncomment both of these if you have custom chuniio implementation comprised of two DLLs.
|
||||
; x86 chuniio to path32, x64 to path64. Both are necessary.
|
||||
path32=brokenithm_x86.dll
|
||||
path64=brokenithm_x64.dll
|
||||
```
|
||||
Run the `brokenithm_server.exe` you extracted previously. A CMD window should open, with a message that it is waiting for a device on port 52468.
|
||||
Open the Brokenithm App on your Android device. At the top right, in the Address box, enter your PCs local IP address and then press the start button.
|
||||
You can now run your game via the `start.bat` as normal.
|
||||
|
||||
#### Automatically launching the Brokenithm server
|
||||
|
||||
!!! tip ""
|
||||
If you want the `brokenithm_server.exe` to automatically run when launching the game, you will need to modify `start.bat`.
|
||||
Open `start.bat` with a text editor, and add a new line containing `start /min brokenithm_server` above the existing `start /min inject_x64 ...` line, as shown below.
|
||||
```bat
|
||||
@echo off
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
start /min brokenithm_server
|
||||
start /min inject_x64 -d -k chusanhook_x64.dll amdaemon.exe -c config_common.json config_server.json config_client.json config_cvt.json config_sp.json config_hook.json
|
||||
inject_x86 -d -k chusanhook_x86.dll chusanApp.exe
|
||||
taskkill /f /im amdaemon.exe > nul 2>&1
|
||||
|
||||
echo.
|
||||
echo Game processes have terminated
|
||||
pause
|
||||
```
|
||||
This will only work if you copied the `brokenithm_server.exe` file to your `\App\bin` folder.
|
||||
|
||||
#### Slider Lights
|
||||
|
||||
!!! tip ""
|
||||
By default, the Brokenithm Server runs in `UDP` mode. This is done to decrease latency when connected over WiFi, however it does not send any lighting data to the tablet. The server also supports a `TCP` mode, which does send lighting data.
|
||||
|
||||
To run the Brokenithm Server in TCP mode, we need to start it with the ` -T` flag.
|
||||
|
||||
Navigate to the folder that contains your `brokenithm_server.exe`, click on the Address Bar at the top of the folder, type `CMD`, and hit enter. A Command Prompt window should open.
|
||||
In the Command Prompt window, type `brokenithm_server -T` and hit enter.
|
||||
|
||||
On your Android device, find the button labeled `UDP` at the top-center of the Brokenithm application. Tap the button to toggle to `TCP` mode. You should now be able to connect, using your PCs local IP, as described above.
|
||||
|
||||
If you are running the Brokenithm Server via the `start.bat` as shown in the previous step, simply add ` -T` to the end of the brokenithm_server line, as shown below.
|
||||
```bat
|
||||
start /min brokenithm_server -T
|
||||
```
|
||||
|
||||
#### Improving Latency
|
||||
|
||||
!!! tip ""
|
||||
As WiFi isn't the best for latency, it is preferable to run Brokenithm with your Android device tethered to your PC. This will require enabling Developer options, and USB debugging on your tablet. As this process varies by device, instructions are not included here.
|
||||
|
||||
Once you have USB debugging enabled, you will need to download and extract the [Android SDK Platform Tools](https://developer.android.com/tools/releases/platform-tools) to somewhere on your PC.
|
||||
Navigate to the folder you extracted the tools too, click in the Address bar, type `CMD` and hit enter to open a Command Prompt window.
|
||||
|
||||
Make sure your Android device is connected and that USB debugging is enabled.
|
||||
|
||||
In the Command Prompt window, type one of the following commands, depending on which mode you plan to run the server in.
|
||||
|
||||
**TCP**
|
||||
```bat
|
||||
adb reverse tcp:52468 tcp:52468
|
||||
```
|
||||
|
||||
**UDP**
|
||||
```bat
|
||||
adb reverse udp:52468 udp:52468
|
||||
```
|
||||
Start your `brokenithm_server.exe`.
|
||||
Open Brokenithm on your Android device, and in the address bar, change the IP to `0.0.0.0`. Press the start button to connect. You will now be connected via the USB cable.
|
||||
Run the game via the `start.bat` as normal.
|
||||
|
||||
If you extract the `platform-tools` folder to your `\Bin\app\` folder, you can add the following line to your `start.bat` to run this command when the game launches.
|
||||
```bat
|
||||
start /min platform-tools/adb reverse tcp:52468 tcp:52468
|
||||
```
|
||||
This should go above the line which starts the `brokenithm_server.exe`.
|
||||
|
||||
***
|
||||
|
||||
### Brokenithm iOS
|
||||
|
||||
!!! tip ""
|
||||
Running Brokenithm on an iPad requires either a jailbroken device, or another method to install .ipa files. Using [Sideloady](https://sideloadly.io/) is a popular method.
|
||||
|
||||
Before proceeding, you must uninstall the Microsoft Store versions of iTunes and iCloud (if present) then install the non Microsoft Store version from the [iTunes website](https://www.apple.com/itunes/download/win64). This is also covered under the **Important Windows Task** section of the Sideloady website.
|
||||
|
||||
Download the latest version of Brokenithm-iOS from the [redive.estertion.win](https://redive.estertion.win/ipas/Brokenithm-iOS-build-10.ipa) website. Install the .ipa to your device using your preferred method.
|
||||
|
||||
Download the latest version of the Brokenithm-Evolved-iOS server from the [redive.estertion.win](https://redive.estertion.win/ipas/Brokenithm/Brokenithm-Evolved-iOS-v0.3.7z) website.
|
||||
Extract the files to your `\App\bin\` folder. `aimeio.dll` and `chuniio.dll` can be deleted, as they are not required.
|
||||
|
||||
Download the latest version of the [Brokenithm-Evolved](https://gitea.tendokyu.moe/Dniel97/Brokenithm-Evolved/) IO dll files from the [releases tab](https://gitea.tendokyu.moe/Dniel97/Brokenithm-Evolved/releases). Extract the 3 dll files to your `\App\bin\` folder.
|
||||
|
||||
Open your `segatools.ini` with a text editor, and modify the `[aimeio]` section as shown.
|
||||
```ini
|
||||
[aimeio]
|
||||
; Uncomment this if you have custom (x64) aime implementation.
|
||||
; Leave empty if you want to use Segatools built-in keyboard input.
|
||||
path=aime_brokenithm.dll
|
||||
```
|
||||
Modify the `[chuniio]` section as shown.
|
||||
```ini
|
||||
[chuniio]
|
||||
; Uncomment this if you have custom chuniio implementation comprised of a single 32bit DLL.
|
||||
; (will use chu2to3 engine internally)
|
||||
;path=
|
||||
|
||||
; Uncomment both of these if you have custom chuniio implementation comprised of two DLLs.
|
||||
; x86 chuniio to path32, x64 to path64. Both are necessary.
|
||||
path32=brokenithm_x86.dll
|
||||
path64=brokenithm_x64.dll
|
||||
```
|
||||
Run the `Brokenithm-Evolved-iOS.exe` you extracted previously. A CMD window should open, with a message that it is waiting for a device.
|
||||
Open the Brokenithm App on your iPad, and connect it to your PC via a USB cable.
|
||||
You can now run your game via the `start.bat` as normal.
|
||||
|
||||
!!! note "Latency"
|
||||
As Brokenithm for iOS only connects via USB connection, there is no need to configure any extra network settings to improve latency.
|
||||
|
||||
#### Automatically launching the Brokenithm server
|
||||
|
||||
!!! tip ""
|
||||
If you want the `Brokenithm-Evolved-iOS.exe` to automatically run when launching the game, you will need to modify `start.bat`.
|
||||
Open `start.bat` with a text editor, and add a new line containing `start /min Brokenithm-Evolved-iOS` above the existing `start /min inject_x64 ...` line, as shown below.
|
||||
```bat
|
||||
@echo off
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
start /min Brokenithm-Evolved-iOS
|
||||
start /min inject_x64 -d -k chusanhook_x64.dll amdaemon.exe -c config_common.json config_server.json config_client.json config_cvt.json config_sp.json config_hook.json
|
||||
inject_x86 -d -k chusanhook_x86.dll chusanApp.exe
|
||||
taskkill /f /im amdaemon.exe > nul 2>&1
|
||||
|
||||
echo.
|
||||
echo Game processes have terminated
|
||||
pause
|
||||
```
|
||||
This will only work if you copied the `Brokenithm-Evolved-iOS.exe` file to your `\App\bin` folder.
|
||||
|
||||
***
|
||||
|
||||
## Tasoller
|
||||
|
||||
!!! note "Tasoller:"
|
||||
The Tasoller is an arcade accurate controller, produced by DJ-DAO.
|
||||
Out of the box, the Tasoller will only offer keyboard input, with no lighting support. To get full compatability with CHUNITHM, you will need to install [custom firmware](https://pixeldrain.com/u/DajSPEoa). Instructions on how to install the firmware are included in the archive.
|
||||
|
||||
!!! danger "Warning:"
|
||||
The Tasoller custom firmware is only compatabile with controllers running the DJ-DAO 2.0 firmware. If your controller was purchased after January 2022, it should have shipped with the update already applied.
|
||||
If your Tasoller was purchased before 2022, and is still using the original firmware it shipped with, you will need to first update to 2.0 by following the guide on [DJ-DAO's website](https://www.dj-dao.com/en/support/11.html).
|
||||
Once you've updated your controller to the DJ-DAO 2.0 firmware, you can follow the instructions included with the Custom Firmware as normal.
|
||||
|
||||
!!! tip ""
|
||||
DJ-DAO doesn't directly provide any input assistance for customers wanting to play on data. Thankfully there are community members creating open source alternatives.
|
||||
There are two up to date drivers available for the Tasoller, with full support for Dniel97's segatools fork. Functionally these work the same as eachother, with the only difference being the language they are written in.
|
||||
|
||||
[chuniio-tasoller](https://gitea.tendokyu.moe/Scribbler/chuniio-tasoller) written in `zig`.
|
||||
[chuniio-rs](https://gitea.tendokyu.moe/beerpsi/chuniio-rs) written in `rust`.
|
||||
|
||||
Head to the `Releases` tab for your chosen driver, and download the latest package. For `chuniio-rs` make sure you download the `chusan.zip`.
|
||||
Extract the `*.dll` files to your `\App\bin\` folder.
|
||||
Make the required changes to `segatools.ini`, as shown in the `Configuration` section of the readme for the driver you have downloaded.
|
||||
|
||||
***
|
||||
|
||||
## YubiDeck
|
||||
|
||||
!!! note "YubiDeck:"
|
||||
The YubiDeck is an arcade accurate controller, produced by ZhouSensor and sold by YubiParts. It also includes a built in Aime card scanner.
|
||||
|
||||
!!! tip ""
|
||||
YubiDeck firmware updates are provided in the support section of the YubiParts website. Unfortunately the IO driver they provide is no longer available for download.
|
||||
|
||||
An open source alternative is available, [chuniio-yubideck](https://gitea.tendokyu.moe/beerpsi/chuniio-yubideck).
|
||||
Head to the `Releases` tab and download the latest package. Extract the `*.dll` files to your `\App\bin\` folder.
|
||||
Make the required changes to `segatools.ini`, as shown in the `Configuration` section of the chuniio-yubideck readme.
|
||||
|
||||
If you want to make use of the built-in card scanner, add the following line to the `[aimeio]` section in `segatools.ini`.
|
||||
```ini
|
||||
path=aimeio_yubideck.dll
|
||||
```
|
||||
|
||||
***
|
||||
|
||||
## Arcade Panels and other Controllers
|
||||
|
||||
!!! tip ""
|
||||
If you're interested in connecting a real cabinet Slider and Airs, or possibly even DIYing your own controller, the [Cons&Stuff](https://consandstuff.github.io/) website and Discord community is a great place to start!
|
||||
42
docs/games/chunithmsunplus/networks.md
Normal file
42
docs/games/chunithmsunplus/networks.md
Normal file
@ -0,0 +1,42 @@
|
||||
# CHUNITHM SUN PLUS Network Setup
|
||||
|
||||
<img src="/img/chunithmsunplus/sunplus.png">
|
||||
|
||||
## Why would you want to use a server?
|
||||
|
||||
!!! tip ""
|
||||
While CHUNITHM can be run offline, connecting to a server gives you the ability to create a profile, save scores, and unlock additional features.
|
||||
|
||||
## Self hosted local servers
|
||||
|
||||
!!! tip ""
|
||||
If you wish to run the game locally, but with the ability to create and save a profile, you can run a server on the same computer you are playing the game on. This server will need to be running before you launch the game, however it can be shut down when you are no longer playing.
|
||||
|
||||
These 2 projects are still in active development, and as such, any provided setup instructions are likely to become outdated rather quickly.
|
||||
|
||||
Please refer to the included setup instructions on each projects respective web page.
|
||||
|
||||
### ARTEMiS
|
||||
|
||||
!!! note ""
|
||||
[ARTEMiS](https://gitea.tendokyu.moe/Hay1tsme/artemis) - A network service emulator for games running SEGA'S ALL.NET service, and similar.
|
||||
|
||||
!!! tip ""
|
||||
ARTEMiS is a network service emulator for various ALL.NET games. It runs on Python.
|
||||
While initial setup is more involved than AquaDX, it offers a more complete emulation of the ALL.NET service.
|
||||
ARTEMiS also uses your own game files to build its database, meaning any new content updates can just be imported to the server yourself, without having to wait for someone else to provide an update.
|
||||
|
||||
### AquaDX
|
||||
|
||||
!!! note ""
|
||||
[AquaDX](https://github.com/hykilpikonna/AquaDX) - Multipurpose game server powered by Spring Boot, for ALL.Net-based games
|
||||
|
||||
!!! tip ""
|
||||
AquaDX is a game server targetting SEGA Rhythm Games specifically. It runs on Java.
|
||||
Initial setup for AquaDX is a little easier, as more of the setup is provided by the developers.
|
||||
AquaDX does not currently support importing your own game data, so you will need to head back to the github page to download and updated build if new content becomes available.
|
||||
|
||||
## Online Hosted Servers
|
||||
|
||||
!!! tip ""
|
||||
There are a few online hosted servers that support Chunithm SUN PLUS, however they are all currently invite only. Ask your friends where they play, and maybe they'll invite you!
|
||||
97
docs/games/chunithmsunplus/problems.md
Normal file
97
docs/games/chunithmsunplus/problems.md
Normal file
@ -0,0 +1,97 @@
|
||||
# CHUNITHM SUN PLUS Common Problems/Tips
|
||||
|
||||
<img src="/img/chunithmsunplus/sunplus.png">
|
||||
|
||||
### I'm having audio issues
|
||||
|
||||
!!! tip ""
|
||||
CHUNITHM expects a specific Default Format from your sound card.
|
||||
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 `16bit, 48000 Hz (DVD Quality)` and check both of the options inside `Exclusive Mode` as pictured.
|
||||
|
||||
By default, CHUNITHM uses Exclusive Audio. This means you won't be able to hear any other sounds from your PC while the game is running. A Shared Audio mode can be enabled via the chusanApp.exe Patcher website, though it should be noted that this can increase audio latency.
|
||||
|
||||
<img src="/img/gen/sega480.png">
|
||||
|
||||
### Some of my installed Songs and Events aren't visible in game
|
||||
|
||||
!!! tip ""
|
||||
Some content in CHUNITHM is locked behind event maps, or other requirements, such as playing the same song on another SEGA game, such as maimai.
|
||||
We can force unlock this content, making it always available in game.
|
||||
|
||||
Download the [Chunithm_Unlocker](https://pixeldrain.com/u/Ccttn8u9) powershell script, and place it in your game folder, next to the `App` and `Option` folders.
|
||||
Right click the file, and select `Run with Powershell`.
|
||||
Once the script has scanned your game files, it will present you with several options for unlocking different types of content. You can either unlock everything, or only unlock specific things (such as songs), leaving the other content to be unlocked via regular gameplay.
|
||||
|
||||
!!! note ""
|
||||
The Chunithm_Unlocker script creates backups of any file it modifies, and has options to restore the files back to their original state. Please note that certain content (such as character unlocks) are sent to the server and saved to your profile, so reverting the unlock in your game files won't always relock that content for your game profile.
|
||||
|
||||
### My game takes a long time to boot
|
||||
|
||||
!!! tip ""
|
||||
The game files for CHUNITHM consists of thousands of small .xml files, and Windows Defender is known to spend a long time scanning through them during game boot up.
|
||||
One way to massively speed up boot times is to add the entire game folder as a Windows Defender Exception.
|
||||
|
||||
!!! danger "Warning:"
|
||||
Doing this will prevent Defender from scanning your game folder for viruses. Only do this if you trust the source of your data.
|
||||
|
||||
!!! tip ""
|
||||
Open `Virus & threat protection`.
|
||||
Under `Virus & threat protection settings` click the `Manage Settings` button.
|
||||
Scroll down to `Exclusions` and click on `Add or remove exclusions`.
|
||||
Click the `Add an exclusion` button, select the `folder` option, navigate to the base of your game install and click `Select Folder`.
|
||||
|
||||
<img src="/img/chunithmsunplus/defender.png">
|
||||
|
||||
### My game crashes when I alt-tab out of fullscreen
|
||||
|
||||
!!! tip ""
|
||||
As the game is intended to run on dedicated hardware, it doesn't like to be minimised.
|
||||
One work-around for this is to use [DXVK](https://github.com/doitsujin/dxvk/) to run the game with Vulkan rather than Direct3D. This has the added benefit of smoother frame rates for some hardware configurations.
|
||||
|
||||
Download the latest version of DXVK from the [releases tab](https://github.com/doitsujin/dxvk/releases). This will be a `dxvk-x.x.tar.gz` file. Open the file with `7zip` and navigate to the `x32` folder.
|
||||
Extract the `d3d9.dll` file to your `\CHUNITHMSUNPLUS\App\bin\` folder, alongside your `chusanApp.exe`.
|
||||
You should now be able to tab out of fullscreeen, leaving the game running.
|
||||
|
||||
!!! note "Additional DXVK configuration:"
|
||||
DXVK has other options that can be changed by adding a `dxvk.conf` file next to the `d3d9.dll` file. The most common use for this is to add an FPS counter to the game.
|
||||
If you wish to have an FPS counter, create a `dxvk.conf` file and open it with Notepad++. Add the following line.
|
||||
```json
|
||||
dxvk.hud = fps
|
||||
```
|
||||
You can learn more about the available options at the [DXVK Configuration Wiki page](https://github.com/doitsujin/dxvk/wiki/Configuration).
|
||||
|
||||
!!! note "Controller inputs whilst minimised:"
|
||||
As the game was never designed to be minimised, it will not ignore inputs when not focused. This means any controller inputs will be accepted, so try not to lean on your slider while tabbed out!
|
||||
The most common issue this causes is when typing the number `1` with the game minimised, as by default this will enter the test menu. If you were mid-credit, your scores will be lost.
|
||||
If you wish to change the keyboard keys assigned to the Test, Service and Coin buttons, this can be configured in the `[io3]` section of `segatools.ini`.
|
||||
|
||||
### My game occasionally drops frames/stutters
|
||||
|
||||
!!! tip ""
|
||||
While frame drops can be caused by running the game on under-powered hardware, it is also common for this to happen when running on hardware that is too over-powered!
|
||||
As a lot of the game consists of mostly 2D assets, your GPU is unlikely to be pushed very hard. Modern GPUs attempt to be as energy efficient as possible by changing power-states when under-utilised. If these power-state changes happen mid song, this can lead to slight frame drops and stutters.
|
||||
This can be solved by forcing the GPU to stay in its maximum power-state while the game is running.
|
||||
|
||||
!!! note "NVIDIA:"
|
||||
In the Windows Taskbar Icon Tray, right click the NVIDIA Settings icon, and select `NVIDIA Control Panel`.
|
||||
On the left, select `Manage 3D settings`.
|
||||
On the right, click on the `Program Settings` tab.
|
||||
Click the add button, and navigate to your `\CHUNITHMSUNPLUS\App\bin\` folder, and select `chusanApp.exe`.
|
||||
In the `Feature` list, scroll down to `Power management mode` and select `Prefer maximum performance`.
|
||||
Save your settings and close `NVIDIA Control Panel`. Your game will now always run in the highest power-state!
|
||||
|
||||
<img src="/img/chunithmsunplus/nvidiaperf.png">
|
||||
|
||||
!!! note "AMD:"
|
||||
In the Windows Taskbar Icon Tray, right click the `AMD Software` icon, and select `Open AMD Software: Adrenalin Edition`.
|
||||
At the top of the window, select the `Gaming` tab.
|
||||
If `chusanApp` isn't already listed in your Games Library, click on the 3 dots at the top right of the window, then click on `Add A Game...`. Navigate to your `\CHUNITHMSUNPLUS\App\bin\` folder, and select `chusanApp.exe`.
|
||||
Select `chusanApp` from the Games Library.
|
||||
Under the `Graphics` section, set the `Graphics Profile` to `Performance`.
|
||||
|
||||
<img src="/img/chunithmsunplus/amdperf.png">
|
||||
|
||||
!!! note "AMD, continued:"
|
||||
While the above will help to reduce any issues, it's not quite the same as the `Power management mode` offered by NVIDIA.
|
||||
A similar configuration can be achieved by adding a custom Overlocking Game Profile in the `Performance` > `Tuning` section of the AMD Software, and increasing the minimum `GPU Frequency` for each `State`.
|
||||
As these settings will vary wildly from one GPU to another, and as overclocking comes with its own risks, specifics for this won't be included on this page.
|
||||
220
docs/games/chunithmsunplus/setup.md
Normal file
220
docs/games/chunithmsunplus/setup.md
Normal file
@ -0,0 +1,220 @@
|
||||
# CHUNITHM SUN PLUS
|
||||
|
||||
<img src="/img/chunithmsunplus/sunplus.png">
|
||||
|
||||
!!! note "Author Note:"
|
||||
Last updated: 08.02.2024 (Currently using `SDHD 2.16.00`)
|
||||
|
||||
For hex edits: Go to the CHUNITHM section of your prefered patcher host, or use the Offline Patcher included with the unpacked binaries.
|
||||
|
||||
!!! 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.
|
||||
|
||||
This guide will use [Dniel97's segatools](https://gitea.tendokyu.moe/Dniel97/segatools/releases), which is a fork of segatools that gets regular updates and will be needed to get the game running.
|
||||
|
||||
### Getting Started
|
||||
|
||||
!!! tip ""
|
||||
Before we even touch the game, there are some prerequisites we should install to minimise issues.
|
||||
|
||||
First off we should make sure our [Microsoft Visual C++ Runtimes](https://github.com/abbodi1406/vcredist) are up to date.
|
||||
|
||||
Grab the latest version of the AIO installer from the [releases tab](https://github.com/abbodi1406/vcredist/releases). Make sure to get the version that installs both x86 and x64 versions.
|
||||
|
||||
Run the downloaded `VisualCppRedist_AIO_x86_x64.exe` and press next. The installer will proceed to download and install the required files. This may take some time.
|
||||
|
||||
<img src="/img/chunithmsunplus/AIO_finished.png">
|
||||
|
||||
!!! tip ""
|
||||
Next we should make sure we have all the required DirectX files.
|
||||
|
||||
Download the DirectX Redist (June 2010) from the [Microsoft Website](https://www.microsoft.com/en-gb/download/details.aspx?id=8109).
|
||||
|
||||
Run the downloaded `directx_Jun2010_redist.exe` and accept the License Agreement. You will be asked to pick a location to extract the installer too, it's recommended you create a new folder somewhere as it will extract a lot of files.
|
||||
|
||||
Go to the folder you extracted the installer too, find the `DXSETUP.exe` and run it. Accept the License Agreement and start the installation. Once it's complete, press Finish.
|
||||
|
||||
You can delete the folder you extracted the installer too once the install is complete.
|
||||
|
||||
<img src="/img/chunithmsunplus/redist_finished.png">
|
||||
|
||||
### Verifying your Game Data
|
||||
|
||||
!!! tip ""
|
||||
SEGA games are generally distributed as a base game folder and sequential update folders. For SUN PLUS, this will be a base `SDHD 2.15.00` and an `SDHD 2.16.00` update.
|
||||
|
||||
<img src="/img/chunithmsunplus/1.png">
|
||||
|
||||
!!! tip ""
|
||||
The base game folder should contain an `amfs`, `App` and `Option` folder.
|
||||
|
||||
<img src="/img/chunithmsunplus/2.png">
|
||||
|
||||
!!! tip ""
|
||||
The update folder should only contain an `App` folder.
|
||||
|
||||
!!! note "Other Data Formats:"
|
||||
SEGA data is also commonly distributed as single `.app` and `.opt` files. These files are useful for archival purposes, but are not required to run the game. Always download the unpacked data for home use.
|
||||
|
||||
### Setting Up the Game Data
|
||||
|
||||
!!! danger "Warning:"
|
||||
segatools is currently unable to be run from the `E:\` drive. Please ensure your data is setup on another drive letter.
|
||||
|
||||
!!! tip ""
|
||||
Choose a location for your game data, for example, `C:\CHUNITHMSUNPLUS\`.
|
||||
Copy/move the `amfs`, `App` and `Option` folders from `CHUNITHM SUN PLUS (SDHD 2.15.00)` to this new folder.
|
||||
Copy the `App` folder from `CHUNITHM SUN PLUS (SDHD 2.16.00)` to your new game folder. When asked, choose to replace the existing files with the newly copied files.
|
||||
|
||||
<img src="/img/chunithmsunplus/replace.png">
|
||||
|
||||
!!! tip ""
|
||||
Next we need to replace the protected executables with copys that will run on a regular PC.
|
||||
Obtain unpacked copies of `chusanApp.exe` and `amdaemon.exe`. If these weren't provided with your data, join the [Discord](https://discord.gg/cZRUmEPK78) for assistance.
|
||||
Copy `chusanApp.exe` and `amdaemon.exe` to the `App\bin\` folder of your game data. When asked, overwrite the existing files.
|
||||
|
||||
### Installing segatools
|
||||
|
||||
!!! note "segatools:"
|
||||
`segatools` is a loader and hardware emulator for SEGA arcade games. It will allow us to launch the game, as well as configure inputs and network settings. More information can be found at the [segatools gitea page](https://gitea.tendokyu.moe/Dniel97/segatools).
|
||||
|
||||
!!! tip ""
|
||||
Download the latest version of segatools from [the release tab](https://gitea.tendokyu.moe/Dniel97/segatools/releases) of the segatools page. This will be a file named `segatools.zip`.
|
||||
As segatools supports many games, the `segatools.zip` file will contain several more zip files. For CHUNITHM SUN PLUS, we will need to open the `chusan.zip`.
|
||||
|
||||
<img src="/img/chunithmsunplus/chusanzip.png">
|
||||
|
||||
!!! tip ""
|
||||
Copy the files from `chusan.zip` to your `App/bin` folder.
|
||||
Here is how your `App/bin` folder should look after everything has been copied correctly.
|
||||
|
||||
<img src="/img/chunithmsunplus/appbincomplete.png">
|
||||
|
||||
### Configuring segatools.ini
|
||||
|
||||
!!! tip ""
|
||||
The configuration information for segatools is all stored within `segatools.ini`.
|
||||
Open up `segatools.ini` with a text editor of your choice. We'll be using [Notepad++](https://notepad-plus-plus.org/).
|
||||
`segatools.ini` is seperated into several sections, indicated by the section name in `[square brackets]`.
|
||||
Most options will have comments describing their function and how to configure them. We will go over the most important ones below.
|
||||
|
||||
!!! tip ""
|
||||
The `[vfs]` section contains paths to important game files. You can use either relative or absoloute paths, however if your path name has spaces in it, you must wrap the path in "quotations marks".
|
||||
|
||||
`amfs=` should point to the `amfs` folder, which should be in the root of your game folder. This folder should contain an ICF1 file.
|
||||
`option=` should point to the `Option` folder, which contains game data update folders, with A**XXX** names. This should also be in the root of your game folder, next to `amfs`.
|
||||
`appdata=` is a new folder created for the games appdata. You can either create a folder somewhere to point this too, or simply enter `appdata=appdata` to have a folder created within your `App/bin` folder.
|
||||
|
||||
The example image below was created with a base game folder of `C:\CHUNITHMSUNPLUS\`.
|
||||
|
||||
<img src="/img/chunithmsunplus/vfs.png">
|
||||
|
||||
!!! tip ""
|
||||
The `[dns]` section is for connecting to a server, however this will also need to be changed for offline play. In most cases this will be set to your local IPv4 Address.
|
||||
Open your Command Prompt from the start menu, and type `ipconfig`.
|
||||
Find the line that says `IPv4 Address. . . .` and copy the address. This will normally be in the format of **192.168.x.x**, though this may vary.
|
||||
Replace `127.0.0.1` with the IP address you copied from Command Prompt.
|
||||
|
||||
<img src="/img/chunithmsunplus/dns.png">
|
||||
|
||||
!!! tip ""
|
||||
The `[gpio]` section is where we can change between 60 FPS and 120 FPS.
|
||||
For 60 FPS, leave the settings as they are.
|
||||
For 120 FPS, change `dipsw2` and `dipsw3` from `1` to `0`.
|
||||
|
||||
<img src="/img/chunithmsunplus/gpio.png">
|
||||
|
||||
!!! tip ""
|
||||
Save and close `segatools.ini`.
|
||||
|
||||
Before we can test the game offline, we need to open `config_hook.json` in a text editor, and replace its content with the following:
|
||||
```json
|
||||
{
|
||||
"allnet_auth": {
|
||||
"type": "1.0"
|
||||
},
|
||||
"allnet_accounting": {
|
||||
"enable": false
|
||||
},
|
||||
"emoney": {
|
||||
"enable": false
|
||||
}
|
||||
}
|
||||
```
|
||||
This is only needed to boot the game in offline mode, as any correctly configured server should handle the default settings properly.
|
||||
|
||||
!!! danger "Intel 10th Gen and higher:"
|
||||
If your PC has a 10th Gen or newer Intel CPU, there is one last step before running the game.
|
||||
Due to an [issue with OpenSSL](https://www.intel.com/content/www/us/en/developer/articles/troubleshooting/openssl-sha-crash-bug-requires-application-update.html), AMDaemon will fail to launch without the following changes.
|
||||
|
||||
!!! tip ""
|
||||
Find the `start.bat` file in your games bin folder, and open it with a text editor.
|
||||
At the very top of the file, above the `@echo off` line, add the following.
|
||||
```bat
|
||||
set OPENSSL_ia32cap=:~0x20000000
|
||||
```
|
||||
Save and close `start.bat`.
|
||||
|
||||
### Service Menu settings
|
||||
|
||||
!!! note "Service Menu:"
|
||||
Without an English patch the Service Menu will be in Japanese. [Google Lens](https://lens.google/) is a very handy tool for navigating this menu.
|
||||
|
||||
!!! tip ""
|
||||
We are now ready to test our game setup.
|
||||
Start the game by launching `start.bat` from the games `App/bin` folder.
|
||||
Let the game load until it gets to the following screen.
|
||||
|
||||
<img src="/img/chunithmsunplus/asettings.png">
|
||||
|
||||
!!! tip ""
|
||||
Press `F1` on your keyboard to enter the Service Menu (`1` on older versions of segatools).
|
||||
Use `D` and `F` to navigate the menu, and `L` to select an option.
|
||||
|
||||
Navigate to `Game Settings`, the 4th option from the top.
|
||||
|
||||
<img src="/img/chunithmsunplus/gamesettings.png">
|
||||
|
||||
!!! tip ""
|
||||
Select the second option, `reference machine settings` and toggle this setting to `follow the reference machine`, as shown below.
|
||||
|
||||
<img src="/img/chunithmsunplus/followreference.png">
|
||||
|
||||
!!! tip ""
|
||||
Select the last option from the menu, to return to the previous menu.
|
||||
Once back to the main Service Menu, select the 10th option in the list, `closing setting`.
|
||||
|
||||
<img src="/img/chunithmsunplus/closingsetting.png">
|
||||
|
||||
!!! tip ""
|
||||
Select the second option, `hour`, and toggle with `L` until the option `all time` is selected.
|
||||
|
||||
<img src="/img/chunithmsunplus/alltime.png">
|
||||
|
||||
!!! tip ""
|
||||
Select the last option from the menu to return to the previous menu, and then select the last option of the main menu to save your settings and continue booting the game.
|
||||
|
||||
If you get stuck at a `Waiting for Distribution Server` message, shown below, close the game and relaunch. This is caused by dipswitch settings not setting themselves correctly the very first time the game is launched.
|
||||
|
||||
<img src="/img/chunithmsunplus/distserver.png">
|
||||
|
||||
!!! tip ""
|
||||
If everything has been set up correctly, you should now be at the games Attract Screen.
|
||||
`F2` and `F3` will let you insert service/coin credits (`1` and `2` on older versions of segatools).
|
||||
Now we know the game is working, we can move on to configuring controllers and network access.
|
||||
|
||||
!!! note "Dipswitch Settings:"
|
||||
The dipswitch settings, `dipsw1`, `dipsw2` and `dipsw3`, are not set the very first time you run the game, as some system files still need to be created. If the game is running at the wrong frame rate, you may need to exit and re-open the game for these settings to apply.
|
||||
|
||||
### Further Configuration
|
||||
|
||||
!!! note "Controllers:"
|
||||
As there are several different input methods, each with different setup procedures, these will be covered in the [Controllers](controllers.md) section.
|
||||
|
||||
!!! note "Networks:"
|
||||
Local Network options will be covered in the [Networks](networks.md) section.
|
||||
|
||||
!!! warning "Have any other errors?"
|
||||
Check out the [Common Problems/Tips](problems.md) section.
|
||||
BIN
docs/img/chunithmsunplus/1.png
Normal file
BIN
docs/img/chunithmsunplus/1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.7 KiB |
BIN
docs/img/chunithmsunplus/2.png
Normal file
BIN
docs/img/chunithmsunplus/2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.8 KiB |
BIN
docs/img/chunithmsunplus/AIO_finished.png
Normal file
BIN
docs/img/chunithmsunplus/AIO_finished.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 60 KiB |
BIN
docs/img/chunithmsunplus/alltime.png
Normal file
BIN
docs/img/chunithmsunplus/alltime.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
BIN
docs/img/chunithmsunplus/amdperf.png
Normal file
BIN
docs/img/chunithmsunplus/amdperf.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 57 KiB |
BIN
docs/img/chunithmsunplus/appbincomplete.png
Normal file
BIN
docs/img/chunithmsunplus/appbincomplete.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 73 KiB |
BIN
docs/img/chunithmsunplus/asettings.png
Normal file
BIN
docs/img/chunithmsunplus/asettings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
BIN
docs/img/chunithmsunplus/chuniio_onedll.png
Normal file
BIN
docs/img/chunithmsunplus/chuniio_onedll.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.5 KiB |
BIN
docs/img/chunithmsunplus/chuniio_twodll.png
Normal file
BIN
docs/img/chunithmsunplus/chuniio_twodll.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
BIN
docs/img/chunithmsunplus/chusanzip.png
Normal file
BIN
docs/img/chunithmsunplus/chusanzip.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
BIN
docs/img/chunithmsunplus/closingsetting.png
Normal file
BIN
docs/img/chunithmsunplus/closingsetting.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
BIN
docs/img/chunithmsunplus/defender.png
Normal file
BIN
docs/img/chunithmsunplus/defender.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
docs/img/chunithmsunplus/distserver.png
Normal file
BIN
docs/img/chunithmsunplus/distserver.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
BIN
docs/img/chunithmsunplus/dns.png
Normal file
BIN
docs/img/chunithmsunplus/dns.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
docs/img/chunithmsunplus/followreference.png
Normal file
BIN
docs/img/chunithmsunplus/followreference.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
BIN
docs/img/chunithmsunplus/gamesettings.png
Normal file
BIN
docs/img/chunithmsunplus/gamesettings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
BIN
docs/img/chunithmsunplus/gpio.png
Normal file
BIN
docs/img/chunithmsunplus/gpio.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
BIN
docs/img/chunithmsunplus/nvidiaperf.png
Normal file
BIN
docs/img/chunithmsunplus/nvidiaperf.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 69 KiB |
BIN
docs/img/chunithmsunplus/redist_finished.png
Normal file
BIN
docs/img/chunithmsunplus/redist_finished.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
BIN
docs/img/chunithmsunplus/replace.png
Normal file
BIN
docs/img/chunithmsunplus/replace.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
BIN
docs/img/chunithmsunplus/sunplus.png
Normal file
BIN
docs/img/chunithmsunplus/sunplus.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 91 KiB |
BIN
docs/img/chunithmsunplus/vfs.png
Normal file
BIN
docs/img/chunithmsunplus/vfs.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
BIN
docs/img/gen/sega480.png
Normal file
BIN
docs/img/gen/sega480.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
@ -119,7 +119,12 @@ nav:
|
||||
- 'Common Problems/Tips': 'games/musecafinal/problems.md'
|
||||
- 'Hex Edits': 'games/musecafinal/hexedits.md'
|
||||
- SEGA:
|
||||
- 'Coming Soon': '#'
|
||||
- 'CHUNITHM':
|
||||
- 'SUN PLUS':
|
||||
- 'First Time Setup': 'games/chunithmsunplus/setup.md'
|
||||
- 'Controllers': 'games/chunithmsunplus/controllers.md'
|
||||
- 'Networks': 'games/chunithmsunplus/networks.md'
|
||||
- 'Common Problems/Tips': 'games/chunithmsunplus/problems.md'
|
||||
- Error Codes: errorcodes.md
|
||||
- Extras:
|
||||
- 'How to use Patcher Websites': 'extras/patchweb.md'
|
||||
|
||||
Loading…
Reference in New Issue
Block a user