diff --git a/README.md b/README.md index 7547a4a..bca103d 100644 --- a/README.md +++ b/README.md @@ -11,44 +11,44 @@ authentic gameplay experience, and easier support for a broader range of release # List of supported games * BeatStream - * BeatStream (bst.zip) - * BeatStream アニムトライヴ (bst.zip) + * BeatStream (bst.zip) using bsthook + * BeatStream アニムトライヴ (bst.zip) using bsthook * Dance Dance Revolution - * Dance Dance Revolution X2 (ddr-12-to-16.zip) - * Dance Dance Revolution X3 vs. 2ndMIX (ddr-12-to-16.zip) - * Dance Dance Revolution 2013 (ddr-12-to-16.zip) - * Dance Dance Revolution 2014 (ddr-12-to-16.zip) - * Dance Dance Revolution A (ddr-12-to-16.zip) + * Dance Dance Revolution X2 (ddr-12-to-16.zip) using ddrhook + * Dance Dance Revolution X3 vs. 2ndMIX (ddr-12-to-16.zip) using ddrhook + * Dance Dance Revolution 2013 (ddr-12-to-16.zip) using ddrhook + * Dance Dance Revolution 2014 (ddr-12-to-16.zip) using ddrhook + * Dance Dance Revolution A (ddr-12-to-16.zip) using ddrhook * Beatmania IIDX - * Beatmania IIDX 9th Style (iidx-09-to-12.zip) - * Beatmania IIDX 10th Style (iidx-09-to-12.zip) - * Beatmania IIDX 11 IIDX RED (iidx-09-to-12.zip) - * Beatmania IIDX 12 HAPPY SKY (iidx-09-to-12.zip) - * Beatmania IIDX 13 DistorteD (iidx-13.zip) - * Beatmania IIDX 14 GOLD (iidx-14-to-17.zip) - * Beatmania IIDX 15 DJ TROOPERS (iidx-14-to-17.zip) - * Beatmania IIDX 16 EMPRESS (iidx-14-to-17.zip) - * Beatmania IIDX 17 SIRIUS (iidx-14-to-17.zip) - * Beatmania IIDX 18 Resort Anthem (iidx-18.zip) - * Beatmania IIDX 19 Lincle (iidx-19.zip) - * Beatmania IIDX 20 Tricoro (iidx-20.zip) - * Beatmania IIDX 21 SPADA (iidx-21-to-24.zip) - * Beatmania IIDX 22 PENDUAL (iidx-21-to-24.zip) - * Beatmania IIDX 23 copula (iidx-21-to-24.zip) - * Beatmania IIDX 24 SINOBUZ (iidx-21-to-24.zip) - * Beatmania IIDX 25 CANNON BALLERS (iidx-25-to-26.zip) - * Beatmania IIDX 26 Rootage (iidx-25-to-26.zip) + * Beatmania IIDX 9th Style (iidx-09-to-12.zip) using [iidxhook1](doc/iidxhook/iidxhook1.md) + * Beatmania IIDX 10th Style (iidx-09-to-12.zip) using [iidxhook1](doc/iidxhook/iidxhook1.md) + * Beatmania IIDX 11 IIDX RED (iidx-09-to-12.zip) using [iidxhook1](doc/iidxhook/iidxhook1.md) + * Beatmania IIDX 12 HAPPY SKY (iidx-09-to-12.zip) using [iidxhook1](doc/iidxhook/iidxhook1.md) + * Beatmania IIDX 13 DistorteD (iidx-13.zip) using [iidxhook2](doc/iidxhook/iidxhook2.md) + * Beatmania IIDX 14 GOLD (iidx-14-to-17.zip) using [iidxhook3](doc/iidxhook/iidxhook3.md) + * Beatmania IIDX 15 DJ TROOPERS (iidx-14-to-17.zip) using [iidxhook3](doc/iidxhook/iidxhook3.md) + * Beatmania IIDX 16 EMPRESS (iidx-14-to-17.zip) using [iidxhook3](doc/iidxhook/iidxhook3.md) + * Beatmania IIDX 17 SIRIUS (iidx-14-to-17.zip) using [iidxhook3](doc/iidxhook/iidxhook3.md) + * Beatmania IIDX 18 Resort Anthem (iidx-18.zip) using [iidxhook4](doc/iidxhook/iidxhook4.md) + * Beatmania IIDX 19 Lincle (iidx-19.zip) using [iidxhook5](doc/iidxhook/iidxhook5.md) + * Beatmania IIDX 20 Tricoro (iidx-20.zip) using [iidxhook6](doc/iidxhook/iidxhook6.md) + * Beatmania IIDX 21 SPADA (iidx-21-to-24.zip) using [iidxhook7](doc/iidxhook/iidxhook7.md) + * Beatmania IIDX 22 PENDUAL (iidx-21-to-24.zip) using [iidxhook7](doc/iidxhook/iidxhook7.md) + * Beatmania IIDX 23 copula (iidx-21-to-24.zip) using [iidxhook7](doc/iidxhook/iidxhook7.md) + * Beatmania IIDX 24 SINOBUZ (iidx-21-to-24.zip) using [iidxhook7](doc/iidxhook/iidxhook7.md) + * Beatmania IIDX 25 CANNON BALLERS (iidx-25-to-26.zip) using [iidxhook8](doc/iidxhook/iidxhook8.md) + * Beatmania IIDX 26 Rootage (iidx-25-to-26.zip) using [iidxhook8](doc/iidxhook/iidxhook8.md) * jubeat - * jubeat (experimental/buggy) (jb-01.zip) - * jubeat saucer (fulfill) (jb-05-to-07.zip) - * jubeat prop (jb-05-to-07.zip) - * jubeat Qubell (jb-05-to-07.zip) - * jubeat clan (jb-08.zip) + * jubeat (experimental/buggy) (jb-01.zip) using [jbhook1](doc/jbhook1/jbhook1.md) + * jubeat saucer (fulfill) (jb-05-to-07.zip) using jbhook + * jubeat prop (jb-05-to-07.zip) using jbhook + * jubeat Qubell (jb-05-to-07.zip) using jbhook + * jubeat clan (jb-08.zip) using jbhook * SOUND VOLTEX - * SOUND VOLTEX BOOTH (sdvx.zip) - * SOUND VOLTEX II -infinite infection- (sdvx.zip) - * SOUND VOLTEX III GRAVITY WARS (sdvx.zip) - * SOUND VOLTEX IV HEAVENLY HAVEN (sdvx.zip) + * SOUND VOLTEX BOOTH (sdvx.zip) using sdvxhook + * SOUND VOLTEX II -infinite infection- (sdvx.zip) using sdvxhook + * SOUND VOLTEX III GRAVITY WARS (sdvx.zip) using sdvxhook + * SOUND VOLTEX IV HEAVENLY HAVEN (sdvx.zip) using sdvxhook # Supported platforms Our main platforms are currently Windows XP and Windows 7 which are also the target platforms on the original hardware diff --git a/doc/iidxhook/README.md b/doc/iidxhook/README.md index 69bfc3e..a65dc70 100644 --- a/doc/iidxhook/README.md +++ b/doc/iidxhook/README.md @@ -4,6 +4,11 @@ iidxhook is a collection of hook libraries for BeatmaniaIIDX 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](../inject.md) or +[launcher](../launcher.md) depending on the version you want to run. Further +instructions are given in dedicated readme files for each iidxhook version +(see below). + # Versions iidxhook comes in a few different flavors. The game and its engine changed over diff --git a/doc/iidxhook/iidxhook1.md b/doc/iidxhook/iidxhook1.md index 9971180..70021ca 100644 --- a/doc/iidxhook/iidxhook1.md +++ b/doc/iidxhook/iidxhook1.md @@ -6,6 +6,8 @@ The following games are compatible with this version of iidxhook: * RED * HAPPY SKY +The games must be bootstrapped using [inject](../inject.md). + # Data setup and running the game Ensure your folder with your unpacked data looks like this: diff --git a/doc/iidxhook/iidxhook2.md b/doc/iidxhook/iidxhook2.md index a56e230..c13187f 100644 --- a/doc/iidxhook/iidxhook2.md +++ b/doc/iidxhook/iidxhook2.md @@ -3,6 +3,8 @@ The following games are compatible with this version of iidxhook: * DistorteD +The games must be bootstrapped using [inject](../inject.md). + # Data setup and running the game Ensure your folder with your unpacked data looks like this: diff --git a/doc/iidxhook/iidxhook3.md b/doc/iidxhook/iidxhook3.md index c3d4396..87675ab 100644 --- a/doc/iidxhook/iidxhook3.md +++ b/doc/iidxhook/iidxhook3.md @@ -6,6 +6,8 @@ The following games are compatible with this version of iidxhook: * EMPRESS * SIRIUS +The games must be bootstrapped using [inject](../inject.md). + # Data setup and running the game Ensure your folder with your unpacked data looks like this: diff --git a/doc/iidxhook/iidxhook4.md b/doc/iidxhook/iidxhook4.md index f0a79d9..275e43d 100644 --- a/doc/iidxhook/iidxhook4.md +++ b/doc/iidxhook/iidxhook4.md @@ -3,6 +3,8 @@ The following games are compatible with this version of iidxhook: * Resort Anthem +The games must be bootstrapped using [launcher](../launcher.md). + # Data setup and running the game We assume that you are using a clean/vanilla data dump. Ensure your ("concents") diff --git a/doc/iidxhook/iidxhook5.md b/doc/iidxhook/iidxhook5.md index 30558ae..45e04cf 100644 --- a/doc/iidxhook/iidxhook5.md +++ b/doc/iidxhook/iidxhook5.md @@ -3,6 +3,8 @@ The following games are compatible with this version of iidxhook: * Lincle +The games must be bootstrapped using [launcher](../launcher.md). + # Data setup and running the game We assume that you are using a clean/vanilla data dump. Ensure your ("concents") diff --git a/doc/iidxhook/iidxhook6.md b/doc/iidxhook/iidxhook6.md index 304a5fa..7201dc9 100644 --- a/doc/iidxhook/iidxhook6.md +++ b/doc/iidxhook/iidxhook6.md @@ -3,6 +3,8 @@ The following games are compatible with this version of iidxhook: * Tricoro +The games must be bootstrapped using [launcher](../launcher.md). + # Data setup and running the game We assume that you are using a clean/vanilla data dump. Ensure your ("concents") diff --git a/doc/iidxhook/iidxhook7.md b/doc/iidxhook/iidxhook7.md index 97ae161..fbd4650 100644 --- a/doc/iidxhook/iidxhook7.md +++ b/doc/iidxhook/iidxhook7.md @@ -6,6 +6,8 @@ The following games are compatible with this version of iidxhook: * copula * SINOBUZ +The games must be bootstrapped using [launcher](../launcher.md). + # Data setup and running the game We assume that you are using a clean/vanilla data dump. Ensure your ("concents") diff --git a/doc/iidxhook/iidxhook8.md b/doc/iidxhook/iidxhook8.md index 9a6b39d..768376e 100644 --- a/doc/iidxhook/iidxhook8.md +++ b/doc/iidxhook/iidxhook8.md @@ -3,6 +3,8 @@ The following games are compatible with this version of iidxhook: * CANNON BALLERS +The games must be bootstrapped using [launcher](../launcher.md). + # Data setup and running the game ## Supported versions of Windows diff --git a/doc/inject.md b/doc/inject.md new file mode 100644 index 0000000..090f0fe --- /dev/null +++ b/doc/inject.md @@ -0,0 +1,18 @@ +# Inject + +Inject is a tool that creates a process for a specified application executable +file and injects a specified list of library/dll files into the process before +it is kicked off. + +Typically, the tool is run when you use one of the bat script files to start +any of the games that require its usage, e.g. older IIDX games. + +It comes with further option switches for development, e.g. Halting until +a debugger is attached, outputting debug output to a logfile etc. +Just run the application without any parameters to get a usage message: +``` +inject.exe +``` + +How inject.exe is used can be taken from the bat script files of various +(typically older) games. diff --git a/doc/launcher.md b/doc/launcher.md new file mode 100644 index 0000000..b815956 --- /dev/null +++ b/doc/launcher.md @@ -0,0 +1,15 @@ +# Launcher + +Launcher is a tool which is required to run the more recent titles. It sets up +the AVS environment for the target game to boot before it runs the it. + +Typically, the tool is run when you use one of the bat script files to start +any of the games that require its usage, e.g. newer IIDX games. + +It comes with option switches to configure the AVS environment and for +development, e.g. Halting until a debugger is attached, outputting debug +output to a logfile etc. +Just run the application without any parameters to get a usage message: +``` +launcher.exe +``` \ No newline at end of file