YGGverse
/
xash3d-fwgs
mirror of https://github.com/YGGverse/xash3d-fwgs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Xash3D FWGS engine.
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.
986 Commits
6 Branches
2 Tags
16 MiB
 
 
 
 
Tree: 9421457b3a
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '9421457b3a'
${ noResults }
Alibek Omarov 9421457b3a
engine: big refactoring commit, instead of using platform-specific platform-specific macros, use appropriate macros set by public/build.h 		5 years ago
Documentation Documentation: engine-porting-guide: finalize document 5 years ago
common engine: big refactoring commit, instead of using platform-specific platform-specific macros, use appropriate macros set by public/build.h 5 years ago
contrib contrib: generate me an IDE project instead of updating it manually everytime 6 years ago
engine engine: big refactoring commit, instead of using platform-specific platform-specific macros, use appropriate macros set by public/build.h 5 years ago
game_launch Revert "game_launch: check for Platform_Main before Host_Main" 5 years ago
mainui@1b8a12389b mainui: update 5 years ago
pm_shared xash3d-fwgs: append missing new line at the end of file 5 years ago
public build: add XASH_ARMvX defines(buildsystem integration), add oneliner to generate #undef list 5 years ago
ref_gl engine: big refactoring commit, instead of using platform-specific platform-specific macros, use appropriate macros set by public/build.h 5 years ago
scripts scripts: build_motomagx_engine: use waf install now, as HLSDK now supports library naming scheme 5 years ago
vgui-dev@f5566261bd readme: add note for debian/ubuntu prerequisites, add vgui-dev as submodule, update mainui 6 years ago
vgui_support wscript: refactoring, add waf_unit_test, disable -Wdouble-promotion, rename fast as fastnative and leave fast without -march=native for x-compiling 5 years ago
.cirrus.yml ci: disable dedicated build for freebsd at now 5 years ago
.editorconfig editorconfig: initial add 6 years ago
.gitignore scripts: enable deploying vc2008 project 6 years ago
.gitmodules readme: add note for debian/ubuntu prerequisites, add vgui-dev as submodule, update mainui 6 years ago
.travis.yml travis: fix magx deploy 5 years ago
CONTRIBUTING.md readme: sligthly update contributing guidelines 5 years ago
README.md readme: wording 5 years ago
waf waf: third msvc test 5 years ago
waf.bat waf.bat: fix strange ERRORLEVEL bug 6 years ago
wscript wscript: tune-up options for magx 5 years ago

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-master

Fork features

  • HLSDK 2.4 support.
  • Crossplatform: officially supported x86 and ARM on Windows/Linux/BSD/Android. (see Documentation/ports.md 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, GLES, Software)
  • A set of small improvements, without broken compatibility.

Planned fork features

  • Virtual Reality support and game API
  • Voice support
  • Vulkan renderer

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.
  • 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

ArchLinux

  • ArchLinux users are lucky enough and there is a xash3d-git AUR package for them.

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

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.