* added filter api to create new filters from within plugins
[xonotic/netradiant.git] / www / gtkradiant.html
1 <font color="#ffcc00">\r
2 <center><b>GTKRadiant 1.1 beta</b></center>\r
3 <center> </center>\r
4 </font>\r
5 <font color="#ffffff">\r
6 \r
7 <!-- -->\r
8 <!-- INSTALLATION -->\r
9 <!-- -->\r
10 <b>Installation</b>\r
11 <blockquote>\r
12 \r
13 GtkRadiant 1.1 beta is available for Windows and Linux. Quake III Arena editing \r
14 is the only game supported so far. You can get the setup files from several \r
15 mirrors:<br>\r
16 \r
17 </blockquote>\r
18 <blockquote>\r
19 \r
20 <a href="http://www.3ddownloads.com/index.php3?directory=/qeradiant/GtkRadiant/" \r
21 target="_new">3DDownloads</a><br>\r
22 \r
23 <a href="ftp://ftp.lokigames.com/pub/beta/q3sdk/" target="_new">Loki's \r
24 ftp</a><br> \r
25 \r
26 Fileplanet: <a href="http://www.fileplanet.com/index.asp?file=51668" \r
27 target="_new">Linux</a> <a href="http://www.fileplanet.com/index.asp?file=51669" \r
28 target="_new">Win32 (full)</a> <a \r
29 href="http://www.fileplanet.com/index.asp?file=51670" target="_new">Win32 \r
30 (patch)</a><br>\r
31 \r
32 <a \r
33 href="http://www.quakexpert.com/cgi-bin/ftp-ge/utilities.cgi?browse&qeradiant/Gt\r
34 kRadiant" target="_new">French mirror at Quakexpert.com</a><br>\r
35 \r
36 </blockquote>\r
37 \r
38 <blockquote>\r
39 Win32 Installation instructions:<br>\r
40 \r
41 Grab one of the two setups: a full installation or an upgrade. If you don't know \r
42 what to choose, get the full setup (<a \r
43 href="http://www.3ddownloads.com/index.php3?directory=/qeradiant/GtkRadiant/" \r
44 target="_new">GtkRadiantSetup-1.1-beta.zip</a> 8Mb), if you have a working \r
45 installation of Q3Radiant above 199, or GtkRadiant Alpha, get the patch (<a \r
46 href="http://www.3ddownloads.com/index.php3?directory=/qeradiant/GtkRadiant/" \r
47 target="_new">GtkRadiantSetup-1.1-beta-patch.zip</a> 4Mb). GtkRadiant \r
48 installation doesn't interfere with your current Q3Radiant installation: \r
49 everything will be installed under GtkRadiant/ (whereas usual path for Q3Radiant \r
50 is Tools/) and a new file quakev2.qe4 will be installed in baseq3/scripts/\r
51 \r
52 </blockquote>\r
53 \r
54 <blockquote>\r
55 Linux Installation:<br>\r
56 \r
57 Get <a \r
58 href="http://www.3ddownloads.com/index.php3?directory=/qeradiant/GtkRadiant/" \r
59 target="_new">linuxq3sdk-1.1b.x86.run</a>. Once downloaded, execute it from your \r
60 favorite shell (as root).<br>NOTE: this is the full Quake III Arena SDK, it \r
61 will install the game source and mod tools as well.\r
62 \r
63 </blockquote>\r
64 \r
65 <!-- -->\r
66 <!-- GETTING STARTED -->\r
67 <!-- -->\r
68 <b>Getting started</b>\r
69 <blockquote>\r
70 \r
71 Some features in GtkRadiant have undergone major changes compared to Q3Radiant. \r
72 The main difference is the use of Gtk for all the widgets (buttons, lists, \r
73 dialog boxes). It looks and feels different but you'll get used to it quickly. \r
74 We believe the Gtk toolkit brings a great deal of clarity to the interface.<br>\r
75 \r
76 </blockquote>\r
77 \r
78 <blockquote>\r
79 \r
80 Scroll down to see the full changelog for GtkRadiant. Since it is pretty huge \r
81 I'll only go over the new functionalities.\r
82 \r
83 </blockquote>\r
84 \r
85 <blockquote>\r
86 \r
87 <li>\r
88 \r
89 Compilation monitoring: GtkRadiant comes with a modified version of q3map that \r
90 reports to GtkRadiant through the network. You get the output of q3map in the \r
91 console window. And the compiling errors can be processed. So far it detects\r
92 leaks, bad brush planes and winding errors.  This requires using the version 2\r
93 project files (the newest ones). You can still use the classic compilation \r
94 process and set a few options in the preferences: see the 'BSP monitoring' \r
95 in the preferenes dialog (Edit > Preferences).<br>\r
96 \r
97 <li>\r
98 \r
99 Sleep mode: you can put Radiant to sleep and have it release all the GL stuff.\r
100 Very handy to run Quake 3 Arena engine without eating too much GL resources.\r
101 You can trigger sleep mode by hand from File > Sleep, or turn it on\r
102 automatically in the BSP monitoring prefs. Expect waking up from sleep mode to\r
103 be about the same speed as loading the map\r
104 (you need to reload all the textures).<br>\r
105 \r
106 <li>\r
107 \r
108 Improved q3map: the version of q3map that comes in GtkRadiant has been optimized\r
109 to require less memory for normal use. The 1.0q version of q3map allocates around\r
110 75Mb of RAM on startup. This new version shrinks the startup memory allocation\r
111 by around 45Mb, bringing the minimum requirements around 30Mb. Then it will\r
112 dynamically allocate as needed. These changes need a lot of testing, don't\r
113 hesitate to send some feedback.\r
114 \r
115 <li>\r
116 \r
117 The project file format has changed a bit. The new format (version 2) is in \r
118 baseq3/scripts/quakev2.qe4 (it will be loaded by default at startup). Some of \r
119 the new features of GtkRadiant rely on this new format, old one is still \r
120 supported but you should move to the new one. We are using a template scheme: \r
121 when you load quakev2.qe4 a custom project file will be generated and saved for \r
122 you in baseq3/scripts/user0.qe4. If you have custom BSP commands, you can edit \r
123 that resulting userxx.qe4 to add your stuff. (see below for the new BSP process \r
124 monitoring)<br>\r
125 \r
126 <li>\r
127 \r
128 Inspectors: the increments steps are now available in the surface inspector\r
129 (S) and in the patch inspector (Shift+S). The keyboard shortcuts Shift+Arrows\r
130 are following these increment steps as well. \r
131 \r
132 <li>\r
133 \r
134 Radiant is no longer using the windows registry. All settings are stored in \r
135 radiant.ini and savedinfo.bin under the radiant directory (i.e. same directory \r
136 as the binary)<br>\r
137 \r
138 <li>\r
139 \r
140 The shortcut keys file has changed name from radiant.ini to shortcuts.ini and a \r
141 bit changed syntax. See shortcuts.ini.sample in the distribution for a \r
142 sample.<br>\r
143 \r
144 </blockquote>\r
145 \r
146 <!-- -->\r
147 <!-- Feedback and discussion -->\r
148 <!-- -->\r
149 <b>Feedback and discussion</b>\r
150 <blockquote>\r
151 \r
152 This is a beta release. We consider it to be ready for production use. It has\r
153 been in internal testing for a while, the main problems remaining would be\r
154 driver or OS related, so we are tagging it as beta. Overall we will bring \r
155 minor improvements until the final release (bringing more plugins in and \r
156 fixing issues that will appear). Brand new functionalities will go in 1.2<br>\r
157 \r
158 </blockquote>\r
159 <blockquote>\r
160 \r
161 <li>\r
162 \r
163 The documentation is outdated. We'll have a new version of the manual ready. \r
164 Until then this page, the <a \r
165 href="http://www.qeradiant.com/faq/fom-serve/cache/115.html">faq</a>, the <a \r
166 href="news://news.lokigames.com/loki.games.q3sdk">newsgroup</a> and the <a \r
167 href="http://www.quake3world.com/cgi-bin/forumdisplay.cgi?action=topics&forum=Le\r
168 vel+Editing&number=6&DaysPrune=10&LastLogin=">forum</a> are the best \r
169 references.<br>\r
170 \r
171 </blockquote>\r
172 \r
173 <blockquote>\r
174 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
175 \r
176 <li>\r
177 \r
178 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
179 \r
180 <li>\r
181 \r
182 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
183 \r
184 <li>\r
185 \r
186 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
187 \r
188 <li>\r
189 \r
190 IRC! .. most of us are IRC whores .. idling a lot on irc.telefragged.com #qeradiant<br>\r
191 \r
192 </blockquote>\r
193 \r
194 <!-- -->\r
195 <!-- Credits -->\r
196 <!-- -->\r
197 <b>Credits</b>\r
198 <blockquote>\r
199 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
200 Loki:<br>\r
201 Leonardo Zide leo@lokigames.com<br>\r
202 Mike Phillips (early testing)<br>\r
203 Bernd Kreimeier (overall coordination)<br>\r
204 QER.com:<br>\r
205 TTimo timo@qeradiant.com<br>\r
206 ^Fishman (Pablo Zurita) fish@gamedesign.net<br>\r
207 Curry plugin Team:<br>\r
208 Mike "mickey" Jackman<br>\r
209 Tim "Maj" Rennie<br>\r
210 William "SmallPileOfGibs" Joseph<br>\r
211 PrtView plugin, various bug fixes and q3map guru:<br>\r
212 Geoffrey DeWan<br>\r
213 Updated shader files, textures, entities.def, keyboard shortcut list and<\r
214 overall testing / feedback:<br>\r
215 Jean-Francois "Eutectic" Groleau<br>\r
216 Improvements and bug fixing to the editor:<br> \r
217 Jan Paul "MrElusive" van Waveren, Robert Duffy<br>\r
218 Web:<br>\r
219 Dave "Bargle" Koenig and Jason "Wolfen" Spencer<br>\r
220 FAQ:<br>\r
221 Equim and Wex<br>\r
222 Thanks to everyone on the beta mailing list and irc.telefragged.com \r
223 #qeradiant \r
224 for testing and feedback.<br>\r
225 </blockquote>\r
226 \r
227 <!-- -->\r
228 <!-- Changelog -->\r
229 <!-- -->\r
230 \r
231 <b>Changelog</b>\r
232 <blockquote>\r
233 <pre>\r
234 GtkRadiant 1.1 beta Changes\r
235 ---------------------------\r
236 \r
237 MrElusive:\r
238 - bspc 2.1c, MAX_MAPFILE_PLANES bumped up (needed on big maps)\r
239 \r
240 G_Dewan:\r
241 - fix to BSP menu order getting mixed up\r
242 - fix to bogus noshader error message in q3map\r
243 - suppressed winsock2 dependency, only requires winsock1 now\r
244 - improved q3map, reducing minimal memory footprint by about 45Mb\r
245 \r
246 leo:\r
247 - Fixed q3map crashing if visbytes is greater than the maximum allowed\r
248 - fixed texture window not scrolling when last texture is large\r
249 - Fixed q3map Makefile\r
250 - Fixed +/- numpad keys not working in win32\r
251 - Fixed Alt shortcuts not working in win32\r
252 - fixed prefab path and user ini in preferences dialog\r
253 - fixed add/remove bsp items in project settings dialog\r
254 - fixed some console not working in view #3\r
255 - fixed warning when exiting in views #2 #3\r
256 - Fixed patch inspector not showing after it has been closed\r
257 - Fixed load window position bug (saved pos greater than screen resolution)\r
258 - Fixed selection nudge bug\r
259 - fixed Z window not shrinking small enough in floating windows mode (win32)\r
260 - Improved entity windows layout\r
261 - Added 'Reset' button to entity dialog\r
262 - added LOD for patches, see in prefs for the LOD you want to display on patches\r
263 - no more DOS dialog box under windows, Gtk errors and warnings are\r
264 redirected to the console\r
265 - remember size/position of the entities dialog\r
266 - new 128 and 256 grid\r
267 \r
268 - added shift+rclick+mouse move to zoom in/out of the view\r
269 (way cool feature! check it out!)\r
270 \r
271 TTimo:\r
272 - fixed the Region commands, "Region > Set brush" is working\r
273 Region uses the camera as spawn point.\r
274 - updated quakev2.qe4 with -vlight options\r
275 - added checks in q3map to prevent crashing on allocating a winding too big.\r
276 - improved snapshots behaviour, doesn't snapshot non-modified maps\r
277 - improved the CycleCapTexturePatch command, now cycle across the 3 planes only \r
278 and works on multiple patches in one shot\r
279 - fixed the help menu, Help > Help or F1 will try to open the Q3Radiant manual \r
280 (if you have office installed) (Help > Links also fixed)\r
281 - surface inspector allows to change increments steps and stores them in \r
282 registry. General behaviour of the surface inspector has been reworked. Undo \r
283 works better on the surface inspector.\r
284 - shift+arrows shortcuts now match the increments from the surface inspector\r
285 - button 'Match Grid' in the SI to set the increment to current grid\r
286 \r
287 - debug stream between GtkRadiant 1.1 and q3map:\r
288 As with the Alpha version, q3map connects to Q3Radiant to report on it's \r
289 progress. The progress reporting code has been enhanced with an XML stream. If \r
290 your map has errors that need geometry information to be fixed, Radiant can help \r
291 you out. To get a grip on this feature, load baseq3/maps/museum.map and compile \r
292 it (with BSP monitoring turned on of course).\r
293 \r
294 - cleaned the entity inspector window, better layout management\r
295 \r
296 - two new items in the View > Show menu:\r
297 the X, Y and Z axis have been assigned colors (Z: Red, X: Green, Y: Blue)\r
298 Show outline draws a colored outline around your view, helping you know what \r
299 view is currently active.\r
300 Show Axes will draw a small axis base in the upper left corner\r
301 \r
302 GtkRadiant alpha version Changes\r
303 --------------------------------\r
304 \r
305 MrElusive:\r
306 -q3map 1.0q: fixed a bug in q3map that sometimes cause mapobjects not to be lit\r
307 \r
308 G_Dewan:\r
309 -more arrows drawn on entities with relevant angle information\r
310 \r
311 Fishman:\r
312 -antialiased lines\r
313 \r
314 leo & TTimo:\r
315 - based on Q3Radiant 202\r
316 - patched q3map with network code\r
317 - shortcut keys are now in shortcuts.ini\r
318 the syntax has changed a bit, no spaces between the '='\r
319 see shortcuts.sample\r
320 - no longer using the registry, settings are stored in radiant.ini and savedinfo.bin\r
321 in Radiant directory\r
322 - project settings templates:\r
323 the project settings file format has changed a bit.\r
324 it has version information now, and the setups come with a new quakev2.qe4 file\r
325 the project files are true templates, Radiant will read them and then store actual\r
326 project settings it uses in baseq3/scripts/user0.qe4 user1.qe4 etc.\r
327 - new compilation monitoring\r
328 GtkRadiant comes with a modified version of q3map that reports to GtkRadiant through\r
329 the network. You get the output of q3map in the console window. And the compiling\r
330 errors can be processed (currently it detects leaks)\r
331 - sleep mode:\r
332 before running Quake 3 Arena to playtest your maps, you can put Radiant to sleep:\r
333 manually with File > Sleep command\r
334 automatic if you compile and set "Activate sleep mode when running the engine"\r
335 </pre>\r
336 </blockquote>\r
337 \r
338 </font>\r