RPGCORE — Admin & Developer Documentation¶
A suite of Paper Minecraft plugins (Paper API 26.1.2, Java 25) that together build an entirely custom RPG framework. The goal is total vanilla replacement — every gameplay mechanic (damage, mana, skills, mob spawning, crafting, enchanting, brewing, regen, abilities, etc.) is custom-coded and configurable via YAML. No Java required to author content.
Project status: Actively in development. Core systems, all skill addons, economy, chat, HUD, parties, guilds, dungeons, enchanting, accessories, NPCs, holograms, quests, regions, trade, and admin utilities are all shipped. Each page has a
Status:header showing where individual subsystems stand.
New here? Start with content creation¶
| Goal | Where to go |
|---|---|
| Get something playable in 30 minutes | Quick-Start Guide |
| Copy-paste examples for every content type | Cookbook |
| Full mob walkthrough (end-to-end) | First Mob Walkthrough |
| Common ability patterns (fireball, AoE, etc.) | Patterns |
| How to tune gear and mob difficulty | Progression Guide |
Reference links¶
- Installation — setup, dependencies, plugin order
- Configuration overview — config file layout, reload commands
- Stats reference — every stat, its effect, and damage formulas
- Resource pack & CustomModelData ranges
- Master command reference
- Master permission reference
- Admin guide — authoring workflows and troubleshooting
- Changelog — version history
- Formatting guide — GUI layouts, text colors, message standards
- Development — build, test, contribute
- Roadmap — everything still to be built (bugs · features · improvements · GUI · docs)
Core systems¶
rpg-core owns every shared service. All addons hard-depend on it.
| Page | What it covers |
|---|---|
| Core overview | Service surface, what lives in core |
| Persistence | YAML/MySQL toggle, schema versioning, migrations |
| Damage pipeline | How damage is computed and routed |
| Status effects | Custom (de)buff framework |
| Skills framework | XP, levels, curve equations, milestones |
| Health display | Custom HP display (hearts as percent) |
| Selection wand | Single admin wand with multiple modes |
| Vanilla suppression | Master toggle list for cancelling vanilla mechanics |
Content authoring¶
Admins author content as YAML files in the plugin data directory. Any number of files, any number of entries per file.
| Page | Folder | What you author |
|---|---|---|
| Items | items/ |
Weapons, armor, materials, consumables, upgrades, accessories |
| Mobs | mobs/ |
Custom mobs with stats, equipment, abilities, AI profiles |
| Abilities | abilities/ |
Custom ability sequences using the effect DSL |
| Blocks | blocks/ |
Custom blocks (ores, logs, crafting stations) |
| Recipes | recipes/crafting/, recipes/cooking/, recipes/brewing/ |
All recipe types |
| Loot tables | loot-tables/ (or inline in mobs) |
Drop tables with damager attribution |
| Spawning | spawners/, natural-spawning/ |
Admin spawners and natural-spawn rules |
Addons¶
Each addon is its own jar. Toggle them by adding or removing jars from the plugins/ folder. All hard-depend on rpg-core; see Installation for soft dependencies.
Skill addons¶
| Module | Skill | Page |
|---|---|---|
rpg-combat |
Combat | Skills |
rpg-mining |
Mining | Mining |
rpg-foraging |
Foraging | Skills |
rpg-farming |
Farming | Farming |
rpg-fishing |
Fishing | Fishing |
rpg-cooking |
Cooking | Cooking |
rpg-alchemy |
Alchemy | Alchemy |
rpg-enchanting |
Enchanting (+ reforge + upgrades) | Enchanting |
Feature addons¶
| Module | What it does | Page |
|---|---|---|
rpg-economy |
Currency, balances, shop integration | Economy |
rpg-chat |
Chat format, channels, /msg, moderation |
Chat |
rpg-hud |
Scoreboard, action bar, tablist | HUD |
rpg-parties |
Session-only player groups, XP sharing | Parties |
rpg-guilds |
Persistent communities, bank, ranks, perks | Guilds |
rpg-regions |
Named world regions with flags | Regions |
rpg-dungeons |
Instanced dungeon templates | Dungeons |
rpg-accessories |
Accessory bag, ACCESSORY item type, stat aggregation |
Accessories |
rpg-npcs |
Persistent NPCs with shop/dialogue/quest handoff | NPCs |
rpg-holograms |
Static holograms + damage indicators | Holograms |
rpg-quests |
Kill/mine/collect/talk objectives, rewards | Quests |
rpg-trade |
Player-to-player item trade GUI | Trade |
rpg-admin |
Admin utility commands (fly, god, heal, speed, etc.) | Admin Utilities |
rpg-bossbar |
Custom boss bar display for entities and events | — |
Planned (not yet scaffolded)¶
- rpg-pets — companions / mounts
- rpg-auction-house — see design spec
- rpg-bazaar — see design spec
Conventions used in these docs¶
Status header at the top of every page:
| Label | Meaning |
|---|---|
Working |
Fully implemented and stable |
In Progress |
Partially implemented — some things work, others are deferred |
Planned |
Not started — documented for design reference only |
Deprecated |
Removed or replaced; page kept for historical reference |
YAML examples are the canonical schema. If a feature is Planned, the YAML reflects the target schema as designed.
Permissions follow rpg.<module>.<verb>[.<qualifier>]. Player commands default to true; admin/op commands default to op.