mirror of https://github.com/djhackersdev/bemanitools.git synced 2024-11-27 16:00:52 +01:00

History

icex2 edd0bda3bb Update distribution files and naming to indicate support of iidx 29 No significant changes on the game's side. Tooling that works for 27 and 28 also works fine for 29		2022-10-19 00:46:47 +02:00
..
ddrhook	Add docs for ddr unicorntail	2022-06-19 12:51:49 +02:00
dev	doc: Add a bunch of root readme files to various levels, enhance doc	2020-12-20 17:06:27 +01:00
iidxhook	Update distribution files and naming to indicate support of iidx 29	2022-10-19 00:46:47 +02:00
jbhook	jbhook: Add some better documentation	2022-01-03 14:30:20 +10:00
popnhook	Change reference of jubeat in popnhook documentation	2022-06-16 12:51:58 -04:00
sdvxhook	doc: Collect vigem related documentation in own subfolder in doc	2021-01-06 20:34:31 +00:00
tools	doc: Add a bunch of root readme files to various levels, enhance doc	2020-12-20 17:06:27 +01:00
vigem	doc: Make doc.zip include the whole folder	2021-04-30 20:24:13 -07:00
api.md	doc: Update api doc regarding eamuse readers and usage	2022-10-19 00:43:43 +02:00
architecture.md	iidxhook4-cn: Add support for IIDX Resort Anthem CN	2022-06-15 23:34:50 +02:00
development.md	Update readme/development doc about docker building	2020-05-11 00:24:21 +02:00
game-error-codes.md	doc/game-errorcodes: Add the well known IIDX network error on boot	2022-06-11 00:45:54 +02:00
inject.md	Add documentation: inject, launcher and iidxhooks using them	2019-10-19 21:33:49 +02:00
launcher.md	Add documentation: inject, launcher and iidxhooks using them	2019-10-19 21:33:49 +02:00
README.md	doc: Add links to game error code documentation	2022-06-11 00:45:52 +02:00

README.md

Bemanitools 5 documentation

This folder contains various types of documentation.

Table of contents:

Game
- Error codes: List of bemani game specific error codes that you might encounter during boot or gameplay with troubleshooting information
Key tools
- Inject: Readme for one of BT5's key applications, inject.exe
- Launcher: Readme for another one of BT5's key applications, launcher.exe
- Tools: Documentation for additional user and development tooling
Game hooks
- ddrhook: Documentation relevant to ddrhook implementations
- iidxhook: Documentation relevant to iidxhook implementations
- jbhook: Documentation relevant to jbhook implementations
- popnhook: Documentation relevant to popnhook implementations
- sdvxhook: Documentation relevant to sdvxhook implementations
Development
- API: Available APIs for BT5 and instructions how to use them
- Architecture: Outline of BT5's architecture, how things are designed and why
- Development: Development environment, building, releasing, etc.
- Developer documentation: Various lose documentation/notes by developers
- Tools: Documentation for additional user and development tooling

Further external documentation

A list of external documentation that can be useful when dealing with bemanitools, supported data and hardware.

arcade-docs: An open (to read and contribute) repository of arcade hardware and software documentation