2020-01-15 23:50:52 +08:00
# Aqua Server
2022-03-10 20:48:20 +08:00
Multipurpose game server powered by Spring Boot.
2020-01-15 23:50:52 +08:00
### Supported Game:
2022-03-11 19:45:32 +08:00
* CHUNITHM New
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
2022-03-19 23:32:16 +08:00
Read [game specific notes ](docs/game_specific_notes.md ) for more information.
2022-03-10 20:48:20 +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.
2022-03-10 20:48:20 +08:00
* 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.
2022-03-11 19:45:32 +08:00
* This server also provides a simple API for viewing play records and edit settings for some games.
2021-12-25 22:34:37 +08:00
2020-01-15 23:50:52 +08:00
### Usage:
Requirements:
2022-03-18 05:28:01 +08:00
* Java 11 or above (for running JAR)
2022-03-17 14:32:32 +08:00
* Optional: MariaDB (preferred) or MySQL (< 8.0 )
2020-01-15 23:50:52 +08:00
2022-03-18 05:28:01 +08:00
Run `java -jar aqua-x.x.xx-RELEASE.jar` or `aqua-x.x.xx-RELEASE.exe` (on Windows)
2020-01-15 23:50:52 +08:00
2022-03-10 20:48:20 +08:00
By default, Aqua will use sqlite and save user data in data/db.sqlite.
2020-01-15 23:50:52 +08:00
2022-03-17 14:32:32 +08:00
If you want to MariaDB (or MySQL < 8.0 ) , 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:
2022-03-18 05:28:01 +08:00
Configuration is saved in `config/application.properties` , spring loads this file automatically.
2020-01-15 23:50:52 +08:00
2022-03-11 19:45:32 +08:00
* 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.
2022-03-11 19:45:32 +08:00
* 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.
2020-01-17 00:03:14 +08:00
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
```
2022-03-18 05:28:01 +08:00
The `target` folder will contain an uberjar and standalone distribution package with JRE included.
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..
