Fix wording/formatting

This commit is contained in:
Akitake 2025-10-10 22:18:51 +02:00
parent b7bffb10cc
commit 48df37af05
No known key found for this signature in database
8 changed files with 80 additions and 105 deletions

View File

@ -10,10 +10,10 @@
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:
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)
📂yyyymmddrr (revision directory, y = year digit, m = month digit, d = day digit, r = revision digit)
📂data
📄sidcode.txt
```
@ -22,20 +22,22 @@
!!! tip ""
- Download the latest Bemanitools release zip [here](https://github.com/djhackersdev/bemanitools/releases/latest)
- 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` into your revision folder (yyyymmddrr)
- (Hint: you only need one of the `gamestart-**.bat` and `iidxhook-**.bat` files, specific to your game version number)
- 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/clvsd.md"
--8<-- "docs/snippets/konami/iidx/btools_clvsd.md"
!!! tip ""
- After all this, here's what the expected data structure should look like:
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
@ -77,29 +79,16 @@
--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
## Configuring graphics
!!! 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"
--8<-- "docs/snippets/konami/iidx/btools_graphics.md"
## Before playing
@ -158,15 +147,21 @@
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!"
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"
--8<-- "docs/snippets/common/help.md"

View File

@ -3,7 +3,7 @@
--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"
!!! 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
@ -22,7 +22,7 @@
??? 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](extras.md) page"
!!! 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.
@ -35,11 +35,11 @@
- 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)"
!!! 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).
The CLVSD codec is not installed. Install it by following the correct section in the setup guide.

View File

@ -3,6 +3,7 @@
!!! 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
@ -12,4 +13,5 @@
- 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`"
!!! 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`"

View File

@ -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.

View File

@ -4,6 +4,6 @@
- Inside `bemanitools-supplement-vx.x.zip` locate `misc.zip`
- Inside `misc\d3d8to9\`, extract `d3d8.dll` into your revision folder.
- Inside `misc\d3d8to9\`, extract `d3d8.dll` to your revision directory
This enables us to use the graphic options inside `iidxhook-xx.conf` (xx being your game version number) which we will take advantage of.
This lets you configure graphics options inside `iidxhook-xx.conf` (xx being your game version number)

View File

@ -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">

View File

@ -1,50 +0,0 @@
!!! 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
```

View File

@ -1,16 +0,0 @@
!!! 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.