docs/INSTALL

   1 -------------------------------------------
   2 Virtual Jaguar v2.1.3 Rx Qt release INSTALL
   3 -------------------------------------------
   4
   5
   6 REQUIREMENTS:
   7 -------------
   8
   9 The minimum requirements for compiling Virtual Jaguar from source are:
  10
  11  o  GCC v4.4.x or higher
  12  o  SDL v1.2.15
  13  o  zlib v1.2.8 or higher
  14  o  libelf 0.8.13
  15  o  libdwarf 1.41
  16  o  libcdio v0.90 or higher (optional, for Jaguar CD support)
  17  o  OpenGL libraries
  18  o  Qt 5.5.1 or higher
  19  o  Visual Studio 2015 or 2017 (if any of interest)
  20  o  supported OS (WIN64 through msys2/MinGW64, Windows 64 bits); other
  21     OSs may work to but you may need to change some items in the Makefile or adapt the Visual Studio project.
  22  o  cygwin64 support is done but no test has been completed
  23
  24 Previously supported OS (BeOS, Linux, FreeBSD and WIN32 through mingw, MacOS);
  25 other OSs may work to but you may need to change some items in the Makefile.
  26
  27
  28 COMPILING:
  29 ----------
  30
  31 Assuming that you meet the minimum software requirements, you can compile
  32 Virtual Jaguar by issuing the following command in the directory where you
  33 decompressed the source:
  34
  35 make
  36
  37 Optionally you can manually strip virtualjaguar[.exe] to downsize the binary.
  38 You can also run upx on the binary as well and you'll end up with a somewhat
  39 smaller binary.
  40
  41 That's it! You can now start the emulator with ./virtualjaguar. See the built
  42 in help (Help|Contents) for more info.
  43
  44 For even more info, go to http://icculus.org/virtualjaguar.
  45
  46
  47 NOTES FOR COMPILING UNDER MAC OSX:
  48 ----------------------------------
  49
  50 All is not well in Appleland, but we can help. Apple, in their infinite wisdom,
  51 has decided not to ship a compiler and tools to build software. So first of all
  52 you need to download and install 'Command Line Tools for XCode'. Then, to
  53 compile the bare minimum app under OSX requires libsdl and Qt; however, these
  54 must be made statically and installed "the unix way". What that means is you
  55 have to download and unpack the source directories, then make and install them
  56 from the terminal. For libsdl, this is as simple as doing:
  57
  58 ./configure
  59 make
  60 sudo make install
  61
  62 libsdl makes both static *and* shared libs and installs both. Making Qt takes a
  63 bit longer (timewise), but requires not much user intervention to get things
  64 going. Basically, you do:
  65
  66 ./configure -static -no-webkit -no-qt3support -no-framework -no-exceptions -nomake examples -nomake demos
  67 make
  68 sudo make install
  69
  70 Be forewarned that it will use around 20 GB of disk space to build, and another
  71 20 GB for the install! Once libsdl and Qt have been made and installed, you can
  72 now go into the folder where the Virtual Jaguar source is and do:
  73
  74 make
  75
  76 Assuming all went well, you should now have a nice shiny new virtualjaguar.app
  77 in that folder. Depending on how old your copy of OSX is, you might have to
  78 copy a qt_menu.nib into the app bundle like so:
  79
  80 cp -r ~/location-where-you-built-qt/src/gui/mac/qt_menu.nib virtualjaguar.app/Contents/Resources/
  81
  82 Have fun!
  83
  84
  85 NOTES FOR COMPILING UNDER VISUAL STUDIO 2015 / 2017:
  86 ----------------------------------------------------
  87
  88 Win-VS2015 & Win-VS2017 sub-directories contain the projects and solution files
  89 You may have to adapt such files to handle your own development environement,
  90 usualy to put the right include and library paths will be enough assuming you have all the requirements properly set.
  91
  92 Assuming all went well, you will have either Debug or Release executables.
  93 You will also need the QT5 & SDL necessary DLLs in the executable directory.