Shogiground

Shogiground is a free/libre open source shogi UI forked from Chessground rewritten for lishogi.org. It supports modern desktop and mobile browsers.

Documentation & interactive demo ->

License

Shogiground is distributed under the GPL-3.0 license (or any later version, at your option). When you use Shogiground for your website, your combined work may be distributed only under the GPL. You must release your source code to the users of your website.

Features

• Written in TypeScript with no runtime dependencies
• Click, drag & drop, touch support, keyboard navigation, premoves, predrops, and animations
• Configurable CSS styling, board highlights, and SVG arrows and circles
• SFEN import/export and board dimensions up to 16×16
• No built-in shogi rules, so you can supply your own logic for shogi and variants

Installation

npm install shogiground

Follow the setup guide to load the required CSS and create your first board.

Documentation

• Interactive demo
• Configuration
• API reference
• Styling guide

Development

pnpm install
pnpm compile:watch  # Build the module and watch for changes
pnpm dist:watch     # Build the standalone bundle and watch for changes
pnpm docs:dev       # Run the documentation site locally