Organics Files

June 22nd, 2011
@SicklyBean

Okay so the new goal of the project is for increased organization and collaboration (although it was kind of the old goal too, I am just better at it now).
This means that all of the game files are being moved to sourceforge and that all changes to code and new things added should be done through something called SVN. I will explain the new system in steps.

1. What is on Sourceforge at the moment?
	-This README file
	-SVN repository which you can view online at http://organicsjava.svn.sourceforge.net/
	 It contains:
		All of the most current game code
		My current copies of the map files (files/maps)
		My current copies of the gamedata folder files (files/gamedata)
		Some documentation (documentation/) (includeing this file)
		*Not the resources folder (it contained troublesome files that messed up SVN)

2. Getting new code & Repository breakdown
If you don't want to go through the trouble of learning SVN (which I highly recommend but it can be tricky), then to get the new code you just have to go to the url: http://organicsjava.svn.sourceforge.net/viewvc/organicsjava/

All of the code is in sourcecode/

Other folders in repository
testcode/ is for new code that hasn't been implemented fully yet (Like the inventory)
documentation/ has all the documentation (Except JavaDocs) about the project
files/ has gamedata and maps, In your NetBeans project folder you should make a folder called files and put the folders gamedata, maps, and resources in it.
extrafiles/ this is for things like raw images, which should be taken out of resources. Also for raw tile uploads


3. What is SVN
SVN is a way for multiple people to access, modify, and control code.
It might be difficult to learn at first but it is actually really useful. At least learn how to use "svn checkout" and "svn update" (see below) so you can get the new version code.
For a brief introduction read given sections of the online ebook (its legal) http://svnbook.red-bean.com/en/1.5/index.html
Keep in mind the link to our SVN repository is https://organicsjava.svn.sourceforge.net/svnroot/organicsjava (This is different from the link to access online given above)
	You only need to read these parts in the ebook (and skip the parts that are overly thorough and technical)
		First two sections of http://svnbook.red-bean.com/en/1.5/svn.intro.whatis.html 
		http://svnbook.red-bean.com/en/1.5/svn.basic.repository.html
		http://svnbook.red-bean.com/en/1.5/svn.basic.in-action.html (Skim this page)
		http://svnbook.red-bean.com/en/1.5/svn.tour.initial.html (Just really the begining)
		http://svnbook.red-bean.com/en/1.5/svn.tour.cycle.html
You don't need to understand everything here since we don't really have to worry about merging or anything too intense. The main commands you should use are:

Commands to obtain code:

	svn checkout https://organicsjava.svn.sourceforge.net/svnroot/organicsjava src
		-Initially creates your working copy in a folder called src in whatever directory you are currently in

	svn update
		-makes sure you have the latest working copy

Commands to edit Repository:

	svn add "filename"
		-Adds the file "filename" to the SVN repository (it must already exist in your local working copy)
	
	svn delete "filename"
		-deletes the file "filename" from the SVN repository 
	
	svn mkdir "dirname"
		-creates the directory "dirname" within your local working copy and the SVN repository

	svn copy "oldname" "newname"
	svn move "oldname" "newname"

And most importantly

	svn commit -m "Your Comment Here"

NONE OF THESE CHANGES WILL BE MADE UNLESS YOU CALL COMMIT

Nothing is ever actually deleted 
Every single change every made is recorded and saved
When you call commit, the change you made will forever be tagged with the comment "Your Comment Here"