UTMapLoader2
by {MØZ}Mr_Rogers
UTMapLoader2 allows you to upload maps from your local system to Unreal Tournament, UT 2003, and UT 2004 servers.
UTMapLoader2 takes care of finding all of the dependencies that go along with a map file, such as sounds, textures, and music. It automatically determines which files already exist on the target game server, and uploads only the necessary files. If appropriate, it also makes compressed (.uz) copies of all required files and updates your redirect server as well.
UTMapLoader2 can upload maps while your game server is running! Freshly uploaded maps will appear within one or two map voting cycles. If you're using a fixed map list, then naturally the list will need to be updated by a game server administrator.
For game server admins, the program provides you the opportunity to allow non-admins to update your game servers. By giving users a settings file (an INI) that has your game/redirect server FTP credentials already encrypted, you can give someone the ability to load maps without giving them unrestricted FTP access. More on this later.
Installation
Extract the UTMapLoader2 ZIP file contents to any folder on your hard drive (I recommend a "UTMapLoader2" folder). Then, double-click the UTMapLoader2.exe file. That's it - there's no installation program to run.
Getting Started
The first time you run UTMapLoader2, it will ask you to confirm some user-specific details, such as your name and the folders where your various versions of UnrealTournament are installed. If you used the official/stock installation CD's, the program should correctly determine the locations of these versions. Otherwise, you may need to enter the paths manually. Click the "Done" button when you have updated this information. If you ever need to change user-specific details, right-click the UTMapLoader2 window and select the "User Settings..." menu option.
To give UTMapLoader2 a try without fear of making changes your game servers, right-click the window and select the "Test Mode" menu option. In test mode, UTMapLoader2 runs through all normal activities such as finding map dependencies, querying the game server to see what files are already installed, and creating compressed copies of files as necessary. It does not, however, make any changes to the game or redirect servers. Actual file uploads are simulated. When you're ready to upload a map for real, make sure you disable the "Test Mode" option.
Configuration
Unless you're a game administrator, feel free to skip this section.
UTMapLoader2 can upload to any server for which you have a settings file. Each settings file contains the information UTMapLoader2 needs to know in order to update a single server (and optional redirect). The format of the information is described in the sample settings file provided with the program, but some of the finer points are described here.
The "game_server" entries are required and cannot be omitted or left blank.
If your game hosting company allows you to keep miscellaneous files on your server, then I encourage you to set the "game_server.use_log_file" setting to "true". If true, this setting causes UTMapLoader2 to keep a running log file on your game server in the game's root directory. This log will contain a list of all files uploaded (both maps and dependencies), who uploaded them, and when. On the other hand, if you're running on a nameless game service provider who will shut you down for having a single byte of non-game data on the server, set this value to "false".
If your game hosting company has set you up with a dedicated redirect, or any redirect server that you must update yourself, then you must fill in the "redirect_server" settings. If you're operating on a shared redirect that is updated automatically by your game host, then leave all of the "redirect_server" settings blank. If you have no FTP account information for a redirect server, it is likely that you have an automatically updated shared redirect, and do not need to bother with these settings.
A Special Note for Server Admins
To create a settings file that you can give to others, use one of the existing settings files as a template and copy it to an appropriate file name. The extension must be "ini". Edit the file and enter your server's FTP credentials in clear text. Save the file, then launch UTMapLoader2. You don't need to upload anything, just running the program is enough. Close the program and open the settings file. Note that the credentials have been encrypted. You can now provide this encrypted version of the configuration file to others in your group so that they can upload maps without fear of giving away your FTP credentials.
Uploading Maps
Begin by selecting the game server you want to update. Move your mouse over the UTMapLoader2 window and over the name of the game server displayed there. Note how the color of the text changes. Click the mouse button while the game server name is hilighted to change it. A popup menu will appear that will allow you to select any game server for which you have a settings file.
IMPORTANT NOTE: UTMapLoader2 uploads maps from one of your local Unreal Tournament installations. You should always run a map in a local practice game to make sure it runs well, and is an appropriate map for your game server. If you cannot run it locally, there is a problem with the map and UTMapLoader2 will not be able to upload it to a game server. Uploading maps without testing them first is STRONGLY discouraged.
Open Windows Explorer and navigate to the folder where your Unreal Tournament game which matches the selected game server is installed. For example, if you've selected a UT 2004 server, navigate to your "C:\UT2004" folder. Navigate down to the "Maps" folder. Select a map file, press and hold the mouse button down, drag the file onto the UTMapLoader2 window, and release the mouse button. That's it - your map is being processed. You can use the Ctrl and Shift keys inside Windows Explorer to select multiple maps and drag them onto the UTMapLoader2 window in groups. You can drag additional files to the UTMapLoader2 window at any time - even when it's in the middle of uploading a map.
Notes
UTMapLoader2 tries to stay as quiet and unobtrusive as possible. Therefore, it doesn't provide you with much detail about the upload process unless the program just can't continue without your input. To find out the status of recent uploads, select the "View Log" menu option by right-clicking on the program's window. Your default browser will be launched to view the program's HTML log output. This log is cumulative - if you want to clear it, simply select the "Clear Log" menu option. Note that these options are unavailable until any in-progress uploads have completed.
Don't expect your map to appear right away in the game server's voting mechanism. It may take one or two map voting cycles for the map to appear. If it does not appear after that, contact a game administrator.
If your game server configuration includes a dedicated redirect, then UTMapLoader2 will automatically compress files and update the redirect server. The program uses the Unreal Tournament UCC.EXE engine for all compression purposes. For some unknown reason, some files take an inordinate amount of time for UCC to compress, while others compress extremely quickly, and it doesn't appear to be based on the size of the file. Unfortunately, this is Epic/Atari's issue, and there's nothing UTMapLoader2 can do to speed up the process.
Warning!
Please pay attention to any warnings issued by UTMapLoader2, as they indicate conditions that might keep the map from being playable on the game server. In particular, any warnings about "System Files" should be given special attention.
Let's say that you attempt to upload "CTF-TheMatrix.unr" and are given a warning about an "InfAdds.u" system dependency. If you continue through the warnings (by clicking the OK or check buttons), then the map "CTF-TheMatrix.unr" and the system file "InfAdds.u" will be uploaded to the server, but it is unlikely that the map will work. Why? The system file "InfAdds.u" (the Infiltration mod) needs to be a server package so that players will download it if necessary. To do this, a game administrator will have to stop the server, download the UT configuration file, add a line with the contents "ServerPackages=InfAdds" to it, upload the new configuration file to the game server, and finally restart the server. After all that, the map should work.
If you aren't familiar with the server administration process, answer "No" to any question that says "Do you want to continue?"
Questions or Problems?
Contact me at mrrogers@columbus.rr.com (email and MSN).