diff --git a/HELP.md b/HELP.md index 232fc9be8..e23d02358 100644 --- a/HELP.md +++ b/HELP.md @@ -538,21 +538,21 @@ restart it in order for the plugins to become disabled. The serverpackcreator.conf file allows you to customize a couple of different things: -| Variable | Description | -|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| modpackDir | The path to the directory/ZIP-archive where your modpack resides in. | -| clientMods | Each inclusion-specification ensures that the file or directory from `source` gets included in your server pack one way or another.
A basic configuration usually contains the `mods` and `config` directories. No need to prefix them with the path to your modpack.
ServerPackCreator will take care of that automatically by itself.
If you want to include files or folders *outside* of your modpack, then you will need to specify the whole path.
Below are some examples for including files from your modpack (`mods` and `config`) as well as files and folders from outside the modpack.
[[inclusions]]
    destination = ""
    exclusionFilter = ""
    source = "config"
    inclusionFilter = ""
[[inclusions]]
    destination = ""
    exclusionFilter = ""
    source = "mods"
    inclusionFilter = ""
[[inclusions]]
    destination = "SomeFiles"
    exclusionFilter = ""
    source = "C:\\Some\\Path\\With\Files
    inclusionFilter = ""
[[inclusions]]
    destination = "somefiles"
    exclusionFilter = ""
    source = "/home/myuser/some/files"
    inclusionFilter = ""
[[inclusions]]
    destination = "MyInstructions.md"
    exclusionFilter = ""
    source = "C:\\MyAwesomeModpack\\Stuff\\HowTo.md"br>    inclusionFilter = ""
[[inclusions]]
    destination = "MyInstructions.md"
    exclusionFilter = ""
    source ="/home/myuser/my_awesome_modpack/HOWTO.md"
    inclusionFilter = "" | -| [scripts]
