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

Admin manual aktualisieren

Pascal
2024-06-23 09:03:49 +00:00
parent c82108dbbe
commit 3126730a7c
1 changed files with 21 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
Admin-manual.md

@@ -40,19 +40,32 @@ Create a new json file. This must be accessable via the web via a static url as
Each action object describes a step to be do.
| Name | Description |
| ------ | ------ |
| | |
| | |
| | |
| | |
| | |
| Name | Required | Description |
| ------ | ------ | ------ |
| `DestPath` | ✔️ | The destination path. This normally should be a file. If `IsZip` is `true`, then this should be a directory. You don't need to start or end with an `/`. |
| `DownloadUrl` | ✔️ | A public static link to a file. This can be from your own server, from CurseForge, Modrinth, GitHub, GitLab or whatever. |
| `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`. |
## 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
### Properties for an action
| Name | Required | Description |
| ------ | ------ | ------ |
| `Type` | ✔️ | Defines the update action. Can be `Update`, `Delete`, `Copy`, `Move` and `None`. |
| `DestPath` | `Copy`, `Move` | The destination path. This normally should be a file. If `IsZip` is `true`, then this should be a directory. You don't need to start or end with an `/`. |
| `SrcPath` | `Copy`, `Move` | The source file or directory path. |
| `DownloadUrl` | `Update` | A public static link to a file. This can be from your own server, from CurseForge, Modrinth, GitHub, GitLab or whatever. This property is not required if `Typer` is `Delete`. |
| `IsDirectory` | `Copy`, `Move` | 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`. |
| `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`. |
## Setup installation keys