README.md

This repository contains the code for the Battlehack20 fancyviewer. Before you can use this package, you must first have battlehack20 or battlehack20-minimal installed.

Installation and Usage

Installation

To install the viewer, run

$ pip install battlehack20-fancyviewer

Usage

You can then edit run.py in your battlehack20-scaffold to use this viewer as follows:

from fancyviewer import FancyViewer
...
if __name__ == "__main__":
    ...
    viewer = FancyViewer(args.board_size, game.board_states)

You can also run a game from a log file in the following way:

$ python -m fancyviewer [log_file]