# Q3Radiant Editor Manual

# Installation & Set Up

Instalation of the editor has changed in the latest build. It is much more simple then before.

## Installing the editor

Run the setup file you downloaded of the latest GTKradiant program. You know longer have to install GTKRadiant to the Quake3 directory. It can reside in any directory you would like to have it.

## Setting up Paths

During installation you will be asked where your Quake3 game is located. Browse to the folder and select Ok. Then you will be prompted for a directory name for the Quake3 game pak. Setup will create this directory in the Quake3 game directory.
You will then be prompted for your Return To Castle Wolfenstein folder. Repeat the same process as you did for Quake3, only this time pointing to your RTCW directory.

## Improving Performance

If you find that the editor is sluggish on your system, try some or all of the following tweaks:

- On the View menu, check Cubic Clipping to be ON. This reduces the number of game components in view, by shortening the distance that the editor can "see." Use CTRL + to set the distance to 13 (a good number in this case).
- On the Textures menu, open the Render Quality option and select an option higher on the list than your current setting. We recommend not going below Nearest MipMap first. This reduces the amount of blending and filtering in the textures as they are seen in the Camera window, but still lets you see what the textures look like in a relatively undistorted manner. The Nearest setting will further improve performance, but textures may be distorted when seen in perspective.
- On View Menu, open the Entities as… option and select an option higher on the list than your current setting.
- Select Preferences … from the Edit Menu. Under “Display / 3D View”, deselect (uncheck) “Update XY views during mouse drags.” This will stop the 2D-map window(s) from being repeatedly redrawn during Camera window mouse drags.
- Select Preferences … from the Edit Menu. Under “Display / Texturing Settings”, move the slider bar under "Texture Quality" one or more settings to the left, reducing overall texture quality.
- Select Preferences - from the Edit Menu. Under “Interface / Editing”, lower the number of “Patch Subdivisions” to a lower number.
- Further performance can be gained by turning off curves (CTRL + p) or reducing curve displays to wireframe only.

## Setting up Preferences

To set up your editing preferences, open the Edit menu and select Preferences. Use preferences to set a variety of options and editor behavior based on your personal preferences.

Globals
Game Settings / Select The Game
GTKRadiant now stores preferences on a per game basis. For instance: Any settings you set up for Quake3 are stored for that game mode only. Switching to Return To Castle Wolfenstein mode, will use the preferences you setup when that Game mode was set up.

Display
2D Display

- OpenGl Display Lists - Uncheck this option if you encounter any graphic errors. This can some times cuase problems with bad opengl drivers.
- OpenGL Antialliased Points and Lines - This will render all points and lines in the 2D view using antialiasing. This can slow down the 2d view if your video card can not handle antialiasing very well.
- Solid Selection Boxes - This will make anything selected draw with solid lines rather then the old style of dashed boxes. This can slow down the 2D view as well.
- Display Size Info - If this is checked on, it will display the size information of any object selected.
- Alternate Vertex Edge Handles - This changes the shape (a little bit) of the vertex and edge points when in either vertex or edge manipulation mode.

3D View
Thanks to some new code. Radiants 3D View is Ultra fast.

- Movement Velocity - This will increase or decrease the movement of forward, back, and strafing speed in the 3d view.
- Rotational Velocity - This will increase or decrease the turning speed in the 3D View.
- Freelook in Camera View - With this checked, you will be able to use free look in the 3D View. Just Right Click in the 3d view to turn on free look, and Shift + Right Click again to turn it off.
- Invert Mouse In Freelook - This will reverse the mouse controls in freelook mode.
- Discrete Movement - If checked, this cuases the view in the 3d view to move one step at a time. If unchecked the movement is smoother.
- Update XY Views On Camera Move - When interacting with the camera (which you will do a lot), turning this off will NOT update the camera icon location in the Map windows automatically. This can help with speed but prevents you from seeing exactly where the camera icon is positioned.

Texture Settings

- Texture Quality - This will increase or decrease the texture quality displayed in the texture window and 3D View.
- Texture Subsets - This provides a texture edit window within the texture window. It is still buggy as of build 188. It puts a text field at the top of the Texture window. Type in the first few letters of a texture name and the window will only display the textures beginning with that letter or letters.
- Texture Scrollbar - If checked, this will add a scroll bar to the texture window.
- Tex Increment Matches Grid - If checked, this will cuase Radiant to use the grid spacing when moving and aligning textures with the shift + arrow keys.
- Default Scale - The default scaling of textures on load up of the editor.
- Startup Shaders - You can choose to have certain shaders load upong startup of the editor or to not have any load on startup.

