ef2-ubertools-gdk/Documentation/start.html

320 lines
17 KiB
HTML
Raw Normal View History

2003-08-18 00:00:00 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title><EFBFBD>berTools Game Development Kit</title>
<link rel="stylesheet" href="content/style.css">
<script type="text/javascript">
/***********************************************
* Switch Menu script- by Martial B of http://getElementById.com/
* Modified by Dynamic Drive for format & NS4/IE4 compatibility
* Visit http://www.dynamicdrive.com/ for full source code
***********************************************/
if (document.getElementById){ //DynamicDrive.com change
document.write('<style type="text/css">\n')
document.write('.submenu{display: none;}\n')
document.write('</style>\n')
}
function SwitchMenu(obj){
if(document.getElementById){
var el = document.getElementById(obj);
var ar = document.getElementById("masterdiv").getElementsByTagName("span"); //DynamicDrive.com change
if(el.style.display != "block"){ //DynamicDrive.com change
for (var i=0; i<ar.length; i++){
if (ar[i].className=="submenu") //DynamicDrive.com change
ar[i].style.display = "none";
}
el.style.display = "block";
}else{
el.style.display = "none";
}
}
}
</script>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<a name="top"></a>
<table width="702" border="0" align="center" cellpadding="0" cellspacing="0">
<tr>
<td colspan="3"><img src="images/header.jpg" width="702" height="101" border="0"></td>
</tr>
<tr>
<td width=158 valign="top"><table border="0" cellspacing="0" cellpadding="0">
<tr>
<td valign="top" class="menu">
<!-- Keep all menus within masterdiv-->
<div id="masterdiv">
<img src="images/navigation.jpg" width="158" height="27"><br>
UberTools GDK
<div class="menutitle" onclick="SwitchMenu('sub0')">&raquo; Introduction &amp; Contents</div>
<span class="submenu" id="sub0">
&nbsp;&nbsp;&nbsp;&nbsp;<a href="start.html">Introduction</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="start.html#2">Utilities</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="start.html#3">Source Files</a><br>
</span>
<br>Level Design<br>
<div class="menutitle" onclick="SwitchMenu('sub1')">&raquo; Setting Up UberRadiant</div>
<span class="submenu" id="sub1">
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_setup.html">That Scary Error Msg</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_setup.html#2">General Tab</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_setup.html#3">Display Tab</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_setup.html#4">User Interface Tab</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_setup.html#5">Keyboard Shortcuts Tab</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_setup.html#6">Colors Tab</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_setup.html#7">Game / Paths Tab</a><br>
</span>
<div class="menutitle" onclick="SwitchMenu('sub2')">&raquo; Building Your First Room</div>
<span class="submenu" id="sub2">
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_firstroom.html">Editor Interface Basics</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_firstroom.html#2">Choosing Your Textures</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_firstroom.html#3">Building The Room</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_firstroom.html#4">Adding a Light</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_firstroom.html#5">Adding a Player Start</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_firstroom.html#6">Compiling Your Level</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_firstroom.html#7">Viewing the Level</a><br>
</span>
<div class="menutitle" onclick="SwitchMenu('sub3')">&raquo; Constructing Terrain</div>
<span class="submenu" id="sub3">
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_terrain.html">Setting up the Tools</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_terrain.html#2">Creating Terrain</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_terrain.html#3">Modifying the Textures</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/radiant_terrain.html#4">Adding More Terrain</a><br>
</span>
<div class="menutitle" onclick="SwitchMenu('sub4')">&raquo; Additional Reference</div>
<span class="submenu" id="sub4">
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/ldesign_lighting.html">Lighting System</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/ldesign_terrain.html">Terrain Texture Blending</a><br>
</span>
<br>Scripting<br>
<div class="menutitle" onclick="SwitchMenu('sub5')">&raquo; Scripting Tutorials</div>
<span class="submenu" id="sub5">
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_syntax.html">Scripting Syntax</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_waves.html">Spawning Waves</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_flying.html">Creating Flying Creatures</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_tripwires.html">Setting Up Tripwires</a><br>
</span>
<div class="menutitle" onclick="SwitchMenu('sub6')">&raquo; Global Script Synopsis</div>
<span class="submenu" id="sub6">
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts.html">Introduction</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_accelmove.html">global_accelerated</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_accelmove.html">Movement.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_archetype.html">global_archetype.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_array.html">global_array.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_cinefx.html">global_cinematicFX.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_common.html">global_common.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_debug.html">global_debugUtils.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_flyin.html">global_flyin.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_math.html">global_math.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_ploadout.html">global_playerLoadout.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_soundpan.html">global_soundPan.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_spawnwave.html">global_spawnWave.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_transport.html">global_Transport.scr</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/scripting_globalscripts_tripwire.html">global_tripwire.scr</a><br>
</span>
<div class="menutitle" onclick="SwitchMenu('sub7')">&raquo; Classes Reference</div>
<span class="submenu" id="sub7">
&nbsp;&nbsp;&nbsp;&nbsp;<a href="allclasses_g.html">Game Module</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="allclasses_cl.html">Client Module</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="allclasses_cg.html">Client Game Module</a><br>
</span>
<br>Older Documentation<br>
<div class="menutitle" onclick="SwitchMenu('sub8')">&raquo; Heavy Metal FAKK2</div>
<span class="submenu" id="sub8">
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/fakk2_camera.html">Camera Documentation</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/fakk2_clientsidecmds.html">Client Side Commands</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/fakk2_gui.html">GUI Documentation</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/fakk2_ingameutils.html">In-Game Utilities</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/fakk2_max2skl.html">MAX2SKL Reference</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/fakk2_shadermanual.html">Shader Manual</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/fakk2_soundsystem.html">Sound System</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/fakk2_tiki.html">TIKI Model System</a><br>
</span>
<br>Other<br>
<div class="menutitle" onclick="SwitchMenu('sub9')">&raquo; Web Links &amp; Credits</div>
<span class="submenu" id="sub9">
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/other_links.html">Web Links</a><br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="content/other_credits.html">Credits</a><br>
</span>
</div>
</td>
</tr>
</table></td>
<td width="13" background="images/vert_line.jpg"><img src="images/vert_line.jpg" width="13" height="1"></td>
<td valign="top" width="533"><p class="header"><br>
&Uuml;bertools gdk documentation</p>
<p class="subheader">introduction</p>
<p>Thanks for downloading the &Uuml;berTools Game Development Kit!</p>
<p>Ritual's &Uuml;berTools for Quake III v4.0 offer a lot of potential for
creating user made content. Whether you&#8217;re looking to create a total
conversion, a player model, or a level, the &Uuml;berTools provide you
with lots of power and flexibility. There are so many features to cover
that we just could not document them all, but we&#8217;ve tried to cover
the major areas, and then provide you with ways on where to look to find
some additional help. So sit back, relax, and welcome to the wonderfully
magical world of the UberTools.. *insert wonderfully magical world music
cue here*</p>
<p>As with most GDKs, the &Uuml;berTools are released as-is and are not
an officially supported product by Ritual Entertainment or Activision.</p>
<p>This documentation consists of four major sections:</p>
<table width="100%" border="0" cellspacing="4" cellpadding="0">
<tr>
<td width="28%" valign="top"><b>Level Design</b></td>
<td valign="top">-</td>
<td>Contains setup instructions and tutorials for &Uuml;berRadiant,
the latest generation of Ritual's in-house map editor.</td>
</tr>
<tr>
<td valign="top"><b>Scripting</b></td>
<td valign="top">-</td>
<td>Contains tutorials and reference material for Ritual's scripting
language. </td>
</tr>
<tr>
<td valign="top"><b>Older Documentation</b></td>
<td valign="top">-</td>
<td>This section features documents that were originally written for
Heavy Metal FAKK2, but which may still apply to newer generations
of the &Uuml;berTools.</td>
</tr>
<tr>
<td valign="top"><b>Other</b></td>
<td valign="top">-</td>
<td>Contains web links and GDK credits.</td>
</tr>
</table>
<p>In addition to the documentation and the utilities listed below, we've
included two single player levels, a multiplayer map and one of the character
models from the game. Examining those files should answer most of your
questions not discussed in the documentation. </p>
<p class="subheader"><a name="2"></a>Utilities</p>
<p>The following is a list of tools and utilities included with the &Uuml;berTools
GDK. Some of these utilities are DOS-based and need to be executed from
a command prompt. </p>
<table width="100%" border="0" cellspacing="4" cellpadding="0">
<tr>
<td valign="top" class="menu">\bspc.exe</td>
<td valign="top">-</td>
<td>Used to generate an .aas file for a multiplayer map. This enables
bot support.</td>
</tr>
<tr>
<td valign="top" class="menu">\ubermap.exe</td>
<td valign="top">-</td>
<td>Compiles a .map source file into a .bsp file that can be loaded
by the game engine (<a href="content/radiant_firstroom.html#6">more</a>).</td>
</tr>
<tr>
<td valign="top" class="menu">\radiant.exe</td>
<td valign="top">-</td>
<td>Map editor, used to create a .map level file.</td>
</tr>
<tr>
<td valign="top" class="menu">\UBER Tools EULA.doc</td>
<td valign="top">-</td>
<td>The GDK license agreement. Read this carefully to find out what
you can and cannot legally do.</td>
</tr>
<tr>
<td valign="top" class="menu">\Documentation\start.html</td>
<td valign="top">-</td>
<td>What you're reading right now.</td>
</tr>
<tr>
<td valign="top" class="menu">\Utilities\dlgedit2.exe</td>
<td valign="top">-</td>
<td>Used to created graphical user interfaces that can be used by the
game engine (<a href="content/fakk2_gui.html">more</a>).</td>
</tr>
<tr>
<td valign="top" class="menu">\Utilities\fontgen.exe</td>
<td valign="top">-</td>
<td>Used to generate .ritualfont fonts that can be used by the game
engine. </td>
</tr>
<tr>
<td valign="top" class="menu">\Utilities\LODTweak.exe</td>
<td valign="top">-</td>
<td>Used to edit level-of-detail distances in .tik files.</td>
</tr>
<tr>
<td valign="top" class="menu">\Utilities\Lipsync\lipsync.exe</td>
<td valign="top">-</td>
<td>Used to generate lipsyncing files for characters.</td>
</tr>
<tr>
<td valign="top" class="menu">\Utilities\Lipsync\mss32.dll</td>
<td valign="top">-</td>
<td>Sound driver required for lipsync.exe</td>
</tr>
<tr>
<td valign="top" class="menu">\Utilities\MAXUtilities\max2skl.exe</td>
<td valign="top">-</td>
<td>Converts a 3DS MAX file to a skeleton-based model that can be loaded
by the game engine (<a href="content/fakk2_max2skl.html">more</a>).</td>
</tr>
<tr>
<td valign="top" class="menu">\Utilities\MAXUtilities\max2tan.exe</td>
<td valign="top">-</td>
<td>Converts a 3DS MAX file to a triangle-based model that can be loaded
by the game engine (<a href="content/fakk2_max2skl.html">more</a>).</td>
</tr>
<tr>
<td valign="top" class="menu">\Utilities\MAX4Plugins\</td>
<td valign="top">-</td>
<td>Contains plugins for MAX4/MAX5 that allow the loading and export
of .tik models. Put all of these files into your 3DS MAX plugins directory.</td>
</tr>
</table>
<p class="subheader"><a name="3"></a>Source Files</p>
<table width="100%" border="0" cellspacing="4" cellpadding="0">
<tr>
<td class="menu">\base\maps\dm_ctf_station.map<br>
\base\maps\m4l1a-attrexian_station.map<br>
\base\maps\m10l1-romulan_installation.map</td>
<td valign="top">-</td>
<td valign="top">Map source files.</td>
</tr>
<tr>
<td class="menu">\base\models\merc-female\body.tga<br>
\base\models\merc-female\face-green-dark.tga<br>
\base\models\merc-female\head.tga </td>
<td valign="top">-</td>
<td valign="top">Skin source files</td>
</tr>
<tr>
<td class="menu">\base\models\merc-female\merc-female.max</td>
<td valign="top">-</td>
<td valign="top">3DS MAX model source file</td>
</tr>
</table>
<p>&nbsp;</p>
</td>
</tr>
<tr>
<td colspan="3"><img src="images/footer.jpg" width="702" height="36" border="0" usemap="#Map"><br>
<img src="images/hor_line.jpg" width="702" height="1"></td>
</tr>
<tr>
<td colspan="3" class="legal"><table width="100%" border="0" cellspacing="0" cellpadding="4">
<tr>
<td class="legal"> Copyright &copy;2003 Ritual Entertainment, Inc. All rights reserved.<br>
Please do not email Ritual Entertainment with questions about the
UberTools Game Development Kit. It is provided as is and is not supported by Ritual Entertainment.</td>
<td><a href="http://www.ritual.com/tech/overview.html" target="_blank"><img src="images/uber_logo.jpg" width="43" height="56" hspace="4" border="0"></a></td>
<td><a href="http://www.ritual.com" target="_blank"><img src="images/ritual_logo.jpg" width="100" height="56" hspace="4" border="0"></a></td>
</tr>
</table>
<p align="center">&nbsp;</p></td>
</tr>
</table>
<map name="Map">
<area shape="rect" coords="601,10,693,28" href="#top">
</map>
</body>
</html>