Alibek Omarov
ac46164a6e
|
||
|---|---|---|
| .builds | ||
| .github | ||
| 3rdparty | ||
| Documentation | ||
| common | ||
| engine | ||
| filesystem | ||
| game_launch | ||
| pm_shared | ||
| public | ||
| ref | ||
| scripts | ||
| utils | ||
| .cirrus.yml | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| CONTRIBUTING.md | ||
| README.md | ||
| waf | ||
| waf.bat | ||
| wscript | ||
README.md
Xash3D FWGS Engine 
Xash3D FWGS is a game engine, aimed to provide compatibility with Half-Life Engine and extend it, as well as to give game developers well known workflow.
Xash3D FWGS is a heavily modified fork of an original Xash3D Engine by Unkle Mike.
Donate
If you like Xash3D FWGS, consider supporting individual engine maintainers. By supporting us, you help to continue developing this game engine further. The sponsorship links are available in documentation.
Fork features
- Steam Half-Life (HLSDK 2.4) support.
- Crossplatform and modern compilers support: supports Windows, Linux, BSD & Android on x86 & ARM and many more.
- Better multiplayer support: multiple master servers, headless dedicated server, voice chat and IPv6 support.
- Multiple renderers support: OpenGL, GLESv1, GLESv2 and Software.
- Advanced virtual filesystem:
.pk3and.pk3dirsupport, compatibility with GoldSrc FS module, fast case-insensitivity emulation for crossplatform. - Mobility API: better game integration on mobile devices (vibration, touch controls)
- Different input methods: touch and gamepad in addition to mouse & keyboard.
- TrueType font rendering, as a part of mainui_cpp.
- External VGUI support module.
- PNG & KTX2 image format support.
- A set of small improvements, without broken compatibility.
Installation & Running
- Get Xash3D FWGS binaries: you can use testing build or you can compile engine from source code.
- Copy engine binaries to some directory.
- Copy
valvedirectory from Half-Life to directory with engine binaries. If your CPU is NOT x86 compatible or you're running 64-bit version of the engine, you may want to compile Half-Life SDK. This repository contains our fork of HLSDK and restored source code for some of the mods. Not all of them, of course. You still needed to copyvalvedirectory as all game resources located there. - Run the main executable (
xash3d.exeor AppImage).
For additional info, run Xash3D with -help command line key.
Contributing
- Before sending an issue, check if someone already reported your issue. Make sure you're following "How To Ask Questions The Smart Way" guide by Eric Steven Raymond. Read more: http://www.catb.org/~esr/faqs/smart-questions.html
- Issues are accepted in both English and Russian
- Before sending a PR, check if you followed our contribution guide in CONTRIBUTING.md file.
Build instructions
We are using Waf build system. If you have some Waf-related questions, I recommend you to read https://waf.io/book/
NOTE: NEVER USE GitHub's ZIP ARCHIVES. GitHub doesn't include external dependencies we're using!
Prerequisites
If your CPU is x86 compatible, we are building 32-bit code by default. This was done to maintain 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!
If your CPU is NOT x86 compatible or you decided build 64-bit version of engine, you may want to compile Half-Life SDK. This repository contains our fork of HLSDK and restored source code for some of the mods. Not all of them, of course.
Windows (Visual Studio)
- Install Visual Studio.
- Install latest Python OR run
cinst python.installif you have Chocolatey. - Install latest Git OR run
cinst git.installif you have Chocolatey. - Download SDL2 development package for Visual Studio.
- Clone this repository:
git clone --recursive https://github.com/FWGS/xash3d-fwgs. - Make sure you have at least 12GB of free space to store all build-time dependencies: ~10GB for Visual Studio, 300 MB for Git, 100 MB for Python and other.
GNU/Linux
Debian/Ubuntu
- Enable i386 on your system, if you're compiling 32-bit engine on amd64. If not, skip this
$ sudo dpkg --add-architecture i386
- Install development tools
- For 32-bit engine on amd64:
$ sudo apt install build-essential gcc-multilib g++-multilib python libsdl2-dev:i386 libfontconfig-dev:i386 libfreetype6-dev:i386 - For everything else:
$ sudo apt install build-essential python libsdl2-dev libfontconfig-dev libfreetype6-dev
- For 32-bit engine on amd64:
- Clone this repostory:
$ git clone --recursive https://github.com/FWGS/xash3d-fwgs
Building
Windows (Visual Studio)
- Open command line
- Navigate to
xash3d-fwgsdirectory. - Carefully examine which build options are available:
waf --help - Configure build:
waf configure -T release --sdl2=c:/path/to/SDL2 - Compile:
waf build - Install:
waf install --destdir=c:/path/to/any/output/directory
Linux
If compiling 32-bit on amd64, you may need to supply export PKG_CONFIG_PATH=/usr/lib/i386-linux-gnu/pkgconfig prior to running configure.
- Examine which build options are available:
./waf --help - Configure build:
./waf configure -T release(You need to pass-8to compile 64-bit engine on 64-bit x86 processor) - Compile:
./waf build - Install(optional):
./waf install --destdir=/path/to/any/output/directory