RTCW

RTCW

Updated 05 Apr 2018

Upper levels:
- QuArK Information Base
- 1. Introduction to QuArK
- 1.3. Configuration and Options
- 1.3.2. Games
- 1.3.2.1. Specific games

1.3.2.1.5. RTCW

[ Prev - Up - Next ]

Index

- Configuration (05 Apr 2018)
- Sound Editing (05 Apr 2018)
- Misc. Info. (05 Apr 2018)

Configuration

cdunde - 05 Apr 2018

[ Top ]

In this short tutorial I will be showing you how to quickly setup Quark to compile and run maps for the Return to Castle Wolfenstein or RTCW game engine. This particular games configuration is a bit more involved than most because it actually deals with two different compiler programs. Because of this, we have strived to preset as much of this as possible and even have included one of the compiling programs and its related files in its own folder located in the RTCW addons folder. But I will cover that in more detail a little bit later.

Part 1 – Setting up QuArK to work with RTCW
In this section we will quickly go over how to setup Quark to work with RTCW. To start with load up Quark, you should be greeted with the 'Quark Explorer' panel. The Quark Explorer allows you to define which game environment you wish to work in, as well as doing many other things.
First we need to select the game we want to map for. We do this by simply going to the 'Games' button located on the top right of the Explorer panel, once pressed it will present you with a drop list of all the currently available games, select RTCW as shown in the screen shot to the right.
Next we need to setup Quark to work with the RTCW game engine, which is actually a variation of the Quake 3 engine. To do so go back to the 'Games' button and press the 'Configuration' button at the bottom of the list.
Once selected a new window will be opened called 'Configuration', making sure you have RTCW selected on the left navigation panel, (under the Games Tab) as we now need to fill out some of the necessary game settings on the right of the Configuration panel which is shown in the configuration image further down.
But before we do that, go to your QuArK > addons > RTCW folder, copy the QuArK files folder that is there and paste it into your Return to Castle Wolfenstein game folder as shown to the right here. In the QuArK files folder is a sub-folder called bspc. In that folder is one of the compiling programs I spoke about briefly above and its related files.
The other folder shown below that is the second compiling program folder and its files. You will need to download the q3map_2.5.16_win32_x86.zip file from the Official QuArK site.
Also, see the Misc. Info. section below for more detailed instructions on its installation.

Part 2 – QuArK game pack download
This is the QuArK RTCW game support package. Download the QuArK_RTCW.zip file and extract it, using the folders path option, to the game folder location where you have RTCW installed on your computer.
All the paths to the "Main" sub-folder have already been set in the zip file. The zip file is about 64.7 MB and will take around 2 minutes with cable or DSL.
This package has been created to work with QuArK 6.5.0 alpha 8 or later and will give the most complete support available.
Every effort has been made working through the RTCW game files and other sources to allow the viewing of all available textures in QuArK's Texture Browser, all game models viewable in the 3D editor Texture views and detail entity settings with the use of pre-defined dropdown list, model selection and variations list, file selection capabilities for models and sounds, as well as 'color pickers' for all lighting functions. Even a few 'script\shader' corrections.

Part 3 – QuArK RTCW Configuration settings
As you can see in the image below, most of the settings have already been set with a default entry. While others have been pre-coded in QuArK's Defaults.qrk file that you can not see. This will prove to make life a lot easyer when you go to build and run your maps in RTCW.
RTCW command-line : Even though this is pre-set for you, I wanted to explain exactly what the added items are that follow the WOLFSP.EXE entry, the entire line is:

