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