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

For Modmanager v1.0.4
Last updated 2005/05/06

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

0 Contents
1 Introduction
2 Disclaimer
3 Installation
4 Using ModManager
5 Command Line Options
6 Creating Mods for ModManager
7 Bugs etc
8 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.  It should
work both with the normal Activision version of CTP2 and with the Apolyton
Edition

Thanks to:
Paul for writing ModSwapper and providing the inspiration
All at www.apolyton.net for their suggestions and support, in particular
Fromafar and velosim for reporting bugs and problems.

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.

ModManager has existed for some time now, and no serious problems have been
reported, so using it should be fairly safe.  However, many of the advanced
features have not been tested much or even at all (becuase none of the
currently existing mods use them), so may not work correctly.  Of course, until
mods using these features exist, that is not a problem.  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 Installation
==============

Simply unzip the ModManager zip file to wherever you want ModManager installed.
It is recommended that you unzip into the main CTP2 directory (that's the one
containing the ctp2_data and ctp2_program directories) - if you choose to place
ModManager elsewhere then you will have to pass the CTP2 directory as a command
line argument (see section 5 below).

4 Using ModManager
==================

To use ModManager, simply run ModMan.exe.  If you installed to the main CTP2
directory then that should suffice, but otherwise you will have to provide an
appropriate command line argument.

If you get an error about a file not being found, then you should check the
following:

1. If the message indicates that the file is being sought in a directory which
does not exist, then ensure you are running ModManager with the correct working
directory or command line arguments so that it can locate CTP2.

2. If you are missing the file
[Your CTP2 installation directory]\ctp2_program\ctp\userprofile.txt
then you must run CTP2 and start a game, which will cause CTP2 to create that
file.

I'm hoping the interface is mostly sufficiently obvious that I don't have to
explain :), but the following comments are in order:

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'.

It is possible that, if you have logging enabled, the log file (ModMan.log)
could grow large.  It is perfectly safe to delete this file if you wish.

See the section 5, on command line options, for further features which are not
obvious through the interface.

If you want to report bugs, request features, etc., please post in the
CTP2-Creation/AI/Mods/Scenarios forum at apolyton.net, which can be found at
the follwing URL:
http://apolyton.net/forums//forumdisplay.php?s=&forumid=118

5 Command Line Options
======================

There are several command line options you can use with ModManager.  Amongst
other things, these allow you to create a shortcut directly to each of your
favorite mods.

-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.

6 Creating Mods for ModManager
==============================

ModManager needs mods to be specified my a mod definition file - see the
example file mods\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.

7 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.  The only way I know to do this involves
nastiness involving strange DLLs, which I would rather avoid.

8 Version History
=================

v1.0.4
------

- Fixed possible crashes caused by NumPlayers or MaxPlayers being too small
- Added more languages to dropdown list
- Added some more logging

v1.0.3
------

- Fixed the same bug for NumPlayers as was fixed for MaxPlayers in v1.0.2.
- Fixed some logging that was being done even when logging was deactivated.

unversioned release
-------------------

- Updated and clarified readme.

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.
