chessground

棋场

Chessground是一个为 lichess.org 开发的免费开源国际象棋 UI。它针对现代浏览器以及使用 Cordova 的移动开发。

执照

Chessground 根据GPL-3.0 许可证（或任何更高版本，由您选择）分发。当您在网站上使用 Chessground 时，您的组合作品只能在 GPL 下分发。您必须向网站的用户发布您的源代码。

请在 greendrake.info 上阅读有关 JavaScript 的 GPL 的更多信息。

演示

• 嵌入式 PGN 查看器
• 国际象棋电视
• 董事会编辑
• 谜题
• 分析板
• 游戏预览

特征

Chessground 旨在满足 lichess.org 网络和移动应用程序的所有需求，因此功能非常强大。

• 使用 TypeScript 打字良好
• 快速地。使用自定义 DOM diff 算法将 DOM 写入减少到绝对最小值。
• 占用空间小：gzip 压缩后为 10K（解压后为 31K）。没有依赖性。
• 在板上绘制圆形、箭头和自定义用户形状的 SVG
• 箭头捕捉到有效的移动。徒手箭头可以通过在绘制箭头时将鼠标从板上拖动并返回来绘制。
• 完全可配置并可随时重新配置
• 仅使用 CSS 进行样式设置：只需切换类即可更改棋盘和棋子
• 流体布局：可以随时调整板的大小
• 支持 3D 部件和板
• 完整的移动支持（touchstart、touchmove、touchend）
• 通过点击移动棋子
• 通过拖放移动棋子
  • 拖动前的最小距离
  • 光标下的片段集中
  • 碎片鬼元素
  • 丢弃恢复或垃圾
• 通过单击或拖动进行预移动
• 将新作品拖到棋盘上（编辑器，Crazyhouse）
• 片段的动画：移动和消失
• 显示最后移动、检查、移动目的地和预移动目的地（可能有悬停效果）
• 采用 FEN 表示法的导入和导出头寸
• 用户回调
• 内部没有国际象棋逻辑：可用于国际象棋变体

安装

npm install --save chessground

用法

 import { Chessground } from 'chessground' ;

const config = { } ;
const ground = Chessground ( document . body , config ) ;

包装纸

• React：react-chess/chessground、ruilisi/react-chessground
• Vue.js：vitogit/vue-chessboard、qwerty084/vue3-chessboard
• 角度：topce/ngx-chessground
• Svelte：agelas/svelte-chessground-ui、gtim/svelte-chessground、gtm-nayan/svelte-use-chessground

更多的？请提出拉取请求以将其包含在此处。

文档

• 配置类型
• 默认配置值
• API 类型签名
• 简单的独立示例
• 示例仓库
• 基础CSS

发展

安装构建依赖项：

pnpm install

构建节点模块：

pnpm run compile --watch

要构建独立的：

pnpm run dist