# Supported Plugins

## Vault

Player Auctions depends on [Vault ](https://www.spigotmc.org/resources/34315/)so you can use any of your favorite economy/permissions plugins that will be used in Player Auctions by hooking into Vault.

## PlaceholderAPI

Player Auctions hooks into [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) so you can use the Player Auctions placeholders everywhere that supports PlaceholderAPI, here is a list of the current placeholders.

| Placeholder                           | Description                                                                                                                                                                                          |
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| %pa\_player\_auctions%                | View the amount of current auctions.                                                                                                                                                                 |
| %pa\_player\_available%               | View the amount of current auctions a player can sell.                                                                                                                                               |
| %pa\_player\_maxauctions%             | View the maximum amount of auctions that you can sell.                                                                                                                                               |
| %pa\_player\_expired%                 | View the amount of expired auctions.                                                                                                                                                                 |
| %pa\_player\_recent%                  | View the total amount of recent auctions.                                                                                                                                                            |
| %pa\_player\_recent\_\<type>%         | View the amount of recent auctions for that type.                                                                                                                                                    |
| %pa\_player\_recent\_spent\_\[when]%  | View the amount the player has spent based on their recently bought. The when placeholder is optional and can either be: `day`, `week`, `month` & `year.` You may append \_raw to get the raw value. |
| %pa\_player\_recent\_earned\_\[when]% | View the amount the player has earned based on their recently sold. The when placeholder is optional and can either be: `day`, `week`, `month` & `year.` You may append \_raw to get the raw value.  |
| %pa\_server\_auctions%                | View the amount of current auctions on the server.                                                                                                                                                   |
| %pa\_server\_auctions\_\<category>%   | View the amount of current auctions for that category.                                                                                                                                               |
| %pa\_gui\_auction\_\<modifier>%       | <p>View the modifier of the current auction that is assigned to the player via a menu.</p><p>Check modifiers below.</p>                                                                              |
| %pa\_gui\_category%                   | View the current category name that is assigned to the player via a menu.                                                                                                                            |
| %pa\_gui\_category\_display%          | View the current category display name that is assigned to the player via a menu.                                                                                                                    |
| %pa\_gui\_page%                       | View the current page that is assigned to the player via a menu.                                                                                                                                     |
| %pa\_gui\_pages%                      | View the current pages that is assigned to the player via a menu.                                                                                                                                    |

| Modifier          | Description                              |
| ----------------- | ---------------------------------------- |
| price             | Get tge price of the auction.            |
| price\_formatted  | Get the formatted price of the auction.  |
| price\_item       | Get the price per item for that auction. |
| currency          | Get the currency of the auction.         |
| seller            | Get the seller of the auction.           |
| seller\_uuid      | Get the seller UUID of the auction.      |
| expire            | Get the expired time of the auction.     |
| categories        | Get the categories of the auction.       |
| id                | Get the ID of the auction.               |
| enchantments      | Get the enchantments of the auction.     |
| repair\_cost      | Get the repair cost of the auction.      |
| amount            | Get the amount of the auction.           |
| lore              | Get the lore of the auction.             |
| date              | Get the date created of the auction.     |
| bidder            | Get the top bidder of the auction.       |
| server            | Get the server of the auction.           |
| item              | Get the item of the auction.             |
| item\_displayname | Get the item displayname of the auction. |

These are the current auction expansions, that hook into other plugins to change on how the plugin works. You can configure all these expansions and change how they work in the expansions.yml. Every expansion is configurable.

## TokenManager

Player Auctions hooks into [TokenManager](https://www.spigotmc.org/resources/8610/) as a currency so you can sell/purchase items on the auction house using this currency. Here is the default configuration for this addon.

```yaml
  tokenmanager:
    # Do you want to enable the TokenManager currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The name that is used in-game to decide what currency to use.
    name: "tokens"
    # The prefix of the price variable, this is how you want the variable to show when using the token manager currency.
    prefix: "%price% tokens"
    # The minimum amount they need to at least pay when using this currency in the confirmation GUI. Set to -1 to ignore.
    min-price-purchase: -1
    # What's the minimum amount the player can add to the offer of a bid?
    # This is to stop people from adding for example $1 when the bid is about to end to win the bid.
    min-bid-amount: 1000
    # What is the minimum price for an auction?
    min-price-auction: 1000
    # What is the maximum price for an auction?
    max-price-auction: 9999999
```

## PlayerPoints

Player Auctions hooks into [PlayerPoints](https://www.spigotmc.org/resources/80745/) as a currency so you can sell/purchase items on the auction house using this currency. Here is the default configuration for this addon.

```yaml
  playerpoints:
    # Do you want to enable the PlayerPoints currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The name that is used in-game to decide what currency to use.
    name: "points"
    # The prefix of the price variable, this is how you want the variable to show when using the player points currency.
    prefix: "%price% points"
    # The minimum amount they need to at least pay when using this currency in the confirmation GUI. Set to -1 to ignore.
    min-price-purchase: -1
    # What's the minimum amount the player can add to the offer of a bid?
    # This is to stop people from adding for example $1 when the bid is about to end to win the bid.
    min-bid-amount: 1000
    # What is the minimum price for an auction?
    min-price-auction: 1000
    # What is the maximum price for an auction?
    max-price-auction: 9999999
```

## BeastToken

Player Auctions hooks into [BeastToken](https://www.spigotmc.org/resources/20806/) as a currency so you can sell/purchase items on the auction house using this currency. Here is the default configuration for this addon.

```yaml
  beasttoken:
    # Do you want to enable the BeastToken currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The name that is used in-game to decide what currency to use.
    name: "tokens"
    # The prefix of the price variable, this is how you want the variable to show when using the beast token currency.
    prefix: "%price% tokens"
    # The minimum amount they need to at least pay when using this currency in the confirmation GUI. Set to -1 to ignore.
    min-price-purchase: -1
    # What's the minimum amount the player can add to the offer of a bid?
    # This is to stop people from adding for example $1 when the bid is about to end to win the bid.
    min-bid-amount: 1000
    # What is the minimum price for an auction?
    min-price-auction: 1000
    # What is the maximum price for an auction?
    max-price-auction: 9999999
```

## GemsEconomy

Player Auctions hooks into [GemsEconomy](https://www.spigotmc.org/resources/95658/) as a currency so you can sell/purchase items on the auction house using this currency. Here is the default configuration for this addon.

```yaml
  gemseconomy:
    # Do you want to enable the GemsEconomy currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The name that is used in-game to decide what currency to use.
    name: "gems"
    # The prefix of the price variable, this is how you want the variable to show when using the gemseconomy currency.
    prefixes:
      currency_name: "%price% gems"
    # The minimum amount they need to at least pay when using this currency in the confirmation GUI. Set to -1 to ignore.
    min-price-purchase: -1
    # What's the minimum amount the player can add to the offer of a bid?
    # This is to stop people from adding for example $1 when the bid is about to end to win the bid.
    min-bid-amount: 1000
    # What is the minimum price for an auction?
    min-price-auction: 1000
    # What is the maximum price for an auction?
    max-price-auction: 9999999
```

## UltraEconomy

Player Auctions hooks into [UltraEconomy](https://www.spigotmc.org/resources/83374/) as a currency so you can sell/purchase items on the auction house using this currency. Here is the default configuration for this addon.

```yaml
  ultraeconomy:
    # Do you want to enable the UltraEconomy currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The name that is used in-game to decide what currency to use.
    name: "gems"
    # The prefix of the price variable, this is how you want the variable to show when using the ultraeconomy currency.
    prefixes:
      currency_name: "%price% coins"
    # The minimum amount they need to at least pay when using this currency in the confirmation GUI. Set to -1 to ignore.
    min-price-purchase: -1
    # What's the minimum amount the player can add to the offer of a bid?
    # This is to stop people from adding for example $1 when the bid is about to end to win the bid.
    min-bid-amount: 1000
    # What is the minimum price for an auction?
    min-price-auction: 1000
    # What is the maximum price for an auction?
    max-price-auction: 9999999
```

## EcoBits

Player Auctions hooks into [EcoBits](https://www.spigotmc.org/resources/109967/) as a currency so you can sell/purchase items on the auction house using this currency. Here is the default configuration for this addon.

```yaml
  ecobits:
    # Do you want to enable the EcoBits currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The name that is used in the config to decide what currency to use.
    name: "bits"
    # The prefix of the price variable, this is how you want the variable to show when using the eco bits currency.
    prefixes:
      currency_name: "%price% bits"
    # The minimum amount they need to at least pay when using this currency in the confirmation GUI. Set to -1 to ignore.
    min-price-purchase: -1
    # What's the minimum amount the player can add to the offer of a bid?
    # This is to stop people from adding for example $1 when the bid is about to end to win the bid.
    min-bid-amount: 1000
    # What is the minimum price for an auction?
    min-price-auction: 1000
    # What is the maximum price for an auction?
    max-price-auction: 9999999
```

## ExcellentEconomy

Player Auctions hooks into [ExcellentEconomy](https://www.spigotmc.org/resources/84121/) as a currency so you can sell/purchase items on the auction house using this currency. Here is the default configuration for this addon.

```yaml
  excellenteconomy:
    # Do you want to enable the ExcellentEconomy currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The name that is used in the config to decide what currency to use.
    name: "coins"
    # The prefix of the price variable, this is how you want the variable to show when using the excellent economy currency.
    prefixes:
      currency_name: "%price% coins"
    # The minimum amount they need to at least pay when using this currency in the confirmation GUI. Set to -1 to ignore.
    min-price-purchase: -1
    # What's the minimum amount the player can add to the offer of a bid?
    # This is to stop people from adding for example $1 when the bid is about to end to win the bid.
    min-bid-amount: 1000
    # What is the minimum price for an auction?
    min-price-auction: 1000
    # What is the maximum price for an auction?
    max-price-auction: 9999999
```

## RivalCredits

Player Auctions hooks into [RivalCredits](https://builtbybit.com/resources/31250/) as a currency so you can sell/purchase items on the auction house using this currency. Here is the default configuration for this addon.

```yaml
  rivalcredits:
    # Do you want to enable the RivalCredits currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The name that is used in the config to decide what currency to use.
    name: "credits"
    # The prefix of the price variable, this is how you want the variable to show when using the rival credits currency.
    prefix: "%price% credits"
    # The minimum amount they need to at least pay when using this currency in the confirmation GUI. Set to -1 to ignore.
    min-price-purchase: -1
    # What's the minimum amount the player can add to the offer of a bid?
    # This is to stop people from adding for example $1 when the bid is about to end to win the bid.
    min-bid-amount: 1000
    # What is the minimum price for an auction?
    min-price-auction: 1000
    # What is the maximum price for an auction?
    max-price-auction: 9999999
```

## RivalHarvesterHoes

Player Auctions hooks into [RivalHarvesterHoes](https://builtbybit.com/resources/21424/) as a currency so you can sell/purchase items on the auction house using this currency. Here is the default configuration for this addon.

```yaml
  rivalharvesterhoes:
    # Do you want to enable the RivalHarvesterHoes currency?
    enabled: false
    # What version of this expansion do you want to download/use?
    version: latest
    # The name that is used in the config to decide what currency to use.
    name: "credits"
    # The prefix of the price variable, this is how you want the variable to show when using the rival harvester hoes currency.
    prefix: "%price% credits"
    # The minimum amount they need to at least pay when using this currency in the confirmation GUI. Set to -1 to ignore.
    min-price-purchase: -1
    # What's the minimum amount the player can add to the offer of a bid?
    # This is to stop people from adding for example $1 when the bid is about to end to win the bid.
    min-bid-amount: 1000
    # What is the minimum price for an auction?
    min-price-auction: 1000
    # What is the maximum price for an auction?
    max-price-auction: 9999999
```


---

# 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://docs.olziedev.com/projects/playerauctions/plugins.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.
