# Requirements

All requirements can also be used as prerequisites!

## Basic requirements

### Online time

Check how much time a player has spent online on the server (without being AFK).

Requirement name: `time`

| Example usage |                 Explanation                |
| :-----------: | :----------------------------------------: |
|     1d 2h     |       Play at least 1 day and 2 hours      |
|       1m      |           Play at least 1 minute           |
|     1h 2m     |     Play at least 1 hour and 2 minutes     |
|    1d 2h 3m   | Play at least 1 day, 2 hours and 3 minutes |

### Experience level

Check the experience level of a player

Requirement name: `exp`

| Example usage |           Explanation          |
| :-----------: | :----------------------------: |
|       20      | Need at least level 20 of exp. |

### Experience Range level

Check the range of experience level of a player

Requirement name: `exp range`

| Example usage |              Explanation             |
| :-----------: | :----------------------------------: |
|     20;29     | Need at least level 20 to 29 of exp. |

### Money

Check how much money a player has

Requirement name: `money`

{% hint style="warning" %}
This requirement requires Vault to be installed (and an economy plugin)
{% endhint %}

| Example usage |                 Explanation                |
| :-----------: | :----------------------------------------: |
|      150      | Need at least 150 money (in your currency) |

### World

Check whether a player is in a specific world

Requirement name: `world`

<table><thead><tr><th width="374" align="center">Example usage</th><th align="center">Explanation</th></tr></thead><tbody><tr><td align="center">world_nether</td><td align="center">Should be in world_nether</td></tr></tbody></table>

### Gamemode

Check whether a player is in a specific gamemode (survival, creative, spectator)

Requirement name: `gamemode`

{% hint style="info" %}
For a list of gamemodes, see this [link](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/GameMode.html). Use the numeric values (so 0, 1, 2, etc.)
{% endhint %}

| Example usage |           Explanation          |
| :-----------: | :----------------------------: |
|       1       | Player needs to be in creative |

### Obtained an item

Check whether a player has a specific item or multiple of it.

Requirement name: `has item`

Syntax of the requirement: `material; amount; display name; match display name`

| Parameter                    | Explanation                                                |
| ---------------------------- | ---------------------------------------------------------- |
| Material (string)            | Name of material                                           |
| Amount (integer)             | Amount of the item                                         |
| Display name (string)        | Name to show to the user in the requirement                |
| Match display name (boolean) | Whether the name of the item should match the display name |

{% hint style="info" %}
For a list of materials, see this [link](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html).
{% endhint %}

|      Example usage     |                              Explanation                             |
| :--------------------: | :------------------------------------------------------------------: |
|         BONE;4         |                     Need to have at least 4 bones                    |
|    BONE;4;More bones   | Need to have at least 4 bones (it will show the player 'More bones') |
| BONE;4;More bones;true |      Need to have at least 4 bones (that are named 'More bones')     |

### Location

Check whether a player is in a s

Requirement name: `location`

Syntax of the requirement: `x; y; z; world; radius`

| Parameter | Explanation                                                      |
| --------- | ---------------------------------------------------------------- |
| `X`       | X coordinate of the location                                     |
| Y         | Y coordinate of the location                                     |
| Z         | Z coordinate of the location                                     |
| world     | World of the location                                            |
| Radius    | How close the player should be to the exact location (in blocks) |

|       Example usage      |                                   Explanation                                   |
| :----------------------: | :-----------------------------------------------------------------------------: |
| 10;65;10;world\_nether;5 | Needs to be within 5 blocks of location 10 (x), 65 (y), 10 (z) on world\_nether |

### Time across several servers

Check how much time a player has spent across multiple servers (without being AFK).

Requirement name: `global time`

| Example usage |                 Explanation                |
| :-----------: | :----------------------------------------: |
|     1d 2h     |       Play at least 1 day and 2 hours      |
|       1m      |           Play at least 1 minute           |
|     1h 2m     |     Play at least 1 hour and 2 minutes     |
|    1d 2h 3m   | Play at least 1 day, 2 hours and 3 minutes |

### Time since joining the server

Check how much time has passed since the player has first joined the server. Note that a player does not need to be online for this time to increment.

Requirement name: `total time`

| Example usage |                 Explanation                |
| :-----------: | :----------------------------------------: |
|     1d 2h     | Must have joined the server 1d and 2h ago. |
|       1m      |  Must have joined the server 1 minute ago. |

### Be in a permission group

Check whether a player is in a specific permission group

Requirement name: `in group`

