Seal Dice

https://docs.sealdice.com/
Admin
Seal Dice is a simple and easy-to-use dice system for tabletop role-playing games, offering...
Tokens:133,872
Snippets:884
Trust Score:5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Permission Identification Example

Source: https://docs.sealdice.com/advanced/js_example.html

Shows how to retrieve the current user's privilege level using ctx.privilegeLevel. The example maps numeric privilege values to human-readable strings.

```javascript
// ==UserScript==
// @name         权限识别样例
// @author       SzzRain
// @version      1.0.0
// @description  使用命令 .myperm 查看自己的权限
// @timestamp    1699086084
// @license      MIT
// @homepageURL  https://github.com/Szzrain
// ==/UserScript==
if (!seal.ext.find('myperm')) {
  const ext = seal.ext.new('myperm', 'SzzRain', '1.0.0');
  // 创建一个命令
  const cmdMyperm = seal.ext.newCmdItemInfo();
  cmdMyperm.name = 'myperm';
  cmdMyperm.help = '使用 .myperm 展示我的权限';
  cmdMyperm.solve = (ctx, msg, cmdArgs) => {
    let text = "普通用户";
    console.log(ctx.privilegeLevel);
    switch (ctx.privilegeLevel) {
      case 100:
        text = "master";
        break;
      case 60:
        text = "owner";
        break;
      case 50:
        text = "admin";
        break;
      case 40:
        text = "inviter";
        break;
      case -30:
        // 黑名单用户，但是由于黑名单会被过滤掉，所以实际上这里并不会执行，这里只是为了演示
        return seal.ext.newCmdExecuteResult(false);
    }
    seal.replyToSender(ctx, msg, text);
    return seal.ext.newCmdExecuteResult(true);
  }
  // 注册命令
  ext.cmdMap['myperm'] = cmdMyperm;

  // 注册扩展
  seal.ext.register(ext);
}
```

--------------------------------

### Data Persistence Example: Feeding Plugin

Source: https://docs.sealdice.com/advanced/js_example.html

Shows how to use storageGet and storageSet to persist data, using JSON.stringify and JSON.parse to handle objects.

```javascript
// ==UserScript==
// @name         示例：存储数据
// @author       木落
// @version      1.0.0
// @description  投喂，格式 .投喂 <物品>
// @timestamp    1672423909
// 2022-12-31
// @license      Apache-2
// @homepageURL  https://github.com/sealdice/javascript
// ==/UserScript==

// 先将扩展模块创建出来，如果已创建就直接使用
if (!seal.ext.find('test')) {
  const ext = seal.ext.new('test', '木落', '1.0.0');

  const cmdFeed = seal.ext.newCmdItemInfo();
  cmdFeed.name = '投喂';
  cmdFeed.help = '投喂，格式：.投喂 <物品>\n.投喂 记录 // 查看记录';
  cmdFeed.solve = (ctx, msg, cmdArgs) => {
    let val = cmdArgs.getArgN(1);
    switch (val) {
      case 'help':
      case '': {
        // .投喂 help
        const ret = seal.ext.newCmdExecuteResult(true);
        ret.showHelp = true;
        return ret;
      }
      case '列表':
      case '记录':
      case 'list': {
        const data = JSON.parse(ext.storageGet('feedInfo') || '{}');
        const lst = [];
        for (let [k, v] of Object.entries(data)) {
          lst.push(`- ${k}: 数量 ${v}`);
        }
        seal.replyToSender(ctx, msg, `投喂记录:\n${lst.join('\n')}`);
        return seal.ext.newCmdExecuteResult(true);
      }
      default: {
        const data = JSON.parse(ext.storageGet('feedInfo') || '{}');
        const name = val || '空气';
        if (data[name] === undefined) {
          data[name] = 0;
        }
        data[name] += 1;
        ext.storageSet('feedInfo', JSON.stringify(data));
        seal.replyToSender(ctx, msg, `你给海豹投喂了${name}，要爱护动物！`);
        return seal.ext.newCmdExecuteResult(true);
      }
    }
  };

  // 将命令注册到扩展中
  ext.cmdMap['投喂'] = cmdFeed;
  ext.cmdMap['feed'] = cmdFeed;

  seal.ext.register(ext);
}
```

