Revise documentation

This commit is contained in:
Dom Eori
2022-03-11 20:45:32 +09:00
parent 806c68e966
commit 00c3ca62e2
3 changed files with 83 additions and 15 deletions

View File

@@ -2,16 +2,18 @@
Multipurpose game server powered by Spring Boot.
### Supported Game:
* CHUNITHM New
* CHUNITHM Paradise Lost (and below)
* Maimai DX Universe (and below)
* Project DIVA Arcade Future Tone
* O.N.G.E.K.I. bright (and below)
For more information, please see [game specific notes](docs/game_specific_notes.md).
Read [game specific notes](docs/game_specific_notes.md) for more information.
### Notes:
* Some game may require additional patches and these will not provided in this project and repository. You already found this, so you know where to find related resources too.
* This repository may contain untested, experimental implementation for few games which I can't test properly. If you couldn't find your wanted game in the above list, do not expect support.
* This server also provides a simple API for viewing play records and edit settings for some games.
### Usage:
Requirements:
@@ -29,20 +31,10 @@ Please go to the database migration tool's website to check if your database ver
### Configuration:
Configuration is save in `application.properties`
- The host and port of game title servers can be overritten in `allnet.server.host` and `allnet.server.port`. By default it will send the same host and port the client used the request this information.
* The host and port of game title servers can be overritten in `allnet.server.host` and `allnet.server.port`. By default it will send the same host and port the client used the request this information.
This will be send to the game at booting and being used by following request.
- You can switch to MySQL (or MariaDB) database by commenting the Sqlite part.
#### Game specific setting:
##### CHUNITHM:
- Support auto profile downgrade now. You can just run any legacy version, but works better if you set a different keychip serial.
- You can enable team function and customize team name by changing `game.chunithm.team-name` value. Leave this blank to disable team function.
### Other Information:
- This server provide a simple API for view play information and edit settings for some games.
- DIVA and Maimai DX screenshot will be save in data folder.
* You can switch to MySQL (or MariaDB) database by commenting the Sqlite part.
* For some game, you might need to change some game specific config entries.
### Building:
You need to install JDK on your system. However, you don't need to care about Maven, as wrapper script is included.