diff --git a/docs/concepts/install.md b/docs/concepts/install.md index 0b7cc51..854f37c 100644 --- a/docs/concepts/install.md +++ b/docs/concepts/install.md @@ -1,6 +1,6 @@ # File installing -## Install commands +## Install actions ### move @@ -8,7 +8,7 @@ args: - `[location]` -`move` is simplest install step of all. It just moves the selected file to +`move` is simplest install action of all. It just moves the file to the given location. ### extract @@ -26,7 +26,7 @@ args: - `[new name]` -`rename` renames the selected file to the new given filename. +`rename` renames the file to the new given filename. ### inject @@ -38,13 +38,13 @@ are also in injected file. ### 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 +`launch` can be used to mark the file as the launch file for a specific side. Files having this +install action 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 launchable or 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 +Moreover, this install action may only be used with launchable or instance addons and there may be only one file for each +side, which has this install action, except all of them are marked as `optional`, in which case they are also implicitly marked as incompatible to each other. ## Locations @@ -54,6 +54,6 @@ For example `./mods` would point to the mods directory of the Minecraft instance ## Directories -If the selected file is a directory, then it is treated like a zip file, which means, that you can move and -rename it like a normal file, but also use the `extract` install step to move all contents of the directory +If the file is a directory, then it is treated like a zip file, which means, that you can move and +rename it like a normal file, but also use the `extract` install action to move all contents of the directory to the specified location. diff --git a/docs/schema/install.md b/docs/schema/install.md index f3e75cd..ef75d54 100644 --- a/docs/schema/install.md +++ b/docs/schema/install.md @@ -2,19 +2,19 @@ ```json { - "command": "move", + "action": "move", "args": ["./mods"] } ``` ## Required properties -### command +### action -This is the [install command](../concepts/install.md), which should be used at this installation step. +This is the [install action](../concepts/install.md), which should be used at this installation step. ## Optional properties ### args -This is an array of arguments for the [install command](../concepts/install.md). Each of them takes other arguments. +This is an array of arguments for the [install action](../concepts/install.md). Each of them takes other arguments.