bemanitools/doc
icex2 b64dea0849 feat: Add iidxio-async implementation
A shim library implementing the same concept as the already
existing ddrio-async library. The iidxio implementation takes
another iidxio library and runs it asynchronously which may
improve performance for certain iidxio implementations,
e.g. if the send and receive functions are driving actual IO
calls synchrously and are expensive.

This is not a replacement for a well engineered and proper
implementation of a iidxio library for any specific use-case.
It does not fix bad performance of existing implementations,
i.e. if the poll rate is too low because actual IO is too slow.

Use with caution and know why and when you need to use
it.
2025-02-08 22:51:46 +01:00
..
ddrhook fix(doc): Update list of supported ddr versions 2024-01-31 22:47:14 +01:00
dev chore: Apply formatting to all markdown docs 2024-01-31 22:20:51 +01:00
iidxhook feat: Add iidxio-async implementation 2025-02-08 22:51:46 +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