1
0
mirror of https://github.com/djhackersdev/bemanitools.git synced 2024-11-28 00:10:51 +01:00

doc/iidxhook: Update documentation, explain new io feature switches

This commit is contained in:
icex2 2020-11-08 00:24:52 +01:00
parent c1f6166e1b
commit 671723febd
6 changed files with 113 additions and 47 deletions

View File

@ -85,17 +85,29 @@ cycle the machine (i.e. quit the game and restart it).
## USB IO (ezusb) ## USB IO (ezusb)
Use the specific iidxio API implementations, e.g. iidxio-ezusb2.dll to use You have the following options:
the IO2 EZUSB board, to run the game on real hardware. Thanks to a common * Set `io.disable_io_emu=true` in the `iidxhook.conf` file to not hook ezusb
abstraction layer, you can also use custom IO boards or whatever Konami hardware IO communication with an emulation layer. The game will directly talk to the IO.
is going to be available in the future. Obviously, someone has to write a The game supports the ezusb (C02) as well as ezusb FX2 (IO2) boards.
driver, first. * Set `io.disable_io_emu=false` in the `iidxhook.conf` file.
Use the specific iidxio API implementations, e.g. `iidxio-ezusb2.dll` to use
the IO2 EZUSB board. The common `iidxio` abstraction layer also allows you to
use custom IO boards or whatever Konami hardware is going to be available in
the future. Obviously, someone has to write an imlementation of the `iidxio`
API, first.
## Slotted/Wave pass card readers ## Slotted/Wave pass card readers
Replace the default *eamio.dll* with the *eamio-icca.dll* and have either your You have the following options:
* Set `io.disable_card_reader_emu=true` in the `iidxhook.conf` file to not hook
card reader communication with an emulation layer. The game will directly talk
to the real readers though this only supports whatever readers the game
directly supports (slotted readers)
* Set `io.disable_card_reader_emu=false` in the `iidxhook.conf` file.
Replace the default `eamio.dll` with the `eamio-icca.dll` and have either your
slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers
conencted and and assigned to *COM1*. conencted and and assigned to `COM1`. Other custom implementations of of the
`eamio` API also work.
### ICCA device settings (device manager) ### ICCA device settings (device manager)
* Port: COM1 * Port: COM1
@ -112,7 +124,7 @@ mainboard.
# Known bugs # Known bugs
## USBIO (FM-DL TIMEOUT) ## USBIO (FM-DL TIMEOUT)
IIDX occasionally fails to boot with a "USBIO (FM-DL TIMEOUT)" error. If this IIDX occasionally fails to boot with a "USBIO (FM-DL TIMEOUT)" error. If this
happens, run the game again. happens, run the game again.
# Troubleshooting and FAQ # Troubleshooting and FAQ

View File

@ -85,17 +85,29 @@ cycle the machine (i.e. quit the game and restart it).
## USB IO (ezusb) ## USB IO (ezusb)
Use the specific iidxio API implementations, e.g. iidxio-ezusb2.dll to use You have the following options:
the IO2 EZUSB board, to run the game on real hardware. Thanks to a common * Set `io.disable_io_emu=true` in the `iidxhook.conf` file to not hook ezusb
abstraction layer, you can also use custom IO boards or whatever Konami hardware IO communication with an emulation layer. The game will directly talk to the IO.
is going to be available in the future. Obviously, someone has to write a The game supports the ezusb (C02) as well as ezusb FX2 (IO2) boards.
driver, first. * Set `io.disable_io_emu=false` in the `iidxhook.conf` file.
Use the specific iidxio API implementations, e.g. `iidxio-ezusb2.dll` to use
the IO2 EZUSB board. The common `iidxio` abstraction layer also allows you to
use custom IO boards or whatever Konami hardware is going to be available in
the future. Obviously, someone has to write an imlementation of the `iidxio`
API, first.
## Slotted/Wave pass card readers ## Slotted/Wave pass card readers
Replace the default *eamio.dll* with the *eamio-icca.dll* and have either your You have the following options:
* Set `io.disable_card_reader_emu=true` in the `iidxhook.conf` file to not hook
card reader communication with an emulation layer. The game will directly talk
to the real readers though this only supports whatever readers the game
directly supports (wave pass readers)
* Set `io.disable_card_reader_emu=false` in the `iidxhook.conf` file.
Replace the default `eamio.dll` with the `eamio-icca.dll` and have either your
slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers
conencted and and assigned to *COM1*. conencted and and assigned to `COM1`. Other custom implementations of of the
`eamio` API also work.
### ICCA device settings (device manager) ### ICCA device settings (device manager)
* Port: COM1 * Port: COM1

