FWGS/xash3d-fwgs
2
0
Fork 0
mirror of https://github.com/FWGS/xash3d-fwgs synced 2024-12-28 03:35:19 +01:00
Code Issues 2 Projects Releases Wiki Activity
1,515 Commits 25 Branches 52 Tags 30 MiB
C 95.5%
Python 1.8%
C++ 0.8%
Java 0.7%
Kotlin 0.6%
Other 0.5%
ed7ed818bb
Go to file
Alibek Omarov ed7ed818bb Add .gitattributes to enforce Git write normal human file endings and show pretty diffs for C and Python
2021-10-02 03:47:32 +03:00
.github/workflows Revert "ci: adding pvs-studio checking" 2021-09-30 16:38:32 +03:00
common engine: modify NetAPI to follow const qualifiers 2021-07-20 16:10:32 +03:00
contrib/mittorn contrib: remove my personal qtcreator project, as I'm using compile_commands.json support now 2019-11-28 19:21:53 +03:00
Documentation Documentation: rework ports.md 2021-06-15 19:00:12 +03:00
engine engine: client: fix paused icon drawn when levelshots are disabled 2021-09-30 16:43:21 +03:00
game_launch game_launch: add const to game var 2021-06-07 19:39:52 +03:00
mainui@d8e2adbc5b mainui: update 2021-08-27 18:23:38 +03:00
pm_shared Trim all trailing whitespace 2021-01-04 20:55:10 +03:00
public engine: mathlib: added Q_equal macros 2021-07-09 14:57:49 +03:00
ref_gl ref_gl: fixed GL_CheckForErrors doesn't print error message 2021-08-01 22:28:24 +03:00
ref_soft ref_soft: fix pointer-to-int casts 2021-07-20 16:03:35 +03:00
scripts scripts: waifulib: fix build with sanitizers on 2021-09-30 15:58:50 +03:00
utils/mdldec utils: mdldec: fix of masked_solid texture flag 2021-07-29 13:17:38 +03:00
vgui_support Trim all trailing whitespace 2021-01-04 20:55:10 +03:00
vgui-dev@93573075af vgui-dev: update submodule 2021-01-08 07:42:57 +03:00
.cirrus.yml ci: migrate to GitHub Actions 2021-07-03 20:21:09 +03:00
.editorconfig
.gitattributes Add .gitattributes to enforce Git write normal human file endings and show pretty diffs for C and Python 2021-10-02 03:47:32 +03:00
.gitignore engine: common: add quote symbol escaping support (#411) 2021-04-04 22:03:02 +03:00
.gitmodules Add gl4es submodule 2020-12-28 16:11:04 +03:00
.travis.yml ci: migrate to GitHub Actions 2021-07-03 20:21:09 +03:00
CONTRIBUTING.md readme: sligthly update contributing guidelines 2019-10-06 03:49:46 +03:00
README.md readme: better wording 2021-07-03 22:54:31 +03:00
waf waf: update 2021-06-14 21:14:22 +03:00
waf.bat
wscript wscript: allow compiling with disabled warning-as-error 2021-09-06 00:04:27 +03:00

README.md

Xash3D FWGS Engine

GitHub Actions Status Travis CI 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. Get Xash3D binaries: you can use testing build or you can compile engine from source code. 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 directory with engine binaries. Also if you're using Windows: you should copy vgui.dll library from Half-Life directory to Xash3D directory. As alternative, you can compile hlsdk-xash3d instead of using official Valve game binaries, but you still needed to copy valve directory as all game resources 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/

NOTE: NEVER USE GitHub's ZIP ARCHIVES. GitHub doesn't include external dependencies 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 Waf to throw an error, if you're trying to build 64-bit engine. This was 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 (You need to pass -8 to compile 64-bit engine on 64-bit x86 processor)
  3. Compile: ./waf build
  4. Install(optional): ./waf install