mirror of
https://github.com/djhackersdev/bemanitools.git
synced 2026-08-28 03:14:03 -05:00
Add documentation: inject, launcher and iidxhooks using them
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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")
|
||||
|
||||
@@ -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")
|
||||
|
||||
@@ -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")
|
||||
|
||||
@@ -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")
|
||||
|
||||
@@ -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
|
||||
|
||||
18
doc/inject.md
Normal file
18
doc/inject.md
Normal file
@@ -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.
|
||||
15
doc/launcher.md
Normal file
15
doc/launcher.md
Normal file
@@ -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
|
||||
```
|
||||
Reference in New Issue
Block a user