View File

@ -96,17 +96,29 @@ cycle the machine (i.e. quit the game and restart it).
## USB IO (ezusb) ## USB IO (ezusb)
Use the specific iidxio API implementations, e.g. iidxio-ezusb2.dll to use You have the following options:
the IO2 EZUSB board, to run the game on real hardware. Thanks to a common * Set `io.disable_io_emu=true` in the `iidxhook.conf` file to not hook ezusb
abstraction layer, you can also use custom IO boards or whatever Konami hardware IO communication with an emulation layer. The game will directly talk to the IO.
is going to be available in the future. Obviously, someone has to write a The game supports the ezusb (C02) as well as ezusb FX2 (IO2) boards.
driver, first. * Set `io.disable_io_emu=false` in the `iidxhook.conf` file.
Use the specific iidxio API implementations, e.g. `iidxio-ezusb2.dll` to use
the IO2 EZUSB board. The common `iidxio` abstraction layer also allows you to
use custom IO boards or whatever Konami hardware is going to be available in
the future. Obviously, someone has to write an imlementation of the `iidxio`
API, first.
## Slotted/Wave pass card readers ## Slotted/Wave pass card readers
Replace the default *eamio.dll* with the *eamio-icca.dll* and have either your You have the following options:
* Set `io.disable_card_reader_emu=true` in the `iidxhook.conf` file to not hook
card reader communication with an emulation layer. The game will directly talk
to the real readers though this only supports whatever readers the game
directly supports (wave pass readers)
* Set `io.disable_card_reader_emu=false` in the `iidxhook.conf` file.
Replace the default `eamio.dll` with the `eamio-icca.dll` and have either your
slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers
conencted and and assigned to *COM1*. conencted and and assigned to `COM1`. Other custom implementations of of the
`eamio` API also work.
### ICCA device settings (device manager) ### ICCA device settings (device manager)
* Port: COM1 * Port: COM1

View File

@ -101,17 +101,29 @@ cycle the machine (i.e. quit the game and restart it).
## USB IO (ezusb) ## USB IO (ezusb)
Use the specific iidxio API implementations, e.g. iidxio-ezusb2.dll to use You have the following options:
the IO2 EZUSB board, to run the game on real hardware. Thanks to a common * Set `io.disable_io_emu=true` in the `iidxhook.conf` file to not hook ezusb
abstraction layer, you can also use custom IO boards or whatever Konami hardware IO communication with an emulation layer. The game will directly talk to the IO.
is going to be available in the future. Obviously, someone has to write a The game supports the ezusb (C02) as well as ezusb FX2 (IO2) boards.
driver, first. * Set `io.disable_io_emu=false` in the `iidxhook.conf` file.
Use the specific iidxio API implementations, e.g. `iidxio-ezusb2.dll` to use
the IO2 EZUSB board. The common `iidxio` abstraction layer also allows you to
use custom IO boards or whatever Konami hardware is going to be available in
the future. Obviously, someone has to write an imlementation of the `iidxio`
API, first.
## Slotted/Wave pass card readers ## Slotted/Wave pass card readers
Replace the default *eamio.dll* with the *eamio-icca.dll* and have either your You have the following options:
* Set `io.disable_card_reader_emu=true` in the `iidxhook.conf` file to not hook
card reader communication with an emulation layer. The game will directly talk
to the real readers though this only supports whatever readers the game
directly supports (wave pass readers)
* Set `io.disable_card_reader_emu=false` in the `iidxhook.conf` file.
Replace the default `eamio.dll` with the `eamio-icca.dll` and have either your
slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers
conencted and and assigned to *COM1*. conencted and and assigned to `COM1`. Other custom implementations of of the
`eamio` API also work.
### ICCA device settings (device manager) ### ICCA device settings (device manager)
* Port: COM1 * Port: COM1