| Example usage |                    Explanation                   |
| :-----------: | :----------------------------------------------: |
|    Citizen    | Player must be in the permission group 'Citizen' |

### Not in a permission group

Check whether a player is not in a specific permission group

Requirement name: `not in group`

| Example usage |                      Explanation                     |
| :-----------: | :--------------------------------------------------: |
|    Citizen    | Player must not be in the permission group 'Citizen' |

### Have a permission

Check whether a player has a specific permission

Requirement name: `permission`

|  Example usage  |                  Explanation                  |
| :-------------: | :-------------------------------------------: |
| some.permission | Player needs the *some.permission* permission |

### Be in a biome

Check whether a player is in a specific biome

Requirement name: `in biome`

{% hint style="info" %}
​[Here's ](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/Biome.html)a list of biomes you can use.
{% endhint %}

### Have active (Autorank) paths

Check whether a player has a specific path as active or has a number of active paths

Requirement name: `active paths`

| Example usage |                 Explanation                 |
| :-----------: | :-----------------------------------------: |
|      `10`     |    Needs to have at least 10 active paths   |
|   Cool Path   | Needs to have 'Cool Path' as an active path |

### Have completed (Autorank) paths

Check whether a player has completed a specific path or has completed a number of paths

Requirement name: `completed paths`

| Example usage |                Explanation                |
| :-----------: | :---------------------------------------: |
|       10      | Needs to have at least 10 completed paths |
|   Cool Path   |  Needs to have completed path 'Cool Path' |

## Statistic-based requirements

Most requirements use the statistics provided by Minecraft, but some may require Statz to be installed. It can be found here: <https://www.spigotmc.org/resources/statz.25969/>

### Distance travelled

Check whether a player has moved a certain number of blocks

Requirement name: `blocks moved`

| Example usage |              Explanation             |
| :-----------: | :----------------------------------: |
|      1000     | Needs to travel at least 1000 blocks |

### Players killed

Check how many players a player has killed

Requirement name: `players killed`

| Example usage |             Explanation            |
| :-----------: | :--------------------------------: |
|      200      | Needs to kill at least 200 players |

### Mobs killed

Check how many mobs (of a specific type) a player has killed.

Requirement name: `mobs killed`

{% hint style="info" %}
For a list of mobs, see [this link](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EntityType.html).
{% endhint %}

|          Example usage         |               Explanation               |
| :----------------------------: | :-------------------------------------: |
|             `1000`             | Needs to kill a 1000 mobs (of any type) |
| 10;SPIDER;\<short name of mob> |         Needs to kill 10 spiders        |

### Blocks placed

Check whether a player has placed a specific type of block (or how many blocks in total he's placed)&#x20;

In checking Vanilla Stats due to how they mix blocks and items in DB you can not check all Blocks Placed.

Requirement name: `blocks placed`

Syntax of the requirement: `material; amount; display name`

| Parameter             | Explanation                                 |
| --------------------- | ------------------------------------------- |
| Material (string)     | Name of material                            |
| Amount (integer)      | Amount of the item                          |
| Display name (string) | Name to show to the user in the requirement |

{% hint style="info" %}
For a list of materials, see this [link](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html).
{% endhint %}

|     Example usage    |                               Explanation                               |
| :------------------: | :---------------------------------------------------------------------: |
|           4          |                         Place at least 4 blocks                         |
|        GLASS;4       |                      Need to place at least 4 glass                     |
| GLASS;4;shiny things | Need to place at least 4 glass (it will show the player 'shiny things') |

### Blocks broken

Check whether a player has broken a specific type of block (or how many blocks in total he's broken)

In checking Vanilla Stats due to how they mix blocks and items in DB you can not check all Blocks Broken.

Requirement name: `blocks broken`

Syntax of the requirement: `material; amount; display name`

| Parameter             | Explanation                                 |
| --------------------- | ------------------------------------------- |
| Material (string)     | Name of material                            |
| Amount (integer)      | Amount of the item                          |
| Display name (string) | Name to show to the user in the requirement |

{% hint style="info" %}
For a list of materials, see this [link](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html).
{% endhint %}

|     Example usage    |                               Explanation                               |
| :------------------: | :---------------------------------------------------------------------: |
|           4          |                         Break at least 4 blocks                         |
|        GLASS;4       |                      Need to break at least 4 glass                     |
| GLASS;4;shiny things | Need to break at least 4 glass (it will show the player 'shiny things') |

### Votes

Check how many times a player has voted

Requirement name: `votes`

{% hint style="warning" %}
**Statz and a compatible voting plugin is required.**
{% endhint %}

| Example usage |            Explanation           |
| :-----------: | :------------------------------: |
|      200      | Needs to vote at least 200 times |

### Damage taken

Check how much damage a player has taken

Requirement name: `damage taken`

| Example usage |            Explanation            |
| :-----------: | :-------------------------------: |
|      500      | Needs to take at least 500 damage |

### Fish caught

Check how much fish a player has caught

Requirement name: `fish caught`

| Example usage | Explanation                     |
| :-----------: | ------------------------------- |
|       10      | Needs to catch at least 10 fish |

### Items crafted

Check how much items a player has crafted or how much of a specific item a player has crafted

Requirement name: `items crafted`

{% hint style="info" %}
A list of material names that you can use is provided [here](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html).
{% endhint %}

|         |                                  |
| ------- | -------------------------------- |
| 10      | Needs to craft at least 10 items |
| ANVIL;2 | Needs to craft 2 anvils          |

### Sheep shorn

Check how many sheep a player has shorn

Requirement name: `times sheared`

| Example usage |            Explanation           |
| :-----------: | :------------------------------: |
|       50      | Needs to shear at least 50 sheep |

### Food consumed

Check how much food a player has consumed or a specific type of food

Requirement name: `food eaten`

{% hint style="info" %}
For a list of materials (and consumables), click [here](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html).
{% endhint %}

|   Example usage  |             Explanation            |
| :--------------: | :--------------------------------: |
|        20        |   Needs to consume 20 food items   |
| 20;BAKED\_POTATO | Needs to consume 20 baked potatoes |

### Advancement obtained

Check how many advancement a player has obtained or whether a player has obtained a specific advancement.

Requirement name: `has advancement`

{% hint style="info" %}
Advancement strings can be found [here](https://minecraft.gamepedia.com/Advancement). Look at the *namespaced ids*.
{% endhint %}

|              Example usage             |                                     Explanation                                     |
| :------------------------------------: | :---------------------------------------------------------------------------------: |
|                   10                   |                           Needs to obtain 10 advancements                           |
| minecraft:story/shiny\_gear;Shiny gear | <p>Needs to obtain the advancement </p><p>('shiny gear' is shown to the player)</p> |

### Animals bred

Check how many animals a player has bred.

Requirement name: `animals bred`

| Example usage |        Explanation        |
| :-----------: | :-----------------------: |
|       10      | Needs to breed 10 animals |

### Cake slices eaten

Check how many slices of cake a player has eaten.

Requirement name: `cake slices eaten`

| Example usage |           Explanation          |
| :-----------: | :----------------------------: |
|       10      | Needs to eat 10 slices of cake |

### Number of items enchanted

Check how many items a player has enchanted

Requirement name: `items enchanted`

| Example usage |        Explanation        |
| :-----------: | :-----------------------: |
|       10      | Needs to enchant 10 items |

### Number of potted plants

Check how many plants a player has potted

Requirement name: `plants potted`

| Example usage |       Explanation      |
| :-----------: | :--------------------: |
|       10      | Needs to pot 10 plants |

### Number of deaths

Check how many times a player has died.

Requirement name: `times died`

| Example usage |      Explanation      |
| :-----------: | :-------------------: |
|       10      | Needs to die 10 times |

### Trades with villagers

Check how many times a player has traded with a villager

Requirement name: `traded with villagers`

| Example usage |               Explanation              |
| :-----------: | :------------------------------------: |
|      `10`     | Needs to trade 10 times with villagers |

### Items thrown

Check how many times a player has thrown a specific item.

Requirement name: `item thrown`

| Example usage |       Explanation       |
| :-----------: | :---------------------: |
|    EGG;100    | Needs to throw 100 eggs |

## AureliumSkills requirements

You will need [AureliumSkills](https://www.spigotmc.org/resources/aurelium-skills-advanced-skills-stats-abilities-and-more.81069/) for these requirements.

### Level of a particular skill

Check the level of a particular skill

Requirement name: `aurelium skills skill level`

| Example usage |              Explanation             |
| :-----------: | :----------------------------------: |
|  fishing;100  | Needs to have level 100 in 'fishing' |

### Level of a stat

Check the level of a stat of a player

Requirement name: `aurelium skills stat level`

| Example usage |                   Explanation                  |
| :-----------: | :--------------------------------------------: |
|  strength;100 | Needs to have level 100 in the stat 'strength' |

### XP level of a skill

Check the xp level of a skill

Requirement name: `aurelium skills xp`

| Example usage |            Explanation            |
| :-----------: | :-------------------------------: |
|  sorcery;100  | Needs to have 100 XP in 'sorcery' |

### Amount of mana

Check the amount of mana a player has

Requirement name: `aurelium skills mana`

| Example usage |       Explanation      |
| :-----------: | :--------------------: |
|     `250`     | Needs to have 250 mana |

## BentoBox requirements

To use these requirements, you'll need [this plugin](https://www.spigotmc.org/resources/acidisland.581/).&#x20;

### Island level&#x20;

Check the island level of a player.

Requirement name: bentobox `level`

| Example usage |             Explanation             |
| :-----------: | :---------------------------------: |
|    20;world   | Needs to have an island level of 20 |

## Essentials(X) requirements

You'll need either Essentials or [EssentialsX ](https://www.spigotmc.org/resources/essentialsx.9089/)for these requirements.

### Geo location

Check the real life location of a player

Requirement name: `essentials geoip location`

| Example usage |                  Explanation                  |
| :-----------: | :-------------------------------------------: |
|  Netherlands  | Player should be playing from the Netherlands |

## Factions requirements

To use these requirements, you need a Factions plugin, like this [one](https://www.spigotmc.org/resources/factions.1900/).

### Faction power

Check how much power a faction of a player has (if he has any). If a player does not have a faction, this will return zero.

Requirement name: `faction power`

| Example usage |           Explanation          |
| :-----------: | :----------------------------: |
|       10      | Needs to have 10 faction power |

## GriefPrevention requirements

You'll need [GriefPrevention ](https://www.spigotmc.org/resources/griefprevention.1884/)to use these requirements.

### Number of claims

Check how many claims a player has

Requirement name: `grief prevention claims`

| Example usage |       Explanation       |
| :-----------: | :---------------------: |
|      `24`     | Needs to have 24 claims |

### Number of claimed blocks

Check how many claimed blocks a player has

Requirement name: `grief prevention claimed blocks`

| Example usage |            Explanation           |
| :-----------: | :------------------------------: |
|      100      | Needs to have 100 claimed blocks |

### Number of remaining claim blocks

Check how many blocks a player can still claim

Requirement name: `grief prevention remaining blocks`

| Example usage |            Explanation            |
| :-----------: | :-------------------------------: |
|       55      | Needs to have 55 remaining blocks |

### Number of bonus claim blocks

Check how many bonus claim blocks a player has

Requirement name: `grief prevention bonus blocks`

| Example usage |             Explanation             |
| :-----------: | :---------------------------------: |
|       10      | Needs to have 10 bonus claim blocks |

## Jobs requirements

[Jobs ](https://www.spigotmc.org/resources/jobs-reborn.4216/)is required!

### Current points

Check the points that a player currently has

Requirement name: `jobs current points`

| Example usage |        Explanation       |
| :-----------: | :----------------------: |
|     `120`     | Needs to have 120 points |

### Total points

Check the total points that a player has accumulated over time.

Requirement name: `jobs total points`

| Example usage |             Explanation             |
| :-----------: | :---------------------------------: |
|      120      | Needs to have a total of 120 points |

### Level of a specific job

Check the level of a specific job of a player

Requirement name: `jobs level`

| Example usage |                  Explanation                 |
| :-----------: | :------------------------------------------: |
|   100;mining  | Needs to have level 100 in the *mining* job. |

### Experience of a job

Check the experience a player has for a specific job

Requirement name: `jobs experience`

| Example usage |                Explanation                |
| :-----------: | :---------------------------------------: |
|   120;mining  | Needs to have 120 exp in the *mining* job |

## mcMMO requirements

To use these requirements, you'll need [mcMMO](https://www.spigotmc.org/resources/official-mcmmo-original-author-returns.64348/).

### Have a particular skill level

Check the level of a particular skill of a player

Requirement name: `mcmmo skill level`

{% hint style="info" %}
For a list of skills, see this [page](https://github.com/mcMMO-Dev/mcMMO/blob/fdd951f1f1890d4bcb62fb6d44fd576df63ad8fe/src/main/java/com/gmail/nossr50/datatypes/skills/PrimarySkillType.java#L37).
{% endhint %}

| Example usage |             Explanation             |
| :-----------: | :---------------------------------: |
|   100;mining  | Needs to have level 100 in *Mining* |

### Have a power level

Check the power level of a player (= sum of skill levels)

Requirement name: `mcmmo power level`

| Example usage |             Explanation            |
| :-----------: | :--------------------------------: |
|      450      | Needs to have a power level of 450 |

## Placeholder requirements

You need [PlaceholderAPI ](https://www.spigotmc.org/resources/placeholderapi.6245/)for these requirements.

Syntax of the requirement: `amount; placeholder; language placeholder`

| Parameter                       | Explanation                                              |
| ------------------------------- | -------------------------------------------------------- |
| Amount (integer)                | Amount of the item                                       |
| Placeholder (integer or String) | Placeholder from a plugin you want to use for your check |
| Language placeholder (string)   | Discription to show to the user in the requirement       |

### Integer

Check the integer value of a placeholder, for a player

Requirement name: placeholder integer

|                Example usage               |                     Explanation                     |
| :----------------------------------------: | :-------------------------------------------------: |
| 10;\<placeholder>;<`language placeholder`> | Needs to have 10 of what the placeholder represents |

### String

Check the string value of a placeholder, for a player

Requirement name: placeholder string

|                   Example usage                   |                         Explanation                        |
| :-----------------------------------------------: | :--------------------------------------------------------: |
| \<String>;\<placeholder>;<`language placeholder>` | Needs to have \<String> of what the placeholder represents |

## PlayerPoints requirements

You need [PlayerPoints ](https://dev.bukkit.org/projects/playerpoints)for these requirements.

### Points

Check the player points of a player.

Requirement name: `playerpoints points`

| Example usage |            Explanation           |
| :-----------: | :------------------------------: |
|      `50`     | Needs to have a 50 player points |

## Quests requirements

To use these requirements, you'll need this [Quests ](https://www.spigotmc.org/resources/%E2%96%B6-quests-%E2%97%80-set-up-goals-for-players.23696/)plugin or this [one](https://www.spigotmc.org/resources/quests.3711/).

### Number of active quests

Check how many active quests a player has

Requirement name: `quests active quests`

| Example usage |           Explanation          |
| :-----------: | :----------------------------: |
|       10      | Needs to have 10 active quests |

Check how many completed quests a player has

Requirement name: `quests completed quests`

| Example usage |            Explanation            |
| :-----------: | :-------------------------------: |
|       10      | Needs to have 10 completed quests |

Check whether a player has completed a specific quest

Requirement name: `quests complete quest`

|    Example usage   |               Explanation              |
| :----------------: | :------------------------------------: |
| Kill Mother Teresa | Needs to complete *Kill Mother Teresa* |

Check how many quest points a player has.

Requirement name: `quests quest points`

{% hint style="warning" %}
This requirement can only be used when you use [this specific Quests](https://www.spigotmc.org/resources/quests.3711/) plugin.
{% endhint %}

| Example usage |           Explanation          |
| :-----------: | :----------------------------: |
|      100      | Needs to have 100 quest points |

## Towny requirements

​[Towny ](https://www.spigotmc.org/resources/towny-advanced.72694/)is required for these requirements.

### Has a town

Check whether a player is part of a town

Requirement name: `towny has town`

| Example usage |          Has a town         |
| :-----------: | :-------------------------: |
|      true     | Player needs to have a town |

### Has a nation

Check whether a player is part of a nation

Requirement name: `towny has nation`

| Example usage |          Explanation          |
| :-----------: | :---------------------------: |
|      true     | Player needs to have a nation |

Check whether a player is a mayor or a town

Requirement name: `towny is mayor`

| Example usage |         Explanation        |
| :-----------: | :------------------------: |
|      true     | Player needs to be a mayor |

Check whether a player is king of a nation

Requirement name: `towny is king`

| Example usage |        Explanation        |
| :-----------: | :-----------------------: |
|      true     | Player needs to be a king |

Check how many town blocks a player has

Requirement name: `towny town blocks`

| Example usage |          Explanation         |
| :-----------: | :--------------------------: |
|       75      | Needs to have 75 town blocks |

## WorldGuard requirements

To use these requirements, you need the WorldGuard plugin, like this [one](https://dev.bukkit.org/projects/worldguard).

### Be in a worldguard region

Check whether a player is in a specific worldguard region

Requirement name: `worldguard region`

| Example usage |         Explanation         |
| :-----------: | :-------------------------: |
|   TestRegion  | Needs to be in *TestRegion* |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://autorank.gitbook.io/autorank-v5.1.0/path-configuration/building-your-own-paths/requirements.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.