Awesome

SGF4J

I've been doing some serious yak shaving. Instead of solving Go problems to improve my game I've been writing a SGF viewer to make it easier to go through my problem files.

As a side result of that viewer I had to do some SGF parsing. Hence this project. You can use this library to parse SGF files and then actually play it out on a virtual board and then write out the SGF if you want to. I test the library with bunch of databases to make sure it is able to parse enough different SGF files and also when writing those out no data is lost.

I use this parser on a weekly basis when I solve Go problems and haven't found any parsing or serialising issues for some time. I also test the library with 90 000+ SGF files that I parse with this library to make sure the lib is mature enough to parse most of the games out there. I also write the games out again to SGF format to re-parse them and make sure that by writing them out again we are not losing any data. If you find SGF files that don't parse with this library then please let me know.

Include in your project

The project is synced to Maven Central and to use it just include it in your pom.xml.

<dependencies>
  <dependency>
    <groupId>com.toomasr</groupId>
    <artifactId>sgf4j-parser</artifactId>
    <version>0.0.3</version>
  </dependency>
<dependencies>

Parsing from file

Simple parsing looks like this. You either have a SGF file in a String or a Path of the location of the file. You create a Game object of it and then start walking the nodes from the root node. There are methods to start from the end too.

    Game game = Sgf.createFromPath(Paths.get("location-of-your.sgf"));

    GameNode node = game.getRootNode();
    do {
      System.out.println(node);
    }
    while ((node = node.getNextNode()) != null);

Remember that not every node is an actual move. Also note that a node might have multiple children. I have built it in a way that node.getNextMove() returns the next move in the main line of play while getChildren() will return the rest of the possible next moves.

Writing to file

Once you have parsed a file into a Game object you can also write it back to a SGF file.

Game game = Sgf.createFromPath(sgfPath);
//... add/remove/update nodes
game.saveToFile(Paths.get("/tmp/output.sgf"))

This project writes the SGF string of the game to the output.sgf file. This code path uses the Game.getGeneratedSgf() method that returns the SGF string of the current Game object.