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

Updated SubCreator (markdown)

ME1312 2019-12-11 22:09:34 -05:00
parent 61e13d9f11
commit 6faa747f31
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

@ -48,7 +48,7 @@ Template:
&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>
&nbsp; &nbsp; &nbsp; &nbsp; `Import` **[Enum Value List]**: Import and run other templates by name<br> &nbsp; &nbsp; &nbsp; &nbsp; `Import` **[Enum Value List]**: Import and run other templates by name<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Server-Type` **[Enum Value]**: Set which [ServerType](https://src.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 script when true<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>
@ -57,7 +57,7 @@ Template:
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `name`: The name of the new server<br> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `name`: The name of the new server<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `host`: The name of the host that was selected<br> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `host`: The name of the host that was selected<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `template`: The name of the template being used<br> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `template`: The name of the template being used<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `type`: The [ServerType](https://src.me1312.net/jenkins/job/SubServers%20Platform/javadoc/SubServers.Bungee/net/ME1312/SubServers/Bungee/Host/SubCreator.ServerType.html) the template will create<br> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `type`: The [ServerType](https://dev.me1312.net/jenkins/job/SubServers%20Platform/javadoc/SubServers.Bungee/net/ME1312/SubServers/Bungee/Host/SubCreator.ServerType.html) the template will create<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `version`: The minecraft version requested (may be empty)<br> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `version`: The minecraft version requested (may be empty)<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `sp_version`: The sponge build parsed by SubCreator (`FORGE` and `SPONGE` servers only)<br> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `sp_version`: The sponge build parsed by SubCreator (`FORGE` and `SPONGE` servers only)<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `mcf_version`: The forge build parsed by SubCreator (`FORGE` servers only)<br> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `mcf_version`: The forge build parsed by SubCreator (`FORGE` servers only)<br>
@ -68,7 +68,7 @@ Template:
&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, String values in this object can use the following variables:<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, String values in this object can use the following variables:<br>
&nbsp; &nbsp; &nbsp; &nbsp; **->** `$name$`: The name of the new server<br> &nbsp; &nbsp; &nbsp; &nbsp; **->** `$name$`: The name of the new server<br>
&nbsp; &nbsp; &nbsp; &nbsp; **->** `$template$`: The name of the template that was used<br> &nbsp; &nbsp; &nbsp; &nbsp; **->** `$template$`: The name of the template that was used<br>
&nbsp; &nbsp; &nbsp; &nbsp; **->** `$type$`: The [ServerType](https://src.me1312.net/jenkins/job/SubServers%20Platform/javadoc/SubServers.Bungee/net/ME1312/SubServers/Bungee/Host/SubCreator.ServerType.html) the template will create) the template created<br> &nbsp; &nbsp; &nbsp; &nbsp; **->** `$type$`: The [ServerType](https://dev.me1312.net/jenkins/job/SubServers%20Platform/javadoc/SubServers.Bungee/net/ME1312/SubServers/Bungee/Host/SubCreator.ServerType.html) the template will create) the template created<br>
&nbsp; &nbsp; &nbsp; &nbsp; **->** `$version$`: The minecraft version requested<br> &nbsp; &nbsp; &nbsp; &nbsp; **->** `$version$`: The minecraft version requested<br>
&nbsp; &nbsp; &nbsp; &nbsp; **->** `$address$`: The bind address of the host<br> &nbsp; &nbsp; &nbsp; &nbsp; **->** `$address$`: The bind address of the host<br>
&nbsp; &nbsp; &nbsp; &nbsp; **->** `$port$`: The port number of the new server<br> &nbsp; &nbsp; &nbsp; &nbsp; **->** `$port$`: The port number of the new server<br>