Updated SubCreator (markdown)

ME1312 2019-05-09 12:30:46 -04:00
parent 618545faae
commit 99b7e98b5f

@ -1,12 +1,12 @@
SubCreator is the program that creates SubServers for you. This page goes over how to use it.
## Using SubCreator
SubCreator can setup a subserver for you in only 4 arguments.<br>
`/sub create <Name> <Host> <Template> <Version> [Port]`<br>
SubCreator can setup a subserver for you in 3-5 arguments.<br>
`/sub create <Name> <Host> <Template> [Version] [Port]`<br>
`Name` - Name of the new server<br>
`Host` - Host to create it on<br>
`Template` - Template to use<br>
`Version` - Minecraft Version to create<br>
`Version` - Minecraft Version to create (optional)<br>
`Port` - Port number to use (optional)<br>
### SubCreator Templates
@ -27,6 +27,7 @@ Template:
- OtherTemplate
Server-Type: 'Custom'
Use-Cache: true
Require-Version: true
Executable: 'bash build.sh'
Run-On-Finish: true
Settings:
@ -41,6 +42,7 @@ Template:
&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; `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; `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; **->** `host`: The name of the host that was selected<br>