1. Summary
  2. Files
  3. Support
  4. Report Spam
  5. Create account
  6. Log in

Installation

From usarsim

Jump to: navigation, search

Back to the Manual

Previous Page

This document supports USARSim for following platforms: UT2004UT3UDK

Contents

Instructions for UDK

UDK

Installation instructions

Please see the readme file included in the release for the most up-to-date instructions.

  1. Download and Install the latest UDK (http://www.udk.com/, the last checked version is from Feb-2013). Install this to a directory named UDK\UDK-yyyy-mm. In this case 'yyyy' is the year of your UDK release and 'mm' is the month.
  2. Using a client such as Git Gui, open a bash window in the same directory that you specified in step 1 (UDK-yyyy-mm) and type:
     git clone git://git.code.sf.net/p/usarsim/code

When you have a sourceforge account which is added to the contributors list you have read/write access. In that case type:

     git clone ssh://yourUserName@git.code.sf.net/p/usarsim/code
  1. Move all of the files (including the .git folder) from the usarsim folder into the directory specified in step 1. Note that the .git folder is only visible when the Windows Folder View option 'Show hidden files and directories' is active.
  2. To compile USARSim, run "make" in the UDK-yyyy-mm folder.

Running

  1. Execute make.bat (might require Administrative privileges to run correctly)
  2. Start usarsim using one of the map bat files located in USARRunMaps

Editing/Compiling USARSim using MS Visual Studio

A tool called nFringe allows for the synchronization of unreal script (source) files inside Microsoft Visual Studio (tested with Microsoft Visual Studio 2010). For development, nFringe is highly recommended since it provides, among other things: color themes, building/compiling, intellisense (auto-completion), and "go to definition" for Unreal Scripts. To install, perform the following steps, after having installed UDK and USARSim:

  1. Download and install the latest version of nFringe from here (tested with version 1.2.23.0).
  2. Download the Visual Studio project for UDK and place it in the directory PATH_TO_UDK\Development\Src
  3. Open the newly downloaded project (MyUdkProject.ucproj) with MS Visual Studio. nFringe should load automatically and ask you to register it (nFringe is free for non-commercial use). If it does not, make sure that you register nFringe, otherwise MS Visual Studio with Unreal Script will not work (there should be an icon in the task bar that you can double-click and follow the on-screen instructions).

Instructions for UT3

UT3

Install UT3

Windows

  • Install UT3 using the installation disk to the default directory: C:\Program Files\Unreal Tournament 3
  • Install the UT3 patch found at: http://www.unrealtournament3.com/us/main.html (Select "Downloads" and then "Latest Patch"). These files is directly available from fileplanet.com.
  • Checkout the USARSimUT3 SVN Repository, found at http://sourceforge.net/projects/usarsim, to one of the following locations: (Either location will keep USARSimUT3 files in a separate subdirectory from the UT3 base files.)
    • For a root directory installation: C:\Program Files\Unreal Tournament 3\usarsim
    • For a home directory installation: My Documents\My Games\Unreal Tournament 3\usarsim

The root directory installation will install USARSimUT3 for all users, but requires administrator privileges. The home directory installation will only install USARSimUT3 for the current user, but requires no special privileges.

Compiling USARSim for UT3

To compile USARSimUT3, run the script usarsim\Src\make.bat. This script will automatically detect whether USARSim is installed into the UT3 root directory or the home directory, and set the appropriate flags for compilation. Upon running, a UT3 compilation window will appear. When compilation is complete, there may be a number of warnings (in yellow), but there should be no errors (in red).

If the autodetected settings do not work, they can be overridden by editing the path variables in the make script. However, this should not normally be necessary.

Running USARSim for UT3

  • Run the appropriate batch file in the usarsim\Unpublished\USARSimRunMaps (currently there’s only one).
  • Run Usar.exe or a telnet application to connect.

Instructions for UT2004

UT2004

Requirements

Operating System : Windows 2000/XP or. Linux

Software : UT2004 with the 3339 or later patch

Optional requirements : For the controller, we recommend MOAST, which is fully integrated with USARSim. In addition, Pyro (out of date) or Player may be used. The Pyro plug-in requires Pyro 2.2.1, and the Player USARSim drivers require Player

1.4rc2 or higher.

Uninstall UT2004

if you have a previous version of USARSim installed, it must be uninstalled. Users have several options to remove previous USARSim versions. Please note that %UT20024% refers to the Unreal Tournament main folder.

Windows

  1. Use the Uninstaller (USARSim Full version 3.00 or higher only)
  2. Run the Uninstall-USARSimFull.exe file located in the %UT2004% directory
  3. Uninstall Unreal Tournament by going to Start->Programs->Unreal Tournament 2004->Uninstall Unreal Tournament 2004, followed by
    • Manually delete the %UT2004% folder from your computer.
  4. Manually Delete Files
    • Manually delete the following folders, if they exist:

%UT2004%\Doc\
%UT2004%\Tools\
%UT2004%\BotAPI\
%UT2004%\USARBot\
%UT2004%\USARBotAPI\
%UT2004%\USARMisPkg\
%UT2004%\USARModels\
%UT2004%\USARVictims\

    • Manually delete the following files, if they exist:

%UT2004%\Animations\UDN_CharacterModels_K.ukx
%UT2004%\Sounds\SEERVoices.uax
%UT2004%\StaticMeshes\FreiburgRescue.usx
%UT2004%\StaticMeshes\IUB_meshes.usx
%UT2004%\StaticMeshes\spqrMapsMeshes.usx
%UT2004%\StaticMeshes\spqrRobotMeshes.usx
%UT2004%\StaticMeshes\TalonMeshes.usx
%UT2004%\StaticMeshes\USAR_Robots.usx
%UT2004%\StaticMeshes\USARSim_Hummer.usx
%UT2004%\StaticMeshes\USARSim_Sedan.usx
%UT2004%\StaticMeshes\USARSim_Submarine.usx
%UT2004%\StaticMeshes\Sub.usx
%UT2004%\StaticMeshes\USARSim_Cars.usx
%UT2004%\StaticMeshes\Hummer.usx
%UT2004%\StaticMeshes\USARSim_Vehicles_Meshes.usx
%UT2004%\StaticMeshes\USARSim_VehicleParts_Meshes.usx
%UT2004%\StaticMeshes\USARSim_Objects_Meshes.usx
%UT2004%\StaticMeshes\USARSim_LeggedRobots_Meshes.usx
%UT2004%\System\Hook.dll
%UT2004%\System\make.bat
%UT2004%\System\make.csh
%UT2004%\System\usar_c.bat
%UT2004%\System\usar_s.bat
%UT2004%\System\usar_t.bat
%UT2004%\System\USARBot.ini
%UT2004%\System\USARBotAPI.ini
%UT2004%\System\USARSim.ini
%UT2004%\System\BotAPI.ini
%UT2004%\Textures\IUB_textures.utx
%UT2004%\Textures\SEERS_girls.utx
%UT2004%\Textures\SEERS_gWounded.utx
%UT2004%\Textures\SEERS_Wounded.utx
%UT2004%\Textures\SEERSTextures.utx
%UT2004%\Textures\SEERSTexturesSG.utx
%UT2004%\Textures\spqrMapsTextures.utx
%UT2004%\Textures\spqrRobotTextures.utx
%UT2004%\Textures\TalonTexture.utx
%UT2004%\Textures\USAR.utx
%UT2004%\Textures\submarine.utx
%UT2004%\Textures\USARSim_Cars.utx
%UT2004%\Textures\Hummer.utx
%UT2004%\Textures\USARSim_Vehicles_Textures.utx
%UT2004%\Textures\USARSim_VehicleParts_Textures.utx
%UT2004%\Textures\USARSim_Objects_Textures.utx
%UT2004%\Textures\USARSim_LeggedRobots_Textures.utx
%UT2004%\ChangeLog
%UT2004%\README


Install USARSim

Windows

For non-developers:

1) Install Unreal Tournament. You will get a folder, which we will refer to as %UT2004% for these instructions.

