1
0
mirror of https://github.com/djhackersdev/bemanitools.git synced 2024-11-12 01:10:49 +01:00
bemanitools/README.md

108 lines
5.1 KiB
Markdown
Raw Normal View History

2019-09-27 22:36:50 +02:00
# Bemanitools 5
Version: 5.26</br>
[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.
# List of supported games
* BeatStream
* BeatStream (bst.zip)
* BeatStream アニムトライヴ (bst.zip)
* 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)
* 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.zip)
* 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)
* 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)
# 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.
# Development
## API
Please refer to the [API documentation](doc/api.md).
## Source Code
The source code is included with this distribution package (src.zip). Please refer to the
[development document](doc/development.md) for further details.
## Bugs and TODOs
We have our own issue tracker for this. If you want to contribute or have any bugs to report, please reach out to us on
the various channels we are available on. Please help us by providing a detailed description of your concern including:
* The version of bemanitools you are using
* The games affected including version
* Log output of bemanitools and the game
* The APIs you have been using with bemanitools, e.g. iidxio-keyboard, eamio-keyboard.
* The OS version you are running this on
* Specs of your hardware including CPU, RAM, GPU
* A detailed description of your issue. Describe the symptoms and the steps to trigger and reproduce them. Videos and
screenshots might be helpful depending on the issue.
## Contributions
Patches are welcome! Let us know if you have any contributions, e.g. bugfixes, and send us a patch file. Please read
our [development guidelines](doc/development.md) as they contain valuable information that your contribution meets our
standards.
Once submitted, we will review your contribution and get back to you about any changes or when we merge them to our
upstream repository. Your changes, once approved, will be included in the next release.
## Roadmap
No concrete roadmap or timeline exists. We want to continue adding support for new games as well as old games (some of
the old games supported by BT4 are not supported, yet). However, our time and workforce is limited. If you are
interested in contributing, please check the [contribution section](#contributions).
# 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.