MCTOOLBOX
MC ToolboxMC TOOLBOX

服务器与文件

plugin.yml 生成器

根据官方字段集构建 Spigot / Paper / Bukkit plugin.yml:必需的 name、main、version,以及 commands、permissions、depend 等。下载到你的插件 resources 文件夹。

必填项(Spigot)

可选元数据

指令

Permissions

生成的 plugin.yml

name: MyPlugin
main: com.example.myplugin.MyPlugin
version: 1.0.0
description: 'A cool new plugin.'
api-version: 26.2
author: Player

如何使用:适用于 Spigot 和 Paper 的 plugin.yml 生成器

plugin.yml 是一个小的 YAML 文件,它告诉 Spigot、Paper 和 Purpur 如何加载你的插件:名称、主类、版本、API 目标、命令和权限。这个生成器会填充这些常见字段,这样你就不必在每次项目重命名后手动输入易碎的 YAML。它不会编写 Java、编译 jar 或修复损坏的主类路径。

你输入插件名称、主类、版本、可选的作者、描述、网站、api-version、depend/softdepend 列表,然后如果需要的话,输入命令和权限。页面会构建一个 plugin.yml,你可以下载或粘贴到 src/main/resources 中。这样可以缩短首次搭建脚手架和“我只需要在 /help 中再加一个命令”的修复时间。

它不会编写你的插件代码。如果这里列出的命令从未在 Java 中注册,玩家将看到损坏的条目。如果主类与你编译的包不匹配,服务器将拒绝启用插件。请将该文件视为元数据,而不是神奇的安装程序。

api-version 应接近你编译所针对的 Minecraft 版本,以便 Paper 在不兼容的 API 上发出警告。depend 和 softdepend 仅当这些插件实际存在于目标服务器上时才有帮助。这里的错误名称不会下载任何东西;它们只会改变加载顺序和启用行为。

每个命令可以携带描述、用法行和权限节点。每个权限可以设置默认值(op、true、false、not op)。一旦玩家和 LuckPerms 组开始使用这些名称,请保持名称稳定;以后重命名节点意味着在实时服务器上迁移配置。

在普通的 Maven 或 Gradle 项目中,该文件位于 resources 下,因此它最终会作为 plugin.yml 出现在 jar 的根目录中。重新构建后,在责怪生成器之前,请确认 jar 中仍然包含该文件。托管面板上传“插件文件夹”仍然需要正确的 jar 才能用于 Spigot 风格的插件。

Plugin Yml 常见问题

这会为我编写 Java 吗?

不会。只生成 plugin.yml。你仍然需要自己编写代码、编译和部署 jar。

Paper 还是 Spigot?

基本字段是同一系列的。将 api-version 设置为你支持的版本,并在你的真实 jar 上进行测试。

我应该把文件放在哪里?

通常放在 src/main/resources/plugin.yml,这样它会随 jar 的根目录一起发布。

为什么插件无法启用?

主类错误、缺少依赖或 onEnable 中的加载错误。在文件看起来正确后,检查服务器日志。

下载后我可以编辑 YAML 吗?

可以。生成器只是一个起点。请与项目的其余部分一起在 git 中保留一份副本。