Skip to content

Commit 126161c

Browse files
Xottab-DUTYXottab-DUTY
committed
Updated build instructions
1 parent 96d9ad4 commit 126161c

File tree

2 files changed

+50
-51
lines changed

2 files changed

+50
-51
lines changed

‎doc/howto/build-linux.txt

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -21,43 +21,41 @@ cmake ..
2121
(or export CC=clang && export CXX=clang++ && cmake ..)
2222
make
2323

24-
25-
Build:
24+
Libraries:
2625
------
2726
To build X-Ray Engine you'll need following libraries:
28-
* OpenSSL: https://www.openssl.org/source
29-
- Prebuilt binaries can be downloaded here: https://slproweb.com/products/Win32OpenSSL.html
30-
* OpenAutomate: https://developer.nvidia.com/openautomate
31-
* NVAPI: https://developer.nvidia.com/nvapi
32-
* libjpeg: http://sourceforge.net/projects/libjpeg
33-
- Use "jpeg" as project root directory name for compatibility with CxImage
34-
* zlib: http://zlib.net
35-
* BugTrap: https://github.com/nitrocaster/BugTrap
27+
* Windows SDK
28+
* BugTrap: https://github.com/Xottab-DUTY/BugTrap
29+
* CryptoPP: https://github.com/weidai11/cryptopp
3630
* FreeImage: http://freeimage.sourceforge.net
37-
* FreeMagic
31+
* FreeMagic: https://github.com/OpenXRay/FreeMagic
32+
* GameSpy: https://github.com/nitrocaster/GameSpy
33+
* libjpeg: https://github.com/OpenXRay/libjpeg
34+
- Use "jpeg" as project root directory name for compatibility with CxImage
3835
* libogg-1.1.4: http://xiph.org/downloads
3936
* libtheora-1.1.1: http://xiph.org/downloads
4037
* libvorbis-1.2.3: http://xiph.org/downloads
41-
* Autodesk Maya 2008/2009 SDK
42-
* Autodesk 3DS Max 6.0 SDK
43-
* Windows SDK: http://www.microsoft.com/en-us/download/details.aspx?id=8279
44-
* DirectX SDK June 2010: http://www.microsoft.com/en-us/download/details.aspx?id=6812
45-
- replace dxguid.lib with the one from Windows SDK
46-
(for DirectPlay GUIDs)
47-
XXX nitrocaster: add LuaJIT & LuaBind instructions
48-
49-
You can download all these libraries (except Windows/DirectX SDK) with compiled binaries here:
50-
https://drive.google.com/file/d/0B2mH6ffKfXjCMjRfRTZsVlBtUVE
38+
* Lightwave: https://github.com/OpenXRay/LightWave
39+
* Luabind: https://github.com/Xottab-DUTY/luabind-deboostified
40+
* LuaJIT: https://github.com/Xottab-DUTY/LuaJIT
41+
* lzo: https://github.com/alexgdi/lzo
42+
* Autodesk Maya 2008/2009 SDK: https://github.com/OpenXRay/maya
43+
* Autodesk 3DS Max 6.0 SDK: https://github.com/OpenXRay/3dsmax
44+
* NVAPI: https://developer.nvidia.com/nvapi
45+
* OpenAutomate: https://developer.nvidia.com/openautomate
46+
* pugixml: https://github.com/zeux/pugixml/
47+
* zlib: http://zlib.net
48+
All mentioned libraries are already in repository as submodules!
5149

5250
Setup:
5351
------
5452
- Install S.T.A.L.K.E.R Call of Pripyat
5553
- Install patch 1.6.02 (only for russian locale, worldwide release should have it included):
5654
http://cop.stalker-game.ru/?page=patches#2
57-
- Download and unpack archive with libraries
58-
- Run xrbinprep.cmd to initialize new game binary directories and link default gamedata to OpenXRay's:
59-
$ xrbinprep.cmd "C:\Program Files (x86)\GSC World Publishing\S.T.A.L.K.E.R. - Call of Pripyat"
60-
Note that this script requires admin rights (in order to execute 'mklink'). Also make sure you pass a
61-
game installation directory to this script. Once done, you can find .xrbinup_xxx scripts in the reporitory root:
62-
use them later to install newly built binaries to the corresponding game binary directory.
55+
- Clone the repository (you should not download it as an archive)
56+
You can just push `Open in Desktop` if you are using Github Desktop.
57+
If you are using Git console, here's the command:
58+
`git clone https://github.com/OpenXRay/xray-16.git --recurse-submodules`
59+
- If you are using git client, make sure all submodules are initialized.
60+
Type this command in the Git console `git submodule update --init --recursive`
6361
- Now you can build the engine!

‎doc/howto/build.txt

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ Currently, the only compiler supported is Visual C++ 2017. If you don't have Vis
66
download and install Visual Studio 2017 Community Edition - it's absolutely free for open source projects.
77

