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

[general] Update README.md

pull/1/head
Dom Eori 2023-01-08 01:56:04 +09:00
parent 56cc9056e6
commit e625252927
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -22,10 +22,10 @@ Check out these docs for more information.
### Usage ### Usage
Requirements: Requirements:
* Java 11 or above (for running JAR) * Java 17 or above (for running JAR)
* Optional databases: MariaDB 10.6.x (recommended) or MySQL 8.0.x * 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) Run `java -jar aqua-x.x.xx-RELEASE.jar`
By default, Aqua will use sqlite and save user data in data/db.sqlite. By default, Aqua will use sqlite and save user data in data/db.sqlite.
@ -40,11 +40,11 @@ This will be send to the game at booting and being used by following request.
* For some game, you might need to change some game specific config entries. * For some game, you might need to change some game specific config entries.
### Building ### Building
You need to install JDK on your system. However, you don't need to care about Maven, as wrapper script is included. You need to install JDK on your system. However, you don't need to care about Gradle, as wrapper script is included.
``` ```
mvnw package gradlew clean build
``` ```
The `target` folder will contain an uberjar and standalone distribution package with JRE included. The `build/libs` folder will contain an jar file.
### Credit ### Credit
* **samnyan**: The creator and developer of the original Aqua server * **samnyan**: The creator and developer of the original Aqua server