2) Install the Official Unreal Tournament Patch V3369, which you can download at: http://data.unrealtournament.com/UT2004-WinPatch3369.exe. On a 64bits machine, also install ut2004-win64-3369.zip

3) Download the Editor Choice Bonus pack v1.1, because many maps use textures from this pack: ut2004-ecebonuspack1-1.exe

4) Download the usarsim-2004 files in the download section of the USARSim project page: http://sourceforge.net/project/showfiles.php?group_id=145394

5) Extract the files you just downloaded into the %UT2004% folder.

6) Compile USARSim by running the "make.bat" script in the %UT2004%/System folder.

For developers:

1) Install Unreal Tournament. You will get a folder, which we will refer to as %UT2004% for these instructions.

2) Install the Official Unreal Tournament Patch V3369, which you could download at: http://data.unrealtournament.com/UT2004-WinPatch3369.exe. On a 64bits machine, also install ut2004-win64-3369.zip

3) Download the Editor Choice Bonus pack v1.1, because many maps use textures from this pack: ut2004-ecebonuspack1-1.exe

4) Temporarily rename the %UT2004% folder to "usarsim". Put yourself in the folder above "usarsim".

5) Check out the latest source code snapshot from SourceForge. For instructions on doing this, go to: http://sourceforge.net/cvs/?group_id=145394

