mirror of https://github.com/hykilpikonna/AquaDX
Revise documentation
Dom Eori
parent
806c68e966
commit
00c3ca62e2
20
README.md
20
README.md
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,54 @@
|
|||
## This is a configuration file which included in the Aqua Server package.
|
||||
|
||||
## AimeDb server setting
|
||||
aimedb.server.enable=true
|
||||
aimedb.server.port=22345
|
||||
|
||||
## Server host & port return to client when boot up.
|
||||
## By default the same address and port from the client connection is returned.
|
||||
## Please notice DIVA won't work with localhost or 127.0.0.1
|
||||
#allnet.server.host=localhost
|
||||
#allnet.server.port=80
|
||||
|
||||
## Http Server Port
|
||||
## Only change this if you have a reverse proxy running.
|
||||
## The game rely on 80 port for boot up command
|
||||
server.port=80
|
||||
|
||||
## Chunithm
|
||||
## This enables team function if you set team name here. Leave this blank to disable it.
|
||||
game.chunithm.team-name=
|
||||
|
||||
## Chusan
|
||||
## The version of your client. If this doesn't match with your game, you will not be able to play some game modes.
|
||||
## Match this with data.conf file in latest option.
|
||||
## For example, if data.conf says "VerMajor = 2, VerMinor = 5, VerRelease = 4" then this need to be 2.05.04
|
||||
game.chusan.version=2.00.00
|
||||
## This enables team function if you set team name here. Leave this blank to disable it.
|
||||
game.chusan.team-name=
|
||||
|
||||
## Ongeki
|
||||
## The version of your client. Match this with DataConfig.xml file in latest option. (only if bright memory and up)
|
||||
## For example, if DataConfig.xml says "<major>1</major>, <minor>35</minor>, <release>1</release>" then this need to be 1.35.01
|
||||
game.ongeki.version=1.05.00
|
||||
|
||||
## Logging
|
||||
spring.servlet.multipart.max-file-size=10MB
|
||||
spring.servlet.multipart.max-request-size=20MB
|
||||
|
||||
## Database Setting
|
||||
|
||||
########## For Sqlite ##########
|
||||
spring.datasource.driver-class-name=org.sqlite.JDBC
|
||||
spring.datasource.url=jdbc:sqlite:data/db.sqlite
|
||||
spring.jpa.properties.hibernate.dialect=org.sqlite.hibernate.dialect.SQLiteDialect
|
||||
|
||||
########## For Mysql ##########
|
||||
#spring.datasource.driver-class-name=org.mariadb.jdbc.Driver
|
||||
#spring.datasource.username=
|
||||
#spring.datasource.password=
|
||||
#spring.datasource.url=jdbc:mariadb://localhost:3306/?useSSL=false
|
||||
#spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MariaDB10Dialect
|
||||
#spring.datasource.hikari.maximum-pool-size=10
|
||||
|
||||
## You can add any Spring Boot properties below
|
||||
|
|
@ -7,6 +7,7 @@ This document is for detailed game specific notes, if any.
|
|||
|
||||
| Name | Game ID | Latest supported version | Latest supported option | Actively supported | Requires patch |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
|Chunithm (Chusan)|SDHD |New |A141 |Yes |Yes |
|
||||
|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 |
|
||||
|
|
@ -18,6 +19,22 @@ This document is for detailed game specific notes, if any.
|
|||
* 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 (Chusan)
|
||||
Only JP variant is supported.
|
||||
|
||||
### Required patches
|
||||
* No encryption
|
||||
|
||||
### Non-working features
|
||||
* Global matching
|
||||
* Profile migration from Chunithm
|
||||
|
||||
### Additional notes
|
||||
* Match `game.chusan.version` key in `application.properties` same as your client version. If not, class mode is disabled due to version mismatch.
|
||||
* Team function can be enabled by changing `game.chusan.team-name` value. Leave this blank to disable team function.
|
||||
* Chusan and Chunithm uses different endpoints and tables. Your progress from Chunithm won't carry over to Chusan.
|
||||
* User box customization requires Web UI, which is not added yet. The only option to do now is editing database.
|
||||
|
||||
## Chunithm
|
||||
Only JP variant is supported.
|
||||
|
||||
|
|
@ -28,6 +45,7 @@ This section only applies to Paradise and up.
|
|||
|
||||
### Additional notes
|
||||
* Workaround for profile version mismatch is implemented, but not recommended.
|
||||
* Team function can be enabled by changing `game.chunithm.team-name` value. Leave this blank to disable team function.
|
||||
|
||||
## Maimai DX
|
||||
Only JP variant is supported.
|
||||
|
|
@ -46,6 +64,7 @@ Only JP variant is supported.
|
|||
|
||||
### Additional notes
|
||||
* Previous versions of Aqua reported different endpoint URI for Maimai DX thus required compatible patches. Currently, it doesn't matter and both will work.
|
||||
* Score cards are saved in the data folder.
|
||||
|
||||
## O.N.G.E.K.I
|
||||
|
||||
|
|
@ -57,4 +76,7 @@ Only JP variant is supported.
|
|||
|
||||
### Non-working features
|
||||
* KOP related
|
||||
* Physical cards
|
||||
* Physical cards
|
||||
|
||||
### Additional notes
|
||||
* Match `game.ongeki.version` key in `application.properties` same as your client version. This applies to Bright Memory version and up.
|
||||
Loading…
Reference in New Issue