Save The Chocolate(s) Files

************************************ SAVE THE CHOCOLATE(S) : A PING PONG GAME *********************************************
****************************** CREATED BY DHRUV JAIN IN ASSOCIATION WITH ABHISHEK GUPTA ***********************************
********************** AN OPEN SOURCE FREE LICENSED DISTRIBUTION(OPENGL AND SOCKET PROGRAMMING) ***************************  



..... PRE REQUISITES .....
1. g++ compiler with the opengl library (preferably freeglut)
2. pthreads support in linux (generally available on most linux systems)
3. A running internet(Though the game would not add to your bill, since it uses very less bandwidth!)


....INSTALLATION....
No need for the installation. The game runs directly from the folder.



.....COMPILE.....
1.Go to SaveChocolate(s) directory using  
	#cd SaveChocolate\(s\)
2.and then make
	#make



.....RUN.....
Connect to the internet and put the terminal in the full screen mode.
The game requires a dedicated server. So first run the server in one terminal window using:
	#cd SaveChocolate\(s\)
	#cd server; make run

The various options for selecting the game parameters will be displayed. Following are the hints:
1. For the number of players, enter 1,2,4 or 4.
2. (Only for single player game) : The probability of failure of computer's AI paddle.(Range : 0 to 1; idle value = 0.7). 
3. For the number of balls, enter either 1 2 or 3. (idle value = 3)
4. For the difficulty level enter 1,2 or 3. (idle value = 2)

Once the server is on, open a NEW terminal on same/different computer(Ensure that the host computer is connected to its clients through LAN for best results) and run the following commands after switching the terminal to the full screen mode :
	#cd SaveChocolate\(s\) 
	#cd client; make run

The game WILL NOT RUN until the required number of clients have connected to the network (thourgh different terminals on same/different computers)

For best results keep only one client per system.



.... IN CASE OF TOO MANY SEGMENTATION FAULTS .... 
During the game you may notice that there are segmentation fault errors when you run the client. In that case re-run the server and then continue.
If it still persists then this is what you have to do,
	
	#cd SaveChocolate\(s\) 
	#make clean 

This would remove all the executables. Now re-compile and run the game (from the beginning).



.... ON GAME ....
The players compete with each other saving the chocolates (the balls) with the bar (the paddles) until their score reaches zero. After that they lose the game. The last player to remain wins.
#######Read the playing instructions for playing with mouse (and/or) Keyboard#######



....ALAS! FOR THOSE WHO LOSE THE GAME IN BETWEEN .....
If you lose the game and have nothing to do, you can CHAT WITH OTHER PLAYERS on the client terminal( The terminal displays the ongoing chat session). Just type in few words like How are you?, That guy plays real good etc. etc. to see it running!
NOTE : If you want to enjoy this feature don't forget to put the terminal(not the opengl window) in the fullscreen mode before you run the game. Otherwise, it won't be shown clearly.



FOR ENTHUSIASTICS : Send us a mail with the subject "I want to look into the game features" and we will send you the ways in which you can modify the game features which include :
1. Modifying the ball speed (to whichever you like).
2. Modifying the initial starting score (from 5 - 99).
3. To be able run the game WITHOUT internet(new!).
4. Modifying the colors of the game according to your own needs(theming). 
5. Modifying the paddle shape.
and many more ....


Lastly, feel free to report any bugs that you come across to the undersigned.







************************************************* DEVELOPERS SECTION ******************************************************
			Please read the terms and conditions carefully before you proceed.	


.....AUTOMATED TESTS....

Various test logs are provided in test_logs folder.
To run these tests:
1. First compile the code (see above).
2. open the client and server folders on the seperate terminal. 
3. See the makefiles in the client and server to run the appropriate test. 
	EXAMPLE : 
	#make 
	#cd server
	#make test1

	In other terminal
	#cd client
	#make test1	




.......LIMITATIONS AND BUGS...... 

1. Broken pipe errors are prominant due to extensive threads used.
2. The GUI needs to be improved a lot. 


YOU CAN REFER TO THE DESIGN DOCUMENTS (design_doc folder) FOR A DETAILED DESCRIPTION ON HOW THE GAME FUNCTIONS.


Additionally, If you think you can improve the game more, reduce any bugs, come forward  write to us and lend us a hand. If we liked your proposal, we may feature the enhanced game on our website.



.........................................................................................................................................
CONTACT : higherdefender@gmail.com (Please be patient, It may take 1-2 days to respond) 
copyrights@dhruvlab.com
.........................................................................................................................................