Julia package for reading and writing the SGF File Format; a text based format that is commonly used to store game records of popular board games, such as Go, Backgammon, or Hex.
Package Status | Package Evaluator | Build Status |
---|---|---|
Description from the official website:
SGF is the abbreviation of 'Smart Game Format'. The file format is designed to store game records of board games for two players. It's a text only, tree based format. Therefore games stored in this format can easily be emailed, posted or processed with text-based tools. The main purposes of SGF are to store records of played games and to provide features for storing annotated and analyzed games (e.g. board markup, variations).
TODO
Check out the latest documentation
Additionally, you can make use of Julia's native docsystem.
The following example shows how to get additional information
on load_sgf
within Julia's REPL:
?load_sgf
Until this package is registered in METADATA.jl
it can be
cloned using Pkg
as usual.
Pkg.clone("https://github.com/Evizero/SmartGameFormat.jl.git")
Currently the character encoding is hardcoded to UTF-8
. In case
any other encoding is specified in an CA
property, a warning is
raised. Pull requests to improve this situation are welcome. A
potential solution could be build on top of
StringEncodings.jl.
This code is free to use under the terms of the MIT license.