From 75f4bb3364d6784df53969b4e48d681174bf7b5a Mon Sep 17 00:00:00 2001 From: akiroz Date: Fri, 18 Mar 2022 05:28:01 +0800 Subject: [PATCH 1/2] Compile standalone distribution package --- README.md | 12 +++++----- {docs => config}/application.properties | 0 {docs => config}/game_specific_notes.md | 0 pom.xml | 29 +++++++++++++++++++++++++ 4 files changed, 34 insertions(+), 7 deletions(-) rename {docs => config}/application.properties (100%) rename {docs => config}/game_specific_notes.md (100%) diff --git a/README.md b/README.md index 55aae921..4e896cd8 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Multipurpose game server powered by Spring Boot. * Project DIVA Arcade Future Tone * O.N.G.E.K.I. bright (and below) -Read [game specific notes](docs/game_specific_notes.md) for more information. +Read [game specific notes](config/game_specific_notes.md) for more information. ### 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. @@ -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/docs/game_specific_notes.md b/config/game_specific_notes.md similarity index 100% rename from docs/game_specific_notes.md rename to config/game_specific_notes.md diff --git a/pom.xml b/pom.xml index b2bc9b77..bbc741e5 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 + + + + + From 6e755f48aab4d9df8bdb03c13320c0753b443d72 Mon Sep 17 00:00:00 2001 From: akiroz Date: Sat, 19 Mar 2022 23:32:16 +0800 Subject: [PATCH 2/2] move game specific notes back to docs dir --- README.md | 2 +- {config => docs}/game_specific_notes.md | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename {config => docs}/game_specific_notes.md (100%) diff --git a/README.md b/README.md index 4e896cd8..aac8ac63 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Multipurpose game server powered by Spring Boot. * Project DIVA Arcade Future Tone * O.N.G.E.K.I. bright (and below) -Read [game specific notes](config/game_specific_notes.md) for more information. +Read [game specific notes](docs/game_specific_notes.md) for more information. ### 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. diff --git a/config/game_specific_notes.md b/docs/game_specific_notes.md similarity index 100% rename from config/game_specific_notes.md rename to docs/game_specific_notes.md