---------------------------------------------------------------------
Source Code Readme.txt for NnCTF and OpenMod
Document By: David "VicViper" Ludwig (davidl@captured.com
http://www.captured.com/nonamectf
---------------------------------------------------------------------

For the moment, the readme.txt files for the source code releases of OpenMod
and NnCTF are the same.  This is because the information I felt needed to be
contained in both files was so identical that it would be silly not to do it
this way.  Please note, NnCTF, and soon OpenMod, will have their separate
respective files.

Anyhoo, NnCTF is a perfectly good example of OpenMod stuff *FOR THE TIME
BEING*.  Once OpenMod is a little more stable, I will create a totally
separate "example" package which shows how easily OpenMod stuff can be
created.  In the meantime, if you have any questions, my e-mail address is at
the top of this file.

*********************************************************************
DISCLAIMER: Both of these source code only packages are meant for the
consumption of developers only!  That is why they are released only as source
code.  They are *NOT* guaranteed to work.  In fact, they probably have all
sorts of icky bugs in them which can cause the game to totally malfunction or
even crash!  If you want a version of NnCTF which is more stable, download one
of the pre-compiled versions off the NnCTF web site (listed above).
*********************************************************************

Moving On.....


---------------------------------------------------------------------
Release Notes
---------------------------------------------------------------------

This version will work under Unreal 224/5f.

Also, be sure to check out the changelog.txt files in each packages' specific
directory.

Other Notes:
* The DeathWatch mod is slightly modified from the original (it had to be in
  order for it to be subclassed properly.)  The author has been notified of the
  changes.  The changed packages are available in the new "required" package.


---------------------------------------------------------------------
Step 1, Setting up the rebuild.
---------------------------------------------------------------------

First off, when extracting the source-code-release .zip files, make sure that
you unzip them to the inside of your Unreal directory with full pathnames.  In
other words, your Unreal directory should end up with an "OpenMod" dir and a
"NnCTF" dir.

Also, it is assumed that you have previously installed NnCTF according to the
directions specified in it's readme.txt file.

Now, open up your unreal.ini file and find the [Editor.EditorEngine] section.
Scroll to the bottom of this section where you'll find the 'EditPackages'
portion.  Then, from looking at the list below, add "OpenMod" through "NnCTF"
in the order shown below.

EditPackages=Core
EditPackages=Engine
EditPackages=Editor
EditPackages=Fire
EditPackages=IpDrv
EditPackages=UnrealShare
EditPackages=UnrealI
EditPackages=IpServer
EditPackages=OpenMod
EditPackages=OpenModTestClasses
EditPackages=OpenModMusicInfo
EditPackages=uWeapons
EditPackages=uWeaponsSpawner
EditPackages=NnCTF

Please note that the order in which you add packages is important.  OpenMod
*MUST* be above NnCTF otherwise NnCTF will not rebuild.


---------------------------------------------------------------------
Step 2, Rebuilding.
---------------------------------------------------------------------

Before you can do a rebuild, Unreal has to know that you want to rebuild a
specific package.  It figures this out by looking through the EditActors list
(the one you edited in Step 1) and checking to see if each entry actually
exists.  If it does not, it will then try and rebuild it.  It does this by
looking for a directory with the same name as the package, finding a 'Classes'
directory inside it, and then compiling all the .uc files inside it.  Ie, if
you're going to rebuild NnCTF, Unreal will check to see if there is an NnCTF.u
file.  If not, it looks in Unreal\NnCTF\Classes for .uc files and compiles any
it finds.

In other words, here is how you do it.

* Back up your existing OpenMod.u and NnCTF.u files (putting them in another
directory will do fine.)
* Delete OpenMod.u and NnCTF.u from your Unreal\System dir.
* Run: unreal -make

Provided there aren't too many screwups, it should leave you with brand
spanking new OpenMod.u and NnCTF.u files.




---------------------------------------------------------------------
Credit
---------------------------------------------------------------------

Until I formally update the main NnCTF readme.txt, I'd like to thank and give
credit to the following people/groups.

Outkast - For the AWT (http://www.unrealscript.net/AWT/index.html)
Unrealistic - For the ITSHUD (http://www.planetunreal.com/unrealistic)
Adam Alpern - For creating the DeathWatch HUD/spectator system.
James - For making the OpenMod "diff" util.
Zed + Outkast (again) - For a project which I'm sure you'll all hear about in
  the near future.  :-)
Tim Sweeney + Brandon Reinhart - For answering the really tough code questions.
Zuel - For occasionally (frequently?) slapping some sense into me.
The NnCTF team - For helping to make NnCTF more than just code.

