UTJB www.daikiki.com

JailBreak Manual

About JailBreak

UTJB is the Unreal Tournament version of the well known JailBreak game type for the Quake series of games. In it, players compete in one of two teams to imprison the opposing team while avoiding capture themselves. Each team operates from a base that contains a jail release mechanism, usually a button of some kind. When an opponent activates this mechanism, your jail opens and the prisoners escape. Whenever all players in a team are captured, the opposing team scores and all players are restarted in their own bases. The process repeats itself until a set score or time limit has been reached.

Although the gameplay will be familiar to those who have played one of the Quake incarnations of JailBreak, they will find that UTJB contains a myriad of features not featured in those versions, making it a wholly unique experience.


Installation

UTJB is distributed in a .umod package. This package contains all game data, maps, and other resources required to install UTJB.

To install, simply double-click the UTJB.umod icon. You will be presented with a window explaining which version of UTJB you are about to install. Click next and fill in the location of your Unreal Tournament folder (fig. 1).

If you do not know the location of your Unreal Tournament folder, use the find option under your Start menu to find a file named UnrealTournament.exe. This file resides in the system directory of your Unreal Tournament folder. Fill in this path, excluding the \system at the end. This process only works under Windows, although Sherlock provides a similar search function for the Macintosh. The installer will now proceed to install all relevant data.

[Installer Dialog]



Starting a Game
[Start Practice Session Dialog]   

Once you have installed UTJB, you can start a game by starting Unreal Tournament, selecting Start Practice Session from the game menu and choosing UTJB as game type (fig. 2).

The defaults will suffice for a quick game. If you wish to host a multiplayer game, select Start New Multiplayer Game from the Multiplayer menu and select UTJB as the game type, as before.



Joining a Game

You may join an online game of UTJB in the same way as you would join any other multiplayer game. Simply select Find Internet Games and click on the UTJB tab in the server browser (fig. 3). For a LAN game, select the LAN Servers tab.

[Server Browser]



Game Setup
[Start Network Game Dialog]   

Setting up a game of UTJB, either in multiplayer or practice mode, is similar to setting up a CTF game.

There are additional tags to take into account. First is the Max Capture Time (fig. 4). This value represents the number of minutes that will be allowed to pass without a capture taking place before the round is considered a draw and both teams are respawned in their own base. Setting this to zero means the teams will never be restarted. The maximum value for this field is ten minutes. If Reset On Release is checked, the capture time countdown will be reset every time both teams have been released, as well as after a team is captured. Transloc Time sets the minimum amount of time, in seconds, between translocations if the translocator is enabled. All other options behave as you would expect them to do.

In addition to the basic settings, you may choose to use the included JBcampkill mutator. This mutator offers protection for so called 'Jail Campers'. To configure the mutator, select Configure JBCampkill from the Mod menu. From here, you can set the amount of time, in seconds, that released players are protected and how to protect them. If you wish them to take no damage from enemy fire, check No Damage. If you want campers to be punished, they can be made llama's by checking Make Llamas. In addition, JBCampkill can prevent players in jail from taking damage from enemy fire that originates outside of the jail. To activate this option, check No Jail Damage. Once you have configured JBCampkill, it must be activated by selecting it from the Mutators menu under the Match tab of either a practice session or an online game.



Key Bindings

From the Mod menu, select UTJB Preferences. You will be presented with a small window that allows you to bind keys to certain commands (fig. 5). Bot Aggression Up and Down controls the aggressiveness of your bots, while Switch Compass switches the target of your in-game compass between your own and your opponents' release mechanism.

Recommended settings are the Keypad Plus (+) and Minus (-) for aggressiveness, and Keypad Star (*) for the compass. Not setting these keys means that you will not be able to use these functions from within the game.

[UTJB Key Bindings Dialog]



Head-Up Display
[Head-Up Display Elements]   

Once you have started a game of UTJB, the first thing you will likely notice is the new head-up display elements on the right side of the screen (fig. 6). From top to bottom:

