> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/pinnaprison/tools-and-items/boosters.md).

# Boosters

Boosters temporarily multiply the currency (or enchant proc chance) a player earns. There are **personal** boosters (activated from an item) and **global**, server-wide boosters (started by an admin). Configured in `boosters.yml`.

```yaml
enabled: true
gui: 'boosters'
gui-booster-display: ' &b- &7{name}: &b{multiplier}x'
gui-no-booster-display: ' &b- &7None'

multiplicative-boosters: false

global-boosters:
  show-bossbar: true
  bossbar-color: 'PURPLE'
  bossbar-style: 'SOLID'
  bossbar-format: '&d&lGLOBAL BOOSTER &7| {boosters}'
  booster-format: '&f{name} &d{multiplier}x &7({time})'
  separator: ' &8| '
  permanent-time: 'Permanent'
  announce: '&d&lGLOBAL BOOSTER &r&dA &f{name} &dx{multiplier} booster is now active for &f{time}&d!'
  formats:
    money: '&2Money'
    tokens: '&4Tokens'
    enchants: '&9Global Enchant'

booster-items:
  tokens-booster:
    name: 'Tokens Multiplier'
    is-enchant-booster: false
    total-duration: 150        # seconds
    economy: 'tokens'
    multiplier: 3              # (+1 base) = x4 final
    item:
      material: POTION
      name: '&4&lTokens &c&lBooster'
      lore:
        - '&4[ʀɪɢʜᴛ ᴄʟɪᴄᴋ ᴛᴏ ᴀᴄᴛɪᴠᴀᴛᴇ]'
```

## Global settings

| Key                                              | Description                                                                                                                       |
| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
| `enabled`                                        | Master toggle.                                                                                                                    |
| `gui`                                            | The boosters menu (`guis/boosters.yml`).                                                                                          |
| `gui-booster-display` / `gui-no-booster-display` | How active boosters render in the menu (`{name}`, `{multiplier}`).                                                                |
| `multiplicative-boosters`                        | How boosters on the same economy stack. `false` (default, additive): x2 + x3 = **x5**. `true` (multiplicative): x2 + x3 = **x6**. |

## Global boosters display

The `global-boosters` block controls the boss bar and announcement for server-wide boosters.

| Key                 | Description                                                             |
| ------------------- | ----------------------------------------------------------------------- |
| `show-bossbar`      | Show a boss bar while a global booster is active.                       |
| `bossbar-color`     | `WHITE`, `PINK`, `PURPLE`, `RED`, `GREEN`, `YELLOW`, `BLUE`.            |
| `bossbar-style`     | `SOLID`, `SEGMENTED_6`, `SEGMENTED_10`, `SEGMENTED_12`, `SEGMENTED_20`. |
| `bossbar-format`    | Boss bar text (`{boosters}` = the list).                                |
| `booster-format`    | One booster entry (`{name}`, `{multiplier}`, `{time}`).                 |
| `separator`         | Between multiple booster entries.                                       |
| `permanent-time`    | Text shown for a booster with no time limit.                            |
| `announce`          | Broadcast when a global booster starts.                                 |
| `formats.<economy>` | Display name per economy (`money`, `tokens`, `enchants`).               |

## Booster items (`booster-items`)

| Key                  | Description                                                                                 |
| -------------------- | ------------------------------------------------------------------------------------------- |
| `name`               | Display name.                                                                               |
| `is-enchant-booster` | `true` = boosts **all enchant** proc chances; `false` = boosts a currency.                  |
| `total-duration`     | Duration in seconds.                                                                        |
| `economy`            | The currency id boosted (empty for enchant boosters).                                       |
| `multiplier`         | The bonus multiplier. Note: there is always a base `+1`, so `multiplier: 3` = **x4** final. |
| `item`               | The booster item (right-click to activate).                                                 |

The plugin ships booster items for **tokens, money, gems, shards, rankup XP, pickaxe XP, blocks** and a **global enchant** booster — all shown as multiplier breakdowns in the `/boosters` menu.

## Blocks multiplier

The **blocks (autosell) multiplier** decides how many blocks each mined block is worth for autosell / your [backpack](/p/pinnaprison/tools-and-items/backpacks.md). It is the sum of:

* the player's **backpack tier** multiplier,
* their equipped **pickaxe skin** multiplier ([Pickaxe Skins](/p/pinnaprison/core/pickaxe/pickaxe-skins.md)),
* and any active **`blocks` boosters / crystals / attributes** (the same boost stack currencies use, keyed by the economy id `blocks`).

The total is shown in the `/boosters` menu and via `%pinnaprison_blocks_multiplier%`. To add to it, give a booster/crystal whose economy is `blocks` — e.g. the default **Blocks Booster** item, or:

```
/boosters give <player> blocks <multiplier> <time-in-sec> <name>
/boosters global blocks <multiplier> <time-in-sec>
```

## Usage

* **Right-click** a booster item → activate it (personal booster).
* **`/boosters`** (aliases `/boosts`, `/booster`) — open the boosters menu.
* Admins:
  * `/boosters giveitem <player> <item-id>` — give a booster item.
  * `/boosters give <player> <currency|enchant> <multiplier> <time-in-sec> <name>` — apply a personal booster directly.
  * `/boosters global <currency|enchant|enchants> <multiplier> <time-in-sec>` — start a server-wide booster.

## Placeholders

```
%pinnaprison_boosters_global_<currency>%   -> current multiplier (incl. base)
%pinnaprison_boosters_global_enchants%     -> enchant booster multiplier
%pinnaprison_boosters_names_<currency>%    -> active booster names
%pinnaprison_boosters_names_enchants%      -> active enchant booster names
%pinnaprison_boosters_global_blocks%       -> active blocks-booster multiplier
%pinnaprison_blocks_multiplier%            -> total blocks/autosell multiplier (backpack + skin + boosters)
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://edseries-plugins.gitbook.io/p/pinnaprison/tools-and-items/boosters.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.