Installation

Read all the steps carefully, otherwise the setup of this plugin might fail!!

1. Download the Plugin (It is recommended to download it from here to get the latest version).
2. Upload the Scoreboard.jar to your Server (into the plugins folder). If there is no Plugin folder in the root directory of your server you have no server software that supports plugin. It is recommended to use Spigot or PaperSpigot.
3. Restart your Server. To verify that the Plugin works type the command "/plugins".

Please note: Every time you read config.yml, I always mean the config.yml from the scoreboard plugin.



Setup

1. Go to the new generated "Scoreboard"-folder in your plugin directory (Path: /plugins/Scoreboard).
2. Now you should begin with the config.yml. To open it, it is recommended to use Notepad++ instead of the Windows editor. Download Notepad++ from here: Download
3. Now adapt the config.yml to your server. Every setting is explained in this file.



Configure the ranks (optional - skip this if you don't want to use ranks)

1. Open you config.yml.
2. Go to the section "ranks".
3. First you should select your permission system. Set the permission system that is running on your server. If you have no permission system and want to use ranks, install one.
LuckPerms is a good one.


You only need to setup one of these! So select LuckPerms, PermisionsEx or none:


LuckPerms:

Choose which one you want to use - LuckPerms with API (recommended for Bungeecord that your ranks will always be in sync with other servers) or without API:


4.1.1 Setup LuckPerms without API:

- Create a group for every rank.
- Change the "permission: 'rank.rankname'" option to "permission: 'rankname'". The rankname has to match the name of the group that you have created for this rank.
Note: The ranks are sorted in the tablist like in the config.yml. For example is the owner rank is on top in the config.yml it will also be on top in the tablist.

4.1.2 Setup LuckPerms with API:

- Enable the luckperms-api in the config.yml.
- Now create a group for every rank in LuckPerms. The group needs the following details to work: Group name; Weight; Display name; Prefix
- Set the right weight: For example, if you have 10 ranks, the owner rank needs to have the weight 10 and the player rank the weight 1.
The weight should not be higher than the amount of ranks. The rank with the highest weight is the highest in the tablist.

Note: If you enabled the API, all ranks that you have configured in the config.yml will no longer be used. The plugin now uses the rank infos from LuckPerms.


PermissionsEx:

4.2.1 Create for every rank a group in PermissionsEx.
4.2.2 Now configure the ranks in the config.yml.
4.2.3 Change the "permission: 'rank.rankname'" option to "permission: 'rankname'". The rankname has to match the name of the group that you have created in PermissionsEx.
4.3.1 Configure the ranks in the config.yml.
4.3.2 Now create a group for each rank and give the group the permission that you have set for the rank in the "permission: rank.rankname" option or give the permission to players directly.
Note: The ranks are sorted in the tablist like in the config.yml. For example is the owner rank is on top in the config.yml it will also be on top in the tablist.



Setup the scoreboard (optional)

Skip this if you have the scoreboard disabled

1. Go to the new generated "Scoreboard"-folder in your plugin directory (Path: /plugins/Scoreboard).

2. Open the scoreboard.yml file.

3. The option "wait" means how long it should take before the next animation step is executed. You have to set this value in ticks. So if you want to set it to one seconds, set it to 20 because 20 ticks is one second.

4. To add a new animated step, just add a new value (for example add this: - 'YourNewStep').

5. If you don't want to use animations, just remove all animation steps except for one. For static texts you can also set the wait value very high like 99999 to save performance.

6. Add a new score: You can add up to 14 Scores (limited by Minecraft). For this just add a new number like "'7':".

NOTE: If there are some errors, carefully check if there any spaces that don't belong there. Compare it with the other lines. If there is only one space too much it will no longer work.



Setup the tablist (optional)

Skip this if you have the tablist disabled

1. Go to the new generated "Scoreboard"-folder in your plugin directory (Path: /plugins/Scoreboard).

2. Open the tablist.yml file.

3. The option "speed" means how long it should take before the next animation step is executed. You have to set this value in ticks. So if you want to set it to one seconds, set it to 20 because 20 ticks is one second.

4. To add a new animated step, just add a new value (for example add this: - 'YourNewStep').

5. If you don't want to use animations, just remove all animation steps except for one. For static texts you can also set the wait value very high like 99999 to save performance.

6. Add a new line: Just add a new number like "'5':".



Now you are done!


Just restart your Server. If you reload (not recommended) all players should rejoin.





Troubleshooting / FAQ

Why does the Prefix/Scoreboard not show up or the whole plugin does not work?

+

A reason because this may won't work is that you have any other Scoreboard Plugin installed. Other Prefix Plugins also count as Scoreboard because they are made with a scoreboard.
To check wich Plugin may cause the error, remove all Plugins from your server and then slowly add them again. Just add a few and then reload the server to check if the scoreboard still works.
If not then the Plugin that you just added may cause the error.
Then you have to remove the Plugin or the Scoreboard Plugin. But keep in mind that this is not a bug in my Plugin.
Almost all Plugins have this problem. In Minecraft you can just have one Scoreboard.



If you removed all Plugins from your Server but it still doesn't work then you should check if the Plugin is correctly configured and installed.
To check if there is a wrong setting, rename the Scoreboard folder to Scoreboard_ and restart (no reload) the Server.
A new folder with the default settings will be created. If the Plugin still does not work with the default settings and no other Plugins on the Server, check your Server Software and maybe update to a newer one.

It is only confirmed that the Plugin will work with Spigot and PaperSpigot. If you use one of these make shure you use the following versions:
1.8.8, 1.9.4, 1.10.2, 1.11.2, 1.12.2, 1.13.2, 1.14.4, 1.15.2, 1.16.5

If it still does not work with default settings, no other Plugins and the listed versions try to download your Server software and Scoreboard Plugin again.
If that also doesn't work, contact your Server Hoster.

Why does the owner and admin has the same prefix/suffix?

+

This problem occur when you have no permission system set in the config.yml of the scoreboard. When there is no permission system set then the plugin uses permissions for the rank system. But if the admin has '*' permissions then of course he also has the permission that you have set for the owner rank.

So to solve this problem select PermissionsEx or LuckPerms as your perm system in your config.yml. You could also try to give the admin a minus permission.

Is it possible to sort the Players in the tablist after the alphabet?

+

No, sadly this is not possible.