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.
601 Commits
6 Branches
2 Tags
16 MiB
 
 
 
 
Tree: 4eee187f1b
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '4eee187f1b'
${ noResults }
Night Owl 4eee187f1b
engine: common: imagelib: add simple decoder/encoder for 8-bit RGB/RGBA PNG images. 		5 years ago
common engine: port: disable ARCH_SUFFIX set to "64" for 64-bit platforms, it would replaced with new library naming scheme in near future 6 years ago
contrib contrib: generate me an IDE project instead of updating it manually everytime 6 years ago
engine engine: common: imagelib: add simple decoder/encoder for 8-bit RGB/RGBA PNG images. 5 years ago
game_launch wscript: move build env setup to main wscript 6 years ago
mainui@e36175ae03 waf: update to 2.0.17, rename module dir to waifulib, remove some modules, as they moved to waf binary itself(see waifu project) 6 years ago
pm_shared Legacy protocol compatibility (cl_legacymode) 6 years ago
public public: crclib now is part of public library 6 years ago
ref_gl ref: remove COM_HashKey API call 6 years ago
scripts appimage: fix AppRun shell-script POSIX compatibility 6 years ago
vgui_support vgui_support: remove miniutl submodule 6 years ago
.editorconfig editorconfig: initial add 6 years ago
.gitignore scripts: enable deploying vc2008 project 6 years ago
.gitmodules Add gl-wes-v2 and nanogl submodules 6 years ago
.travis.yml travis: comment mingw build until it's not stable 6 years ago
CONTRIBUTING.md readme: add missed newlines 6 years ago
README.md readme: fix url to development builds 6 years ago
waf waf: update 6 years ago
waf.bat waf.bat: fix strange ERRORLEVEL bug 6 years ago
wscript wscript: disable thread-safe local static initialization for C++11 code, as it cause crashes on Windows XP 6 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/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.
  • 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.
  • 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.