6) This will check out the USARSim source code snapshot into your "usarsim" folder, merging it with what's already there.

7) Change "usarsim" back to %UT2004%.

8) Download the base files in the download section of the USARSim project page: http://sourceforge.net/project/showfiles.php?group_id=145394

9) Extract the base files you just downloaded into the %UT2004% folder.

10) Compile USARSim by running the "make.bat" script in the %UT2004%/System folder.

11) From this point on, you can run periodic "cvs update" commands to get the latest snapshot, and recompile as in (8).

Linux

6) Install UT2004

7) Install the patch a. Download ut2004 patch at http://www.unrealtournament.com/ut2004/downloads.php b. Download and run the shell script http://www.hetepsenusret.net/files/ut2k*/ut2k4-patch to install the patch. For more details about usage, please run i. $ ut2k4-patch --help

NOTE: To make the code under windows, run the file make.bat that is located in the system directory. For linux users, the file make.csh should be executed.

NOTE: In addition to the worlds, the file AAA_MapBaseFiles_VX.XX.zip located under the BaseFiles release of the Maps package is necessary for most worlds.

There is a testing control interface written in C++. If you don't want to install any controller software, you can copy USAR_UI to your machine and try it. USAR_UI may be found under the "Tools' section of the Files release area on sourceforge. USAR_UI only works on Windows. You can use it to send commands to USARSim and investigate all the messages received from the Unreal server. NOTE: When you restore the zipped file, please make sure it is restored under the correct directory. If your directory structure looks something like "\ut2004\ut2004, you need to move all the files under "\ut2004\ut2004 to "\ut2004.

Install the controller

This step is optional. Install a controller only when you want to use MOAST, Pyro (out of date) or Player to control a robot in USARSim.

MOAST

MOAST fully supports USARSim. MOAST and all of its related packages may be retrieved from sourceforge. Additional packages that must be downloaded include gtki (image extensions to gtk used for graphical user interfaces), and rcslib (an interprocess communications package). These packages may be found on the release section of the MOAST site ( http://sourceforge.net/project/showfiles.php?group_id=148555 ). The rcslib archive is available as either source or pre-compilied for cygwin. The MOAST code may be retrieved from CVS. To retrieve the code, enter the following commands:

$ cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/moast login 
$ cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/moast co 
-P devel 

Information about accessing this CVS repository may be found in the document titled, " CVS (Version Control for Source Code) ". Alternatively, the latest snapshot may be retrieved from the release section of the MOAST site. MOAST requires a Linux style environment. This may be obtained by running a Linux operating system or by running cygwin under windows. More information on installing cygwin for a MOAST windows installation may be found under the "What else do I need" topic found at: http://moast.sourceforge.net/Column%20With%20Contents.htm#_What_else_do . In addition to the Linux style environment, a communications package known as rcs must be installed. This is available from the files area of the MOAST sourceforge repository in both source and pre-compiled cygwin formats. To install the pre-compiled version, simply download from http://www.sourceforge.net/project/showfiles.php?group_id=148555 and then unpack.

NOTE: When unpacking the pre-compiled version, use the following commands:

$ cd / 
$ tar "zxvf path_to_rcslib.tgz /rcslibV0.2-cygwin.tgz 

To install the source: Install the rcs library at /usr/local directory

$ cd / 
$ tar -zxvf path_to_rcslib.tgz /rcslibV0.2-src.tgz 
$ cd /usr/local/rcslib 
$ ./configure 
$ make 
$ make install prefix=/usr/local/rcslib 
$ cd src/java 
$ make 

If you want to use the MOAST supplied GUI, you need to make sure GTK and GTKI are installed on your machine. GTK is a standard package and will be automatically installed during the cygwin installation and is usually installed on Linux operating systems. GTKI may be found in the file release area of the MOAST repository. It should be downloaded and installed in the /usr/local/src directory. The following commands may be used to install GTKI:

$ cd /usr/local/src 
$ tar -zxvf path_to_gtki-1.9.tgz /gtki-1.9.tgz 
$ cd gtki-1.9.0 
$ ./configure 
$ make 
$ make install 

Then you need to set the PKG_CONFIG_PATH environment variable to tell the system where GTKI is located.

TIP: Use the following command to set PKG_CONFIG_PATH:

$ export PKG_CONFIG_PATH = "/path_to_gtki� 

MOAST may now be installed. Download the tar file from SourceForge or check the code out of CVS, and then execute the following commands:

$ cd /path_to_moast/ 
$ ./configure 
$ make 

NOTE: If checking out from CVS, you will need to issue the command $ before the configure command. ./bootstrap

All of the code in the MOAST repository is built using autotools. This allows for the ./configure to figure out your system's individual configuration and build the code appropriately

Pyro

Please note that the pyro interface is out of date and no longer supported. If someone would like to renew support for this interface, please mail the USARSim developer's mailing list.

Windows

Pyro is designed for Linux. Although Python, the development language used by Pyro, works under any OS system, Pyro uses some features only supported by Linux, such as Linux environment variables, shell commands. This makes Pyro only work on Linux. We have made Pyro work under Windows. The modified code can be found on pyro_win.zip. To install Pyro under windows:

1) Follow the Pyro Installation web page ( http://pyrorobotics.org/pyro/?page=PyroInstallation ) to install all the packages/software needed by Pyro. Please remember download and install the windows version.

2) After you restore Pyro, you need not run "make' to compile it. Since it uses gcc and gmake to compile files, you will need these installed on your machine or the makefile will not work. Furthermore, it also tries to use XWindow, so give up compiling it under windows. Since this step only affects the plugged third-part robots or simulators, it has no impact on USARSim. After you installed Pyro, you need to download and unzip pyro_win.zip (from the "Tools" section of the file release page on the USARSim repository) to overwrite the files in the Pyro directory. When the system asks you whether you want to overwrite the file(s) or not, please select "yes'. NOTE: When you restore the zipped file, please make sure it is restored under correct directory. If your directory structure looks something like "\Pyro\Pyro, you need to move all the files under "\Pyro\Pyro to …\Pyro.

