docs: Update changelog, readme, help, manifests, license agreement an…

…d report
Griefed · Jul 6, 2024 · d6f6a46 · d6f6a46
1 parent dd0a1e9
commit d6f6a46
Show file tree

Hide file tree

Showing 20 changed files with 421 additions and 59 deletions.
diff --git a/HELP.md b/HELP.md
@@ -484,15 +484,56 @@ ServerPackCreator has three main modes in which it can operate or in which you c
 There are a couple more ways to use/run ServerPackCreator which may or may not be helpful for you,
 depending on how you plan on using it:
 
-| Argument  | Description                                                                                                                                                                                                             |
-|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `-help`   | Print ServerPackCreators help to commandline.                                                                                                                                                                           |
-| `-update` | Check whether a newer version of ServerPackCreator is available.                                                                                                                                                        |
-| `-cgen`   | Run ServerPackCreators configuration generation.                                                                                                                                                                        |
-| `-cli`    | Run ServerPackCreator in commandline-mode. If **no** graphical environment is supported, this is the default ServerPackCreator will enter, even when starting ServerPackCreator with no extra arguments at all.         |
-| `-web`    | Run ServerPackCreator as a webservice.                                                                                                                                                                                  |
-| `-gui`    | Run ServerPackCreator with our GUI. If a graphical environment is supported, this is the default ServerPackCreator will enter, even when starting ServerPackCreator with no extra arguments at all.                     |
-| `--setup` | Set up and prepare the environment for subsequent runs of ServerPackCreator. This will create/copy all files needed for ServerPackCreator to function properly from inside its JAR-file and setup everything else, too. |
+```
+  -lang: Allows you to use one of the available languages for ServerPackCreator. I can not
+         guarantee that each of the following available languages is 100% translated.
+         You best choice is en_us, or not specifying any as that is the default, because
+         I write ServerPackCreator with english in mind. Available usages:
+         -lang en_us
+         -lang uk_ua
+         -lang de_de
+
+  -cgen: Only available for the commandline interface. This will start the generation of
+         a new configuration file. You will be asked to enter information about your modpack
+         step-by-step. Each setting you enter will be checked for errors before it is saved.
+         If everything you enter is valid and without errors, it will be written to a new
+         serverpackcreator.conf and ServerPackCreator will immediately start a run with said
+         configuration file, generating a server pack for you.
+
+-update: Check whether a new version of ServerPackCreator is available for download.
+         If an update is available, the version and link to the release of said update are
+         written to the console so you can from work with it from there.
+         Note: Automatic updates are currently not planned nor supported, and neither are
+         downloads of any available updates to your system. You need to update manually.
+
+   -cli: Run ServerPackCreator in Command-line interface mode. Checks the serverpackcreator.conf
+         for errors and if none are found, starts the generation of a server pack with the configuration
+         provided by your serverpackcreator.conf.
+
+   -web: Run ServerPackCreator as a webservice available at http://localhost:8080. The webservice
+         provides the same functionality as running ServerPackCreator in GUI mode (so no Commandline
+         arguments and a non-headless environment) as well as a REST API which can be used in different ways.
+         For more information about the REST API, please see the Java documentation:
+          - GitHub Pages: https://griefed.github.io/ServerPackCreator/
+          - GitLab Pages: https://griefed.pages.griefed.de/ServerPackCreator/
+
+   -gui: Run ServerPackCreator using the graphical user interface. If your environment supports
+         graphics, i.e. is not headless, then this is the default mode in which ServerPackCreator
+         started as when no arguments are used.
+
+--setup: Set up and prepare the environment for subsequent runs of ServerPackCreator.
+         This will create/copy all files needed for ServerPackCreator to function
+         properly from inside its JAR-file and setup everything else, too. You can pass a properties-file, too
+         if you so desire.
+         Examples:
+         --setup "/path/to/custom.properties"
+         --setup "C:\path\to\custom.properties"
+
+--home:  Override the home-directory setting for your user.
+         Examples:
+         --home "/path/to/directory"
+         --home "C:\users\<YOUR_USER>\SPC"
+```
 
 Each of these modes has its advantages and disadvantages.
 

diff --git a/licenses/LICENSE-AGREEMENT b/licenses/LICENSE-AGREEMENT
@@ -500,7 +500,7 @@ URL: https://www.apache.org/licenses/LICENSE-2.0
 (2 of 38)
 Group:   com.electronwill.night-config
 Name:    toml
-Version: 3.7.1
+Version: 3.7.2
 POM Project URL: https://github.com/TheElectronWill/night-config
 
 

