build.txt

TITLE: X-Ray 1.6 build and setup instructions

Build:
------
Currently, the only compiler supported is Visual C++ 2015. If you don't have Visual Studio yet, you can
download and install Visual Studio 2015 Community Edition - it's absolutely free for open source projects.

By default, all libraries mentioned below (except Windows/DirectX SDK) are assumed to be in
the src\Externals directory.

To build X-Ray Engine you'll need following libraries:
* OpenSSL: https://www.openssl.org/source
  - Prebuilt binaries can be downloaded here: https://slproweb.com/products/Win32OpenSSL.html
* OpenAutomate: https://developer.nvidia.com/openautomate
* NVAPI: https://developer.nvidia.com/nvapi
* libjpeg: http://sourceforge.net/projects/libjpeg
  - Use "jpeg" as project root directory name for compatibility with CxImage
* zlib: http://zlib.net
* BugTrap: https://github.com/nitrocaster/BugTrap
* FreeImage: http://freeimage.sourceforge.net
* FreeMagic
* libogg-1.1.4: http://xiph.org/downloads
* libtheora-1.1.1: http://xiph.org/downloads
* libvorbis-1.2.3: http://xiph.org/downloads
* Autodesk Maya 2008/2009 SDK
* Autodesk 3DS Max 6.0 SDK
* Windows SDK: http://www.microsoft.com/en-us/download/details.aspx?id=8279
* DirectX SDK June 2010: http://www.microsoft.com/en-us/download/details.aspx?id=6812
  - replace dxguid.lib with the one from Windows SDK
    (for DirectPlay GUIDs)
XXX nitrocaster: add LuaJIT & LuaBind instructions

You can download all these libraries (except Windows/DirectX SDK) with compiled binaries here:
https://drive.google.com/file/d/0B2mH6ffKfXjCMjRfRTZsVlBtUVE

Setup:
------
- Install S.T.A.L.K.E.R Call of Pripyat
- Install patch 1.6.02 (only for russian locale, worldwide release should have it included):
  http://cop.stalker-game.ru/?page=patches#2
- Download and unpack archive with libraries
- Run xrbinprep.cmd to initialize new game binary directories and link default gamedata to OpenXRay's:
  $ xrbinprep.cmd "C:\Program Files (x86)\GSC World Publishing\S.T.A.L.K.E.R. - Call of Pripyat"
  Note that this script requires admin rights (in order to execute 'mklink'). Also make sure you pass a
  game installation directory to this script. Once done, you can find .xrbinup_xxx scripts in the reporitory root:
  use them later to install newly built binaries to the corresponding game binary directory.
- Now you can build the engine!