https://github.com/sabakihq/shudan

A highly customizable, low-level Preact Goban component.
https://github.com/sabakihq/shudan

baduk board-game component game go goban gomoku preact react ui-component weiqi

Last synced: about 1 month ago
JSON representation

A highly customizable, low-level Preact Goban component.

• Host: GitHub
• URL: https://github.com/sabakihq/shudan
• Owner: SabakiHQ
• License: mit
• Created: 2018-03-15T12:04:50.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-09-05T08:39:56.000Z (over 1 year ago)
• Last Synced: 2024-11-13T17:03:51.538Z (about 1 month ago)
• Topics: baduk, board-game, component, game, go, goban, gomoku, preact, react, ui-component, weiqi
• Language: JavaScript
• Homepage:
• Size: 3.78 MB
• Stars: 85
• Watchers: 7
• Forks: 22
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shudan Goban

A highly customizable, low-level Preact Goban component.

![Screenshot](./screenshot.png)

## Features

- Resizable

- Board coordinates

- Easy customization

- Fuzzy stone placement

- Stone placing animation

- Board and stone markers

- Lines and arrows

- Heat and paint map

- Busy state

- Partial board

## Documentation

See [documentation](./docs/README.md).

## Build Demo

Make sure you have Node.js v8 and npm installed. First, clone this repository

via Git, then install all dependencies with npm:

```

$ git clone https://github.com/SabakiHQ/Shudan

$ cd Shudan

$ npm install

```

Use the `build-demo` script to build the demo project:

```

$ npm run build-demo

```

You can use the `watch-demo` command for development:

```

$ npm run watch-demo

```

Open `demo/index.html` in your browser to run demo. Alternatively, use

`build-demo-react` and `watch-demo-react` to build the React-based demo.