diff --git a/licenses/LICENSE-AGREEMENT.txt b/licenses/LICENSE-AGREEMENT.txt
@@ -500,7 +500,7 @@ URL: https://www.apache.org/licenses/LICENSE-2.0
 (2 of 38)
 Group:   com.electronwill.night-config
 Name:    toml
-Version: 3.7.1
+Version: 3.7.2
 POM Project URL: https://github.com/TheElectronWill/night-config
 
 

diff --git a/licenses/index.html b/licenses/index.html
@@ -124,7 +124,7 @@
 <div class='header'>
 <h1>serverpackcreator dev</h1>
 <h2>Dependency License Report</h2>
-<h2 class='timestamp'><em>2024-06-03 19:44:54 MESZ</em>.</h2></div>
+<h2 class='timestamp'><em>2024-07-06 17:07:25 MESZ</em>.</h2></div>
 <h3>Dependency Licences</h3>
 <ul>
 <li><a class='license' href='#Dependency_Licences_Apache_License,_Version_2.0'><span class='name'>Apache License, Version 2.0</span> <span class='badge'>25</span></a></li>
@@ -390,7 +390,7 @@ <h2>GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1</h2>
 <a id='Dependency_Licences_GNU_Lesser_General_Public_License_v3.0'></a>
 <h2>GNU Lesser General Public License v3.0</h2>
 <div class='dependency'>
-<p><strong> 31.</strong> <strong>Group:</strong> com.electronwill.night-config <strong>Name:</strong> toml <strong>Version:</strong> 3.7.1 </p><label>POM Project URL</label>
+<p><strong> 31.</strong> <strong>Group:</strong> com.electronwill.night-config <strong>Name:</strong> toml <strong>Version:</strong> 3.7.2 </p><label>POM Project URL</label>
 <div class='dependency-value'><a href='https://github.com/TheElectronWill/night-config'>https://github.com/TheElectronWill/night-config</a></div>
 <label>POM License</label>
 <div class='dependency-value'>GNU Lesser General Public License v3.0 - <a href='https://www.gnu.org/licenses/lgpl-3.0.txt'>https://www.gnu.org/licenses/lgpl-3.0.txt</a></div>

diff --git a/licenses/licences.md b/licenses/licences.md
@@ -1,7 +1,7 @@
 
 # Dependency Licenses
 ## Dependency License Report
-_2024-06-03 19:44:55 MESZ_
+_2024-07-06 17:07:25 MESZ_
 ## Apache License, Version 2.0
 
 **1** **Group:** `com.cronutils` **Name:** `cron-utils` **Version:** `9.2.1` 
@@ -173,7 +173,7 @@ _2024-06-03 19:44:55 MESZ_
 
 ## GNU Lesser General Public License v3.0
 
