FAQ

• Will crossword_puzzle continue to be maintained?

  • Necessary compatibility updates and bug fixes will be made to ensure crossword_puzzle can be used for the years to come. I am also willing to add feature requests posted in Discussions or Issues.

• How long did it take to make crossword_puzzle?

  • Around 200-250 hours from January to May.

• Does crossword_puzzle work with languages that use right-to-left scripts such as Arabic?

  • Unfortunately, support for right-to-left scripts has not been implemented and probably never will be.

• What was the hardest part of making crossword_puzzle?

  • The crossword generator. I had many failed attempts before making this repository.

• I read the installation instructions, but where do I actually type these commands?

  • In your operating system's terminal:

    • For Windows/MacOS, open your Start Menu with the Windows key or Spotlight and search for Terminal.
    • For Linux, open your Start Menu and try searching for Terminal. It might also be called Konsole.

• How can I install crossword_puzzle?

  • Refer to the installation instructions in the README here or in the wiki here

• Can I add my own crosswords?

  You can do it manually by following these steps:

  • Find where your package is installed in your operating systems. Try running pip install crossword_puzzle --force-reinstall to see where pip installs it.
  • Open the base_cwords directory.
  • Make a new folder in this directory to create a new category (optional).
  • Open your new category's directory (or an existing one).
  • Create your crossword in the format crossword_name-difficulty (where difficulty is either easy, medium, hard or extreme.
  • Copy the path to your new crossword's directory and open it in your favourite text editor. For example, with VSCode, you would run code <path>.
  • Create definitions.json in your crossword's directory
  • Begin defining this crossword's definitions. There must be at least 3 entries!

  { 
    "paris": "The capital of France",
    "brussels": "The capital of Belgium",
    "amsterdam": "The capital of the The Netherlands"
  }

  • Relaunch/open the GUI with crossword-ctk and your new crosswords will be visible! If you do not follow this process exactly, there might be unexpected results.