GitBook: [#80] Updated template instructions

This commit is contained in:
OpenSource 2022-08-24 23:51:39 +00:00 committed by gitbook-bot
parent 88c9dbd169
commit bd4d9258c8
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
4 changed files with 17 additions and 8 deletions

View File

@ -6,8 +6,8 @@
* [🚀 Plugin Installation Tutorial](overview/installation/README.md)
* [🎁 Templates](overview/installation/templates.md)
* [📦 Adding pre-defined plugins](overview/installation/adding-pre-defined-plugins.md)
* [🛳 Docker installation](overview/installation/docker-installation.md)
* [🌐 Pterodactyl configuration](overview/installation/pterodactyl-configuration.md)
* [🛳 Docker configuration](overview/docker-configuration.md)
* [🌐 Pterodactyl configuration](overview/pterodactyl-configuration.md)
* [📜 Current Config files](overview/config.md)
* [🚫 Limitations](overview/limitations/README.md)
* [Permission-based RAM](overview/limitations/permission-based-ram.md)

View File

@ -4,24 +4,33 @@ description: Learn how to setup templates with plugins, mods, worlds and configu
# 🎁 Templates
## Introduction
In PlayerServers, Templates are an essential way of managing the creation of your servers.
{% hint style="info" %}
_At minimum you are required to have a default Template folder with Spigot.jar file inside. Without that, it will not be possible to create a subserver._
{% endhint %}
## Instructions
1. Create folder in /templates/\<yourtemplate>
2. Put all the server files there INCLUDING Spigot.jar (do not include server.properties or spigot.yml)
3. If the folder includes plugins, please do not include PSServerCore.jar or it's configuration files
3. If the folder includes plugins, <mark style="color:yellow;">please do not include PSServerCore.jar or it's configuration files</mark>
4. If your server includes plugins, please add all of them to plugins-to-be-installed-ingame folder
5. Add your template to config.yml as in the following example:
```yaml
templates:
default:
# Below you should add all the plugins from your template in the described format
plugins:
- EssentialsX-2.18.1.0.jar;Essentials;Provides an essential, core set of commands for Bukkit.
```
As you can see, the template is the following: \
JarFileNameFromPluginsToBeInstalledIngameFolder;PluginNameFromPlugin.yml;Description
**As you can see, the template is the following:** \
<mark style="color:blue;">JarFileNameFromPluginsToBeInstalledIngameFolder</mark>;<mark style="color:yellow;">PluginNameFromPlugin.yml</mark>;<mark style="color:green;">Description</mark>
* JarFileNameFromPluginsToBeInstalledIngameFolder - the name of the jar file from the plugins to be installed ingame folder (example: EssentialsX-2.18.1.0.jar)
* PluginNameFromPlugin.yml - Find it by openning the plugin with WinRar, for example. Inside, you will see plugin.yml. Copy the plugin name from there
* Description - As described in the previous step, there is also a plugin description in plugin.yml. Copy it in the description part. NOTE THAT NOT ALL THE PLUGINS CONTAIN DESCRIPTION. In that case, you can create a custom one.
* <mark style="color:blue;">JarFileNameFromPluginsToBeInstalledIngameFolder</mark> - the name of the jar file from the plugins to be installed ingame folder (example: EssentialsX-2.18.1.0.jar)
* <mark style="color:yellow;">PluginNameFromPlugin.yml</mark> - Find it by openning the plugin with WinRar, for example. Inside, you will see plugin.yml. Copy the plugin name from there
* <mark style="color:green;">Description</mark> - As described in the previous step, there is also a plugin description in plugin.yml. Copy it in the description part. NOTE THAT NOT ALL THE PLUGINS CONTAIN DESCRIPTION. In that case, you can create a custom one.