mirror of
https://github.com/MewoLab/AquaDX.git
synced 2026-02-09 04:57:27 +08:00
Thank you for playing statement
This commit is contained in:
54
README_project.md
Normal file
54
README_project.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Aqua Server
|
||||
Multipurpose game server powered by Spring Boot, for ALL.Net based games
|
||||
|
||||
This is a forked maintaining attempt of the [original Aqua server](https://dev.s-ul.net/NeumPhis/aqua)
|
||||
|
||||
### Supported Games
|
||||
* CHUNITHM SUN (and below)
|
||||
* CHUNITHM Paradise Lost (and below)
|
||||
* Maimai DX Festival (and below)
|
||||
* Card Maker (1.34)
|
||||
* Project DIVA Arcade Future Tone
|
||||
* O.N.G.E.K.I. bright memory (and below)
|
||||
|
||||
Check out these docs for more information.
|
||||
* [Game specific notes](docs/game_specific_notes.md)
|
||||
* [Frequently asked questions](docs/frequently_asked_questions.md)
|
||||
|
||||
### 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:
|
||||
* Java 17 or above (for running JAR)
|
||||
* Optional databases: MariaDB 10.6.x (recommended) or MySQL 8.0.x
|
||||
|
||||
Run `java -jar aqua-x.x.xx-RELEASE.jar`
|
||||
|
||||
By default, Aqua will use sqlite and save user data in data/db.sqlite.
|
||||
|
||||
If you want to use optional databases, edit configuration file then it will auto create the table and import some initial data.
|
||||
|
||||
### Configuration
|
||||
Configuration is saved in `config/application.properties`, spring loads this file automatically.
|
||||
|
||||
* 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 MariaDB (or MySQL) 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 Gradle, as wrapper script is included.
|
||||
```
|
||||
gradlew clean build
|
||||
```
|
||||
The `build/libs` folder will contain an jar file.
|
||||
|
||||
### Credit
|
||||
* **samnyan**: The creator and developer of the original Aqua server
|
||||
* **Akasaka Ryuunosuke** : providing all the DIVA protocol information
|
||||
* 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
|
||||
Reference in New Issue
Block a user