Interface
Layout

- Layout - Choose 1 of 4 layouts.
  - Split Window View - This is the QeRadiant default view. The Camera, XY Map, Z-axis Scale, Texture, and Console windows are constantly displayed. While the arrangement of the windows cannot be changed, their size is adjustable by pulling the window border splitters. The Entity and Group windows share a common pop-up window. This arrangement is one that may work particularly well for mappers using smaller monitors and slower computers.
  - Floating Window View - This is the view used by id designers. The position, arrangement, and size of the windows are all adjustable. The windows initially come up on top of one another (a known bug), but once positioned, this view offers the greatest flexibility. The Camera, XY Map, Z-axis Scale, and a shared Entity/Texture/Console/Group window are all displayed simultaneously. Changing the size of one window does not automatically affect the others (it can lay atop the others). Additional map layout views can be cycled from menu commands or bound keys. This view only works well if you have a 20+-inch monitor.

    Make it Big! In floating windows mode (ONLY), you can double-click on any window’s Title Bar to enlarge the contents of the window to fill the screen. Double clicking on it again reduces it back to normal size.

  - Quad View - The display window is split into four equal-sized windows: Camera, XY Map, YZ Map, and XZ Map. This is similar to other editors and offers four-way viewing. You see the map components in three views simultaneously. The size of the windows (relative to each other) can be adjusted, by pulling the splitters. The combined Entity/Texture/Console/Group window is brought into view as a single, floating window that lays over the others. The Z-axis window is not used in this view. This is a popular editing configuration, but it has significant performance issues. The editor is drawing all the 2D map components three times (plus maintaining a camera view). Some mappers have notice significant performance slow-downs when working with curves. Using the Quad view is only recommended for mappers with more powerful computers.
  - Reverse Split Window View - Essentially the same as the Split Window view, except that the windows are all flopped left to right.
- Floating Z Window - This will make the Z-Window float in the Floating Window View mode.
- Patch Toolbar - Seems to have been disabled.
- Use Win32 File Load Dialog - If checked, this will use the common windows style file browser. Unchecked it will have the unique GTK / Linux X-Windows file browser.

Mouse

- 2 Button / 3 Button - Use 2 button mode or 3 button mode. Each mode is different in some ways. The hot keys and key combinations are generally different for each mode.
- Right Click To Drop Entities - If checked, this will create a menu where ever you click in the 2D View with a list of the entities you can select and place.
- Mouse Chaser - Turning this on causes the view to chase the mouse if you drag something off the edge.
- Alt + Multi-Drag - If this option is checked, you must hold down the ALT key to drag multiple brush edges. This lets you resize more than one brush at a time.
- Wheel Mouse Inc - This number will adjust the amount the texture window scrolls in the texture window when using the mouse wheel. The higher the number, the faster it scroll basically.

Editing

- Vertex Editing Splits Face - This will cuase face splits in brushes when in moving vertex points around and the brush becomes a concave shape.
- Fix Target/Targetname Collisions - This prevents duplicate target/targetnames from happening if you load a map into your current map. For instance: if you load q3dm7 into q3dm7, it adds _1 to duplicate target/targetname pairs.
- Cliiper Tool Uses Caulk - When using the clipper tool, the faces that are created from the clip will add a cualk texture to the brush.
- Dont Clamp Plane Points - This turns off clamping of plane points. This allows for very precise brush/vertex manipulation but can make it difficult to get things properly aligned and can also cause the bsp process to take a LOT longer. In general, this should be unchecked.
- Select Patches by Bounding Boxes - If checked, you will be able to select patches by there bounding boxes. Note: Bounding boxes for patches must be turned on.
- Rotation Increment - This allows you to choose the increments in pixels a texture is rotated when rotating a texture with the shift + pgup or pgdn keys.
- Undo Levels - Set how many undos you can do. This does require memmory so do not set it to high if you do not have alot of memmory.
- Patch Subdivisions - Select how many subdivisions are drawn on the patches in all views. If set to high it can slow down the editor. If set very low it will look blocky. Essentially it works like the games r_subdivisions option.

Other
Startup/Autosave

- Snapshots - If checked, this will create snapshots every 5 minutes of your level. They are saved into your maps directory and have a numbered order (eg. .001 .002) for the file extension.
- Load Last Project On Open - If checked, GTKRadiant will automatically load the project settings you last used.
- Load Last Map On Open - If checked, GTKRadiant will load the last map you had open during your last session.
- Auto-Save Every - Here you can choose to use auto saving, and how many minutes between each auto-save.

Paths

