From 5c08e966d9292a1d84fe70d34d63f36e455eeb7a Mon Sep 17 00:00:00 2001 From: icex2 Date: Sun, 11 Jun 2023 17:35:14 +0200 Subject: [PATCH] doc: Update documentation for various tools and ddrio added --- README.md | 4 ++++ doc/api.md | 3 ++- doc/ddrhook/ddrio-p3io.md | 27 +++++++++++++++++++++++++++ doc/tools/README.md | 5 +++++ doc/tools/ddriotest.md | 3 +++ doc/tools/p3io-ddr-tool.md | 2 ++ 6 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 doc/ddrhook/ddrio-p3io.md create mode 100644 doc/tools/ddriotest.md create mode 100644 doc/tools/p3io-ddr-tool.md diff --git a/README.md b/README.md index 77b357f..62a54d8 100644 --- a/README.md +++ b/README.md @@ -100,9 +100,13 @@ The following games are supported with their corresponding hook-libraries. * [iidx-bio2-exit-hook](doc/tools/iidx-bio2-exit-hook.md): For IIDX with BIO2 IO * [iidx-ezusb2-exit-hook](doc/tools/iidx-ezusb-exit-hook.md): For IIDX with ezusb FX2 IO * Bemanitools API testing: Tools for testing bemanitools API implementations + * [ddriotest](doc/tools/ddriotest.md): For [ddrio API](doc/api.md#io-boards) * [eamiotest](doc/tools/eamiotest.md): For [eamio API](doc/api.md#eamuse-readers) * [iidxiotest](doc/tools/iidxiotest.md): For [iidxio API](doc/api.md#io-boards) * [jbiotest](doc/tools/jbiotest.md): For [jbio API](doc/api.md#io-boards) +* DDR IO testing: Tools for testing hardware of a real DDR cabinet + * [p3io-ddr-tool](doc/tools/p3io-ddr-tool.md) + * [extiotest](doc/tools/extiotest.md) * [aciotest](doc/tools/aciotest.md): Command line tool to quickly test ACIO devices * config: UI input/output configuration tool when using the default bemanitools API (geninput) * ir-beat-patch-9/10: Patch the IR beat phase on IIDX 9 and 10 diff --git a/doc/api.md b/doc/api.md index 63a5048..3c85111 100644 --- a/doc/api.md +++ b/doc/api.md @@ -22,8 +22,9 @@ The following implementations are already shipped with BT5. * bstio.dll (default): Keyboard, joystick and mouse input * Dance Dance Revolution * ddrio.dll (default): Keyboard, joystick and mouse input + * [ddrio-p3io.dll](ddrhook/ddrio-p3io.md): DDR P3IO (Dragon PCB) + EXTIO hardware * ddrio-mm.dll: Minimaid hardware - * ddrio-smx.dll: StepManiaX platforms + * [ddrio-smx.dll](ddrhook/ddrio-smx.md): StepManiaX platforms * Beatmania IIDX * iidxio.dll (default): Keyboard, joystick and mouse input * [iidxio-bio2.dll](iidxhook/iidxio-bio2.md): BIO2 driver diff --git a/doc/ddrhook/ddrio-p3io.md b/doc/ddrhook/ddrio-p3io.md new file mode 100644 index 0000000..59be0b2 --- /dev/null +++ b/doc/ddrhook/ddrio-p3io.md @@ -0,0 +1,27 @@ +# ddrio API implementation with DDR P3IO (Dragon) and EXTIO + +This implementation of BT5's ddrio API allows you to use the native DDR P3IO +of a "Dragon PCB" plus the EXTIO with anything the ddrio API supports. + +This is not required to run the actual games supporting the hardware natively. +However, there are various 3rd party applications using the ddrio API where you +might benefit from using actual SD cabinet hardware, e.g. +[vigem-ddrio](../vigem/README.md). + +## Setup + +For hooks, but likely applicable to 3rd party applications (consolidate their +manuals). + +* Driver: You must have the P3IO driver intalled on your system + * Driver from [bemanitools-supplements](https://github.com/djhackersdev/bemanitools-supplement/blob/master/ddr/p3io/README.md) +* Have `ddrio-p3io.dll` in the same folder as your `ddrhookX.dll` +* Rename `ddrio-p3io.dll` to `ddrio.dll` +* Ensure that your `gamestart.bat` actually injects the appropriate ddrhook dll, for example: +```bat +inject ddrhook1.dll ddr.exe ...* +``` +or +```bat +launcher -K ddrhook2.dll arkmdxp3.dll ...* +``` \ No newline at end of file diff --git a/doc/tools/README.md b/doc/tools/README.md index 8168f44..a8cd655 100644 --- a/doc/tools/README.md +++ b/doc/tools/README.md @@ -6,6 +6,7 @@ BT5's supported games, but provides additional features for users and developers 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 @@ -15,6 +16,10 @@ to run any target games. * [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 + (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. diff --git a/doc/tools/ddriotest.md b/doc/tools/ddriotest.md new file mode 100644 index 0000000..3c620c7 --- /dev/null +++ b/doc/tools/ddriotest.md @@ -0,0 +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. \ No newline at end of file diff --git a/doc/tools/p3io-ddr-tool.md b/doc/tools/p3io-ddr-tool.md new file mode 100644 index 0000000..eb6054f --- /dev/null +++ b/doc/tools/p3io-ddr-tool.md @@ -0,0 +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. \ No newline at end of file