--------------------------------

### Draw from Decks Example

Source: https://docs.sealdice.com/advanced/js_example.html

Demonstrates two ways to draw from a deck: using seal.deck.draw for programmatic control and seal.format for template-based extraction. The first method requires checking the 'exists' field in the returned map, while the second returns a string directly.

```javascript
// ==UserScript==
// @name         抽取牌堆示例
// @author       SzzRain
// @version      1.0.0
// @description  用于演示如何抽取牌堆
// @timestamp    1699077659
// @license      MIT
// @homepageURL  https://github.com/sealdice/javascript
// ==/UserScript==

// 本脚本用于演示如何抽取牌堆，共有两种实现方式
if (!seal.ext.find('draw-decks-example')) {
  const ext = seal.ext.new('draw-decks-example', 'SzzRain', '1.0.0');
  // 创建一个命令
  const cmdDrawDecks = seal.ext.newCmdItemInfo();
  cmdDrawDecks.name = 'dr';
  cmdDrawDecks.help = '使用 .dr <牌堆名> 来抽取牌堆';
  cmdDrawDecks.solve = (ctx, msg, cmdArgs) => {
    // 抽取牌堆
    // 参数1：ctx 参数2：牌堆名称 参数3：是否放回抽取
    // 返回值：{exists: true, result: '抽取结果', err: '错误原因'}
    const decks = seal.deck.draw(ctx, cmdArgs.getArgN(1), true);
    // 判断是否抽取成功
    if (decks['exists']) {
      seal.replyToSender(ctx, msg, decks['result']);
      return seal.ext.newCmdExecuteResult(true);
    } else {
      seal.replyToSender(ctx, msg, '抽取牌堆失败，原因：' + decks['err']);
      return seal.ext.newCmdExecuteResult(true);
    }
  };
  // 注册命令
  ext.cmdMap['dr'] = cmdDrawDecks;

  // 创建一个命令
  const cmdDrawDecks2 = seal.ext.newCmdItemInfo();
  cmdDrawDecks2.name = 'dr2';
  cmdDrawDecks2.help = '使用 .dr2 <牌堆名> 来抽取牌堆';
  cmdDrawDecks2.solve = (ctx, msg, cmdArgs) => {
    // 抽取牌堆的另一种写法，使用 format 函数，由于经过了 rollvm 的处理，所以代码的执行效率会更慢
    // 不过这种写法的返回值固定为字符串，省去了判断是否抽取成功的步骤
    // 参数1：ctx 参数2：海豹语表达式，其中 #{DRAW-牌堆名称} 会被替换为抽取结果
    const decks = seal.format(ctx, `#{DRAW-${cmdArgs.getArgN(1)}}`);
    seal.replyToSender(ctx, msg, decks);
  }
  // 注册命令
  ext.cmdMap['dr2'] = cmdDrawDecks2;

  // 注册扩展
  seal.ext.register(ext);
}
```

--------------------------------

### Create and Register a Command

Source: https://docs.sealdice.com/advanced/js_example.html

Demonstrates how to define a command item, set its help text and logic, and register it to an extension.

```javascript
// 创建一个命令
  const cmdcget = seal.ext.newCmdItemInfo();
  cmdcget.name = 'cget';
  cmdcget.help = '使用.cget <用户id> 来查看目标用户的黑名单/信任信息，仅master可用';
  cmdcget.solve = (ctx, msg, cmdArgs) => {
    let val = cmdArgs.getArgN(1);
    switch (val) {
      case 'help': {
        const ret = seal.ext.newCmdExecuteResult(true);
        ret.showHelp = true;
        return ret;
      }
      default: {
        if (ctx.privilegeLevel === 100) {
          let info = seal.ban.getUser(val);
          if (!info) {
            seal.replyToSender(ctx, msg, "用户不存在或未被拉黑/信任");
            return seal.ext.newCmdExecuteResult(true);
          }
          let level = info.rank;
          // 不知道为什么，用 === 是 false
          if (info.rank == 30) {
            level = "信任"
          } else if (info.rank == -30) {
            level = "拉黑"
          } else if (info.rank == -10) {
            level = "警告"
          }
          let text = `用户${info.name}(${info.id}) 当前等级:${level} 怒气值:${info.score}`;
          seal.replyToSender(ctx, msg, text);
        } else {
          seal.replyToSender(ctx, msg, "你没有权限执行此命令");
        }
        return seal.ext.newCmdExecuteResult(true);
      }
    }
  }
  // 注册命令
  ext.cmdMap['cget'] = cmdcget;

  // 注册扩展
  seal.ext.register(ext);
}
```

--------------------------------

### Variable Management API

Source: https://docs.sealdice.com/advanced/js_api_list.html

Methods for getting and setting persistent variables within the bot context.

```APIDOC
## seal.vars.intGet(ctx, key)
Retrieves an integer variable. Returns [value, exists].

