Support for IIDX16 and various snippets for older styles

docs/games/konami/iidx/16_empress/extras.md

@@ -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!
+        
+    

docs/games/konami/iidx/16_empress/setup.md

@@ -0,0 +1,172 @@
+<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 folder, y = year digit, m = month digit, d = day digit, r = revision digit)
+    📂data
+    📄sidcode.txt
+    ```
+
+## Installing Bemanitools
+
+!!! tip ""
+
+    - Download the latest Bemanitools release zip [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` into your revision folder (yyyymmddrr)
+        - (Hint: you only need one of the `gamestart-**.bat` and `iidxhook-**.bat` files, specific to your game version number)
+    
+--8<-- "docs/snippets/konami/iidx/btools_d3d8to9.md"
+
+--8<-- "docs/snippets/konami/iidx/clvsd.md"
+
+!!! tip ""
+
+    - After all this, 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"
+
+## 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.
+
+--8<-- "docs/snippets/konami/iidx/btools_resolution_fps.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 need to select a display type.
+    !!! tip "This setting affects timing offset in the song."
+    - For lower offset, select `TYPE B`. If your monitor has high latency, select `TYPE A`. If you're not sure what to pick, remember that you can always change this setting later depending on how the game feels
+    - Go to `SAVE AND EXIT`
+
+    Select `GAME MODE`.
+    
+!!! success "You're all done! The game should load up properly now. Make sure to insert credits by pressing your `SERVICE` key!"
+
+## Help
+
+--8<-- "docs/snippets/common/help.md"

