Merge pull request #22 from Keeboy99/feature/Taiko

Taiko Guide

.gitignore

@@ -1,2 +1,3 @@
 .idea
-mkdocs-material/
+mkdocs-material/
+/.vs

docs/extras/streamaudio.md

@@ -103,6 +103,11 @@ FlexASIO is a virtual ASIO service that can redirect output to various backends,
 
 	<img src="/img/flexasio/1.png">
 
+!!! tip "Taiko no Tatsujin Nijiiro"
+	1. Disable `wasapi_shared` in `config.toml`.
+	2. Enable `asio` in `config.toml`.
+	3. Set `asio_driver` to `FlexASIO`.
+
 - To capture audio, you can capture desktop audio as you normally would in OBS.
 
 ### Option 5 - Voicemeeter

docs/games/taikonijiiro/controllers.md

@@ -0,0 +1,64 @@
+# Taiko no Tatsujin Nijiiro Controller Setup
+
+<img src="/img/taikonijiiro/taikonijiiro.png">
+
+## I/O Settings
+!!! tip ""
+    Enter the I/O setup screen by pressing `F1` on the attract screen then using `arrow keys` and `ENTER` navigate to `I/O TEST` -> `TAIKO TEST`. For the best settings copy the image below. If you wish you can adjust these settings to your liking.
+
+<img src="/img/taikonijiiro/io.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.  
+    The default layout uses `DF JK` for the drum input, `P` to insert card, and `ENTER` to add coins.  
+    If you wish to view or change all the default keybinds, you can do so in `keyconfig.toml`.
+
+!!! danger "Warning:"
+    If you use a jp layout keyboard you may need to enable `jp_layout =`, `auto_ime =` in `config.toml`.
+
+***
+
+## Controller
+
+!!! tip ""
+    The setup for both drum and normal controllers is the same.                                                        
+    In `config.toml` set `wait_period =` to `0`.               
+    
+    If you are using a controller that does not use keyboard inputs then you need to
+    set SDL keybinds in `keyconfig.toml`, a list of valid SDL inputs can be found at the bottom of `keyconfig.toml`
+
+!!! danger "Warning:"
+    If you use an analog input for the drums you may need to enable `analog_input =` in `config.toml`.
+
+!!! danger "Warning:"
+    If you using 2 controllers use [JoyToKey](https://joytokey.net/en/) and remove SDL inputs from `keyconfig.toml`.
+
+***
+
+## Card Reader
+
+!!! tip ""
+    The setup for aic pico and acr122u are different.                                                        
+    In `config.toml` set `[card_reader]` to `true`.               
+    
+    If you are using an aic pico update to the latest [firmware](https://github.com/whowechina/aic_pico).                                           
+    Inside `AMFWConfig.ini` change com4 to the port of your aic pico                  
+    
+    If you are using an acr122u or similar.                                                                    
+    Use AkaiiKitsune's [tal-cardreader plugin](https://gitea.farewell.dev/AkaiiKitsune/tal-cardreader)
+
+***
+
+## Arcade Drums and other Controllers
+
+!!! tip ""
+    If you're interested in connecting a real cabinet Drum, or possibly even DIYing your own controller, the [Cons&Stuff](https://consandstuff.github.io/) website and Discord community is a great place to start!

docs/games/taikonijiiro/networks.md

@@ -0,0 +1,35 @@
+# Taiko no Tatsujin Nijiiro Network Setup
+
+<img src="/img/taikonijiiro/taikonijiiro.png">
+
+## Why would you want to use a server?
+
+!!! tip ""
+    While Nijiiro can be run offline, connecting to a server gives you the ability to create a profile, save scores, and unlock additional features.
+
+## Online Hosted Servers
+
+!!! tip ""
+    There are a few online hosted servers that support Nijiiro, however most of them are currently invite only. Ask your friends where they play, and maybe they'll invite you!
+
+### Elara Global Taiko Server
+
+!!! tip ""
+    [EGTS](https://egts.keitannunes.ca/guide) is the only public Nijiiro server that also comes with an omnimix that includes custom songs and songs from other taiko games. 
+
+## 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.  
+
+    Any provided setup instructions are likely to become outdated rather quickly.  
+
+    Please refer to the included setup instructions on each projects respective web page.
+
+### TLS
+
+!!! note ""
+    [TLS](https://github.com/asesidaa/TaikoLocalServer/tree/Refactor) - A network service emulator for Nijiiro.
+
+!!! tip ""
+    Setup can be complex as you are required to build TLS from source using [VisualStuido](https://visualstudio.microsoft.com/) and `.sln` files.

docs/games/taikonijiiro/problems.md

@@ -0,0 +1,118 @@
+# Taiko no Tatsujin Nijiiro Common Problems/Tips
+
+<img src="/img/taikonijiiro/taikonijiiro.png">
+
+### Change Language
+
+!!! tip ""
+    Nijiiro support changing the language from the test menu. The officially supported languages are                                                                              
+    Japanese(Default)                                                                   
+    English                                                                           
+    Chinese(zh-TW)                                                                   
+    Korean                 
+    
+    An unofficial mod allows you to change the language to Chinese(simplified) this can be found on the [Discord](https://discord.gg/cZRUmEPK78).
+    
+    Using `F1` `arrow keys` and `ENTER` navigate to `OTHERS` -> `LANGUAGE`
+
+<img src="/img/taikonijiiro/lang.png">
+
+### My game takes a long time to boot
+
+!!! danger "Warning:"
+    First boot after connecting to a network will be very long (>90s)
+
+!!! tip ""
+    The game files for Nijiiro consists of thousands of small .bin files, and Windows Defender is known to spend a long time scanning through them during game boot up.  
+    One way to massively speed up boot times is to add the entire game folder as a Windows Defender Exception.
+
+!!! 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/taikonijiiro/defender.png">
+
+### My game is running crazy fast/slow
+
+!!! tip ""
+    The game needs to be ran at 120fps or things will break.
+    
+    If you have a >=120hz display.                                  
+    Set your display to 120hz. you may need to make a custom resolution.                                                                              
+    In `config.toml` set `vsync =` to `true`.  
+     
+    If you have a <120hz display.                                                    
+    In `config.toml` set `vsync =` to `false`.                                                                        
+    Limit the FPS for `Taiko.exe` using your GPU settings or [RTSS](https://www.guru3d.com/download/rtss-rivatuner-statistics-server-download/)      
+    
+<img src="/img/taikonijiiro/fps.png">
+
+### My game is not connected to a network but I set one up
+
+!!! tip ""
+    Disable shop close time or you won't always be able to connect to the network.
+
+    Using `F1` `arrow keys` and `ENTER` navigate to `GAME OPTIONS` -> `CLOCK/CLOSE TIME SETTING` -> `SCHEDULE TYPE`.
+
+    If you are still unable to connect that means you have incorrectly configured your `config.toml` or your server.
+
+<img src="/img/taikonijiiro/close.png">
+
+### Help some game modes are missing
+
+!!! tip ""
+    This will happen if you did not correctly apply the unlock game modes mod or card in.
+
+    You can download the mod on the [Discord](https://discord.gg/cZRUmEPK78).
+
+    You can card in by pressing `P` by default.
+
+<img src="/img/taikonijiiro/game.png">
+
+### My game is still too big/small after setting resolution in `config.toml`
+
+!!! tip ""
+    This will happen if you incorrectly set your resolution or scale.
+
+    You can check your display resolution by right clicking your desktop and selecting `Display settings`.
+
+    You can set your scale to `100%` right above where it says your resolution.
+
+<img src="/img/taikonijiiro/scale.png">
+
+### My controller is dropping inputs/I can't hit good drumrolls
+
+!!! tip ""
+    This a common issue on some controllers.
+
+    In `config.toml` increase `wait_period =` by 1 then test in game and repeat untill feels correct.
+
+### Best settings for Nvidia GPUs
+
+!!! tip ""
+    This will help with latency and other issues
+    
+    In `NVIDIA Control Panel` set the following settings for `Taiko.exe`.                                                         
+    Low Latency Mode `Ultra`                                                    
+    Max Frame Rate `120 FPS`                                          
+    Power management mode `Prefer maximum performance`                                         
+    Vertical sync `Fast`                                                  
+
+### Audio
+
+!!! tip ""
+    By default the game will use wasapi shared
+    
+    To use wasapi exclusive disable `wasapi_shared` in `config.toml`.                                                                      
+    Copy the audio settings in the screenshot.                                
+
+    To use ASIO disable `wasapi_shared` in `config.toml` and enable `asio`.
+    Set your `asio_driver`
+
+    To use FlexASIO refer to [this](../../extras/streamaudio.md#option-4-flexasio).
+

docs/games/taikonijiiro/setup.md

@@ -0,0 +1,129 @@
+# Taiko no Tatsujin Nijiiro
+
+
+<img src="/img/taikonijiiro/taikonijiiro.png">
+
+!!! note "Author Note:"
+	Last updated: 08.02.2024 (Currently using `JP/39.06`)
+
+!!! 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 [esuo1198's TaikoArcadeLoader](https://github.com/esuo1198/TaikoArcadeLoader/actions), which is a fork of TaikoArcadeLoader 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/taikonijiiro/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 to, 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 to once the install is complete.
+
+<img src="/img/taikonijiiro/redist_finished.png">
+
+### Verifying your Game Data
+
+!!! tip ""
+	Taiko is generally distributed as a single folder. For Nijiiro, this will be `SBWY 39.06`.
+
+<img src="/img/taikonijiiro/1.png">
+
+!!! tip ""
+	The game folder should contain an `AMCUS`, `Data` and `Executable` folder.
+
+<img src="/img/taikonijiiro/2.png">
+
+!!! danger "Warning:"
+	Nijiiro is a rolling release so please verify your game version by opening `AMCUS\AMConfig.ini` and verifying that `cacfg-game_ver=39.06`
+
+!!! note "Other Data Formats:"
+	NAMCO data is also distributed as `.VHDX` and `.VHD` files. These files are useful for archival purposes, but are not required to run the game. Always download the unpacked data for home use.
+
+### Setting Up the Game Data
+
+!!! tip ""
+	Choose a location for your game data, for example, `C:\TaikoNijiiro\`.  
+	Copy/move the folders and files from `Taiko no Tatsujin Nijiiro Version (SBWY 39.06)` to this new folder.  
+
+!!! note "TaikoArcadeLoader:"
+	`TaikoArcadeLoader` is a loader and hardware emulator for Nijiiro. It will allow us to launch the game, as well as configure inputs and network settings. More information can be found at the [TAL github page](https://github.com/esuo1198/TaikoArcadeLoader).
+
+!!! tip ""
+	Download the latest version of TAL from [the actions tab](https://github.com/esuo1198/TaikoArcadeLoader/actions) of the TAL page. This will be a file named `dist`.   
+	You will need to be logged into github to download this file.
+
+<img src="/img/taikonijiiro/dist.png">
+
+!!! tip ""
+	Copy the files from `dist.zip` to your `Executable/Release` folder. When asked, choose to replace the existing files with the newly copied files.  
+	Here is how your `Executable/Release` folder should look after everything has been copied correctly.
+
+<img src="/img/taikonijiiro/executablereleasecomplete.png">
+
+### Configuring config.toml
+
+!!! tip ""
+	The configuration information for TaikoArcadeLoader is stored within `config.toml`.  
+	Open up `config.toml` with a text editor of your choice. We'll be using [Notepad++](https://notepad-plus-plus.org/).  
+	`config.toml` is separated into several sections, indicated by the section name in `[square brackets]`.  
+	Information for this can be found at the [TAL github page](https://github.com/esuo1198/TaikoArcadeLoader). We will go over the most important ones below.  
+
+!!! tip ""
+	The `[amauth]` section contains network related config.  
+
+	`server =` can be left default if playing on a [local server](networks.md) or offline but it is recommend to play on a [network](networks.md).                                 
+	`port =` do not change unless you know what you are doing.                                                                           
+	`chassis_id =` do not change unless you know what you are doing.    
+	`shop_id =` mostly visual. change if you want to.                            
+	`game_ver =` mostly visual. change if you want to.                                                                
+	`country_code =` do not change unless you know what you are doing.                                                           
+
+	Example image below.
+
+<img src="/img/taikonijiiro/amauth.png">
+
+!!! tip ""
+	The `[patches]` section contains patches.  
+
+	`version =` do not change unless you know what you are doing.                                 
+	`res =` change to your display's resolution.                                                                           
+	`windowed =` set to `true` if you want to run the game in windowed.    
+	`vsync =` set to `true` if your display is set to 120hz.                            
+	`unlock_songs =` do not change unless you know what you are doing.                                                                                                                           
+
+	Example image below.
+
+<img src="/img/taikonijiiro/patches.png">
+
+!!! tip ""
+	Save and close `config.toml` then run `Taiko.exe` to start the game.
+
+
+### 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.

mkdocs.yml

@@ -109,6 +109,13 @@ nav:
                     - 'Controllers': 'games/chunithmsunplus/controllers.md'
                     - 'Networks': 'games/chunithmsunplus/networks.md'
                     - 'Common Problems/Tips': 'games/chunithmsunplus/problems.md'
+        - NAMCO:
+            - 'Taiko no Tatsujin':
+                - 'Nijiiro':
+                    - 'First Time Setup': 'games/taikonijiiro/setup.md'
+                    - 'Controllers': 'games/taikonijiiro/controllers.md'
+                    - 'Networks': 'games/taikonijiiro/networks.md'
+                    - 'Common Problems/Tips': 'games/taikonijiiro/problems.md'
     - Error Codes: errorcodes.md
     - Game Patching:
         - 'Spice2x Patching': 'extras/patchsp2x.md'