Configuring
This section will cover how to configure PowerRanks to fit your servers needs.
Configuration for PowerRanks v1.10.5 and higher

Configuration location

Server Platform
Location
Bukkit
/plugins/PowerRanks/config.yml
The path to the PowerRanks configuration file for each platform is above.
Please note that the configuration automatically updates when PowerRanks itself is being updated.
If options are missing from the configuration, PowerRanks re-adds them with the default value.
Editing configuration files while the server is running will revert back to it's initial state before editing. This is not a bug but how PowerRanks internally works. All confiugration files are cached and saved when needed.
To apply your changes without restarting your server use: `/pr reload config`
Otherwise, shutdown your server, edit the configuration/ranks/players file and start your server.

Configuration options

general

.defaultrank

The rank that is granted when a new player joins the server
general:
defaultrank: 'Member' # Name of the rank

.playtime-update-interval

With what interval should the players playtime be updated
general:
playtime-update-interval: 60 # Time in seconds
Set the time in seconds to 0 in order to disable auto-updating players playtime

.autosave-files-interval

At what interval should PowerRanks automatically save the ranks and player data files
general:
autosave-files-interval: 600 # Time in seconds
Set the time in seconds to 0 in order to disable auto-saving of ranks and player data files

.disable-op

Should the /op and /deop command be disabled as well as all players be de-opped?
This option has been added since PowerRanks can't override behavior of opperators
general:
disable-op: false # true: op disabled & false: op enabled

storage

.type

The storage type used to store player & rank data
Available storage methods:
Readable & Editable files
Local databases
Remote databases
YAML
SQLite
MySQL
JSON
MongoDB*
PSM
*MongoDB storage option is available as add-on (https://legacy.powerranks.nl/addons)
storage:
type: YAML # Name of the storage method to use
The storage method is only applicable for the rank & player storage.
Configuration and language files are fixed to YAML

.mysql

MySQL configuration options
Only applicable if the storage method has been set to MySQL
storage:
type: MYSQL
mysql:
host: 127.0.0.1
port: 3306
database: powerranks
username: username
password: password
verbose: false # Show more information be shown about connection issues?

chat

.enabled

Should PowerRanks edit the chat format?
chat:
enabled: true
Set this to false if you have any other chat management plugin.
You can add a player rank prefix/suffix to your chat management plugin of choice if it supports PlaceholderAPI

.format

The format for chat messages
Format options:
Format
Description
[world]
The player's current world
[prefix]
Rank prefix
[suffix]
Rank suffix
[subprefix]
Player's subrank prefixes
[subsuffix]
Player's subrank suffixes
[player]
Player's (display) name
[msg]
The message player typed
[usertag]
The player's self-assigned tag
[format]
The current chat format
chat:
format: '&a[world]&r [usertag] [prefix] [subprefix] [player] [subsuffix] [suffix]&r: [msg]'
PlaceholderAPI placeholders can be used in the format

tablist_modification

.enabled

Should PowerRanks edit the tablist (playerlist) format?
tablist_modification:
enabled: true
Set this to false if you have any other tab management plugin.
You can add a player rank prefix/suffix to your tab management plugin of choice if it supports PlaceholderAPI

.format

The format for the tablist (playerlist)
Format options:
[world]
The player's current world
[prefix]
Rank prefix
[suffix]
Rank suffix
[subprefix]
Player's subrank prefixes
[subsuffix]
Player's subrank suffixes
[player]
Player's (display) name
[usertag]
The player's self-assigned tag
tablist_modification:
format: '&a[world]&r [usertag] [prefix] [subprefix] [player] [subsuffix] [suffix]'

nametagedit

Specific configuration for the plugin NametagEdit

.prefix

This is shown before the player's name.
nametagedit:
prefix: '[usertag] [prefix] [subprefix]'

.suffix

This is shown after the player's name.
nametagedit:
suffix: '[subsuffix] [suffix]'

signs

.enabled

Should PowerRanks signs be enabled?
signs:
enabled: true

.title_format

The title format that is used to indicate PowerRanks successfully registered this sign.
signs:
title_format: '&0[&b%plugin_name%&0]'

plugin_hook

.vault_economy

Should Vault Economy integration be enabled?
Required to use the rankup functionality in PowerRanks.
plugin_hook:
vault_economy: true
This requires the plugin Vault as well as an economy plugin

.vault_permissions

Should Vault Permission integration be enabled?
This registers PowerRanks as permission management plugin (as well as chat manager for compatibility with some plugins).
plugin_hook:
vault_permissions: true
This requires the plugin Vault

.placeholderapi

When enabled PowerRanks registers itself as placeholder provider that other plugins can use as well as allow PowerRanks to use any other placeholders registered in PlaceholderAPI.
plugin_hook:
placeholderapi: true
This requires the plugin PlaceholderAPI

.deluxetags

plugin_hook:
deluxetags: false
This requires the plugin DeluxeTags
When enabled, the usertag functionality in PowerRanks will be disabled!

.nametagedit

Use the plugin NametagEdit to show the players rank prefix/suffix above its head.
plugin_hook:
nametagedit: true
This requires the plugin nametagEdit

announcements

.rankup

What message should be broadcasted when a player's rank has been changed?
announcements:
rankup:
enabled: false
format: '[powerranks_prefix] &6[player]''s rank has been changed to [rank]'

.promote

What message should be broadcasted when a player is promoted?
announcements:
promote:
enabled: false
format: '[powerranks_prefix] &6[player] has been promoted to [rank]'

.demote

What message should be broadcasted when a player is demoted?
announcements:
demote:
enabled: false
format: '[powerranks_prefix] &6[player] has been demoted to [rank]'

updates

.enable_update_checking

Should PowerRanks check for updates and show a notification in the server console when an update is available?
updates:
enable_update_checking: true

.automatic_download_updates

Should PowerRanks always keep itself up-to-date?
This does not check for compatibillity!
updates:
automatic_download_updates: false

.automatic_update_config_files

Should PowerRanks automatically update all configuration files on update?
updates:
automatic_update_config_files: true

addon_manager

.accepted_terms

Has the server owner agreed to the add-on manager terms & conditions?
This value is updated automatically when running /pr addonmanager
addon_manager:
accepted_terms: false

rankup

.buy_command

What command should be executed when a player buys a rank in PowerRanks?
rankup:
buy_command:
enabled: false
command: 'say %playername% just bought the rank %rankname%'
Copy link
On this page
Configuration location
Configuration options
general
storage
chat
tablist_modification
nametagedit
signs
plugin_hook
announcements
updates
addon_manager
rankup