* The Stance Bar
This bar represents the current aggressiveness of the bots on your team. Based on several factors, such as the number of imprisoned players on either team, bots will dynamically decide whether to defend their own release mechanism or assault that of their opponents. Team stance modifies this choice. Set to aggressive (red), more bots will assault the enemy mechanism, attempting to release their team-mates, while a defensive setting (green) will cause more bots to defend their own mechanism against attack. Since all human players in a team may influence team stance, the setting may change without any intervention from you.

* The Timer
If playing with a maximum capture time, this timer will display the amount of time remaining to score a capture before both teams are reset. The timer is reset whenever a capture is scored, or whenever both teams have been released, if that option was selected from the Rules tab.

* The Status Icon
The status icon contains information on your current status. If there's nothing about your status worth mentioning, it will display a compass pointing out the direction of either your own or your opponents' release mechanism. A blue arrow points in the direction of the blue release mechanism, which releases red players from jail, while a red arrow does the opposite. The target of the compass can be switched using the key you have bound to this function in the UTJB Key Bindings dialog (see above). If you are imprisoned, the status icon will display the UTJB ball and chain logo. If you are in the arena (see The Arena, below), an arena logo will be displayed. If you are imprisoned and scheduled to go to the arena, the same arena logo will be displayed, this time with a countdown timer. If you've just been released and are being protected by the JBCampkill mutator, you will see a shield. If the icon displays a llama, you're in trouble (see Llama Hunt, below).

* The Team Icons
The bottom two icons are team status icons, one for the red team, one for the blue. These icons display the team score in a large number at the top left of the icon, and the current number of jailed players out of the total team size at the bottom.




Gameplay

Gameplay proceeds as any team game of UT would proceed, with players gathering weapons and powerups before assaulting the enemy. It wouldn't be much of a mod if that was all.

* Prisons
Whenever your player dies for whatever reason in UTJB you are respawned in a prison. There you must wait for your team-mates to release you. An audio and visual message will inform you when this has happened. Keep an eye on the exits as they only stay open for a limited amount of time. If you do not respond quickly, you may find yourself too late to escape. Some prisons feature secondary escape routes that can be triggered from the inside. These routes require a degree of skill and often assistance from team-mates. Look around the inside of jails carefully and see if you can work out how to escape. Imprisoned bots get bored easily. They slouch around, and sometimes even fall asleep, snoring loudly. If they get on your nerves, you may shoot them. That tends to wake them up.

* The Arena
Depending on the map, imprisoned players may find themselves challenged to fight for their freedom in the arena. An audio message will warn you when this happens to you. Your status icon will also change to represent an arena with a countdown timer. Once transported to the arena, you will fight a one-on-one battle against a member of the opponents. The winner will be respawned near his own base, while the loser of such a battle is returned to jail. If after 90 seconds of such a battle both combatants are still alive, the match is considered a draw and both players are returned to their jail. If during an arena countdown a team is captured or one of the combatants leaves the prison, the battle will be cancelled.

* Scoring
Individual scoring is as follows: One point for a kill, a bonus point if you kill a target while defending a release mechanism, one point if your team captures the opponent, and one point per released team-mate upon liberating prisoners. A player can also score five bonus points for killing a llama (see Llama Hunt, below). No score is ever rewarded for fragging a player that is already imprisoned. Teams score only upon imprisoning the opposing team.

* Llama Hunt
A player is considered a llama if he or she disconnects from a multiplayer game while in prison and reconnects in an attempt to free him-/herself. A player may also be designated a llama if he or she attacks a player recently released from prison, depending on the server settings. If this happens, that player will be designated a llama. Killing a llama scores the killer five bonus points. If, after a designated amount of time, a llama hasn't been killed, he or she will explode, quite of his own accord. Llamas can not release their team mates from prison, either.



Dedicated Servers

