Plugin.yml文件
plugin.yml 是一个包含你的插件信息的文件。没有这个文件,你的插件将无法工作。它由一组属性组成,每个属性都定义在一个新的行上,没有缩进。
所有的属性都是区分大小写的。
Plugin文件必要的三个属性
- main
- 这个属性指向你的插件的类,它扩展了 JavaPlugin。
- 这必须包含完整的命名空间,包括类文件本身。
main: love.iloveworld.Test
- name
- 这个属性是你的插件的名称。
- 必须由所有字母数字字符和下划线组成(a-z,A-Z,0-9,_)。
- 用于确定插件的数据文件夹的名称。
- 推荐的做法是将你的 jar 命名为与此相同(例如:MyPlugin.jar)。
name: MyPlugin
- version
- 你的插件的版本。
- 最常见的版本格式是语义版本,写成 MAJOR.MINOR.PATCH(例如:1.4.1或9.12.4)。
version: 1.0
可选的属性
- description
- 对你的插件所提供的功能进行人性化的描述。
- 该描述可以有多行。
description: This plugin does so much stuff it can't be contained!
- api-version
- 你想使用的 API 的版本。
- 1.13、1.14、1.15、1.16、1.17、1.18 和 1.19 是可用版本。
- 这将向服务器发出信号,表明你的插件在编码时已经考虑到了特定的服务器版本,它不应该应用任何形式的向后兼容措施。因此,你还需要确保你的代码编程时考虑到了对旧配置、数据等的读取。每个服务器版本可以决定如何实现兼容性,未知或未来的版本将阻止插件启用。从 1.14 版本开始,仍然允许使用 api-version 1.13 然而未来的版本可能会基于这个版本放弃向后支持。
api-version: 1.12
- load
- 你想使用的API的版本。明确说明插件应该在什么时候被加载。如果不提供将默认为 POSTWORLD。
- 有两个可能的值。STARTUP 和 POSTWORLD。
load: POSTWORLD
- author
- 唯一标识这个插件的开发者。
- 在一些服务器错误信息中使用,以提供有用的反馈信息,说明发生错误时应与谁联系。
- 建议使用 SpigotMC.org 论坛或电子邮件地址。
author: TobyCold
- authors
- 如果是一个合作项目,允许你列出多个作者。
- 必须是有效的 YAML 列表格式。
authors: [md_5, thinkofdeath]
- website
- 该插件的或作者的网站。
- 如果你没有专门的网站,建议链接到该插件所在的页面。
website: iloveworld.love