/koishi-plugin-chess

棋类游戏插件

Primary LanguageTypeScriptMIT LicenseMIT

koishi-plugin-chess

npm

适用于 Koishi v4 的棋类游戏插件。

目前支持的规则有:

  • 五子棋
  • 围棋(禁全同,暂时不支持点目)
  • 黑白棋

注意事项

  • 本插件在有数据库的情况下会自动保存棋局状态,即使机器人重新启动也能自动恢复。要启用自动保存功能,你需要安装数据库支持。
  • 本插件同时支持以文本和图片两种形式显示棋局。要启用图片功能,你需要安装 koishi-plugin-puppeteer

开始和停止棋局

使用 chess 指令开始一个棋局:

chess --rule <rule> [--size <size>]

或者直接使用已经注册号的快捷调用:“围棋”,“五子棋”,“黑白棋”,也可以开始一个棋局。

其中目前支持的棋局规则以及它们对应的规则名和默认棋盘大小为:

快捷名 规则名 默认大小
围棋 go 19
五子棋 gomoku 15
黑白棋 / 奥赛罗 othello 8

使用 chess --stop 或者 停止下棋 可以停止一个正在进行的棋局。

落子,悔棋和跳过

当棋局开始时,默认发起人是后手,而第一个响应这个棋局者是先手。输入 chess position 或者 落子 position 就可以加入这个棋局,此时棋局正式形成,其他人无法继续加入游戏。而参与游戏的两人可以依次使用“落子”指令进行游戏。

输入 chess --repent 或者 悔棋 进行悔棋,游戏会向前倒退一步。

输入 chess --skip 或者 跳过回合 可以跳过一个回合。

输入 chess --view 可以查看当前棋局。