PlayerServers/PlayerServers-Wiki-Archive
4
0
Fork 0
forked from Upstream/playerservers-wiki
Code Pull Requests Activity

GitBook: [#69] No subject

Browse Source
This commit is contained in:
OpenSource 2022-08-24 02:56:18 +00:00 committed by gitbook-bot
parent 30360f5f11
commit 426ffdc3d1
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
4 changed files with 34 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -5,26 +5,28 @@ 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)
{% embed url="https://builtbybit.com/resources/15521/" %}
Purchase on BuiltByBit (MC-Market)
{% endembed %}
{% embed url="https://www.spigotmc.org/resources/82268/" %}
Purchase on SpigotMC
{% endembed %}

2
SUMMARY.md
View File

@ -3,6 +3,7 @@
## 📘 Overview
* [🖥 PlayerServers - Overview](README.md)
* [🚀 Plugin Installation Tutorial](overview/installation.md)
***
@ -16,7 +17,6 @@
* [Basic instructions](for-players/basic-instructions.md)
* [Plugin management](for-players/plugin-management.md)
* [Editing config files](for-players/editing-config-files.md)
* [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)

4
legacy/README.md
View File

@ -14,6 +14,6 @@ description: >-
[permissions-and-commands.md](../for-owners/permissions-and-commands.md)
{% endcontent-ref %}
{% content-ref url="../for-owners/installation.md" %}
[installation.md](../for-owners/installation.md)
{% content-ref url="../overview/installation.md" %}
[installation.md](../overview/installation.md)
{% endcontent-ref %}

38
for-owners/installation.md → overview/installation.md
View File

