id

abstract val id: String

插件 ID. 用于指令权限等一些内部处理

  • 仅允许英文字母, '-', '_', '.'. 在内部操作处理时不区分大小写.

  • 类似于 Java 包名, 插件 ID 需要 '域名.名称' 格式, 如 net.mamoe.mirai.example-plugin

  • 域名和名称都是必须的

  • 数字和符号都不允许位于首位

  • '-' 和 '' 仅允许存在于两个英文字母之间. 不推荐使用 ''. 请参照 org.example.mirai.plugin.my-example-plugin 格式.

可使用 ID_REGEX 检验格式合法性.

ID 在插件发布后就应该保持不变, 以便其他插件添加依赖.

插件 ID 的域名和名称都不能完全是以下其中一个 (FORBIDDEN_ID_NAMES).

  • "console"

  • "main"

  • "plugin"

  • "config"

  • "data"

示例

  • 合法 net.mamoe.mirai.example-plugin

  • 非法 .example-plugin

See also