GoBoard

approved

by Dmitry I. Sokolov

Render Go game diagrams from Markdown code blocks.

12 stars145 downloadsUpdated 2mo agoMIT
View on GitHub

GoBoard

GoBoard

GoBoard is a plugin for Obsidian that renders Go game diagrams (also known as Weiqi or Baduk).

License Version Obsidian Downloads

Language: English • Русский • 中文

Installation

If you don't have Obsidian installed yet - download it.

To install click here, or follow these steps:

  1. In the Obsidian application, open the community plugins settings: Settings -> Community plugins.
  2. If you haven't done this yet, you'll need to enable support for third-party plugins Turn on community plugins.
  3. Go to plugin selection by clicking Browse.
  4. In the search bar, enter GoBoard.
  5. Select the plugin, click Install, and after installation is complete - Enable.
  6. Done, now you can draw diagrams!

Other installation methods are described in installation.md

Usage

Diagrams are drawn based on markdown code blocks with the goboard syntax specified.

For example, the following code will draw an empty 9x9 goban:

```goboard
size 9x9
```

Empty 9x9 goban (light theme) Empty 9x9 goban (dark theme)

To place stones on the diagram, use B <position> and W <position> for black and white stones respectively. For example:

```goboard
size 9x9
B G7
W C3
```

First two moves on 9x9 goban (light theme) First two moves on 9x9 goban (dark theme)

For more usage examples, see examples.md.

Building the project

See build.md

Issues and suggestions

If you found a bug or have suggestions for improvement - don't hesitate to create issues!

License

MIT License - see the LICENSE file for details.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.