mirror of
https://github.com/djhackersdev/bemanitools.git
synced 2024-11-13 18:00:49 +01:00
159 lines
9.2 KiB
Markdown
159 lines
9.2 KiB
Markdown
# Bemanitools 5
|
|
[](https://dev.s-ul.net/djhackers/bemanitools/commits/master)
|
|
|
|
Version: 5.41
|
|
|
|
[Release history](CHANGELOG.md)
|
|
|
|
A collection of tools to run [various Bemani arcade games](#list-of-supported-games).
|
|
|
|
Bemanitools 5 (BT5) is the successor to Bemanitools 4 which introduces a big code cleanup and support for newer games.
|
|
BT5 uses a cleaner approach than BT4 did; specifically, all input and lighting is handled by emulating the protocols
|
|
spoken by the real IO PCBs, instead of replacing chunks of game code like BT4. The benefits of this approach are a more
|
|
authentic gameplay experience, and easier support for a broader range of releases from each game series.
|
|
|
|
## Documentation
|
|
Browse our [documentation](doc/README.md) as it might already cover various questions and concerns
|
|
you are looking for or about to ask.
|
|
|
|
## Contributions and bug reporting
|
|
[Read the dedicated CONTRIBUTING.md documentation](CONTRIBUTING.md).
|
|
|
|
The tl;dr version and golden rules of the sections in the document:
|
|
* **EVERYONE** can contribute, this is **NOT** limited to people coding
|
|
* [Open an issue on gitlab for discussions, feature requests and bug reports](CONTRIBUTING.md#reporting-and-discussions-issues-section-on-github)
|
|
* [ALWAYS report bugs as issues and ALWAYS use the available bug template](CONTRIBUTING.md#bug-reports)
|
|
* [Everyone is allowed to submit changes which are not just limited to code by opening merge requests](CONTRIBUTING.md#pull-requests-bugfixes-new-features-or-other-code-contributions)
|
|
* [Documentation improvements can and even should be contributed by non developers](CONTRIBUTING.md#pull-requests-bugfixes-new-features-or-other-code-contributions)
|
|
|
|
## Supported games
|
|
The following games are supported with their corresponding hook-libraries.
|
|
|
|
* BeatStream
|
|
* BeatStream (`bst.zip`): bsthook
|
|
* BeatStream アニムトライヴ (`bst.zip`): bsthook
|
|
* [Dance Dance Revolution](doc/ddrhook/README.md)
|
|
* Dance Dance Revolution X (`ddr-11.zip`): [ddrhook1](doc/ddrhook/ddrhook1.md)
|
|
* Dance Dance Revolution X2 (US/EU regions) (`ddr-12-us.zip`): [ddrhook1](doc/ddrhook/ddrhook1.md)
|
|
* Dance Dance Revolution X2 (JP region) (`ddr-12.zip`): [ddrhook2](doc/ddrhook/ddrhook2.md)
|
|
* Dance Dance Revolution 2013 (`ddr-14-to-16.zip`): [ddrhook2](doc/ddrhook/ddrhook2.md)
|
|
* Dance Dance Revolution 2014 (`ddr-14-to-16.zip`): [ddrhook2](doc/ddrhook/ddrhook2.md)
|
|
* Dance Dance Revolution A (`ddr-14-to-16.zip`): [ddrhook2](doc/ddrhook/ddrhook2.md)
|
|
* [Beatmania IIDX](doc/iidxhook/README.md)
|
|
* Beatmania IIDX 9th Style (`iidx-09-to-12.zip`): [iidxhook1](doc/iidxhook/iidxhook1.md)
|
|
* Beatmania IIDX 10th Style (`iidx-09-to-12.zip`): [iidxhook1](doc/iidxhook/iidxhook1.md)
|
|
* Beatmania IIDX 11 IIDX RED (`iidx-09-to-12.zip`): [iidxhook1](doc/iidxhook/iidxhook1.md)
|
|
* Beatmania IIDX 12 HAPPY SKY (`iidx-09-to-12.zip`): [iidxhook1](doc/iidxhook/iidxhook1.md)
|
|
* Beatmania IIDX 13 DistorteD (`iidx-13.zip`): [iidxhook2](doc/iidxhook/iidxhook2.md)
|
|
* Beatmania IIDX 14 GOLD (`iidx-14-to-17.zip`): [iidxhook3](doc/iidxhook/iidxhook3.md)
|
|
* Beatmania IIDX 15 DJ TROOPERS (`iidx-14-to-17.zip`): [iidxhook3](doc/iidxhook/iidxhook3.md)
|
|
* Beatmania IIDX 16 EMPRESS (`iidx-14-to-17.zip`): [iidxhook3](doc/iidxhook/iidxhook3.md)
|
|
* Beatmania IIDX 17 SIRIUS (`iidx-14-to-17.zip`): [iidxhook3](doc/iidxhook/iidxhook3.md)
|
|
* Beatmania IIDX 18 Resort Anthem (`iidx-18.zip`): [iidxhook4](doc/iidxhook/iidxhook4.md)
|
|
* Beatmania IIDX 19 Lincle (`iidx-19.zip`): [iidxhook5](doc/iidxhook/iidxhook5.md)
|
|
* Beatmania IIDX 20 Tricoro (`iidx-20.zip`): [iidxhook6](doc/iidxhook/iidxhook6.md)
|
|
* Beatmania IIDX 21 SPADA (`iidx-21-to-24.zip`): [iidxhook7](doc/iidxhook/iidxhook7.md)
|
|
* Beatmania IIDX 22 PENDUAL (`iidx-21-to-24.zip`): [iidxhook7](doc/iidxhook/iidxhook7.md)
|
|
* Beatmania IIDX 23 copula (`iidx-21-to-24.zip`): [iidxhook7](doc/iidxhook/iidxhook7.md)
|
|
* Beatmania IIDX 24 SINOBUZ (`iidx-21-to-24.zip`): [iidxhook7](doc/iidxhook/iidxhook7.md)
|
|
* Beatmania IIDX 25 CANNON BALLERS (`iidx-25-to-26.zip`): [iidxhook8](doc/iidxhook/iidxhook8.md)
|
|
* Beatmania IIDX 26 Rootage (`iidx-25-to-26.zip`): [iidxhook8](doc/iidxhook/iidxhook8.md)
|
|
* Beatmania IIDX 27 Heroic Verse (`iidx-27-to-28.zip`): [iidxhook9](doc/iidxhook/iidxhook9.md)
|
|
* Beatmania IIDX 28 BISTROVER (`iidx-27-to-28.zip`): [iidxhook9](doc/iidxhook/iidxhook9.md)
|
|
* [jubeat](doc/jbhook/README.md)
|
|
* jubeat (`jb-01.zip`): [jbhook1](doc/jbhook/jbhook1.md)
|
|
* jubeat ripples (`jb-02.zip`): [jbhook1](doc/jbhook/jbhook1.md)
|
|
* jubeat knit (`jb-03.zip`): [jbhook2](doc/jbhook/jbhook2.md)
|
|
* jubeat copious (`jb-04.zip`): [jbhook2](doc/jbhook/jbhook2.md)
|
|
* jubeat saucer (fulfill) (`jb-05-to-07.zip`): [jbhook3](doc/jbhook/jbhook3.md)
|
|
* jubeat prop (`jb-05-to-07.zip`): [jbhook3](doc/jbhook/jbhook3.md)
|
|
* jubeat qubell (`jb-05-to-07.zip`): [jbhook3](doc/jbhook/jbhook3.md)
|
|
* jubeat clan (`jb-08.zip`): [jbhook3](doc/jbhook/jbhook3.md)
|
|
* jubeat festo (`jb-08.zip`): [jbhook3](doc/jbhook/jbhook3.md)
|
|
* SOUND VOLTEX
|
|
* SOUND VOLTEX BOOTH (`sdvx-01-to-04.zip`): sdvxhook
|
|
* SOUND VOLTEX II -infinite infection- (`sdvx-01-to-04.zip`): sdvxhook
|
|
* SOUND VOLTEX III GRAVITY WARS (`sdvx-01-to-04.zip`): sdvxhook
|
|
* SOUND VOLTEX IV HEAVENLY HAVEN (`sdvx-01-to-04.zip`): sdvxhook
|
|
* SOUND VOLTEX Vivid Wave (`sdvx-05-to-06`): sdvxhook2
|
|
* SOUND VOLTEX EXCEED GEAR (`sdvx-05-to-06`): sdvxhook2
|
|
|
|
## ViGEm clients: Expose BT5 APIs as XBOX game controllers
|
|
Play your favorite non-bemani arcade games with any hardware, e.g. real cabinet hardware, that
|
|
implements BT5 APIs.
|
|
|
|
See the dedicated [readme](doc/vigem/README.md) for details.
|
|
|
|
## Supported platforms
|
|
Our main platforms are currently Windows XP and Windows 7 which are also the target platforms on the original hardware
|
|
of those games. However, as it gets more difficult to get and maintain hardware comptible with Windows XP, this might
|
|
change in the future. Many games also run on very recent Windows 10 builds but bear with us that it's hard to keep up
|
|
with Windows updates breaking legacy software.
|
|
|
|
## Distribution contents
|
|
Check the [list of supported games](#list-of-supported-games) to grab the right files for your game. BT5 also includes
|
|
a *tools* subpackage (tools.zip) as well as the full source code (src.zip).
|
|
|
|
You will find *.md files in various sub-packages that give you further instructions for setup, usage, error information
|
|
or FAQ. We advice you to read them as your questions and concerns might already be answered by them. If not, let us
|
|
know if there is any information that you consider helpful or important to know and should be added.
|
|
|
|
## Setup and dependencies
|
|
Most (older generation) games were developed for Windows XP Embedded but should run fine on any
|
|
consumer version of Windows XP. Newer versions of Windows, e.g. Windows 7, 8 and 10, should be fine
|
|
as well. Some hooks also include fixes required to run the games on a more recent version.
|
|
|
|
Depending on the game, you also need the following dependencies installed:
|
|
* DirectX 9 runtime
|
|
* Microsoft Visual C++ Redistributables 2010 **and** 2013: Depends on the game and age but both
|
|
should cover most if not all of the games so far
|
|
|
|
## Development
|
|
### Building
|
|
See the [development document](doc/development.md).
|
|
|
|
### Architecture
|
|
A dedicate [architecture document](doc/architecture.md) outlines the architecture of Bemanitools and points out the most
|
|
important aspects you should know before you get started with development.
|
|
|
|
### API
|
|
Please refer to the [API documentation](doc/api.md).
|
|
|
|
## Release process
|
|
Steps for the release process:
|
|
1. Update the corresponding section in the [changelog](CHANGELOG.md) with bullet points reflecting
|
|
major features merged into master since the previous release
|
|
1. Make sure you have the latest `master` state pulled to your local copy
|
|
1. Tag the release with the next release number which also be found at the
|
|
[top of the readme](#bemanitools-5) as it always reflects the current version beinged worked on
|
|
on the `master` branch , e.g. 5.35: `git tag 5.35`
|
|
1. Push the tag to upstream: `git push origin 5.35`
|
|
1. The [build pipeline](https://dev.s-ul.net/djhackers/bemanitools/-/pipelines) should start
|
|
automatically once the tag is pushed including the steps `build` and `upload-release`
|
|
1. Once completed successfully, the release is uploaded
|
|
1. Take the changelog of the published version and notify the pigs in the stall about it:
|
|
1. New post in thread
|
|
```
|
|
<insert version here> released: <direct link to published version>
|
|
|
|
Changelog:
|
|
<paste changelog here>
|
|
```
|
|
1. Update the OP title by bumping the version number in it
|
|
1. Update the OP post by extending it accordingly (see previous entries)
|
|
|
|
1. Bump the version number at the [top of this readme](#bemanitools-5) and add a new empty section
|
|
in the [changelog](CHANGELOG.md) with the new version number as title. Commit changes and push to
|
|
`master` branch
|
|
1. Continue developing and merging MRs until you decide its time for another release
|
|
|
|
## License
|
|
Source code license is the Unlicense; you are permitted to do with this as thou wilt. For details, please refer to the
|
|
[LICENSE file](LICENSE) included with the source code.
|
|
|
|
|
|
|
|
|
|
|
|
|