Max/djhackersdev_bemanitools
1
0
Fork 0
Code Issues 72 Pull Requests 15 Actions Packages Projects Releases 20 Wiki Activity

doc: Improve visibility of iidxio API implementations

Browse Source
This commit is contained in:
icex2
2020-12-20 15:25:16 +01:00
parent 30d346a3aa
commit 7d0cb64abf
2 changed files with 17 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/api.md
+5 -5
View File
@@ -22,15 +22,15 @@ The following implementations are already shipped with BT5.
* ddrio-smx.dll: StepManiaX platforms * ddrio-smx.dll: StepManiaX platforms
* Beatmania IIDX * Beatmania IIDX
* iidxio.dll (default): Keyboard, joystick and mouse input * iidxio.dll (default): Keyboard, joystick and mouse input
* iidxio-bio2.dll: BIO2 driver * [iidxio-bio2.dll](iidxhook/iidxio-bio2.md): BIO2 driver
* iidxio-ezusb.dll: Ezusb (C02 IO) driver * [iidxio-ezusb.dll](iidxhook/iidxio-ezusb.md): Ezusb (C02 IO) driver
* iidxio-ezusb2.dll: Ezusb FX2 (IO2) driver * [iidxio-ezusb2.dll](iidxhook/iidxio-ezusb2.md): Ezusb FX2 (IO2) driver
* jubeat * jubeat
* jbio.dll (default): Keyboard, joystick and mouse input * jbio.dll (default): Keyboard, joystick and mouse input
* SOUND VOLTEX * SOUND VOLTEX
* sdvxio.dll (default): Keyboard, joystick and mouse input * sdvxio.dll (default): Keyboard, joystick and mouse input
* sdvxio-bio2.dll: BIO2 driver * [sdvxio-bio2.dll](sdvxhook/sdvxio-bio2.md): BIO2 driver
* sdvxio-kfca.dll: KFCA IO board driver * [sdvxio-kfca.dll](sdvxhook/sdvxio-kfca.md): KFCA IO board driver
Eamuse hardware support is implemented separately: Eamuse hardware support is implemented separately:
* eamio.dll (default): Keyboard and joystick input * eamio.dll (default): Keyboard and joystick input
doc/iidxhook/README.md
+12 -7
View File
@@ -1,5 +1,4 @@
# iidxhook # iidxhook
iidxhook is a collection of hook libraries for BeatmaniaIIDX providing iidxhook is a collection of hook libraries for BeatmaniaIIDX providing
emulation and various patches to run these games on non BemaniPC hardware and emulation and various patches to run these games on non BemaniPC hardware and
newer Windows versions. newer Windows versions.
@@ -9,8 +8,7 @@ The hook libraries must be bootstrapped either using [inject](../inject.md) or
instructions are given in dedicated readme files for each iidxhook version instructions are given in dedicated readme files for each iidxhook version
(see below). (see below).
# Versions ## Versions
iidxhook comes in a few different flavors. The game and its engine changed over iidxhook comes in a few different flavors. The game and its engine changed over
the years. Some game versions might require patches/parameters enabled which the years. Some game versions might require patches/parameters enabled which
others don't need or have different AVS versions. Here is the list of supported others don't need or have different AVS versions. Here is the list of supported
@@ -30,8 +28,7 @@ which are ready to be dropped on top of vanilla AC data dumps. We recommend
using prestine dumps to avoid any conflicts with other hardcoded hacks or using prestine dumps to avoid any conflicts with other hardcoded hacks or
binary patches. binary patches.
# How to run ## How to run
To run your game with iidxhook, you have to use the inject tool to inject the To run your game with iidxhook, you have to use the inject tool to inject the
DLL to the game process. *dist/iidx* contains bat scripts with all the DLL to the game process. *dist/iidx* contains bat scripts with all the
important parameters configured. Further parameters can be added but might not important parameters configured. Further parameters can be added but might not
@@ -39,7 +36,15 @@ be required to run the game with default settings.
Further information on how to setup the data for each specific version are Further information on how to setup the data for each specific version are
elaborated in their dedicated readme files. elaborated in their dedicated readme files.
# Command line options ## Command line options
Add the argument *-h* when running inject with iidxhook to print help/usage Add the argument *-h* when running inject with iidxhook to print help/usage
information with a list of parameters you can apply to tweak various things. information with a list of parameters you can apply to tweak various things.
## iidxio API
Available implementations that can be swapped out depending on which kind of
IO hardware you want to use:
* `iidxio`: Default implementation supporting keyboard, mouse and USB
game controllers
* [iidxio-bio2](iidxhook/iidxio-bio2.md): Support BIO2 hardware
* [iidxio-ezusb](iidxhook/iidxio-ezusb.md): Support C02 ezusb FX hardware
* [iidxio-ezusb2](iidxhook/iidxio-ezusb2.md): Support IO2 ezusb FX2 hardware