Paper & the server platform
PaperMC is the server software most Minecraft servers actually run. This is a navigable index of its 197 documentation pages, plus how Paper relates to Spigot, Bukkit and the vanilla server.
On this page
Overview
📌 Note
This is an index into PaperMC’s own documentation, not a copy of it. Paper’s docs are maintained by the PaperMC team and stay under their licence; every row links to the canonical page. Generated by tools/platform_pages.py from the published sitemap.
Paper, Spigot and vanilla
The server stack is a chain of forks, each keeping the layer below it working:
| Layer | What it adds | Runs data packs? |
|---|---|---|
| Vanilla server | Mojang’s own server. The reference implementation. | Yes |
| Bukkit / Spigot | A plugin API, and performance and configuration options vanilla does not expose. | Yes |
| Paper | A Spigot fork: substantially more performance work, a much larger API surface, and extensive per-world configuration. | Yes |
| Folia | A Paper fork that threads independent regions of the world separately, for very high player counts. | Yes, with caveats |
| Velocity | A proxy that sits in front of several backend servers; it does not run world logic itself. | N/A |
⚠ Version differences
- Data packs behave the same on Paper as on vanilla — Paper does not change the data-pack format. What it does change is timing and limits, which is why the performance guidance matters more on a busy Paper server.
- Paper’s configuration moved to
paper-global.ymlandpaper-world-defaults.yml; older guides referencing a singlepaper.ymlpredate that split.
Adventure (text & UI library)
The text-component, MiniMessage, bossbar and book library Paper ships with.
42 pages.
| Page | Path |
|---|---|
| Adventure | /adventure |
| Audiences | /adventure/audiences |
| Book | /adventure/book |
| Bossbar | /adventure/bossbar |
| Community libraries | /adventure/community-libraries |
| Faq | /adventure/faq |
| Getting started | /adventure/getting-started |
| Localization | /adventure/localization |
| Migration | /adventure/migration |
| Adventure 4.x | /adventure/migration/adventure-4.x |
| Bungeecord chat api | /adventure/migration/bungeecord-chat-api |
| Text 3.x | /adventure/migration/text-3.x |
| Minimessage | /adventure/minimessage |
| Api | /adventure/minimessage/api |
| Dynamic replacements | /adventure/minimessage/dynamic-replacements |
| Format | /adventure/minimessage/format |
| Translator | /adventure/minimessage/translator |
| Platform | /adventure/platform |
| Bukkit | /adventure/platform/bukkit |
| Bungeecord | /adventure/platform/bungeecord |
| Fabric | /adventure/platform/fabric |
| Implementing | /adventure/platform/implementing |
| Modded | /adventure/platform/modded |
| Native | /adventure/platform/native |
| Neoforge | /adventure/platform/neoforge |
| Spongeapi | /adventure/platform/spongeapi |
| Viaversion | /adventure/platform/viaversion |
| Resource pack | /adventure/resource-pack |
| Serializer | /adventure/serializer |
| Ansi | /adventure/serializer/ansi |
| Gson | /adventure/serializer/gson |
| Json | /adventure/serializer/json |
| Legacy | /adventure/serializer/legacy |
| Plain | /adventure/serializer/plain |
| Sound | /adventure/sound |
| Tablist | /adventure/tablist |
| Text | /adventure/text |
| Titles | /adventure/titles |
| Version history | /adventure/version-history |
| Adventure platform mod | /adventure/version-history/adventure-platform-mod |
| Adventure platform | /adventure/version-history/adventure-platform |
| Adventure | /adventure/version-history/adventure |
Folia
The regionised-threading server fork.
6 pages.
| Page | Path |
|---|---|
| Folia | /folia |
| Admin | /folia/admin |
| Reference | /folia/admin/reference |
| Faq | /folia/faq |
| Overview | /folia/reference/overview |
| Region logic | /folia/reference/region-logic |
Tooling & misc
Related tools and utilities.
11 pages.
| Page | Path |
|---|---|
| Misc | /misc |
| Assets | /misc/assets |
| Contact | /misc/contact |
| Downloads service | /misc/downloads-service |
| Hangar publishing | /misc/hangar-publishing |
| Java install | /misc/java-install |
| Tools | /misc/tools |
| Diff viewer | /misc/tools/diff-viewer |
| Item command converter | /misc/tools/item-command-converter |
| Minimessage web editor | /misc/tools/minimessage-web-editor |
| Start script gen | /misc/tools/start-script-gen |
Running a Paper server
Installation, configuration files, updating, and the day-to-day operation of a server.
5 pages.
| Page | Path |
|---|---|
| Admin | /paper/admin |
| Getting started | /paper/admin/getting-started |
| How to | /paper/admin/how-to |
| Misc | /paper/admin/misc |
| Reference | /paper/admin/reference |
Plugin development
The Paper API: events, scheduling, component APIs, and the differences from Spigot/Bukkit.
67 pages.
| Page | Path |
|---|---|
| Dev | /paper/dev |
| Api | /paper/dev/api |
| Command api | /paper/dev/api/command-api |
| Arguments | /paper/dev/api/command-api/arguments |
| Basics | /paper/dev/api/command-api/basics |
| Misc | /paper/dev/api/command-api/misc |
| Component api | /paper/dev/api/component-api |
| Entity api | /paper/dev/api/entity-api |
| Event api | /paper/dev/api/event-api |
| Inventories | /paper/dev/api/inventories |
| Lifecycle | /paper/dev/api/lifecycle |
| Chat events | /paper/dev/chat-events |
| Adventure | /paper/dev/command-api/arguments/adventure |
| Entity player | /paper/dev/command-api/arguments/entity-player |
| Enums | /paper/dev/command-api/arguments/enums |
| Location | /paper/dev/command-api/arguments/location |
| Minecraft | /paper/dev/command-api/arguments/minecraft |
| Paper | /paper/dev/command-api/arguments/paper |
| Predicate | /paper/dev/command-api/arguments/predicate |
| Registry | /paper/dev/command-api/arguments/registry |
| Argument suggestions | /paper/dev/command-api/basics/argument-suggestions |
| Arguments and literals | /paper/dev/command-api/basics/arguments-and-literals |
| Command tree | /paper/dev/command-api/basics/command-tree |
| Custom arguments | /paper/dev/command-api/basics/custom-arguments |
| Executors | /paper/dev/command-api/basics/executors |
| Introduction | /paper/dev/command-api/basics/introduction |
| Registration | /paper/dev/command-api/basics/registration |
| Requirements | /paper/dev/command-api/basics/requirements |
| Basic command | /paper/dev/command-api/misc/basic-command |
| Comparison bukkit brigadier | /paper/dev/command-api/misc/comparison-bukkit-brigadier |
| Audiences | /paper/dev/component-api/audiences |
| I18n | /paper/dev/component-api/i18n |
| Introduction | /paper/dev/component-api/introduction |
| Signed messages | /paper/dev/component-api/signed-messages |
| Custom events | /paper/dev/custom-events |
| Custom inventory holder | /paper/dev/custom-inventory-holder |
| Data component api | /paper/dev/data-component-api |
| Debugging | /paper/dev/debugging |
| Dialogs | /paper/dev/dialogs |
| Display entities | /paper/dev/display-entities |
| Entity pathfinder | /paper/dev/entity-pathfinder |
| Entity teleport | /paper/dev/entity-teleport |
| Event listeners | /paper/dev/event-listeners |
| Folia support | /paper/dev/folia-support |
| Getting started | /paper/dev/getting-started |
| Paper plugins | /paper/dev/getting-started/paper-plugins |
| Handler lists | /paper/dev/handler-lists |
| How do plugins work | /paper/dev/how-do-plugins-work |
| Internals | /paper/dev/internals |
| Lifecycle | /paper/dev/lifecycle |
| Datapacks | /paper/dev/lifecycle/datapacks |
| Menu type api | /paper/dev/menu-type-api |
| Misc | /paper/dev/misc |
| Mob goals | /paper/dev/mob-goals |
| Particles | /paper/dev/particles |
| Pdc | /paper/dev/pdc |
| Plugin configurations | /paper/dev/plugin-configurations |
| Plugin messaging | /paper/dev/plugin-messaging |
| Plugin yml | /paper/dev/plugin-yml |
| Project setup | /paper/dev/project-setup |
| Reading stacktraces | /paper/dev/reading-stacktraces |
| Recipes | /paper/dev/recipes |
| Registries | /paper/dev/registries |
| Roadmap | /paper/dev/roadmap |
| Scheduler | /paper/dev/scheduler |
| Userdev | /paper/dev/userdev |
| Using databases | /paper/dev/using-databases |
Getting started
First steps with Paper.
1 page.
| Page | Path |
|---|---|
| Getting started | /paper/getting-started |
Configuration reference
Every option in paper-global.yml, paper-world-defaults.yml, server.properties and the rest.
15 pages.
| Page | Path |
|---|---|
| Bukkit commands configuration | /paper/reference/bukkit-commands-configuration |
| Bukkit configuration | /paper/reference/bukkit-configuration |
| Bukkit help configuration | /paper/reference/bukkit-help-configuration |
| Bukkit permissions configuration | /paper/reference/bukkit-permissions-configuration |
| Cli arguments | /paper/reference/cli-arguments |
| Commands | /paper/reference/commands |
| Configuration | /paper/reference/configuration |
| Global configuration | /paper/reference/global-configuration |
| Paper plugins | /paper/reference/paper-plugins |
| Permissions | /paper/reference/permissions |
| Server properties | /paper/reference/server-properties |
| Spigot configuration | /paper/reference/spigot-configuration |
| System properties | /paper/reference/system-properties |
| Vanilla data files | /paper/reference/vanilla-data-files |
| World configuration | /paper/reference/world-configuration |
Velocity proxy — admin
Running the Velocity proxy in front of a network of servers.
4 pages.
| Page | Path |
|---|---|
| Admin | /velocity/admin |
| Getting started | /velocity/admin/getting-started |
| How to | /velocity/admin/how-to |
| Reference | /velocity/admin/reference |
Velocity proxy — development
Writing Velocity plugins.
13 pages.
| Page | Path |
|---|---|
| Dev | /velocity/dev |
| Api basics | /velocity/dev/api-basics |
| Api | /velocity/dev/api |
| Command api | /velocity/dev/command-api |
| Creating your first plugin | /velocity/dev/creating-your-first-plugin |
| Dependency management | /velocity/dev/dependency-management |
| Event api | /velocity/dev/event-api |
| Getting started | /velocity/dev/getting-started |
| How to | /velocity/dev/how-to |
| Pitfalls | /velocity/dev/pitfalls |
| Plugin messaging | /velocity/dev/plugin-messaging |
| Porting plugins from velocity 1 | /velocity/dev/porting-plugins-from-velocity-1 |
| Scheduler api | /velocity/dev/scheduler-api |
Other
Documentation in this section.
1 page.
| Page | Path |
|---|---|
| Index | / |
Paper
Documentation in this section.
15 pages.
| Page | Path |
|---|---|
| Paper | /paper |
| Adding plugins | /paper/adding-plugins |
| Aikars flags | /paper/aikars-flags |
| Anti xray | /paper/anti-xray |
| Basic troubleshooting | /paper/basic-troubleshooting |
| Contributing | /paper/contributing |
| Events | /paper/contributing/events |
| Faq | /paper/faq |
| Migration | /paper/migration |
| Paper bug fixes | /paper/misc/paper-bug-fixes |
| Update checker | /paper/misc/update-checker |
| Next steps | /paper/next-steps |
| Profiling | /paper/profiling |
| Updating | /paper/updating |
| Vanilla | /paper/vanilla |
Velocity
Documentation in this section.
14 pages.
| Page | Path |
|---|---|
| Velocity | /velocity |
| Built in commands | /velocity/built-in-commands |
| Comparisons to other proxies | /velocity/comparisons-to-other-proxies |
| Configuration | /velocity/configuration |
| Credits | /velocity/credits |
| Faq | /velocity/faq |
| Getting started | /velocity/getting-started |
| Migration | /velocity/migration |
| Player information forwarding | /velocity/player-information-forwarding |
| System properties | /velocity/reference/system-properties |
| Security | /velocity/security |
| Server compatibility | /velocity/server-compatibility |
| Tuning | /velocity/tuning |
| Why velocity | /velocity/why-velocity |
Waterfall
Documentation in this section.
3 pages.
| Page | Path |
|---|---|
| Waterfall | /waterfall |
| Configuration | /waterfall/configuration |
| Getting started | /waterfall/getting-started |