set eol-style

[xonotic/netradiant.git] / www / gtkradiant.html

<font color="#ffcc00">\r
<center><b>GTKRadiant 1.1 beta</b></center>\r
<center> </center>\r
</font>\r
<font color="#ffffff">\r
\r
<!-- -->\r
<!-- INSTALLATION -->\r
<!-- -->\r
<b>Installation</b>\r
<blockquote>\r
\r
GtkRadiant 1.1 beta is available for Windows and Linux. Quake III Arena editing \r
is the only game supported so far. You can get the setup files from several \r
mirrors:<br>\r
\r
</blockquote>\r
<blockquote>\r
\r
<a href="http://www.3ddownloads.com/index.php3?directory=/qeradiant/GtkRadiant/" \r
target="_new">3DDownloads</a><br>\r
\r
<a href="ftp://ftp.lokigames.com/pub/beta/q3sdk/" target="_new">Loki's \r
ftp</a><br> \r
\r
Fileplanet: <a href="http://www.fileplanet.com/index.asp?file=51668" \r
target="_new">Linux</a> <a href="http://www.fileplanet.com/index.asp?file=51669" \r
target="_new">Win32 (full)</a> <a \r
href="http://www.fileplanet.com/index.asp?file=51670" target="_new">Win32 \r
(patch)</a><br>\r
\r
<a \r
href="http://www.quakexpert.com/cgi-bin/ftp-ge/utilities.cgi?browse&qeradiant/Gt\r
kRadiant" target="_new">French mirror at Quakexpert.com</a><br>\r
\r
</blockquote>\r
\r
<blockquote>\r
Win32 Installation instructions:<br>\r
\r
Grab one of the two setups: a full installation or an upgrade. If you don't know \r
what to choose, get the full setup (<a \r
href="http://www.3ddownloads.com/index.php3?directory=/qeradiant/GtkRadiant/" \r
target="_new">GtkRadiantSetup-1.1-beta.zip</a> 8Mb), if you have a working \r
installation of Q3Radiant above 199, or GtkRadiant Alpha, get the patch (<a \r
href="http://www.3ddownloads.com/index.php3?directory=/qeradiant/GtkRadiant/" \r
target="_new">GtkRadiantSetup-1.1-beta-patch.zip</a> 4Mb). GtkRadiant \r
installation doesn't interfere with your current Q3Radiant installation: \r
everything will be installed under GtkRadiant/ (whereas usual path for Q3Radiant \r
is Tools/) and a new file quakev2.qe4 will be installed in baseq3/scripts/\r
\r
</blockquote>\r
\r
<blockquote>\r
Linux Installation:<br>\r
\r
Get <a \r
href="http://www.3ddownloads.com/index.php3?directory=/qeradiant/GtkRadiant/" \r
target="_new">linuxq3sdk-1.1b.x86.run</a>. Once downloaded, execute it from your \r
favorite shell (as root).<br>NOTE: this is the full Quake III Arena SDK, it \r
will install the game source and mod tools as well.\r
\r
</blockquote>\r
\r
<!-- -->\r
<!-- GETTING STARTED -->\r
<!-- -->\r
<b>Getting started</b>\r
<blockquote>\r
\r
Some features in GtkRadiant have undergone major changes compared to Q3Radiant. \r
The main difference is the use of Gtk for all the widgets (buttons, lists, \r
dialog boxes). It looks and feels different but you'll get used to it quickly. \r
We believe the Gtk toolkit brings a great deal of clarity to the interface.<br>\r
\r
</blockquote>\r
\r
<blockquote>\r
\r
Scroll down to see the full changelog for GtkRadiant. Since it is pretty huge \r
I'll only go over the new functionalities.\r
\r
</blockquote>\r
\r
<blockquote>\r
\r
<li>\r
\r
Compilation monitoring: GtkRadiant comes with a modified version of q3map that \r
reports to GtkRadiant through the network. You get the output of q3map in the \r
console window. And the compiling errors can be processed. So far it detects\r
leaks, bad brush planes and winding errors.  This requires using the version 2\r
project files (the newest ones). You can still use the classic compilation \r
process and set a few options in the preferences: see the 'BSP monitoring' \r
in the preferenes dialog (Edit > Preferences).<br>\r
\r
<li>\r
\r
Sleep mode: you can put Radiant to sleep and have it release all the GL stuff.\r
Very handy to run Quake 3 Arena engine without eating too much GL resources.\r
You can trigger sleep mode by hand from File > Sleep, or turn it on\r
automatically in the BSP monitoring prefs. Expect waking up from sleep mode to\r
be about the same speed as loading the map\r
(you need to reload all the textures).<br>\r
\r
<li>\r
\r
Improved q3map: the version of q3map that comes in GtkRadiant has been optimized\r
to require less memory for normal use. The 1.0q version of q3map allocates around\r
75Mb of RAM on startup. This new version shrinks the startup memory allocation\r
by around 45Mb, bringing the minimum requirements around 30Mb. Then it will\r
dynamically allocate as needed. These changes need a lot of testing, don't\r
hesitate to send some feedback.\r
\r
<li>\r
\r
The project file format has changed a bit. The new format (version 2) is in \r
baseq3/scripts/quakev2.qe4 (it will be loaded by default at startup). Some of \r
the new features of GtkRadiant rely on this new format, old one is still \r
supported but you should move to the new one. We are using a template scheme: \r
when you load quakev2.qe4 a custom project file will be generated and saved for \r
you in baseq3/scripts/user0.qe4. If you have custom BSP commands, you can edit \r
that resulting userxx.qe4 to add your stuff. (see below for the new BSP process \r
monitoring)<br>\r
\r
<li>\r
\r
Inspectors: the increments steps are now available in the surface inspector\r
(S) and in the patch inspector (Shift+S). The keyboard shortcuts Shift+Arrows\r
are following these increment steps as well. \r
\r
<li>\r
\r
Radiant is no longer using the windows registry. All settings are stored in \r
radiant.ini and savedinfo.bin under the radiant directory (i.e. same directory \r
as the binary)<br>\r
\r
<li>\r
\r
The shortcut keys file has changed name from radiant.ini to shortcuts.ini and a \r
bit changed syntax. See shortcuts.ini.sample in the distribution for a \r
sample.<br>\r
\r
</blockquote>\r
\r
<!-- -->\r
<!-- Feedback and discussion -->\r
<!-- -->\r
<b>Feedback and discussion</b>\r
<blockquote>\r
\r
This is a beta release. We consider it to be ready for production use. It has\r
been in internal testing for a while, the main problems remaining would be\r
driver or OS related, so we are tagging it as beta. Overall we will bring \r
minor improvements until the final release (bringing more plugins in and \r
fixing issues that will appear). Brand new functionalities will go in 1.2<br>\r
\r
</blockquote>\r
<blockquote>\r
\r
<li>\r
\r
The documentation is outdated. We'll have a new version of the manual ready. \r
Until then this page, the <a \r
href="http://www.qeradiant.com/faq/fom-serve/cache/115.html">faq</a>, the <a \r
href="news://news.lokigames.com/loki.games.q3sdk">newsgroup</a> and the <a \r
href="http://www.quake3world.com/cgi-bin/forumdisplay.cgi?action=topics&forum=Le\r
vel+Editing&number=6&DaysPrune=10&LastLogin=">forum</a> are the best \r
references.<br>\r
\r
</blockquote>\r
\r
<blockquote>\r
QERadiant.com is preparing a site reorganization to handle the newcomer GtkRadiant. The developpement team has grown bigger since Loki Software is involved in the project. They are providing most of the resources (cvs server, mailing list, bug tracking and newsgroup). As time goes we'll open the developpement more and more. For now we are providing the following for feedback and discussion:<br>\r
\r
<li>\r
\r
The <a href="http://www.quake3world.com/cgi-bin/forumdisplay.cgi?action=topics&forum=Level+Editing&number=6&DaysPrune=10&LastLogin=">Quake 3 World editing forum</a> is a good place for end user discussion.<br>\r
\r
<li>\r
\r
Technical topics (specific crashes, driver issues etc.) should be discussed on <a href="news://news.lokigames.com/loki.games.q3sdk">the newsgroup loki.games.q3sdk</a>. Be sure to specify the version of GtkRadiant you are using, the details of your hardware and the platform you are running GtkRadiant on (windows or linux).<br>\r
\r
<li>\r
\r
You can view our current list of bugs on <a href="http://fenris.lokigames.com">fenris</a>, the bug tracking server. You can report problems there. Run a <a href="http://fenris.lokigames.com/buglist.cgi?bug_status=New&bug_status=Assigned&bug_status=Reopened&email2=&emailtype2=substring&emailreporter2=1&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Q3SDK&component=MapEditor&short_desc=&short_desc_type=substring&long_desc=&long_desc_type=substring&cmdtype=doit&newqueryname=&order=%22Importance%22&form_name=query">query with the Q3SDK program and MapEditor component</a>.<br>\r
\r
<li>\r
\r
IRC! .. most of us are IRC whores .. idling a lot on irc.telefragged.com #qeradiant<br>\r
\r
</blockquote>\r
\r
<!-- -->\r
<!-- Credits -->\r
<!-- -->\r
<b>Credits</b>\r
<blockquote>\r
Waaa... so many people involved in that project, trying to list a few (this is the GtkRadiant contributors, for qeradiant.com see the staff page):<br>\r
Loki:<br>\r
Leonardo Zide leo@lokigames.com<br>\r
Mike Phillips (early testing)<br>\r
Bernd Kreimeier (overall coordination)<br>\r
QER.com:<br>\r
TTimo timo@qeradiant.com<br>\r
^Fishman (Pablo Zurita) fish@gamedesign.net<br>\r
Curry plugin Team:<br>\r
Mike "mickey" Jackman<br>\r
Tim "Maj" Rennie<br>\r
William "SmallPileOfGibs" Joseph<br>\r
PrtView plugin, various bug fixes and q3map guru:<br>\r
Geoffrey DeWan<br>\r
Updated shader files, textures, entities.def, keyboard shortcut list and<\r
overall testing / feedback:<br>\r
Jean-Francois "Eutectic" Groleau<br>\r
Improvements and bug fixing to the editor:<br> \r
Jan Paul "MrElusive" van Waveren, Robert Duffy<br>\r
Web:<br>\r
Dave "Bargle" Koenig and Jason "Wolfen" Spencer<br>\r
FAQ:<br>\r
Equim and Wex<br>\r
Thanks to everyone on the beta mailing list and irc.telefragged.com \r
#qeradiant \r
for testing and feedback.<br>\r
</blockquote>\r
\r
<!-- -->\r
<!-- Changelog -->\r
<!-- -->\r
\r
<b>Changelog</b>\r
<blockquote>\r
<pre>\r
GtkRadiant 1.1 beta Changes\r
---------------------------\r
\r
MrElusive:\r
- bspc 2.1c, MAX_MAPFILE_PLANES bumped up (needed on big maps)\r
\r
G_Dewan:\r
- fix to BSP menu order getting mixed up\r
- fix to bogus noshader error message in q3map\r
- suppressed winsock2 dependency, only requires winsock1 now\r
- improved q3map, reducing minimal memory footprint by about 45Mb\r
\r
leo:\r
- Fixed q3map crashing if visbytes is greater than the maximum allowed\r
- fixed texture window not scrolling when last texture is large\r
- Fixed q3map Makefile\r
- Fixed +/- numpad keys not working in win32\r
- Fixed Alt shortcuts not working in win32\r
- fixed prefab path and user ini in preferences dialog\r
- fixed add/remove bsp items in project settings dialog\r
- fixed some console not working in view #3\r
- fixed warning when exiting in views #2 #3\r
- Fixed patch inspector not showing after it has been closed\r
- Fixed load window position bug (saved pos greater than screen resolution)\r
- Fixed selection nudge bug\r
- fixed Z window not shrinking small enough in floating windows mode (win32)\r
- Improved entity windows layout\r
- Added 'Reset' button to entity dialog\r
- added LOD for patches, see in prefs for the LOD you want to display on patches\r
- no more DOS dialog box under windows, Gtk errors and warnings are\r
redirected to the console\r
- remember size/position of the entities dialog\r
- new 128 and 256 grid\r
\r
- added shift+rclick+mouse move to zoom in/out of the view\r
(way cool feature! check it out!)\r
\r
TTimo:\r
- fixed the Region commands, "Region > Set brush" is working\r
Region uses the camera as spawn point.\r
- updated quakev2.qe4 with -vlight options\r
- added checks in q3map to prevent crashing on allocating a winding too big.\r
- improved snapshots behaviour, doesn't snapshot non-modified maps\r
- improved the CycleCapTexturePatch command, now cycle across the 3 planes only \r
and works on multiple patches in one shot\r
- fixed the help menu, Help > Help or F1 will try to open the Q3Radiant manual \r
(if you have office installed) (Help > Links also fixed)\r
- surface inspector allows to change increments steps and stores them in \r
registry. General behaviour of the surface inspector has been reworked. Undo \r
works better on the surface inspector.\r
- shift+arrows shortcuts now match the increments from the surface inspector\r
- button 'Match Grid' in the SI to set the increment to current grid\r
\r
- debug stream between GtkRadiant 1.1 and q3map:\r
As with the Alpha version, q3map connects to Q3Radiant to report on it's \r
progress. The progress reporting code has been enhanced with an XML stream. If \r
your map has errors that need geometry information to be fixed, Radiant can help \r
you out. To get a grip on this feature, load baseq3/maps/museum.map and compile \r
it (with BSP monitoring turned on of course).\r
\r
- cleaned the entity inspector window, better layout management\r
\r
- two new items in the View > Show menu:\r
the X, Y and Z axis have been assigned colors (Z: Red, X: Green, Y: Blue)\r
Show outline draws a colored outline around your view, helping you know what \r
view is currently active.\r
Show Axes will draw a small axis base in the upper left corner\r
\r
GtkRadiant alpha version Changes\r
--------------------------------\r
\r
MrElusive:\r
-q3map 1.0q: fixed a bug in q3map that sometimes cause mapobjects not to be lit\r
\r
G_Dewan:\r
-more arrows drawn on entities with relevant angle information\r
\r
Fishman:\r
-antialiased lines\r
\r
leo & TTimo:\r
- based on Q3Radiant 202\r
- patched q3map with network code\r
- shortcut keys are now in shortcuts.ini\r
the syntax has changed a bit, no spaces between the '='\r
see shortcuts.sample\r
- no longer using the registry, settings are stored in radiant.ini and savedinfo.bin\r
in Radiant directory\r
- project settings templates:\r
the project settings file format has changed a bit.\r
it has version information now, and the setups come with a new quakev2.qe4 file\r
the project files are true templates, Radiant will read them and then store actual\r
project settings it uses in baseq3/scripts/user0.qe4 user1.qe4 etc.\r
- new compilation monitoring\r
GtkRadiant comes with a modified version of q3map that reports to GtkRadiant through\r
the network. You get the output of q3map in the console window. And the compiling\r
errors can be processed (currently it detects leaks)\r
- sleep mode:\r
before running Quake 3 Arena to playtest your maps, you can put Radiant to sleep:\r
manually with File > Sleep command\r
automatic if you compile and set "Activate sleep mode when running the engine"\r
</pre>\r
</blockquote>\r
\r
</font>\r