Updated build instructions

OpenXRay · Jun 17, 2018 · 126161c · 126161c
1 parent 96d9ad4
commit 126161c
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 51 deletions.
diff --git a/doc/howto/build-linux.txt b/doc/howto/build-linux.txt
@@ -21,43 +21,41 @@ cmake ..
 (or export CC=clang && export CXX=clang++ && cmake ..)
 make
 
-
-Build:
+Libraries:
 ------
 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
+* Windows SDK
+* BugTrap: https://github.com/Xottab-DUTY/BugTrap
+* CryptoPP: https://github.com/weidai11/cryptopp
 * FreeImage: http://freeimage.sourceforge.net
-* FreeMagic
+* FreeMagic: https://github.com/OpenXRay/FreeMagic
+* GameSpy: https://github.com/nitrocaster/GameSpy
+* libjpeg: https://github.com/OpenXRay/libjpeg
+ - Use "jpeg" as project root directory name for compatibility with CxImage
 * 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
+* Lightwave: https://github.com/OpenXRay/LightWave
+* Luabind: https://github.com/Xottab-DUTY/luabind-deboostified
+* LuaJIT: https://github.com/Xottab-DUTY/LuaJIT
+* lzo: https://github.com/alexgdi/lzo
+* Autodesk Maya 2008/2009 SDK: https://github.com/OpenXRay/maya
+* Autodesk 3DS Max 6.0 SDK: https://github.com/OpenXRay/3dsmax
+* NVAPI: https://developer.nvidia.com/nvapi
+* OpenAutomate: https://developer.nvidia.com/openautomate
+* pugixml: https://github.com/zeux/pugixml/
+* zlib: http://zlib.net
+All mentioned libraries are already in repository as submodules!
 
 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.
+- Clone the repository (you should not download it as an archive)
+ You can just push `Open in Desktop` if you are using Github Desktop.
+ If you are using Git console, here's the command:
+ `git clone https://github.com/OpenXRay/xray-16.git --recurse-submodules`
+- If you are using git client, make sure all submodules are initialized.
+ Type this command in the Git console `git submodule update --init --recursive`
 - Now you can build the engine!
diff --git a/doc/howto/build.txt b/doc/howto/build.txt
@@ -6,8 +6,7 @@ Currently, the only compiler supported is Visual C++ 2017. If you don't have Vis
 download and install Visual Studio 2017 Community Edition - it's absolutely free for open source projects.
 
 By default, all libraries mentioned below (except Windows SDK) are assumed to be in
-the src\Externals directory. You can download all these libraries (except Windows SDK) with compiled binaries here:
-https://drive.google.com/file/d/0B2mH6ffKfXjCMjRfRTZsVlBtUVE
+the src\Externals directory.
 
 Windows SDK is available from Visual Studio 2017 installer. You will definitely need to install the following items:
 * Windows 8.1 SDK (or newer)
@@ -20,38 +19,40 @@ https://marketplace.visualstudio.com/items?itemName=hbuexinxin.ForceUTF8NoBOM
 Libraries:
 ------
 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
+* Windows SDK
+* BugTrap: https://github.com/Xottab-DUTY/BugTrap
+* CryptoPP: https://github.com/weidai11/cryptopp
 * FreeImage: http://freeimage.sourceforge.net
-* FreeMagic
+* FreeMagic: https://github.com/OpenXRay/FreeMagic
+* GameSpy: https://github.com/nitrocaster/GameSpy
+* libjpeg: https://github.com/OpenXRay/libjpeg
+ - Use "jpeg" as project root directory name for compatibility with CxImage
 * 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
-* DirectX SDK June 2010 (DOES NOT NEED ANYMORE ?): 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
+* Lightwave: https://github.com/OpenXRay/LightWave
+* Luabind: https://github.com/Xottab-DUTY/luabind-deboostified
+* LuaJIT: https://github.com/Xottab-DUTY/LuaJIT
+* lzo: https://github.com/alexgdi/lzo
+* Autodesk Maya 2008/2009 SDK: https://github.com/OpenXRay/maya
+* Autodesk 3DS Max 6.0 SDK: https://github.com/OpenXRay/3dsmax
+* NVAPI: https://developer.nvidia.com/nvapi
+* OpenAutomate: https://developer.nvidia.com/openautomate
+* pugixml: https://github.com/zeux/pugixml/
+* zlib: http://zlib.net
+All mentioned libraries are already in repository as submodules!
 
 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.
+- Clone the repository (you should not download it as an archive)
+ You can just push `Open in Desktop` if you are using Github Desktop.
+ If you are using Git console, here's the command:
+ `git clone https://github.com/OpenXRay/xray-16.git --recurse-submodules`
+- If you are using git client, make sure all submodules are initialized.
+ Type this command in the Git console `git submodule update --init --recursive`
 - Now you can build the engine!
 
 Debug/Run from Visual Studio: