This project aim to build a goban widget that would be easy to integrate in any website to display a go Game.
It would be an alternative to the wgo.js library.
We are going to use sabaki libraries:
Why? one could ask!
- Why not just use sabaki web branch? It have been attempted and it's not that easy (see this issue). Sabaki author advise us to iframe sabaki and we prefer to build a proper tool.
- Why not use wgo.js or glift? Sadly wgo fail to display some sgfs and is hardly maintained. On the other hand we feel glift lack a proper API to interact with it (got to move/variation, highlight coordinate, ...).
We assume you have a working nodejs 8.10.0.
Clone the repo: git clone https://github.com/Awea/wshudan.git
Install dependencies:npm install
Run the server: make serve
You can also build the js bundle with make build
- Basic setup using shudan, sgf, go-board, immutable-gametree libraries.
- Next/previous buttons.
- Move counter.
- Comment box.
- Capture counter.
- Game infos box: players, ranks, rules.
- UI, css: style different components and arrange them in a fancy layout.
- Load the widget on a html attribute such as
<div data-wshudan="game.sgf"></div>. - Set up options and API to define max-width, starting move number, UI configuration.
- Game tree component.
- Make sure we can render multiple widget on the same page without any conflicts.
- Create an "edit" mode.