eureka(6)

1EUREKA(6)                        Games Manual                        EUREKA(6)
2
3
4

NAME

6       Eureka - a DOOM map editor
7

SYNOPSIS

9       eureka [FILE...]  [OPTION...]
10

DESCRIPTION

12       Eureka is a cross-platform map editor for the classic DOOM games.
13
14       It  features  multiple-level  undo  and redo, a 3D preview, texture and
15       thing browsers, a built-in nodes builder, panels for  directly  editing
16       the  properties  of map objects, a flexible key binding system, and low
17       system requirements (e.g. a 3D card is not required).
18

OPTIONS

20       Note that long options are shown here with two dashes, but may also  be
21       used with a single dash for compatibility with the original DOOM binary
22       and various source ports.
23
24       -f, --file <file>...
25              Wad file(s) to edit.  This is mainly for compatibility with DOOM
26              command-line  syntax,  since  filenames are more easily provided
27              without this option (i.e. directly after the program name).
28
29              When no file is specified, Eureka will open the first map in the
30              IWAD (game wad).
31
32       -w, --warp <map>
33              Level  to  edit.  This can be the full map name, e.g. "MAP12" or
34              "E3M7", but can also be a single number like "12"  or  "37",  or
35              two  separate  numbers  like "3 7" for compatibility with DOOM 1
36              and Ultimate DOOM.
37
38              When absent, the first level found in the edited wad is used.
39
40       -i, --iwad <file>
41              The name of the IWAD (game data).  This  also  determines  which
42              game  the  map  is for, e.g. "doom.wad" will mean the map is for
43              DOOM 1, whereas "heretic.wad" will mean we are editing  for  the
44              game Heretic.
45
46       -m, --merge <file>...
47              Resource  file(s)  to  load.   These can be wad files containing
48              textures, flats, sprites (etc) but can also  be  Eureka  defini‐
49              tions files (with ".ugh" extension).
50
51       -p, --port <name>
52              Port  (engine) name.  The default port is "boom", but some other
53              supported ports are  "vanilla"  (the  original  EXE),  "odamex",
54              "edge" and "legacy".
55
56       -h, --help
57              Show usage summary
58
59       -v, --version
60              Show the version
61
62       -d, --debug
63              Enable debugging messages
64
65       -q, --quiet
66              Quiet mode (no messages on stdout)
67

CONFIGURATION OPTIONS

69       The following options control how Eureka finds some important files and
70       directories.  They are not particular useful per se, but may be  needed
71       for special circumstances.
72
73       --install <dir>
74              The  installation directory where game definition files, default
75              key  bindings,  etc  are  stored.   This   defaults   to   $PRE‐
76              FIX/share/eureka (see FILES section below...)
77
78              Specifying  "." for the current directory is useful when testing
79              a locally compiled version without  doing  "make  install".   In
80              fact  Eureka  will  try it automatically when it cannot find its
81              normal installation directory.
82
83       --home <dir>
84              The home directory where user settings, backups, etc are stored.
85              This defaults to the ~/.eureka directory.
86
87       --log <file>
88              File where all log messages are written.  Defaults to "logs.txt"
89              under the home directory.
90
91       --config <file>
92              The config file which stores the general user settings (but  not
93              key  bindings).   This file will loaded during startup, and also
94              saved to when the user uses the Preferences dialog.
95

FILES

97       $PREFIX/share/eureka/
98              The installation directory for Eureka.  PREFIX is typically /usr
99              or  /usr/local, depending on how Eureka was installed.  This di‐
100              rectory contains the standard key bindings, plus all the defini‐
101              tion  files (with .ugh extension) for the supported games, ports
102              and mods.
103
104       ~/.eureka/config.cfg
105              Contains user settings
106
107       ~/.eureka/bindings.cfg
108              Contains user key bindings
109
110       ~/.eureka/logs.txt
111              The logs from the previous session of Eureka, or the current one
112              if Eureka is currently running.
113
114       ~/.eureka/backups
115              Whenever  a file is saved, Eureka makes a backup of the existing
116              file and stores it here, in a directory based on  the  filename.
117              Multiple  backups are made, up to a configurable limit on number
118              and total size of the files.
119
120              If something goes awry with your wad, look here!
121
122       ~/.eureka/iwads
123              IWAD files can be placed here and Eureka will find them automat‐
124              ically
125

ENVIRONMENT

127       DOOMWADDIR
128              If  set, contains a single directory name where Eureka will look
129              for IWADs.
130
131       DOOMWADPATH
132              If set, contains a colon-separated list of directories where Eu‐
133              reka will look for IWADs.
134