A tool to create valid crossword puzzle grids!
This code, written in Python, will output an image of a valid (psuedo-)randomly generated crossword grid. Although there may be no stringent definition of what makes a crossword puzzle layout 'valid,' in this particular instance it means that the grid adheres to construction guidelines as outlined by the New York Times. In summary, the criteria are:
- grid size
- 15 x 15 (i.e., small)
- 21 x 21 (i.e., large)
- minimum word length: 3 letters
- symmetry about the origin, or center, of the puzzle
The repository includes an example of an output for each puzzle size, small and large.
This crossword generator requires Python 3.6 and Pillow 5.1.0 (PIL Fork). After cloning or downloading the repository, the crossword generator can be used simply by calling the file with python!
$ python xword_generator.py
After running the script you will be given a series of prompts to determine what size crossword the program will generate and what the name of the output .png image file will be. The image file will be saved into the directory from which the script was run.
If the script is run as shown above, size and output file name may be specified; however, there are two other parameters that can be modified to influence the crossword that is generated. Following is the syntax for xword_image_gen():
xword_generator.xword_image_gen(size=None, max_word_len=None, max_black_len=None, save_name=None)
- size
- "S" or "L". "S" = small, 15 x 15. "L" = large, 21 x 21
- default size="S"
- max_word_len
- the maximum length of a word that is generated in the first row of the puzzle, influencing how the rest of the puzzle will unfold
- default max_word_len=5
- max_black_len
- the maximum number of black squares that can be generated in the first row of the puzzle, influencing how the rest of the puzzle will unfold
- default max_black_len=4
- save_name
- a string indicating the name of the output file where the image will be saved in the directory. Will overwrite existing file of the same name. Name must be string type, and end in ".png"
- default save_name="xword_out.png"
As both a crossword enthusiast and amatuer programmer, I embarked on writing this code to exercise my coding ability, and also get myself one step closer to eventually submitting my own crossword to be considered for publishing in the NYT! stares off whistfully... To both ends, I plan to continue to work on this repository. Some of my current ideas on future work include:
- specifiying maximum number of words in the puzzle. The NYT construction guidelines give maximum word counts for puzzles based on size. Cursory investigation seems to indicate that this criterion is typically met, but further constraints should be outlined to ensure
- 15 x 15 (themed): 78 words
- 15 x 15 (themeless): 72 words
- 21 x 21 (always themed): 140 words
- specifying themed versus themeless for small puzzles (similar to previous bullet)
- adding more options for a tailored output. For example, being able to specify that the four longest clues are 15 squares in length
- debugging. There appears to be a bug where the "compare_look" function returns a NoneType object, halting the crossword output altogether
- generating words to fill puzzle. Given zero or more words to be included in the puzzle, use a dictionary to fill the rest of the puzzle with valid word combinations
- generating an answer key from words included in the puzzle
- generating clues for words based on existing crosswords available on the internet