Your Game Title
===============

Entry in Pyggy July 2011  <http://pyggy.pyweek.org/1012/>
Team: Gumm And Hisself
Members: Solo entry by Gummbum


DEPENDENCIES:

You might need to install some of these before running the game:

  Python:     http://www.python.org/
  PyGame:     http://www.pygame.org/



RUNNING THE GAME:

On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.

Otherwise open a terminal / console and "cd" to the game directory and run:

  python run_game.py

To run the game in a console with debugging output:

  python run_game_debug.py



HOW TO PLAY THE GAME:

The game can be played with a combination of mouse and keyboard.

When the game starts, some buttons appear on the right side. These buttons are
always available.

It might be worthwhile to let the game run through its tips and credits messages
the first time. This is done quickly the first time, and then less frequently.

The buttons:

  The button labeled "Normal" cycles the game's difficulty. Other choices are
  "Hard" and "Insane". These represent word lists of increasing size and
  obscurity.

  Buttons labeled "Play ..." offer games that vary in random selection. For
  example, 3-4 chooses a four-letter word and all its three- and four-letter
  variations. 3-7 chooses a seven-letter word and all variations of length three
  through seven (potentially many more words to solve).

  The "Solve" button will flip all unsolved words.

  The "Replay" button will start a new game with of the previous game type.

Playing the game:

  Clicking a "Play ..." button starts a word game. A list of words are randomly
  chosen, and their blank flipcards are displayed in rows and columns. The
  combination of letters that can be used to guess the hidden words is displayed
  near the bottom of the screen, as well as some new buttons to manipulate the
  letters.

  Clicking one of the letters raises it above the others. Click multiple letters
  to make words. Click the "Enter" button to submit a guess. If the guessed word
  matches one of the hidden words, the flipcard will be turned to display the
  word.

  Left-clicking a blank flipcard will reveal one of its letters. Successive
  clicks will reveal additional letters.

  Right-clicking a blank flipcard will reveal the entire word.

  Once a word is revealed, clicking the flipcard will look up its definition and
  display it on screen in a simple text pager. The pager provides hints on its
  operation. Pressing the Escape key or clicking in the pager will close it. (In
  some cases the word lists will contain obscure words that do not exist in the
  dictionary. When this happens as tip will appear in the game's message area.)

  There are a number of keyboard shortcuts available:

    Build words with ALPHABET keys.
    Submit a guess with ENTER key.
    Undo a letter with BACKSPACE key.
    Clear letters with ESCAPE key.
    Shuffle letters with SPACE key.
    Replay the last game with UP or DOWN key.
    Quit the game with SHIFT-ESCAPE.

Advanced options:

  Opening a console window and running the following command displays help
  text.

    run_game_debug.py -help

    usage: run_game.py [-normal|-hard|-insane] [-fullscreen] [-size WxH]
      [-speed n] [-background|-nobackground] [-help]

        -help                           this text
        -fullscreen                     use fullscreen display (default window)
        -background | -nobackground     run background (default -background)
        -normal | -hard | -insane       optional dictionaries (default -normal)
        -size WxH                       window/screen resolution (default 800x600)
        -speed n                        max FPS; recommend 60-120 (default 120)
        -word text min_len max_len      specify a word at startup

    Examples:
      run_game.py -insane -word paeitsr 3 7  # 424 words =)



LICENSE:

Vocab Extreme is GPL3.
Moby word lists use a custom license. See data/text/mword10.zip for details.
StarDict is GPL3.
pystardict is GPL3.
Gummworld2 is LGPL3.
Buttons from buttongenerator.com require web site attribution.
Button from freebuttons.com appear to be public domain.

Sincere effort has been made to comply with the various license constraints. If
any error has been made, please notify the author of Vocab Extreme.
