Configuration options (Settings.yml)

Since version 3.1.1, Autorank has a settings.yml. It houses all the options that you can change to make Autorank as you want. We always strive to keep Autorank as customisable as possible. But making it customisable means we have to add a lot of configurable options. Not all options are that easy to understand. So I've made a list (that I will keep updating while Autorank is developing) that explains all options individually.

NOTE: When you update Autorank to a newer version, the Settings config will not update automatically. This can result in options not being shown. If you want to change an option, you can always add it to your settings.yml. For a most recent version of the settings.yml, click here.

AFK integration

Autorank can detect whether a player is AFK. When Autorank detects that a player is AFK, it will not add time played to that player. The player will also not get ranked up automatically. You can either set this option to true or false. If you set this to true, Autorank will try to find an AFK-integrated plugin.

Use partial completion

When a player tries to perform /ar check, Autorank will check whether the player meets all the requirements for the specific rank they're in. If partial completion is set to true, it will allow players to pass certain requirements. After these requirements have been passed, they don't have to pass them again for that rank. So let's say a player needs to be at a specific location and needs to have played for 10 minutes. If partial completion is false, the player will need to be at the specific location and have played for 10 minutes. When this option is set to true, a player can first go to that location, type /ar check, and Autorank will check the location requirement. After a while, the player walks back to spawn and does /ar check again. Now, since the player already has been at the specific location before, and partial completion is allowed, Autorank will rank up the player (because he has passed the location requirement and has played for at least 10 minutes).

Interval check

This option is the time (in minutes) between the automatic rank up checks. If this number is lowered, Autorank will check more often, making it more accurate, but it will cost more resources, as Autorank has to check the player more often. It's up to you to find the perfect balance for your server. The default value is set to 5 minutes, which should be fine for most servers.

Use time of

Autorank does automatic rank up checks to see if a player passed all its requirements. Whenever a 'time' requirement is used, it will check if the player has at least played for the specified time. The time that the player played in total can be retrieved from different places. Autorank keeps track of all players' play time, but so do other plugins. If you want Autorank to use the time of other plugins (because some are more accurate than Autorank), you can specify it here. When a non-existent or unsupported plugin is specified, Autorank will default to itself.

Leaderboard layout

This is the layout of the leaderboard that is shown when a player performs /ar leaderboard. You can use a few variables for the layout:

&r : Ranking in the leaderboard
&p : Player name
&m : Minutes (with full days and full hours not counted)
&h : Hours (with full days not counted)
&d : Days
&tm : Total amount of minutes
&th : Total amount of hours

Check command layout

This is the layout of the /ar check command. You can use a few variables for the layout:

&p : Player name
&time : time in hours, minutes and seconds
&groups : Groups the player is in. Most of the time this is only one group.
&reqs : a list of all requirements

SQL info

If you want Autorank to use its integrated MySQL system, you can configure your database options here.

hostname is the name of the host. This also includes the port number (which is 3306 most of the time).
username is the user name Autorank has to use to gain access to the MySQL server.
password is the password used for that given account.
database is the database name. This is the top base of the MySQL structure.
table is the table name. Its parent is the database itself. You can have a database called 'minecraft' with a table in it, called 'autorank'.

Auto updater

Autorank is capable of updating and checking for updates. If you want to be notified when there is a new version of Autorank available, set this to true. The auto-download option will let Autorank automatically download the newest version once it is available.

Advanced dependency output

When the server is started, Autorank will check for a lot of different libraries (or plugins) it can use. Autorank will output all the information about the found or not-found plugins. Some admins don't like the amount of messages, and turn this off to prevent the console from spamming. This option can be used to identify why Autorank doesn't recognise a plugin.

Show help command based on permission

Some admins don't want players to see all the available commands when they perform /ar help. If this is set to true, players that perform /ar help will only see the commands available to them. If they don't have the permission to perform a certain command, it will not display this command on the help page.

use debug

When debug is true, Autorank will output a lot of (otherwise) useless messages. When you are having a problem, sometimes the devs of Autorank will tell you to turn it on so that they can see what is going wrong.

allow infinite ranking

By default this is false. This means that once players ranked up to a specific rank (let's say rank A), they can not rank up to it again. If for some reason you decide to manually change the rank of a player back to the previous one, he'll always be stuck on that rank as he cannot rank up to rank A anymore.