FWGS
/
xash3d-fwgs
mirror of https://github.com/FWGS/xash3d-fwgs
2
0
Fork 0
Code Issues 2 Projects Releases Wiki Activity
543 Commits 30 Branches 36 Tags 19 MiB
C 97.1%
Python 1.8%
C++ 0.7%
Shell 0.4%
Go to file
Alibek Omarov 74062fab12
waf.bat: fix strange ERRORLEVEL bug 		2019-05-23 22:28:35 +03:00
common port.h: temporarily disable hardfp postfix 2019-05-12 03:00:50 +03:00
contrib update my Qt Creator project 2018-10-27 23:28:29 +03:00
engine ref_api: remove GL_OnContextCreated, remove return value of GL_RenderFrame 2019-05-12 18:02:59 +03:00
game_launch wscript: move build env setup to main wscript 2019-03-25 01:25:44 +03:00
mainui@ec653a40ba engine: fix long<->int conversion UBs 2019-05-02 19:05:09 +03:00
pm_shared Legacy protocol compatibility (cl_legacymode) 2019-01-25 20:54:05 +07:00
public wscript: Add shared lib flags to public 2019-04-17 06:42:34 +07:00
ref_gl ref_gl: fix msvc build 2019-05-23 22:10:35 +03:00
scripts travis: windows: die if waf has failed 2019-05-23 22:13:00 +03:00
vgui_support vgui_support: remove miniutl submodule 2019-04-11 01:51:54 +03:00
.gitignore scripts: enable deploying vc2008 project 2019-04-08 21:09:21 +03:00
.gitmodules vgui_support: remove utl dependency, by porting new vgui support code from original engine, remove dead function definitions, remove dead vgui_main.h header from engine 2019-04-11 01:12:52 +03:00
.travis.yml travis: comment mingw build until it's not stable 2019-05-23 22:01:06 +03:00
CONTRIBUTING.md readme: add missed newlines 2019-02-24 01:11:23 +03:00
README.md readme: fix links 2019-02-24 05:47:57 +07:00
waf waf: update 2018-10-08 22:39:33 +03:00
waf.bat waf.bat: fix strange ERRORLEVEL bug 2019-05-23 22:28:35 +03:00
wscript wscript: error on return-type, some android related changes 2019-05-12 03:03:34 +03:00

README.md

Xash3D FWGS Engine

Build Status Discord Server

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

Latest release build: https://github.com/FWGS/xash3d-fwgs/releases/latest

Latest development build: https://github.com/FWGS/xash3d-deploy/tree/newengine-latest

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 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.
  • A set of small improvements, without broken compatibility.

Planned fork features

  • Virtual Reality support and game API(in development!)
  • 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/

If you're stuck somewhere and you need a clear example, read .travis.yml and scripts/build*.sh.

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.
  • Clone vgui-dev repository: git clone https://github.com/FWGS/vgui-dev.
  • 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.

Linux

NOTE: Make sure you're OK with targetting 32-bit.

Even if Xash3D FWGS does support targetting 64-bit, you can't load games without recompiling them from source code!

  • Gentoo: TODO
  • Debian: TODO
  • ArchLinux: <AUR Helper> -S xash3d-git

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 --build-type=release --sdl2=c:/path/to/SDL2 --vgui=c:/path/to/vgui-dev --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 --build-type=release --vgui=vgui-dev
  3. Compile: ./waf build
  4. 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.