From 25cf1e7561a8f76bf8969014b805db2cf07acd21 Mon Sep 17 00:00:00 2001 From: Timo Ley Date: Fri, 1 Sep 2023 11:32:38 +0200 Subject: [PATCH] use patches array instead of side patches --- docs/concepts/instance.md | 5 ++--- docs/schema/manifest.md | 15 ++++----------- docs/schema/patch.md | 7 +++++++ 3 files changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/concepts/instance.md b/docs/concepts/instance.md index 2af2809..6ce648c 100644 --- a/docs/concepts/instance.md +++ b/docs/concepts/instance.md @@ -36,9 +36,8 @@ Patches are applied in the following order: patches of that instance addon are applied according to the same order rules 2. Patches inherited from the another instance addon using the `patch` [flag](flags.md) in the order, in which the addons are specified in the [relations array](../schema/manifest.md#relations) -3. Patches done directly by the instance addon using the - [client_patches](../schema/manifest.md#clientpatches) and [server_patches](../schema/manifest.md#serverpatches) - properties. +3. Patches done directly by the instance addon using the [patches array](../schema/manifest.md#patches) + in the order, in which they are specified in the array. ## Main file diff --git a/docs/schema/manifest.md b/docs/schema/manifest.md index 14590f7..35a6427 100644 --- a/docs/schema/manifest.md +++ b/docs/schema/manifest.md @@ -12,8 +12,7 @@ "repositories": [], "instance": false, "use_builder": false, - "client_patches": {}, - "server_patches": {}, + "patches": [], "meta": {} } ``` @@ -71,16 +70,10 @@ This is a boolean which specifies, if this addon will use the [environment build Only valid if [instance](#instance) is `true`. If this property is not present, it defaults to `false`. (DEPRECATED) -### client_patches +### patches -This is a [patch object](patch.md) for the client, -which can be used to modify the launch configuration of this instance. -Only available for [instance addons](../concepts/instance.md). - -### server_patches - -This is a [patch object](patch.md) for the server, -which can be used to modify the launch configuration of this instance. +This is an array of [patch object](patch.md) which can be used to modify t +he launch configuration of this instance. Only available for [instance addons](../concepts/instance.md). ### meta diff --git a/docs/schema/patch.md b/docs/schema/patch.md index f0cbbf3..841a14b 100644 --- a/docs/schema/patch.md +++ b/docs/schema/patch.md @@ -2,6 +2,7 @@ ```json { + "side": "client", "main_class": "com.example.SomeClass", "arguments": [], "jvm_arguments": ["-Djvmargument"], @@ -10,6 +11,12 @@ } ``` +## Required properties + +### side + +This specifies, for which side this patch should be applied. Valid values are `client`, `server` and `both`. + ## Optional properties ### main_class