doc: Add doc for idzhook

Apply 8 suggestion(s) to 2 file(s)

doc: Fix up initial d docs
This commit is contained in:
Bemani Witch 2021-06-16 00:03:07 +02:00
parent 987f9652da
commit e4999005cb
2 changed files with 277 additions and 0 deletions

166
doc/config/initiald.md Normal file
View File

@ -0,0 +1,166 @@
# Initial D Arcade Stage Zero configuration settings
This file describes configuration settings specific to Initial D Arcade Stage
Zero.
Keyboard binding settings use
[Virtual-Key Codes](https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes).
## `[io3]`
Cabinet specific inputs.
### `test`
Default `0x31` (`1 Key`)
Key-binding for cabinet test button.
### `service`
Default `0x32` (`2 Key`)
Key-binding for cabinet service button.
### `coin`
Default `0x33` (`3 Key`)
Key-binding for cabinet coin switch.
### `mode`
Choose whether you want to use a xinput (Xbox controllers, etc) or a dinput (PS
controllers, most wheels) type controller.
### `restrict`
Default `97`
This setting scales the steering wheel input so that the maximum positive and
minimum negative steering inputs reported in the operator menu's input test
screen do not exceed the value below. The maximum possible value is 128, and the
value that matches the input range of a real cabinet is 97.
NOTE: This is not the same thing as DirectInput steering wheel movement range!
Segatools cannot control the maximum angle of your physical steering wheel
controller, this setting is vendor-specific and can only be adjusted in the
Control Panel.
### `autoNeutral`
Default `1`
Automatically reset the simulated shifter to Neutral when XInput Start is
pressed (e.g. when navigating menus between races).
### `singleStickSteering`
Default `0`
By default if you use a xinput controller, segatools will use both sticks for
steering. While this is recommended for precision, it may be confusing to some
people. Set this to `1` to use a more traditional control scheme where only the
left stick is used to steer.
## `[dinput]`
Configuration for dinput controllers.
### `deviceName`
Default ` `
Name of the DirectInput wheel or controller to use (or any text that occurs in
its name) Example: TMX, Wireless Controller, T300, etc
If this is left blank then the first DirectInput device will be used. If you
don't know the name of your input device, you can find it in the windows
controller panel. The quickest way to access it is to press Win+R, then type in
`joy.cpl` and look at the list it will display.
### `shifterName`
Default ` `
Name of the positional shifter to use (or any subset thereof). Leave blank if
you do not have a positional shifter; a positional shifter will be simulated
using the configured Shift Down and Shift Up buttons in this case. If you don't
know the name of your input device, you can find it in the windows controller
panel. The quickest way to access it is to press Win+R, then type in `joy.cpl`
and look at the list it will display.
### Note on pedal mappings
Pedal mappings. Valid axis names are:
`X, Y, Z, RX, RY, RZ, U, V`
(U and V are old names for Slider 1 and Slider 2). The default values below are
valid for a Thrustmaster TMX.
### `brakeAxis`
Default `RZ`
Which axis to use for the brake pedal.
### `accelAxis`
Default `Y`
Which axis to use for the accelerator pedal.
### Note on button mappings
These are dinput button numbers. Note that buttons are numbered from 1, while
some software numbers buttons from 0. The default windows controller panel
should show the correct ones, if it hasn't been replaced by the controller
driver.
### `start`
Default `2`
Button mapping for the `Start` button.
### `viewChg`
Default `3`
Button mapping for the `View Change` button.
### `shiftDn`
Default `5`
Button mapping for shifting down with the emulated shifter. (If no `shifterName`
was specified)
### `shiftUp`
Default `6`
Button mapping for shifting up with the emulated shifter. (If no `shifterName`
was specified)
### `gear1`, `gear2`, `gear3`, `gear4`, `gear5`, `gear6`
Default `1, 2, 3, 4, 5, 6`
Button mappings for the physical shifter, if one was specified via the
`shifterName` setting.
### `reverseAccelAxis`
Default `0`
Inverts the accelerator axis if set to 1. This is needed for certain
controllers like the DS4 or Dualsense.
### `reverseBrakeAxis`
Default `0`
Inverts the brake axis if set to 1. This is needed for certain controllers
like the DS4 or Dualsense.

111
doc/idzhook.md Normal file
View File

@ -0,0 +1,111 @@
# idzhook
## Supported games
- Initial D Arcade Stage Zero Version 1
- Initial D Arcade Stage Zero Version 2
## General remarks
- The minimum version of Windows that this game supports is Windows 8
- Most of the game is in japanese, even in EXP region mode.
- This game is hard to set up. You may encounter weird errors that are hard to
diagnose
## Known issues
- The game will run in a semi windowed mode, even when set to fullscreen.
- No DirectInput force feedback (future Segatools enhancement)
- Felica.txt cards do not work with Version 2 of the game
## Data and game setup
1. Get the data
1. Ensure the game files are not marked read-only
1. Start up your favorite ALLNET server implementation in the background.
Without it you won't be able to save your progress whatsoever.
1. The data releases have the following structure:
- `package/`: Game data
- `opt/`: Addon data
- `amfs/`: Metadata
4. Unpack segatools to the `package` directory
5. Create an `appdata` folder (this isn't Windows APPDATA) in the data release
next to `package/`, `opt/` and `amfs/`
6. In the `[vfs]` section of `package/segatools.ini` set the paths for the
folders:
```text
[vfs]
amfs=../../amfs
appdata=../../appdata
option=../../opt
```
1. In the `[dns]` section, set `default=` to your computer's hostname or LAN IP.
Do not put `127.0.0.1` here, the game specifically checks for and rejects
loopback addresses. This setting controls the address of the network services
server
1. If you want to change the language to english, you can set `region=` in the
`[ds]` section to `4`.
1. This will change the region to `EXP` which comes with a rudimentary english
translation.
- Note for Version 2 of the game: You'll have to manually create a card ID and
set it up. To do so, change your `package/segatools.ini` so that the `[aime]`
section looks like this:
```
aimePath=DEVICE\aime.txt
felicaGen=0
```
- Then, go into the `package\DEVICE` folder, create a text file called aime.txt
and fill it with 20 digits, for example `01234567891234567890`. Make sure to
save the file.
1. Right click `start.bat` in `package` and run it as Administrator. After the
first run you may be able to run the game as a normal user.
1. Once you're at the title screen, press 2 or 3 a few times to add some
credits, then _hold_ the Enter key for a few seconds to scan a card and start
a credit.
- In some cases it might be necessary to run the game from the `C:\` drive. Try
copying the game there if for some reason it won't boot on a different drive.
## Segatools configuration
Configurable settings are exposed in the `segatools.ini` file. For a detailed
description, please refer to [this document](doc/config/common.md).
## Initial D Arcade Stage Zero specific configuration
For configuring IDZ specific features, e.g. IO, please refer to
[this document](doc/config/initiald.md).
## FAQ
### Where is the Free Play setting?
In the SEGA Nu system supervisor program, which is not included in this release.
A command-line tool to change this setting will be provided in a future release
of Segatools.
Do note however that Free Play is not advised for this game, as it will prohibit
you from purchasing additional cars.
### How do I get extra music?
Play through the story and also rack up your mileage.
### How do I unlock extra gauges?
Some will unlock in the story but most were time-limited online events. Try
editing the "idz_unlocks" table in the MiniMe database to force-unlock them on
your profile.
### Why does my story progress keep resetting?
If you are using minime, this is a known issue and will be fixed in a future
release.