archive
/
AquaDX
mirror of https://github.com/hykilpikonna/AquaDX
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Update Readme

pull/1/head
Dom Eori 2022-04-10 02:23:51 +09:00
parent 8a349f630e
commit e8ae2d5ebc
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -4,7 +4,7 @@ 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 New
* CHUNITHM NEW Plus (and below)
* CHUNITHM Paradise Lost (and below)
* Maimai DX Universe (and below)
* Project DIVA Arcade Future Tone
@ -20,15 +20,13 @@ Read [game specific notes](docs/game_specific_notes.md) for more information.
### Usage
Requirements:
* Java 11 or above (for running JAR)
* Optional: MariaDB (preferred) or MySQL
* Optional databases: MariaDB 10.6.x (recommended) or MySQL 8.0.x
Run `java -jar aqua-x.x.xx-RELEASE.jar` or `aqua-x.x.xx-RELEASE.exe` (on Windows)
By default, Aqua will use sqlite and save user data in data/db.sqlite.
If you want to MariaDB (or MySQL), edit configuration then it will auto create the table and import some initial data.
Please go to the database migration tool's website to check if your database version is being supported https://flywaydb.org/documentation/database/mariadb
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.