---

Getting XMaps to Run in UnrealTournament

---

To use XMaps in your games, select your game type as usual in UT's Start Game windows and select the Mutators button. Add 'XMaps' to the Mutators Used list, and check the 'Always use this Mutator configuration' box to make sure it's used each time UnrealTournament switches levels. Close the Configure Mutators window and Start the game. UnrealTournament remembers these settings, so you only need to do it once.

If you run a server from the console, or a command-line, you can add the game option string '?mutator=XMaps.XMapsControl' to the execution command (without the quotes). If you wanted to run a Listen server, for example, you could use this command-line (it's all one line, and the spaces are important):

UnrealTournament.exe DM-Temple.unr?Game=BotPack.DeathMatchPlus?Mutator=XMaps.XMapsControl?Listen -server log=server.log

UnrealTournament must be set up to 'Auto Change Levels' for XMaps' map selection features to work. In versions 106 and later, XMaps automatically sets this up when it loads. The 'Auto Change Levels' option makes UnrealTournament read your map list when it changes levels. XMaps sees this happening and jumps in to implement its map selection features. Since XMaps takes over this feature, the Map List you select in the 'Start Game' windows will have no effect on the game.

All other XMaps features - Game Switching, Player Matching and so on - are enabled using the XMaps Setup windows, accessed from the XMaps option in the UT Mod menu, or by using XMaps Remote Control.

If you're using XMaps to switch game types on a server, or use the HUD Menu or key bindings to switch games or maps, then XMaps will recognise this and load itself each time a new game or map is loaded. At all other times, the 'Always use this Mutator configuration' option must be set on, with XMaps in the Mutator list, in the UT Start Game windows. See Loading XMaps from UT above.

When you're running XMaps on a server, XMaps Remote Control and XMaps' client features can be used to control and configure the server, making your life as a server admin much easier. The HUD Menu and the Client Setup window are available to all clients when XMaps is running on a server, as long as those clients can log in to the server as an Administrator user. The Client Setup window can automate this process for you.

To enable XMaps to run correctly on a server and it's clients, the XMaps client must be set up as a ServerPackage. In the INI file you use to start your server - usually UnrealTournament.ini - make sure the following line is present in the [Engine.GameEngine] section:

[Engine.GameEngine]
...
ServerPackages=XMapsClient232
...

This line will be set up automatically if you use the umod installer to install or upgrade XMaps. If you prefer to use the non-umod archive, the line must be added manually. If you use a different INI file to start your server, the line must also be added manually.

If you upgrade or re-install XMaps at any time, be sure to remove any ServerPackages lines that reference old versions. The name of the XMaps client package is changed between releases to prevent version conflicts (for example, XMapsClient232.u), so you need to change the ServerPackages entry accordingly. Note that the client package is an optional download, and XMaps.u is server-side only. Some releases may only contain changes to the server package, XMaps.u, so your clients won't need to change.

See Installing XMaps for more information.