jGoBoard v5

Modular JavaScript toolkit for Go (Baduk/Weiqi): board state, rules engine, variation tree, SGF IO, renderer, and embeddable player.

This package is now v5-first. The legacy v4 API (JGO.Board, JGO.Setup, JGO.Record, etc.) is no longer the primary API surface.

Installation

npm install jgoboard

CDN

Global JGO (UMD):

<script src="https://cdn.jsdelivr.net/npm/jgoboard@5/dist/jgoboard.umd.min.js"></script>
<script>
  const game = JGO.createGame({ size: 9 });
</script>

Module import (ESM):

<script type="module">
  import { createGame } from 'https://cdn.jsdelivr.net/npm/jgoboard@5/dist/jgoboard.js';
  const game = createGame({ size: 9 });
</script>

Quick Start

import { createBoard, STONE, createRenderer } from 'jgoboard';

const board = createBoard({ size: 19 });
board.setStone('D4', STONE.BLACK);

const renderer = createRenderer('#board', {
  board,
  theme: 'kaya-medium',
});

await renderer.whenReady();
renderer.render();

Module Entry Points

import { createBoard, createGameTree, createCursor } from 'jgoboard';
// or subpaths
import { createGame, rules } from 'jgoboard/core';
import { createRenderer } from 'jgoboard/renderer';
import { kayaMedium } from 'jgoboard/presets';
import { parseSgf, gameTreeFromSgf, sgfFromGameTree } from 'jgoboard/sgf';
import { createPlayer } from 'jgoboard/player';

Documentation

Demos

demoV5Renderer.html
demoV5Layers.html
demoV5Game.html
demoV5Tree.html
demoV5Player.html

Run demos in dev mode:

npm install
npm run dev

Then open for example http://localhost:5173/demoV5Player.html.

Development

npm run dev
npm run build
npm run test
npm run lint
npm run format

Build output includes:

dist/jgoboard.js (ESM)
dist/jgoboard.cjs (CJS)
dist/jgoboard.umd.min.js (UMD)
dist/core.{js,cjs}, dist/renderer.{js,cjs}, dist/presets.{js,cjs}, dist/sgf.{js,cjs}, dist/player.{js,cjs}
dist/*.d.ts

Theme Assets

Built-in textured themes (kaya-*, walnut-*) now resolve their image URLs relative to the jGoBoard module/script location.
This works out of the box for direct CDN usage, local repo clone demos, and GitHub release dist usage.
For custom npm/bundler asset layouts, set assetBaseUrl (globally or per renderer/player instance).
bw-* themes do not load image assets.

import { createRenderer, setAssetBaseUrl } from 'jgoboard';

setAssetBaseUrl('/static/vendor/jgoboard/');
// or: createRenderer(target, { board, theme: 'kaya-medium', assetBaseUrl: '/static/vendor/jgoboard/' })

License

Creative Commons Attribution-NonCommercial 4.0 International (CC-BY-NC-4.0).

Jgoboard

Install / Use

README