Torch模组简单介绍#

Torch 通过Token上的HUD控件可以快速赋予Token的光照效果，前提是你的角色物品需要有可以提供光源的物品。

Torch通过自带的一套识别系统，可以快速识别包内的以下物品并快速提供光源匹配：

显然他们都是英文，但是不重要，作者提供了多语言解决方案，我们先来看如何使用。

如何使用？#

当你安装并启用模组后，你的Token指示物控件会增加一个控件：

此时若我们直接点击左上角的问号，会弹出如下界面：

让我们先在角色包里创建一个名为Torch的物品。

TIP

由于Torch模组采用的是名称匹配，所以包内只需要有对应名称的物品即可。

在创建好后，指示物控件会更新：

此时点击左上角控件即可。

此时查看Token的光亮属性，会发现Torch按照预设已经应用了对应的光源：

创建自己的光照预设#

在README中，作者简单介绍了一下如何创建预设。在模组中，预设可以通过json文件或YAML文件建立，当然笔者推荐后者（真的有人能忍受json那烂语法吗）。

一个典型的json预设是这样的：

1
{
2
  "dnd5e": {
3
    "system": "dnd5e", // Optional but, if supplied, must match the key above
4
    "topology": "standard", // Optional - nearly all systems use standard topology
5
    "quantity" : "quantity", // Optional - "quantity" is the default - see notes below
6
    "aliases": {
7
      "Lantern (Bullseye)": "Bullseye Lantern",
8
      "Lantern (Hooded)": "Hooded Lantern"
9
    },
10
    "sources": {
11
      "Candle": {
12
        "name": "Candle",
13
        "type": "equipment",
14
        "consumable": true,
15
        "states": 2,
16
        "light": [ // If you have only 2 states, you can supply a single set of light stats rather than an array
17
          {
18
            "bright": 10, "dim": 15, "angle": 360, "color": "#ff9329", "alpha": 0.5,
19
            "animation": { "type": "torch", "speed": 5, "intensity": 5, "reverse": false }
20
          }
21
        ]
22
      },
23
      // Add additional sources for your system here
24
    }
25
  },
26
  // Add additional systems here
27
}

笔者简单介绍一下预设如何书写：

JSON 文件中每个系统对应一个顶级属性，该属性的键为系统的ID。对于每个系统：

• 如果指定了 system 值，它应始终与键完全一致。该值可以（且通常应）省略。

• topology 值有两个可能的取值，如果省略则默认为 standard。

  • standard 拓扑：设备为 Item 对象。几乎所有系统均为 standard。
  • gurps 拓扑：光源被收集在角色属性下，并需要使用 GURPS 特定函数来查找、操作其数量等。
  • 若将物品拖动到角色上以“装备”，则系统几乎肯定是 standard，因此可省略该设置。

  TIP

  以上可无视，按照标准写法即可

• quantity值用于告知拓扑结构哪个属性决定拥有数量。它是光源对象“系统”子树中数量属性的路径。默认值为quantity。

  • 对于standard，它是item.system下包含数量的字段路径。对于几乎所有系统，此值为quantity。（但Earthdawn系统为amount。）
  • 对于 gurps，它是位于角色（actor）下嵌套结构中的字段路径。应设置为 amount。
  • 部分系统可能不统计库存。对于此类系统，可省略该字段并使用默认值。

  TIP

  dnd5e里面保存默认即可

• sources 属性为每个创建或替换的光源包含一个子属性。对于每个光源：

  • 键值为光源的名称。
  • 如果指定了 name 值，它应始终与键相同。它可以（而且可能应该）省略。
  • type 值可以是 equipment 或 spell。如果省略，默认为 equipment。
  • consumable 值应为 true 或 false。
    • 若为 true，使用光源时库存数量会减少。当数量降至零时，光源将不可用。

• 若为 false，库存数量将被忽略，但使用光源时仍需将其保存在库存中。

• 若未指定，默认为 false。

  • 如果你的系统不计数库存，请确保所有光源要么不指定此字段，要么将其设置为 false。

• 如果觉得“计数蜡烛”会严重影响游戏体验，你可以通过“GM 消耗物品”和“玩家消耗物品”设置关闭此功能。

• states 指定光源切换的状态数量。这允许像带帽灯笼这样的光源在需要时切换“高 - 低 - 关”状态。该字段可省略，此时状态数量将比 light 数组中提供的对象数量多 1。

• light 值是一个对象数组，用于指定每个“开”状态的光源属性。该字段无默认值。

  • “off”状态的值来自角色默认token的设置。

• 如果提供单个对象而非对象数组，模块将将其视为包含一个项的数组（即具有单个“开”状态的光源，这是最常见的情况），此时 states 将默认设置为 2。

  • 在 animation 中，type 字段目前可取以下值。除前两个外，其余与 GUI 中的列表对应关系较为明显。

• flame（用于 Torch 动画）

• torch（用于 Flickering Light 动画）

  • revolving、siren、pulse、chroma、wave、fog、sunburst、dome、emanation、hexa、ghost、energy

• roiling、hole、vortex、witchwave、rainbowswirl、radialrainbow、fairy、grid、starlight、smokepatch

• aliases属性允许您为现有光源指定替代名称。每个条目包含一个键和值：

  • 键是光源的新名称。
  • 值是现有光源的名称（作为字符串）。
  • 您使用新名称复制的光源可以是预定义的光源之一，也可以是同一用户设置中的光源之一。

例如让我们来修改一下样例，使得可以匹配提灯

1
{
2
  "dnd5e": {
3
    "system": "dnd5e",
4
    "topology": "standard",
5
    "quantity" : "quantity",
6
    "aliases": {
7
      "提灯": "提灯"
8
    },
9
    "sources": {
10
      "提灯": {
11
        "name": "提灯",
12
        "type": "equipment",
13
        "consumable": true,
14
        "states": 2,
15
        "light": [
16
          {
17
            "bright": 30, "dim": 15, "angle": 360, "color": "#ff9329", "alpha": 0.5,
18
            "animation": { "type": "torch", "speed": 5, "intensity": 5, "reverse": false }
19
          }
20
        ]
21
      }
22
    }
23
  }
24
}

将文件上传后在Torch的配置界面进行设置：

符合预期。

当然你也可以写YAML语法：

1
---
2
dnd5e:
3
  system: dnd5e
4
  topology: standard
5
  quantity: quantity
6
  aliases:
7
    Lantern (Bullseye): Bullseye Lantern
8
    Lantern (Hooded): Hooded Lantern
9
  sources:
10
    Candle:
11
      name: Candle
12
      type: equipment
13
      consumable: true
14
      states: 2
15
      light:
16
      - bright: 10
17
        dim: 15
18
        angle: 360
19
        color: "#ff9329"
20
        alpha: 0.5
21
        animation:
22
          type: torch
23
          speed: 5
24
          intensity: 5
25
          reverse: false

预设文件分享#

笔者是懒狗，如果你有写好的预设文件，欢迎在评论区留言，或发送邮件至LtimeOfficial@outlook.com，笔者会很快更新在这里的！