- Prefab Path - Here you can choose the directory of where you will have your prefabs ( .pfb ) stored.
- Game Path - This is now controlled by GTKRadiant. It displays the path of your game executable for which game mode you are in.
- User Ini Path - This will allow you to choose a user .ini file and its path.

Misc

- Light Drawing - This draws lights as shaded triangle things (octahedrons) instead of standard square entities. When enabled, the light entities also show their emitted light color.
- Log The Console To radiant.log - This will cuase GTKRadiant to create a log file of all output from the GTKRadiant console. This can cuase the editor to slow down, and is normally used for debugging purposes.
- Use Pak/PK3 Files - This will force GTKRadiant to read from .pak or .pk3 files before searching in the game directories like baseq3.

BSP Monitoring

- Enable BSP Process Monitoring - This will have a ms-dos window open when you compile a map from the BSP menu.
- Stop Compilation On Leak - This will cuase the bsp compile process to halt when a leak is found in a map during the BSP process.
- Run Engine After Compile - This will cuase the game to launch after the compile process is complete.
- Activate Sleep Mode When Running The Engine - This is automatic now. GTKRadiant will go into sleep mode when you load the engine after a compile.

  Warning. With some video drivers, it is a bad idea to run Quake 2 or Quake III Arena and the Q3Radiant editor. The drivers just will not sustain two demanding OpenGL applications simultaneously. This feature is best left turned off.

## The Project File

The project file contains the paths for the various GTKRadiant file-processing functions. Using the installer to set up the editor should write these for you.

New Project

This creates a new folder (which you must name) in your Quake III Arena or RTCW directory.
This is a good function for mods. You can use a different directory other then baseq3 if you plan to have alot of new resources and dont want to clutter it into the baseq3 folder.

Load Project

This opens up a browse directory pointed at the scripts directory. It is looking for a text file with a .qe4 file extension.

Changing the Project File

You can edit the project file by changing the pathnames to various functions in field of the dialogue window that pops up. HOWEVER, before doing this, you should make a backup copy of your Quake project file and give it a new name. Make your changes to this new file. If you mess things up, you can always reload the original. This is a good thing to do if you are making maps for a mod that uses a separate set of definitions for entities or directories for textures and want to easily change between types of projects.

Project Settings

Basepath: This traces a path, beginning in your root directory to the baseq3 where the editor expects to find resources.

Mapspath: This traces a path, beginning in your root directory, to the location where maps are saved and from which they are loaded. The default is the maps directory.

Rshcmd: This means "remote shell command." Use it only if you are directing a remote processing device (not your editing computer) to compile maps. The syntax for the field is: "rsh [processor name]"

Remotebasepath: If you are running your compile from your editing computer, this should be the same as your basepath. If you are working off a remote compling device, this should trace the full path to the to the baseq3 folder where the compiler will find the resources it requires.

Entitypath: This traces a path to the definition file for your game entities. This can either be a .c file which contains the game code, or a .def file which contains more instructive information about the entities.
Note: As of GTKRadiant 1.2.1 the default path for this is "Radiant", also known as the new game packs style it uses which allows for the remote installation of GTKRadiant anywhere on your computer.

Texturepath: This traces a path, beginning in your root directory, to the location from which textures are loaded. The default is the textures directory.

Menu commands
These commands are your map compile commands. You can CHANGE these commands or ADD your own. Each new command must start with “bsp_” The following is the compile command string for “bsp_Fullvis” taken off one of our project files.

! q3map $ && ! q3map -vis -threads 8 $ && ! q3map -light -threads 8 $

Command parameters:

! | The exclamation mark is replaced by the contents of the rshcmd field. It is the path to the processor.
$ | The dollar sign is replaced by the Mapspath.
&& | The double ampersand is the command terminator (end of command)
q3map | This is the process command. Without a switch after it, it performs the .bsp compile phase.
-vis | This is a switch to select the vis compile phase.
-light | This is a switch to select the lighting compile phase.
-threads | This is a switch to break the compile up into a number of different processor threads. The number of processors follows the switch parameter.

Other parameters

-onlyents | Process only the entities in the map.
-fast | A quicker process. However, it treats the map as if it were all one vis area.
-extra | As in -light -extra. This is a second lighting pass that more finely subdivides the map into areas of light and shadow.
-nowater | Compiled without liquids in the map. Used in the first compile phase only.
-nocurves | Compiles without curves in the map. Used in the first compile phase only.

Misc settings
Use brush primitives in MAP files.
Once this is set for a map, the program converts the texture mapping to this format. Once chosen, there is no going back to the old format. Brush primitives are described in detail under the Working with Textures section.

