Skip to content

创建你的 Hub

前置条件

  • 一个 GitHub 账号
  • 一个运行中的 Koishi 机器人

步骤

1. 创建 GitHub 仓库

  1. 打开 GitHub → 右上角 +New repository
  2. 仓库名称随意,例如 NWTFhub
  3. 选择 Public(Bot 需要能读取仓库内容)
  4. 勾选 Add a README file
  5. 点击 Create repository

2. 创建 images 目录

  1. 进入刚创建的仓库
  2. 点击 Add fileCreate new file
  3. 在文件名输入 images/.gitkeep,这会自动创建 images 目录
  4. 点击 Commit changes

3. 生成 GitHub Token

  1. 进入 GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic)
  2. 点击 Generate new token
  3. 勾选 repo 权限(完整的仓库访问权限)
  4. 生成并保存 Token(只显示一次)

WARNING

Token 保存后无法再次查看,请妥善保管。如果泄露,立即在 GitHub 撤销。

4. 安装插件

koishi-plugin-hub-pusl 安装到你的 Koishi 机器人中,详见 插件使用

5. 配置插件

在 Koishi 配置中填写:

yaml
plugins:
  hub-pusl:
    githubToken: ghp_xxxxxxxx           # 第 3 步生成的 Token
    githubRepo: your-username/NWTFhub   # 你的仓库,格式:owner/repo
    baseBranch: main                     # 仓库默认分支

6. 验证

启动机器人,在群内发送:

nwtf-push 测试 [附带一张图片]

如果一切正常,Bot 会返回一个 PR 链接。合并 PR 后,发送:

nwtf-pull

Bot 应该会发送 测试.png 和对应的图片。