Go to file
Alibek Omarov 955dde6d5f Create README.md 2019-02-23 13:46:16 +03:00
common Merge 4344 update 2018-12-30 01:51:02 +03:00
contrib update my Qt Creator project 2018-10-27 23:28:29 +03:00
engine wscript: check for dedicated or singlebinary before recurse into subdirectory, add a chance to skip some subprojects on configuration stage 2019-02-19 17:49:09 +03:00
game_launch wscript: check for dedicated or singlebinary before recurse into subdirectory, add a chance to skip some subprojects on configuration stage 2019-02-19 17:49:09 +03:00
mainui@9acf8b75d9 wscript: check for dedicated or singlebinary before recurse into subdirectory, add a chance to skip some subprojects on configuration stage 2019-02-19 17:49:09 +03:00
pm_shared Legacy protocol compatibility (cl_legacymode) 2019-01-25 20:54:05 +07:00
scripts Try fix mingw linking 2019-02-23 18:32:49 +07:00
vgui_support wscript: remove useless option type specifier 2019-02-19 17:55:45 +03:00
.gitignore gitignore: allow waflib directory, hide pyc and pycache 2018-12-13 07:48:51 +03:00
.gitmodules vgui_support: switch to free miniutl 2019-01-26 14:31:02 +03:00
.travis.yml travis: add mingw build deployment 2018-12-12 04:50:24 +03:00
README.md Create README.md 2019-02-23 13:46:16 +03:00
waf waf: update 2018-10-08 22:39:33 +03:00
waf.bat Add waf itself(with included wurf and msvs.py) and waf.bat launcher for Windows 2018-06-14 21:23:38 +03:00
wscript wscript: remove useless option type specifier 2019-02-19 17:55:45 +03:00

README.md

Xash3D FWGS Engine

Xash3D FWGS is a fork of Xash3D Engine by Unkle Mike.

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: officially supported x86 and ARM on Windows/Linux/BSD/macOS/Android/iOS/Haiku.
  • Modern compilers support, say no more to VC6.
  • Better multiplayer support: multiple master servers, headless dedicated server.
  • Mobility API, which 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.
  • A set of small improvements, without broken compatibility.

Planned fork features

  • Voice support
  • Multiple renderers support(OpenGL, GLES, Vulkan, software)

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
  • Before sending a PR, check if you followed our coding guide in CODING_STYLE.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/

  1. Clone this repository: git clone --recursive https://github.com/FWGS/xash3d-fwgs
  2. Examine which build options are available: waf --help
  3. Configure build: waf configure
  4. Compile: waf build
  5. Install(optional): waf install

Running

  1. Copy libraries and main executable somewhere, if you're skipped installation stage.
  2. Copy game files to same directory
  3. Run xash3d.exe/xash3d.sh/xash3d depending on which platform you're using.

For additional info, run Xash3D with -help command line key.