Work in progressPapyrus is under active development — expect breaking changes, incomplete features, and limited production support.
Skip to content

API Packages

Papyrus ships the Paper API from the papyrus-api module. The public surface matches Paper — browse the full reference on jd.papermc.io.

org.bukkit

Core Bukkit API inherited from Spigot/CraftBukkit.

AreaExamples
ServerBukkit.getServer(), Server
WorldsWorld, Chunk, Location
EntitiesEntity, Player, LivingEntity
BlocksBlock, BlockState, Material
EventsListener, Event, EventHandler
CommandsCommand, CommandExecutor, PluginCommand
InventoryInventory, ItemStack, ItemMeta

org.bukkit.plugin

Plugin lifecycle and registration.

  • JavaPlugin — base class for Bukkit plugins
  • PluginManager — load, enable, disable plugins
  • ServicesManager — service registration and lookup
  • PluginLoader — class loading

io.papermc.paper

Modern Paper API additions.

AreaPackage / types
Registryio.papermc.paper.registry.RegistryKey, generated *Keys classes
Data componentsio.papermc.paper.datacomponent
Dialogsio.papermc.paper.dialog
Configurationio.papermc.paper.configuration
Server build infoio.papermc.paper.ServerBuildInfo
Pluginsio.papermc.paper.plugin (Paper plugin bootstrap)
Eventsio.papermc.paper.event

com.destroystokyo.paper

Legacy Paper-specific extensions.

  • ParticleBuilder, Title, SkinParts
  • Entity AI: VanillaGoal
  • Block utilities: TargetBlockInfo, BlockSoundGroup
  • Brigadier: BukkitBrigadierCommand

co.aikar.timings

Timing and profiling (Timings v2).

  • Timings, TimingHandler, TimingsManager
  • Used internally; plugin authors rarely need direct access

Generated registry keys

The papyrus-api/src/generated/java/io/papermc/paper/registry/keys/ directory contains typed registry key constants (BlockTypeKeys, ItemTypeKeys, EnchantmentKeys, etc.) generated from Minecraft data.

Source layout

text
papyrus-api/
├── src/main/java/       Hand-written API
├── src/generated/java/  Generated registry keys and enums
└── build.gradle.kts     Published as paper-api

See Project Structure for the full repository layout.

GPL/MIT · Papyrus by SushiMC