Merge pull request #162 from boh-wyp/iidx16

Add IIDX 16

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,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 B`: Lower latency
+    - `TYPE A`: If your monitor has high latency
+
+    We recommend starting with `TYPE B` and returning change 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"
+

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 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).
+    

docs/snippets/konami/common/btools_cards.md

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

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_clvsd.md

@@ -0,0 +1,18 @@
+!!! tip ""
+
+    For background movies to work, you need to install and register a codec.
+
+    This also applies for IIDX 12 to 18, if you'd done it before you shouldn't need to again and may skip this step.
+
+    - Inside `bemanitools-supplement-vx.x.zip` locate and open `iidx.zip`
+
+    - Inside `iidx\misc\`, extract `CLVSD.ax` to any directory where the file can stay long term  
+    As an example we will be using your Documents folder, but it really could be anywhere you prefer.
+
+    - Open a command prompt as ***administrator***, and run `regsvr32 "CHOSEN_PATH\CLVSD.ax"`  
+    For the Documents folder, the command would be `regsvr32 "C:\Users\YOUR_USERNAME\Documents\CLVSD.ax"`
+
+    You should get confirmation that the file has been registered successfully.
+
+    If an error occurs, you most likely didn't start your command prompt as administrator, or the location to CLVSD.ax was incorrect.
+

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` to your revision directory
+
+    This lets you configure graphics options inside `iidxhook-xx.conf` (xx being your game version number)

docs/snippets/konami/iidx/btools_graphics.md

@@ -0,0 +1,26 @@
+!!! tip ""
+
+    - Open your `iidxhook-xx.conf` (xx being your game version)
+
+    - Locate and change the options we're interested in:
+    
+    ```
+    gfx.framed=false                    # Only matters if windowed. False for borderless, True for decorations (title bar, etc..)
+    gfx.frame_rate_limit=0.0            # Set this to 59.95
+    gfx.windowed=false                  # False for fullscreen, True for windowed
+    gfx.window_width=0                  # Set to your desired game width (recommended: monitor width)
+    gfx.window_height=0                 # Set to your desired game height (recommended: monitor height)
+    gfx.scale_back_buffer_width=0       # Set to your desired game width (recommended: monitor width)
+    gfx.scale_back_buffer_height=0      # Set to your desired game height (recommended: monitor height)
+    gfx.scale_back_buffer_filter=none   # Set to point or linear (pick one from examples below)
+    ```
+
+    Here are visual examples of the two filter options:
+
+    ??? info "point (sharp, pixel perfect)"
+
+        <img src="/img/konami/iidx/14_gold/iidx14_point.webp">
+    
+    ??? info "linear (less sharp, not pixel perfect)"
+
+        <img src="/img/konami/iidx/14_gold/iidx14_linear.webp">

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"