1
0
mirror of https://github.com/djhackersdev/bemanitools.git synced 2024-12-18 01:05:52 +01:00
bemanitools/doc/ddrhook
2023-11-03 15:46:11 +01:00
..
ddrhook1.md Documentation fixes, MR feedback 2022-06-07 18:17:54 +00:00
ddrhook2.md Add docs for ddr A20+ data setup and folder structure 2022-06-19 12:51:33 +02:00
ddrio-async.md doc: Add info/instructions regarding ddrio-async 2023-11-03 15:46:11 +01:00
ddrio-p3io.md doc: Update documentation for various tools and ddrio added 2023-06-25 13:24:07 +02:00
ddrio-smx.md Moved location of ddrio-smx.md to doc/ddrhook/ddrio-smx.md, fixed some formatting, clarified joystick config. 2020-06-28 15:37:29 -04:00
README.md doc: Add info/instructions regarding ddrio-async 2023-11-03 15:46:11 +01:00
unicorntail.md unicorn tail doc update 2023-04-11 00:16:07 +02:00

ddrhook

ddrhook is a collection of hook libraries for "Dance Dance Revoluion" providing emulation and various patches to run these games on non BemaniPC hardware and newer Windows versions.

The hook libraries must be bootstrapped either using inject or launcher depending on the version you want to run. Further instructions are given in dedicated readme files for each ddrhook version (see below).

Versions

ddrhook comes in a few different flavors. The game and its engine changed over 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 games:

  • ddrhook1: X, X2 (US/EU regions)
  • ddrhook2: X2 (JP region), X3 vs. 2ndMIX, 2013, 2014, A

When building bemanitools, independent packages are created for each set of games which are ready to be dropped on top of vanilla AC data dumps. We recommend using pristine dumps to avoid any conflicts with other hardcoded hacks or binary patches.

How to run

To run your game with ddrhook, you have to use the inject tool to inject the DLL to the game process. dist/ddr contains bat scripts with all the important parameters configured. Further parameters can be added but might not be required to run the game with default settings. Further information on how to setup the data for each specific version are elaborated in their dedicated readme files.

Command line options

Add the argument -h when running inject with ddrhook to print help/usage information with a list of parameters you can apply to tweak various things.

ddrio API

Available implementations that can be swapped out depending on which kind of IO hardware you want to use:

  • ddrio: Default implementation supporting keyboard, mouse and USB game controllers
  • ddrio-mm: Support Minimaid custom interface
  • ddrio-smx: Support for StepManiaX dance platforms
  • ddrio-p3io: P3IO + EXTIO driver implementation
  • ddrio-async: Wrapper/shim library to drive another ddrio in a dedicated IO thread

Unicorntail

Instructions how to run on Chimera PCBs.