Contributors:

Skungee Team

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 (YAML):

1.  
2. # ServerInstances is like a cloud server system built into Skungee. You can create servers and add them to Bungeecord with simple Skript syntax.
3. # You can manage and control these servers through Skungee. This configuration file will allow you to define the defaults of the servers.
4.  
5. # 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.
6.  
7. #-----------------------------------------------------------------------------------------------------------------------------------------
8. #                                                                 TUTORIAL
9. #-----------------------------------------------------------------------------------------------------------------------------------------
10. #
11. #                 So lets start off with explaining how the ServerInstances work and how you should be setting up these bad boys.
12. #               First under the plugins/Skungee/ServerInstances/templates/ directory, you need to make a new directory for a server.
13. #                       This directory should be a normal name as this will be where a Skript Syntax looks for the name.
14. #                     Like `template "Example"` and the directory is named plugins/Skungee/ServerInstances/templates/Example
15. # 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.
16. #       The plugins/Skungee/ServerInstances/running-servers/ directory should not be touched as this is like a temporarily folder for running servers.
17. #                                You may delete servers within this folder if the Bungeecord proxy has been stopped.
18. #
19. #                   In order for ServerInstances to track and connect to Skungee, the manditory files needed in a template are
20. #                        server.properties and the actual server jar which needs to match the option `jar-name` set below.
21. #                     This doesn't mean you only need those files, you can put server folders as templates and it will work.
22. #         These are just the bare minimum files that are needed. If they're not in the template folder, ServerInstances will not start that server.
23. #
24. #                         Skungee NEEDS to be installed and configured on these templates, without that this wont work.
25. #           ServerInstances also needs the Recievers option enabled within these Skungees in order for the syntax to get sent to them.
26. #
27. #-----------------------------------------------------------------------------------------------------------------------------------------
28. # The version is to help determine which version this configuration is. Please do not modify this value.
29. configuration-version: 2
30.  
31. # Disables the message stating that ServerInstances has hooked into Skungee.
32. DisableRegisteredInfo: false
33.  
34. ServerInstances:
35.    # Prints additional information to the main Bungeecord console for ServerInstances.
36.     debug: false
37.     # The main wrapper for the servers. Current wrappers are: (remote). More soon.
38.     # The "default" value will automate to remote.
39.     wrapper: default
40.     # The dedotaded wam allocated to the servers. This can be modified with the Skript syntax.
41.     # Xmx is the maximum amount allocated. Xmx should always be greater than or equal to Xms.
42.     default-Xmx: 512M
43.     # Xms is the amount allocated to start with.
44.     default-Xms: 256M
45.     # The range of the ports for the servers (Keep in mind the ports need to be port forwarded or available to you)
46.     minimum-port: 25000
47.     maximum-port: 27000
48.     # The name of all the jars within the server folders.
49.     jar-name: spigot.jar
50.     # The server that players will get sent to when a ServerInstance gets closed.
51.     fallback-server: "Hub"
52.     # Should the player only get moved when a ServerInstances server stops, crashes or if it's moving the user?
53.     # If this is false then all servers will have this feature. It's similar to a plugin called "MoveMeNow"
54.     fallback-instances: true
55.     # The message stated to the user when the user gets moved from a ServerInstance to the fallback server due to it stopping, crashing or moving the user.
56.     # Placeholders are:
57.     #   %previous% - the server they got moved from.
58.     #   %kickmsg% - the kick message if the server gave a reasoning.
59.     move-message: "&cYou have been moved from the server %previous% to the fallback server Hub due to %kickmsg%"
60.     # The maximum amount of server instances that can be running at the same time.
61.     max-servers: 25
62.     # You can add some command arguments here for the server run command.
63.     # The default argument "-DIReallyKnowWhatIAmDoingISwear" allows the server to start up without the outdated delay message.
64.     # 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.
65.     # This argument is great if you're generating servers, otherwise the eula from the server directory will be used like normal.
66.     command-arguments:
67.         - "-DIReallyKnowWhatIAmDoingISwear"
68.         - "-XX:+UseConcMarkSweepGC"
69.      
70. # If you would like ServerInstances to bind to an exact IP address you can define so here. Ports not excepted.
71. address-bind: "localhost"
72.  
73. # The listener is a system that listens for incoming ServerInstances syntax from the Spigot servers.
74. # This is needed in order for the Syntaxes to register with ServerInstances.
75. # Recommended to leave on automatic. The system will try it's best to set everything up.
76. # If it doesn't work, no ports were found that were available to the server.
77. # If you want it to run on a defined port, disable automatic and use the port option below it.
78. Listener:
79.     automatic: true
80.     port: 7331
81.  

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