FWGS
/
xash3d-fwgs
mirror of https://github.com/FWGS/xash3d-fwgs
2
0
Fork 0
Code Issues 2 Projects Releases Wiki Activity

readme: better wording

This commit is contained in:
Alibek Omarov 2021-07-03 22:54:31 +03:00
parent dcf7ec2c3d
commit e00c20b288
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -27,12 +27,12 @@ Read more about Xash3D on ModDB: https://www.moddb.com/engines/xash3d-engine
* Vulkan renderer * Vulkan renderer
## Installation & Running ## Installation & Running
0) Download Xash3D binaries: you can use [testing](https://github.com/FWGS/xash3d-deploy/tree/anewengine-master) build, also you can compile engine from sources. 0) Get Xash3D binaries: you can use [testing](https://github.com/FWGS/xash3d-fwgs/releases/tag/continuous) build or you can compile engine from source code.
Choose proper build package depending on which platform you're using. Choose proper build package depending on which platform you're using.
1) Copy engine binaries to some directory. 1) Copy engine binaries to some directory.
2) Copy `valve` directory from [Half-Life](https://store.steampowered.com/app/70/HalfLife/) to mentioned above directory with engine binaries. 2) Copy `valve` directory from [Half-Life](https://store.steampowered.com/app/70/HalfLife/) to directory with engine binaries.
Also if you're using Windows: you should copy `vgui.dll` library from Half-Life directory to Xash3D directory. Also if you're using Windows: you should copy `vgui.dll` library from Half-Life directory to Xash3D directory.
But instead, you can compile [hlsdk-xash3d](https://github.com/FWGS/hlsdk-xash3d) yourself instead of using official Valve game binaries, but you still needed to copy `valve` directory because all resources like sounds/models/maps located in there. As alternative, you can compile [hlsdk-xash3d](https://github.com/FWGS/hlsdk-xash3d) instead of using official Valve game binaries, but you still needed to copy `valve` directory as all game resources located in there.
3) Download [extras.pak](https://github.com/FWGS/xash-extras/releases/tag/v0.19.2) and place it to `valve` directory. 3) Download [extras.pak](https://github.com/FWGS/xash-extras/releases/tag/v0.19.2) and place it to `valve` directory.
4) Run `xash3d.exe`/`xash3d.sh`/`xash3d` depending on which platform you're using. 4) Run `xash3d.exe`/`xash3d.sh`/`xash3d` depending on which platform you're using.
@ -46,9 +46,7 @@ For additional info, run Xash3D with `-help` command line key.
## Build instructions ## Build instructions
We are using Waf build system. If you have some Waf-related questions, I recommend you to read https://waf.io/book/ We are using Waf build system. If you have some Waf-related questions, I recommend you to read https://waf.io/book/
If you're stuck somewhere and you need a clear example, read `.travis.yml` and `scripts/build*.sh`. NOTE: NEVER USE GitHub's ZIP ARCHIVES. GitHub doesn't include external dependencies we're using!
NOTE: NEVER USE GitHub's ZIP ARCHIVES. They are broken and don't contain external dependencies sources we're using.
### Prerequisites ### Prerequisites
#### Windows (Visual Studio) #### Windows (Visual Studio)
@ -61,7 +59,7 @@ NOTE: NEVER USE GitHub's ZIP ARCHIVES. They are broken and don't contain externa
#### GNU/Linux #### GNU/Linux
NOTE FOR USERS WITH X86 COMPATIBLE CPUs: NOTE FOR USERS WITH X86 COMPATIBLE CPUs:
We have forced build system to throw an error, if you're trying to build 64-bit engine. This done for keeping compatibility with Steam releases of Half-Life and based on it's engine games. We have forced Waf to throw an error, if you're trying to build 64-bit engine. This was done for keeping compatibility with Steam releases of Half-Life and based on it's engine games.
Even if Xash3D FWGS does support targetting 64-bit, you can't load games without recompiling them from source code! Even if Xash3D FWGS does support targetting 64-bit, you can't load games without recompiling them from source code!
##### Debian/Ubuntu ##### Debian/Ubuntu
@ -88,7 +86,7 @@ Even if Xash3D FWGS does support targetting 64-bit, you can't load games without
#### Linux #### Linux
0) Examine which build options are available: `./waf --help` 0) Examine which build options are available: `./waf --help`
1) Configure build: `./waf configure -T release --prefix=/path/to/any/output/directory` 1) Configure build: `./waf configure -T release --prefix=/path/to/any/output/directory`
(To compile 64-bit engine on 64-bit x86 processor, you need to pass `-8` also) (You need to pass `-8` to compile 64-bit engine on 64-bit x86 processor)
2) Compile: `./waf build` 2) Compile: `./waf build`
3) Install(optional): `./waf install` 3) Install(optional): `./waf install`