强曰为道
与天地相似,故不违。知周乎万物,而道济天下,故不过。旁行而不流,乐天知命,故不忧.
文档目录

PaperMC 插件开发完全指南

PaperMC 插件开发完全指南

从零开始,系统学习 Minecraft 服务端插件开发的方方面面。

适用读者

  • 对 Minecraft 游戏有一定了解,想自己写插件的玩家/服主
  • 有 Java 基础(或 Kotlin),希望进入 Minecraft 插件开发领域
  • 已经在用 Spigot/Paper,想深入了解 API 和最佳实践

前置要求

项目要求
JavaJDK 17+(Paper 1.20.5+ 强制要求)
IDEIntelliJ IDEA(推荐)或 Eclipse
构建工具Maven 3.8+ 或 Gradle 8+
Minecraft了解基本游戏机制
编程语言Java 基础(面向对象、泛型、Lambda)

章节目录

章节标题简介
第 1 章插件开发概述Bukkit API / Paper API / Spigot 关系与选型
第 2 章开发环境搭建Maven / Gradle 项目结构与初始化
第 3 章插件描述文件plugin.yml / bungee.yml / 权限与命令声明
第 4 章命令处理命令注册 / Tab 补全 / 参数解析 / 权限检查
第 5 章事件系统事件监听 / 优先级 / 自定义事件
第 6 章物品 API物品创建 / 自定义物品 / NBT / 模型数据
第 7 章背包与 GUI菜单系统 / 交互处理 / 序列化
第 8 章世界操作世界管理 / 区块加载 / 实体与结构生成
第 9 章实体 API实体操作 / 自定义生物 AI / 装备
第 10 章计分板侧边栏 / 标签 / Teams
第 11 章数据包ProtocolLib / 包监听与注入
第 12 章数据库集成SQLite / MySQL / Redis
第 13 章任务调度同步 / 异步 / 定时器 / 延迟任务
第 14 章占位符扩展PlaceholderAPI / 自定义占位符
第 15 章Docker 环境开发服务器 / 测试环境 / CI 构建
第 16 章测试单元测试 / MockBukkit / 集成测试
第 17 章发布与分发SpigotMC / Hangar / 版本管理
第 18 章最佳实践代码规范 / 性能优化 / 安全 / 兼容性

学习路线建议

入门 → 第 1-5 章(环境搭建 + 基础 API)
进阶 → 第 6-10 章(物品 / GUI / 世界 / 实体 / 计分板)
深入 → 第 11-14 章(数据包 / 数据库 / 调度 / 占位符)
工程 → 第 15-18 章(Docker / 测试 / 发布 / 最佳实践)

约定说明

  • 本文代码示例基于 Paper 1.21+Java 17
  • 代码以 Java 为主,关键处附 Kotlin 写法
  • 所有示例均可直接编译运行
  • 术语采用"中文(English)“格式,如"事件监听器(Event Listener)”

提示: PaperMC 是 Spigot 的下游分支,完全兼容 Bukkit API,同时提供更多现代 API(如 Adventure、原生异步事件等)。本文以 Paper 为主要平台,涉及兼容性差异时会特别说明。