Upstream/SubServers-2
1
0
Fork 0
mirror of https://github.com/ME1312/SubServers-2.git synced 2024-11-29 05:36:13 +01:00
Code Issues Projects Releases Wiki Activity

Updated SubCreator (markdown)

ME1312 2020-06-13 04:20:15 -04:00
parent 7e75fb681d
commit dcaf19d3f9
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
SubCreator.md

@ -46,7 +46,7 @@ Template:
Executable: 'java -jar myfile.jar' Executable: 'java -jar myfile.jar'
``` ```
`Template` **[Object]**: Settings container for this template. All of these values are optional unless otherwise specified. See the [Configuration](https://github.com/ME1312/SubServers-2/wiki/Configuration) for more info on the value types and modifiers used here.<br> `Template` **[Object]**: Settings container for this template. All of these values are optional unless otherwise specified. See the [Configuration](https://github.com/ME1312/SubServers-2/wiki/Configuration) for more info on the value types and modifiers used here.<br>
&nbsp; &nbsp; `Enabled` **[Boolean]**: Whether this template is enabled<br> &nbsp; &nbsp; `Enabled` **[Boolean]**: Set whether this template is enabled<br>
&nbsp; &nbsp; `Display` **[String]**: Set the display name of this template<br> &nbsp; &nbsp; `Display` **[String]**: Set the display name of this template<br>
&nbsp; &nbsp; `Icon` **[Item]**: Set the item icon of this template<br> &nbsp; &nbsp; `Icon` **[Item]**: Set the item icon of this template<br>
&nbsp; &nbsp; `Build` **[Object]**: SubCreator build options<br> &nbsp; &nbsp; `Build` **[Object]**: SubCreator build options<br>
@ -54,11 +54,11 @@ Template:
&nbsp; &nbsp; &nbsp; &nbsp; `Replace` **[File Path List]**: Select files to replace variables in ([How?](https://github.com/ME1312/SubServers-2/wiki/SubCreator#Other-Files))<br> &nbsp; &nbsp; &nbsp; &nbsp; `Replace` **[File Path List]**: Select files to replace variables in ([How?](https://github.com/ME1312/SubServers-2/wiki/SubCreator#Other-Files))<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Replacements` **[Object]**: Define custom variables for this build<br> &nbsp; &nbsp; &nbsp; &nbsp; `Replacements` **[Object]**: Define custom variables for this build<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Server-Type` **[Enum Value]**: Set which [ServerType](https://dev.me1312.net/jenkins/job/SubServers%20Platform/javadoc/SubServers.Bungee/net/ME1312/SubServers/Bungee/Host/SubCreator.ServerType.html) this template will build<br> &nbsp; &nbsp; &nbsp; &nbsp; `Server-Type` **[Enum Value]**: Set which [ServerType](https://dev.me1312.net/jenkins/job/SubServers%20Platform/javadoc/SubServers.Bungee/net/ME1312/SubServers/Bungee/Host/SubCreator.ServerType.html) this template will build<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Use-Cache` **[Boolean]**: Creates and forwards a valid cache directory to the script when true<br> &nbsp; &nbsp; &nbsp; &nbsp; `Use-Cache` **[Boolean]**: Creates and forwards a valid cache directory to the build script<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Install-Client` **[Boolean]**: Toggles whether SubServers.Client will be installed<br> &nbsp; &nbsp; &nbsp; &nbsp; `Install-Client` **[Boolean]**: Toggles whether SubServers.Client will be installed<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Require-Version` **[Boolean]**: Switches the `[Version]` field from optional to required<br> &nbsp; &nbsp; &nbsp; &nbsp; `Require-Version` **[Boolean]**: Switches the `[Version]` field from optional to required<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Can-Update` **[Boolean]**: Signals that this template can update servers created by it<br> &nbsp; &nbsp; &nbsp; &nbsp; `Can-Update` **[Boolean]**: Signals that this template can update servers created by it<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Update-Files` **[Boolean]**: Replace files that differ from the template files<br> &nbsp; &nbsp; &nbsp; &nbsp; `Update-Files` **[Boolean]**: Replaces files that differ from the template files<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Executable` **[File Path/String]**: A command to execute or the path to a script to execute.<br> &nbsp; &nbsp; &nbsp; &nbsp; `Executable` **[File Path/String]**: A command to execute or the path to a script to execute.<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Run-On-Finish` **[Boolean]**: Whether this subserver will be started after SubCreator finishes<br> &nbsp; &nbsp; &nbsp; &nbsp; `Run-On-Finish` **[Boolean]**: Whether this subserver will be started after SubCreator finishes<br>
&nbsp; &nbsp; `Settings` **[Object]**: Sets the default options for the subserver. Any setting from the `Servers` section of the [main configuration](https://github.com/ME1312/SubServers-2/wiki/Configuration#subserversserversyml-global-configuration) is valid here. Additionally, you can use variables for this object's strings using this format: `$variable$`.<br><br> &nbsp; &nbsp; `Settings` **[Object]**: Sets the default options for the subserver. Any setting from the `Servers` section of the [main configuration](https://github.com/ME1312/SubServers-2/wiki/Configuration#subserversserversyml-global-configuration) is valid here. Additionally, you can use variables for this object's strings using this format: `$variable$`.<br><br>