Cool_Tools/bemanitools
1
0
Fork 0
mirror of https://github.com/djhackersdev/bemanitools.git synced 2024-11-13 18:00:49 +01:00
Code Releases Activity
ecd598185b
bemanitools/doc/README.md

34 lines
1.7 KiB
Markdown
Raw Normal View History

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
# Bemanitools 5 documentation
Formatting
2021-09-12 23:56:45 +02:00
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
This folder contains various types of documentation.
Table of contents:
Formatting
2021-09-12 23:56:45 +02:00
doc: Add links to game error code documentation
2021-05-02 13:47:15 +02:00
* Game
* [Error codes](game-error-codes.md): List of bemani game specific error codes that you might
encounter during boot or gameplay with troubleshooting information
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
* Key tools
Formatting
2021-09-12 23:56:45 +02:00
* [Inject](inject.md): Readme for one of BT5's key applications, `inject.exe`
* [Launcher](launcher.md): Readme for another one of BT5's key applications, `launcher.exe`
* [Tools](tools/README.md): Documentation for additional user and development tooling
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
* Game hooks
Formatting
2021-09-12 23:56:45 +02:00
* [ddrhook](ddrhook/README.md): Documentation relevant to `ddrhook` implementations
* [iidxhook](iidxhook/README.md): Documentation relevant to `iidxhook` implementations
* [jbhook](jbhook/README.md): Documentation relevant to `jbhook` implementations
Support pop'n music 15-18 * popnhook1 for pop'n 15 - 18 has been added * popnio has been added * inject.exe has new syntax for loading hook DLLs, `real.dll=hook.dll`. This will trigger an early IAT hook where it will load the EXE suspended without resolving imports, replace the reference to real.dll in the import table with hook.dll, and then resolve everything before launching. This allows for ezusb.dll to be hooked properly. * launcher.exe also has a new early IAT hook feature now. Use `-I real.dll=hook.dll`. The idea is the same as described above for inject.exe. * Updated ezusb constant namings based on what is visible in ezusb.dll's debug statements. The launcher.exe implementation of early IAT hooking means that someone can implement popnhook2.dll for 19 and above. I have tried pop'n music Sunny Park using a modified version of popnhook1 and it seems to work to some degree: the I/O check and security check returns OK which means the ezusb hooking used in popnhook1 is also working for the later games using `launcher.exe -I ezusb.dll=ezusb2-popn-shim.dll ...`. The process is rather invasive (manually resolving all imports means more chances to fail) so it has been implemented in such a way that the launcher will work the same as it has before as long as `-I` isn't specified. One questionable thing I am not confident about is the `texture_usage_fix` hack flag I added in the conf. As the comment says, pop'n music 16 will work in Windows XP without the flag being set, but the game will immediately crash on later OSes without the flag being set in my experience. No other games had this issue in my experience. Enabling it in other games doesn't seem to have any negative effects.
2022-06-11 00:46:59 +02:00
* [popnhook](popnhook/README.md): Documentation relevant to `popnhook` implementations
Formatting
2021-09-12 23:56:45 +02:00
* [sdvxhook](sdvxhook/README.md): Documentation relevant to `sdvxhook` implementations
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
* Development
Formatting
2021-09-12 23:56:45 +02:00
* [API](api.md): Available APIs for BT5 and instructions how to use them
* [Architecture](architecture.md): Outline of BT5's architecture, how things are designed and why
* [Development](development.md): Development environment, building, releasing, etc.
* [Developer documentation](dev/README.md): Various lose documentation/notes by developers
* [Tools](tools/README.md): Documentation for additional user and development tooling
Add reference to arcade-docs project to documentation
2021-09-12 23:57:55 +02:00
## Further external documentation
A list of external documentation that can be useful when dealing with bemanitools,
supported data and hardware.
* [arcade-docs](https://github.com/Shizmob/arcade-docs): An open (to read and contribute) repository
of arcade hardware and software documentation
Copy Permalink