####################################################################################################
##
##  BTCheckPoints 1.0
##  Copyright (C) 2010 Patrick "Sp0ngeb0b" Peltzer
##
##  Contact: spongebobut@yahoo.com  -  www.unrealriders.de
##
####################################################################################################


####################################################################################################
## 
##  INTRODUCTION
##
####################################################################################################
BT Players know that: You play an awesome BT map (which you don't know), but unfortunately you don't
make it to the end because you die. That's very frustrating!

BTCheckPoints allows all BT players out there to set a 'Checkpoint' on which they will respawn
after they die! Sounds cool, doesn't it?

From now on, you are able to discover BTMaps safely, without making thoughts about hidden crushers or
anything that could move you back to your startspot! On top of that, this mutator is also a great help
for rushers or for 'normal' players to get some practise on a map or on a specific obstacle!

Ofcourse, BTCheckpoints comes with a build-in laming preventer:
After respawning at a Checkpoint, players are not able to cap. They have to do a run FROM THE BEGINNING
on their own.

This mutator comes with a cooperating mode for BTPlusPlus to optimize its features. For that mode
to work, servers need at least version BTPlusPlus097r4, I recommend version 098 or higher.
In addition, BTCheckpoints also comes with a Nexgen cooperating mode, so that the player messages
will be automatically colored (if Nexgen HUD is enabled)!

Admins can choose between many config options, like the CP outward appearance or usefull HUD information for players. 
Have a look at the 'Settings' paragraph to know more about them.


####################################################################################################
## 
##  How to use the mutator in-game
##
####################################################################################################
Here's a user guide how to use the mutator ingame (don't worry, you only have to remember 2 commands):

For SETTING a checkpoint, players can either enter
'mutate checkpoint'
in their console (how impractical, but good for keybinds)

OR

they can simply SAY: '!cp'


For REMOVING a checkpoint, the command
"mutate nocheckpoint"
will do the trick,

OR

Saying: '!nocp'


Bind:
If you are interested in binding a key for setting a checkpoint, enter this into your UT console:
'set input 'key' mutate checkpoint'
and
'set input 'key' mutate nocheckpoint'

where 'key' is your specific key you want to use.


####################################################################################################
## 
##  Server Install
##
####################################################################################################
To install BTCheckPoints on your server, you can choose between two types:


1. ServerActor (will be loaded everytime)
*****************************************

- Copy the 'BTCheckPoints.u' and the 'BTCheckPoints.ini' file into your servers System folder
- Open your server's config file (usually UnrealTournament.ini)
- Go to the [Engine.GameEngine]
- Add the following lines:

ServerActors=BTCheckPoints.BTCheckPoints
ServerPackages=BTCheckPoints

- Save the file and restart your server


2. Mutator (can be unloaded)
****************************

- Copy the 'BTCheckPoints.u', the 'BTCheckPoints.int' and the 'BTCheckPoints.ini' file into your servers System folder
- Open your server's config file (usually UnrealTournament.ini)
- Go to the [Engine.GameEngine]
- Add the following line:

ServerPackages=BTCheckPoints

- Save the file and restart your server
- Select the mutator 'BTCheckPoints' via WebAdmin (or via any other Mod) and restart the map


If BTCheckPoints is running succesfully, and you wish to modify its settings, have a look at the next section.
If it doesn't run succesfully, have a look into your server's log and/or contact me.


####################################################################################################
## 
##  Settings
##
####################################################################################################
BTCheckpoints comes with default settings, which should fit into every server environment.
If you want to change some of these settings, open 'BTCheckPoints.ini' and modify the following lines:

WARNING: Changing some default settings can cause bugs

bEnabled:          
Set this to false if you want to disable the mutator
(DEFAULT = TRUE)

bSearchForNexgen: 
Set this to false if you don't want BTCheckPoints to search for Nexgen (e.g. if you don't want the colered messages if you are using Nexgen)
(DEFAULT = TRUE)
                  
bSearchForBTpp:    
Set this to false if you don't want BTCheckPoints to search for BTPlusPlus and do not want to use it's cap preventer
(DEFAULT = TRUE)
                  
bDisallowCaps:  
Set this to false if you want to allow captures after using a CP (will stop build-in cap preventer and BTPlusPlus cap preventer)
(DEFAULT = TRUE)

bRemoveCPAfterCap:
If you want to remove the player's CheckPoint after he capped, set this to true. 
(DEFAULT = TRUE)
                  
iCPDelay:
The time a player has to wait before setting a new CheckPoint  (Default: 5 seconds, 0 will turn it off)
(DEFAULT = 5)

iCPType:  
Sets the Checkpoint outward appearance. Avaible options: 0 = Player ghost , 1 = Colored marking on ground
(DEFAULT = 0)
                  
bAllowInAir: 
Allow players to set a checkpoint while beeing in the air (not touching the ground)
(DEFAULT = FALSE)

bAllowInWater:
Set this to false if you don't want to allow players to set a CheckPoint while beeing underwater
(DEFAULT = TRUE)

bAllowInWrongZone:
Allow players to set a checkpoint while beeing in a special zone (e.g. lava or vacuum)
(DEFAULT = FALSE)

bAllowOnMovers:
Allow players to set a checkpoint while standing on a mover
(DEFAULT = FALSE)

bAllowOnTeleporters:
Set this to true if you want to allow players to set a Checkpoint while touching a teleporter. This can result in 'endless-dying'.
(DEFAULT = FALSE)

bShowCPOwners:    
If set to true and a player is touching a checkpoint, he gets a message on his HUD containing the playername belonging to the checkpoint.
(DEFAULT = TRUE)

bShowCPStatus:   
Set this to true if you want a line on the player's HUD, informing him whether he respawned at his Checkpoint (so he wont be able to cap).
(DEFAULT = TRUE)


####################################################################################################
## 
##  Thanks to
##
####################################################################################################
- i4Games and their private mutator for giving me the inspiration (NO CODE HAS BEEN VIEWED / COPIED, BTCHECKPOINTS IS TOTALLY CREATED FROM SCRATCH)
- The FBT community for BETA testing, bug reports and feedback
- Rush, for parts of his HUD code in BTPlusPlus so both mutators harmonize well




Now go out and enjoy the new BT feeling!

Sp0ngeb0b

December 2010



####################################################################################################
## 
##  Info for coders
##
####################################################################################################
This program is free software; you can redistribute and/or modify it under the terms of the Open Unreal Mod License version 1.1.

This .zip includes the source code, so you are welcome to have a look in it and/or modify it for your needs. 
Nevertheless, I would like to get informed if you are planning to release a new public version, so just write a mail (don't be shy, I don't bite :p )

                   






