settings.yml

该配置通过配置匹配器来为某一类物品应用不同的物品设置，可以绑定特定物品

注意

匹配器将按配置顺序逐一检测匹配，过多的匹配器会影响性能，复杂的匹配器应放在最后

配置匹配器的结构如下：

matchers:
  匹配器ID: # 不可重复，除了 global-setting 之外的任何名字
    match: # 匹配节点
      匹配项1: ……
      匹配项2: ……
    settings: # 配置节点 global-setting.yml中的配置项
       ……
    

每个匹配器分为 匹配器ID、匹配节点、配置节点 三部分，缺一不可

匹配器ID

匹配器ID不能重复，global-setting 是 global-setting.yml的匹配器名称(匹配所有物品)，所以你自定义的匹配器不能为这个名字

---

匹配节点

注

多个节点之间是 and(与) 的关系，所有键都匹配时这个匹配器才算匹配到物品

你可以在这个网站测试正则表达式: https://www.bejson.com/othertools/regex/

匹配器节点有以下类型

键名	数据类型	说明
name	String	匹配自定义物品名，原版翻译名无法匹配，正则表达式，颜色符号为§
name-without-color	String	匹配去除颜色代码之后的自定义物品名，原版翻译名无法匹配，正则表达式
material	String	匹配物品材质，正则表达式
materials	StringList	匹配多个物品材质
ids	StringList	匹配多个物品，格式为 物品数字ID:子ID
materialIds	StringList	匹配多个物品，格式为 物品ID:子ID 或者 物品ID
lore	StringList	匹配一行或连续的多行lore，正则表达式，颜色符号为§
lore!	StringList	同lore，会在绑定时删除匹配的lore
lore-without-color	StringList	匹配一行或连续的多行lore(去除颜色代码)，正则表达式
lore-without-color!	StringList	同lore-without-color，会在绑定时删除匹配的lore
nbt	yaml键值对,值为String	匹配特定NBT, 值为正则表达式
mmoitems	String 或 StringList	匹配MMOItems物品 格式为 Type:ID 特殊，填all匹配所有物品
mmoitems-type	String 或 StringList	匹配MMOItems物品Type 格式为 Type 特殊，填all匹配所有物品
itemsadder	String 或 StringList	匹配ItemsAdder物品，格式为 namespace:id 特殊，填all匹配所有物品
itemsadder-namespace	String 或 StringList	匹配ItemsAdder命名空间，格式为 namespace 特殊，填all匹配所有物品
oraxen	String 或 StringList	匹配oraxen物品，格式为 物品ID 。特殊，填all匹配所有物品

以下匹配器键互斥，不能同时生效

• name、name-without-color
• material、materials、ids、materialIds
• lore、lore-without-color、lore!、lore-without-color!
• mmoitems、mmoitems-type
• itemsadder、itemsadder-namespace

---

配置节点

配置节点可以覆盖 global-setting,yml 中的同名配置，为该匹配器配置特殊的配置，比如自动绑定。

同 global-settting.yml 以 @ 结尾的布尔类型的项，其物主将使用与他人相反的设置

示例

示例一、

匹配lore中含有 灵魂绑定的物品，自动在点击物品时、扫描器扫描时绑定物品，并在绑定时删除这个lore，指定绑定lore为&a灵魂绑定2: &6玩家名。

matchers:
  示例一:
    match:
      lore!:
        - '灵魂绑定'
    settings:
      item:
        lore: # 支持 placeholder
        - '&a灵魂绑定2: &6%player%' # %player% 会替换为物主的名字，不是placeholder
      auto-bind:
        enable: true
        onClick: true
        onScanner: true
      

示例二、

匹配名为大宝剑的所有 剑 ，自动在点击物品时、扫描器扫描时绑定物品。

matchers:
  示例二:
    match:
      name: '大宝剑'
      materials: 
        - 'NETHERITE_SWORD'
        - 'DIAMOND_SWORD'
        - 'GOLDEN_SWORD'
        - 'IRON_SWORD'
    settings:
      auto-bind:
        enable: true
        onClick: true
        onScanner: true
        
  示例二另一个方式:
    match:
      name: '大宝剑'
      material: '_SWORD' # material是正则表达式，但是性能没有 materials 的高
    settings:
      auto-bind:
        enable: true
        onClick: true
        onScanner: true
      

示例三、

匹配 NBTtag下custom1下 csutom2值为 1 的 钻石剑 。

注：查看nbt结构可以用命令 /sakurabind nbt 输出手上物品的NBT到控制台

