1YADEX(6) Games Manual YADEX(6)
2
6 yadex - a Doom/Heretic/Strife level editor
7
9 yadex -?|-help|--help
10 yadex --version
11 yadex [options] [file ...]
12 yadex [options] -b string [file ...]
13
15 Yadex can be used to view, create and modify levels for Doom, Ultimate
16 Doom, Doom II, Final Doom, Doom press release pre beta and Heretic. It
17 also supports, to a lesser extent, Doom alpha, Hexen and Strife.
18 See README for a quick start.
20 To know what's new in this release, see CHANGES.
21 The rest of documentation is in doc/index.html (HTML format).
22
24 Boolean options can be negated by using + instead of -. For example,
25 +v would disable verbose mode even if verbose is set to 1 in the con‐
26 figuration file. For non boolean options, + is equivalent to - (note:
27 the fact that a misimplementation is documented should not be construed
28 as an incitement to make use of it).
29 For options that take a parameter, the option and the parameter must be
31 in separate command-line arguments, i.e. you cannot write -gdoom.
32 It is not possible to run options together, i.e. you can't use -dv as
34 short for -d -v.
35 The -- "end-of-options" convention is not supported.
37 -?, -help, --help
39 Print usage summary to stdout and exit successfully.
40 -b string
42 Run a benchmark on some part of Yadex and exit successfully. See
43 the benchmark() function for further details.
44 -d, -debug
46 Debug mode. This option is equivalent to and overrides the
47 debug directive of the configuration file.
48 -expert
50 Expert mode. Enforces default choices for certain dialogs. As
51 those default choices are IMHO not all judicious, I don't recom‐
52 mend using this option. Check insert_vertex_split_linedef and
53 insert_vertex_merge_vertices instead. This option is equivalent
54 to and overrides the expert directive of the configuration file.
55 -f, -config_file file
57 Use file as the config file instead of the default.
58 -fc, -fake_cursor
60 (X11 only) Fake cursor. Currently, this option is a no-op. This
61 option is equivalent to and overrides the fake_cursor directive
62 of the configuration file.
63 -fn, -font string
65 (X11 only) Use font string. If no font is specified or if the
66 specified font is not found, Yadex falls back on the default
67 font of the X server. This option is equivalent to and over‐
68 rides the font directive of the configuration file.
69 -g, -game string
71 Set the game to string, which can be one of the following:
72 · doom Doom or Ultimate Doom
74 · doom02 Doom alpha 0.2
75 · doom04 Doom alpha 0.4
76 · doom05 Doom alpha 0.5
77 · doom2 Doom II or Final Doom
78 · doompr Doom press release pre-beta
79 · heretic Heretic
80 · hexen Hexen
81 · strife Strife 1.1 and later
82 · strife10 Strife 1.0
83 This option is equivalent to and overrides the game directive of
85 the configuration file.
86 -h, -height integer
88 (X11 only) Initial height of the window. If the argument is just
89 a number, the height of the window will be that many pixels. If
90 the argument is a number followed by a percent sign (%), it will
91 be that many percent of the width of the screen. The default is
92 90%. This option is equivalent to and overrides the height
93 directive of the configuration file. See also -w.
94 -i1, -iwad1 file
96 The name of the Doom or Ultimate Doom iwad. This option has
97 effect only if the game is doom. This option is equivalent to
98 and overrides the iwad1 directive of the configuration file.
99 -i2, -iwad2 file
101 The name of the Doom II or Final Doom iwad. This option has
102 effect only if the game is doom2. This option is equivalent to
103 and overrides the iwad2 directive of the configuration file.
104 -i3, -iwad3 file
106 The name of the Heretic iwad. This option has effect only if
107 the game is heretic. This option is equivalent to and overrides
108 the iwad3 directive of the configuration file.
109 -i4, -iwad4 file
111 The name of the Hexen iwad. This option has effect only if the
112 game is hexen. This option is equivalent to and overrides the
113 iwad4 directive of the configuration file.
114 -i5, -iwad5 file
116 The name of the Strife iwad. This option has effect only if the
117 game is strife. This option is equivalent to and overrides the
118 iwad5 directive of the configuration file.
119 -i6, -iwad6 file
121 The name of the Doom alpha 0.2 iwad. This option has effect
122 only if the game is doom02. This option is equivalent to and
123 overrides the iwad6 directive of the configuration file.
124 -i7, -iwad7 file
126 The name of the Doom alpha 0.4 iwad. This option has effect
127 only if the game is doom04. This option is equivalent to and
128 overrides the iwad7 directive of the configuration file.
129 -i8, -iwad8 file
131 The name of the Doom alpha 0.5 iwad. This option has effect
132 only if the game is doom05. This option is equivalent to and
133 overrides the iwad8 directive of the configuration file.
134 -i9, -iwad9 file
136 The name of the Doom press release pre-beta iwad. This option
137 has effect only if the game is doompr. This option is equiva‐
138 lent to and overrides the iwad9 directive of the configuration
139 file.
140 -i10, -iwad10 file
142 The name of the Strife 1.0 iwad. This option has effect only if
143 the game is strife10. This option is equivalent to and over‐
144 rides the iwad10 directive of the configuration file.
145 -pw, -pwad file
147 [Deprecated] Load pwad file. This option is useless since pwads
148 can be given as arguments anyway. It's there for backward com‐
149 patibility only. This option is equivalent to and overrides the
150 pwad directive of the configuration file.
151 -P, -no_pixmap
153 (X11 only) Use no pixmap. Makes Yadex more responsive at the
154 cost of a lot of flickering. Off by default. This option is
155 equivalent to and overrides the no_pixmap directive of the con‐
156 figuration file.
157 -q, -quiet
159 In theory, quiet mode. In practice, has no effect. This option
160 is equivalent to and overrides the quiet directive of the con‐
161 figuration file.
162 -qq, -quieter
164 Quieter. Makes Yadex completely silent (beepless). This option
165 is equivalent to and overrides the quieter directive of the con‐
166 figuration file.
167 -s0, -select0
169 Select the 0th object automatically whenever the editing mode is
170 set. This option is equivalent to and overrides the select0
171 directive of the configuration file.
172 -sb, -swap_buttons
174 Swap mouse buttons. Currently, this option is a no-op. This
175 option is equivalent to and overrides the swap_buttons directive
176 of the configuration file.
177 -td, -text_dot
179 Debug the DrawScreenText() function. This option is equivalent
180 to and overrides the text_dot directive of the configuration
181 file.
182 -v, -verbose
184 Verbose mode. This option is equivalent to and overrides the
185 verbose directive of the configuration file.
186 --version
188 Print version information to stdout and exit successfully.
189 The first line contain three fields, separated by white space,
191 with no other punctuation. The first field is the name of the
192 program ("Yadex"). The second field is the version number
193 ("$VERSION"). The third field is the release date, between
194 parentheses ("($SOURCE_DATE)").
195 The second line contains a configuration file magic string (not
197 used).
198 The third line contains the magic string that this version
200 requires at the beginning of game definition files.
201 -w, -width dimension
203 (X11 only) Initial width of the window. If the argument is just
204 a number, the width of the window will be that many pixels. If
205 the argument is a number followed by a percent sign (%), it will
206 be that many percent of the width of the screen. The default is
207 90%. This option is equivalent to and overrides the width
208 directive in the configuration file. See also -h.
209 -z, -zoom_default integer
211 Initial zoom factor in percent. The default is 0, which means
212 that the zoom factor is to be adjusted so that the level fills
213 the window. This option is equivalent to and overrides the
214 zoom_default directive of the configuration file.
215
217 Configuration files
218 $FILES_ETC
219 Game definition files
221 $FILES_SHARE
222 Swap files
224 $TMPDIR/yadexswp??????
225 /tmp/yadexswp??????
226
228 DISPLAY
229 X11 only. The name of the X display that Yadex will try to con‐
230 nect to.
231 HOME Used to expand ~ when locating configuration and game definition
233 files.
234 LINES If set, Yadex assumes the tty has that many lines instead of 24.
236 The value must be an unsigned, non-zero decimal integer.
237 TMPDIR If set, swap files are created there. Otherwise, in /tmp.
239 YADEX_GAME
241 Indicates the game to use. Overrides the game parameter in the
242 config file, is overridden by the -g command line option.
243
245 None. Yadex does not use the X resources system.
246
248 0 OK.
249 1 Incorrect invocation.
250 >1 Fatal error.
251
253 In certain circumstances, exposures are not handled. If the Yadex win‐
254 dow turns black, back out by pressing [Esc], several times if neces‐
255 sary.
256 If you edit a level from a file that contains several and save it, all
258 the other levels from that file are lost.
259 And many more. See TODO.
261
263 André Majorel (http://www.teaser.fr/~amajorel/)
264 Contributors:
266 Andrew J. Apted (http://www.netspace.net.au/~ajapted/)
267 Matthew W. Miller (zbp+ee+fhozhybp=eryyvzjz)
268 Yadex is derived from DEU 5.21 that was written by Raphaël Quinet,
270 Brendon Wyber and others.
271 See the HTML documentation for detailed credits.
273
275 Yadex
276 $COPYRIGHT_MAN
277 This program is free software; you can redistribute it and/or modify it
279 under the terms of the GNU General Public License as published by the
280 Free Software Foundation; either version 2 of the License, or (at your
281 option) any later version.
282 This program is distributed in the hope that it will be useful, but
284 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
285 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
286 Public License for more details.
287 You should have received a copy of the GNU Library General Public
289 License along with this library; if not, write to the Free Software
290 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307,
291 USA.
292 Atclib
294 The Yadex distribution includes a subset of Atclib.
295 Atclib is copyright André Majorel 1995-1999 and distributed under the
297 terms of version 2 of the GNU Library General Public License.
298 This library is free software; you can redistribute it and/or modify it
300 under the terms of version 2 of the GNU Library General Public License
301 as published by the Free Software Foundation.
302 This library is distributed in the hope that it will be useful, but
304 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
305 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library
306 General Public License for more details.
307 You should have received a copy of the GNU Library General Public
309 License along with this library; if not, write to the Free Software
310 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
311 USA
312 Boost
314 The Yadex distribution includes a subset of Boost 1.25.0.
315 Boost 1.25.0 is copyright various authors and released under the fol‐
317 lowing terms : Permission to copy, use, modify, sell and distribute
318 this software is granted provided this copyright notice appears in all
319 copies. This software is provided "as is" without express or implied
320 warranty, and with no claim as to its suitability for any purpose.
321
323 bsp(6), idbsp(6), tkwadcad(6), warm(6), xwadtools(6)
324 LDE http://interreality.org/~tetron/technology/lde/
326 PFME http://www.purplefrog.com/~thoth/purplefrog/editor.html
328 Why http://www.hut.fi/~jpakkane/why/
330 Xwad (part of Dumb)
332 http://stekt.oulu.fi/~tosi/dumb/dumb.html
333 Xwadtools
335 ftp://3darchives.in-span.net/pub/idgames/source/
336Yadex $VERSION $SOURCE_DATE YADEX(6)