SPC_JAVA_SPC = "java" | Path to the Java Installation. On Linux systems use `which java` to find the location of your Java install. On Windows use `where java` and exclude the `.exe`-part. Note, that changing this value only affects the *unzipped* server pack's `variables.txt`. The one in the *zipped* server pack is unaffected by this setting and will always point to `java` to increase compatibility with users who download the *zipped* server pack. | -| minecraftVersion | The version of Minecraft for which to install the modloader server. The same version of Minecraft your modpack uses. | -| modLoader | Which modloader to install. Must be either "Forge", "NeoForge", "Fabric", "Quilt" or "LegacyFabric". The same modloader your modpack uses. | -| modLoaderVersion | Specific Modloader version to install the server in the serverpack. The same version your modpack uses. | -| includeServerIcon | Whether to include server-icon.png in your serverpack. Must be `true` or `false`. | -| includeServerProperties | Whether to include server.properties in your serverpack. Must be `true` or `false`. | -| includeZipCreation | Whether to create a zip-file of your serverpack, saved in the directory you specified with `modpackDir`. Must be `true` or `false`. | -| javaArgs | JVM flags / Java Args to add to the generated start-scripts. Set to "empty" to not use any in your start-scripts. | -| serverPackSuffix | A suffix to append to the name of the server pack directory and server pack ZIP-archive. Illegal characters are / < > : " \ | ? * # % & { } $ ! ' @ + ´ \` = and must not end with a SPACE or a DOT . | | -| serverIconPath | Path to a custom server-icon.png-file to include in the server pack. | -| serverPropertiesPath | Path to a custom server.properties-file to include in the server pack. | +| Variable | Description | +|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| modpackDir | The path to the directory/ZIP-archive where your modpack resides in. | +| [[inclusions]] | Each inclusion-specification ensures that the file or directory from `source` gets included in your server pack one way or another.
A basic configuration usually contains the `mods` and `config` directories. No need to prefix them with the path to your modpack.
ServerPackCreator will take care of that automatically by itself.
If you want to include files or folders *outside* of your modpack, then you will need to specify the whole path.
Below are some examples for including files from your modpack (`mods` and `config`) as well as files and folders from outside the modpack.
[[inclusions]]
    destination = ""
    exclusionFilter = ""
    source = "config"
    inclusionFilter = ""
[[inclusions]]
    destination = ""
    exclusionFilter = ""
    source = "mods"
    inclusionFilter = ""
[[inclusions]]
    destination = "SomeFiles"
    exclusionFilter = ""
    source = "C:\\Some\\Path\\With\Files
    inclusionFilter = ""
[[inclusions]]
    destination = "somefiles"
    exclusionFilter = ""
    source = "/home/myuser/some/files"
    inclusionFilter = ""
[[inclusions]]
    destination = "MyInstructions.md"
    exclusionFilter = ""
    source = "C:\\MyAwesomeModpack\\Stuff\\HowTo.md"br>    inclusionFilter = ""
[[inclusions]]
    destination = "MyInstructions.md"
    exclusionFilter = ""
    source ="/home/myuser/my_awesome_modpack/HOWTO.md"
    inclusionFilter = "" | +| [scripts]
    SPC_JAVA_SPC = "java" | Path to the Java Installation. On Linux systems use `which java` to find the location of your Java install. On Windows use `where java` and exclude the `.exe`-part. Note, that changing this value only affects the *unzipped* server pack's `variables.txt`. The one in the *zipped* server pack is unaffected by this setting and will always point to `java` to increase compatibility with users who download the *zipped* server pack. | +| minecraftVersion | The version of Minecraft for which to install the modloader server. The same version of Minecraft your modpack uses. | +| modLoader | Which modloader to install. Must be either "Forge", "NeoForge", "Fabric", "Quilt" or "LegacyFabric". The same modloader your modpack uses. | +| modLoaderVersion | Specific Modloader version to install the server in the serverpack. The same version your modpack uses. | +| includeServerIcon | Whether to include server-icon.png in your serverpack. Must be `true` or `false`. | +| includeServerProperties | Whether to include server.properties in your serverpack. Must be `true` or `false`. | +| includeZipCreation | Whether to create a zip-file of your serverpack, saved in the directory you specified with `modpackDir`. Must be `true` or `false`. | +| javaArgs | JVM flags / Java Args to add to the generated start-scripts. Set to "empty" to not use any in your start-scripts. | +| serverPackSuffix | A suffix to append to the name of the server pack directory and server pack ZIP-archive. Illegal characters are / < > : " \ | ? * # % & { } $ ! ' @ + ´ \` = and must not end with a SPACE or a DOT . | | +| serverIconPath | Path to a custom server-icon.png-file to include in the server pack. | +| serverPropertiesPath | Path to a custom server.properties-file to include in the server pack. | ### serverpackcreator.properties diff --git a/serverpackcreator-app/src/main/resources/HELP.md b/serverpackcreator-app/src/main/resources/HELP.md index 232fc9be8..e23d02358 100644 --- a/serverpackcreator-app/src/main/resources/HELP.md +++ b/serverpackcreator-app/src/main/resources/HELP.md @@ -538,21 +538,21 @@ restart it in order for the plugins to become disabled. The serverpackcreator.conf file allows you to customize a couple of different things: -| Variable | Description | -|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| modpackDir | The path to the directory/ZIP-archive where your modpack resides in. | -| clientMods | Each inclusion-specification ensures that the file or directory from `source` gets included in your server pack one way or another.
A basic configuration usually contains the `mods` and `config` directories. No need to prefix them with the path to your modpack.
ServerPackCreator will take care of that automatically by itself.
If you want to include files or folders *outside* of your modpack, then you will need to specify the whole path.
Below are some examples for including files from your modpack (`mods` and `config`) as well as files and folders from outside the modpack.
[[inclusions]]
    destination = ""
    exclusionFilter = ""
    source = "config"
    inclusionFilter = ""
[[inclusions]]
    destination = ""
    exclusionFilter = ""
    source = "mods"
    inclusionFilter = ""
[[inclusions]]
    destination = "SomeFiles"
    exclusionFilter = ""
    source = "C:\\Some\\Path\\With\Files
    inclusionFilter = ""
[[inclusions]]
    destination = "somefiles"
    exclusionFilter = ""
    source = "/home/myuser/some/files"
    inclusionFilter = ""
[[inclusions]]
    destination = "MyInstructions.md"
    exclusionFilter = ""
    source = "C:\\MyAwesomeModpack\\Stuff\\HowTo.md"br>    inclusionFilter = ""
[[inclusions]]
    destination = "MyInstructions.md"
    exclusionFilter = ""
    source ="/home/myuser/my_awesome_modpack/HOWTO.md"
    inclusionFilter = "" | -| [scripts]
SPC_JAVA_SPC = "java" | Path to the Java Installation. On Linux systems use `which java` to find the location of your Java install. On Windows use `where java` and exclude the `.exe`-part. Note, that changing this value only affects the *unzipped* server pack's `variables.txt`. The one in the *zipped* server pack is unaffected by this setting and will always point to `java` to increase compatibility with users who download the *zipped* server pack. | -| minecraftVersion | The version of Minecraft for which to install the modloader server. The same version of Minecraft your modpack uses. | -| modLoader | Which modloader to install. Must be either "Forge", "NeoForge", "Fabric", "Quilt" or "LegacyFabric". The same modloader your modpack uses. | -| modLoaderVersion | Specific Modloader version to install the server in the serverpack. The same version your modpack uses. | -| includeServerIcon | Whether to include server-icon.png in your serverpack. Must be `true` or `false`. | -| includeServerProperties | Whether to include server.properties in your serverpack. Must be `true` or `false`. | -| includeZipCreation | Whether to create a zip-file of your serverpack, saved in the directory you specified with `modpackDir`. Must be `true` or `false`. | -| javaArgs | JVM flags / Java Args to add to the generated start-scripts. Set to "empty" to not use any in your start-scripts. | -| serverPackSuffix | A suffix to append to the name of the server pack directory and server pack ZIP-archive. Illegal characters are / < > : " \ | ? * # % & { } $ ! ' @ + ´ \` = and must not end with a SPACE or a DOT . | | -| serverIconPath | Path to a custom server-icon.png-file to include in the server pack. | -| serverPropertiesPath | Path to a custom server.properties-file to include in the server pack. | +| Variable | Description | +|------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| modpackDir | The path to the directory/ZIP-archive where your modpack resides in. | +| [[inclusions]] | Each inclusion-specification ensures that the file or directory from `source` gets included in your server pack one way or another.
A basic configuration usually contains the `mods` and `config` directories. No need to prefix them with the path to your modpack.
ServerPackCreator will take care of that automatically by itself.
If you want to include files or folders *outside* of your modpack, then you will need to specify the whole path.
Below are some examples for including files from your modpack (`mods` and `config`) as well as files and folders from outside the modpack.
[[inclusions]]
    destination = ""
    exclusionFilter = ""
    source = "config"
    inclusionFilter = ""
[[inclusions]]
    destination = ""
    exclusionFilter = ""
    source = "mods"
    inclusionFilter = ""
[[inclusions]]
    destination = "SomeFiles"
    exclusionFilter = ""
    source = "C:\\Some\\Path\\With\Files
    inclusionFilter = ""
[[inclusions]]
    destination = "somefiles"
    exclusionFilter = ""
    source = "/home/myuser/some/files"
    inclusionFilter = ""
[[inclusions]]
    destination = "MyInstructions.md"
    exclusionFilter = ""
    source = "C:\\MyAwesomeModpack\\Stuff\\HowTo.md"br>    inclusionFilter = ""
[[inclusions]]
    destination = "MyInstructions.md"
    exclusionFilter = ""
    source ="/home/myuser/my_awesome_modpack/HOWTO.md"
    inclusionFilter = "" | +| [scripts]
    SPC_JAVA_SPC = "java" | Path to the Java Installation. On Linux systems use `which java` to find the location of your Java install. On Windows use `where java` and exclude the `.exe`-part. Note, that changing this value only affects the *unzipped* server pack's `variables.txt`. The one in the *zipped* server pack is unaffected by this setting and will always point to `java` to increase compatibility with users who download the *zipped* server pack. | +| minecraftVersion | The version of Minecraft for which to install the modloader server. The same version of Minecraft your modpack uses. | +| modLoader | Which modloader to install. Must be either "Forge", "NeoForge", "Fabric", "Quilt" or "LegacyFabric". The same modloader your modpack uses. | +| modLoaderVersion | Specific Modloader version to install the server in the serverpack. The same version your modpack uses. | +| includeServerIcon | Whether to include server-icon.png in your serverpack. Must be `true` or `false`. | +| includeServerProperties | Whether to include server.properties in your serverpack. Must be `true` or `false`. | +| includeZipCreation | Whether to create a zip-file of your serverpack, saved in the directory you specified with `modpackDir`. Must be `true` or `false`. | +| javaArgs | JVM flags / Java Args to add to the generated start-scripts. Set to "empty" to not use any in your start-scripts. | +| serverPackSuffix | A suffix to append to the name of the server pack directory and server pack ZIP-archive. Illegal characters are / < > : " \ | ? * # % & { } $ ! ' @ + ´ \` = and must not end with a SPACE or a DOT . | | +| serverIconPath | Path to a custom server-icon.png-file to include in the server pack. | +| serverPropertiesPath | Path to a custom server.properties-file to include in the server pack. | ### serverpackcreator.properties