libipuz.org

libipuz is a library for loading and saving the ipuz data format for pencil-and-paper puzzles. It is written in C and Rust, and has dependencies on glib and json-glib. It is licensed under terms of the LGPLv2.1-or-later and the MIT licenses.

libipuz intends to have complete compatibility with the ipuz spec (local mirror), and areas where we don’t support something correctly are considered a bug. The areas where we have extensions or clarifications are documented here:

• Extensions to the ipuz spec that we support

This library was primarily written for use by GNOME Crosswords, though has at least one other user. Currently it handles the following puzzle kinds:

• Acrostics

• Arrowwords

• Barred Crosswords

• Crosswords

• Cryptic Crosswords

• Filipine Puzzles

• Nonograms

• Nonogram Color

Puzzles in italics are libipuz extensions. Other types are planned for the future.

Development

Libipuz has extensive documentation, and can be used from any language that supports GObject Introspection. It is tested with typescript, python, and C.

• libipuz development manual and API guide

Source code

The current version of libipuz is 0.5.0

• Main libipuz repository

• Issue tracker

• Release NEWS

• Release tarballs

Design documents

• Coordinate clarification

• Filippine puzzles

• Parsing strategy

• Full Puzzle Kind

• Nonograms

Rustification (ongoing)

• Rust in libipuz

• Porting IpuzCharset to Rust

Coding style

• Some style conventions

See http://ipuz.org/ for more information about the file format. ipuz is a trademark of Puzzazz, Inc., used with permission