jrw972 / boxofrocks Goto Github PK

BoxOfRocks v1.0a - FINAL
README
BoxOfRocks is Copyright (C) 2007 Jason Schindler and released under the GNU 
General Public License.  To view the GNU GPL, please see 'gpl.txt' included 
with the source, or visit: http://www.gnu.org/licenses/gpl.txt 

====
Table of Contents:
====
1 - About

2 - Use

3 - Development Environment
----


====
1 - About
====
BoxOfRocks is a silly little Java program that has allowed me to dive deeply
into the depths of object oriented programming.  Basically it consists of a
community of rocks that communicate with each other and share information.

So BoxOfRocks gives you the opportunity to interact with a number of other
rocks and share information with them.  Currently, you can only interact
with computer rocks or "bot rocks."  For the final version, I hope to build
a server environment that will allow you to share information with rocks
that other people have created. -- And I did.  Go me.  It has a GUI too...
Enjoy!

----

====
2 - Use
====
You should find "start-server.bat" and "start-client.bat" files in the root of 
your crisp new BoxOfRocks folder.  If you execute them, it should start the 
program right up.

Once you start the program, you will need to create a new rock. Then, you 
will need to type in an IP for a BoxOfRocks server.  It defaults to localhost.
If you don't have a server available, just start up the provided server and 
enter a blank for the IP address.  After that, you will be presented with a 
series of menus that allow you to move around the "Rock Garden" and interact 
with fellow rocks.

====
3 - Development Environment
====
BoxOfRocks was built with the following tools:

Arch Linux 0.8				-	http://www.archlinux.org
Java Development Kit 1.6.0_01/1.5.0_10  -	http://java.sun.com
Eclipse SDK 3.2.2			-	http://www.eclipse.org
----

Please read 'gpl.txt' for information about distribution and license.