diff --git a/README.md b/README.md index c4883db..7d0eeca 100644 --- a/README.md +++ b/README.md @@ -5,26 +5,25 @@ description: >- them with easy-to-use, friendly GUI --- -# PlayerServers - General +# 🖥 PlayerServers - Overview ## Description -PlayerServers is an advanced plugin that will allow your players to create their own BungeeCord sub-server with just one command. On that server, they'll be owners and they'll have the whole control under that server. They'll even be able to install plugins on it using an advanced GUI. [**In order to purchase it, please scroll to the bottom of this page.**](./#purchase-it-now)**** +PlayerServers is an advanced plugin that will allow your players to create their own BungeeCord sub-server with just one command. They'll have all permissions and will be able to manage them with an easy-to-use in-game GUI in order to manage plugins and configuration files. Optionally, you can extend it's functionality by configuring Docker or deploying servers directly on Pterodactyl panel. ## Features -* **Async, lag-free:** Creation of servers happens 95% in async mode, which means that the creation of servers will be processed in a separate thread and 0 lag will be generated during that period. -* **Templates:** You'll be able to create the default template which will be used when creating the servers. -* **HubCore:** When purchasing this plugin, you'll get an additional HubCore plugin which will allow you to make a compass that will show online & offline player servers and give your players the ability to connect to them. Furthermore, it will give you some basic options for your lobby like disabling rain, hunger & damage. A special placeholder that will allow players to see current player-count on their sub server is also included. +* **Async, lag-free:** The plugin is running asynchronously making use of all cores of your machine. Servers are created in seconds with no performance impact on your network. +* **Templates:** Make the game for your players more fun by giving them already-built templates to choose from. Servers will be initialised with predefined plugins, worlds, mods and configuration files - all at your will. +* **HubCore:** HubCore is an addon to PlayerServers which adds nice features to your lobby such as PlayerServers selector, option to create and manage servers with an intuitive GUI, options to disable some of the basic Minecraft functionalities such as rain or damage and much more - and the best part - It's completely free and opensource. * **Automatically terminate inactive servers**: if servers are inactive (or don't have any players) for a configurable amount of time, they will automatically shutdown. -* **Fast & Efficient:** The creation of the server happens in less than 2 seconds which will allow your players to be teleported to their sub server in less than 15 seconds (other time will be used for boot-up of spigot server, and generating the main world - also, the huge factor is your server CPU) -* **ControlGUI:** Server owners will have their GUI control panel, that they'll be able to access with command /menu. It will allow them to manage various parts of the server (whitelist, bans, weather & more) and give them an option to install, enable, or disable additional plugins (see screenshots below). -* **Permissions-based:** Configure per-group permissions on max plugins, max players or RAM -* **Automatic & works out of the box:** The plugin is working out of the box without any need for external dependencies. Thanks to the integration of the [Bungee Server Manager plugin](https://www.spigotmc.org/resources/bungeeservermanager.7388/) (which I'm allowed to integrate, as it could be seen [here](https://i.imgur.com/iMT8RAh.png)), we were able to achieve the effect of automatically adding newly created sub servers to the BungeeCord config & server list without the need of any reboot or greload. The same goes for the deletion of sub servers as well. +* **ControlGUI:** Once your players enter your server, they'll be presented with instructions on how to proceed and do basic tasks, the most common of which is managing their server with PlayerServer GUI. From this interface, they'll be able to install plugins, edit server variables, edit configuration files and much more! +* **Permissions-based:** In PlayerServers everything's configurable through config files, or dynamically through Permissions. Limit the amount of plugins your players may have, max players, RAM or CPU and monetise your server by giving better perks to donators that support your work. +* **Automatic & works out of the box:** The plugin is working out of the box without any need for external dependencies. Servers are added and removed from your network seamlessly without any need for reboot or greload. ## Purchase it now -* SpigotMC - [https://www.spigotmc.org/resources/82268/](https://www.spigotmc.org/resources/%E3%80%8C-playerservers-%E3%80%8Dlet-your-players-have-their-own-server.82268/) -* MC-Market - [https://www.mc-market.org/resources/15521/](https://www.mc-market.org/resources/15521/) -* Songoda - [https://songoda.com/marketplace/product/418](https://songoda.com/marketplace/product/playerservers-let-your-players-have-their-own-server-an-advanced-plugin-which-allows-you.418) +{% content-ref url="legacy/additional-tutorials-faq.md" %} +[additional-tutorials-faq.md](legacy/additional-tutorials-faq.md) +{% endcontent-ref %} diff --git a/SUMMARY.md b/SUMMARY.md index 73caad8..3c37c09 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,40 +1,35 @@ # Table of contents -* [PlayerServers - General](README.md) -* [Updates](updates/README.md) - * [v1.1 to v1.2](updates/v1.1-to-v1.2.md) - * [8.0 to v1.0](updates/8.0-to-v1.0.md) - * [5.0 to 6.0](updates/5.0-to-6.0.md) - * [3.7-D to 4.0](updates/update1.md) +## 📘 Overview -## For Players - -* [Basic instructions](for-players/basic-instructions.md) -* [Plugin management](for-players/plugin-management.md) -* [Editing config files](for-players/editing-config-files.md) - -## For Owners - -* [Plugin Installation Tutorial](for-owners/installation.md) -* [Current Config & Messages File](for-owners/config.md) -* [Permissions & Commands](for-owners/permissions-and-commands.md) -* [Limitations](for-owners/limitations/README.md) - * [Permission-based RAM](for-owners/limitations/permission-based-ram.md) - * [Max players limitation](for-owners/limitations/max-players-limitation.md) - * [Max plugins limitation](for-owners/limitations/max-plugins-limitation.md) -* [Adding pre-defined plugins](for-owners/adding-pre-defined-plugins.md) -* [Creating MySQL database](for-owners/creating-mysql-database.md) -* [Additional Tutorials (FAQ)](for-owners/additional-tutorials-faq.md) -* [Screen (accessing consoles)](for-owners/screen.md) -* [Screen (advanced)](https://linuxize.com/post/how-to-use-linux-screen/) - -## experimental - -* [Templates](experimental/templates.md) -* [Multi-Node Support](experimental/multi-node-support.md) +* [🖥 PlayerServers - Overview](README.md) *** -* [Unofficial Video Tutorial](https://www.youtube.com/watch?v=VApcwAG4y5c) -* [MC-Market Thread](https://www.mc-market.org/threads/583445/#post-4508558) -* [Support Discord](https://invite.gg/arcadiaxyz) +* [Legacy](legacy/README.md) + * [Updates](legacy/updates/README.md) + * [PlayerServers - General](legacy/updates/master.md) + * [v1.1 to v1.2](legacy/updates/v1.1-to-v1.2.md) + * [8.0 to v1.0](legacy/updates/8.0-to-v1.0.md) + * [5.0 to 6.0](legacy/updates/5.0-to-6.0.md) + * [3.7-D to 4.0](legacy/updates/update1.md) + * [Basic instructions](legacy/basic-instructions.md) + * [Plugin management](legacy/plugin-management.md) + * [Editing config files](legacy/editing-config-files.md) + * [Plugin Installation Tutorial](legacy/installation.md) + * [Current Config & Messages File](legacy/config.md) + * [Permissions & Commands](legacy/permissions-and-commands.md) + * [Limitations](legacy/limitations/README.md) + * [Permission-based RAM](legacy/limitations/permission-based-ram.md) + * [Max players limitation](legacy/limitations/max-players-limitation.md) + * [Max plugins limitation](legacy/limitations/max-plugins-limitation.md) + * [Adding pre-defined plugins](legacy/adding-pre-defined-plugins.md) + * [Creating MySQL database](legacy/creating-mysql-database.md) + * [Additional Tutorials (FAQ)](legacy/additional-tutorials-faq.md) + * [Screen (accessing consoles)](legacy/screen.md) + * [Screen (advanced)](https://linuxize.com/post/how-to-use-linux-screen/) + * [Templates](legacy/templates.md) + * [Multi-Node Support](legacy/multi-node-support.md) + * [Unofficial Video Tutorial](https://www.youtube.com/watch?v=VApcwAG4y5c) + * [MC-Market Thread](https://www.mc-market.org/threads/583445/#post-4508558) + * [Support Discord](https://invite.gg/arcadiaxyz) diff --git a/legacy/README.md b/legacy/README.md new file mode 100644 index 0000000..44a7cd7 --- /dev/null +++ b/legacy/README.md @@ -0,0 +1,19 @@ +--- +description: >- + Expand this category to view documentation for Legacy versions of + PlayerServers (older than v3) +--- + +# Legacy + +{% content-ref url="../" %} +[..](../) +{% endcontent-ref %} + +{% content-ref url="permissions-and-commands.md" %} +[permissions-and-commands.md](permissions-and-commands.md) +{% endcontent-ref %} + +{% content-ref url="installation.md" %} +[installation.md](installation.md) +{% endcontent-ref %} diff --git a/for-owners/adding-pre-defined-plugins.md b/legacy/adding-pre-defined-plugins.md similarity index 100% rename from for-owners/adding-pre-defined-plugins.md rename to legacy/adding-pre-defined-plugins.md diff --git a/for-owners/additional-tutorials-faq.md b/legacy/additional-tutorials-faq.md similarity index 100% rename from for-owners/additional-tutorials-faq.md rename to legacy/additional-tutorials-faq.md diff --git a/for-players/basic-instructions.md b/legacy/basic-instructions.md similarity index 100% rename from for-players/basic-instructions.md rename to legacy/basic-instructions.md diff --git a/for-owners/config.md b/legacy/config.md similarity index 100% rename from for-owners/config.md rename to legacy/config.md diff --git a/for-owners/creating-mysql-database.md b/legacy/creating-mysql-database.md similarity index 100% rename from for-owners/creating-mysql-database.md rename to legacy/creating-mysql-database.md diff --git a/for-players/editing-config-files.md b/legacy/editing-config-files.md similarity index 100% rename from for-players/editing-config-files.md rename to legacy/editing-config-files.md diff --git a/for-owners/installation.md b/legacy/installation.md similarity index 100% rename from for-owners/installation.md rename to legacy/installation.md diff --git a/for-owners/limitations/README.md b/legacy/limitations/README.md similarity index 100% rename from for-owners/limitations/README.md rename to legacy/limitations/README.md diff --git a/for-owners/limitations/max-players-limitation.md b/legacy/limitations/max-players-limitation.md similarity index 100% rename from for-owners/limitations/max-players-limitation.md rename to legacy/limitations/max-players-limitation.md diff --git a/for-owners/limitations/max-plugins-limitation.md b/legacy/limitations/max-plugins-limitation.md similarity index 100% rename from for-owners/limitations/max-plugins-limitation.md rename to legacy/limitations/max-plugins-limitation.md diff --git a/for-owners/limitations/permission-based-ram.md b/legacy/limitations/permission-based-ram.md similarity index 100% rename from for-owners/limitations/permission-based-ram.md rename to legacy/limitations/permission-based-ram.md diff --git a/experimental/multi-node-support.md b/legacy/multi-node-support.md similarity index 100% rename from experimental/multi-node-support.md rename to legacy/multi-node-support.md diff --git a/for-owners/permissions-and-commands.md b/legacy/permissions-and-commands.md similarity index 100% rename from for-owners/permissions-and-commands.md rename to legacy/permissions-and-commands.md diff --git a/for-players/plugin-management.md b/legacy/plugin-management.md similarity index 100% rename from for-players/plugin-management.md rename to legacy/plugin-management.md diff --git a/for-owners/screen.md b/legacy/screen.md similarity index 100% rename from for-owners/screen.md rename to legacy/screen.md diff --git a/experimental/templates.md b/legacy/templates.md similarity index 100% rename from experimental/templates.md rename to legacy/templates.md diff --git a/updates/5.0-to-6.0.md b/legacy/updates/5.0-to-6.0.md similarity index 100% rename from updates/5.0-to-6.0.md rename to legacy/updates/5.0-to-6.0.md diff --git a/updates/8.0-to-v1.0.md b/legacy/updates/8.0-to-v1.0.md similarity index 100% rename from updates/8.0-to-v1.0.md rename to legacy/updates/8.0-to-v1.0.md diff --git a/updates/README.md b/legacy/updates/README.md similarity index 100% rename from updates/README.md rename to legacy/updates/README.md diff --git a/legacy/updates/master.md b/legacy/updates/master.md new file mode 100644 index 0000000..bb9317c --- /dev/null +++ b/legacy/updates/master.md @@ -0,0 +1,30 @@ +--- +description: >- + An advanced plugin which allows your players to create their sub-servers as + part of your network, isolated in Docker and manageable with easy-to-use GUI + or intuitive Pterodactyl panel interface +--- + +# PlayerServers - General + +## Description + +PlayerServers is an advanced plugin that will allow your players to create their own sub-server with just one command. On that server, they'll be owners and they'll have the whole control under that server. They'll even be able to install plugins on it using an advanced GUI. [**In order to purchase it, please scroll to the bottom of this page.**](../../#purchase-it-now)**** + +## Features + +* **Async, lag-free:** Creation of servers happens 95% in async mode, which means that the creation of servers will be processed in a separate thread and 0 lag will be generated during that period. +* **Templates:** You'll be able to create the default template which will be used when creating the servers. +* **HubCore:** When purchasing this plugin, you'll get an additional HubCore plugin which will allow you to make a compass that will show online & offline player servers and give your players the ability to connect to them. Furthermore, it will give you some basic options for your lobby like disabling rain, hunger & damage. A special placeholder that will allow players to see current player-count on their sub server is also included. +* **Automatically terminate inactive servers**: if servers are inactive (or don't have any players) for a configurable amount of time, they will automatically shutdown. +* **Fast & Efficient:** The creation of the server happens in less than 2 seconds which will allow your players to be teleported to their sub server in less than 15 seconds (other time will be used for boot-up of spigot server, and generating the main world - also, the huge factor is your server CPU) +* **ControlGUI:** Server owners will have their GUI control panel, that they'll be able to access with command /menu. It will allow them to manage various parts of the server (whitelist, bans, weather & more) and give them an option to install, enable, or disable additional plugins (see screenshots below). +* **Permissions-based:** Configure per-group permissions on max plugins, max players or RAM +* **Automatic & works out of the box:** The plugin is working out of the box without any need for external dependencies. Thanks to the integration of the [Bungee Server Manager plugin](https://www.spigotmc.org/resources/bungeeservermanager.7388/) (which I'm allowed to integrate, as it could be seen [here](https://i.imgur.com/iMT8RAh.png)), we were able to achieve the effect of automatically adding newly created sub servers to the BungeeCord config & server list without the need of any reboot or greload. The same goes for the deletion of sub servers as well. + +## Purchase it now + +* SpigotMC - [https://www.spigotmc.org/resources/82268/](https://www.spigotmc.org/resources/%E3%80%8C-playerservers-%E3%80%8Dlet-your-players-have-their-own-server.82268/) +* MC-Market - [https://www.mc-market.org/resources/15521/](https://www.mc-market.org/resources/15521/) +* Songoda - [https://songoda.com/marketplace/product/418](https://songoda.com/marketplace/product/playerservers-let-your-players-have-their-own-server-an-advanced-plugin-which-allows-you.418) + diff --git a/updates/update1.md b/legacy/updates/update1.md similarity index 86% rename from updates/update1.md rename to legacy/updates/update1.md index 6aa6668..47e2f88 100644 --- a/updates/update1.md +++ b/legacy/updates/update1.md @@ -28,14 +28,14 @@ ram-limiting: In case you'd like to see the default config after this update, please click the link below: -{% content-ref url="../for-owners/config.md" %} -[config.md](../for-owners/config.md) +{% content-ref url="../config.md" %} +[config.md](../config.md) {% endcontent-ref %} In case you'd like to learn more about permission-based RAM system, follow this link: -{% content-ref url="../for-owners/limitations/permission-based-ram.md" %} -[permission-based-ram.md](../for-owners/limitations/permission-based-ram.md) +{% content-ref url="../limitations/permission-based-ram.md" %} +[permission-based-ram.md](../limitations/permission-based-ram.md) {% endcontent-ref %} diff --git a/updates/v1.1-to-v1.2.md b/legacy/updates/v1.1-to-v1.2.md similarity index 100% rename from updates/v1.1-to-v1.2.md rename to legacy/updates/v1.1-to-v1.2.md