chore: Apply formatting to all markdown docs
This commit was merged in pull request #279.
This commit is contained in:
icex2
+38
-42
@@ -1,59 +1,54 @@
|
||||
# jbhook
|
||||
|
||||
jbhook is a collection of hook libraries for jubeat providing
|
||||
emulation and various patches to run these games on non BemaniPC hardware and
|
||||
newer Windows versions.
|
||||
jbhook is a collection of hook libraries for jubeat 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 jbhook version
|
||||
(see below).
|
||||
[launcher](../launcher.md) depending on the version you want to run. Further instructions are given
|
||||
in dedicated readme files for each jbhook version (see below).
|
||||
|
||||
# Versions
|
||||
|
||||
jbhook 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:
|
||||
* [jbhook1](jbhook1.md): jubeat, ripples
|
||||
* [jbhook2](jbhook2.md): knit, copious
|
||||
* [jbhook3](jbhook3.md): saucer, prop, qubell, clan, festo
|
||||
jbhook 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:
|
||||
|
||||
I sure have trouble remembering which jubeat version is which, here's a handy
|
||||
guide:
|
||||
* 01 - jubeat
|
||||
* 02 - ripples
|
||||
* 03 - knit
|
||||
* 04 - copious
|
||||
* 05 - saucer
|
||||
* 06 - prop
|
||||
* 07 - qubell
|
||||
* 08 - clan
|
||||
* 09 - festo
|
||||
- [jbhook1](jbhook1.md): jubeat, ripples
|
||||
- [jbhook2](jbhook2.md): knit, copious
|
||||
- [jbhook3](jbhook3.md): saucer, prop, qubell, clan, festo
|
||||
|
||||
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.
|
||||
I sure have trouble remembering which jubeat version is which, here's a handy guide:
|
||||
|
||||
- 01 - jubeat
|
||||
- 02 - ripples
|
||||
- 03 - knit
|
||||
- 04 - copious
|
||||
- 05 - saucer
|
||||
- 06 - prop
|
||||
- 07 - qubell
|
||||
- 08 - clan
|
||||
- 09 - festo
|
||||
|
||||
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 jbhook, you have to use the inject tool to inject the
|
||||
DLL to the game process. `dist/jb` 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.
|
||||
To run your game with jbhook, you have to use the inject tool to inject the DLL to the game process.
|
||||
`dist/jb` 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.
|
||||
|
||||
# Data setup and running the game
|
||||
|
||||
Ensure your folder with your unpacked data looks like this:
|
||||
|
||||
- `data`
|
||||
- `prop`
|
||||
- Various dll files including `jubeat.dll` **OR** `jubeat.exe`
|
||||
|
||||
Unpack the package containing jbhook into the folder containing the jubeat
|
||||
binary file.
|
||||
Unpack the package containing jbhook into the folder containing the jubeat binary file.
|
||||
|
||||
Run the `gamestart-XX.bat` file where `XX` denotes the version of the game you want to run.
|
||||
|
||||
@@ -62,10 +57,11 @@ Run the `gamestart-XX.bat` file where `XX` denotes the version of the game you w
|
||||
Running jubeat or ripples? Modify jbhook-01.conf or jbhook-02.conf.
|
||||
|
||||
Running anything newer?
|
||||
* Open the `prop/ea3-config.xml`
|
||||
* Replace the `ea3/network/services` URL with network service URL of your
|
||||
choice (for example http://my.eamuse.com)
|
||||
* Edit the `ea3/id/pcbid`
|
||||
|
||||
- Open the `prop/ea3-config.xml`
|
||||
- Replace the `ea3/network/services` URL with network service URL of your choice (for example
|
||||
http://my.eamuse.com)
|
||||
- Edit the `ea3/id/pcbid`
|
||||
|
||||
# Real hardware support
|
||||
|
||||
@@ -73,5 +69,5 @@ Run the launcher without the hook dll: `launcher jubeat.dll`
|
||||
|
||||
# Command line options
|
||||
|
||||
Add the argument *-h* when running inject with jbhook to print help/usage
|
||||
information with a list of parameters you can apply to tweak various things.
|
||||
Add the argument *-h* when running inject with jbhook to print help/usage information with a list of
|
||||
parameters you can apply to tweak various things.
|
||||
|
||||
+17
-18
@@ -1,19 +1,21 @@
|
||||
# Game list
|
||||
|
||||
The following games are compatible with this version of jbhook:
|
||||
* jubeat
|
||||
* jubeat ripples
|
||||
|
||||
- jubeat
|
||||
- jubeat ripples
|
||||
|
||||
The games must be bootstrapped using [inject](../inject.md).
|
||||
|
||||
# Data setup and running the game
|
||||
|
||||
Unpack the package containing jbhook1 into the revision folder of your choice.
|
||||
Most likely, you want to target the latest revision you have to run the latest
|
||||
binary of the game with any bugfixes by developers.
|
||||
Unpack the package containing jbhook1 into the revision folder of your choice. Most likely, you want
|
||||
to target the latest revision you have to run the latest binary of the game with any bugfixes by
|
||||
developers.
|
||||
|
||||
The DLLs in this package should be in the same location as the game DLLs and executable - i.e. all
|
||||
these files should be in the same folder:
|
||||
|
||||
The DLLs in this package should be in the same location as the game DLLs and
|
||||
executable - i.e. all these files should be in the same folder:
|
||||
- `inject.exe`
|
||||
- `jubeat.exe`
|
||||
- `jbhook-01.conf`
|
||||
@@ -25,18 +27,15 @@ Run the `gamestart-01.bat` file as admin.
|
||||
|
||||
# Eamuse network setup
|
||||
|
||||
If you want to run the games online, you have to set a valid PCBID in the
|
||||
configuration file. You also have to set the url of the eamuse server you want
|
||||
to connect to.
|
||||
If you want to run the games online, you have to set a valid PCBID in the configuration file. You
|
||||
also have to set the url of the eamuse server you want to connect to.
|
||||
|
||||
# Eamuse network setup
|
||||
|
||||
If you want to run the games online, you have to set a valid PCBID and EAMID
|
||||
(use the PCBID as the EAMID) in the configuration file or as a command line
|
||||
argument. You also have to set the url of the eamuse server you want to
|
||||
connect to.
|
||||
If you want to run the games online, you have to set a valid PCBID and EAMID (use the PCBID as the
|
||||
EAMID) in the configuration file or as a command line argument. You also have to set the url of the
|
||||
eamuse server you want to connect to.
|
||||
|
||||
Additional note regarding EAMID: This is provided as the identifier of the
|
||||
"eamuse license" to the server. Depending on the implementation of the server,
|
||||
this can lead to authentication failure resulting in a network error on boot or
|
||||
warning during gameplay.
|
||||
Additional note regarding EAMID: This is provided as the identifier of the "eamuse license" to the
|
||||
server. Depending on the implementation of the server, this can lead to authentication failure
|
||||
resulting in a network error on boot or warning during gameplay.
|
||||
|
||||
+17
-18
@@ -1,19 +1,21 @@
|
||||
# Game list
|
||||
|
||||
The following games are compatible with this version of jbhook:
|
||||
* jubeat knit
|
||||
* jubeat copious
|
||||
|
||||
- jubeat knit
|
||||
- jubeat copious
|
||||
|
||||
The games must be bootstrapped using [launcher](../launcher.md).
|
||||
|
||||
# Data setup and running the game
|
||||
|
||||
Unpack the package containing jbhook2 into the revision folder of your choice.
|
||||
Most likely, you want to target the latest revision you have to run the latest
|
||||
binary of the game with any bugfixes by developers.
|
||||
Unpack the package containing jbhook2 into the revision folder of your choice. Most likely, you want
|
||||
to target the latest revision you have to run the latest binary of the game with any bugfixes by
|
||||
developers.
|
||||
|
||||
The DLLs in this package should be in the same location as the game DLLs and executable - i.e. all
|
||||
these files should be in the same folder:
|
||||
|
||||
The DLLs in this package should be in the same location as the game DLLs and
|
||||
executable - i.e. all these files should be in the same folder:
|
||||
- `launcher.exe`
|
||||
- `jubeat.dll`
|
||||
- `eamio.dll`
|
||||
@@ -25,18 +27,15 @@ Run the `gamestart-02.bat` file as admin.
|
||||
|
||||
# Eamuse network setup
|
||||
|
||||
If you want to run the games online, you have to set a valid PCBID in the
|
||||
configuration file. You also have to set the url of the eamuse server you want
|
||||
to connect to.
|
||||
If you want to run the games online, you have to set a valid PCBID in the configuration file. You
|
||||
also have to set the url of the eamuse server you want to connect to.
|
||||
|
||||
# Eamuse network setup
|
||||
|
||||
If you want to run the games online, you have to set a valid PCBID and EAMID
|
||||
(use the PCBID as the EAMID) in the configuration file or as a command line
|
||||
argument. You also have to set the url of the eamuse server you want to
|
||||
connect to.
|
||||
If you want to run the games online, you have to set a valid PCBID and EAMID (use the PCBID as the
|
||||
EAMID) in the configuration file or as a command line argument. You also have to set the url of the
|
||||
eamuse server you want to connect to.
|
||||
|
||||
Additional note regarding EAMID: This is provided as the identifier of the
|
||||
"eamuse license" to the server. Depending on the implementation of the server,
|
||||
this can lead to authentication failure resulting in a network error on boot or
|
||||
warning during gameplay.
|
||||
Additional note regarding EAMID: This is provided as the identifier of the "eamuse license" to the
|
||||
server. Depending on the implementation of the server, this can lead to authentication failure
|
||||
resulting in a network error on boot or warning during gameplay.
|
||||
|
||||
@@ -1,18 +1,19 @@
|
||||
# Game list
|
||||
|
||||
The following games are compatible with this version of jbhook:
|
||||
* jubeat saucer
|
||||
* jubeat prop
|
||||
* jubeat qubell
|
||||
* jubeat clan
|
||||
* jubeat festo
|
||||
|
||||
- jubeat saucer
|
||||
- jubeat prop
|
||||
- jubeat qubell
|
||||
- jubeat clan
|
||||
- jubeat festo
|
||||
|
||||
The games must be bootstrapped using [launcher](../launcher.md).
|
||||
|
||||
# Data setup and running the game
|
||||
|
||||
Unpack the package containing jbhook3 into the revision folder of your choice.
|
||||
Most likely, you want to target the latest revision you have to run the latest
|
||||
binary of the game with any bugfixes by developers.
|
||||
Unpack the package containing jbhook3 into the revision folder of your choice. Most likely, you want
|
||||
to target the latest revision you have to run the latest binary of the game with any bugfixes by
|
||||
developers.
|
||||
|
||||
Run the `gamestart-03.bat` file as admin.
|
||||
|
||||
@@ -1,13 +1,15 @@
|
||||
This library talks to a MagicBox cab's IO and implements the jbio API of BT5.
|
||||
Thus, it allows you to use a MagicBox cab with *any* version of jubeat that is supported by BT5.
|
||||
This library talks to a MagicBox cab's IO and implements the jbio API of BT5. Thus, it allows you to
|
||||
use a MagicBox cab with *any* version of jubeat that is supported by BT5.
|
||||
|
||||
# Setup
|
||||
* Rename `jbio-magicbox.dll` to `jbio.dll`.
|
||||
* Make sure `jbio.dll` is in the same folder as both `jbhook.dll` and `jubeat.dll`
|
||||
* Make sure that you have a copy of the `ch341dll.dll` that comes with MagicBox.
|
||||
* Ensure that your `gamestart.bat` actually injects the appropriate jbhook dll
|
||||
for example:
|
||||
|
||||
- Rename `jbio-magicbox.dll` to `jbio.dll`.
|
||||
- Make sure `jbio.dll` is in the same folder as both `jbhook.dll` and `jubeat.dll`
|
||||
- Make sure that you have a copy of the `ch341dll.dll` that comes with MagicBox.
|
||||
- Ensure that your `gamestart.bat` actually injects the appropriate jbhook dll for example:
|
||||
|
||||
```
|
||||
launcher -K jbhook.dll jubeat.dll ...*
|
||||
```
|
||||
|
||||
or that the application otherwise uses `jbio.dll`
|
||||
|
||||
+15
-11
@@ -1,18 +1,22 @@
|
||||
This library talks to a P4IO (panel) and H44B through ACIO (lights) of a jubeat cab and implements the jbio API of BT5.
|
||||
Thus, it allows you to use a modern jubeat cab with *any* version of jubeat that is supported by BT5.
|
||||
This library talks to a P4IO (panel) and H44B through ACIO (lights) of a jubeat cab and implements
|
||||
the jbio API of BT5. Thus, it allows you to use a modern jubeat cab with *any* version of jubeat
|
||||
that is supported by BT5.
|
||||
|
||||
# Setup
|
||||
* Rename `jbio-p4io.dll` to `jbio.dll`.
|
||||
* Make sure `jbio.dll` is in the same folder as both `jbhook.dll`, `aciomgr.dll` and `jubeat.dll`
|
||||
* If you want IC card support via eamio-icca, ensure you also rename `eamio-icca.dll` to `eamio.dll`
|
||||
* Ensure that your `gamestart.bat` actually injects the appropriate jbhook dll
|
||||
for example:
|
||||
|
||||
- Rename `jbio-p4io.dll` to `jbio.dll`.
|
||||
- Make sure `jbio.dll` is in the same folder as both `jbhook.dll`, `aciomgr.dll` and `jubeat.dll`
|
||||
- If you want IC card support via eamio-icca, ensure you also rename `eamio-icca.dll` to `eamio.dll`
|
||||
- Ensure that your `gamestart.bat` actually injects the appropriate jbhook dll for example:
|
||||
|
||||
```
|
||||
launcher -K jbhook.dll jubeat.dll ...*
|
||||
```
|
||||
|
||||
or that the application otherwise uses `jbio.dll`
|
||||
|
||||
* If you have P4IO but no H44B, lights will be disabled
|
||||
* You can change the port and baudrate of the H44B node by editing the `jbio-h44b.conf` that should be created by default
|
||||
* If you are using IC card support, you can edit `eamio-icc.conf` to change the port and baudrate
|
||||
* If you are playing on a real cab, the port and baud of H44B and ICCA should be identical
|
||||
- If you have P4IO but no H44B, lights will be disabled
|
||||
- You can change the port and baudrate of the H44B node by editing the `jbio-h44b.conf` that should
|
||||
be created by default
|
||||
- If you are using IC card support, you can edit `eamio-icc.conf` to change the port and baudrate
|
||||
- If you are playing on a real cab, the port and baud of H44B and ICCA should be identical
|
||||
|
||||
Reference in New Issue
Block a user