INSTALL

   1 Installation Instructions
   2 =========================
   3
   4 Requirements
   5 ------------
   6
   7 vor requires the following libraries to build/run:
   8
   9 *       sdl           http://www.libsdl.org/download-1.2.php
  10 *       sdl_mixer     http://www.libsdl.org/projects/SDL_mixer/
  11 *       sdl_image     http://www.libsdl.org/projects/SDL_image/
  12
  13 If you are building from git, (or editing the graphics) you will also
  14 need:
  15
  16         autoconf      version 2.63 or greater
  17
  18 You'll also need the graphics (`data` subdir) from the tarbal, or the following
  19 packages to render the graphics:
  20
  21         povray        http://www.povray.org/
  22         netpbm        http://netpbm.sourceforge.net/
  23
  24
  25 Building From A Release Tarball
  26 -------------------------------
  27
  28 (See Building From Git below if you don't have a release tarball)
  29
  30 change to the source directory and run this:
  31
  32 ./configure && make
  33
  34 Unless there are errors, you should be able to run the game from the
  35 source directory like this:
  36
  37 ./vor
  38
  39
  40 Building From Git
  41 -----------------
  42
  43 1.      Make sure you have the extra dependencies first. If you want to avoid
  44         installing povray and/or netpbm, you can simply copy the data/ directory
  45         from a recent release.
  46
  47 2.      Run ``autoreconf``
  48
  49 3.      Continue as normal with the Building From A Release Tarball section above.
  50
  51
  52 Building For Windows
  53 --------------------
  54
  55 These instructions should work on most any modern GNU/Linux system, and maybe
  56 other Unix-like systems.
  57
  58 1.      Download MXE (and install its dependencies) by following just step 1 of
  59         this tutorial:
  60
  61         http://mxe.cc/#tutorial
  62
  63 2.      `cd` into the `mxe` directory
  64
  65 3.      Run this: (takes some patience)
  66
  67                 make gcc
  68
  69 4.      Run this:
  70
  71                 make sdl-image sdl-mixer
  72
  73 5.      Set up your environment for cross-compiling:
  74
  75                 export PATH="/PATH/TO/YOUR/MXE/DIR/usr/bin:$PATH"
  76
  77 6.      `cd` to vor source directory.
  78
  79 7.      Build VoR with this command:
  80
  81                 ./configure --host=i686-pc-mingw32 && make
  82
  83
  84 Running
  85 -------
  86
  87         You can run VoR from the source directory without installing it:
  88
  89                 ./vor
  90
  91         add `-h` to see commandline arguments.
  92
  93         See `README` file for keys, etc.
  94
  95
  96 Installing
  97 ----------
  98
  99         You can run `make install` to install vor. If you're installing
 100         system-wide (for example, to the default install location of `/usr/local`)
 101         you'll need to run this as root.
 102
 103         You can specify an alternative install location with the `--prefix=`
 104         argument to `./configure`. See the output of: `./configure --help` for more
 105         information.