#baduk #sgf #go #svg #png

bin+lib sgf-render

A renderer for SGF diagrams

26 stable releases

new 2.4.4 Feb 26, 2024
2.4.1 Jul 26, 2023
2.4.0 Feb 28, 2022
2.3.3 Sep 21, 2021
1.2.1 Nov 29, 2020

#65 in Images

Download history 7/week @ 2023-11-04 1/week @ 2023-11-11 24/week @ 2023-11-18 28/week @ 2023-11-25 69/week @ 2023-12-02 23/week @ 2023-12-09 23/week @ 2023-12-16 49/week @ 2023-12-23 25/week @ 2024-01-06 15/week @ 2024-01-13 30/week @ 2024-01-20 46/week @ 2024-01-27 50/week @ 2024-02-10 400/week @ 2024-02-17

496 downloads per month

MIT license

265KB
2K SLoC

Sgf Render

Continuous integration

Cho Chikun Elementary, Problem 45.

CLI to generate SVG or PNG diagrams of Go games from SGF format game records.

SVG output is clean and well labeled for easy re-styling or modification.

Supports numbered moves, markup, kifu output, and several customizable styles.

Installation

Check the releases page on GitHub for pre-built binaries.

If you have cargo installed, you can also install the package from crates.io:

$ cargo install sgf-render

Building

If you have git and cargo installed you can also build from source:

$ git clone https://julianandrews/sgf-render
$ cd sgf-render
$ cargo build --release
$ ./target/release/sgf-render -h

Usage

Usage: sgf-render [FILE] [options]

Options:
    -o, --outfile FILE  Output file. SVG and PNG formats supported.
    -n, --node PATH_SPEC
                        Node to render. For simple use provide a number or
                        `last` to render the last node. See the README for
                        more detail (default 0).
    -w, --width WIDTH   Width of the output image in pixels (default 800).
    -s, --shrink-wrap   Draw only enough of the board to hold all the stones
                        (with 1 space padding).
    -r, --range RANGE   Range to draw as a pair of corners (e.g. 'cc-ff').
        --style STYLE   Style to use. One of 'simple', 'fancy' or
                        'minimalist'.
        --custom-style FILE
                        Custom style to use. Overrides '--style'. See the
                        README for details.
        --move-numbers  Draw move numbers (disables other markup).
        --first-move-number NUM
                        First move number to draw if using --move-numbers
        --label-sides SIDES
                        Sides to draw board labels on (any of nesw).
        --no-board-labels
                        Don't draw position labels.
        --no-marks      Don't draw SGF marks.
        --no-triangles  Don't draw SGF triangles.
        --no-circles    Don't draw SGF circles.
        --no-squares    Don't draw SGF squares.
        --no-selected   Don't draw SGF selected.
        --no-dimmed     Don't draw SGF dimmmed.
        --no-labels     Don't draw SGF labels.
        --no-lines      Don't draw SGF lines.
        --no-arrows     Don't draw SGF arrows.
        --kifu          Generate a kifu.
        --version       Display the version and exit.
    -h, --help          Display this help and exit.

If FILE isn't provided, sgf-render will read from stdin. If --outfile isn't provided sgf-render will print the resulting SVG to stdout.

Node selection

For the --node argument PATH_SPEC should be a comma-separated list of steps. A step can be a number which advances that many steps, 'v' followed by a number which advances one step down the chosen variation, or last which advances to the last node down the current variation. Variations are zero-indexed, so, for instance, v0 is equivalent to 1.

Note that the zeroth node in an SGF usually has no moves, but may have setup (which is common for tsumego). Nodes without moves (with commentary or annotations) are possible, but uncommon.

Examples:

  • --node 0: Show the root node (usually before the first move).
  • --node 7: Show the 8th node (probably the 7th move) of the main variation.
  • --node last: Show the last node of the main variation.
  • --node 5,v1,12: Advance to the 6th node advance 1 step down the first (non-main) variation at that node, then advance 12 more steps. Show that node.
  • --node 5,v1,last: Advance to the 6th node advance 1 step down the first (non-main) variation at that node, then advance to the last node. Show that node.

Kifu mode

By default sgf-render generates diagrams designed to show the board position at a single point in time. Captured stones are removed, and when using --move-numbers only the last move number at a given point is displayed. --kifu generates diagrams appropriate for use as a whole game record:

  • move numbers are enabled,
  • all other markup is disabled,
  • stones are never removed from the board,
  • if a stone would be placed on an existing stone an annotation is added instead, and
  • --node defaults to last (can be overridden).

Custom styles

You can use the --custom-style flag to specify a file with custom style configuration in TOML format. As an example here's the style config for the simple style:

line_color = "black"
line_width = 0.03
hoshi_radius = 0.09
background_fill = "#cfa87e"
label_color = "#6e5840"
black_stone_fill = "black"
white_stone_fill = "white"
black_stone_stroke = "black"
white_stone_stroke = "black"
markup_stroke_width = 0.1
black_stone_markup_color = "white"
white_stone_markup_color = "black"
empty_markup_color = "black"
black_stone_selected_color = "blue"
white_stone_selected_color = "blue"
empty_selected_color = "blue"

You can see a couple other examples in the source code package under resources/styles/

Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

Feature requests are also welcome! The goal is to make this a general purpose sgf diagram generation tool. Just open an issue at GitHub.

Dependencies

~1.5–3MB
~64K SLoC