Installing Carball

Introduction

This document describes the installation methods available for installing the Carball mod and provides installation related tips and troubleshooting information. Installing the Carball mod is quite simple and in fact the majority of users will have no difficulty after reading the Installation section of the Quickstart Guide. However, additional detail is provided in this guide for those who would benefit from some extra assistance.

The Carball file is available as a compressed archive (usually provided in ZIP format) or as a UMOD. You only need one version or the other to install the mod. Generally speaking, the compressed archive is smaller than the UMOD file, however the UMOD file is considered the easier to use option.

(It is possible to compress a UMOD using ZIP, RAR or other compression format. If your file is a compressed archive of a UMOD, just uncompress and use the resulting UMOD file as described below under the "Using the UMOD File" section.)

You can download the full Carball installation package from the Carball Files Section. The download package is available in ZIP, RAR, and UMOD formats. There are also many other maps created by Carball players that are not included with the default Installation packages, which can also be found in the Carball Files Section.

Basic Installation

Using the UMOD File

UMODs are "Unreal Module Files"; files that self extract and automatically order themselves into the appropriate directories. They are like programme installers, but are used specifically for installing game content for an Unreal Engine based game. Typically, a UMOD file for Unreal Tournament 2004 (UT2004) will end in the extension ".ut4mod" without the quotes.

UMOD Installer screenshot

If you have the UMOD version, just run the UMOD file by double clicking on its icon and it will do all the installation work for you.

The MacIntosh and Linux versions of UT2004 do not have full support for UMODs. Mac users can use a command line for installing UMODs. The command is as follows:

cd '/Applications/Unreal Tournament 2004.app/System/'./ucc-bin umodunpack -x Carball.ut4mod -nohomedir

(Linux and MacIntosh users can install UMODs in a much easier way using the information found under the Installation Tips section.)

Using the Compressed Archive ZIP File

Compressed archives are files that have had their size reduced by putting them into a format that takes up less storage space, but cannot be run by a computer. Uncompressing these archives restores them to their original size and allows the computer to use the file. The Carball mod can be distributed in any compressed archive format, but it is usually distributed as a ZIP or RAR file. ZIP files typically end in ".zip" and RAR files typically end in ".rar" without the quotes.

In order to install the Carball mod from ZIP, RAR (or other compression format) file, use an uncompression programme to expand the archive into the root directory of your Unreal Tournament 2004 installation.

So, for example, if you installed UT2004 in C:\Games\UT2004, tell your uncompression programme to expand the mod file to C:\Games\UT2004.

As another example, if you installed the game to D:\Games\FPS\UT2004, tell the uncompression programme to expand the mod file to D:\Games\FPS\UT2004.

As a further example, if you installed the game to hda2/games/ut2004, tell the uncompression programme to expand the mod file to hda2/games/ut2004.

The action of uncompression will place the files into the correct existing UT2004 directories and create the required new directories as long as you uncompress the file into the UT2004 root directory.

See the Resources section bellow for info on uncompression programmes.

Installation Tips

Full support for UMODs is only available on Windows even though there are MacIntosh and Linux versions of UT2004. However, an individual programmer wrote a Python script that will extract files from UMODs and place them into the correct directories. Python is a scripting language with many dedicated devotees that is used in a wide variety of applications. You can learn more about Python here and through the Python newsgroup comp.lang.python. The aforementioned Python web site provides information on installing Python on various platforms. Once it is installed, you will then be able to run the UMOD Python script that is obtainable here. (Please note that the author of this script is unrelated to the Carball Dev Team, has probably never heard of Carball, and probably should be thanked if you use her script.)

Information on patches and bonus packs mentioned in this document may be found at Epic's official Unreal Tournament web site, as well as major Unreal community web sites such as (but not limited to) Beyond Unreal and Planet Unreal.

It may be helpful to know that Epic Games has released a bonus pack called the UT2004 Mega Pack which includes the ECE Bonus Pack and the 3369 patch in one file.

The Python script that will extract files from UMODs and place them into the correct directories referenced above will work with Windows systems that have Python installed.

Although not directly related to these issues, the following information may be helpful to Linux and Mac users who wish to install the ECE Bonus Pack. Beyond Unreal on their Essential Downloads page state "Linux/Mac users can unzip this file, delete the System/user.ini and Help/UT2004Logo.bmp files (as well as any .dlls or .exes), then copy the rest of the files to their installation (thanks Ryan Gordon)."

