INSTALL.txt

   1
   2 COMPILING (Linux)
   3 =================
   4
   5 Note: this section deals with compiling the Linux binary.
   6 For information on compiling for Windows and MacOS X, see below.
   7
   8
   9 Dependencies:
  10
  11 1. C++ compiler (GNU's G++) and associated tools
  12    packages: g++ binutils
  13
  14 2. GNU make
  15    package: make
  16
  17 3. FLTK 1.3
  18    website: http://www.fltk.org/
  19    package: libfltk1.3-dev
  20
  21    You may also need: libxft-dev
  22                       libxinerama-dev
  23                       libfontconfig-dev
  24                       libjpeg-dev
  25                       libpng-dev
  26
  27 4. OpenGL
  28    (recommended but not strictly necessary, see below)
  29
  30 5. zlib
  31    website: http://www.zlib.net/
  32    package: zlib1g-dev
  33
  34 6. XDG Utils
  35    (only needed for Linux, to install the desktop and icon files)
  36    package: xdg-utils
  37
  38
  39 Assuming all those dependencies are met, then the following shell
  40 command will build the Eureka binary. (the '>' is just the prompt)
  41
  42    > make
  43
  44
  45 Some systems may need additional CFLAGS and/or LDFLAGS in order
  46 to find the required libraries (especially FLTK).  For example,
  47 the following is reported to work for Gentoo Linux:
  48
  49    CFLAGS  += -I/usr/include/fltk-1
  50    LDFLAGS += -L/usr/lib64/fltk-1/
  51
  52
  53 OpenGL is used to greatly speed up the 2D and 3D views, however
  54 Eureka still supports software-only rendering as a compile-time
  55 option.  You will need to edit the Makefile and disable OpenGL
  56 support -- look for the line containing NO_OPENGL and uncomment
  57 that line, and remove all GL libraries from the build.
  58
  59
  60
  61 INSTALLING (Linux)
  62 ==================
  63
  64 First make sure the Eureka binary was compiled successfully.
  65
  66 Then become root (via the 'sudo' or 'su' command) and enter the
  67 following shell command:
  68
  69    > make full-install
  70
  71 That will install the eureka binary, definition files for various
  72 games and source ports, and the desktop and icon files.
  73
  74 There is also a plain "install" target which does not run the
  75 XDG utilities (which install the desktop and icon files).
  76
  77
  78
  79 COMPILING (Windows)
  80 ===================
  81
  82 The official windows executable is built using a "cross compiler"
  83 under Linux, using the MingW-w64 tools.
  84
  85 Sorry but compiling Eureka under Windows itself is not currently
  86 supported.  If you want to do this, you will have to figure it
  87 out on your own.
  88
  89
  90 Dependencies:
  91
  92 1. C++ cross compiler and tools
  93    package: mingw-w64
  94
  95 2. GNU make
  96    package: make
  97
  98 3. FLTK 1.3.5
  99    website: http://www.fltk.org/
 100
 101
 102 The FLTK library must be in a directory called "lib_win32" with the
 103 name "fltk-1.3.5" (it can be a symlink to the actual location), and
 104 it needs to be cross-compiled with MingW-w64.  Our makefile assumes
 105 that FLTK was compiled to use its internal copies of the zlib, png
 106 and jpeg libraries.  FLTK has some information on cross-compiling
 107 in the "README.CMake.txt" document.
 108
 109 Assuming all those dependencies are met, then the following shell
 110 command will build the Eureka binary. (the '>' is just the prompt)
 111
 112    > make -f Makefile.xming
 113
 114
 115
 116 COMPILING (MacOS X)
 117 ===================
 118
 119 Compiling the MacOS X binary requires Xcode 4.
 120
 121 See the documents in the osx/ folder for more information.
 122
 123
 124
 125 SETTING UP Eureka
 126 =================
 127
 128 Eureka requires an IWAD file from one of the supported games, for
 129 example "doom2.wad".  Eureka will look for IWADs when it starts up,
 130 but if it cannot find any then the 'Manage Wads' dialog will open
 131 and you can browse for an IWAD file there, which will be remembered
 132 for next time.
 133
 134 Places where Eureka looks for IWADs:
 135
 136   1. The "iwads" directory in Eureka's home directory.  In Linux
 137      this will be "~/.eureka/iwads".  It is created automatically
 138      the first time Eureka is run (though there is no harm in
 139      creating it yourself).
 140
 141   2. (a) In Linux: /usr/share/games/doom
 142      (b) In Windows: C:\DOOM and C:\DOOM2
 143
 144   3. If you run Eureka from the command line and have the DOOMWADDIR
 145      or DOOMWADPATH environment variables set, then Eureka should find
 146      it the specified directory.
 147
 148   4. If running from the command line, Eureka will look in the current
 149      directory for the IWAD.
 150
 151   5. You can specify the IWAD file directly with the --iwad option.
 152