XMaps Key Bindings and Console Commands

Key Bindings

XMaps supports several key bindings that you can use while UnrealTournament is running a game. The keys you want to use can be set up in XMaps' Client Setup window or using UT's Controls dialog (select Options | Preferences from the UT menu, and then the Controls tab). Scroll down the list of controls and you'll find an XMaps section where you can allocate your chosen keys.

Note that you'll only be able to use the UT Preferences if XMaps is actually installed on your PC. If you're connecting to an UnrealTournament server that's running XMaps, you don't need to have XMaps installed - the server will send you the XMaps client package and you can use the Client Setup window to set your key bindings.

XMaps currently supports the following key bindings:

BindingAction
Open Client SetupOpens the Client Setup window.
Open HUD MenuOpens the HUD Menu.
Restart current levelRestarts the current game.
Show map nameShows the name of the current map.
Skip current levelSkips to the next map according to your XMaps settings.
Switch game typesImmediately switches game types according to your XMaps settings.

Note that, unlike automatic Game Switching, XMaps will abort an Assault game in either part when you use the Switch game types key binding or console command.

Console Commands

Some of the XMaps commands can be entered by hand using the game console or mini-console, if that's what you prefer. The key binding commands that can be entered this way are shown below. You can drop down the console or mini-console, and type one of the following:

Command......is Binding...
mutate xmaps restartRestart current level
mutate xmaps mapnameShow map name
mutate xmaps skipSkip current level
mutate xmaps switchSwitch game types

The commands aren't case-sensitive, so "Mutate XMaps SKIP" is the same as "mutate xmaps skip".

Administrator Login

If you're running a multiplayer game, you need to be an authorised user to use the key bindings and/or console commands. If the game you're in is running stand-alone, this won't happen, but if you're running a network game, then XMaps makes sure you're 'allowed' to change the map or game type by checking your user status. Server admins running XMaps may choose to only allow Adminstrator users access to XMaps' features.

If this is the case, XMaps can perform the Admin login for you from the Client Setup window. If you don't use the Client Setup window, you'll have to log in by hand when a server admin restricts XMaps access to Administrators. If you're running a server and want to control the way the Client Setup window automates admin login, check out the Server Options window.

For those of you who aren't familiar with the Admin user concept ... when you start a network game, the Server tab gives you the chance to set up an Admin password; this is the password you need to become recognised as the Admin User. When the game is playing, you need to being down the console and enter the command:

adminlogin <password>

Where <password> is the Admin Password set up in the Server tab. Then, you're the admin user and can do things like using XMaps to switch the map or game type. You'll probably find it easier to use the Client Setup window, though, since it remembers passwords for you.

'Advanced' Console Commands

There's also a series of XMaps mutate commands that are used by the in-game HUD Menu, but may turn out to be useful in their own right. Each of the commands listed below must be preceded by "mutate xmaps" in the console or mini-console:

CommandAction
gameonly <game>Switches UT to the game class <game>. Note that this must be a full class designation, for example:
   mutate xmaps gameonly botpack.ctfgame
When the new game type loads, XMaps will pick the next map according to your XMaps settings. XMaps assumes that the <game> class designation you enter is valid.
loadmap <map>Loads the map <map>. For example:
   mutate xmaps loadmap DM-Deck16][
XMaps assumes that the map is suitable for the game type already playing. If it isn't, you should use 'fullmap'. Of course, you could use this feature to load any kind of map in Deathmatch mode, for example.
fullmap <map>?<game>Switches to the game class <game> and loads the map <map>. The two designators must be seperated by '?' for this to work. For example:
   mutate xmaps fullmap CTF-Terra.unr?botpack.ctfgame
settimelimit <limit>Sets the Time Limit for the current game to <limit>, in minutes.
setfraglimit <limit>Sets the Frag Limit for a Deathmatch game to <limit>.
setlmslives <limit>Sets the Frag Limit for a Last Man Standing game to <limit>.
setteamgoal <value>Sets the Team Goal for the current team-based game to <value>. In CTF games, this would be the Capture Limit. In Team Deathmatch, it's the Team Frag Limit. In Domination, it's the Score Limit.
togglefavouritesToggles the Use Favourites setting.
togglegameswitchToggles the Switch game types setting.
togglehudpauseToggles the Pause for HUD setting.
togglelargehudfontToggles the Large HUD font setting.
togglematchplayersToggles the Match players setting.

The commands aren't case-sensitive, so "Mutate XMaps ToggleFavourites" is the same as "mutate xmaps togglefavourites". Note that the Unreal map extension (.unr) doesn't need to be present in the <map> parts of the loadmap and fullmap commands.