Upstream/SubServers-2
1
0
Fork 0
mirror of https://github.com/ME1312/SubServers-2.git synced 2024-11-22 10:15:52 +01:00
Code Issues Projects Releases Wiki Activity

Updated SubCreator (markdown)

ME1312 2019-01-18 19:26:15 -05:00
parent 218d127724
commit 4cbbda2e61
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
SubCreator.md

@ -40,7 +40,7 @@ Template:
&nbsp; &nbsp; `Build` **[Object]**: SubCreator build options<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Import` **[Enum Value]**: 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; `Use-Cache` **[Boolean]**: Creates and forwards a valid cache directory to the build 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; `Executable` **[File Path/String]**: A command to execute or the path to a script to execute relative to the directory set above. This value can use the following variables in addition to the system's own:<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `name`: The name of the new server<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `template`: The name of the template being used<br>
@ -51,7 +51,7 @@ Template:
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `address`: The bind address of the host<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `port`: The port number of the new server<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; **->** `cache`: The caching directory (only when `Use-Cache` is true)<br>
&nbsp; &nbsp; &nbsp; &nbsp; `Run-On-Finish` **[Boolean]**: Whether this subserver will start automatically 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#subserversconfigyml-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; **->** `$template$`: The name of the template that was used<br>