Quackle

Crossword game artificial intelligence and analysis tool.

See LICENSE in this directory.

Building Quackle:

Quackle runs automated GitHub CI builds on Qt 5.15, 6.2, and 6.12, so it should work with any Qt version in those ranges. See README.MacOS and README.Windows for platform-specific instructions. Generally:

Clone the repo or download the tarball and untar. Use cmake to build quacker, which will automatically build quackle and quackleio:

cd quacker
mkdir build && cd build
cmake ..
cmake --build .

The binary will build as 'Quackle'.

You need Qt. There are various ways to get it. If you don't want to install it globally via package manager, aqtinstall is a particularly useful tool.

If you're using aqtinstall, then invoke cmake as...

cmake -DCMAKE_PREFIX_PATH="<path_to_qt_dir>/<ver>/<platform>" ..

If you're building with Qt provided by vcpkg, then invoke cmake as...

cmake -DCMAKE_PREFIX_PATH="<path_to_vcpkg>/installed/<arch>" ..

The Quackle cmake build system uses Qt6 by default. But you can specify Qt5 by invoking...

cmake -DQT_VERSION=5 ..

File organization:

• quackle/ - libquackle sources. libquackle is the engine, and can be linked to any convenient interface. It does not use Qt.
• quackle/quackleio/ - I/O library for Quackle. Implements stuff for accessing dictionaries, serializing GCG files, etc. Also, command-line option handling. This does have some modest dependencies on Qt.
• quackle/quacker/ - code for full Quackle UI. Written in Qt, and requires libquackleio and libquackle.
• quackle/makeminidawg/ - standalone console program for building Quackle dictionaries.
• quackle/makegaddag/ - standalone console program for building gaddag files.
• quackle/data/ - lexicons, strategy files, and alphabet resources for Quackle.

olaughlin@gmail.com jasonkatzbrown@gmail.edu jfultz@wolfram.com matt.liberty@gmail.com