docs/games/konami/iidx/16_empress/troubleshooting.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 [this](https://github.com/djhackersdev/bemanitools/blob/master/doc/game-error-codes.md) Bemanitools documentation page"
+
+## 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.
+    !!! tip "For more information regarding output modes, check out the [Extra Information](https://two-torial.xyz/games/konami/iidx/16_empress/extras/) 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 and the such, check out Bemanitools' performance guide [here](https://github.com/djhackersdev/bemanitools/blob/master/doc/iidxhook/iidx-syncbook.md)"
+
+### Other
+
+??? tip "Background videos not working"
+    
+    The CLVSD codec is not installed. Install it by following the correct section in the setup guide.
+    

docs/snippets/konami/common/btools_cards.md

@@ -0,0 +1,15 @@
+    !!! info "This tab lets you configure which cards are used to save your game profile to"
+    
+    !!! warning "If you haven't generated a card number before, you can grab one from [here](https://kawashi.ro/card)"
+    
+    !!! tip ""
+        Now we will set up our PIN pad and card.
+        
+        - Click on `Keyboard device` for whichever player's card reader you want to use
+        - You may or may not have more than one option. To figure out which one is your actual keyboard, select a device inside that list and press a button on the numpad
+        - Once you have found your correct device, the `Keypad status` will change **(the number and location of the number does not matter, it only matters that it changed)**
+        - Create a `.txt` file in a location that is easily accessible, and name it however you like
+        - Inside the file, paste in your card number. Example: `E0045812F8AFB2DE`
+        - Point to the file you created by clicking `Browse...` and selecting it
+        
+    !!! info "If you don't have a numpad, make sure to tick `Use top keyboard row for PIN pad input`. This will also change the `Card In` button to `Backspace`"

docs/snippets/konami/common/btools_lights.md

@@ -0,0 +1,8 @@
+    !!! info "This tab allows you to configure controller lights to sync with the game"
+        Not all controllers support this, but it does not affect gameplay and is completely optional.
+
+    !!! tip ""
+
+        - In `Device`, pick your controller
+        - In `Game Light`, select the corresponding button that will be used for that light
+        - Repeat for your other lights

docs/snippets/konami/iidx/btools_analogs.md

@@ -0,0 +1,13 @@
+    !!! info "This tab is used to bind analog controls like the turntable"
+
+    !!! warning "Ignore this tab if you play with a keyboard"
+    
+    !!! tip "Bind your controller's turntable"
+
+        With a controller rather than binding buttons to `TT+` and `TT-`, you need to:
+
+        - Head to the `Analogs` tab at the top
+        - In `Device`, pick your controller
+        - In `Control`, pick whichever one corresponds to the turntable
+        - Turn your turntable ensuring that the preview turns along with it
+        - Click `OK`, leaving the rest of the settings alone

docs/snippets/konami/iidx/btools_buttons.md

@@ -0,0 +1,15 @@
+    !!! info "This tab is used to bind your keyboard and controller buttons"
+
+    !!! tip ""
+
+        Double click on the right on a button that you wish to bind, then press the key you want associated with the action.
+
+        With your controller and/or keyboard plugged in, configure your keys for:  
+
+        - **Maintenance**: `Service, Test`
+        - **P1 Game buttons**: `1 to 7, Start, EFFECT, VEFX` 
+        - **P1 Keypad**: `Keypad Insert Card` 
+
+        **Only if** you're playing using a keyboard:
+
+        - **Turntable**: `TT+, TT-` **and optionally** `TT+/-` which alternates between `TT+` and `TT-` on each press.

docs/snippets/konami/iidx/btools_connecting_network.md

@@ -0,0 +1,42 @@
+!!! danger "Pick one or the other, not both!"
+
+??? tip "Option 1: Remote (Online Network)"
+
+    Remote networks typically require an invitation to join.  
+    You'll need to connect with members of the community who can provide you with an invite.
+
+    Your network should provide you with the necessary information to proceed:
+
+    - Open `iidxhook-xx.conf` (xx being your game version) with a text editor
+
+    - In the line `eamuse.server=localhost:80`, replace `localhost:80` with your provided network url
+
+    - In the lines `eamuse.pcbid=XXXXXXXXXXXXXXXXXXXX` **and** `eamuse.eamid=XXXXXXXXXXXXXXXXXXXX`, replace the part after `=` with your provided PCBID
+    
+    - Example:
+    ```
+    # URL (e.g. http://my.eamuse.server:80/whatever) or IPV4 (e.g. 127.0.0.1:80) of the target eamuse server. The port is optional but defaults to 80.
+    eamuse.server=http://be.ma.ni/
+
+    # PCBID
+    eamuse.pcbid=ABMYPRECIOUSPCBIDCDE
+
+    # EAMID
+    eamuse.eamid=ABMYPRECIOUSPCBIDCDE
+    ```
+
+??? tip "Option 2: Local e-amuse Emulator (Asphyxia)"
+
+    For instructions on setting up Asphyxia, please refer to our [Asphyxia setup guide](/extras/asphyxia.md).
+
+    After Asphyxia is setup with the proper plugin for your game:
+
+    - Open `iidxhook-xx.conf` (xx being your game version) with a text editor
+
+    - In the line `eamuse.server=localhost:80`, replace `localhost:80` to point to your asphyxia server, typically `localhost:8083`
+    
+    - Example:
+    ```
+    # URL (e.g. http://my.eamuse.server:80/whatever) or IPV4 (e.g. 127.0.0.1:80) of the target eamuse server. The port is optional but defaults to 80.
+    eamuse.server=localhost:8083
+    ```

docs/snippets/konami/iidx/btools_d3d8to9.md

@@ -0,0 +1,9 @@
+!!! tip ""
+
+    - Download the latest Bemanitools supplements release [here](https://github.com/djhackersdev/bemanitools-supplement/releases/latest)
+
+    - Inside `bemanitools-supplement-vx.x.zip` locate `misc.zip`
+
+    - Inside `misc\d3d8to9\`, extract `d3d8.dll` into your revision folder.
+
+    This enables us to use the graphic options inside `iidxhook-xx.conf` (xx being your game version number) which we will take advantage of.

docs/snippets/konami/iidx/btools_resolution_fps.md

@@ -0,0 +1,50 @@
+!!! tip ""
+    Next up, we'll setup borderless window and configure the proper resolution. We're using a `1920x1080` monitor so we will use that.
+    
+    Open your `iidxhook-xx.conf` (xx being your game version). 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
+    ```

docs/snippets/konami/iidx/clvsd.md

@@ -0,0 +1,16 @@
+!!! tip ""
+
+    In order to have background videos work, we need to install a codec.
+
+    - Inside `bemanitools-supplement-vx.x.zip` that you downloaded locate `iidx.zip`
+
+    - From inside `iidx\misc\`, extract `CLVSD.ax` into any folder on your computer that won't get moved or renamed
+        - An example to this can be your Documents folder
+
+    - Open the command prompt as ***administrator***, and type `regsvr32 "[File location]\CLVSD.ax"`
+        - In the case of the documents folder, the command will be `regsvr32 "C:\Users\YourUsername\Documents\CLVSD.ax"`
+
+    A prompt should appear telling you that it has been installed successfully.
+    This applies for game styles between 12 and 18, if you did it once you don't have to again.
+
+    If an error occurs, you didn't run the command prompt as administrator or you messed up the location of the file.

mkdocs.yml

@@ -28,6 +28,10 @@ nav:
               - "14 GOLD":
                   - "Game Setup": "games/konami/iidx/14_gold/setup.md"
                   - "Troubleshooting": "games/konami/iidx/14_gold/troubleshooting.md"
+              - "16 EMPRESS":
+                  - "Game Setup": "games/konami/iidx/16_empress/setup.md"
+                  - "Extra Information": "games/konami/iidx/16_empress/extras.md"
+                  - "Troubleshooting": "games/konami/iidx/16_empress/troubleshooting.md"
               - "24 SINOBUZ":
                   - "Game Setup": "games/konami/iidx/24_sinobuz/setup.md"
                   - "Extra Information": "games/konami/iidx/24_sinobuz/extras.md"