Upstream/SubServers-2
1
0
Fork 0
mirror of https://github.com/ME1312/SubServers-2.git synced 2025-02-16 19:51:26 +01:00
Code Issues Projects Releases Wiki Activity

Updated SubCreator (markdown)

ME1312 2019-06-15 16:30:04 -04:00
parent 95e76a99bc
commit c9351edc1b
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
SubCreator.md

@ -20,14 +20,15 @@ This is a YAML file on the root folder, used to modify SubCreator's default conf
```
Template:
Enabled: true
Display: 'Example Template'
Display: 'Example'
Icon: 'minecraft:redstone_torch'
Build:
Import:
- OtherTemplate
Server-Type: 'Custom'
Server-Type: 'CUSTOM'
Use-Cache: true
Require-Version: true
Require-Version: false
Can-Update: false
Executable: 'bash build.sh'
Run-On-Finish: true
Settings:
@ -43,6 +44,7 @@ Template:
&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; `Can-Update` **[Boolean]**: Signals to SubCreator that this template can update servers created by it<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>