> For the complete documentation index, see [llms.txt](https://gatito360.gitbook.io/realmcore-wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gatito360.gitbook.io/realmcore-wiki/readme.md).

# RealmCore

Complete RealmCore documentation for server owners, administrators, developers, and multiserver networks.

RealmCore creates player-owned worlds that can be generated, copied from templates, protected, loaded on demand, and managed through commands or fully configurable menus.

This wiki is written for the current **1.7.03** line. It explains what each file does, what each command checks, how integrations behave, and what to test when something goes wrong.

## 📥 Download

You can download the plugin from [BuiltByBit](https://builtbybit.com/resources/realm-core.34966/).

## 🗒️ Description

The plugin allows each player to create their own private world on a Minecraft server. Players can customize gamerules, invite friends, and grant them permissions to modify the world, providing a controlled and personalized gameplay experience.

## 🚀 Choose your path

* [🧩 Capabilities and Use Cases](/realmcore-wiki/readme/capabilities-and-use-cases.md) — see what combinations RealmCore supports.
* [🏗️ Realm Creation Guide](/realmcore-wiki/readme/realm-creation-guide.md) — understand every creation and reset path.
* [🎮 Gameplay and Operations](/realmcore-wiki/readme/gameplay-and-operations.md) — understand chat, portals, respawn, bossbars, maintenance, and web data.
* [🚀 Getting Started](/realmcore-wiki/quickstart.md) — install the plugin and create the first realm.
* [📟 Commands](/realmcore-wiki/commands.md) — player and administrator commands.
* [🔐 Permissions](/realmcore-wiki/permissions.md) — command, role, biome, template, and numeric permissions.
* [⚙️ Settings Tutorial](/realmcore-wiki/settings-tutorial.md) — understand every configuration file.
* [📬 Menus](/realmcore-wiki/menus.md) — configure Java inventories and Bedrock forms.
* [🏷️ PlaceholderAPI](/realmcore-wiki/placeholderapi-variables.md) — display realm state, balances, cooldowns, and gamerules.
* [🔗 Integrations](/realmcore-wiki/integrations.md) — connect optional plugins safely.
* [📈 Optimization](/realmcore-wiki/optimization-and-stability.md) — keep world creation, loading, and storage predictable.
* [❓ Troubleshooting](/realmcore-wiki/ask-and-questions.md) — diagnose common failures using the first useful log line.

## 🧭 Configuration map

| File or folder        | What it controls                                                                                     |
| --------------------- | ---------------------------------------------------------------------------------------------------- |
| settings.yml          | Main command, language, storage, cooldowns, performance, Bedrock, and web panel.                     |
| realm-settings.yml    | Creation mode, generator, templates, gamerules, borders, spawn, bossbar, chat, and kick destination. |
| role\_permissions.yml | What OWNER, MEMBER, TRUSTED, and VISITOR may do inside a realm.                                      |
| mysql-settings.yml    | MySQL endpoint, identity, credentials, and connection pool.                                          |
| multi-settings.yml    | RealmCoreMulti endpoint, server identity, and verification.                                          |
| lang/                 | Localized messages and optional message suppression.                                                 |
| menus/                | Java and Bedrock menu layout, functional items, permissions, and actions.                            |

## ✨ What RealmCore provides

* Configurable main command and aliases across commands, menus, clickable chat actions, invitations, and teleports.
* Generic boolean gamerule placeholders through %realmcore\_realm\_setting\_%.
* Empty language values that intentionally suppress a message without changing command logic.
* Optional HuskHomes, MythicMobs, PlaceholderAPI, Vault, ItemsAdder, Nexo, and CraftEngine hooks.
* Bounded creation and spawn probing designed to avoid unbounded server work.
* Per-realm coordination for repeated or conflicting load, unload, create, reset, and delete operations.
* Template staging that excludes Paper/Minecraft runtime state files.
* Schema-aware migration with backups instead of replacing a user's configuration blindly.

## 🧩 Developer area

* [🧩 Developer API](/realmcore-wiki/readme/developer-api.md)
* [🧰 Extension Points and Architecture](/realmcore-wiki/readme/developer-api/extension-points-and-architecture.md)
* [📚 API Overview](/realmcore-wiki/readme/developer-api/api-overview.md)
* [🌐 Realm Interface](/realmcore-wiki/readme/developer-api/realm-interface.md)
* [⚡ Events](/realmcore-wiki/readme/developer-api/events.md)

## 🆘 Support checklist

When reporting a problem, include:

1. RealmCore version.
2. Paper, Leaf, or other server implementation and exact version.
3. Java version.
4. YAML or MySQL storage mode.
5. Relevant configuration with passwords and secrets removed.
6. The complete first error, including its Caused by section.
7. Whether the realm was being created, loaded, reset, visited, unloaded, or deleted.

Screenshots are useful for context, but the full log is usually what identifies the cause.