=================
ModManager Readme
=================

For Modmanager v1.0.2
Last updated 2004/05/23

0 Contents
==========

0 Contents
1 Introduction
2 Disclaimer
3 Using ModManager
4 Command Line Options
5 Creating Mods for ModManager
6 Bugs etc
7 Version History

1 Introduction
==============

ModManager is intended as a next step in the evolution of CTP2 Mod utilities after ModSwapper.  It adds many new features and functionality.  Hopefully its use is sufficiently simple not to require explanation here, but I'll say a few things that you cannot or might not otherwise realise.

Thanks to:
Paul for writing ModSwapper and providing the inspiration
All at www.apolyton.net for their suggestions and support

2 Disclaimer
============

This program is provided as is, with no warrantly explicit or implied.  Use it at your own risk, or don't use it at all.

This is still an early version, and many of the advanced features have no been tested much or even at all.  If you're worried, I recommend that you make a zipped up copy of your whole ctp2_data (or even your whole CTP2) directory just to be on the safe side (That's what I've done).

I have tested this only under Windows XP Home.

3 Using ModManager
==================

I'm hoping it's all obvious enough that I don't have to say :).

If you've installed a mod, but it doesn't show up in ModManager, then it might be a ModSwapper mod, in which case you must tell ModManager to look for it.  To do this press 'Manage' and then 'Seek ModSwapper Mods'.

4 Command Line Options
======================

There are three command line options you can use with ModManager, so that you can create shortcuts to it to do funky things:

-path "<Path>"
Where <Path> is your CTP2 Path.  You must do this to specify that path if you do not run Modmanager in the main CTP2 directory.  Modmanager looks under <Path>\ctp2_program\ctp\ or if that fails <Path>\ctp2_code\ctp\ for files like userprofile.txt, civpaths.txt and ctp2.exe.

-executable "<Executable name>"
Where <Executable name> is the name of the executable you wish ModManager to run instead of ctp2.exe.  This can be useful if you have compiled and wish to run the debug version, for example.

-setup "<Setup>"
Where <Setup> is the name of a setup *exactly* as it appears in ModManager.  To get it right, you can copy and paste it out of the 'Currently applied setup' textbox (provided for that very purpose) within ModManager.  This setup will be applied on startup.

-launch
This will cause ModManager to launch CTP2 immediately (after loading any setup specified by the -setup option).

For example:
ModManager -path "C:\games\CTP2" -executable "CivCTP_dbg.exe" -setup "Original Game" -launch
will cause ModManager to look for CTP2 in the C:\games\CTP2 directory, apply the Original Game setup and launch the debug build of CTP2.

5 Creating Mods for ModManager
==============================

ModManager needs mods to be specified my a mod definition file - see the example file MOD_ModDef_sample.txt for details as to how this works.  ModManager can create these files automatically for ModSwapper class mods based on their *_Gamefile.txt if you click the 'Seek ModSwapper mods' button in the 'Manage Setups' dialog.

6 Bugs etc
==========

There are the following known bugs or problems:
- If you have Martin's fix for the buttons which appear in the MP section for choosing ages then, because Martin saved the original files under the orig_ prefix, the original files will be restored when ModManager does a careful restoration.  This means that the age buttons will go back to being the old ones again.

List of features I would like:
- ModManager should quit when you launch CTP2, but if I implement this then CTP2 does not load properly.  I have no ideas here.
- The ability to create shortcuts to various setups automatically, rather than the user having to do so  manually.

7 Version History
=================

v1.0.2
------

- Added '-executable' command line parameter to allow running different builds from ctp2.exe, e.g. the debug build.
- Fixed a bug which caused a crash on execution if MaxPlayers was greater than 29 in UserProfile.txt.
- Changed the logging to append to instead of replacing ModMan.log.
- Added a little more info to the readme.

v1.0.1
------

- Support for the ctp2_code directory, to work with compiled versions of CTP2.

v1.0.0
------

- First release version