You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Velaron 4f31d7504a ref_api: fix remap info allocation (fixes #200) 1 week ago
.github/workflows codeql: try to fix analysis tool 5 months ago
Documentation Documentation: opensource-mods.md: add "Year of the Dragon" and "Overturn". (#375) 2 months ago
common common: remove double defines 2 months ago
contrib/mittorn contrib: remove my personal qtcreator project, as I'm using compile_commands.json support now 1 year ago
engine ref_api: fix remap info allocation (fixes #200) 1 week ago
game_launch game_launch: Add a --disable-menu-changegame build option 4 months ago
mainui@d9e5b5ba14 mainui: update 2 months ago
pm_shared Trim all trailing whitespace 4 months ago
public public: oops, fix broken crtlib 2 months ago
ref_gl ref_api: fix remap info allocation (fixes #200) 1 week ago
ref_soft ref_api: fix remap info allocation (fixes #200) 1 week ago
scripts wscript: added support for "Edit and Continue" MSVC feature 2 weeks ago
utils/mdldec mdldec: build with CONSOLE subsystem on Win32 2 months ago
vgui-dev@93573075af vgui-dev: update submodule 4 months ago
vgui_support Trim all trailing whitespace 4 months ago
.cirrus.yml cirrus: fix freebsd 12 image 2 months ago
.clang-format .clang-format: SpaceBeforeParens: Never 4 months ago
.editorconfig editorconfig: initial add 2 years ago
.gitignore engine: common: add quote symbol escaping support (#411) 1 month ago
.gitmodules Add gl4es submodule 4 months ago
.travis.yml travis: rename win32 build to xash3d-win32-vc.7z 2 months ago
CONTRIBUTING.md readme: sligthly update contributing guidelines 2 years ago
README.md readme: clarify issue languages 2 months ago
waf waf: upgrade to waifu 1.1.0 2 months ago
waf.bat waf.bat: fix strange ERRORLEVEL bug 2 years ago
wscript wscript: try to fix tgmath detection on freebsd 2 months ago

README.md

Xash3D FWGS Engine

Build Status FreeBSD Build Status Discord Server
Download Stable Download Testing

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

  1. Download Xash3D binaries: you can use testing build, also you can compile engine from sources. Choose proper build package depending on which platform you're using.
  2. Copy engine binaries to some directory.
  3. Copy valve directory from Half-Life to mentioned above directory with engine binaries. 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 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.
  4. Download extras.pak and place it to valve directory.
  5. 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/

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. They are broken and don't contain external dependencies sources 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 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. 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)

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

Linux

  1. Examine which build options are available: ./waf --help
  2. 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)
  3. Compile: ./waf build
  4. Install(optional): ./waf install