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

chore: Apply formatting to all markdown docs

Browse Source
This commit was merged in pull request #279.
This commit is contained in:
icex2
2024-01-31 22:20:51 +01:00
committed by icex2
parent 0897a25174
commit 0a29e031ff
75 changed files with 3200 additions and 2786 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/tools/README.md
+31 -22
View File
@@ -1,43 +1,52 @@
# Tools
Documentation about various additional tooling that is fundamentally not required to run any of
BT5's supported games, but provides additional features for users and developers alike.
## BT5 API
Various command line tools for quick and easy testing of BT5 API implementations witohut having
to run any target games.
* [ddriotest](ddriotest.md): `ddrio` API
* [eamiotest](eamiotest.md): `eamio` API
* [iidxiotest](iidxiotest.md): `iidxio` API
* [jbiotest](jbiotest.md): `jbio` API
Various command line tools for quick and easy testing of BT5 API implementations witohut having to
run any target games.
- [ddriotest](ddriotest.md): `ddrio` API
- [eamiotest](eamiotest.md): `eamio` API
- [iidxiotest](iidxiotest.md): `iidxio` API
- [jbiotest](jbiotest.md): `jbio` API
## IO related
### ACIO
* [aciotest](aciotest.md): Command line tool for quick and easy testing of ACIO devices without
having to run a game.
- [aciotest](aciotest.md): Command line tool for quick and easy testing of ACIO devices without
having to run a game.
### P3IO DDR testing tool
* [p3io-ddr-tool](p3io-ddr-tool.md): Extensive command line tool to test and debug a real P3IO DDR
- [p3io-ddr-tool](p3io-ddr-tool.md): Extensive command line tool to test and debug a real P3IO DDR
(Dragon PCB) IO board + EXTIO
### Ezusb
* [ezusb-iidx-fpga-flash](ezusb-iidx-fpga-flash.md): Tool for flashing the FPGA on ezusb 1 boards.
Required if you want to run games without native ezusb support using BT5's iidxio API.
* [ezusb-iidx-sram-flash](ezusb-iidx-sram-flash.md): Tool for flashing data to the SRAM of ezusb
FX 2 boards. Required if you want to run games without native ezusb FX 2 support using BT5's iidxio
API.
* [ezusb-tool](ezusb-tool.md): Fundamental tool for flashing the base firmware to ezusb 1/2 boards.
Required if you want to run games without native ezusb 1/2 support using BT5's iidxio API.
- [ezusb-iidx-fpga-flash](ezusb-iidx-fpga-flash.md): Tool for flashing the FPGA on ezusb 1 boards.
Required if you want to run games without native ezusb support using BT5's iidxio API.
- [ezusb-iidx-sram-flash](ezusb-iidx-sram-flash.md): Tool for flashing data to the SRAM of ezusb FX
2 boards. Required if you want to run games without native ezusb FX 2 support using BT5's iidxio
API.
- [ezusb-tool](ezusb-tool.md): Fundamental tool for flashing the base firmware to ezusb 1/2 boards.
Required if you want to run games without native ezusb 1/2 support using BT5's iidxio API.
### IIDX exit hooks
Exit hooks allow you to exit the game using a combination of inputs on native IO hardware.
Supported IO hardware:
* [ezusb](iidx-ezusb-exit-hook.md)
* [ezusb 2](iidx-ezusb2-exit-hook.md)
* [bio2](iidx-bio2-exit-hook.md)
- [ezusb](iidx-ezusb-exit-hook.md)
- [ezusb 2](iidx-ezusb2-exit-hook.md)
- [bio2](iidx-bio2-exit-hook.md)
## Misc
* [mempatch-hook]: Hook library to dynamically apply memory address patches during runtime before
your application starts execution. Should be prefered over hardcoded hex-edits if applicable.
* [pcbidgen]: Command line tool to generate random PCBIDs
- \[mempatch-hook\]: Hook library to dynamically apply memory address patches during runtime before
your application starts execution. Should be prefered over hardcoded hex-edits if applicable.
- \[pcbidgen\]: Command line tool to generate random PCBIDs
doc/tools/aciotest.md
+2 -2
View File
@@ -1,2 +1,2 @@
Test your real ACIO hardware connected to your machine using this tool. Just
execute it and follow the usage instructions.
Test your real ACIO hardware connected to your machine using this tool. Just execute it and follow
the usage instructions.
doc/tools/ddriotest.md
+3 -3
View File
@@ -1,3 +1,3 @@
Testing tool for development of ddrio libraries used for emulating the main io
hardware on bemanitools for DanceDanceRevoluion. Just place ddriotest.exe and your
custom ddrio.dll in the same folder and run ddriotest.exe.
Testing tool for development of ddrio libraries used for emulating the main io hardware on
bemanitools for DanceDanceRevoluion. Just place ddriotest.exe and your custom ddrio.dll in the same
folder and run ddriotest.exe.
doc/tools/eamiotest.md
+3 -3
View File
@@ -1,3 +1,3 @@
Testing tool for development of eamio libraries used for emulating card reader
hardware on bemanitools. Just place eamiotest.exe and the eamio.dll your
custom eamio.dll in the same folder and run eamiotest.exe.
Testing tool for development of eamio libraries used for emulating card reader hardware on
bemanitools. Just place eamiotest.exe and the eamio.dll your custom eamio.dll in the same folder and
run eamiotest.exe.
doc/tools/ezusb-iidx-fpga-flash.md
+5 -6
View File
@@ -1,6 +1,5 @@
Flash a binary FPGA binary (not hex) firmware image to the FPGA of a EZUSB
board. This assumes that your IO board is already flashed using a base
firmware image (either by the game itself or using the *ezusb-tool*
application). Just call the executable and follow the usage instructions.
The type *v1* refers to the first gen protocol used from iidx 9 to 13 and *v2*
to the second gen protocol used from iidx 14 onwards.
Flash a binary FPGA binary (not hex) firmware image to the FPGA of a EZUSB board. This assumes that
your IO board is already flashed using a base firmware image (either by the game itself or using the
*ezusb-tool* application). Just call the executable and follow the usage instructions. The type *v1*
refers to the first gen protocol used from iidx 9 to 13 and *v2* to the second gen protocol used
from iidx 14 onwards.
doc/tools/ezusb-iidx-sram-flash.md
+3 -4
View File
@@ -1,4 +1,3 @@
Tool to write a binary (not hex) image to the SRAM of a ezusb board.
Just run the executable and follow the usage instructions. Ensure that the
correct base firmware supporting SRAM is flashed to the board prior using this
(either by the game or using the *ezusb-tool* application).
Tool to write a binary (not hex) image to the SRAM of a ezusb board. Just run the executable and
follow the usage instructions. Ensure that the correct base firmware supporting SRAM is flashed to
the board prior using this (either by the game or using the *ezusb-tool* application).
doc/tools/ezusb-tool.md
+4 -5
View File
@@ -1,6 +1,5 @@
Tool for fundamental legacy EZUSB management tasks, e.g. scanning for connected
devices, querying basic device info (vid, pid, name) and flashing firmware.
This tool requires the "cyusb" driver to be installed and does NOT work with the
"cyusb3" driver and thus not on anything newer than WinXP.
Tool for fundamental legacy EZUSB management tasks, e.g. scanning for connected devices, querying
basic device info (vid, pid, name) and flashing firmware. This tool requires the "cyusb" driver to
be installed and does NOT work with the "cyusb3" driver and thus not on anything newer than WinXP.
Just run the tool without any arguments to get usage information.
Just run the tool without any arguments to get usage information.
doc/tools/ezusb2-dbg-hook.md
+13 -18
View File
@@ -1,22 +1,17 @@
A hook library for debugging and dumping usb requests of games that use the
ezusb IO board (IIDX C02, IIDX IO2, Pop'n Music IO2). The library creates
a log file *ezusbdbg.log* in the same directory as your library/executable
which contains data dumps of the usb device's traffic.
A hook library for debugging and dumping usb requests of games that use the ezusb IO board (IIDX
C02, IIDX IO2, Pop'n Music IO2). The library creates a log file *ezusbdbg.log* in the same directory
as your library/executable which contains data dumps of the usb device's traffic.
Example usage:
*inject iidxhook1.dll ezusbdbg-hook.dll bm2dx.exe ...*
*launcher -K ezusbdbg-hook.dll bm2dx.dll ...*
Example usage: *inject iidxhook1.dll ezusbdbg-hook.dll bm2dx.exe ...* *launcher -K ezusbdbg-hook.dll
bm2dx.dll ...*
Make sure to provide the following additional arguments:
*--ezusbdbg_path <device path>*
The device path points to the path to open the device, e.g. on the old IIDX
games that was *"\\\\.\\Ezusb-0"*. If you don't know the path, you can run
the hook with dummy data, e.g. *--ezusbdbg_path asdfgqwer* and check the log
for any logged open calls with paths to find your ezusb device.
Make sure to provide the following additional arguments: *--ezusbdbg_path <device path>* The device
path points to the path to open the device, e.g. on the old IIDX games that was *"\\\\.\\Ezusb-0"*.
If you don't know the path, you can run the hook with dummy data, e.g. *--ezusbdbg_path asdfgqwer*
and check the log for any logged open calls with paths to find your ezusb device.
--ezusbdbg_type <1 or 2>
Specify the type of device to debug. *1* is for the legacy ezusb device, e.g.
IIDX C02, and *2* for the FX2 type device, e.g. IIDX IO2, Pop'n IO2.
--ezusbdbg_type \<1 or 2> Specify the type of device to debug. *1* is for the legacy ezusb device,
e.g. IIDX C02, and *2* for the FX2 type device, e.g. IIDX IO2, Pop'n IO2.
Both parameters must be specified, otherwise the hook will error. Make sure
to check the logfile for any errors or warnings as well.
Both parameters must be specified, otherwise the hook will error. Make sure to check the logfile for
any errors or warnings as well.
doc/tools/ezusb2-tool.md
+4 -5
View File
@@ -1,6 +1,5 @@
Tool for fundamental EZUSB FX2 management tasks, e.g. scanning for connected
devices, querying basic device info (vid, pid, name) and flashing firmware. This
tool requires the newer "cyusb3" driver and does NOT work with the old "ezusb"
driver.
Tool for fundamental EZUSB FX2 management tasks, e.g. scanning for connected devices, querying basic
device info (vid, pid, name) and flashing firmware. This tool requires the newer "cyusb3" driver and
does NOT work with the old "ezusb" driver.
Just run the tool without any arguments to get usage information.
Just run the tool without any arguments to get usage information.
doc/tools/iidx-bio2-exit-hook.md
+13 -7
View File
@@ -1,17 +1,23 @@
# IIDX BIO2 exit hook
A hook library that can be used with BeatmaniaIIDX games that run the BIO2 IO board either natively,
e.g. 25+, or using the [iidxio-bio2 backend](../iidxhook/iidx-bio2.md). It allows the player to
exit the game by pressing the buttons `Start P1 + Start P2 + VEFX + Effect` simultaneously. This can
be useful if you want an option to exit back to your desktop without having a keyboard attached.
The exit hook lib must be loaded like any other hook lib you are already injecting to the game
using either `inject` or `launcher` (depending on the game version). The order for the hook libs is important as they are loaded in the order specified for the inject/launcher call. The entry in the `gamestart.bat` file should look like this for inject:
A hook library that can be used with BeatmaniaIIDX games that run the BIO2 IO board either natively,
e.g. 25+, or using the [iidxio-bio2 backend](../iidxhook/iidx-bio2.md). It allows the player to exit
the game by pressing the buttons `Start P1 + Start P2 + VEFX + Effect` simultaneously. This can be
useful if you want an option to exit back to your desktop without having a keyboard attached.
The exit hook lib must be loaded like any other hook lib you are already injecting to the game using
either `inject` or `launcher` (depending on the game version). The order for the hook libs is
important as they are loaded in the order specified for the inject/launcher call. The entry in the
`gamestart.bat` file should look like this for inject:
```bat
inject iidxhook3.dll -K iidx-bio2-exit-hook.dll bm2dx.exe ...
```
...and for launcher:
```bat
launcher -K iidxhook8.dll -K iidx-bio2-exit-hook.dll bm2dx.dll ...
```
Where `iidxhook3.dll` is used for versions 14-15 and `iidxhook8.dll` for versions 25-26.
Where `iidxhook3.dll` is used for versions 14-15 and `iidxhook8.dll` for versions 25-26.
doc/tools/iidx-ezusb-exit-hook.md
+9 -10
View File
@@ -1,12 +1,11 @@
A hook library that can be used with BeatmaniaIIDX games that run the old ezusb
IO board (e.g. 9-13). It allows you to exit the game by pressing Start P1 +
Start P2 + VEFX + Effect simultaneously. This is very useful if you want an
option to exit back to your desktop without having a keyboard attached.
A hook library that can be used with BeatmaniaIIDX games that run the old ezusb IO board (e.g.
9-13). It allows you to exit the game by pressing Start P1 + Start P2 + VEFX + Effect
simultaneously. This is very useful if you want an option to exit back to your desktop without
having a keyboard attached.
The exit hook lib must be loaded like any other hook lib you are already
injecting to the game using *inject*. The order for the hook libs is important
as they are loaded in the order specified for the inject call. The entry in
the *gamestart.bat* file should look like this:
*inject iidxhook1.dll iidx-ezusb-exit-hook.dll bm2dx.exe ...*
The exit hook lib must be loaded like any other hook lib you are already injecting to the game using
*inject*. The order for the hook libs is important as they are loaded in the order specified for the
inject call. The entry in the *gamestart.bat* file should look like this: *inject iidxhook1.dll
iidx-ezusb-exit-hook.dll bm2dx.exe ...*
Where iidxhook1 is used for version 9-12. Use iidxhook2 for version 13.
Where iidxhook1 is used for version 9-12. Use iidxhook2 for version 13.
doc/tools/iidx-ezusb2-exit-hook.md
+11 -13
View File
@@ -1,15 +1,13 @@
A hook library that can be used with BeatmaniaIIDX games that run the ezusb
FX2 IO board (e.g. 14-24). It allows you to exit the game by pressing Start P1 +
Start P2 + VEFX + Effect simultaneously. This is very useful if you want an
option to exit back to your desktop without having a keyboard attached.
A hook library that can be used with BeatmaniaIIDX games that run the ezusb FX2 IO board (e.g.
14-24). It allows you to exit the game by pressing Start P1 + Start P2 + VEFX + Effect
simultaneously. This is very useful if you want an option to exit back to your desktop without
having a keyboard attached.
The exit hook lib must be loaded like any other hook lib you are already
injecting to the game using either *inject* or *launcher* (depending on the game
version). The order for the hook libs is important as they are loaded in the
order specified for the inject/launcher call. The entry in the *gamestart.bat*
file should look like this for inject:
*inject iidxhook3.dll -K iidx-ezusb2-exit-hook.dll bm2dx.exe ...*
...and for launcher:
*launcher -K iidxhook4.dll -K iidx-ezusb2-exit-hook.dll bm2dx.dll ...*
The exit hook lib must be loaded like any other hook lib you are already injecting to the game using
either *inject* or *launcher* (depending on the game version). The order for the hook libs is
important as they are loaded in the order specified for the inject/launcher call. The entry in the
*gamestart.bat* file should look like this for inject: *inject iidxhook3.dll -K
iidx-ezusb2-exit-hook.dll bm2dx.exe ...* ...and for launcher: *launcher -K iidxhook4.dll -K
iidx-ezusb2-exit-hook.dll bm2dx.dll ...*
Where iidxhook3 is used for 14-15 and iidxhook4 for 20-24.
Where iidxhook3 is used for 14-15 and iidxhook4 for 20-24.
doc/tools/iidxiotest.md
+3 -3
View File
@@ -1,3 +1,3 @@
Testing tool for development of iidxio libraries used for emulating the main io
hardware on bemanitools for BeatmaniaIIDX. Just place iidxiotest.exe and your
custom iidxio.dll in the same folder and run iidxiotest.exe.
Testing tool for development of iidxio libraries used for emulating the main io hardware on
bemanitools for BeatmaniaIIDX. Just place iidxiotest.exe and your custom iidxio.dll in the same
folder and run iidxiotest.exe.
doc/tools/jbiotest.md
+3 -3
View File
@@ -1,3 +1,3 @@
Testing tool for development of jbio libraries used for emulating the main io
hardware on bemanitools for jubeat. Just place jbiotest.exe and your
custom jbio.dll in the same folder and run jbiotest.exe.
Testing tool for development of jbio libraries used for emulating the main io hardware on
bemanitools for jubeat. Just place jbiotest.exe and your custom jbio.dll in the same folder and run
jbiotest.exe.
doc/tools/mempatch-hook.md
+15 -15
View File
@@ -1,36 +1,36 @@
# A simple memory patching hook
This is a hook which can be passed along with other hooks to be injected into
the target application of your choice (e.g. when using inject or launcher). It
allows you to patch raw memory contents of either the target application or
any libraries loaded with it. No static hex-edits anymore. Instead, create a
simple script file and also document your patches for others which allows them
to easily disable/enable them.
This is a hook which can be passed along with other hooks to be injected into the target application
of your choice (e.g. when using inject or launcher). It allows you to patch raw memory contents of
either the target application or any libraries loaded with it. No static hex-edits anymore. Instead,
create a simple script file and also document your patches for others which allows them to easily
disable/enable them.
# Setup
Copy the *mempatch-hook.dll* to the target application of your choice and add
it to the list of libraries to inject:
Copy the *mempatch-hook.dll* to the target application of your choice and add it to the list of
libraries to inject:
Example when using *inject.exe*:
```
inject iidxhook3.dll mempatch-hook.dll bm2dx.exe --config iidxhook-16.conf --mempatch myPatch.mph %*
```
When using *launcher.exe*:
```
launcher -K iidxhook4.dll -K mempatch-hook.dll bm2dx.dll --config iidxhook.conf --mempatch myPatch.mph %*
```
To load a patch script, add the *--mempatch <path to patch script>* argument (as
shown above in the example). You can specify this more than once which allows
you to apply multiple scripts in order, e.g.
*--mempatch myPatch1.mph --mempatch myPatch1.mph*.
To load a patch script, add the *--mempatch <path to patch script>* argument (as shown above in the
example). You can specify this more than once which allows you to apply multiple scripts in order,
e.g. *--mempatch myPatch1.mph --mempatch myPatch1.mph*.
# Patch script format
A patch script is a simple list of items seperated by a newline character
(i.e. one item = one line). Example script file:
A patch script is a simple list of items seperated by a newline character (i.e. one item = one
line). Example script file:
```
# This is a comment
@@ -69,4 +69,4 @@ bm2dx.exe 137C4C 2121212121 4540
# memory check, only. This can be used for signiture checking of the target
# application
bm2dx.exe 137C4C - 4540
```
```
doc/tools/p3io-ddr-tool.md
+2 -2
View File
@@ -1,2 +1,2 @@
Test your real DDR P3IO (Dragon) + EXTIO hardware connected to your machine
using this tool. Just execute it and follow the usage instructions.
Test your real DDR P3IO (Dragon) + EXTIO hardware connected to your machine using this tool. Just
execute it and follow the usage instructions.
doc/tools/pcbidgen.md
+1 -2
View File
@@ -1,2 +1 @@
Tool to generate random and (checksum) valid PCBIDs used on various Konami
Arcade games.
Tool to generate random and (checksum) valid PCBIDs used on various Konami Arcade games.