LITW-Refined/minecraft-modpack-updater
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Admin manual aktualisieren

Pascal
2024-07-10 16:48:18 +00:00
parent 02805beeab
commit 53ea5c141b
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Admin-manual.md

@@ -8,7 +8,6 @@ Create a new json file. This must be accessable via the web via a static url as
{
"Maintenance": false,
"Name": "Life in the Woods: Refined",
"Key": "litw-r",
"InstallUrl": "https://myserver.de/myfiles/install.json",
"UpdateUrl": "https://myserver.de/myfiles/updates.json"
}
@@ -20,9 +19,10 @@ Create a new json file. This must be accessable via the web via a static url as
| ------ | ------ |
| `Maintenance` | Defines if installations/updates on the clients should be surpressed. Can be used for testing purpose while deploying a new update. |
| `Name` | The name of the modpack. Currently it's not shows anywhere, but that will change in the future. |
| `Key` | A short uniquie key for the modpack. This is used as environment value for checking install keys via the Unleash API. |
| `InstallUrl` | An url to another json file defining some informations needed for installation. Splitted to another file to not blow this info file up. As this file is not needed on each update check it is also separated from the update infos. |
| `UpdateUrl` | An url to another json file defining some informations about updates. Splitted to another file to not blow this info file up. |
| `UnleashApiUrl` | The url for your unleash server api endpoint. Optional. |
| `UnleashInstanceId` | The instance id for your unleash server api endpoint. Optional. |
## Installation config
@@ -46,7 +46,7 @@ Each action object describes a step to be do.
| `IsZip` | ✖️ | Set this to `true` or leave empty to. |
| `ZipPath` | ✖️ | The Path within the zip file, if `IsZip` is `true`. Leave empty or `""` to set the root path as destination path.|
| `Side` | ✖️ | Defines the side where this action should take affect. Acceppts `Cleint`, `Server` and `Both` (default). |
| `IsExtra` | ✖️ | Mark the action as extra step wich is only available via an valid installation key. Mostly used for files wich should only be available for private servers, e.g. `defaultserverlist.json`. |
| `IsExtra` | ✖️ | Mark the action as extra step wich is only available via an valid installation key. Mostly used for files wich should only be available for private servers, e.g. `defaultserverlist.json`. Only works if unleash api endpoint is configured. |
## Update config
@@ -64,7 +64,7 @@ Create a new json file. This must be accessable via the web via a static url.
| `IsZip` | ✖️ | Set this to `true` or leave empty to. |
| `ZipPath` | ✖️ | The Path within the zip file, if `IsZip` is `true`. Leave empty or `""` to set the root path as destination path.|
| `Side` | ✖️ | Defines the side where this action should take affect. Acceppts `Cleint`, `Server` and `Both` (default). |
| `IsExtra` | ✖️ | Mark the action as extra step wich is only available via an valid installation key. Mostly used for files wich should only be available for private servers, e.g. `defaultserverlist.json`. |
| `IsExtra` | ✖️ | Mark the action as extra step wich is only available via an valid installation key. Mostly used for files wich should only be available for private servers, e.g. `defaultserverlist.json`. Only works if unleash api endpoint is configured. |
## Setup installation keys