88
By default, all libraries mentioned below (except Windows SDK) are assumed to be in
9-
the src\Externals directory. You can download all these libraries (except Windows SDK) with compiled binaries here:
10-
https://drive.google.com/file/d/0B2mH6ffKfXjCMjRfRTZsVlBtUVE
9+
the src\Externals directory.
1110

1211
Windows SDK is available from Visual Studio 2017 installer. You will definitely need to install the following items:
1312
* Windows 8.1 SDK (or newer)
@@ -20,38 +19,40 @@ https://marketplace.visualstudio.com/items?itemName=hbuexinxin.ForceUTF8NoBOM
2019
Libraries:
2120
------
2221
To build X-Ray Engine you'll need following libraries:
23-
* OpenSSL: https://www.openssl.org/source
24-
- Prebuilt binaries can be downloaded here: https://slproweb.com/products/Win32OpenSSL.html
25-
* OpenAutomate: https://developer.nvidia.com/openautomate
26-
* NVAPI: https://developer.nvidia.com/nvapi
27-
* libjpeg: http://sourceforge.net/projects/libjpeg
28-
- Use "jpeg" as project root directory name for compatibility with CxImage
29-
* zlib: http://zlib.net
30-
* BugTrap: https://github.com/nitrocaster/BugTrap
22+
* Windows SDK
23+
* BugTrap: https://github.com/Xottab-DUTY/BugTrap
24+
* CryptoPP: https://github.com/weidai11/cryptopp
3125
* FreeImage: http://freeimage.sourceforge.net
32-
* FreeMagic
26+
* FreeMagic: https://github.com/OpenXRay/FreeMagic
27+
* GameSpy: https://github.com/nitrocaster/GameSpy
28+
* libjpeg: https://github.com/OpenXRay/libjpeg
29+
- Use "jpeg" as project root directory name for compatibility with CxImage
3330
* libogg-1.1.4: http://xiph.org/downloads
3431
* libtheora-1.1.1: http://xiph.org/downloads
3532
* libvorbis-1.2.3: http://xiph.org/downloads
36-
* Autodesk Maya 2008/2009 SDK
37-
* Autodesk 3DS Max 6.0 SDK
38-
* Windows SDK
39-
* DirectX SDK June 2010 (DOES NOT NEED ANYMORE ?): http://www.microsoft.com/en-us/download/details.aspx?id=6812
40-
- replace dxguid.lib with the one from Windows SDK
41-
(for DirectPlay GUIDs)
42-
XXX nitrocaster: add LuaJIT & LuaBind instructions
33+
* Lightwave: https://github.com/OpenXRay/LightWave
34+
* Luabind: https://github.com/Xottab-DUTY/luabind-deboostified
35+
* LuaJIT: https://github.com/Xottab-DUTY/LuaJIT
36+
* lzo: https://github.com/alexgdi/lzo
37+
* Autodesk Maya 2008/2009 SDK: https://github.com/OpenXRay/maya
38+
* Autodesk 3DS Max 6.0 SDK: https://github.com/OpenXRay/3dsmax
39+
* NVAPI: https://developer.nvidia.com/nvapi
40+
* OpenAutomate: https://developer.nvidia.com/openautomate
41+
* pugixml: https://github.com/zeux/pugixml/
42+
* zlib: http://zlib.net
43+
All mentioned libraries are already in repository as submodules!
4344

4445
Setup:
4546
------
4647
- Install S.T.A.L.K.E.R Call of Pripyat
4748
- Install patch 1.6.02 (only for russian locale, worldwide release should have it included):
4849
http://cop.stalker-game.ru/?page=patches#2
49-
- Download and unpack archive with libraries
50-
- Run xrbinprep.cmd to initialize new game binary directories and link default gamedata to OpenXRay's:
51-
$ xrbinprep.cmd "C:\Program Files (x86)\GSC World Publishing\S.T.A.L.K.E.R. - Call of Pripyat"
52-
Note that this script requires admin rights (in order to execute 'mklink'). Also make sure you pass a
53-
game installation directory to this script. Once done, you can find .xrbinup_xxx scripts in the reporitory root:
54-
use them later to install newly built binaries to the corresponding game binary directory.
50+
- Clone the repository (you should not download it as an archive)
51+
You can just push `Open in Desktop` if you are using Github Desktop.
52+
If you are using Git console, here's the command:
53+
`git clone https://github.com/OpenXRay/xray-16.git --recurse-submodules`
54+
- If you are using git client, make sure all submodules are initialized.
55+
Type this command in the Git console `git submodule update --init --recursive`
5556
- Now you can build the engine!
5657

5758
Debug/Run from Visual Studio:

0 commit comments

Comments
 (0)