2020-01-15 23:50:52 +08:00
# Aqua Server
2022-04-03 19:59:15 +08:00
Multipurpose game server powered by Spring Boot, for ALL.Net based games
2020-01-15 23:50:52 +08:00
2022-04-03 19:59:15 +08:00
This is a forked maintaining attempt of the [original Aqua server ](https://dev.s-ul.net/NeumPhis/aqua )
### Supported Games
2022-04-10 01:23:51 +08:00
* CHUNITHM NEW Plus (and below)
2021-06-20 01:00:57 +08:00
* CHUNITHM Paradise Lost (and below)
2022-08-12 14:26:08 +08:00
* Maimai DX Universe Plus (and below)
* Card Maker (1.34)
2020-01-15 23:50:52 +08:00
* Project DIVA Arcade Future Tone
2022-04-27 16:36:15 +08:00
* O.N.G.E.K.I. bright memory (and below)
2020-01-15 23:50:52 +08:00
2022-11-13 19:51:08 +08:00
Check out these docs for more information.
* [Game specific notes ](docs/game_specific_notes.md )
* [Frequently asked questions ](docs/frequently_asked_questions.md )
2022-03-10 20:48:20 +08:00
2022-04-03 19:59:15 +08:00
### Notes
2021-12-25 22:34:37 +08:00
* 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
2022-04-03 19:59:15 +08:00
### Usage
2020-01-15 23:50:52 +08:00
Requirements:
2022-03-18 05:28:01 +08:00
* Java 11 or above (for running JAR)
2022-04-10 01:23:51 +08:00
* Optional databases: MariaDB 10.6.x (recommended) or MySQL 8.0.x
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-04-10 01:23:51 +08:00
If you want to use optional databases, edit configuration file then it will auto create the table and import some initial data.
2020-01-15 23:50:52 +08:00
2022-04-03 19:59:15 +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-04-03 19:59:15 +08:00
* You can switch to MariaDB (or MySQL) database by commenting the Sqlite part.
2022-03-11 19:45:32 +08:00
* For some game, you might need to change some game specific config entries.
2020-01-17 00:03:14 +08:00
2022-04-03 19:59:15 +08:00
### Building
2022-02-02 14:55:48 +08:00
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
2022-04-03 19:59:15 +08:00
### Credit
* **samnyan**: The creator and developer of the original Aqua server
2020-01-15 23:50:52 +08:00
* **Akasaka Ryuunosuke** : providing all the DIVA protocol information
2022-04-03 19:59:15 +08:00
* Dom Eori : Developer of forked Aqua server, from v0.0.17 and up
* All devs who contribute to the [MiniMe server ](https://dev.s-ul.net/djhackers/minime )
* All contributors by merge request, issues and other channels
