mirror of https://github.com/djhackersdev/bemanitools.git synced 2024-11-14 18:27:36 +01:00

History

icex2 f7e1c8b3f9 doc: Add a bunch of root readme files to various levels, enhance doc Not complete, but a start to make documentation browsable and therefore more accessible.		2020-12-20 17:06:27 +01:00
..
ddrhook	Moved location of `ddrio-smx.md` to `doc/ddrhook/ddrio-smx.md`, fixed some formatting, clarified joystick config.	2020-06-28 15:37:29 -04:00
dev	doc: Add a bunch of root readme files to various levels, enhance doc	2020-12-20 17:06:27 +01:00
hardware	doc/hardware: Add information about bio2 turntable bypass cable	2020-12-20 15:25:16 +01:00
iidxhook	doc/hardware: Add information about bio2 turntable bypass cable	2020-12-20 15:25:16 +01:00
jbhook	Cleanup	2020-11-08 15:32:42 +01:00
sdvxhook	vigem-sdvxio: Add relative mode and address comments	2020-09-26 22:54:12 -07:00
tools	doc: Add a bunch of root readme files to various levels, enhance doc	2020-12-20 17:06:27 +01:00
api.md	doc: Improve visibility of iidxio API implementations	2020-12-20 15:25:16 +01:00
architecture.md	Update changelog	2019-10-12 20:44:51 +02:00
development.md	Update readme/development doc about docker building	2020-05-11 00:24:21 +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 a bunch of root readme files to various levels, enhance doc	2020-12-20 17:06:27 +01: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
Hardware
- Hardware: Anything related to hardware, e.g. IO boards