1Yadex 1.7.0 (2003-12-28)
2
3WHAT IS YADEX ?
4 Yadex is a Doom level (wad) editor for Unix systems running X,
5 including Linux. It supports Doom, Doom II, Ultimate Doom, Final
6 Doom, Heretic, Doom press release pre beta and also, in a more or
7 less limited way, Hexen, Strife and Doom alpha. It is available
8 under the terms of the GPL.
9
10PREREQUISITES
11 You need :
12 - Some flavour of Unix (known to work with AIX, FreeBSD, HP-UX,
13 Irix, Linux, NetBSD, OpenBSD, OpenUnix, QNX and Solaris),
14 - X11R6 or X11R5 and a display of at least 640x480,
15 - a Doom/Doom II/Heretic/Strife iwad (shareware/demo is OK),
16 - GNU make (vanilla make won't do),
17 - a standard C compiler (ISO 9899:1990),
18 - a standard C++ compiler,
19 - hypot() and either nanosleep() or usleep().
20
21BUILDING AND INSTALLING
22 To install in /usr/local :
23
24 ./configure
25 make
26 su -c 'make install'
27
28 To install somewhere else, for example in ~/yadex :
29
30 ./configure --prefix ~/yadex
31 make
32 make install
33
34 To force the use of a particular C/C++ compiler :
35
36 ./configure --cc gcc-3.3 --cxx g++-3.3
37 make
38 make install
39
40 Got problems getting Yadex to compile ? See doc/faq.html.
41 Got no problem ? Read the FAQ anyway. See doc/faq.html.
42
43 Beware, the installation OVERWRITES the following files (assuming
44 you're installing in /usr/local) :
45 /etc/yadex/1.7.0/yadex.cfg
46 /usr/local/bin/yadex
47 /usr/local/bin/yadex-1.7.0
48 /usr/local/man/man6/yadex.6
49 /usr/local/man/man6/yadex-1.7.0.6
50 /usr/local/share/games/yadex/1.7.0/doom.ygd
51 /usr/local/share/games/yadex/1.7.0/doom02.ygd
52 /usr/local/share/games/yadex/1.7.0/doom04.ygd
53 /usr/local/share/games/yadex/1.7.0/doom05.ygd
54 /usr/local/share/games/yadex/1.7.0/doom2.ygd
55 /usr/local/share/games/yadex/1.7.0/doompr.ygd
56 /usr/local/share/games/yadex/1.7.0/heretic.ygd
57 /usr/local/share/games/yadex/1.7.0/hexen.ygd
58 /usr/local/share/games/yadex/1.7.0/strife.ygd
59 /usr/local/share/games/yadex/1.7.0/strife10.ygd
60
61CONFIGURING AND RUNNING
62 Before you run Yadex, you need to tell it where to find your iwads.
63 Assuming you have installed in /usr/local, open
64 /etc/yadex/1.7.0/yadex.cfg with your favourite text editor and
65 insert the appropriate values for the parameters "iwad1", "iwad2",
66 etc. If you don't want Doom II to be the default iwad, also change
67 the value of the "game" parameter.
68
69 You can now run Yadex by typing :
70
71 yadex
72
73 A "yadex:" prompt should show. At that prompt, type this :
74
75 e map01
76
77 or this :
78
79 e e1m1
80
81 Have fun !
82
83DOCUMENTATION
84 There is a man page and quite a lot of documentation, most of it in
85 HTML format. Start at :
86
87 doc/index.html
88
89 If you're upgrading from a previous version of Yadex, please read
90 carefully CHANGES.
91
92STATUS
93 Yadex is work in progress. It still lacks important features like a
94 better interface, cut-and-paste, undo/redo, support for Boom and
95 many more. I know. They will come faster if you help. The source
96 code is a horrible mess. I'm not proud of it. Be indulgent.
97
98LEGAL
99 1. Yadex
100
101 Parts copyright Andrew Apted 2000-2001, GNU GPL v2
102 Parts copyright Andr� Majorel 1997-2003, GNU GPL v2
103 Parts copyright Matthew W. Miller 2000, GNU GPL v2
104 Parts written by Rapha�l Quinet, public domain
105 Parts written by Brendon Wyber, public domain
106
107 This program is free software; you can redistribute it and/or modify
108 it under the terms of the GNU General Public License as published by
109 the Free Software Foundation; either version 2 of the License, or
110 (at your option) any later version.
111
112 This program is distributed in the hope that it will be useful, but
113 WITHOUT ANY WARRANTY; without even the implied warranty of
114 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
115 General Public License for more details.
116
117 You should have received a copy of the GNU General Public License
118 along with this program; if not, write to the Free Software
119 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
120
121 2. Atclib
122
123 The Yadex distribution includes a subset of Atclib.
124
125 Atclib is copyright Andr� Majorel 1995-1999 and distributed under
126 the terms of version 2 of the GNU Library General Public License.
127
128 3. Boost
129
130 The Yadex distribution includes a subset of Boost 1.25.0. Boost
131 1.25.0 is copyright various authors and released under the following
132 terms : Permission to copy, use, modify, sell and distribute this
133 software is granted provided this copyright notice appears in all
134 copies. This software is provided "as is" without express or
135 implied warranty, and with no claim as to its suitability for any
136 purpose.
137
138CONTACT
139 See doc/contact.html for addresses.
140
141AYM 2003-12-28
142