From c82108dbbec0b02fdf18229d05583a249e2005e2 Mon Sep 17 00:00:00 2001 From: Pilzinsel64 Date: Sun, 23 Jun 2024 08:44:59 +0000 Subject: [PATCH] Admin manual aktualisieren --- Admin-manual.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 46 insertions(+), 2 deletions(-) diff --git a/Admin-manual.md b/Admin-manual.md index db1a07b..4c34515 100644 --- a/Admin-manual.md +++ b/Admin-manual.md @@ -1,13 +1,57 @@ ## Modpack configuration -tba +Create a new json file. This must be accessable via the web via a static url as this is the public "modpack config url". + +
Example + +```json +{ + "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" +} +``` +
+ +### Properties + +| Name | Description | +| ------ | ------ | +| `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. | ## Installation config -tba +Create a new json file. This must be accessable via the web via a static url as this is the public "modpack config url". + +### Properties + +| Name | Description | +| ------ | ------ | +| Version | The version this install config represents. | +| Actions | An array of action objects. | + +### Properties of an action + +Each action object describes a step to be do. + +| Name | Description | +| ------ | ------ | +| | | +| | | +| | | +| | | +| | | ## Update config +Create a new json file. This must be accessable via the web via a static url as this is the public "modpack config url". + tba ## Setup installation keys