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. The current version of libipuz is 0.5.2.

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.

This library was primarily written for use by GNOME Crosswords, though has at least one other user. It handles the following puzzle kinds. Puzzles in italics are libipuz extensions, and other types are planned for the future:

• Acrostics

• Arrowwords

• Barred Crosswords

• Crosswords

• Cryptic Crosswords

• Filipine Puzzles

• Nonograms

• Nonogram Color

libipuz has extensive documentation, and can be used from any language that supports GObject Introspection. It is regularly tested with TypeScript, Python, and C.

Documentation

• API documentation
• Design documents
  • Coordinates
  • Filippine puzzles
  • Parsing strategy
  • Full Puzzle Kind
  • Nonograms
• Rustification (ongoing)
  • Rust in libipuz
  • Porting IpuzCharset to Rust
• Miscellaneous
  • ipuz spec
  • ipuz extensions
  • Some style conventions
  • Release process checklist for libipuz

Useful links

• Main libipuz repository

• Issue tracker

• Release NEWS

• Release tarballs

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