(two spaces)+set sv_cheats 1 lets you use the game console (by pressing the ~ Tilde key) developer commands like /noclip, /god and /give all.
+set fs_homepath main gives the path to the Main game sub-folder in the RTCW folder, where the .pak files are.
+set fs_game tmpQuArK a second tmpQuArK sub-folder will be created in the above Main folder, this sets it as a mod folder.
+set nextmap "spdevmap %filename%" this sets your map %filename% (a variable that holds your map's name) as the map to load into the game.
+exec this executes these commands and starts the game engine.

A couple of special points here:
If the intro-movie should start playing, just click your LMB once to bypass it and go right into loading your map.
If you want to reload your map, press the Esc key, click on "Load" > "Show Autosaves..." > your map name > "Load". This does not rebuild the map, just restarts it.
Directory of RTCW : If this does not match your RTCW folder location, use the ... button to select your RTCW folder.
RTCW CD_ROM drive : This is the location of the game cd if you need to operate it from there, just click on the ... button to select the cd drive.
Run these build-programs... : This allows the display of the building, compiling, process in QuArK's console.
Default directory of build-programs : Because there are actually two programs involved for compiling, we use this path for the first one, the bspc tool location.
Run tools from base directory : Do not check this box unless you plan to put both build programs in the same folder and set its folder path above.
Output Map Format : The default setting for "Brush Primitives" should be correct here. If not there are other options you can choose from or just type in your own.
1st through 3rd program : This are pretty self explanatory, just make sure the "q3map2.exe" is set to the correct path for you. If not just use the ... button to select the file.

4th and 5th program : Again, self explanatory, just make sure the "BSPC.EXE" path is set correctly, which was done above for the Default directory of build-programs .

6th program : The "Rename.bat" file (also in your bspc folder) is needed to correct a file naming error inherent with the "BSPC.EXE" program.

After you have finished setting Quark to work with the RTCW engine, simply hit the 'Apply' button, and then press the 'OK' button to close the Configuration panel. This will put you back in the Quark Explorer. Now is also a good time to close QuArK completely, this will save your settings in the Setup.qrk file. You're done!

Part 4 – Compiling

When you are ready to compile your map, simply select the "Go ![textures+build+Rctw]" main menu item, which is a "Full" build, meaning for, textures, their script files, AAS files (for bots) and lighting. This will cause QuArK to export the map file to your RTCW\tmpQuArK\maps folder, texture files to the textures folder and script files to the scripts folder. If any of the folders do not exist then QuArK will create them. Once that is done, QuArK will then start up the two building programs and the bat file to complete the process of compiling the map file and build the rest of the files needed to run in RTCW. Some of these additional game files will be placed in a second folder with the same name "tmpQuArK" but that folder will be in the RTCW "Main" game directory folder. Then the game will be started to load your map and display it !

The rest of the RTCW menu items are variations of the "Full" build process to expedite the compiling and in game viewing time when a "Full" build is not needed.
Because you have already completed the configuration steps above you will be able to see your map in QuArK's Textured 3D view. Even that part is automatically done for you. Just place your mouse cursor over that view, click your RMB and select "Textured" from the pop-up menu. Just a few more minor but important pointers in the Misc. Info. section below and you're good to go.

Sound Editing

cdunde - 05 Apr 2018

[ Top ]

There are various ways in QuArK to deal with sound editing by using .wav files. But because all of these files are stored in the games .pak files, they can not be used directly in QuArK. So in that case their path and full file name would need to be typed in where needed by hand. This is not only cumbersome but leaves a lot of room for errors. Because of this, we have setup "sound file selectors" where they are needed in the DataRTCW.qrk file for various entities when they use sound input settings. The only requirement to use this feature is that the "sound" folder needs to be extracted from the games .pak files.
Extracting .pak files & their placement
The games .pak files are nothing more than a type of .zip compression file and can easily be accessed to extract individual files or entire folders by either using a program that can extract ZIP files, PakScape v0.11 (my personal favorite) or any other archive program.
Once you have opened the .pak file, select the "sound" folder and drag it into your RTCW "Main" folder. You can now go to that "sound" folder by simply clicking on the "sound file selectors" button that looks like this ... and just select that sound.wav file that you want to use for any entity that has a selector.
Custom Sounds and Functions
By having the "sound" folder extracted and placed, as described above, you can now place any .wav file in that folder and select it for sound editing use. There is one important criteria though. The name of the .wav file must NOT have any blank spaces in its name or it will not be located and played in the game. You can, however, use lower dashes _ instead of spaces to separate words in its name.
If you wish to distribute any custom sound files with your map, just create a .pak file (using any ZIP-capible program and then renaming the ZIP-file to .pk3 or PakScape v0.11) and place a folder called "sound" in it with your custom.wav files located in that folder.
When using a "sound file selector", there are couple of nice functions that are available to you by clicking your RMB while you have your mouse cursor over a particular .wav file. This will bring up a standard system pop-up menu where you can select to either Play it before you actually select it (very handy), Rename it, change it's Properties or even Delete it, among other things.
Once a .wav file has been selected, QuArK will automatically trim its path and make other necessary changes so that the sound will now play properly in the game.
If a Sound Does Not Play
There is ONE exception to the rule here that I have found only with the "worldspawn" entity sound setting which will NOT play when your map is first loaded into the game after a build. If that should be the case for ANY sound file, the first thing you want to try is reloading your map while still in the game.
To do this just press the Esc key to bring up the game menu then select Load > Show Autosaves > your map > Load and it should solve the problem when your map reloads. If that does not work, then something else is causing this issue such as improper format Properties of the .wav file itself, which you can check by comparing those to another .wav file that does play and changing it to that type of format, using the RMB method I described above. That pretty well covers it for sound editing.

Misc. Info.

cdunde - 05 Apr 2018

[ Top ]

Installing the q3map_2.5.16_win32_x86 build tool
When you install this program you will need to direct it to the QuArK files folder as shown earlier in the Configuration section. That is really all you need to verify.
Changing and re-running a map
Normally, I run RTCW in a separate window, instead of its "Full Screen" mode when working on a map, for a couple of reasons.
First it's a lot easer to see around to view something in the editor that you might be concentrating on with your work.
The other is being able to jump back and forth between the editor and the game running by simply holding down the Alt key and pressing the Tab key to switch.
It seems less confusing that way.
Unfortunately it does not have the ability to make changes in your map while the game is still running and then rebuild and reload the map.
To do this you will need to close the game and go through the normal process once again.
But basically all you need to do is just click the QuArK menu item and off you go.
To close the game, press the Esc key and select "Exit" from its menu.
Custom textures or models not showing Textures
Open the model .mdc or md3 file with a text editor such as NotePad or WordPad, Do a search for "tga" to find the textures that the model uses, you will see the full path. Extract those textures and make new folders, with the exact same name and additional sub-folder(s), in your "Main" folder and place them in those folders.
Or you can just extract the entire "textures" folder from the .pak file and place that, with all the textures, inside the "Main" folder. BUT...if you use this method it could over write some of the QuArK_RTCW support textures image files. So it would be a good idea to re-install those afterwards, just to be sure everything is the way it should be.
This will also add those textures to the QuArK Texture Browser causing them to show up twice. The original ones are most likely "shaders" but the new ones will only be "standard" textures.
If a model is not displaying all of its "skin" textures and the texture image file (.tga or .jpg) is already in the proper folder location then it is very likely that it is a "script\shader" type of texture. Use its full path and name but without its suffix (.tga or .jpg) and do a search for it in the "scripts" folder and .pak files. Once you have located it look to see if it has a code line something like this:
rgbGen lightingdiffuse
If it does then that could be causing the problem. Copy that entire section of that shader code that starts with the full path and name along with, and including, the starting "left curly bracket" { and ending with the "right curly bracket" } and add it to the quarkcharacters.shader file in the "scripts" folder in your "Main" RTCW directory. Then comment that line out like this:
// rgbGen lightingdiffuse
This will turn off that particular code function and the model skin texture should now show up.
Texture Loading Game Error
It has come to our attention while setting up the QuArK_RTCW.zip file that there is at least one texture in the original RTCW pak0.pk3 file (textures\common\blackish.jpg) that causes RTCW to give an error in the game console that says:
Error: LoadTGA: Only type 2 (RGB), 3 (gray), and 10 (RGB) TGA images supported
and stops the game map from loading. The texture file itself is not bad, but for some unknown reason when this texture is used in QuArK and is opened in an "external editor", like PaintShopPro, it shows as a .pcx file and not a .jpg uncompressed file. When it is exported for the map file by QuArK, it is created as a .tga file, which is not the case at all, and causes this error.
So if you should receive this game error message this is what you should do. Clear out your "tmpQuArK\textures" folder, have QuArK "Prepare all textures and scripts", which is on the RTCW main menu in QuArK, then open each .tga and .jpg texture in the textures folder directly into PSP or Photo Shop. You are looking for two things:
1) That is IS a valid .jpg or .tga file.
2) And, that it is NOT a "compressed" image file. RTCW will give the same error is one is.
Once you find the offending file(s), create an uncompressed .tga file of it and place that new file in a folder called "textures" in your RTCW\Main folder. That will solve all the problems for both QuArK and RTCW, allowing you to continue to use that texture in the future. Please notify us so we can make the same correction.

Other Comments
Some entities and\or models do not work properly or at all. These are erroneous items that were not done correctly by other parties and is not a bug with QuArK. However, other entities may not have been fully understood as to their proper needs and settings which could be an item to bring to our attention for correction.

[ Prev - Top - Next ]