Skip to content
Sam Twidale edited this page Dec 26, 2017 · 31 revisions

Introduction

Blind Crossword 3D is a crossword puzzle game made to enable blind and partially sighted solvers to solve puzzles. The program is voiced using the Qt text to speech module and is licensed under the GPLv3.

How to contribute to Blind Crossword 3D?

Pull requests, suggestions and feedback are all welcomed. The issue tracker is likely to contain plenty of stuff that needs doing and help would be hugely appreciated and encouraged.

Feedback emails can be sent to Eric Westbrook via the program itself. Or you can open a technical issue on the GitHub issue tracker if you prefer. Thanks!


Documents and Specifications

Documentation The code is documented in the Doxygen style, and so comments can be generated by running it through Doxygen. The documentation should be kept up to date in some branch of the repo and connected to the github pages (but it isn't yet!).

Explanation and example of crossword file formats

The .xwc format is Ian Humphreys' human-readable format for 2D crossword. His spec is available here

The .xwc3d format is a simple human-readable format for 3D crosswords. A spec is in the works.


Build Instructions

This program is written in portable C++ and should run on Windows, Mac and Linux.

  • Get the latest open source Qt libraries and Qt Creator from the Qt Project homepage.
  • Pull the repo and run the included Qt Creator project file. It may be necessary to tweak the settings under the Projects tab on the left pane in the IDE.