# Echo-MoJi

**Repository Path**: noteplus/Echo-MoJi

## Basic Information

- **Project Name**: Echo-MoJi
- **Description**: 一款在直播间中显示随机跑马灯消息的 OBS 插件。
- **Primary Language**: JavaScript
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: https://github.com/sheep-realms/Echo-MoJi
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-07
- **Last Updated**: 2026-01-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: JavaScript, subtitles, OBS

## README

# Echo-MoJi

![Banner](https://sheep-realms.github.io/images/project/echo-moji/banner.png)

一款在直播间中显示随机跑马灯消息的 OBS 插件。


## 使用方法

将 `echomoji.html` 作为浏览器源导入 OBS 场景中。

您可以在浏览器中打开 `settings.html` 来调整配置，将导出的配置文件保存在 Echo-MoJi 根目录中，如果操作正确，会有覆盖提示。

在 `message.js` 中修改跑马灯内容。


## 消息格式

`message.js` 中存储了消息列表，有以下几种格式：

- **纯文本** —— 没有任何特殊格式。
- **富文本** —— 数据格式为 Array 或 Object，定义了文本样式。
- **消息队列** —— 队列中的消息会被依次展示，队列中的消息包含以上格式。
- **组合包** —— 组合包中的消息需要通过谓词检查才会被载入。


### 富文本格式

富文本格式消息看起来长这样：

``` json
{
    "text": "我们所经历的每个平凡的日常，也许就是连续发生的奇迹。",
    "style": {
        "bold": true,
        "italic": true,
        "underline": true,
        "strikethrough": true
    }
}
```

支持拆分段落，赋予不同的样式：

``` json
[
    {
        "text": "我们所经历的每个平凡的日常，"
    }, {
        "text": "也许就是连续发生的奇迹。"
    }
]
```

Echo-MoJi 的富文本格式组件复用了 [Echo-Live](https://github.com/sheep-realms/Echo-Live) 的组件，样式是通用的，您可以阅读 [Echo-Live 文档中的消息格式文本样式](https://sheep-realms.github.io/Echo-Live-Doc/message/style/)了解具体用法，文中的 `message` 字段内的部分为通用部分。


### 消息队列

队列中的消息会被依次展示，直到展示到最后一条消息。

``` json
{
    "type": "queue",
    "content": [
        "这是一段连续的消息队列",
        "抽取到此消息队列时",
        "会依次展示队列中的消息",
        "直到队列结束",
    ]
}
```


### 组合包

组合包会设定一个或多个谓词，当所有谓词都通过检查，组合包中的消息才会被载入。

组合包中的 `conditions` 字段定义了谓词列表，谓词通过检查则会将 `centent` 字段中的消息载入。

`centent` 字段支持所有消息格式，包括组合包。

``` json
{
    "type": "pack",
    "conditions": [
        {
            "condition": "date_check",
            "date": "6/1"
        }
    ],
    "content": [
        "这是一条只会在儿童节出现的消息"
    ]
}
```

关于谓词的说明请见下文。


### 变量

消息支持插入占位符以调用变量，纯文本和富文本格式中的 `text` 字段都可以使用。

变量的用法为：

```
{{{变量名}}}
{{{变量名|默认值}}}
```

当变量不存在时将使用默认值，如未指定默认值则保留占位符原文。

有以下变量可以使用：

| 变量名 | 描述 |
| - | - |
| `time:y` | 年。 |
| `time:M` | 月。 |
| `time:d` | 日。 |
| `time:h` | 小时，二十四小时制。 |
| `time:h12` | 小时，十二小时制。 |
| `time:m` | 分钟。 |
| `time:s` | 秒。 |
| `time:ms` | 毫秒。 |
| `time:MM` | 月，前补零。 |
| `time:dd` | 日，前补零。 |
| `time:hh` | 小时，二十四小时制，前补零。 |
| `time:hh12` | 小时，十二小时制，前补零。 |
| `time:mm` | 分钟，前补零。 |
| `time:ss` | 秒，前补零。 |
| `time:mms` | 毫秒，前补零。 |
| `time:utc` | UTC 时区。 |
| `time:utcs` | UTC 时区，带符号。 |
| `time:isAM` | 是上午，布尔值。 |
| `time:isPM` | 是下午，布尔值。 |
| `time:AMorPM` | 上午或下午，`am` 或 `pm`。 |


### 谓词

谓词用于判定某些对象或参数是否满足某种特性或条件。


#### `all_of`

评估一系列谓词，若它们都通过检查，则评估通过。

- `condition`：`all_of`
- `terms`：谓词列表，数组或对象。
  - 数组元素为谓词。
  - 若为对象，则等效于数组中只有一个对象。（仅为容错设计，不推荐这么做）


#### `any_of`

评估一系列谓词，若其中任意一个通过检查，则评估通过。

- `condition`：`any_of`
- `terms`：谓词列表，数组或对象。
  - 数组元素为谓词。
  - 若为对象，则等效于数组中只有一个对象。（仅为容错设计，不推荐这么做）


#### `date_check`

检查当前日期。

- `condition`：`date_check`
- `date`：日期，数字、字符串或对象。
  - 当格式为数字时，视为时间戳。
  - 当格式为字符串时，推荐的格式为：`yyyy/MM/dd`、`MM/dd`。
  - 当格式为对象时，包含字段 `start` 和 `end`，用于选定日期范围，格式同上。可省略其中一项字段，视为不设上 / 下限。


#### `random_chance`

生成一个取值范围为 0.0 ~ 1.0 之间的随机数，并检查其是否小于指定值。

- `condition`：`random_chance`
- `chance`：成功率，数字。


#### `weekday_check`

检查当前星期。

- `condition`：`weekday_check`
- `weekday`：星期，数字、字符串或对象。
  - 当格式为数字或字符串时，1 ~ 6 表示一周的第几天，0 表示星期日，更大或更小的数字会被取模映射到 0 ~ 6 以内。
  - 当格式为对象时，包含字段 `start` 和 `end`，用于选定星期范围，格式同上。若 `start` 值大于 `end` 会被视为跨周范围。


## 另见

- [如何为 Echo-MoJi 项目作出贡献？](CONTRIBUTING.md)
- [授权协议与声明](copyright.md)
- [GPL（GNU General Public License，GNU通用公共许可协议）第3版](LICENSE)


### 姊妹项目

- [Echo-Live](https://github.com/sheep-realms/Echo-Live)


## 相关资源

建议您安装可免费商用字体以规避版权纠纷，Echo-MoJi 默认使用思源黑体。

- [思源黑体](https://github.com/adobe-fonts/source-han-sans)

您还可以在这里搜寻可免费商用的字体：

- [100font.com](https://www.100font.com/)


## 赞助此项目

您可以通过[爱发电](https://afdian.com/a/sheep_realms)赞助此项目。

请注意：您的赞助应当是无偿且自愿的，此项目的开发者 Sheep-realms 不会通过任何方式向您索要报酬。您的赞助也许能促进某个功能或整个项目的开发，但我们对此不作任何形式的承诺与保证。