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

History

icex2 0a29e031ff chore: Apply formatting to all markdown docs		2024-01-31 22:20:51 +01:00
..
ddrhook	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
dev	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
iidxhook	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
jbhook	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
popnhook	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
sdvxhook	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
tools	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
vigem	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
api.md	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
architecture.md	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
development.md	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
game-error-codes.md	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
inject.md	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
launcher.md	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
README.md	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00
release-process.md	chore: Apply formatting to all markdown docs	2024-01-31 22:20:51 +01:00

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 and IO (hardware) implementations 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