<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="main.css">
<TITLE>Project::OSiRiON - Creating models</TITLE>
</head>
<body>
<div class="banner">
<img src="images/banner.png" ALT="Project::OSiRiON">
<br>
Creating models
</div>
<div class="text">
<p>
The engine supports two kind of models: The first one are
Quake 3 style .map files with custom entities. The second
one are .ase models. Textures are supported, but no advanced features
like normal mapping.
</p>
<p>
The .map format allows for a quick and easy way to create usable
3D models, while the .ase format allows importing more complex
models made with modelling packages. The .map format is also used
as a container format to place model tags like lights,
particle effects and weapon locations.
</p>
<p>
.ase models can be loaded as sub-models into a .map file,
making modular spaceship design possible. Ship parts like engines
can be placed into seperate files and reused in other models.
</p>
<p>
The rest of the document describes how to create models using
Radiant and contains mostly information specific to creating
models for Project::OSiRiON. Even if you can handle Radiant,
it is still worth a read.
</p>
</div>
<div class="title">
Content
</div>
<div class="text">
<p>
<ul>
<li><a href="#gtkradiant">Creating models with Radiant</a>
<li><a href="#brushes_and_sizes">Brushes and sizes</a>
<li><a href="#caulk">Caulk</a>
<li><a href="#clip">Clip</a>
<li><a href="#detail_brushes">Detail brushes</a>
<li><a href="#materials">Materials</a>
<li><a href="#shaders_files">Shader files</a>
<li><a href="#lights">Lights</a>
<li><a href="#flares">Flares</a>
<li><a href="#particles">Particles</a>
<li><a href="#groups">Function groups</a>
<li><a href="#submodels">Submodels</a>
<li><a href="#other_entities">Other entities</a>
</ul>
</div>
<!-- =============================================================== -->
<div class="title" id="radiant">
Creating models with Radiant
</div>
<div class="text">
<p>
All the models for the game were created with GtkRadiant 1.5 and NetRadiant,
in theory any editor capable of exporting Quake 3 .map files could
be used. Support for files which can be used with NetRadiant or GtkRadiant 1.5
are included in the data distribution. Refer to the file INSTALL on where
to find them and how to install them. No map compiler is necessary,
the engine reads the .map files directly.
<p></p>
You can also use the NetRadiant distribution from
<a href="http://ingar.satgnu.net/gtkradiant">http://ingar.satgnu.net/gtkradiant</a>.
Note that it does not include the Osirion support files by default.
<p></p>
This document will not explain how to use the editor. Consult google
for numerous tutorials on this subject. All basic brush editing
techniques for any Quake-engine based game can be used.
<p></p>
The main difference with other games is that you are not creating
a map for a 3d-shoot'em'up, but obviously, an object that has to be
loaded into a space game.
<p></p>
Because there is no map compile involved, and the engine is fundamentally
different, some points should be take under consideration.
</p>
</div>
<div class="title" id="brushes_and_sizes">
Brushes and sizes
</div>
<div class="text">
<p>
The engine only supports brushes only, patches will be ignored. A large number
of complex brushes is supported, but I advise not to go below grid size 1.
As with any engine it is still possible to create brushwork that gets
messed up due to rounding errors.
<p></p>
When the model is loaded, the bounding box is calculated. The model will
be automaticly centered around the center of the geometry. All visible faces
will be converted to triangles. At the moment the practical triangle count
limit for a model is between 20,000 and 30,000 brushes. The engine is
capable of handling a lot more, but think about the fact that a large station
might be placed in a system filled with player ships and other objects.
<p></p>
The limits of map coordinates are placed on +/-16384 map units. Placing
brushes outside these bounds will have unpredictable results. The map
will be scaled down to make 1024 units in radiant correspond to 1 game unit.
One game unit corresponds to 100m in-game. 16 units in radiant will
therefor correspond to 1.5625 meters in-game.
<p></p>
The front of a model points along the positive X-axis, the positive
Z-axis is up, the positive Y-axis is left. In Radiant, the nose of
a spacesip or the front of a spacestation should point to the right.
</p>
</div>
<!-- =============================================================== -->
<div class="title" id="caulk">
Caulk
</div>
<div class="text">
<p>
Any brush face that has the <i>common/caulk</i> texture will be ignored on load.
Note that <i>common/caulk</i> is actually a special material with the <i>ignore</i> flag set.
</p>
<p>
Like in Quake 3 maps, all invisible brushes faces should have the this material.
</p>
</div>
<!-- =============================================================== -->
<div class="title" id="clip">
Clip
</div>
<div class="text">
<p>
Any brush face that has the <i>common/clip</i> texture will be ignored on load.
Note that <i>common/clip</i> is actually a special material with the <i>ignore</i> flag set.
Clip is reserved for future use.
</p>
</div>
<!-- =============================================================== -->
<div class="title" id="detail_brushes">
Detail brushes
</div>
<div class="text">
<p>
As with other engines, Osirion supports the use of detail brushes, but
with a twist: detail brushes will only be rendered if the model
is within detail range, close enough to the camera. When it is further away,
only structural brushes will be rendered. The actual detail range depends on the
size of the model.
</p><p>
This means that any object that could only been seen from close by
should be made from detail brushes.
</p><p>
This has one improtant implication: if you show the structural brushes
only (with the CTRL+D filter in Gtkradiant) there should be no obvious
gaps of caulk that were previously hidden behind detail brushes.
</p>
</div>
<!-- =============================================================== -->
<div class="title" id="materials">
Textures and Materials
</div>
<div class="text">
<p>
The engine can use TGA, JPEG and PNG images as textures and uses a simple
script based materials system similar to Quake 3 Arena shader files.
Materials make it possible use special textures like player and engine color,
or to apply certain effects to a texture.
</p><p>
The file <i>materials/shaderlist.txt</i> contains a list of shader files
that can be used by the engine. Each shader file can contain several materials.
</p><p>
The default shaderlist.txt looks like this:
</p>
<pre class="code">
common
colors
glass
</pre>
<p>
On startup, the engine will read materials from the files <i>materials/common.shader</i>
and <i>materials/colors.shader</i>. When loading a .map or .ase file the engine
will check if a texture name matches a known material. If a match is found,
the engine will use the settings found in the material script.
</p><p>
In radiant, the materials can be used as normal textures, like you can with
Quake 3 Arena shaders. A number of default materials are already defined
and can be used out of the box.
</p><p>
The materials in the <i>colors/</i> directory can be used to
draw brush faces with a specified color. The actual RGB color is defined
by the material script. Examples are <i>red</i>, <i>green</i> and <i>blue</i>.
</p><p>
The default set of colors is rather limited, more colors can be added by
using the <i>common/</i> family of materials. The actual in-game
color information for these faces will be provided by the engine.
</p><p>
The <i>common/entity</i> material represents an object's primary color.
In-game the faces with this texture will be drawn with the primary color of the entity
that uses the model. For example, a player's ship will have its owner's color.
Similar, the material <i>common/entity_second</i> represents the secondary
color of an entity. <i>common/entity_third</i> will be a mix of the primary and secondary color.
Each of these materials also has a <i>_dark</i> variant.
</p><p>
There are two special material that will cause the brush faces to be ignored
by the engine: as explained above, the <i>common/caulk</i> material can be used
on hidden faces. The <i>common/clip</i> material is reserved for future use
brush faces using this texture will be ignored as well.
</p><p>
For .ase models, the material name inside the .ase file is interpreted as an osirion material.
If you'd use a material called <i>common/entity</i>, those model faces will rendered using
the object's primary in-game color, regardless of the actual material settings in the .ase file.
</p>
</div>
<!-- =============================================================== -->
<div class="title" id="shader_files">
Shader files
</div>
<div class="text">
<p>
TODO: write a section on shader files.
</p>
<pre class=code>
// material name
textures/common/clip
{
// image used by the map editor
qer_editorimage textures/common/clip.tga
// image transparency in the map editor
qer_trans 0.20
// polygons using this material are ignored
ignore
}
</pre>
<pre class=code>
// material name
textures/common/entity_dark_bright
{
// image used by the map editor
qer_editorimage textures/common/entity_dark.tga
// use entity color
entity
// material color
color 0.5 0.5 0.5
// polygons using this material are rendered fullbright
bright
}
</pre>
<pre class=code>
// material name
textures/ship/plating_entity
{
// use entity color
entity
// use a texture, texture name and material name don't have to be the same
texture textures/ship/plating
}
</pre>
</div>
<!-- =============================================================== -->
<div class="title" id="lights">
Lights
</div>
<div class="text">
<p>
Unlike quake, <i>light</i> entities are not used to add lighting information
to the level but to add point lights to a model. Adding a light will
render a light flare texture in the corresponding location.
</p><p>
The <i>flare</i> value indicates what texture will be used to draw the light.
The flare value is translated to a texture name, <i>bitmaps/fx/flare??</i>.
The default flare texture is <i>flare00</i>.
</p><p>
The <i>light</i> value is used to determine the size of the flare. The engine
default is 100, resulting in rather large flares.
</p><p>
The default <i>_color</i> is white, but the color can be set through radiant's
color menu (K key). If the <i>entity</i> option (spawnflag 2) is set, the
color value will be ignored and the light will be rendered with the
color of the entity it is attached to.
</p><p>
The <i>strobe</i> option (spawnflag 1) will create a blinking light. A number
of options can be set to manipulate the flashing behaviour. By default
a strobe light will be half a second on, half a second off.
</p><p>
The <i>frequency</i> value changes the number of flashes per second.
</p><p>
The <i>offset</i> value changes the moment the light will be on. Offset is
measured in seconds.
</p><p>
The <i>time</i> value sets the fraction of time the light will be on.
The default is 0.5.
</p><p>
Lights will only be rendered if the model is within detail range.
</p><p>
I also came across this usefull information: <a href="http://en.wikipedia.org/wiki/Starboard">http://en.wikipedia.org/wiki/Starboard</a><br>
In short, the green light should be on the right side, the red light on the left side.
</p>
</div>
<!-- =============================================================== -->
<div class="title" id="flares">
Flares
</div>
<div class="text">
<p>
The default light entity creates omnidirectional lights. To create
a directional flare, use the <i>fx_flare</i> entity. Values for a
<i>fx_flare</i> are the same as those for a default light, with one
small diference: the size of the flare is set through the radius
value. The default flare radius is 100. Rotate the entity or set the
angle value to point the flare in a different direction.
</p><p>
Setting the <i>entity</i> option (spawnflag 2) will assign the entities
primary colour as flare colour.
</p><p>
Use the <i>engine</i> option (spawnflag 4) to create a flare that
lights up depending on engine power.
</p><p>
The direction of the flare can be set with the <i>direction</i>,
<i>pitch</i> and <i>roll</i> keys. <i>angle</i> is an alias for
<i>direction</i>.
</p><p>
Flares will only be rendered if the entity is within detail range.
</p>
</div>
<!-- =============================================================== -->
<div class="title" id="particles">
Particles
</div>
<div class="text">
<p>
Add a <i>fx_particles</i> entity to attach a particle system to the model.
They can be used to add effects like trails and smoke. A particle system
must be defined in <i>particles.ini</i> before it can be used.
</p><p>
The <i>script</i> value must be set to the label of the particles script.
</p><p>
Setting the <i>entity</i> option (spawnflag 2) will assign the entities
primary colour as particle system colour.
</p><p>
Use the <i>engine</i> option (spawnflag 4) will assign the models engine colour
as particle system colour.
</p><p>
The direction of the particle system can be set with the <i>direction</i>,
<i>pitch</i> and <i>roll</i> keys. <i>angle</i> is an alias for
<i>direction</i>.
</p><p>
Particles will only be rendered if the entity is within detail range.
</p>
</div>
<!-- =============================================================== -->
<div class="title" id="groups">
Function groups
</div>
<div class="text">
<p>
Brushes can be grouped together into funcion groups. These groups can be used
to create moving parts in a model.
</p>
<p>
<i>func_door</i> will be used to create animated doors (not implemented)
</p>
<p>
<i>func_group</i> an editor utility to group brushes together.
</p>
<p>
<i>func_rotate</i> will create a rotating set of brushes. The center of the rotation
is automaticly calculated as the geometrical center of the group.
The rotation axis can be set with the <i>direction</i>, <i>pitch</i> and <i>roll</i> keys. <i>angle</i> is an alias for <i>direction</i>.
</p>
</div>
<!-- =============================================================== -->
<div class="title" id="submodels">
Submodels
</div>
<div class="text">
<p>
<i>misc_model</i> can be used to add a submodel.
</p>
</div>
<!-- =============================================================== -->
<div class="title" id="other_entities">
Other entities
</div>
<div class="text">
<p>
<i>location_cockpit</i>, <i>location_dock</i>, <i>location_turret</i> and <i>location_cannon</i> are reserved but have not yet been implemented.
</p><p>
<i>location_cockpit</i> will be used to indicate where the cockpit of a vessel is located
and will be used to place the camera in cockpit mode.
</p><p>
<i>location_dock</i> will be used to indicate the location of docking ports.
</p><p>
<i>location_cannon</i> will create an attachment point for a cannon. Cannons are forward
shooting guns.
</p><p>
<i>location_turret</i> will create an attachment point for turrets. Turrets point upwards or downwards.
</p>
</div>
</body>
</html>