-
Notifications
You must be signed in to change notification settings - Fork 61
Commands & Permissions
This page documents all commands (and their respective permissions when applicable). Permissions that are not associated with a command can be found here.
Check the progress of yourself or another player on a path.
| Command | Explanation |
|---|---|
| /ar check | Check all the paths you're on |
/ar check path name
|
Check progress of a path path name
|
/ar check player name
|
Check all the paths player name is on |
/ar check player path name
|
Check the progress of player player name for path path name
|
| Permission | Explanation |
|---|---|
autorank.check |
Allows a player to check their own paths. |
autorank.checkothers |
Allow a player to check paths of other players. |
Check the leaderboard to see who's got the most play-time.
| Command | Explanation |
|---|---|
| /ar leaderboard | Check the leaderboard of all-time |
/ar leaderboard daily
|
Check the leaderboard for the daily times. |
/ar leaderboard weekly
|
Check the leaderboard for the weekly times. |
/ar leaderboard monthly
|
Check the leaderboard for the monthly times. |
/ar leaderboard total
|
Check the leaderboard of all-time |
/ar leaderboard type broadcast
|
Check the leaderboard of a certain type and broadcast to all players that are online |
/ar leaderboard type force
|
Check the leaderboard of a certain type and force it to update. |
| Permission | Explanation |
|---|---|
autorank.leaderboard |
Allows a player to view the leaderboard. |
autorank.leaderboard.force |
Allows a player to force the leaderboard to update. |
autorank.leaderboard.broadcast |
Allows a player to broadcast the leaderboard to all players of the server. |
Get a list of commands that you can perform. Note that when the option 'show help command based on permission' is enabled, Autorank will only show you the commands you have access to.
| Command | Explanation |
|---|---|
| /ar help | Shows the first page of a list of commands. |
/ar help page
|
Shows page page of a list of commands. |
Set the play-time of a player.
| Command | Explanation |
|---|---|
/ar set player name time
|
Set the time of player player name to time minutes. |
| Permission | Explanation |
|---|---|
autorank.set |
Allows a player to perform the set command. |
Add play-time to a player's current play-time.
| Command | Explanation |
|---|---|
/ar add player name time
|
Add time minutes to player player name. |
| Permission | Explanation |
|---|---|
autorank.add |
Allows a player to add time to another player (including themself). |
Remove play-time from a player's current play-time.
| Permission | Explanation |
|---|---|
autorank.remove |
Allows a player to perform the remove command. |
| Command | Explanation |
|---|---|
/ar remove player name time
|
Remove time minutes from player player name. |
Check the global play-time of yourself or another player.
| Command | Explanation |
|---|---|
| /ar gcheck | Check your global play-time |
/ar gcheck player name
|
Check global play-time of player player name
|
| Permission | Explanation |
|---|---|
autorank.gcheck |
Allows a player to check their own global time. |
autorank.checkothers |
Allows a player to check the global time of other players. |
Reload the configuration files of Autorank.
| Command | Explanation |
|---|---|
| /ar reload | Reload the configuration files of Autorank. |
| Permission | Explanation |
|---|---|
autorank.reload |
Allows a player to perform the reload command. |
Import play-time from a flat-file. Make sure you have your files to be imported (Total_time.yml, Daily_time.yml, etc.) in the imports folder of the Autorank folder. Note that you can also combine parameters of this command. This means you can use the command like this: /ar import --overwrite-flatfile --db.
| Command | Explanation |
|---|---|
| /ar import | Import flat-file storage to your local storage. If there is already time stored in your local storage, it will add them together. |
/ar import --db
|
Import flat-file storage to your local storage and global storage. Imported times will be added together with already existing times. |
/ar import --db-only
|
Import flat-file storage to your global storage (MySQL database) and not to your local storage. It will add the imported time to the already existing time. |
/ar import --overwrite-flatfile
|
Import flat-file storage to your local storage only and overwrite the current values that are in your local storage. |
/ar import --overwrite-db
|
Import flat-file storage to your local and global storage, but only overwrite your global storage and add to your local storage. |
/ar import --overwrite-all
|
Import flat-file storage to your local and global storage and override the current values in both the local and global storage. |
| Permission | Explanation |
|---|---|
autorank.import |
Allows a player to perform the import command. |
Archive old play-time entries below a certain threshold.
| Command | Explanation |
|---|---|
/ar archive time
|
Remove the entries of players that have less play-time than time minutes. |
| Permission | Explanation |
|---|---|
autorank.archive |
Allows a player to perform the archive command. |
Create a debug file that can be given to a developer of Autorank to quickly find out all details about your Autorank set-up.
| Command | Explanation |
|---|---|
| /ar debug | Creates a debug file in the debug folder of Autorank. |
| Permission | Explanation |
|---|---|
autorank.debug |
Allows a player to perform the debug command. |
Synchronize the global storage (MySQL database) with your local storage (flat-file).
| Command | Explanation |
|---|---|
| /ar sync | Add time of each player stored in the flat-file and add it to the MySQL database. |
| /ar sync reverse | Add time of each player stored in the MySQL database and add it to the flat-file. |
| Permission | Explanation |
|---|---|
autorank.sync |
Allows a player to perform the sync command. |
Deprecated command. It was used to synchronize data between Stats and Statz, but it does not work anymore.
Try to complete a requirement of a path.
| Command | Explanation |
|---|---|
/ar complete id path
|
Complete a requirement id of path path. |
| Permission | Explanation |
|---|---|
autorank.complete |
Allows a player to perform the complete command. |
Force a rank-up check on a player.
| Command | Explanation |
|---|---|
/ar fcheck player name
|
Force a check on player player name
|
| Permission | Explanation |
|---|---|
autorank.forcecheck |
Allows a player to perform the forcecheck command. |
Track your progress on a specific requirement.
| Command | Explanation |
|---|---|
/ar track id path
|
See your progress on requirement id of path path. |
| Permission | Explanation |
|---|---|
autorank.track |
Allows a player to perform the track command. |
Check which third-party plugins Autorank is connected to (through PluginLibrary).
| Command | Explanation |
|---|---|
| /ar hooks | Check the plugins Autorank is connected to. |
| Permission | Explanation |
|---|---|
autorank.hooks |
Allows a player to perform the hooks command. |
Set the global play-time of a player.
| Command | Explanation |
|---|---|
/ar gset player name time
|
Set the global play-time of player player to time minutes. |
| Permission | Explanation |
|---|---|
autorank.gset |
Allows a player to perform the gset command. |
Add global play-time to a player.
| Command | Explanation |
|---|---|
/ar gadd player name time
|
Add time minutes of global play-time to player player
|
| Permission | Explanation |
|---|---|
autorank.gadd |
Allows a player to perform the gadd command. |
Check out a path without choosing it. You'll see the prerequisites, requirements and results of that path.
| Command | Explanation |
|---|---|
/ar view path
|
Check out all prerequisites, requirements and results of path path. |
| Permission | Explanation |
|---|---|
autorank.view |
Allows a player to perform the view command. |
Join/choose a path.
| Command | Explanation |
|---|---|
/ar choose path
|
Choose path path. |
| Permission | Explanation |
|---|---|
autorank.choose |
Allows a player to perform the choose command. |
Deactivate a path (if allowed). Note that you may lose your progress if you do so.
| Command | Explanation |
|---|---|
/ar deactivate path
|
Deactivate path path. |
| Permission | Explanation |
|---|---|
autorank.deactive |
Allows a player to perform the deactive command. |
Show the total, daily, weekly and monthly play-time of a player.
| Command | Explanation |
|---|---|
| /ar times | Show your own time statistics. |
/ar times player name
|
Show player name's time statistics. |
| Permission | Explanation |
|---|---|
autorank.times.self |
Allows a player to check their own time data. |
autorank.times.others |
Allows a player to check time data of other players. |
Reset the progress of a player.
| Command | Explanation |
|---|---|
| /ar reset | Indicate that you want to reset some data |
When you perform this command, Autorank will start a conversation. You can choose the following items to reset:
| Option | Explanation |
|---|---|
| active progress | Reset the progress of player player name on all active and completed paths. |
| all progress | Reset the progress of player player name on all active paths. |
| active paths | Remove all active paths of player player name. |
| completed paths | Remove all completed paths of player player name. |
| Permission | Explanation |
|---|---|
autorank.reset |
Allows a player to perform the reset command. |
Backup playerdata storage or play-time storage.
| Command | Explanation |
|---|---|
/ar backup playerdata
|
Backup all playerdata storage. |
/ar backup storage
|
Backup all play-time storage. |
| Permission | Explanation |
|---|---|
autorank.backup.storage |
Allows a player to perform the backup command. |
Show info of a player.
| Command | Explanation |
|---|---|
/ar info player name
|
Show info of player name. |
| Permission | Explanation |
|---|---|
autorank.info.self |
Allows a player to view their own info. |
autorank.info.others |
Allows a player to view info of other players. |
Editor playerdata of a player
| Command | Explanation |
|---|---|
| /ar editor | Start the editor conversation to adjust playerdata. |
| Permission | Explanation |
|---|---|
autorank.editor.path.assign |
Allows a player to assign a path to a player. |
autorank.editor.path.assign.force |
Allows a player to assign a path to a player by force. |
autorank.editor.path.unassign |
Allows a player to unassign a path from a player. |
autorank.editor.complete.path |
Allows a player to complete a path of a player. |
autorank.editor.complete.requirement |
Allows a player to complete a requirement of a path of a player. |
Migrate player data from another plugin into Autorank.
| Command | Explanation |
|---|---|
| /ar migrate | Migrate from a plugin to Autorank |
| Permission | Explanation |
|---|---|
autorank.migrate |
Allows a player to use the migration command. |
Some permissions are not associated with a command, but with an action. Hence, these permissions cannot be listed in the previous section. This section provides an overview of these 'left-over' permissions.
| Permission | Explanation |
|---|---|
autorank.exclude |
A player with this permission cannot check its progress and will not be assigned a path or complete a path automatically. It is different from the autorank.timeexclude permission. |
autorank.timeexclude |
A player with permission will not automatically recording play-time. Autorank will not count any time for the player. It is different from the autorank.exclude permission. |
autorank.leaderboard.exclude |
A player with permission will not be shown on any leaderboard. |
autorank.noticeonupdate |
A player with this permission will be notified when a new version of Autorank is available. |
autorank.noticeonwarning |
A player with this permission will be notified Autorank has detected a warning or error. |