The puzzle-draw package

[Tags: library, mit, program]

puzzle-draw is a library and tool for drawing pencil puzzles using Diagrams. It aims to provide a utility layer on top of Diagrams to help with drawing arbitrary puzzles, and to support several specific puzzles types In addition, it includes functionality for parsing puzzle data from a YAML file format.


[Skip to ReadMe]

Properties

Versions0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.4
Change logCHANGES.md
Dependenciesaeson (>=0.7), base (>=4.2 && <5), containers (>=0.5), diagrams-cairo (>=1.1), diagrams-lib (>=1.2), diagrams-svg (>=1.1), filepath (>=1.3), hashable (>=1.2), mtl (>=2.1), optparse-applicative (>=0.7), parsec (>=3.1), puzzle-draw, SVGFonts (>=1.4), text (>=1.1), unordered-containers (>=0.2), vector-space (>=0.8), yaml (>=0.8.4) [details]
LicenseMIT
AuthorRobert Vollmert
Maintainerrfvollmert@gmail.com
CategoryGraphics
Source repositoryhead: git clone http://github.com/robx/puzzle-draw.git
Executablesdrawpuzzle
UploadedSat Nov 15 13:23:10 UTC 2014 by vollmert
Downloads667 total (34 in last 30 days)
Votes
0 []
StatusDocs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Flags

NameDescriptionDefaultType
cairoBuild against Cairo backendDisabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for puzzle-draw-0.1.0.4

Build Status

puzzle-draw

puzzle-draw is a library and command-line tool for drawing pencil puzzles using Diagrams. It aims to provide a utility layer on top of Diagrams to help with drawing arbitrary puzzles, as well as supporting several specific puzzle types directly. In addition, it includes functionality for parsing puzzle data from a YAML file format.

Examples

A liar slitherlink with solution:

Liar Slitherlink

This was rendered from the following YAML document:

type: slitherlinkliar
puzzle: |
  1..0.3
  .03222
  0....1
  3....3
  32202.
  3.3..3
solution:
  loop: |
    .┌──┐┌┐
    .│┌─┘││
    .│└──┘│
    ┌┘.┌─┐│
    └┐┌┘.││
    ┌┘│..││
    └─┘..└┘
  liars: |
    ...X..
    .X....
    X.....
    .....X
    ....X.
    ..X...

There is a demo web application at demo that provides some more examples and that can be used to generate SVG images from such puzzle descriptions.

Or see a puzzle set that covers the puzzle types that are supported as of 2014-05.

Installing

This is a brief overview of how to install the command line tool. You'll need to get a Haskell environment, by installing the Haskell Platform. Then install puzzle-draw with cabal:

$ cabal install puzzle-draw

This will compile puzzle-draw against the SVG backend, and install a binary drawpuzzle that formats puzzles to SVG. Alternatively, you can compile against the Cairo backend by passing -fcairo:

$ cabal install -fcairo puzzle-draw

This will enable PDF and PNG output. Be warned that getting Cairo installed can be tricky on non-Linux platforms.

Running

As an example, suppose the Liar Slitherlink puzzle description above is copied into a file slitherliar.pzl.

$ drawpuzzle slitherliar.pzl

This will generate two files slitherliar.svg and slitherliar-sol.svg, containing the puzzle and solved puzzle, respectively. Run

$ drawpuzzle -h

to see some command line options that allow modifying the program's behaviour, e.g., choosing the output format.