Contributors:

Skungee Team

Supported Minecraft Versions:

• 1.12

ServerInstances is a premium Skript addon that extends Skungee's API to create cloud network based servers. It has syntax which gets injected into Skungee on startup and those syntax can then be utilized to create and manage a cloud based network, all configurations and data folders are generated within the Skungee plugin folder.

Installation

1. Make sure you have Skungee installed and configured correctly.
   
2. The downloaded content goes on the Bungeecord network, placing it in the plugins folder.
3. Enable the ServerInstances node in the Skungee configurations on Spigot and Bungeecord. This part is crucial, this enables the syntax to be registered to Skungee.
   
4. Restart the Bungeecord instance and any Skungee servers you set the node to true on.
   
5. Enjoy!

Syntax get generated in the syntax.yml of Skungee under ServerInstances.

Code (Skript):

1. (start|create) [a] [new] [bungee[[ ]cord]]] server[s] named %strings% (with|from) template %string% [with %-number% xmx [ram] [and] [with] %-number% xms [ram]]

All Skungee server syntax are able to work with these created ServerInstances due to the beauty of the Skungee API.

Tutorial
The tutorial is located with the serverinstances.yml which can also be previewed below under the Configurations section.

Video


Tutorial video coming soon

Configurations

Code (Skript):

1. # ServerInstances is like a cloud server system built into Skungee. You can create servers and add them to Bungeecord with simple Skript syntax.
2. # You can manage and control these servers through Skungee. This configuration file will allow you to define the defaults of the servers.
3.  
4. # This is a massive expansion to Skungee so it may be buggy at in first initial releases, more additions will constantly be added over time.
5.  
6. #-----------------------------------------------------------------------------------------------------------------------------------------
7. #                                                                 TUTORIAL
8. #-----------------------------------------------------------------------------------------------------------------------------------------
9. #
10. #                 So lets start off with explaining how the ServerInstances work and how you should be setting up these bad boys.
11. #               First under the plugins/Skungee/ServerInstances/templates/ directory, you need to make a new directory for a server.
12. #                       This directory should be a normal name as this will be where a Skript Syntax looks for the name.
13. #                     Like `template "Example"` and the directory is named plugins/Skungee/ServerInstances/templates/Example
14. # These will be considered Templates, when you call one of these Templates, Skungee will copy a Template over to the plugins/Skungee/ServerInstances/running-servers/ directory.
15. #       The plugins/Skungee/ServerInstances/running-servers/ directory should not be touched as this is like a temporarily folder for running servers.
16. #                                You may delete servers within this folder if the Bungeecord proxy has been stopped.
17. #
18. #                   In order for ServerInstances to track and connect to Skungee, the manditory files needed in a template are
19. #                        server.properties and the actual server jar which needs to match the option `jar-name` set below.
20. #                     This doesn't mean you only need those files, you can put server folders as templates and it will work.
21. #         These are just the bare minimum files that are needed. If they're not in the template folder, ServerInstances will not start that server.
22. #
23. #                         Skungee NEEDS to be installed and configured on these templates, without that this wont work.
24. #           ServerInstances also needs the Recievers option enabled within these Skungees in order for the syntax to get sent to them.
25. #
26. #-----------------------------------------------------------------------------------------------------------------------------------------
27. # The version is to help determine which version this configuration is. Please do not modify this value.
28. configuration-version: 1
29.  
30. # Disables the message stating that ServerInstances has hooked into Skungee.
31. DisableRegisteredInfo: false
32.  
33. ServerInstances:
34.     # Enable the server instances expansion for Skungee.
35.     enabled: false
36.     # Prints additional information to the main Bungeecord console for ServerInstances.
37.     debug: false
38.     # The main wrapper for the servers. Current wrappers are: (remote). More soon.
39.     # The "default" value will automate to remote.
40.     wrapper: default
41.     # The dedotaded wam allocated to the servers. This can be modified with the Skript syntax.
42.     # Xmx is the maximum amount allocated. Xmx should always be greater than or equal to Xms.
43.     default-Xmx: 512M
44.     # Xms is the amount allocated to start with.
45.     default-Xms: 256M
46.     # The range of the ports for the servers (Keep in mind the ports need to be port forwarded or available to you)
47.     minimum-port: 25000
48.     maximum-port: 27000
49.     # The name of all the jars within the server folders.
50.     jar-name: spigot-1.12.2.jar
51.     # The server that players will get sent to when a ServerInstance gets closed.
52.     fallback-server: "Hub"
53.     # The maximum amount of server instances that can be running at the same time.
54.     max-servers: 25
55.     # You can add some command arguments here for the server run command.
56.     # The default argument allows the server to start up without the outdated delay message.
57.     # If you're using PaperSpigot you can add the argument "-Dcom.mojang.eula.agree=true" to allow for the eula to be signed as true.
58.     # This argument is good if you're generating servers, otherwise the eula from the server directory will be used like normal.
59.     command-arguments:
60.         - "-DIReallyKnowWhatIAmDoingISwear"
61.         - "-XX:+UseConcMarkSweepGC"
62.  
63. # The listener is a system that listens for incoming ServerInstances syntax from the Spigot servers.
64. # This is needed in order for the Syntaxes to register with ServerInstances.
65. # Recommended to leave on automatic. The system will try it's best to set everything up.
66. # If it doesn't work, no ports were found that were available to the server.
67. # If you want it to run on a defined port, disable automatic and use the port option below it.
68. Listener:
69.     automatic: true
70.     port: 7331

If you have any issues please let myself (LimeGlass) know about them. This version requires the latest Skungee at the time reading this.