@ -4,32 +4,28 @@ description: >-
installation.
---
# Plugin Installation Tutorial
# 🚀 Plugin Installation Tutorial
## Before installation
In order to install PlayerServers, you will need to have a **VPS or Dedicated** server with **root** access. If you do not have it, please do not buy the plugin or try to install it on **Shared (Game) Hosting.**
{% hint style="info" %}
Also, thanks to FullOfCode#6328, we have a (unofficial) video tutorial, so maybe you should consider [watching it,](https://www.youtube.com/watch?v=VApcwAG4y5c) instead of reading the rest of this page.
{% endhint %}
In order to install PlayerServers, you will need to have a **VPS or Dedicated** server with **root** access. If you do not have it, please do not buy the plugin or try to install it on a **Shared (Game) Hosting.**
## Picking the right OS
I understand that if you have your server already up and running, it might come hard for you to change your OS. That's why we tested our plugin on many of the popular OS-es. Even tho some of them are marked with ⚠️, it doesn't mean the plugin will not work there, it just means that the instructions from this guide will not help you while setting up the plugin on those Operating Systems, but if you configure everything correctly (like installing Java, Screen & Fuser) the plugin should work without any problems. If you have any problems with an OS-es marked with ✅ or ⚠️, please contact me so we can solve it.
We understand that if you have your server already up and running, it might come hard for you to change your OS. That's why we tested our plugin on many of the popular OS-es. Even tho some of them are marked with ⚠️, it doesn't mean the plugin will not work there, it just means that the instructions from this guide will not help you while setting up the plugin on those Operating Systems, but if you configure everything correctly (like installing Java, Screen & Fuser) the plugin should work without any problems. If you have any problems with an OS marked with ✅, please contact me so we can solve it.
Operating Systems marked with ⛔️ are currently not supported at all, but the support for them come in the future versions. Below is the list of all the popular operating systems:
| **Operating System** | Version | Supported | Notes |
| -------------------- | --------------------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Ubuntu** | <p>20.04</p><p>21.04</p> | ✅ | This OS-es are fully supported by PlayerServers |
| **Ubuntu** | <p>18.04</p><p>(Bionic)</p> | ✅ | <p>Documentation written assuming Ubuntu 18.04<br>as the base OS.</p> |
| **Ubuntu** | 16.04 | ⚠️ | Untested, but the plugin should work |
| **Debian** | <p>9</p><p>10</p><p>11</p> | ✅ | <p>Not <em>heavely</em> tested, the plugin worked but the<br>instructions from this guide might be invalid for that OS.</p><p>Some additional repos might be required.</p> |
| **Debian** | 8 | ⚠️ | Untested, additional repos are most likely required |
| **CentOS** | 7 & 8 | ⚠️ | **Not tested** and **not recommended** at all |
| **Windows** | <p>Server 2016</p><p>Server 2019</p><p>10</p><p>11</p> | ❌❓ | <p><strong>Not tested at all.</strong> It <strong>may</strong> work though, by installing</p><p>Ubuntu subsystem for Windows 10. You can find more</p><p>tutorials about that on Youtube.</p> |
| **MacOS** | <p>Mojave</p><p>Catalina</p><p>Big Sur</p><p>Monterey</p> | ✅ | <p>Should work without any problems as it comes with</p><p>screen &#x26; fuser pre-installed. Tested on M1 processors as well.</p> |
| **Operating System** | Version | Supported | Notes |
| -------------------- | ------------------------------------------------------------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Ubuntu** | <p>20.04</p><p>22.04</p> | ✅ | <p>Documentation written assuming Ubuntu 22.04<br>as the base OS. Heavily tested on 20.04 as well.</p> |
| **Ubuntu** | <p>18.04</p><p>(Bionic)</p> | ✅ | The plugin was tested on this OS and confirmed to have no issues. |
| **Ubuntu** | 16.04 | ⚠️ | Untested, but the plugin should work |
| **Debian** | <p>9</p><p>10</p><p>11</p> | ✅ | <p>Tested, the plugin worked but the instructions from this guide might be invalid for that OS.</p><p></p><p>Some additional repos might be required.</p> |
| **Debian** | <p>9<br>8</p> | ⚠️ | Untested, additional repos may be required |
| **CentOS** | 7 & 8 | ⚠️ | **Not tested**, though we had reports of centOS working without any issues. |
| **Windows** | <p>Server 2016</p><p>Server 2019</p><p>Server 2022</p><p>10</p><p>11</p> | ❌❓ | <p><strong>Tested, not working.</strong> It <strong>may</strong> work though, by installing Ubuntu subsystem for Windows. </p><p></p><p>You can find more tutorials about that on Youtube.</p> |
| **MacOS** | <p>Mojave</p><p>Catalina</p><p>Big Sur</p><p>Monterey<br>Ventura</p> | ✅ | <p>Should work without any problems as it comes with</p><p>screen &#x26; fuser pre-installed. <br><br>Tested on M1 processors as well. On M1 machines, ARM JVM like Azul Zulu is highly recommended.</p> |
## Requirements
@ -49,15 +45,15 @@ You can find an in-depth guide on that [here](https://linuxways.net/ubuntu/how-t
$ apt-get install default-jre -y
```
The second required dependency is Screen. We use screens for providing easy access to PlayerServers. In order to install it, you need to execute the command below. For further help with Screen, please go to the [Screen (accessing consoles)](screen.md) page.
The second required dependency is Screen. We use screens for providing easy access to PlayerServers. In order to install it, you need to execute the command below. For further help with Screen, please go to the [Screen (accessing consoles)](../for-owners/screen.md) page.
```
```bash
$ apt-get install screen -y
```
After successfully installing Screen, you will need to install **fuser**. Many Linux distros already come with it **pre-installed**, but if you don't have it, make sure to install it by executing the following command:
```
```bash
$ apt-get install fuser -y
```
@ -69,7 +65,7 @@ In order to install the plugin, you just need to put it into your BungeeCord plu
After the first boot of the server, you will see some errors generated by the plugin. Don't worry, just **shutdown** your BungeeCord server and follow the instructions below in order to solve it.
{% endhint %}
Now navigate to the `plugins folder -> PlayerServers` and open up the config.yml file. It is recommended to open it usign some sort of advanced text editor (like [Notepad++](https://notepad-plus-plus.org) or [VisualStudio Code](https://code.visualstudio.com)). After that, you will have to enter your MySQL informations. If you're unsure on how to create database on Linux machine, this [Creating MySQL database](creating-mysql-database.md) page might help you.
Now navigate to the `plugins folder -> PlayerServers` and open up the config.yml file. It is recommended to open it usign some sort of advanced text editor (like [Notepad++](https://notepad-plus-plus.org) or [VisualStudio Code](https://code.visualstudio.com)). After that, you will have to enter your MySQL informations. If you're unsure on how to create database on Linux machine, this [Creating MySQL database](../for-owners/creating-mysql-database.md) page might help you.
After the configuration of MySQL database, boot up your BungeeCord server. The plugin should successfully launch this time.