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

icex2 1477480836 Remove hardware docs, moved to arcade-docs project

These didn't really belong to this project to begin with but
didn't find a good home until recently. Already moved to
arcade-docs repository

2021-09-12 23:58:28 +02:00

Bemanitools 5 documentation

This folder contains various types of documentation.

Table of contents:

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
- 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