From 515abf1c17f28264d69d7e163b69bfa91bb5f65c Mon Sep 17 00:00:00 2001 From: Timo Ley Date: Sat, 14 Aug 2021 23:05:46 +0200 Subject: [PATCH] Specify launch install step --- docs/install.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/install.md b/docs/install.md index 8488298..3bb6345 100644 --- a/docs/install.md +++ b/docs/install.md @@ -27,6 +27,18 @@ the given location as working directory. A client should inform the user before ask them for permission to do so and/or it should execute the jar in a closed environment like a container to prevent malicous code from running. +### launch +`launch` + +`launch` can be used to mark the selected file as the launch file for a specific side. Files having this +install step can only have the `client` or the `server` flag, not both. If the file is client-sided, it +has to be a [client JSON file](https://minecraft.fandom.com/wiki/Client.json) as specified by Minecraft +itself. If it is server-sided. it has to be a jar file, which is the file, that should be launched to start +the server. The jar file has to be moved to the root of the instance directory, before using `launch` on it. +Moreover, this install step may only be used with instance addons and there may be only one file for each +side, which has this install step, except all of them are marked as `optional`, in which case they are also +implicitly marked as incompatible. + ### select `select [filename]`