INSTALL

   1 REQUIREMENTS
   2
   3         vor requires the following libraries to build/run:
   4                 sdl           http://www.libsdl.org/download-1.2.php
   5                 sdl_mixer     http://www.libsdl.org/projects/SDL_mixer/
   6                 sdl_image     http://www.libsdl.org/projects/SDL_image/
   7
   8         If you are building from git, (or editing the graphics) you will also
   9         need:
  10
  11                 povray        http://www.povray.org/
  12                 netpbm        http://netpbm.sourceforge.net/
  13                 autoconf      version 2.63 or greater
  14
  15
  16 BUILDING A RELEASE
  17
  18         (see BUILDING FROM GIT if you don't have a release tarball)
  19
  20         change to the source directory and run this:
  21
  22         ./configure && make
  23
  24         Unless there are errors, you should be able to run the game from the
  25         source directory like this:
  26
  27         ./vor
  28
  29
  30 BUILDING FROM GIT
  31
  32         1) Make sure you have the extra dependencies first. If you want to avoid
  33         installing povray and/or netpbm, you can simply the data/ directory from a
  34         recent release.
  35
  36         Run "autoconf".
  37
  38         Continue as normal with the BUILDING A RELEASE section above.
  39
  40
  41 BUILDING FOR WINDOWS
  42
  43         Using mingw32 packages, you can use Linux to cross-compile a binary for
  44         Windows. Below is the recommended way to achieve this:
  45
  46         1) Install Fedora 11, and get up to date with "yum upgrade"
  47
  48         2) run as root: yum install mingw32-SDL_mixer mingw32-SDL_image
  49
  50         3) change to the VoR source directory
  51
  52         4) If you need to build the graphics (eg if you edited them, or if you're
  53         not using a release tarball) then run: ./configure && make graphics
  54
  55         5) run: mingw32-configure && make
  56
  57         6) make a directory with vor.exe, data/ and the following files from
  58         /usr/i686-pc-mingw32/sys-root/mingw/bin/: SDL.dll SDL_image.dll
  59         SDL_mixer.dll libjpeg-62.dll libpng12-0.dll zlib1.dll
  60
  61         7) (optional) change to that directory, and test like so: wine ./vor.exe
  62
  63         8) zip up that new directory and try it out on a Windows install.
  64
  65
  66 RUNNING
  67
  68         "./vor"
  69
  70         After building you should have an executable called "vor" in the
  71         current (source) directory. You can run this here, "./vor"
  72
  73 INSTALLING
  74
  75         You can run "make install" to install vor. If you're installing
  76         system-wide (for example, to the default install location of /usr/local)
  77         you'll need to run this as root.
  78
  79         You can specify an alternative install location with the --prefix=
  80         argument to ./configure. See the output of: ./configure --help for more
  81         information.