From 77597c448df033850cf7e168e6a0c051787e8b0d Mon Sep 17 00:00:00 2001 From: skylerspaeth Date: Sat, 21 May 2022 23:44:50 -0500 Subject: [PATCH 1/4] add worlds dir path to docs --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 143be2729ff..fe195bf6305 100644 --- a/README.md +++ b/README.md @@ -834,6 +834,13 @@ The following diagram shows how this option can be used in a compose deployment ### Overwrite world on start The world will only be downloaded or copied if it doesn't exist already. Set `FORCE_WORLD_COPY=TRUE` to force overwrite the world on every server start. +### Custom worlds directory path +To set a custom worlds directory for the Multiverse plugin on a baremetal server, you'd pass the `--world-dir` argument after the jar file. +In order to accomplish the same in a containerized server, set the `EXTRA_ARGS` environment variable in your command line or docker compose yaml. +``` +docker run -d -e EXTRA_ARGS='--world-dir ./worlds/' +``` + ### Datapacks Datapacks can be installed in a similar manner to mods/plugins. There are many environment variables which function in the same way they do for [mods](#working-with-mods-and-plugins): * `DATAPACKS` From e784316604a9bece4b3c250a9c5e713831a341bc Mon Sep 17 00:00:00 2001 From: skylerspaeth Date: Sat, 21 May 2022 23:47:09 -0500 Subject: [PATCH 2/4] add aliases to make searching docs easier --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index fe195bf6305..840928dcace 100644 --- a/README.md +++ b/README.md @@ -840,6 +840,7 @@ In order to accomplish the same in a containerized server, set the `EXTRA_ARGS` ``` docker run -d -e EXTRA_ARGS='--world-dir ./worlds/' ``` +`--world-container`, `-W`, and `--universe` are aliases to `--world-dir` and can also be used. ### Datapacks Datapacks can be installed in a similar manner to mods/plugins. There are many environment variables which function in the same way they do for [mods](#working-with-mods-and-plugins): From b696aca72a38984f3619b100b4801c57a59a584f Mon Sep 17 00:00:00 2001 From: skylerspaeth Date: Sat, 21 May 2022 23:50:19 -0500 Subject: [PATCH 3/4] update worlds path verbage --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 840928dcace..bc34f26ae45 100644 --- a/README.md +++ b/README.md @@ -836,7 +836,7 @@ The world will only be downloaded or copied if it doesn't exist already. Set `FO ### Custom worlds directory path To set a custom worlds directory for the Multiverse plugin on a baremetal server, you'd pass the `--world-dir` argument after the jar file. -In order to accomplish the same in a containerized server, set the `EXTRA_ARGS` environment variable in your command line or docker compose yaml. +In order to accomplish the same in a containerized server, set the `EXTRA_ARGS` environment variable in your command line or docker compose yaml to the same argument string. For example: ``` docker run -d -e EXTRA_ARGS='--world-dir ./worlds/' ``` From 8d9d6e01a73fbc3d32c6e01a0da9e67915ec62da Mon Sep 17 00:00:00 2001 From: skylerspaeth Date: Sun, 22 May 2022 01:32:04 -0500 Subject: [PATCH 4/4] add jarfile options docs --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index bc34f26ae45..5356d5c165d 100644 --- a/README.md +++ b/README.md @@ -1446,6 +1446,10 @@ environment variable. The JVM requires `-XX` options to precede `-X` options, so For some cases, if e.g. after removing mods, it could be necessary to startup minecraft with an additional `-D` parameter like `-Dfml.queryResult=confirm`. To address this you can use the environment variable `JVM_DD_OPTS`, which builds the params from a given list of values separated by space, but without the `-D` prefix. To make things running under systems (e.g. Plesk), which doesn't allow `=` inside values, a `:` (colon) could be used instead. The upper example would look like this: `JVM_DD_OPTS=fml.queryResult:confirm`, and will be converted to `-Dfml.queryResult=confirm`. +### Jarfile Options +Options that would usually be passed to the jar file (those which are written after the filename) can be passed via the `EXTRA_ARGS` environment variable. +See [Custom worlds directory path](#custom-worlds-directory-path) for an example. + ### Interactive and Color Console If you would like to `docker attach` to the Minecraft server console with color and interactive capabilities, then add