Xash3D FWGS engine.

Alibek Omarov f5ccf093d6 scripts: waifulib: fix build with sanitizers on		3 years ago
.github/workflows	ci: try to create license file by ourselves	3 years ago
Documentation	Documentation: rework ports.md	3 years ago
common	engine: modify NetAPI to follow const qualifiers	3 years ago
contrib/mittorn	contrib: remove my personal qtcreator project, as I'm using compile_commands.json support now	5 years ago
engine	engine: fix build with tests on	3 years ago
game_launch	game_launch: add const to game var	3 years ago
mainui@d8e2adbc5b	mainui: update	3 years ago
pm_shared	Trim all trailing whitespace	4 years ago
public	engine: mathlib: added Q_equal macros	3 years ago
ref_gl	ref_gl: fixed GL_CheckForErrors doesn't print error message	3 years ago
ref_soft	ref_soft: fix pointer-to-int casts	3 years ago
scripts	scripts: waifulib: fix build with sanitizers on	3 years ago
utils/mdldec	utils: mdldec: fix of masked_solid texture flag	3 years ago
vgui-dev@93573075af	vgui-dev: update submodule	4 years ago
vgui_support	Trim all trailing whitespace	4 years ago
.cirrus.yml	ci: migrate to GitHub Actions	3 years ago
.editorconfig	editorconfig: initial add	5 years ago
.gitignore	engine: common: add quote symbol escaping support (#411 )	4 years ago
.gitmodules	Add gl4es submodule	4 years ago
.travis.yml	ci: migrate to GitHub Actions	3 years ago
CONTRIBUTING.md	readme: sligthly update contributing guidelines	5 years ago
README.md	readme: better wording	3 years ago
waf	waf: update	3 years ago
waf.bat	waf.bat: fix strange ERRORLEVEL bug	6 years ago
wscript	wscript: allow compiling with disabled warning-as-error	3 years ago

README.md

Xash3D FWGS Engine

Xash3D FWGS is a fork of Xash3D Engine by Unkle Mike with extended features and crossplatform.

Xash3D is a game engine, aimed to provide compatibility with Half-Life Engine, 
as well as to give game developers well known workflow and extend it.
Read more about Xash3D on ModDB: https://www.moddb.com/engines/xash3d-engine

Fork features

HLSDK 2.4 support.
Crossplatform: supported x86 and ARM on Windows/Linux/BSD/Android. (see docs for more info)
Modern compilers support: say no more to MSVC6.
Better multiplayer support: multiple master servers, headless dedicated server.
Mobility API: allows better game integration on mobile devices(vibration, touch controls)
Different input methods: touch, gamepad and classic mouse & keyboard.
TrueType font rendering, as a part of mainui_cpp.
Multiple renderers support: OpenGL, GLESv1, GLESv2, Software
A set of small improvements, without broken compatibility.

Planned fork features

Virtual Reality support and game API
Voice support
Vulkan renderer

Installation & Running

Get Xash3D binaries: you can use testing build or you can compile engine from source code. Choose proper build package depending on which platform you're using.
Copy engine binaries to some directory.
Copy valve directory from Half-Life to directory with engine binaries. Also if you're using Windows: you should copy vgui.dll library from Half-Life directory to Xash3D directory. As alternative, you can compile hlsdk-xash3d instead of using official Valve game binaries, but you still needed to copy valve directory as all game resources located in there.
Download extras.pak and place it to valve directory.
Run xash3d.exe/xash3d.sh/xash3d depending on which platform you're using.

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

Windows (Visual Studio)

Install Visual Studio.
Install latest Python OR run cinst python.install if you have Chocolatey.
Install latest Git OR run cinst git.install if 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

NOTE FOR USERS WITH X86 COMPATIBLE CPUs: 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!

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
Clone this repostory: $ git clone --recursive https://github.com/FWGS/xash3d-fwgs

Building

Windows (Visual Studio)

Open command line
Navigate to xash3d-fwgs directory.
Carefully examine which build options are available: waf --help
Configure build: waf configure -T release --sdl2=c:/path/to/SDL2 --prefix=c:/path/to/any/output/directory
Compile: waf build
Install: waf install

Linux

Examine which build options are available: ./waf --help
Configure build: ./waf configure -T release --prefix=/path/to/any/output/directory (You need to pass -8 to compile 64-bit engine on 64-bit x86 processor)
Compile: ./waf build
Install(optional): ./waf install