NitWikit/docs-java/advance/MiniMessage.md
SB-Reborn 9b3c93adb2
回退了那些破坏ci的更改并重新配置markdownlint (#286)
* markdownlint

* try to format docs

* 修复了format脚本并添加了markdownlint配置文件

* 重新自动格式化

* revert了自动格式化的部分因为它们貌似破坏了ci

This reverts commit 874a7ec3c8.

Revert "try to format docs"

This reverts commit 003da71931.

* Revert "try to format docs"

This reverts commit 003da71931.

* 尝试修复

* 重新格式化

* changed markdownlint config

* 手动对文档进行了格式化

* fixed markdownlint script

* fixed link

* 尝试格式化
2024-10-01 05:16:42 +08:00

3.2 KiB
Raw Blame History

sidebar_position
9

MiniMessage

MiniMessage 旨在用简单字符串表示聊天组件,便于用户学习和开发人员扩展。

MiniMessage 的实质是一个叫 Adventure 的库,这是它的 文档

支持列表

目前,一些平台已经支持原生使用 Adventure 来扩展字符串,以下是内置此库的列表:

支持平台 支持版本 备注
Sponge Sponge 8 (1.16.5) /
Velocity 1.1.0 build 158 仅支持消息、操作栏标题、boss栏和标题
Paper 1.16.5 build 473 /
Minestom Build 7494725 内容有点杂,详见minestom wiki
Fabric adventure-platform-fabric 5.3.0* 虽然不是一个东西(?),但是体验是一样的

详情可以参阅 Adventure 本机支持

:::note

平台原生支持 ≠ 使用此平台开发的模组/插件支持!!!

举个例子仔细观察上述列表你会发现bukkit并没有支持 MiniMessage ,所以你会发现大部分基于 Bukkit 开发的插件没有 MiniMessage 这一功能(如 EssentialsX) 除非他们自身引入了 Adventure 库(如PlaceholderAPI)。

而基于 Paper 开发的大部分插件都引入了这一功能,所以不要发现一个新奇玩意就到处瞎套。

:::

如何使用

:::warning

本篇不讲述诸如 TAB 等插件或模组自行实现的类似 MiniMessage 效果的使用。

:::

在线编辑

格式化代码 篇一样,用一个 TrMenu 菜单配置展示下:

Icons:
  test:
    display:
      material: stone
      lore:
        - '<rainbow>Hello world'

记住 MiniMessage 语言使用标签,也就是说你所做的一切都将使用标签进行定义。

对于 MiniMessage ,你必须要有一个开始标签 <yellow>,在非严格模式下,你可以省略结束标签 </yellow> ,如下:

<yellow>Hello <blue>World</blue>!

在非严格模式下,所有标记名称都不区分大小写,以减少冲突的可能性(懒癌晚期患者狂喜),但美观和符合规定起见,请使用小写字母编写以便减少被他人嘲讽的几率:

<YelLOw>Hello World!

此外,这里有一个测试网站,他可以使得你无需启动 Minecraft 便可以预览实际效果。

关于实际使用格式详见 标准标签

参考