Linux

1) Following the Pyro Installation web page ( http://pyrorobotics.org/pyro/?page=PyroInstallation ) to install Pyro.

2) Download the pyro_linux.tar from the "Tools" section of the USARSim files release page and restore it to the Pyro directory to install the USARSim plug- in.

Player

If you are new to player and not restricted by hardware player drivers that are only available for player-1.6, you should definitely use the latest player release (currently player-2.0.3). Player is primarily used on Linux system and other POSIX platforms. For Windows there is a work around to get Player 1.6.5 work with MinGW http://sourceforge.net/mailarchive/message.php?msg_id=15368188 .

For player 1.6, please follow the installation document in player1.6.tar.gz to install it. For other versions of Player, do NOT use the "configure" file in player.tar.gz or player1.6.tar.gz. You need to generate it by using GNU Autotools. The installation steps are:

1) Copy the "/usarsim directory in the player.tar.gz into your Player's server/drivers/ directory. So in your Player, you will have a directory like server/drivers/usarsim.

2) Open the "deviceregistry.cc" in the server/ directory and add the following lines before the definition of "player_interface_t interfaces[]':


#ifdef INCLUDE_USARSIM
void UsBot_Register(DriverTable *table);
void UsPosition_Register(DriverTable *table);
void UsPosition3d_Register(DriverTable *table);
void UsSonar_Register(DriverTable *table);
void UsLaser_Register(DriverTable *table);
void UsPtz_Register(DriverTable *table);
#endif 

And then add the following lines into the function "register_devices()':

#ifdef INCLUDE_USARSIM
UsBot_Register(driverTable);
UsPosition_Register(driverTable);
UsPosition3d_Register(driverTable);
UsSonar_Register(driverTable);
UsLaser_Register(driverTable);
UsPtz_Register(driverTable);
#endif 


3) Go to the server/drivers/ directory, add "usarsim' to ‘SUBDIRS' in the file "Makefile.am".

4) Under the Player directory, append the following line into "acinclude.m4' right after other PLAYER_ADD_DRIVER sentences. PLAYER_ADD_DRIVER([usarsim],[drivers/usarsim],[yes],)

5) Add "#undef INCLUDE_USARSIM" to ‘config.h.in' file.

6) In the "configure.in' file, add the following line to AC_OUTPUT. server/drivers/usarsim/Makefile

7) Go back to the Player directory, use the following commands to generate the "configure" file:

$ aclocal 
$ autoconf 
$ automake --add-missing 

8) Follow the Player User Manual to compile and install Player.

To install Player 2.0.3 and our USARSim Player drivers:

1) Download Player 2.0.3 from: http://sourceforge.net/project/showfiles.php?group_id=42445

2) Restore Player on your machine.

3) Restore player.tar.gz located in the "Tools" section of the USARSim file release area to your Player directory. Please make sure all the files are put under the correct directory. Execute the autogen_usarsim.sh script. This script patches some player files. It needs autoreconf installed on your machine.

4) Follow the Player User Manual to compile and install Player. That is, execute the following commands:

$ ./configure 
$ make 
$ make install 

If you want to install Player in another directory rather than /usr/local, you need to use the command:

$ ./configure "prefix <your directory>


Next Page

Personal tools
Navigation
Competitions