1
0
mirror of https://github.com/djhackersdev/bemanitools.git synced 2024-12-03 02:27:17 +01:00
bemanitools/doc/README.md
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

1.3 KiB

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