Add doc for game specific notes

pull/1/head
Dom Eori 2022-03-10 21:48:20 +09:00
parent 89ce3442ff
commit cbae5d049c
2 changed files with 65 additions and 3 deletions

View File

@ -1,5 +1,5 @@
# Aqua Server # Aqua Server
An multipurpose game server power by Spring Boot. Multipurpose game server powered by Spring Boot.
### Supported Game: ### Supported Game:
* CHUNITHM Paradise Lost (and below) * CHUNITHM Paradise Lost (and below)
@ -7,9 +7,11 @@ An multipurpose game server power by Spring Boot.
* Project DIVA Arcade Future Tone * Project DIVA Arcade Future Tone
* O.N.G.E.K.I. bright (and below) * O.N.G.E.K.I. bright (and below)
For more information, please see [game specific notes](docs/game_specific_notes.md).
### Notes: ### 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. * 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 support for few game which I can't test properly. If you couldn't find your wanted game in the above list, do not expect worthwhile support. * 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.
### Usage: ### Usage:
Requirements: Requirements:
@ -18,7 +20,7 @@ Requirements:
Run `java -jar aqua.jar` or use the `start.bat` if you are using windows. Run `java -jar aqua.jar` or use the `start.bat` if you are using windows.
By default, aqua will use sqlite and save user data in data/db.sqlite. By default, Aqua will use sqlite and save user data in data/db.sqlite.
If you want to MySQL (or MariaDB), edit configuration then it will auto create the table and import some initial data. If you want to MySQL (or MariaDB), edit configuration then it will auto create the table and import some initial data.

View File

@ -0,0 +1,60 @@
# Game specific notes
For best viewing experience, please use a markdown viewer that supports Github or Gitlab Flavored Markdown syntax.
This document is for detailed game specific notes, if any.
## Overview
| Name | Game ID | Latest supported version | Latest supported option | Actively supported | Requires patch |
| --- | --- | --- | --- | --- | --- |
|Chunithm |SDBT |Paradise Lost |A032 |Yes |Yes (Paradise) |
|Maimai DX |SDEZ |Universe |D051 |Yes |Yes |
|O.N.G.E.K.I |SDDT |Bright |A016 |Yes |Yes |
|Maimai |SDEY |Finale |? |No |? |
|Project DIVA AFT |SBZV |? |? |No |? |
|Initial D Zero |SDDF |? |? |No |? |
* Actively supported: if yes, it will likely receive future bug fixes and new version support.
* Requires patch: if yes, game needs to be patched in order to work with Aqua server.
* Latest supported option: this may or may not include all options up to latest.
## Chunithm
Only JP variant is supported.
### Required patches
This section only applies to Paradise and up.
* No TLS
* No encryption
### Additional notes
* Workaround for profile version mismatch is implemented, but not recommended.
## Maimai DX
Only JP variant is supported.
### Required patches
* No TLS
* No certificate pinning
* No URI obfuscation
* No encryption
### Non-working features
* KOP related
* User portrait
* DX Pass
* Tournament mode
### Additional notes
* From version 0.0.25, Aqua reports endpoint as `http://ALLNET_HOST/`. The final endpoint that game connects must be `http://ALLNET_HOST/Maimai2Servlet/`.
## O.N.G.E.K.I
### Required patches
* No TLS
* No certificate pinning
* No URI obfuscation
* No encryption
### Non-working features
* KOP related
* Physical cards