An Introduction to CrossFireCrossFire provides a simple but powerful single-window application for creating crossword puzzles.
- Starting Crossfire for the First Time
- Main Interface & Making Puzzles
- Additional Operations
- The CrossYYYs Applet
- Make sure that you are running Java 1.6 or later. The latest version of Java can always be downloaded from http://java.com/.
- Run the supplied installer. It will remind you if you forgot step (1).
- Make sure that you are running Java 1.6 or later. The latest version of Java should be available at http://java.com/.
- Unpack the supplied .tgz file in a location of your choosing.
- Run the supplied "crossfire" shell script.
Macintosh (OS X 10.4 & later)
- Unpack the CrossFire directory from the supplied .tgz file into a location of your choice.
- Double click on the resource bundle (also named CrossFire) inside that directory.
skip over it for now, and return to it at any time via the Help/Config menu item to customize CrossFire's behavior. You may well wish to keep them all (except perhaps for the dictionary files) at the default values in any case. WordNet distribution. While imperfect, it should be enough to get you started.
The dictionary list can contain an arbitrary number of files (though it must contain at least one). Files which are selected via the associated checkbox are considered "active", and the icon to the left of the checkbox indicates whether the file actually exists. When the dictionary is loaded, it will contain all the words from all of the active dictionaries. If a word is contained in multiple dictionaries, then the score and punctuation is taken from the top-most dictionary in which it occurs. This is the active definition, and any occurences in lower dictionaries are shadowed by this upper definition. Note that a dictionary file can specify a score of "0" for a word. If this is the active definition for the word, it will be eliminated from the dictionary, even if there are other shadowed definitions with non-zero scores.
One active dictionary file must be designated as the "primary" dictionary. This is the file into which newly added words are placed, and may also be used when words are edited. See Dictionary maintenance for more information.
If you have Gold subscription to the Cruciverb website, CrossFire makes it easy to get the most from its premium word-lists. Just select the default dictionary for now, and later you can choose the "Dictionary/Merge word list into dictionary" menu option, and specify "Use CrossFire score database" when importing the word lists.
(Note that if your private word list has accented or international characters, they must be in UTF-8 character encoding. If you are not sure about how your file is encoded, you should use the "Merge word list" capability, described below, which will perform appropriate conversions.)http://otsys.com/clue/, and provides comprehensive lists of clues which have been used in most of the top syndicated crosswords, as well as many independently published puzzles. (It provides its own useful external interface as well as being accessibly from within CrossFire.) You may leave this blank for now if you have not installed a clue DB.
- Min fill word score:
- Enter the minimum word score to be used in fills (either automatic "quick fills" or interactive fills via the fill tab). By excluding words in this manner you can guarantee that generated fills will have higher scores, but may it impossible to generate any fills at all. Much finer control may be gained through interactively filling the puzzle via the "Fill" tab.
- Longest shared substring:
- Enter the length of the "maximum shared substring" which may be introduced by the grid filler. If you use the default value of "3", this means that the auto-filler would allow "theater" and "IAteTheWholeThing" to exist in the same puzzle, but not "theater" and "preheats" (since the latter contains the common 4 letter substring "heat").
- Fill candididate quality:
- Set the fill candidate quality, which controls how thoroughly words are examined before added as candidates on the fill tab. The consequence of lowering this setting is faster fills, but poorer "Grid Score" estimates and the chance of more poor words slipping through. Raising the setting should give slower "candidate generation" but higher-quality fills.
- Web lookup URL:
- Set the URL used for the "Lookup word on web" command on various context menus. The default is Google, but you may enter any valid internet address here. Use "%s" to indicate where the search word should be substituted.
- Auto-select definitions when in clue tab:
- If selected, this allows you to immediately select a clue for typing by clicking on the corresponding word in the grid. Otherwise, the grid itself will remain selected for typing and you will have to select the clue using the mouse or CTRL-C.
- Show numbers in grid:
- This checkbox does just what you'd expect, but it's perhaps not obvious why you'd rather leave it unchecked. By not showing word numbers by default, CrossFire can show the fill letters more clearly and, more importantly, show detailed hints about upcoming possibilities during interactive fills. Regardless of whether you check the box, you can always find word numbers via rollover "tool tips".
- Auto-add complete cross words.
- This checkbox controls an important behavior in the fill tab. If left unchecked, you will be shown (and asked to enter) each word in the grid, even those which are filled "by side effect" as a result of filling all of the words which cross them. Many people consider this useful, since it means no words slip in by mistake. However, since it can mean extra work, you might wish to make CrossFire automatically enter these words for you by checking this box.
You will only have to specify these defaults once, but you can change them at any time you choose via the Edit/Config menu item.
If you prefer to create a new puzzle from scratch, simply specify the desired width and height, and a completely blank grid will be provided for you.
Summary, Words, Fill, Clues, Lookup, and Rebus. (The last two of these can be hidden, if desired, via checkboxes in the "tabs" menu. This might produce a less distracting display if you don't regularly use these tabs.)
To get started with the grid, you'll need just a few concepts:
- Put in black squares (blocks) by SHIFT-clicking or selecting squares and hitting PERIOD ('.').
- Select squares by clicking with the mouse or moving around with the arrow keys.
- Manually add letters by simply typing them in.
- Delete letters or black squares using BACKSPACE or DELETE.
However, it's worth realizing that there are actually three varieties of "selection" in the main grid.
- Square selection
- At any given time, there is a single square which is the primary focus of keyboard operations. It is indicated by a dark blue background. You can type new characters in at this location; erase them via the DELETE and BACKSPACE keys; or add new black squares by hitting the PERIOD ('.') key (or SHIFT-clicking). You can set the selection with the mouse, or move it around using the arrow keys. (Note, however, that the first time you hit an arrow key, may simply change the direction of the "word selection", as described below.)
- Word selection
- When the square selection is on a letter or a white space (i.e. a "word square", then CrossFire will typically focus on an entire word. The selected word will be the focus of operations in the other tabs, such as interactive filling, clue specification, or dictionary editing. Since two words usually cross on a word square, the selected word may be horizontal or vertical. Crossfire shows you which one is currently selected by highlighting the squares in light blue. You can change from horizontal or vertical (and vice versa) by clicking the mouse on the square selection, by hitting the TAB key, or by pressing an arrow key which is perpendicular to the current word direction.
- Area selection
- On occasion you will wish to select arbitrary sections of the grid as the focus of certain operations. These "area selections" are created by clicking and dragging, and are highlighted in a light purple. Existing selections can be extended by holding down the CTRL key (ALT on Macintosh) while dragging. When there is an area selection, the "quick fill", "clear letters", and "clear grid" operations are all restricted to the selected area, as is interactive grid filling. In addition the DELETE key becomes enhanced: if the selection contains non-THEME letters, then only the letters in the selection will be deleted. Otherwise, the theme letters and black squares will be cleared. (It's actually fairly intuitive in practice. One DELETE clears minor stuff, while two clears everything.)
You can click on any of the word counts or letter counts in order to highlight the appropriate words/letters in the grid. The selected count will remain selected until you specify a different one or click on it again to unselect it. The highlighting, like the counts themselves, will be dynamically updated anytime the grid changes.
The Summary tab also contains a "Puzzle Info" panel in which you can enter title, author, and copyright information about the puzzle. Not only is this generally useful information, but it is required if you wish to export the puzzle in Across Lite format. (It will also be used when you print the complete puzzle, export it as an image, or export it for NYT publication.)
You can also highlight one or more words and press ctrl-E (or select Dictionary/Edit Selected Words) to update the scores or spellings within your dictionaries (see Dictionary Maintenance below). Alternatively you can right-click any word in the list to bring up a menu allowing you to see a clue list, edit the word, or look the word up on the web.
The words tab may also be used to search for shared substrings between different words in the puzzle. If you specify "Highlight shared strings" in the selector at the bottom of the panel, CrossFire will use orange letters to show parts of words which are the same as portions of other words. If you select those words, these shared substrings will be highlighted in light green. If you instead specify "Show shared strings", then the list will be restricted to only words which have shared letters. This lets you quickly scan through such words and determine whether any of them are troublesome. If you don't want to be bothered with any of this information, simply specify "at least 99 letters long", and you should never see any such highlighting. (Note that the threshold for highlighting is independent of the "config" option for "maximum shared substring". You often, for example, wish to allow 3 letter substrings, and yet be able to look them over to be sure that you haven't accidentally slipped in effectively equivalent words such as "ended" and "ending".)
Whenever the selected word is incomplete, the fill tab will provide a list of possible words to fill that space. This list will be filled incrementally, including only words which have a high likelihood of leading to successful puzzle fills. Furthermore, CrossFire will continue examining the words, removing those which don't lead to successful fills, and marking in bold those which have been proven to lead to successful fills. (Note that by selecting the "Fill/Show eliminated candidates" menu option you can disable the deletion of unsuccessful fills. Some constructors find this handy if they wish to try hand-filling with words that aren't in their dictionaries. Others merely find it distracting.)
Within the word list, you can examine several different scores:
- Word Score: dictionary-assigned score for a word.
- Grid Score: measure of the quality of the neighborhood immediately around the word. Generally any value over 0.9 indicates a pretty good word, while lower values are generally going to lead to bad fill values in the near future.
- Final Score: measures the quality of a complete grid fill created with this word. (This value is relative to that of the first fill found. Thus, typically one fill will be at "1" and others will be slightly more or less than 1.)
Whenever you select a potential fill word, you will see that word in the grid. You will be typically be shown other information, depending on the setting of the "Fill/Show Sample Fill" and "Fill/Show Possible Letters" menu items, as follows:
- If "Show Sample Fill" is selected and there is a known fill for the word, that fill will be shown in light gray. (Typically, there is no guarantee that this will be the best fill. However, if the space being filled is a small corner [10 words or fewer], CrossFire will go back and take the extra time to find the best solution [according to its criteria]. Such optimal solutions will have their scores highlighted in bold face.)
- If "Show Possible Letters" is set to "Always", then forced letters will be shown in a darker gray, and squares which are limited to sets of 2-9 possible letters will show those possibilities in miniature form. (This will give you a "quick glance" impression of how the succeeding words will be constrained.) This will happen whether or not there is a known fill for the grid.
- If "Show Possible Letters" is set to "When forced", then forced letters will be shown in dark gray, as above, but other possible letters will only be shown if there is no known fill for the grid. (This keeps the possible letters from obscuring the potential fill.)
- If "Show Possible Letters" is set to "Never", then neither forced nor possible letters will ever be shown.
Simply double-click or hit "RETURN" after selecting a word to enter it into the grid. You may also bring up the right-click context menu for any word and select the "Insert Word in Grid" option. In addition, if the word is highlighted as "definitely fillable", you will have the option to "Insert Complete Fill".
Note that you can freely enter any of the words from the list, whether confirmed or not, without waiting for the evaluation to finish. You don't have to worry about making a wrong choice -- if you don't like the consequences of a selection, you can simply "undo" that word choice and go back to where you started. All of the original words and evaluations are remembered, so you won't have to wait for it to redo all of its work. In addition, the paths you have "visited" are marked in a light brown so that you can remember which ones you've already tried. If you particularly like or dislike one of the words that you've tried, you can use the context menu to mark it as "good" or "bad", and it will be highlighted in green or red.
After you select a fill word, the filler will automatically select another space to be filled. If you don't like that space, you can simply select any spot on the grid you like, and the filler will switch to that word. You can also, at any time, hit the "Best Location" button to have the filler choose a constrained word which will give the most "bang for the buck" in the filling process.
If you already have some idea what sort of word you wish to put into a space -- for example you know that you want the word to end in "ing" -- you can specify a regular expression in the "Filter" box. (A value of "ing$" would select for only ING endings.) The filler will then limit itself to just matching words, so that you can concentrate on what you want.
As described in the Puzzle Grid section, you may also drag the mouse over just a section of the puzzle to select that region. If you do this while in the Fill tab, the checks for "complete" fills and display of candidate words will only include the selected squares (and other squares required to complete words within the selection). For difficult Saturday-level grids, this may help make the filling process more manageable. If you find yourself needing to select a particular square within the selected region, you can use CTRL-click.
If you have connected to a clue database, then there will be a panel at the bottom of the Clues tab which lists all known clues for whichever word is selected. You can use this to help you in your own clue selection. If you find the clue list to be distracting, you can hide it by selecting the arrows on the divider bar. In order to automatically use one of the clues shown, just double-click on it, and it will be inserted. (Note: Some puzzle editors have expressed displeasure with constructors who re-use existing clues rather then generating new and original clues for themselves. You shouldn't use the clue panel as a substitute for creativity if you want your puzzles to get published.)
While working in the clue-editing panel, you can also right-click a word to see a menu allowing you to edit the word, or look the word up on the web.
Note that, since the pattern is an arbitrary regular expression, you can not only type "foo" to look for any word containing those three characters but also (for example) "b[aeiou]+k[aeiou]+s" to find words with one or more vowels separating the letters "b", "k", and "s". (This will find "bakes", "bookies", and "Uzbekistani".) Remember that because CrossFire's uses regular expressions instead of "globbing" matches, the * and ? wild cards may be different than what you are used to. (Basically, you will end up using ".*" and ".?" where other systems might have you use "*" and "?". This can be confusing at first, but is a lot more powerful. See below for more information.)
By default, the search is performed on the "crunched" form of the dictionary entry, which has been reduced to only lower case alphabetic letters, so you should always enter your search in lower case, without spaces. However, you can change this in the "Content:" box, as follows:
- Lower case letters
- The "crunched" form described above.
- Lower case word(s) with punctuation
- All words will be folded to lower case, but all spaces and punctuation marks will be retained just as they appear in the dictionary.
- Original word(s) with punctuation
- All words will be treated exactly as they appear in the dictionary.
|.||matches any 1 valid character|
(similar to MS-Win file search ? wild card)
|c.t finds both cat andcot|
|.*||matches any character zero or more times|
(similar to MS-Win file search * wild card)
|fl.*rt finds flirt,flaubert & flowchart|
|[ ]||matches any 1 of the bracketed characters||sh[ou]t finds shot & shut but not shout|
|^||^ 1st in a pattern anchors it to the start||^en finds enter but notcenter|
|[^]||bracketed ^ means "anything but"||[^aeiou] finds any consonant|
|$||$ last in a pattern anchors it to the end||en$ finds even but notevent|
|(|)||separate alternatives with | to find either||gr(ai|ee)n finds both green & grain|
|-||use - to find any 1 of a range of letters||ta[m-p] finds tam, tan, tao &tap|
|+||matches preceding element 1 or more times||ab+a finds aba abba but notaa|
|?||matches preceding element zero or 1 time||tame?s finds both tames &tams|
|*||matches preceding element zero or more times||pal* finds pa pal &pall|
|\b||matches zero characters, but only
if at a word boundary|
|\bit\b finds make it so but not pitfall|
You can read more on regular expressions at http://perldoc.perl.org/perlre.html#Regular-Expressions
In other words, everything should just work for you without any effort on your part.
For any new puzzle, the Rebus panel will start effectively empty. There will be an unpopulated table, and an "Add" button at the bottom. If you press the "Add" button, you will be asked to specify the letter sequence that should be treated as a single letter (i.e. "star" above), and a letter which users will use to enter the answer into an interactive application (such as Across Lite or CrossYYYs). If you simply hit return, CrossFire will fill in the "User equivalent" with the first of the substituted letters, but you can choose any other value you like.
When you hit "OK" to add the new rebus, it will show the letters and the user equivalent, but it will also potentially show an additional character that can be used to enter the rebus into the CrossFire grid. (The User Equivalent won't work because it is not unique. However "@", for example, would be.) There will also be a "+" button that can be used to enter the rebus into the currently selected square. Finally, the table entry will include a red "X" button which allows you to remove the rebus.
If you add "star" as a rebus using the above method and insert it into the grid using either the assigned insertion character or the "+" button, it will be displayed as a set of small letters centered in the square. If you move your mouse over the square, the rollover "tool-tip" will show possible insertion words which include the "expanded" form, and display clues based upon that expanded form. You can keep adding rebus strings to the table in this manner, up to a maximum of 100. (This arbitrary limit corresponds to the maximum number of rebuses which can be stored in a binary Across Lite file. If you are going to be saving to an Across Lite "text" file, you should actually limit yourself to 10 rebuses. As of this time of writing, we have never seen more than 50 rebuses in a single published puzzle, but there is undoubtedly a more complex example out there somewhere.)
In order to mark a word as a theme entry, simply select it and then choose Grid/Mark Selected Word as Theme (or simply hit CTRL-T). The word will now be rendered in purple, and will be protected as described above. Theme entries are also rendered in bold face in the "Words" and "Clues" tabs.
If a fill attempt fails, the region of the grid where quick-fill got bogged down will be shown highlighted in red. Note that this is an approximate indication of the failure area, and may not highlight just the single problem word. (In particular, due to the "lookahead" performed by the search algorithm, it is actually more likely to highlight a word which crosses the single "bad" word than the word itself. However, in most interesting cases there simply is no one single word which is the source of a failed fill.) Remember that if a grid word leads to a dead end and has no candidate fills, that word will be pre-emptively highlighted in pink even before you try to do a fill.
Typically the quick fill tries to fill the entire grid, since typical crossword grids are fully connected. However, the quick filler actually examines the grid and potentially divides it up into isolated unfilled "neighborhoods". If there are indeed multiple non-connected neighborhoods, it will always fill just the one closest to the selected square. Further clicks of the quick fill button will fill the remaining unfilled neighborhoods, since one of them will now be the "closest".
As mentioned earlier, you can get even more control over the area to be filled by explicitly dragging the mouse to create "area selections". If there is such a selection, the fill will be restricted to that area. (In fact, it will go outside that area enough to confirm that the unselected portions of partially selected words are fillable, but those unselected portions won't end up in the inserted fill.) Some users find that they prefer to fill the puzzle one section at a time by using this form of restricted fill. (As mentioned before, we suggest that you consider using interactive fill instead, and explicitly moving to whatever area you consider critical at any given time. However, it's your puzzle, and you will undoubtedly do things your way.)
At almost any point within CrossFire, you can hit CTRL-E (or select "Edit Word(s)" from a context menu) to bring up the "Edit Words" dialog. Though simple in principle, this dialog actually provides an enormously powerful tool for selectively updating any or all of your dictionary files. (Note: If the explanation seems too confusing, you can just ignore the next few paragraphs and trust that your edits will do the right thing by default and will be made permanent when you invoke the "File/Save dictionary" function.)
For each word, you are given the option to change the word's score or its "punctuation" (i.e. the capitalization, and extraneous non-letter characters such as spaces, periods and dashes). If you hit the "Next" button, the following happens by default:
- If you changed nothing, than no dictionary file will be changed.
- If the "primary" dictionary is above the first dictionary which defines the changed word, then the word will be added to the primary dictionary, which will also have the effect of changing the internal dictionary.
- Otherwise, the change is applied to the first dictionary which defines the word, which will once again have the effect of changing the internal dictionary.
By pressing the "Advanced" button, you can expand the dialog to get increased control over the changes to the dictionary. You will be shown a list of all dictionaries, with "Change" checkboxes for each dictionary, and "Delete" checkboxes only for the dictionaries that currently contain definitions for the word. You can check all, some, or none of the "Change" boxes, and the appropriate dictionary files will be changed when you hit "Next". If you hit a "Delete" box, the word will be removed entirely from that dictionary. (Note that, if you don't explicitly check any boxes, they will be automatically selected in such a way as to preserve the default behavior described above. This sub-panel is a way to enhance the default behavior, rather than a replacement for it.)
Note that if you explicitly manipulate the selected dictionaries so that changes are applied only to dictionaries which are below the one that provides the "active" definition, then the changes will be "shadowed" in the internal dictionary and won't have any visible effect. However, the appropriate files will still be affected, and the changes may later become visible if you remove or re-order some of the dictionary files.
Note that there are two varieties of word "deletion" that you can perform. If you set a word's score to "0" in the topmost defining dictionary, the word will not be included, even if it has non-zero scores in other "shadowed" dictionaries. Alternatively, you can use the "Edit words" dialog to actually remove the word from the dictionary files. In this case, the score and punctuation will be taken from any lower dictionaries that might previously have been shadowed. If you remove the word from all dictionaries, it will of course be totall gone.
You can add new words through the "Add new word(s)" menu item. This will show you a dialog very similar to the "Edit Words" dialog described above. However, you will be given the chance to freely type whatever words you want, and specify the desired score for each word. (Specified scores will be carried from word to word in order to make it easy to keep the same score for all additions.) The specified words need not, in fact, be new: if they already exist, they will be handled exactly as if you were editing them with the "edit words" dialog, except that they won't automatically inherit the existing score.
If you wish to do a large bulk addition of words, specify per-word scores, or merge several word lists, you can use the "Merge word list into dictionary" operation. (If you don't wish to include the contents of the current dictionary, simply invoke "Clear current dictionary" first. Ignore the pink "no available word" grid highlighting. It'll go away.) This dialog gives you extensive options to control the scores to be used for the incoming words, and the proper way to handle words which are contained in multiple lists. They should, for the most part, be self explanatory.
One interesting option is "Use CrossFire score database". CrossFire is shipped with knowledge of the relative common-ness of various words (gleaned from analysis of large amounts real-world usage). It can apply this knowledge to external word lists, and in particular to the word lists made available to Gold Members of Cruciverb.com. This can make it much easier to get maximum utility from these lists. (Note that we can not provide you with these lists ourselves, since they are owned by other parties, nor can you "reverse engineer" the lists from the CrossFire database.)
Another advantage to using the "Merge word list" operation is that it will take extra care to make sure that international characters are interpreted correctly. This is a tricky issue, since there is no single encoding which is used everywhere. CrossFire uses the UTF-8 encoding, which is quite versatile, but some source may use the Window ("ISO-8859-1") encoding instead. The merge operation will detect which of these encodings the input file uses and interpret it appropriately.
For many users, all you will ever need is the "Export as Across Lite" option. Across Lite is a standard format, and the solving application of choice for Windows users. There are also versions available for Macintosh and Linux, as well as third-party substitutes. (It is, of course, also fully supported by the CrossYYYs on-line applet which is distribued with CrossFire.) These will support printing, solving, and distribution. Typically, you would wish to export directly to Binary format, which is what most people use. However, if you wish to add special features, such as notepad entries, you can export in the Text format and then modify it as needed before using Across Lite to convert it to Binary form.
Exporting as "Grid Image", "Solution Image", or "Puzzle Image" all produce portable PNG image files. These are lossless and widely supported by all drawing tools and web browsers. For the first two forms, you specify the size of each individual square (in pixels), while the last form asks you to specify the overall dimensions of the entire page. (Appropriate font sizes and grid sizes will automatically be chosen to provided a pleasing page layout for the complete puzzle image.)
Exporting "Numbers, Words & Clues" produces a basic tab-delimited text file. It contains all of the answer information for the puzzle in a convenient from for "do it yourself-ers" to manipulate as needed for publication.
The Print sub-menu allows you to send all of the graphical images described above to a printer. However, instead of asking you to explicitly specify dimensions, CrossFire scales them to the paper size specified by the printer.
The print menu also privides a "NYT submission" option. This prints out the puzzle in a format which should conform in all particulars to the standards set by Will Shortz for submission to the New York Times. You will be asked to specify your postal and e-mail addresses for inclusion in the print-out, and CrossFire will do almost everything else for you. (Stamps and envelope not included.) The address info will be remembered from session to session. You can also override it by including your address info in the "Copyright" field, with the lines separated by "*"s. (This may seem odd, but it provides backwards compatibility with Alex Boisvert's conversion utility, which provided inspiration for this capability.)
Due to technical issues, CrossFire does not give you the capability to export to acrobat format. However, a good PDF printer driver can produce very high quality PDF files. For Windows, we have gotten excellent results from PDF995. Macintosh users can simply select "print to PDF" from the print dialog. Linux users might wish to check out cups-pdf.
- crtl-C -- Edit clue for selected word
- ctrl-E -- Edit dictionary
- ctrl-F -- Start & stop quick fill
- ctrl-G -- Clear all/selected spaces, thems andblocks included
- ctrl-L -- Clear all/selected (non-theme) letters from entire grid
- ctrl-N -- Open new puzzle file
- ctrl-O -- Toggle circle in selected square
- ctrl-S -- Save a puzzle file
- ctrl-T -- (un)Mark a word as a theme entry
- ctrl-Z -- Undo fill or block modifications
- ctrl-Y -- Redo fill or block modifications
There are a number of different applets in use today. Most of them are associated with a single file format and seem to be designed to provide an adequate experience for users who don't want to bother downloading the file to a full-featured application. CrossYYYs strives to actually incorporate as much of the full-fledged desktop experience into the web-browser as possible. In particular, it provides:
- Support for Across Lite format, so that your on-line and downloadable versions can be the same.
- Direct printing capabilities.
- Persistent user options saved via cookies.
- Maximized readability at any size.
- Extremely versatile display of long clues and titles.
- Extensive testing for cross-browser/java-version compatibility.
DeploymentIn order to use it, you will need three things:
- Your puzzle. This can be in PUZ, JPZ, CFP or Across Lite TXT format.
- A copy of "CrossYYYsApplet.jar" file (which you will find in the top level directory of your CrossFire distribution). Because of Java security restrictions, you will have to make a copy and serve it from the same web site as the puzzle. (You only need one copy per site, of course, not one per puzzle.) We give you permission to make as many copies as you like. Just don't make any modifications.
- An HTML file which tells how to display the puzzle using the applet.
The basic code that you need to include in your HTML file is the following:
<applet MAYSCRIPT code="CrossYYYs" codebase="." archive="http://yoursite.com/CrossYYYsApplet.jar" height="402" width="600"> <param name="puzzle" value="http://yoursite.com/YourPuzzle.puz"> Arbitrary HTML code to be displayed if the user doesn't have Java installed. </applet>
Because this may seem fairly obscure, we'll go through it line-by line to let you know what you are getting into:
- Must be the exact string "CrossYYYs".
- Tells where, relative to this webpage, you put the JAR file. If you put it in the same directory, you can specify ".", or just omit the field entirely.
- Specifies the exact name of the jar file. You can rename the file arbitrarily, as long as you adjust the ARCHIVE field to match.
- The horizontal space devoted to the applet. Can be any value you like, but must be present.
- The vertical space devoted to the applet. Can be any value you like, but must be present.
- <PARAM name="puzzle" value="...">
- The "..." should be replaced with the location of the puzzle, relative to this web page. The file can be a PUZ, JPZ, Across Lite TXT, or CFP file, though we expect that most folks will stick with PUZ.
If you want a bit more control, there are a few more parameters that you can specify. However, you won't need to -- the applet will look and function just fine without any of them.
- If set to "true" (or any other value which isn't "false") then the applet will use 24x24 icons instead of 16x16. They'll be much more readable, but take up valuable screen real-estate.
- If set to "true", then the clues will be shown in a single column on the left instead of being split between across and down clues. In our opinion, this is less readable, but if you are desperate to reduce size, this is your best bet.
- This option forces the squares in the grid to be a specific designated size (in pixels). If there is not room to display the whole grid along with the clues, then scroll-bars will be added.
- This option forces the clue column(s) to have a specific designated size (in pixels). If there is insufficient room to show the grid at a reasonable (or the designated) size, then scroll-bars will be added to the grid. If the given value would require more space than is available in the applet, it will be ignored.
- This specifies what font will be used for letters within the grid. The default (which is a generic sans-serif font) works just fine, but if you want a bit of variety you can have fun with "Comic Sans MS" or "Courier". If the font isn't found on the user's machine, CrossYYYs will fall back to the default.
- This states whether, barring user preferences, the timer should start as soon as the user selects the puzzle. It defaults to false. If the user has specified a preference, it still always takes priority.
- If true, this switch re-organizes the display so that clues are on the bottom. It's uglier in general, but may be useful if you have to put your puzzle into a particularly constrained space. It defaults to false.
- If true, this switch hides all buttons which might allow the user to ask for answers. It's especially useful if you have an encrypted puzzle in which answers aren't available anyway. It defaults to false.
- If true, this switch causes CrossYYYs to use an OS independent Java look-and-feel rather than trying to match the machine's native look and feel. It's generally uglier, but some people might like it, and it makes it a bit easier to know exactly what a puzzle will look like in everyone's browser. It defaults to false.
- If set (to a hexidecimal color, such as "#ccddff"), this option also sets "genericGUI" to true. It also causes CrossYYYs to try to make various parts of the interface match the specified background color -- thus giving the app a more integrated, invisible look.
- If specified, highlightColor and errorColor specify the exact (hexadecimal) color values to be used for the selected square and for the text of an incorrect letter, respectively. From these values, it also automatically finds compatible values for word selections, clue highlights, cross-clue highlights and corrected mistakes. Thus, you can set the general color scheme of the puzzle, but CrossYYYs still steps in to make sure that it can maintain the proper level of contrast between different elements.