View File

@ -97,22 +97,31 @@ cycle the machine (i.e. quit the game and restart it).
### BIO2 hardware ### BIO2 hardware
Set the *io.disable_bio2_emu* configuration value to *1* to disable BIO2 Set `io.disable_bio2_emu=true` in the `iidxhook.conf` file to not hook the BIO2
emulation to run the game using real BIO2 hardware. communication with an emulation layer. The game will directly talk to the IO.
In this mode, tthe game supports the BIO2 board only.
### Ezusb and other ### Ezusb and other
Use the specific iidxio API implementations, e.g. iidxio-ezusb2.dll to use Set `io.disable_bio2_emu=false` in the `iidxhook.conf` file.
the IO2 EZUSB board, to run the game on real hardware. Thanks to a common Use the specific iidxio API implementations, e.g. `iidxio-ezusb2.dll` to use
abstraction layer, you can also use custom IO boards or whatever Konami hardware the IO2 EZUSB board. The common `iidxio` abstraction layer also allows you to
is going to be available in the future. Obviously, someone has to write a use custom IO boards or whatever Konami hardware is going to be available in
driver, first. the future. Obviously, someone has to write an imlementation of the `iidxio`
API, first.
## Slotted/Wave pass card readers ## Slotted/Wave pass card readers
Replace the default *eamio.dll* with the *eamio-icca.dll* and have either your You have the following options:
* Set `io.disable_card_reader_emu=true` in the `iidxhook.conf` file to not hook
card reader communication with an emulation layer. The game will directly talk
to the real readers though this only supports whatever readers the game
directly supports (wave pass readers)
* Set `io.disable_card_reader_emu=false` in the `iidxhook.conf` file.
Replace the default `eamio.dll` with the `eamio-icca.dll` and have either your
slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers
conencted and and assigned to *COM1*. conencted and and assigned to `COM1`. Other custom implementations of of the
`eamio` API also work.
### ICCA device settings (device manager) ### ICCA device settings (device manager)
* Port: COM1 * Port: COM1

View File

@ -94,22 +94,31 @@ cycle the machine (i.e. quit the game and restart it).
### BIO2 hardware ### BIO2 hardware
Set the *io.disable_bio2_emu* configuration value to *1* to disable BIO2 Set `io.disable_bio2_emu=true` in the `iidxhook.conf` file to not hook the BIO2
emulation to run the game using real BIO2 hardware. communication with an emulation layer. The game will directly talk to the IO.
In this mode, tthe game supports the BIO2 board only.
### Ezusb and other ### Ezusb and other
Use the specific iidxio API implementations, e.g. iidxio-ezusb2.dll to use Set `io.disable_bio2_emu=false` in the `iidxhook.conf` file.
the IO2 EZUSB board, to run the game on real hardware. Thanks to a common Use the specific iidxio API implementations, e.g. `iidxio-ezusb2.dll` to use
abstraction layer, you can also use custom IO boards or whatever Konami hardware the IO2 EZUSB board. The common `iidxio` abstraction layer also allows you to
is going to be available in the future. Obviously, someone has to write a use custom IO boards or whatever Konami hardware is going to be available in
driver, first. the future. Obviously, someone has to write an imlementation of the `iidxio`
API, first.
## Slotted/Wave pass card readers ## Slotted/Wave pass card readers
Replace the default *eamio.dll* with the *eamio-icca.dll* and have either your You have the following options:
* Set `io.disable_card_reader_emu=true` in the `iidxhook.conf` file to not hook
card reader communication with an emulation layer. The game will directly talk
to the real readers though this only supports whatever readers the game
directly supports (wave pass readers)
* Set `io.disable_card_reader_emu=false` in the `iidxhook.conf` file.
Replace the default `eamio.dll` with the `eamio-icca.dll` and have either your
slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers slotted (IIDX, DDR Supernova or GF/DM type) or new wave pass card readers
conencted and and assigned to *COM1*. conencted and and assigned to `COM1`. Other custom implementations of of the
`eamio` API also work.
### ICCA device settings (device manager) ### ICCA device settings (device manager)
* Port: COM1 * Port: COM1