Crossword Nexus HTML5 Solver

An HTML5 crossword solver that can handle JPZ/PUZ/iPUZ/CFP files in a browser.

Dependencies:

jQuery

jsPDF (optional) - https://github.com/MrRio/jsPDF

JSCrossword tools - https://github.com/crosswordnexus/crossword-tools

lscache - https://github.com/pamelafox/lscache/

Installation

Using git command line (preferred)

Use the command git clone --recurse-submodules https://github.com/crosswordnexus/html5-crossword-solver/ in whatever directory you'd like on your server. If you ever want to update you can run a simple git pull from the html5-crossword-solver directory.

Using a zip file

Head over to https://github.com/crosswordnexus/html5-crossword-solver/releases and download the most recent html5-crossword-solver.zip. Unzip it and it will create a html5-crossword-solver directory.

Usage:

Basic usage

You do not need to alter any files in order to create a fullscreen solving page. Simply create a URL like

https://YOUR.SITE/html5-crossword-solver/index.html?file=/PATH/TO/YOUR/FILE

where your file is a puzzle in puz, ipuz, jpz, or cfp format. You can then make an iframe to embed in another page if desired:

<iframe allowfullscreen="true" height="550" width="100%" style="border:none;width: 100% !important;position: static;display: block !important;margin: 0 !important;"
 src="https://YOUR.SITE/html5-crossword-solver/index.html?file=/PATH/TO/YOUR/FILE">
</iframe>

Advanced usage

You can change the code on any page to suit your needs.

var CrossWord = CrosswordNexus.createCrossword(parent, parameters);

Warning

CrossWord object adds listener to window. If you want to remove crossword from DOM - call remove function, that will remove all event listeners, then remove crossword;

CrossWord.remove();

Parameters

Param	Description
parent	jquery-wrapped element, that will be parent for crossword
parameters	javascript object

Available parameters

For a list of available parameters and what they control, see lines 87-119 in crosswords.js. Note that some color settings are configurable via CSS.

Each puzzle file must be object with 3 parameters:

Param	Description
url	Puzzle file url
type	Type of puzzle file. Currently .JPZ/.PUZ/.IPUZ/.CFP puzzles supported. This is optional.
name	Puzzle name. Optional for puzzle_file parameter

With cell_size == 0, crossword will never be bigger than parent.

Example:

Single puzzle with settings disabled and some custom colors:

var params = {
  hover_enabled: false,
  settings_enabled: false,
  color_selected: '#FF0000',
  color_word: '#FFFF00',
  cell_size: 32,
  puzzle_file: {url: '/puzzles/puzzle1.jpz', type: 'jpz'}
};
CrosswordNexus.createCrossword($('#crossword'), params);

crosswordnexus / html5-crossword-solver