Setting Up CVS Access to Realm Wars

Introduction:

The following information is provided for those people who wish to download and access the Realm Wars source from the CVS servers provided by GarageGames. Note: this information is essentially the same as this document provided by GarageGames except that it has been modified specificly for RealmWars CVS.

Before you continue, you should ensure that you have the following:

• You have a CVS program (such as WinCVS) downloaded and installed.
• You are a Torque Game Engine liscensee (this information is required to access the CVS server).

Configuring & Using WinCVS 1.2

These instructions are for version 1.2 of WinCVS. There are a number of dialog box changes in the latest developement 1.3 "beta" release of WinCVS and these instructions will not work.

Step 1: Admin Preferences Start with the first General tab.

To access the repository, WinCVS must know the location of the GarageGames repository (the cvs root). This is done as follows: Launch WinCvs and select Admin - Preferences from the menu. The WinCVS Preferences dialog box will appear. Enter the following into the CVSROOT field:

your_login@cvs.garagegames.com:/cvs/realmwars

Where your_login is your GarageGames website login name. Please note that WinCVS does not handle spaces in login names. If your GG login name has spaces in it, then replace the spaces with the _ character when entering it for WinCVS. Once this field is entered you need to set the dialog's Auhentication field to:

"passwd" file on the cvs server

Next, the Globals tab:

Now select the Globals tab, check the Use TCP/IP compression check box and set the compression number to 6. To help reduce bandwidth usage, the GarageGames CVS server requires that all cvs operations be compressed. The higher the number, the higher the compression, but the more CPU load on the GarageGames server. The recommended value is 6. The server will abort connections that do not have compression set.

Click the OK button to complete the setup.

Step 2: Login

Now select Admin - Login from the menu and enter your GarageGames website password. If this is the first time you've run WinCVS you you will be asked for a Home Directory. This directory is where WinCVS will store a your login and password information so that it doesn't have to be entered every time WinCVS is run. If you don't have a specific home directory, simply select the C:\ root directory.

If your login and password are accepted, the output status window will display the ***** CVS exited normally with code 0***** message. If CVS exits with "code 1", your login/password was rejected.

Step 3: Checkout

Once you've successfully logged in, select the Create - Checkout Module menu option. The Checkout Settings dialog box will appear. In the Enter the module name.. field enter the name realmwars, then select the local destination project folder in the local folder to checkout to: field. This is the folder into which the SDK will be downloaded. Please do not enter a name with spaces in it, this causes problems with the build process. To keep things simple, select the root of your C drive: C:\ Once the checkout is complete the SDK will be located in the C:\realmwars directory.

Note: Currently Realm Wars does not use version tags, this might change in the future, so it is recommended that you leave the version tag option blank so that it will pull down the latest version.

Press the OK button to start the checkout. You should see a scrolling list of the files being downloaded to your machine.

Once the checkout is done you should have a copy of the SDK on your machine.

Getting Updates

Checkouts consume a lot of CPU time and bandwidth. Developer bandwidth is also metered, so it is recommended that you do not repeatedly checkout the SDK unless it is necessary. If you have checked out the head version of the SDK (by not specifying a version tag), then you can periodically update to the latest version of the SDK by using the update command. First select the torque directory from the WinCVS file browser window. The select the Modify - Update Selection menu option. The update command retrieves only the minimal number of files required to bring your version up to date.