简介
gobang 是一款基于 Node.js 和原生 HTML/CSS/JS 的五子棋游戏，可以在终端和浏览器中运行。它在游戏性、可配置性和可扩展性方面都具有非常高的灵活性。
此 npm 包 gobang 将 gobang 游戏的核心功能封装在一个 Node.js 模块中，并提供对应的 Web UI 组件，以便在 web 应用中方便地使用 gobang 游戏。
安装
首先，需要在本地安装 Node.js 环境，并在命令行中使用 npm 或 yarn 安装 gobang 包：
--- ------- ------ ------
或
---- --- ------
快速上手
使用终端版 gobang
安装之后，可以在命令行中直接使用 gobang 命令来启动终端版的 gobang 游戏：
------
命令行将出现五子棋棋盘，请按黑白交替落子即可。
使用 Web UI 组件
gobang 包还提供了 web UI 组件，可以在 Web 应用中方便地使用五子棋游戏。
首先，在 HTML 文件中引入 gobang 包中的 CSS 和 JS 文件：
------ ----- ---------------- ------------------------------------------- ------- -------------------------------------------------- -------
然后，在需要显示五子棋盘的页面中，添加一个 id 为 "gobang-board" 的 div，用来放置棋盘：
------ ---- ------------------------ -------
最后，在 JavaScript 中，使用 gobang.init() 初始化游戏，即可在 gobang-board 中显示五子棋盘：
----- ----- - ---------------------------------------- ----- ---- - -------------------
自定义游戏设置
gobang 包提供了多个游戏设置项，可以在初始化游戏的时候进行自定义。
例如，可以更改棋盘大小、背景颜色、落子提示等，在初始化时传入配置对象即可：
----- ----- - ---------------------------------------- ----- ------ - - ----- --- ---------------- ---------- --------- ----- -- ----- ---- - ------------------ --------
API 文档
gobang.init(board, config?)
初始化 gobang 游戏，返回一个 Game 实例。参数：
board: HTMLDivElement 棋盘所在的 div 元素。config（可选）: 初始化游戏的配置对象。包括以下字段：size: number 棋盘大小，默认为 15。backgroundColor: string 棋盘背景颜色，默认为 '#d1c0a5'。showHint: boolean 是否显示落子提示，默认为 false。
Game 实例
初始化完成后，会返回一个 Game 实例，代表一个 gobang 游戏。在游戏中，可以进行落子、撤回、游戏结束等操作，也可以通过 Game 实例订阅一些事件来监听游戏状态的变化。
方法
play(x: number, y: number)
在（x，y）处落子。
undo()
撤回一个落子操作。
restart()
重新开始游戏。
dispose()
清除游戏，并释放相关资源（包括绑定的事件监听器）。
事件
stonePut
每次落子时触发，包含以下信息：
x: 落子位置的 x 坐标。y: 落子位置的 y 坐标。player: 落子方，0 表示黑方，1 表示白方。
stoneUndo
每次撤销落子时触发，包含以下信息：
x: 被撤销操作位置的 x 坐标。y: 被撤销操作位置的 y 坐标。player: 被撤销操作方，0 表示黑方，1 表示白方。
gameEnd
每次游戏结束时触发，包含以下信息：
result：游戏结果，包括blackWin、whiteWin和tie三种。
示例代码
HTML 文件
--------- -----
----- ----------
------
----- ----------------
------------- ---------------
----- ---------------- -------------------------------------------
-------
------
---- ------------------------
------- --------------------------------------------------
--------
----- ----- - ----------------------------------------
----- ------ - -
----- ---
---------------- ----------
--------- -----
--
----- ---- - ------------------ --------
------------------- ---- -- -------- -- -
--------------------------- - -- --- -- ------ --------
---
------------------ ---------- -- -
-- ------- --- ----------- -
------------------ -------
- ---- -- ------- --- ----------- -
------------------ -------
- ---- -
-------------------
-
---
---------
-------
-------来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60066e6e255dee6beeee73de