FWGS/xash3d-fwgs
2
0
Fork 0
mirror of https://github.com/FWGS/xash3d-fwgs synced 2024-11-22 09:56:22 +01:00
Code Issues 2 Projects Releases Wiki Activity
982 Commits 25 Branches 50 Tags 30 MiB
C 95.5%
Python 1.8%
C++ 0.8%
Java 0.7%
Kotlin 0.6%
Other 0.5%
2e180d5548
Go to file
Alibek Omarov 2e180d5548 Documentation: engine-porting-guide: finalize document
2019-11-24 02:31:48 +03:00
common Merge sdl12-port into master 2019-11-06 22:29:04 +03:00
contrib contrib: generate me an IDE project instead of updating it manually everytime 2019-06-06 04:02:06 +03:00
Documentation Documentation: engine-porting-guide: finalize document 2019-11-24 02:31:48 +03:00
engine engine: fix rodir, now it always creates gamefolder in rwdir. Fixes #87 2019-11-24 02:12:17 +03:00
game_launch Revert "game_launch: check for Platform_Main before Host_Main" 2019-11-07 05:06:51 +03:00
mainui@1b8a12389b mainui: update 2019-11-24 02:12:27 +03:00
pm_shared xash3d-fwgs: append missing new line at the end of file 2019-11-02 08:56:07 +03:00
public build: add XASH_ARMvX defines(buildsystem integration), add oneliner to generate #undef list 2019-11-11 00:38:40 +03:00
ref_gl ref_gl: temporarily fix water drawing on GLES 2019-11-17 18:51:39 +03:00
scripts scripts: build_motomagx_engine: use waf install now, as HLSDK now supports library naming scheme 2019-11-11 04:14:18 +03:00
vgui_support wscript: refactoring, add waf_unit_test, disable -Wdouble-promotion, rename fast as fastnative and leave fast without -march=native for x-compiling 2019-11-05 01:01:33 +03:00
vgui-dev@f5566261bd readme: add note for debian/ubuntu prerequisites, add vgui-dev as submodule, update mainui 2019-06-17 09:04:39 +03:00
.cirrus.yml ci: disable dedicated build for freebsd at now 2019-10-18 07:36:03 +03:00
.editorconfig editorconfig: initial add 2019-06-11 03:07:02 +03:00
.gitignore scripts: enable deploying vc2008 project 2019-04-08 21:09:21 +03:00
.gitmodules readme: add note for debian/ubuntu prerequisites, add vgui-dev as submodule, update mainui 2019-06-17 09:04:39 +03:00
.travis.yml travis: fix magx deploy 2019-11-07 08:41:10 +03:00
CONTRIBUTING.md readme: sligthly update contributing guidelines 2019-10-06 03:49:46 +03:00
README.md readme: wording 2019-07-07 02:46:16 +03:00
waf waf: third msvc test 2019-11-07 07:19:08 +03:00
waf.bat waf.bat: fix strange ERRORLEVEL bug 2019-05-23 22:28:35 +03:00
wscript wscript: tune-up options for magx 2019-11-07 06:56:07 +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-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.