> For the complete documentation index, see [llms.txt](https://lethium.gitbook.io/custombeacons-or-65-effects-or-35-hooks/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lethium.gitbook.io/custombeacons-or-65-effects-or-35-hooks/welcome.md).

# Welcome

The complete guide to running CustomBeacons on your server.

**CustomBeacons** turns the vanilla beacon into something your players build towards. They place a beacon on a pyramid, then unlock and upgrade **effects** that apply inside its area, paying with XP levels, money, items, points or any currency you define.

This guide is written for **server owners and admins**. You do not need to know how to code. Everything is set up through YAML files and in-game menus, and every setting is explained in plain language.

## What you can do with it

* Give players **67 ready-made effects**, from Speed and Regeneration to Ore Fortune, Spawner Speed, Jobs Income and Flying. Every effect is a file you can edit, copy or delete.
* Control **who benefits** from each beacon: only the owner, trusted players, a team (and its allies) or everyone.
* Grow beacons through **7 tiers** and **5 beacon types** (Bronze to Diamond), each with its own power budget and fuel capacity.
* Add **20 beacon upgrades** for range, power, fuel, discounts, protection, chunk loading and more.
* Give the endgame a hook with **prestige**: reset an effect for a stronger level, at the price of beacon tiers.
* Charge for everything in **XP, Vault money, PlayerPoints, items or custom currencies**, with optional upkeep, fuel, power budget and price scaling.
* Restyle **every menu**, translate **every text** (10 languages included), and change every sound, particle and hologram. **Bedrock players** get a tap menu automatically.
* Connect to **over 30 plugins**: teams, claims, WorldGuard, mcMMO, Jobs, shops, spawners, minions, Dynmap and more.
* Run it on **Paper or Folia**, with SQLite, MySQL or MariaDB, automatic backups and a full purchase log.
* Extend it with a **Developer API** for your own effects and upgrades.

## Where to start

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-download" style="color:$primary;">:download:</i></h3></td><td><strong>Install it</strong></td><td>Requirements, license key and first start.</td><td><a href="/custombeacons-or-65-effects-or-35-hooks/getting-started/installation-and-first-start.md">Installation and first start</a></td></tr><tr><td><h3><i class="fa-bolt" style="color:$primary;">:bolt:</i></h3></td><td><strong>Your first beacon</strong></td><td>Build a pyramid and unlock an effect in five minutes.</td><td><a href="/custombeacons-or-65-effects-or-35-hooks/getting-started/your-first-beacon.md">Your first beacon</a></td></tr><tr><td><h3><i class="fa-star" style="color:$primary;">:star:</i></h3></td><td><strong>Prestige</strong></td><td>The endgame system, and how to tune it.</td><td><a href="/custombeacons-or-65-effects-or-35-hooks/how-it-works/prestige.md">Prestige</a></td></tr><tr><td><h3><i class="fa-shield" style="color:$primary;">:shield:</i></h3></td><td><strong>Permissions</strong></td><td>Player and staff nodes, limits per rank, world and type whitelists.</td><td><a href="/custombeacons-or-65-effects-or-35-hooks/running-your-server/permissions.md">Permissions</a></td></tr><tr><td><h3><i class="fa-table-cells" style="color:$primary;">:table-cells:</i></h3></td><td><strong>Menus and GUI</strong></td><td>Restyle every button, slot and animation.</td><td><a href="/custombeacons-or-65-effects-or-35-hooks/running-your-server/menus-and-gui-customisation.md">Menus and GUI customisation</a></td></tr><tr><td><h3><i class="fa-wand-magic-sparkles" style="color:$primary;">:wand-magic-sparkles:</i></h3></td><td><strong>Effect catalog</strong></td><td>All 67 effects with tier, levels and targets.</td><td><a href="/custombeacons-or-65-effects-or-35-hooks/reference/effect-catalog.md">Effect catalog</a></td></tr><tr><td><h3><i class="fa-plug" style="color:$primary;">:plug:</i></h3></td><td><strong>Integrations</strong></td><td>Every plugin CustomBeacons works with.</td><td><a href="/custombeacons-or-65-effects-or-35-hooks/reference/integrations.md">Integrations</a></td></tr></tbody></table>

## How this guide is organised

| Section                                                                                | What is in it                                                                                |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| [Getting Started](/custombeacons-or-65-effects-or-35-hooks/getting-started.md)         | Install, first start, your first beacon                                                      |
| [How It Works](/custombeacons-or-65-effects-or-35-hooks/how-it-works.md)               | Tiers and power, who benefits, effects, prestige, fuel, beacon types, upgrades, prices       |
| [Running Your Server](/custombeacons-or-65-effects-or-35-hooks/running-your-server.md) | Permissions, commands, menus, effects, languages, limits, placeholders, storage, performance |
| [Reference](/custombeacons-or-65-effects-or-35-hooks/reference.md)                     | Effect catalog, integrations, what you can switch off, troubleshooting                       |
| [Developer API](/custombeacons-or-65-effects-or-35-hooks/developer-api.md)             | For developers who want to add effects, upgrades and team providers                          |

{% hint style="info" %}
Every change you make in a file is applied with `/cbeacon reload`, no restart needed (a few settings say otherwise in their comments).
{% endhint %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://lethium.gitbook.io/custombeacons-or-65-effects-or-35-hooks/welcome.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.