README_original.txt

   1
   2 Eureka 1.27 README
   3 ==================
   4
   5
   6 INTRODUCTION
   7
   8 Eureka is a map editor for the classic DOOM games, and a few related
   9 games such as Heretic and Hexen.  The supported operating systems are
  10 Linux (and other Unix-likes), Windows and MacOS X.
  11
  12
  13 WEB SITE
  14
  15 http://eureka-editor.sourceforge.net/
  16
  17
  18 FEATURES
  19
  20 -  Undo/Redo (multiple levels)
  21 -  3D view with good lighting emulation
  22 -  Editable panels for things, linedefs, sectors (etc)
  23 -  Browser for textures, flats, things (etc)
  24 -  Key binding system
  25 -  Built-in nodes builder
  26
  27
  28 SUPPORTED GAMES
  29
  30 -  DOOM
  31 -  DOOM 2
  32 -  Final Doom
  33 -  FreeDoom
  34 -  HacX
  35 -  Heretic
  36 -  Hexen
  37
  38
  39 REQUIREMENTS
  40
  41 -  128 MB of computer memory
  42 -  1024x720 or higher screen resolution
  43 -  3D accelerated graphics card
  44 -  a keyboard and a two-button mouse
  45 -  the data (iwad) file from a supported game
  46
  47
  48 COMPILATION
  49
  50 See the INSTALL.txt document (in source code)
  51
  52
  53 RUNNING
  54
  55 You can run Eureka from the command line, or it can be run from
  56 the desktop menu (if your OS handles .desktop files as per the
  57 XDG specs).  Eureka will need to be able to find an IWAD to run,
  58 if it cannot find any then the "Manage Wads" dialog will open up,
  59 allowing you to "Find" one (which is remembered for next time).
  60
  61 You can open a PWAD file using the File/Open menu command, or start
  62 a new map with File/New command.
  63
  64 You can also specify the PWAD to edit on the command line, either
  65 on its own or with the -file option:
  66
  67    eureka -file masterpiece.wad
  68
  69 If that PWAD contains multiple maps, you may need to specify which
  70 one to edit using the -warp option:
  71
  72    eureka -file masterpiece.wad -warp 14
  73
  74 For a summary of useful command line options, type:
  75
  76    eureka --help
  77
  78
  79
  80 KEYBOARD AND MOUSE CONTROLS
  81
  82 All Modes
  83 ---------
  84
  85 LMB
  86 * select an object, drag to move the object(s)
  87 * click in empty area to clear the selection
  88 * click + drag in empty area to select a group of objects
  89
  90 RMB
  91 * begin/continue line drawing (in vertex mode)
  92 * merge sectors (in sectors mode)
  93 * with CTRL pressed: bring up operation menu
  94
  95 MMB
  96 * scroll the map around (by dragging)
  97
  98 wheel : zoom in or out
  99
 100 cursor keys : scroll the map
 101
 102 F1 : operation menu
 103
 104 TAB : toggle the 3D preview on or off
 105 ESC : cancel the current operation
 106
 107 t : enter Thing mode
 108 l : enter Linedef mode
 109 s : enter Sector mode
 110 v : enter Vertex mode
 111
 112 b : toggle the Browser on or off
 113
 114 1..9 : select the grid size (smallest to largest)
 115
 116 CTRL-Z : undo (can be used multiple times)
 117 CTRL-Y : redo (i.e. undo the previous undo)
 118
 119 CTRL-A : select all
 120 CTRL-I : invert the selection
 121 CTRL-U : unselect all
 122 ` (backquote) : unselect all
 123
 124 HOME : zoom 2D viewport to show the whole map
 125 END  : move 2D viewport to camera location
 126 ' (quote) : move 3D camera to position of mouse pointer
 127
 128 f : toggle free mode vs grid snapping
 129 g : toggle grid on / off
 130
 131 N : open next map in the current wad
 132 P : open previous map in the current wad
 133
 134 j : jump to object (by its numeric id)
 135 J : toggle object number display
 136
 137 o : copy and paste the selected objects
 138 c : copy properties from selected --> highlighted object
 139 C : copy properties from highlighted --> selected objects
 140
 141 H : mirror objects horizontally
 142 V : mirror objects vertically
 143 R : rotate objects 90 degrees clockwise
 144 W : rotate objects 90 degrees anti-clockwise
 145
 146 a : scroll map with the mouse
 147 r : scale selected objects with the mouse
 148 R : scale selected objects, allow stretching
 149 CTRL-R : rotate the selected objects (with the mouse)
 150 K : skew (shear) the selected objects
 151
 152 \ : toggle the RECENT category in the Browser
 153
 154 u  : popup menu to set ratio lock
 155 z  : popup menu to set current scale
 156 B  : popup menu to set browser mode
 157 F8 : popup menu to set sector rendering mode
 158
 159 ; : make the next key pressed META
 160
 161 META-N : load next file in given list
 162 META-P : load previous file in given list
 163
 164 META-F : apply a fresh tag to the current objects
 165 META-L : apply the last (highest) tag to the current objects
 166
 167
 168 Things Mode
 169 -----------
 170
 171 SPACE : add a new thing
 172
 173 d : disconnect things at the same location
 174 m : move selected things to occupy the same location
 175
 176 w : rotate things 45 degrees anti-clockwise
 177 x : rotate things 45 degrees clockwise
 178
 179
 180 Vertex Mode
 181 -----------
 182
 183 SPACE
 184 * begin/continue line drawing
 185 * with SHIFT key: always continue line drawing
 186 * with CTRL key: inhibit creation of sectors
 187
 188 d : disconnect all linedefs at the selected vertices
 189 m : merge selected vertices into a single one
 190 u : unlock any current ratio lock
 191
 192 I : reshape selected vertices into a line
 193 O : reshape selected vertices into a circle
 194 D : reshape selected vertices into a half-circle
 195 C : reshape selected vertices into a 120-degree arc
 196 Q : reshape selected vertices into a 240-degree arc
 197
 198
 199 Linedef Mode
 200 ------------
 201
 202 e : select a chain of linedefs
 203 E : select a chain of linedefs with same textures
 204
 205 w : flip linedefs
 206 k : split linedefs in two
 207 A : auto-align offsets on all selected linedefs
 208
 209 d : disconnect selected linedefs from the rest
 210 m : merge two one-sided linedefs into a two-sided linedef
 211
 212
 213 Sector Mode
 214 -----------
 215
 216 SPACE
 217 * add a new sector to area around the mouse pointer
 218 * if a sector is selected, copy that sector instead of using defaults
 219
 220 d : disconnect sector(s) from their neighbors
 221 m : merge all selected sectors into a single one
 222
 223 w : swap floor and ceiling textures
 224 i : increase light level
 225 I : decrease light level
 226
 227 e : select sectors with same floor height
 228 E : select sectors with same floor texture
 229 D : select sectors with same ceiling texture
 230
 231 , and < : lower floor heights
 232 . and > : raise floor heights
 233 [ and { : lower ceiling heights
 234 ] and } : raise ceiling heights
 235
 236
 237 3D View
 238 -------
 239
 240 (cursor keys will move forward and back, turn left and right)
 241 (the WASD keys can also be used to move the camera)
 242
 243 LMB : select walls, floors or ceilings
 244 MMB : turn or move the camera (by dragging the mouse)
 245
 246 wheel : move camera forwards or backwards
 247
 248 PGUP and PGDN : move camera up and down
 249
 250 g : toggle gravity (i.e. as if the player was on the ground)
 251 e : popup menu to set edit mode
 252 o : toggle objects on or off
 253
 254 META-v : drop to the ground
 255 META-l : toggle lighting on or off
 256 META-t : toggle texturing on or off
 257
 258 F11 : increase brightness (gamma)
 259
 260 r : adjust offsets on highlighted wall (with the mouse)
 261 c : clear offsets on highlighted wall
 262
 263 x : align X offset with wall to the left
 264 y : align Y offset with wall to the left
 265 z : align both X + Y offsets
 266
 267 X : align X offset with wall to the right
 268 Y : align Y offset with wall to the right
 269 Z : align both X + Y offsets
 270
 271
 272
 273 COPYRIGHT and LICENSE
 274
 275   Eureka DOOM Editor
 276
 277   Copyright (C) 2014-2020 Ioan Chera
 278   Copyright (C) 2001-2020 Andrew Apted, et al
 279   Copyright (C) 1997-2003 Andre Majorel et al
 280
 281   Eureka is free software; you can redistribute it and/or modify
 282   it under the terms of the GNU General Public License as published
 283   by the Free Software Foundation; either version 2 of the License,
 284   or (at your option) any later version.
 285
 286   Eureka is distributed in the hope that it will be useful, but
 287   WITHOUT ANY WARRANTY; without even the implied warranty of
 288   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 289   GNU General Public License for more details.
 290