BoxJS 配置生成器使用说明

这页是给第一次接触 BoxJS 的人看的。你不需要先懂 JSON,也不需要知道完整规范,按下面流程填就能先做出一份能用的订阅配置。

先记住一件事

这个页面不是让你“写代码”,而是帮你做一份 BoxJS 能认识的配置文件。

你可以把它理解成一个表单。把内容填好,右边会自动生成 JSON。你最后下载这个 JSON 文件就行。

第一次使用,直接照这个顺序做

  1. 先打开生成器主页。
  2. 在“主订阅”里填两个必填项:订阅标识 ID订阅显示名称
  3. 滚到“应用列表”最下面,点 新增应用
  4. 给这个应用填:应用标识 ID应用显示名称主运行脚本 URL
  5. 给这个应用添加一个变量。最常见的是“账号数据”,变量类型一般选 textarea
  6. 看右边 JSON 预览有没有内容。
  7. 确认没问题后,点右边的 下载 JSON
如果你什么都不懂,也可以先用主页里的“快速模板”,先生成一个能用的骨架,再慢慢改。

哪些是必填,哪些可以先不管

必须填写 订阅标识 ID、订阅显示名称、应用标识 ID、应用显示名称、至少一个变量标识 ID。
建议填写 主运行脚本 URL、变量描述。这样以后你自己回来看也更容易懂。
可以不填 作者、仓库、图标、顶层描述、自动增高、附加动作脚本。这些不影响最基本生成。

每个字段到底是什么意思

订阅标识 ID 整份配置给程序识别用的唯一名字。建议只用英文字母、数字、点号,例如 my.boxjs.sub
订阅显示名称 显示在 BoxJS 里的名字,例如“我的脚本订阅”。这是给人看的。
应用标识 ID 某个应用给程序识别用的名字,例如 dknjd_sign
应用显示名称 显示给人看的名称,例如“迪卡侬签到”。
主运行脚本 URL 这个应用对应的脚本链接。一般就是你仓库里那份 JS 文件地址。
HTML 说明 descs_html 这是高级说明区,适合导入别人已经写好的富文本介绍。编辑器里按“每行一条 HTML”填写,导出后会恢复成 descs_html 数组。
变量标识 ID 最重要。它必须和脚本里读取的变量名一致。脚本里如果读的是 dkn_data,这里就必须写 dkn_data
变量显示名称 在 BoxJS 界面里展示给用户看的文字,例如“账号数据”。这是给人看的。
类型 text 是单行,textarea 是多行,boolean 是开关,number 是数字,select 是下拉。
默认值 这个变量默认显示什么。比如开关常填 false,数字常填 3
自动增高 只影响输入框高度,不影响脚本运行。一般给 textarea 用,内容多时输入框会自动长高。
附加动作脚本 只有当一个应用下面还需要挂多个额外动作时才会用到。普通情况下可以不填。

最常见的 3 种填写方式

1. 单行文本

适合 token、key、手机号、活动 ID 这种内容。类型选 text

2. 多账号数据

适合账号数组、JSON、长字符串。类型选 textarea

3. 开关控制

适合启用通知、随机延迟这类功能。类型选 boolean

4. 数字控制

适合重试次数、轮询次数、金额阈值这类参数。类型选 number

不会填时,最容易错的是这几个地方

直接照着这个最小示例做

如果你只是想先做出第一份配置,先照这个格式来,成功以后再慢慢加别的字段。

{
  "id": "my.boxjs.sub",
  "name": "我的订阅",
  "apps": [
    {
      "id": "demo_sign",
      "name": "示例签到",
      "script": "https://example.com/demo_sign.js",
      "keys": [
        "demo_sign_data"
      ],
      "settings": [
        {
          "id": "demo_sign_data",
          "name": "账号数据",
          "type": "textarea",
          "desc": "多个账号请填写 JSON 数组",
          "val": ""
        }
      ]
    }
  ]
}

生成之后怎么用

  1. 点“下载 JSON”,把文件保存下来。
  2. 把这个文件上传到一个能公开访问的地址。
  3. 复制这个 JSON 文件的链接。
  4. 去 BoxJS 里添加订阅。
  5. 把链接填进去,保存。
如果你已经有旧配置,不想重填,可以回到主页直接用“导入 JSON”或“剪切板导入”。

如果你现在还是不知道从哪里开始

  1. 先去主页。
  2. 点一个“快速模板”。
  3. 把示例名称、示例 ID、脚本地址改成你自己的。
  4. 再看右边 JSON 有没有跟着变。