AquaDX/README.md

60 lines
2.5 KiB
Markdown
Raw Normal View History

2020-01-15 23:50:52 +08:00
# Aqua Server
An multipurpose game server power by Spring Boot.
### Supported Game:
2021-06-20 01:00:57 +08:00
* CHUNITHM Paradise Lost (and below)
2022-02-14 21:19:45 +08:00
* Maimai DX Universe (and below)
2020-01-15 23:50:52 +08:00
* Project DIVA Arcade Future Tone
2021-12-26 18:55:57 +08:00
* O.N.G.E.K.I. bright (and below)
2020-01-15 23:50:52 +08:00
2021-12-25 22:34:37 +08:00
### 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 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.
2020-01-15 23:50:52 +08:00
### Usage:
Requirements:
* Java 11 or above
2021-12-25 22:34:37 +08:00
* Optional: MariaDB or MySQL (<8.0)
2020-01-15 23:50:52 +08:00
Run `java -jar aqua.jar` or use the `start.bat` if you are using windows.
2020-01-15 23:50:52 +08:00
2021-12-25 22:34:37 +08:00
By default, aqua will use sqlite and save user data in data/db.sqlite.
2020-01-15 23:50:52 +08:00
2021-12-25 22:34:37 +08:00
If you want to MySQL (or MariaDB), edit configuration then it will auto create the table and import some initial data.
2020-01-15 23:50:52 +08:00
2021-12-25 22:34:37 +08:00
Please go to the database migration tool's website to check if your database version is being supported https://flywaydb.org/documentation/database/mariadb
2020-01-15 23:50:52 +08:00
### 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.
2020-01-15 23:50:52 +08:00
This will be send to the game at booting and being used by following request.
2021-12-25 22:34:37 +08:00
- You can switch to MySQL (or MariaDB) database by commenting the Sqlite part.
2020-01-15 23:50:52 +08:00
#### Game specific setting:
2020-02-19 20:20:16 +08:00
##### CHUNITHM:
2021-06-26 21:15:33 +08:00
- 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.
2020-02-19 20:20:16 +08:00
2020-01-15 23:50:52 +08:00
### Other Information:
2021-12-25 22:34:37 +08:00
- 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.
2022-02-02 14:55:48 +08:00
### Building:
You need to install JDK on your system. However, you don't need to care about Maven, as wrapper script is included.
```
mvnw package
```
The output jar will be in `target` folder.
2022-02-02 14:58:02 +08:00
Currently, there is no script for making distribution package automatically.
2022-02-02 14:55:48 +08:00
2020-01-15 23:50:52 +08:00
### Credit:
* **samnyan**
* **Akasaka Ryuunosuke** : providing all the DIVA protocol information
2021-12-25 22:34:37 +08:00
* Dom Eori : from v0.0.17 and up
2021-06-20 01:00:57 +08:00
* All devs who contribute to the MiniMe server
2021-12-25 22:34:37 +08:00
* All contributors by merge request, issues and other channels..