There are utilities to allow for better manipulation and easier creation of UMOD files. You may be able to install the UMOD file using one of these utilities if you are otherwise experiencing difficulty. You may just find it convenient to use one of these tools for better UMOD management. One example for Windows is UMOD Tool. One example for the Mac is the Santaduck Toolpak for Macintosh UT2004. Other UMOD utilities can be found on the UnrealGeeks Tools page.

StuffIt Expander, which now comes with MacOS X, will also expand ZIP and RAR files. (There is also a programme for Windows and Linux to expand StuffIt format files available from the makers of StuffIt, Allume which also does a very good job of expanding ZIP and RAR files.)

Troubleshooting UMOD Related Issues

Problems with UMOD installations are rare, but they can happen. The most common issue is that nothing happens when the user double clicks on the UMOD under Windows. Below are some possible solutions.

UMODs being unresponsive can be caused by incorrect file type associations in Windows. Use Tools -> Folder Options -> File Types from any directory window to change the file associations. Basic steps to accomplish this are described below, however you should refer to your Windows manual for details. Hyperlinks to screenshots that may further assist you are included in each entry.

  1. From any directory window use the drop down menu to choose "Tools" -> "Folder Options" and then select the "File Types" tab.
  2. Scroll down the the list and highlight the file type "UT2004 Module". Then press the "Advanced" button. (If you cannot find an Unreal Module entry press the "New" button and add a new file type with the extension UT4MOD.)
  3. Now select the "New..." button in order to create a new action and name the action "Install Umod" without the quotes. (You can also name the association and change the associated icon in this window, but this is not necessary.)
  4. In the "Application used to perform this action" text field enter the path for your UT2004 setup file plus the command 'install "%1"' without the single quotes ('). For example if you installed UT2004 to the Games directory on your D drive, you would enter 'D:\Games\UT2004\System\setup.exe" install "%1"' without the single quotes. Another example would be if you installed UT2004 on the root of your C drive you would enter 'C:\UT2004\System\setup.exe" install "%1"' without the single quotes. In the Action text field, enter "Install Umod" without the quotes.
  5. Press the "OK" or "Close" button on each of the dialogue windows you opened to perform these operations. You are now done.

The Unreal Wiki has a UMOD problems section.

Some issues are caused by installing game updates in the incorrect order. You should install the basic game, the Epic ECE Bonus Pack, then the most recent patch and do so in that order. Installing a patch before installing the Epic ECE Bonus Pack can cause many strange and hard to identify issues with UT2004, including UMOD issues. If you installed game updates in the wrong order, you may have some success by just installing most recent patch again. Uninstalling the game, then reinstalling it, then adding the Epic ECE Bonus Pack, then installing the most recent patch should not be necessary, however you may wish to do so if all else fails.

One member of the Carball Community reported that copying the "setup.exe" file from the most recent patch and copying it over the "setup.exe" file in UT2004's System directory solved his issues with UMODs not being responsive after all else failed. This is not recommended as this was done with the 3339 patch which is no longer the most recent update. Additionally, the root cause of the issue and the reason the solution worked are both unknown. The information that prompted that particular user to attempt this solution, as well as the file he used to extract the "setup.exe" file (called "3339bug.zip") cannot currently be located.

Using one of the UMOD tools referenced above in the Installation Tips section may solve any UMOD issues you have.

Directory Structure

For general reference, here is a description of the directory structure of Carball. You should never have to install these files manually, but if you wanted to do so, you could.

A directory called "CBall" should appear under the UT2004 root directory. It should have the following sub directories: "Animations", "Help", "Maps", "StaticMeshes" and "Textures". The CBall directory should also contain one or more readme files in plain text format and a graphic file called "CBInstaller.bmp". The Carball installation will also place some files into the pre-existing UT2004 directories. After installing Carball, your System sub-directory under the UT2004 root directory should contain files called "CBall.ucl", "CBall.u", "CBall.int", and "CoerPack.u".

A primitive tree diagram of the Carball directory structure would appear something like this:

Carball Directories

Carball files ending in ".ukx" belong in the CBall/Animations directory.

Carball files ending in ".usx" belong in the CBall/StaticMeshes directory.

Carball files ending in ".utx" belong in the CBall/Textures directory.

Files ending in ".ut2" are maps, which belong in the UT2004/Maps directory. (If they begin with "CB-" they are Carball maps and can go in the CBall/Maps directory.)

Files ending in ".ogg" are sound files, which belong in the UT2004/Music directory.

Files ending in ".u", ".ucl", ".ini", or ".int" belong in the UT2004/System directory.