## Setting up the Windows

There are six configurable windows in Q3Radiant.

The Camera Window (CAM)
The Camera window initially shows a gray field. This is where the 3D in-progress view of your map appears. You can SHIFT + click mouse button 1 to select objects in this window. If the images in this window appear overly dark, you can adjust the gamma value. Open the Misc menu and select Gamma. Enter a value between 0 and 1 for the light value. Close the program. Reopen the program. Check the darkness. Repeat this until you have a value you like.

Entity/Texture/Console/Group Window
Depending on the Windows layout view that you’ve chosen, one or more of the following sub-windows share this window. They are selectable by the tab at the bottom of the window, or by shortcut keys.

Entity Window

The Entity window is one of four windows that share the same window space: Console, Entity and Texture and Group. The entity window is used to create and modify the properties of game entities. The uppermost box in this window contains the entity names. Use the scroll bar to find the one you want or for speed, type in the first letter of the class of entity you desire (“w” for weapon, “I” for item and so on). Refer to the Working with Entities section for more details on this.

Texture Window

The Texture window displays textures that have been loaded from the texture directories for easy use. The texture subset tool (set in preferences) allows you to quickly jump to a texture if you know the first few letters of its name. The scrollbar tool adds normal Windows functionality to the window. The most common method of navigating the window is to right-mouse click and drag through the window contents. SHIFT + right-mouse click and drag speeds up the rate of movement through the window’s contents. A thin green outline around a texture indicates a non-shadered texture in use in the map. A thin white outline indicates a shadered texture. A bold red outline indicates a selected texture.

Console Window

The console tracks the editor’s processes, like loading, saving, and compiling. When you compile (selecting an option from the bsp menu), the contents of the console are dumped into the junk.txt file in your Temp file folder on your root drive. In the Split Window view layout, the Console window is always in view.

Groups Window

This window will deal with the future grouping functions that will soon be a part of the editor. At this time, it is only a non-functioning window.

Z-axis Scale Window
This window is used by three of the four views to show the Z-axis position (height) of the Point of View and any selected map components.

Map Window(s)

The Grid
Think of the Map window as a piece of graph paper, neatly divided into squares. However, unlike graph paper, you can change the size of the grid to fit your needs of the moment. You can change grid size from the Grid menu, but it’s faster to learn the key shortcuts listed below.

Setting Grid Size

Grid size | Key
--- | ---
1 unit grid | (1)
2 unit grid | (2)
4 unit grid | (3)
8 unit grid | (4)
16 unit grid | (5)
32 unit grid | (6)
64 unit grid | (7)
Grid Down | Decreases the size of the grid. [ key
Grid Up | Increases the size of the grid. ] key

Grid and Window Layouts
There are four distinct ways of laying out the work windows for Q3Radiant.

Design Notes:
Try not to build architecture with a grid smaller than 8 units.
Use a smaller grid if you need to build small details.
Use a large grid (32 or 64) for roughing in a level.
Use a large grid for moving large chunks of architecture around.

Snap to Grid
When this is checked, the edges and vertices of brushes and patches will “snap” to grid coordinates. Unless you are attempting some very fussy maneuvering of a map component, Snap to Grid makes life much easier. In fact, if you are building objects out of curve patches, it is crucial that you be able to line up patch control points with the vertices of surrounding solid geometry brushes.

Colors
Q3Radiant allows you to select the colors of your grids and tools. Because the manual refers to the colors of some features, you may wish to wait until you are more comfortable using the editor before changing too many things. You can always revert to the Q3Radiant defaults, should you choose change too much.

To change Map window and Texture window colors, select the “Misc” menu and choose colors. The pop-up lists a number of options.

Themes
Brings up three options:

QE4 Original: The settings for id’s original Quake 2 editor
Q3Radiant Original: The default setting.
Black & Green: a black background with a green grid major.

Each of the following options opens the Windows color selector.

Grid Background…
The background color for the map window.

Texture Background…
The background color behind the textures in the texture window. This is probably best left a neutral color.

Grid Major…
These bolder grid lines mark 64 unit increments in the map window. These never change.

Grid Minor…
The finer grid lines in the map window.

Grid Text…
The color of the scale numbers along the left and top of the map window.

Grid Blocks…
These lines mark the 1024 x 1024 unit grids on the map.

Default Brush…
This is the color of unselected brushes in the map.

Selected Brush…
The color of selected brushes in the map.

Active View Name…
This is the text that says “XY Top” or “YZ Side” or “XZ Front” in the map view window(s).

Back | Home | Next