Skip to content

制作语言包 ​

语言包本质上是一个 YAML 格式配置文件。程序会在启动时加载语言包,并用对应语言包里的文本替换系统内置文本。

你只需要替换相应的文本即可:

语言包示例 ​

你可以前往 resources/localization/zh-CN.yml,在系统默认自带语言包的基础上进行修改。

注意

此默认语言包会经常更新。如果你发现以前制作的语言包无法正常显示,请检查默认语言包是否有更新。

颜色代码 ​

从 v2.1.0 起,语言包文本支持内嵌颜色代码,写法是用 {c:颜色} 包住一段文本,再用 {} 闭合:

yaml
b-add-conf: '{c:primary}➕新增配置{}'
b-cancel: '{c:danger}👋取消任务{}'

闭合的 {} 会结束最近一个尚未闭合的颜色段,因此也可以嵌套书写:

yaml
some-key: '{c:primary}前缀{c:danger}告警内容{}{}后缀'

语义色 ​

推荐优先使用语义色,这样在不同客户端主题下都能得到合适的观感:

颜色说明对应按钮样式
default默认,等同不额外着色默认
primary主要,用于常规按钮与强调文本主要
secondary次要,弱于 primary默认
info信息主要
success成功成功
warn警告主要
danger危险,一般用于取消、删除等破坏性操作危险

说明

Telegram 按钮样式只有默认、主要、成功、危险四种,因此语言包里可用的语义色比按钮样式更多。上表最后一列即二者之间的换算关系,超出按钮能力的语义色会归入最接近的一种。

十六进制色 ​

这个特性是为了未来作准备的,目前没有实际使用的的地方🤗 除语义色外,也可以直接写十六进制颜色值(可带或不带 #):

yaml
some-key: '{c:ff8800}自定义橙色{}'

说明

{c:...} 与 {color:...} 两种写法等价,颜色名大小写不敏感。

当文本被用作 Telegram 按钮文案时,其中的语义色会自动换算成按钮样式;十六进制色只影响文本着色,不会改变按钮样式。

占位符 ​

文本中的 %1、%2…… 会被依次替换为程序传入的参数,%% 表示一个字面量百分号:

yaml
current-lang: 当前语言:%1
command-disabled: '`%1` 指令已被禁用'

注意

请勿删除文本中的占位符,也尽量不要改变它们的编号顺序,否则可能会导致显示内容错位。

自定义 Emoji ​

若语言包文本中需要显示 Telegram 自定义 Emoji,可以用 {tg_e:表情ID} 包裹表情 ID:

yaml
some-key: '{tg_e:5368324170671202286}'

其中 {} 同样用于闭合,tg_e 与颜色代码可以叠加使用。

说明

  1. 自定义 Emoji 仅在支持该能力的客户端中正常显示;不支持的客户端会退化为空白,因此建议仍保留可读的文字说明。
  2. 实际上,这项功能也是为了未来作准备的,无实际作用。

文档内容同步自 koipy-public