## seal.vars.intSet(ctx, key, value)
Sets an integer variable.

## seal.vars.strGet(ctx, key)
Retrieves a string variable. Returns [value, exists].

## seal.vars.strSet(ctx, key, value)
Sets a string variable.
```

--------------------------------

### 首次启动容器

Source: https://docs.sealdice.com/deploy/platform-qq-docker.html

通过设置环境变量并运行 docker-compose 命令启动容器。请将 ACCOUNT 替换为实际的 QQ 号。

```bash
echo 'ACCOUNT=123456' > .env # 请将 ACCOUNT 的数字替换为骰娘的 QQ 号
NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker-compose up -d
```

--------------------------------

### Group Anchor Collection Example

Source: https://docs.sealdice.com/advanced/js_example.html

A template for collecting and managing group data, demonstrating the structure for an extension script.

```javascript
// ==UserScript==
// @name         群内安价收集
// @author       憧憬少
// @version      1.0.0
// @description  在群内收集群友给出的安价选项，并掷骰得出结果
// @timestamp    1676386517
// 2023-02-14 22:55:17
// @license      MIT
// @homepageURL  https://github.com/ChangingSelf/sealdice-js-ext-anchor
// ==/UserScript==

(() => {
  // src/index.ts
  const HELP = `群内安价收集 (ak 是アンカー罗马字缩写)
注意 ak 后面有空格，“.ak”也可以换成“.安价”
```

--------------------------------

### Deck Image Path Configuration

Source: https://docs.sealdice.com/advanced/edit_deck.html

Example of using a relative path for an image within a deck JSON file.

```json
{
  "test":["[图:./assets/1.jpg]"]
}
```

--------------------------------

### Lagrange.OneBot appsettings.json 配置

Source: https://docs.sealdice.com/deploy/platform-qq-docker.html

修改 Lagrange.OneBot 的配置文件，将监听地址设置为 0.0.0.0 以允许海豹容器访问。

```json
{
  "Implementations": [
    {
      "Type": "ForwardWebSocket",
      "Host": "0.0.0.0",
      "Port": 8081,
      "HeartBeatInterval": 5000,
      "AccessToken": ""
    }
  ]
}
```

--------------------------------

### Basic Deck Extraction Syntax

Source: https://docs.sealdice.com/advanced/edit_deck.html

Demonstrates how to use non-replacement extraction {key} and replacement extraction {%key} within a deck.

```toml
[decks]
"时间点" = [
  "早上",
  "中午",
  "晚上",
]
"追尾了" = [
  "在{%时间点}追尾了一辆高级黑色轿车",
]
```

--------------------------------

### Define multiple plugin dependencies

Source: https://docs.sealdice.com/advanced/js_start.html

Example of specifying multiple @depends tags to ensure the plugin only loads when all listed dependencies are present.

```javascript
// ==UserScript==
// @name         每日新闻
// @author       SzzRain
// @version      2.0.0
// ...
// @depends      SzzRain:定时任务:>=2.0.0
// @depends      sealdice:强制依赖
```

--------------------------------

### 多账号 docker-compose.yml 配置

Source: https://docs.sealdice.com/deploy/platform-qq-docker.html

通过在 docker-compose.yml 中定义多个 Lagrange.OneBot 服务实例来支持登录多个 QQ 账号。

```yaml
name: sealdice

services:
  sealdice:
    image: ghcr.io/sealdice/sealdice:edge
    ports:
      - 3211:3211
    volumes:
      - ./seal_data:/data
      - ./seal_backups:/backups
    restart: unless-stopped

  lagrange-1:
    image: ghcr.io/lagrangedev/lagrange.onebot:edge
    volumes:
      - ./lagrange_data_1:/app/data
      - ./seal_data:/data
    restart: unless-stopped

  lagrange-2:
    image: ghcr.io/lagrangedev/lagrange.onebot:edge
    volumes:
      - ./lagrange_data_2:/app/data
      - ./seal_data:/data
    restart: unless-stopped
```

--------------------------------

### 管理容器命令

Source: https://docs.sealdice.com/deploy/platform-qq-docker.html

用于启动、查看、停止、更新及重新创建容器的常用 docker-compose 命令。

```bash
docker-compose up -d
```

```bash
docker-compose ps
```

```bash
docker-compose down
```

```bash
docker-compose pull
docker-compose up -d
```

```bash
docker-compose up -d --force-recreate
```

--------------------------------

### Define plugin dependency with version constraint

Source: https://docs.sealdice.com/advanced/js_start.html

Example of using the @depends metadata tag to specify a dependency on another plugin with a minimum version requirement.

```javascript
// ==UserScript==
// @name         每日新闻
// @author       SzzRain
// @version      2.0.0
// ...
// @depends      SzzRain:定时任务:>=2.0.0
```

--------------------------------

### Variable Management APIs

Source: https://docs.sealdice.com/advanced/js_api_list.html

Methods to get and set integer or string variables. These functions return a tuple containing the value and a boolean indicating if the variable exists and matches the type.

```javascript
const [count, countExists] = seal.vars.intGet(ctx, '$m计数');
seal.vars.intSet(ctx, '$m计数', count + 1);

const [text, textExists] = seal.vars.strGet(ctx, '$g公告');
seal.vars.strSet(ctx, '$g公告', '今晚开团');
```

--------------------------------

### Linux 服务器权限修复命令

Source: https://docs.sealdice.com/deploy/transfer.html

在 Linux 服务器间跨架构迁移后，若文件权限不正确，可使用此命令修复文件和目录权限。

```bash
find . -type f | xargs chmod 644
find . -type d | xargs chmod 755
```

--------------------------------

### .welcome 新人入群欢迎

Source: https://docs.sealdice.com/use/fun.html

配置新人入群的自动欢迎语。

```APIDOC
## .welcome

### Description
设置或查看新人入群欢迎语。

### Usage
.welcome (on|off)
.welcome show
.welcome set <欢迎语>
```

--------------------------------

### Hello World 示例脚本

Source: https://docs.sealdice.com/advanced/js_start.html

一个简单的 JS 脚本示例，用于在日志中打印 Hello World。可通过 WebUI 上传或在调试控制台中运行。

```javascript
// ==UserScript==
// @name         示例：如何开始
// @author       木落
// @version      1.0.0
// @description  这是一个演示脚本，并没有任何实际作用。
// @timestamp    1671368035
// 2022-12-18
// @license      Apache-2
// @homepageURL  https://github.com/sealdice/javascript
// ==/UserScript==

console.log('Hello World!');
```

--------------------------------

### 创建 docker-compose.yml

Source: https://docs.sealdice.com/deploy/platform-qq-docker.html

在工作目录下创建 docker-compose.yml 文件以定义海豹与 Lagrange.OneBot 服务栈。此配置将宿主机端口映射并挂载必要的数据目录。

```yaml
name: sealdice

services:
  sealdice:
    image: ghcr.io/sealdice/sealdice:edge
    ports:
      - 3211:3211
    volumes:
      - ./seal_data:/data
      - ./seal_backups:/backups
    restart: unless-stopped

  lagrange:
    image: ghcr.io/lagrangedev/lagrange.onebot:edge
    volumes:
      - ./lagrange_data:/app/data
      - ./seal_data:/data
    restart: unless-stopped
```

--------------------------------

### 启动容器命令

Source: https://docs.sealdice.com/deploy/platform-qq-docker.html

在工作目录下使用 docker compose 启动服务栈。

```bash
docker compose up -d
```

--------------------------------

### 启动 Shizuku 服务

Source: https://docs.sealdice.com/archive/archive-other.html

在电脑端通过 adb 命令启动手机上的 Shizuku 服务以获取系统权限。

```cmd
adb shell sh /storage/emulated/0/Android/data/moe.shizuku.privileged.api/start.sh
```

--------------------------------

### 更新容器命令

Source: https://docs.sealdice.com/deploy/platform-qq-docker.html

拉取最新镜像并重新启动容器以完成更新。

```bash
docker compose pull
docker compose up -d
```

--------------------------------

### 恢复数据到新数据库文件

Source: https://docs.sealdice.com/deploy/db-repair.html

将导出的 SQL 数据读取到新数据库文件 a.db 中，并清理无效的空记录。

```shell
sqlite3.exe a.db
.read 1.sql
delete from attrs_group where id is null;
delete from attrs_user where id is null;
delete from group_info where id is null;
delete from attrs_group_user where id is null;
delete from ban_info where id is null;
delete from group_player_info where id is null;
.exit
```

--------------------------------

### 非 Windows 系统指定端口启动

Source: https://docs.sealdice.com/use/faq.html

在 Linux 等系统上通过命令行启动海豹核心并指定监听端口。

```bash
./sealdice-core --address=127.0.0.1:<端口号>
```

--------------------------------

### 处理指令参数与帮助信息

Source: https://docs.sealdice.com/advanced/js_example.html

通过 cmdArgs.getArgN 获取指令参数，并根据参数值返回执行结果对象。若 showHelp 标记为 true，系统会自动发送帮助信息。

```javascript
cmdSeal.solve = (ctx, msg, cmdArgs) => {
  // 获取第一个参数，例如 .seal A B C
  // 这里 cmdArgs.getArgN(1) 的结果即是 A，传参为 2 的话结果是 B
  let val = cmdArgs.getArgN(1);
  switch (val) {
    case 'help': {
      // 命令为 .seal help
      // 创建一个结果对象，并将 showHelp 标记为 true，这会自动给用户发送帮助
      const ret = seal.ext.newCmdExecuteResult(true);
      ret.showHelp = true;
      return ret;
    }
    default: {
      // 没有传入参数时的代码
      return seal.ext.newCmdExecuteResult(true);
    }
  }
};
```

--------------------------------

### ConfigItem 结构定义

Source: https://docs.sealdice.com/advanced/js_example.html

定义了配置项的数据结构，包含键、类型、描述、默认值、当前值、选项列表、弃用状态及分组信息。

```go
type ConfigItem struct {
    Key          string      `json:"key" jsbind:"key"`
    Type         string      `json:"type" jsbind:"type"`
    Description  string      `json:"description,omitempty" jsbind:"description"` // vA.B.C 新增字段。
    DefaultValue interface{} `json:"defaultValue" jsbind:"defaultValue"`
    Value        interface{} `json:"value,omitempty" jsbind:"value"`
    Option       interface{} `json:"option,omitempty" jsbind:"option"`
    Deprecated   bool        `json:"deprecated,omitempty" jsbind:"deprecated"`
    Group        string      `json:"group,omitempty" jsbind:"group"` // vA.B.C 新增字段。
}
```

--------------------------------

### 创建并注册扩展

Source: https://docs.sealdice.com/advanced/js_example.html

通过 seal.ext.new 创建扩展，并使用 seal.ext.register 进行注册。在创建前应先使用 seal.ext.find 检查扩展是否已存在。

```javascript
// 如何建立一个扩展

// 首先检查是否已经存在
if (!seal.ext.find('test')) {
  // 不存在，那么建立扩展，名为 test，作者“木落”，版本 1.0.0
  const ext = seal.ext.new('test', '木落', '1.0.0');
  // 注册扩展
  seal.ext.register(ext);
}
```

--------------------------------

### 连接模拟器端口

Source: https://docs.sealdice.com/archive/archive-other.html

使用 adb 连接模拟器并转发端口，以便海豹骰子与 Shamrock 通信。

```cmd
.\adb connect 127.0.0.1:端口
```

```cmd
.\adb connect 127.0.0.1:62028
```

```cmd
.\adb forward tcp:5800 tcp:5800
```

--------------------------------

### 编写代骰指令

Source: https://docs.sealdice.com/advanced/js_example.html

通过设置 cmdCatch.allowDelegate = true 并使用 seal.getCtxProxyFirst 获取被代骰者的数据，实现以他人身份进行骰点。

```javascript
// ==UserScript==
// @name         示例：编写代骰指令
// @author       木落
// @version      1.0.0
// @description  捕捉某人，格式.catch <@名字>
// @timestamp    1671540835
// 2022-12-20
// @license      Apache-2
// @homepageURL  https://github.com/sealdice/javascript
// ==/UserScript==

// 编写代骰指令
// 先将扩展模块创建出来，如果已创建就直接使用
if (!seal.ext.find('test')) {
  const ext = seal.ext.new('test', '木落', '1.0.0');

  // 创建指令 .catch
  // 这个命令的功能为，显示“试图捕捉某人”，并给出成功率
  // 如果命令写“.catch @张三”，那么就会试着捕捉张三
  const cmdCatch = seal.ext.newCmdItemInfo();
  cmdCatch.name = 'catch';
  cmdCatch.help = '捕捉某人，格式.catch <@名字>';
  // 对这个指令启用使用代骰功能，即@某人时，可获取对方的数据，以对方身份进行骰点
  cmdCatch.allowDelegate = true;
  cmdCatch.solve = (ctx, msg, cmdArgs) => {
    // 获取对方数据，之后用 mctx 替代 ctx，mctx 下读出的数据即被代骰者的个人数据
    const mctx = seal.getCtxProxyFirst(ctx, cmdArgs);
    let val = cmdArgs.getArgN(1);
    switch (val) {
      case 'help': {
        // 命令为 .catch help
        const ret = seal.ext.newCmdExecuteResult(true);
        ret.showHelp = true;
        return ret;
      }
      default: {
        const text = `正在试图捕捉${mctx.player.name}，成功率为${Math.ceil(Math.random() * 100)}%`;
        seal.replyToSender(mctx, msg, text);
        return seal.ext.newCmdExecuteResult(true);
      }
    }
  };
  // 将命令注册到扩展中
  ext.cmdMap['catch'] = cmdCatch;

  seal.ext.register(ext);
}
```

--------------------------------

### 导出损坏的数据库数据

Source: https://docs.sealdice.com/deploy/db-repair.html

使用 SQLite 3 工具导出损坏数据库中的数据到 SQL 文件。

```shell
sqlite3.exe data.db
.output 1.sql
.recover
.exit
```
Tokens:
Raw