To those of you who may wish to host a dedicated UTJB server, we commend you. 95 % of UT servers these days seem to be running vanilla UT, and half of them are more often than not empty. We hope you will find UTJB a worthy alternative that will draw in players to your service in a way which 'vanilla' servers will not. Although advanced server administration does not fall within the realm of this document, setting up a dedicated server for UTJB is quite simple. Use a server.ini containing something like this:

  [JailBreak.JailBreak]

  FriendlyFireScale=0.000000

  GoalTeamScore=20.000000

  TimeLimit=99

  bClassicDeathMessages=False

  bCoopWeaponMode=False

  bForceRespawn=True

  bHumansOnly=False

  bMultiWeaponStay=False

  bNoMonsters=False

  bNoTeamChanges=False

  bUseTranslocator=False

  FragLimit=0

  FriendlyFireScale=0.000000

  GoalTeamScore=5.000000

  MaxCommanders=0

  MaxTeams=2

  MaxTeamSize=16

  TimeLimit=0

  maxcaptime=5.000000

  HopDelay=3

  ReleaseReset=True

These lines may be edited manually to fit your needs. For both Windows and Linux, change to your UnrealTournament/system directory and start the server with the following command line:

  ucc server JB-Nightmoves-R1?game=JailBreak.JailBreak?mutator=JBCampkill.JBCampkill ini=server.ini log=server.log

Macintosh dedicated servers must be launched from within the game menu by starting a multiplayer game with the dedicated option.

UTJB uses slightly more network resources that a vanilla UT game, but the difference is only about 5 %.



JailBreak Resources

For the latest UTJB news and patches, visit UTJB's homepage. Here you can also report bugs, offer suggestions, and talk with other users on the forum.

For news and reviews of UTJB maps, visit BreakOut. Here you will also find the official UTJB map list. Although down at the time of writing, Jail Crew is another excellent resource of UTJB material.

Mychaeel maintains a page detailing the various mutators available for UTJB here.

The author can be contacted at twitch@dds.nl.



Compatibility

UTJB has been tested with UT version 436 on all available platforms. Its hardware requirements are equal to those of UT itself, although many maps these days will not run well under the minimum requirements. UTJB takes up about 40 MB of space on your hard drive. UTJB may work with older versions of UT, but no guarantee is offered. You will also need the UT Bonus Pack 1. Both the Bonus pack and any patches you may need can be downloaded from Epic Games. Note that the Game of the Year edition of UT incorporates both the latest patch and the Bonus Pack 1.

UTJB will work with most mutators, although there have been problems with some weapon mutators and relics may respawn within jails. Your mileage may vary.


Known Issues

* Bots given orders through the voice command menu will disregard these orders several seconds later. (This is inherent to UTJB. Use the stance setting instead.)

* Bots using custom models will not display UTJB-specific behaviour.



Credits

Primary coding: Daikiki
Coding 205 patch: Mychaeel, Daikiki
JBspecials coding: ElBundee
JB-OfMiceAndMen, JB-CarpeDiem, JB-PitOfDispair, JB-November: DireIce
JB-Freya, JB-CloseQuarters: SnowDog
JB-Phasma: ElBundee
JB-Coloraido: MasterBotAI
JB-SkullDrudgery: Muad'dib
JB-NightMoves, JB-LostFalls, JB-Coret: Daikiki
Ball and Chain logo: ElBundee
Monochrome Arena logo: Mychaeel
Other Graphics: Daikiki
Voice Acting: The Voice
Manual: Daikiki
Manual Editor: Mychaeel
Based on code originally by Mongo
JailBreak concept by Team Reaction

Testers: Lomedae, MarbleX, Appel, Othello, Vinny, ElBundee, Mychaeel, SnowDog, Thoth, WillySurvive, WiseGuy, Valadonis.

Special thanks to Garulfo, Vinny, Lomedae, Mugsy, Caution, QAPete, DrSiN, Anarchy, MyU, Wes.


Copyright:
This code is based on code that was originally reverse engineered from the beta5 release of the official Jailbreak by Team Reaction and Mongo, as is legal under European law, and was extensively rewritten to represent what is in effect a new product. Subject to European and Dutch law, this release may be distributed in a not-for-profit fashion over the internet in its original form with this copyright notice intact. All other uses are subject to explicit permission. This software is provided as-is. No warranty is made as to its suitability for any given purpose. All use is at the user's sole risk. Sorry guys, I'm not a big fan of copyright notices. This'll just have to do.