-**31** **Group:** `com.electronwill.night-config` **Name:** `toml` **Version:** `3.7.1` 
+**31** **Group:** `com.electronwill.night-config` **Name:** `toml` **Version:** `3.7.2` 
 > - **POM Project URL**: [https://github.com/TheElectronWill/night-config](https://github.com/TheElectronWill/night-config)
 > - **POM License**: GNU Lesser General Public License v3.0 - [https://www.gnu.org/licenses/lgpl-3.0.txt](https://www.gnu.org/licenses/lgpl-3.0.txt)
 

diff --git a/serverpackcreator-api/src/main/resources/CHANGELOG.md b/serverpackcreator-api/src/main/resources/CHANGELOG.md
@@ -1,3 +1,29 @@
+## [6.0.0-beta.11](https://git.griefed.de/Griefed/ServerPackCreator/compare/6.0.0-beta.10...6.0.0-beta.11) (2024-07-06)
+
+
+### 🧪 Tests
+
+* Use apiProps to get server icon and props paths ([858b298](https://git.griefed.de/Griefed/ServerPackCreator/commit/858b298936d1611f44e63c1b372eb10ea374bc5d))
+
+
+### 🛠 Fixes
+
+* Fix GitHub workflows ([200ecdf](https://git.griefed.de/Griefed/ServerPackCreator/commit/200ecdf63cc1d37a8131367051eec7cb06eb76e0))
+
+## [6.0.0-beta.10](https://git.griefed.de/Griefed/ServerPackCreator/compare/6.0.0-beta.9...6.0.0-beta.10) (2024-07-06)
+
+
+### 💎 Improvements
+
+* Store home as user-node Java prefs store prop. Allow override via `--home "/path/to/dir"` arg. Check for home before startup. ([34dba53](https://git.griefed.de/Griefed/ServerPackCreator/commit/34dba53c9ff064e4e114110e6694d7a22939bec5))
+
+
+### 🦊 CI/CD
+
+* Ensure test-dir is used at all times. Various misc changes ([0479ffe](https://git.griefed.de/Griefed/ServerPackCreator/commit/0479ffe9f97d6cd7d298fd3c97990145467b7009))
+* Warn about root. Set home as Java prefs store prop. Use AdoptiumJDK instead of Zulu. ([a68c67f](https://git.griefed.de/Griefed/ServerPackCreator/commit/a68c67f46d8d786ece8e3f2f2cfcf0c49245a46b))
+* Include checksums in release notes and artifacts ([7edc8fb](https://git.griefed.de/Griefed/ServerPackCreator/commit/7edc8fb04a0fe147cffc1aaa5f3ddaa84ed1ad12))
+
 ## [6.0.0-beta.9](https://git.griefed.de/Griefed/ServerPackCreator/compare/6.0.0-beta.8...6.0.0-beta.9) (2024-07-05)
 
 

diff --git a/serverpackcreator-api/src/main/resources/HELP.md b/serverpackcreator-api/src/main/resources/HELP.md
@@ -484,15 +484,56 @@ ServerPackCreator has three main modes in which it can operate or in which you c
 There are a couple more ways to use/run ServerPackCreator which may or may not be helpful for you,
 depending on how you plan on using it:
 
-| Argument  | Description                                                                                                                                                                                                             |
-|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `-help`   | Print ServerPackCreators help to commandline.                                                                                                                                                                           |
-| `-update` | Check whether a newer version of ServerPackCreator is available.                                                                                                                                                        |
-| `-cgen`   | Run ServerPackCreators configuration generation.                                                                                                                                                                        |
-| `-cli`    | Run ServerPackCreator in commandline-mode. If **no** graphical environment is supported, this is the default ServerPackCreator will enter, even when starting ServerPackCreator with no extra arguments at all.         |
-| `-web`    | Run ServerPackCreator as a webservice.                                                                                                                                                                                  |
-| `-gui`    | Run ServerPackCreator with our GUI. If a graphical environment is supported, this is the default ServerPackCreator will enter, even when starting ServerPackCreator with no extra arguments at all.                     |
-| `--setup` | Set up and prepare the environment for subsequent runs of ServerPackCreator. This will create/copy all files needed for ServerPackCreator to function properly from inside its JAR-file and setup everything else, too. |
+```
+  -lang: Allows you to use one of the available languages for ServerPackCreator. I can not
+         guarantee that each of the following available languages is 100% translated.
+         You best choice is en_us, or not specifying any as that is the default, because
+         I write ServerPackCreator with english in mind. Available usages:
+         -lang en_us
+         -lang uk_ua
+         -lang de_de
+
+  -cgen: Only available for the commandline interface. This will start the generation of
+         a new configuration file. You will be asked to enter information about your modpack
+         step-by-step. Each setting you enter will be checked for errors before it is saved.
+         If everything you enter is valid and without errors, it will be written to a new
+         serverpackcreator.conf and ServerPackCreator will immediately start a run with said
+         configuration file, generating a server pack for you.
+
+-update: Check whether a new version of ServerPackCreator is available for download.
+         If an update is available, the version and link to the release of said update are
+         written to the console so you can from work with it from there.
+         Note: Automatic updates are currently not planned nor supported, and neither are
+         downloads of any available updates to your system. You need to update manually.
+
+   -cli: Run ServerPackCreator in Command-line interface mode. Checks the serverpackcreator.conf
+         for errors and if none are found, starts the generation of a server pack with the configuration
+         provided by your serverpackcreator.conf.
+
+   -web: Run ServerPackCreator as a webservice available at http://localhost:8080. The webservice
+         provides the same functionality as running ServerPackCreator in GUI mode (so no Commandline
+         arguments and a non-headless environment) as well as a REST API which can be used in different ways.
+         For more information about the REST API, please see the Java documentation:
+          - GitHub Pages: https://griefed.github.io/ServerPackCreator/
+          - GitLab Pages: https://griefed.pages.griefed.de/ServerPackCreator/
+
+   -gui: Run ServerPackCreator using the graphical user interface. If your environment supports
+         graphics, i.e. is not headless, then this is the default mode in which ServerPackCreator
+         started as when no arguments are used.
+
+--setup: Set up and prepare the environment for subsequent runs of ServerPackCreator.
+         This will create/copy all files needed for ServerPackCreator to function
+         properly from inside its JAR-file and setup everything else, too. You can pass a properties-file, too
+         if you so desire.
+         Examples:
+         --setup "/path/to/custom.properties"
+         --setup "C:\path\to\custom.properties"
+
+--home:  Override the home-directory setting for your user.
+         Examples:
+         --home "/path/to/directory"
+         --home "C:\users\<YOUR_USER>\SPC"
+```
 
 Each of these modes has its advantages and disadvantages.