tgluis / challenge-1 Goto Github PK

------------------------------------------------------------------------
              CHALLENGE - CLASSIC MINIGAMES
------------------------------------------------------------------------

The "Challenge" project is a little project who is made by some students
of the UCL (Universite Catholique de Louvain) in Belgium. We began this 
project to train us in the long way of the java programmation. 
So the project was basically created for fun and learning.

Currently, the project contains four differents games.
First one is a Hangman Game which is fully functionnal with one and 
two players modes. A french dictionnary is currently present for single
player mode.
Second is a HighLow game. The principe is really simple, you need to find
a number automatically taked by the computer (or by a friend).
Third is a Mastermind game. With 3 difficulty mode, rediscover the joy
of this classic game !
Fourth is a connect 4 game with 1 and 2 players mode too, like the others.
However the project is still in development and we will add some other games.

You can help if you want but remember that we work on this project only
for fun, don't take it too seriously.

------------------------------------------------------------------------
                     TECHNICAL DETAILS
------------------------------------------------------------------------

PROJECT TITLE: Challenge - Classics games
PURPOSE OF PROJECT: Create little games for fun :D
VERSION or DATE: 1.0 gamma
LANGUAGE : FRENCH - ENGLISH (still in translating)
LAUNCH CONDITION : The game DON'T have a gui (graphical user interface).
                   You need to open it in a terminal

THE GREAT INQUISITOR: vinsifroid
THE FINDER OF CLUES: Bivisi
THE MASTER OF THE DICTIONNARY: melvinmajor
OCCASIONNAL CONTRIBUTOR : Lazyboy007
*** THE MUSE *** : OrvalInspiration

------------------------------------------------------------------------
                	HOW TO START THIS PROJECT
------------------------------------------------------------------------

USER INSTRUCTIONS:
1.) Download all files of the project.
  Begin by downloading all the files of the project. 
  You have 2 options :
    - Download the most recent source code. It contains the most advanced features of the games but there is a risk of bugs
    - Download the source code from one of the few releases of the program. They are considered as "stable version" 
      and they contains (most likely) not any bugs
2.) Unzip the Archive in the folder of your choice
  tip : in versions after the release 1.0 gamma, you need to create yourself a folder named "saves" in the current folder. 
        We gonna try to fix this in the future.
3.) Compile the source on your computer.
  To do that, use the command : javac "filename"
    Windows Users : open a cmd windows (execute -> cmd) and go to the installation folder with "cd "pathname" " command.
    Linux Users : open the terminal with ctrl+t and tape the command
    Compilate all the .java files, NOT the others !
4.) Launch and enjoy the different games ! :D
  When you're done, execute the command "java challenge.java" to launch the program and enjoy !

------------------------------------------------------------------------
                 	LIST OF AVAILABLE GAMES
------------------------------------------------------------------------

Here is the list of all current available games:
1.) Pendu (= Hangman).
2.) Plus ou moins (= Highlow).
3.) MasterMind
4.) Puissance 4 (Connect 4)