rudolphpienaar / wudoko

Simple word board recursive solver

wudoko

Simple word board solver

██╗    ██╗██╗   ██╗██████╗  ██████╗ ██╗  ██╗ ██████╗
██║    ██║██║   ██║██╔══██╗██╔═══██╗██║ ██╔╝██╔═══██╗
██║ █╗ ██║██║   ██║██║  ██║██║   ██║█████╔╝ ██║   ██║
██║███╗██║██║   ██║██║  ██║██║   ██║██╔═██╗ ██║   ██║
╚███╔███╔╝╚██████╔╝██████╔╝╚██████╔╝██║  ██╗╚██████╔╝
 ╚══╝╚══╝  ╚═════╝ ╚═════╝  ╚═════╝ ╚═╝  ╚═╝ ╚═════╝

                - - - - - - - - - - - - -
                - o - - - - o - - - - o -
                - - k - - - k - - - k - -
                - - - o - - o - - o - - -
                - - - - d - d - d - - - -
                - - - - - u u u - - - - -
                - o k o d u w u d o k o -
                - - - - - u u u - - - - -
                - - - - d - d - d - - - -
                - - - o - - o - - o - - -
                - - k - - - k - - - k - -
                - o - - - - o - - - - o -
                - - - - - - - - - - - - -

Abstract

wudoko is a word board builder. Given a grid size and list of words to include, wudoko will solve for all boards that contain these words. Words can be inserted as in the banner above, i.e. up/down, left/right, and diagonals. Optionally, a list of words or characters to not include can also be provided which will remove any boards accordingly.

Notes

This project uses recursion to explore the board solution space. On python, this solution seems extremely slow.

Installation

Using PyPI

The best method of installing wudoko and all of its dependencies is by fetching it from PyPI

pip3 install wudoko 

From source repo

Alternatively, you can just pip3 install -U ./ from the root directory of the source repo.

Usage

For a given grid size, and a list of included/excluded words in separate files:

wudoko --gridSize 4x4 --wordInclude wordsInclude.txt --wordExclude wordsExclude.txt

CLI Synopsis

        --gridSize <Rows>x<Cols>
        The size of the board in rows, cols. This is a string and MUST have an 'x'
        separating the <rows> from <cols>, for example "10x7".

        --wordInclude <wordList>
        The file containing the list of words to include.

        [--wordExclude <wordList>]
        The file containing the list of words to exclude.

        [--version]
        If specified, print the version and exit.

        [--man]
        If specified, print a detail man page and exit.

        [--synopsis]
        If specified, print only an overview synposis and exit.

Examples

Watch this space!

-30-