matchers:
  示例三:
    match:
      materials: 
        - 'DIAMOND_SWORD'
      nbt:
        tag:
          custom1: 
            custom2: '1'
    settings:
      auto-bind:
        enable: true
        onClick: true
        onScanner: true
      

settings.yml

# <--------------------matcher教程-------------------->
# matcher可以匹配某类特殊的物品以应用不同的设置
# 请勿声明名为 'global-setting '的matcher,否则会与公共设置冲突
# match 项为需要匹配的物品特征，采用正则表达式 https://www.bejson.com/othertools/regex/
# 所有 match 项都不是必须的，你可以自由组合, 但至少需要有一个子项, 只有匹配所有子项才算最终匹配到
# name 为 物品名字, 必须为非原版翻译名(也就是从创造物品栏拿出来的'圆石'的name为空)
# name-without-color 为 除去颜色代码的物品名字, 必须为非原版翻译名(也就是从创造物品栏拿出来的'圆石'的name为空)
# material 为 物品材质,使用正则匹配
# materials 为 物品材质,使用全名匹配 https://bukkit.windit.net/javadoc/org/bukkit/Material.html
# ids 为 物品id:子id 匹配方式 如 6578 或 6578:2
# materialIds 为 物品材质:子ID 匹配方式 如 STONE 或 STONE:2 ; 如果只需要匹配材质请使用效率更高的 materials 方式
# lore 为 物品lore正则匹配 如有多行则需全匹配, lore! 表示删除匹配到的lore
# lore-without-color 为 物品lore除去颜色代码正则匹配 如有多行则需全匹配 与 lore 互斥, lore-without-color! 表示删除匹配到的lore
# nbt 为 物品NBT，注意：常规的nbt储存在tag下
# 注：以上的 name 和 name-without-color 互斥，material、materials、ids、materialIds 互斥，
# 注：lore、lore-without-color 及其!后缀互斥。 互斥就是只能同时存在其中一个

# <<--------------------matcher插件兼容-------------------->>
# 以下的项只有在插件存在时有效
# MMOItems 有2个项：mmoitems 和 mmoitems-type, 前者匹配 type:id 的物品id，后者只匹配 type , 请使用 List类型
# MMOItems 有2个特殊的值 mmoitems: all 或 mmoitems-type: all 表示匹配所有MMOItems物品
# ItemsAdder 有2个项：itemsadder 和 itemsadder-namespace, 前者匹配 namespace:id 的物品id，后者只匹配 namespace , 请使用 List类型
# ItemsAdder 有2个特殊的值 itemsadder: all 或 itemsadder-namespace: all 表示匹配所有ItemsAdder物品
# Oraxen 有1个项：oraxen, 匹配 Oraxen 物品ID, 请使用 List类型
# Oraxen 有1个特殊的值 oraxen: all 表示匹配所有 Oraxen 物品
# 注：以上的 mmoitems 和 mmoitems-type 互斥，itemsadder 和 itemsadder-namespace 互斥。互斥就是只能同时存在其中一个

# <--------------------settings教程-------------------->
# settings 项为此matcher独立的设置，完全兼容global-setting中的选项
# settings 项中以 '@' 结尾的布尔类型的项，其物主将使用与他人相反的设置
#          如 block-deny 下的 break: true 表示所有人都不能破坏此方块物品
#          但如果是 break@: true 表示所有人都不能破坏,但物主可以破坏此方块物品
# settings 中不存在的项将继承 global-setting.yml 中的同名项
readme: ''

# 为提高性能，匹配过一次的物品在绑定之后将会把匹配到的设置键存入物品NBT，此为NBT的路径
# 注意，缓存会导致不同配置的nbt不一致，以至于不同配置的相同物品无法堆叠
# 留空会使用默认的缓存键
nbt-cache-path: sakura_bind_setting_cache

# 在此配置匹配器，example 是一个默认的演示匹配器，不需要请删除
matchers:
  example:
    match:
      name: ^这是.*的物品$
      material: BOW|BOOKSHELF
      materials:
      - DIAMOND_SWORD
      materialId:
      - SPECIAL:2
      ids:
      - '6578'
      - '2233:2'
      lore:
      - 绑定物品
      - 属于
      mmoitems:
      - LONG_SWORD:KNIFE
      - LONG_SWORD:SHARP_SWORD
      nbt:
        tag:
          testnbt: .*
    settings:
      item:
        lore:
        - '&a灵魂绑定2: &6%player%'
      item-deny:
        interact: false
      block-deny:
        interact@: false