Code Master Files

================================================================================
---              __  ___  ____  ___  _  _  ___  ________ ___ ___             ---
---             / _|/ _ \|  _ \|  _|| \/ |/ _ \/ _/_   _|  _| _ \            ---
---            | (_| (_) | |_) |  _||    |  _  \_ \ | | |  _|   /            ---
---             \__|\___/|____/|___||_\/_|_| |_/__/ |_| |___|_\_\            ---
---                                                                          ---
================================================================================

NAME------:  Code Master
VERSION...:  2015.3.23
INTERFACE.:  GUI
URL.......:  http://code-master.sourceforge.net/
AUTHOR....:  PCGuyIV
AUTHOR URL:  http://pcguyiv.users.sourceforge.net/
LICENSE...:  GNU General Public License version 3 (GPLv3)

Copyright (C) 2014 - PCGuyIV

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program.  If not, see <http://www.gnu.org/licenses/>.

PACKAGE CONTENTS:
================================================================================
FILENAME                      | DESCRIPTION
--------------------------------------------------------------------------------
README.txt                    | This file.
license.txt                   | The GNU GPLv3
CodeMaster.jar                | The program, itself.
code_master.ico               | Icon file for shortcuts
sourcecode                    | Folder containing sourcecode
    codemaster                | Folder containing sourcecode
        CodeMaster.java       | The main program sourcecode (CodeMaster class)
        Code.java             | The sourcecode for generating and manipulating
                              |   the secret code and guesses submitted by the
                              |   user (Code class)
        package_info.java     | Javadoc information about the program
        codemaster.png        | Window icon
        images                | Folder containing images
            package_info.java | JavaDoc information about the images
            backspace.png     | Backspace button icon
            close.png         | Exit button icon
            erase.png         | Clear button icon
            newgame.png       | New Game button icon
================================================================================

CHANGES SINCE 2014.10.20-patch-1
- Switched to letters instead of numbers.
- Changed buttons without standard characters to images for compatibilty issues.
- Rearranged button order to accomodate letters.

CHANGES SINCE 2014.10.20
- Corrected minor issues when running under Windows

CHANGES SINCE 2014.10.4
- Added game settings as follows:
  - Code Length (3, 4, 5, or 6 Digits - Default is 4)
  - Digit Range (0-3, 0-5, 0-7, 0-9, 1-3, 1-5, 1-7, or 1-9 - Default is 0-5)
  - Number of Guesses (5, 8, 10, 12, or 15 - Default is 10)
- Added Settings Reset feature
- Added mouse-friendly keypad with Backspace, Clear, New Game, and Exit
  buttons.
- Removed per-turn "OK" buttons in favor of on OK button on the keypad

CHANGES SINCE 2014.10.1
- Changed the way that the game panels are generated to allow for more dynamic
  creation. This will allow for changing the number of turns to increase or
  decrease difficulty in future versions.
- Reserialized the main class. Future variants will be built on this version
  only.
- Set Javadoc information for all classes and functions
- Completely rewrote game logic for comparing the user's guess against the
  secret code.
- Changed code display routines to be based on the length of the code to allow
  for changing the length of the secret code in future versions.

CHANGES SINCE 2014.9.15
- Corrected another issue causing incorrect comparison results.
- Changed New Game shortcut key to ALT+N.
- Changed About shortcut key to ALT+A.
- Removed underscore from jar file name.

CHANGES SINCE 2014.9.14
- Corrected logic error that produced incorrect results when comparing user's
  guess with secret code.
- Changed Rules menu to respont to F1 rather than ALT+F1
- Built on Java 1.7.65 rather than Java 1.8.0, for more universal portability.

CHANGES SINCE 2014.9.13
- Switched to GUI instead of CLI

ABOUT THE GAME:
This game is similar to Mastermind. The computer generates a random code that
the user must then guess within a specified number of turns. If the user does
not guess the code correctly, the user's guess is compared to the secret code.
A result is returned that signifies how many characters the user guessed
correctly (right value, right spot), and how many characters the user guessed
that are in the code, but not in the correct spot. For example, If the secret
code is 4201, and the user guesses 2501, the computer will provide a result of
"O O X -", which means that 2 characters from the user's guess (the 0 and the
1) match the secret code exactly, a third digit (the 2) is in the code but not
in the correct spot, and the fourth digit (the 5) is completely wrong.
Naturally, the user will not know exactly which digits are correct, in the
code, or completely wrong. The game is over when the user successfully guesses
the secret code or runs out of turns.

TO PLAY THE GAME:
- Double-click on CodeMaster.jar to start the program.