diff --git a/README.md b/README.md index 55aae921..aac8ac63 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,10 @@ Read [game specific notes](docs/game_specific_notes.md) for more information. ### Usage: Requirements: -* Java 11 or above +* Java 11 or above (for running JAR) * Optional: MariaDB (preferred) or MySQL (<8.0) -Run `java -jar aqua.jar` or use the `start.bat` if you are using windows. +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. @@ -29,7 +29,7 @@ If you want to MariaDB (or MySQL <8.0), edit configuration then it will auto cre Please go to the database migration tool's website to check if your database version is being supported https://flywaydb.org/documentation/database/mariadb ### Configuration: -Configuration is save in `application.properties` +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. @@ -41,9 +41,7 @@ You need to install JDK on your system. However, you don't need to care about Ma ``` mvnw package ``` -The output jar will be in `target` folder. - -Currently, there is no script for making distribution package automatically. +The `target` folder will contain an uberjar and standalone distribution package with JRE included. ### Credit: * **samnyan** diff --git a/docs/application.properties b/config/application.properties similarity index 100% rename from docs/application.properties rename to config/application.properties diff --git a/pom.xml b/pom.xml index 6e8dc580..3dbe72c4 100644 --- a/pom.xml +++ b/pom.xml @@ -121,6 +121,35 @@ org.springframework.boot spring-boot-maven-plugin + + io.github.fvarrui + javapackager + 1.6.5 + + + package + + package + + + ${artifactId}-${version} + icu.samnyan.aqua.AquaServerApplication + true + false + false + false + auto + + config + data + + + console + + + + +