FWGS/xash3d-fwgs
2
0
Fork 0
mirror of https://github.com/FWGS/xash3d-fwgs synced 2024-11-24 02:40:41 +01:00
Code Issues 2 Projects Releases Wiki Activity
3,474 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%
fe5944720b
Go to file
Alibek Omarov fe5944720b engine: use common strings to name the engine, makes branding easier for custom forks
2024-03-19 21:11:10 +03:00
.builds ci: enable builds.sr.ht 2024-01-23 20:42:09 +03:00
.github Create FUNDING.yml 2024-03-07 09:41:18 +03:00
3rdparty 3rdparty: gl4es: update 2024-02-26 11:20:04 +03:00
common filesystem: don't check for SDL whether we can load Android assets, because filesystem doesn't know anything about SDL 2024-03-11 23:25:10 +03:00
Documentation Documentation: extensions: add doc about native-object 2024-02-19 17:49:37 +03:00
engine engine: use common strings to name the engine, makes branding easier for custom forks 2024-03-19 21:11:10 +03:00
filesystem filesystem: minor logging opened archives change 2024-03-19 20:42:10 +03:00
game_launch wscript: move werror flags into uselib 2024-01-30 17:24:17 +03:00
pm_shared
public public: build: use XASH_BUILD_BRANCH define set by Waf. Expect XASH_BUILD_{BRANCH,COMMIT} to be always set. 2024-03-19 19:34:30 +03:00
ref ref: gl: invalidate texture units state cache when texture deletes 2024-03-09 22:12:35 +03:00
scripts waifulib/compiler_optimizations: disable no-semantic-interposition for gcc4 in release builds too 2024-02-27 04:16:14 +03:00
utils utils: mdldec: boneweights fix. 2024-03-01 20:26:18 +03:00
.cirrus.yml ci: disable freebsd-12 task 2024-01-04 22:15:08 +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 platform: android: port to SDL 2024-02-19 17:47:40 +03:00
.gitmodules 3rdparty: add xash-extras submodule 2022-09-11 01:38:17 +03:00
CONTRIBUTING.md
README.md readme: add sourcehut builds badge [skip ci] 2024-01-24 21:10:21 +03:00
waf waf: upgrade to waifu 1.2.0 2024-03-19 19:24:49 +03:00
waf.bat waf.bat: use unicode charset 2022-08-09 13:47:38 +03:00
wscript wscript: move gitversion load to libpublic, define XASH_BUILD_BRANCH, use unknown-{commit,branch} if detecting git version was failed 2024-03-19 19:30:52 +03:00

README.md

Xash3D FWGS Engine Xash3D FWGS icon

builds.sr.ht status GitHub Actions Status FreeBSD Build Status Discord Server
Download Stable Download Testing

Xash3D FWGS is a game engine, aimed to provide compatibility with Half-Life Engine and extend it, as well as to give game developers well known workflow.

Xash3D FWGS is a heavily modified fork of an original Xash3D Engine by Unkle Mike.

Donate

Donate to FWGS button
If you like Xash3D FWGS, consider supporting individual engine maintainers. By supporting us, you help to continue developing this game engine further. The sponsorship links are available in documentation.

Fork features

  • Steam Half-Life (HLSDK 2.4) support.
  • Crossplatform and modern compilers support: supports Windows, Linux, BSD & Android on x86 & ARM and many more.
  • Better multiplayer support: multiple master servers, headless dedicated server, voice chat and IPv6 support.
  • Multiple renderers support: OpenGL, GLESv1, GLESv2 and Software.
  • Advanced virtual filesystem: .pk3 and .pk3dir support, compatibility with GoldSrc FS module, fast case-insensitivity emulation for crossplatform.
  • Mobility API: better game integration on mobile devices (vibration, touch controls)
  • Different input methods: touch and gamepad in addition to mouse & keyboard.
  • TrueType font rendering, as a part of mainui_cpp.
  • External VGUI support module.
  • PNG & KTX2 image format support.
  • A set of small improvements, without broken compatibility.

Installation & Running

  1. Get Xash3D FWGS binaries: you can use testing build or you can compile engine from source code.
  2. Copy engine binaries to some directory.
  3. Copy valve directory from Half-Life to directory with engine binaries. If your CPU is NOT x86 compatible or you're running 64-bit version of the engine, you may want to compile Half-Life SDK. This repository contains our fork of HLSDK and restored source code for some of the mods. Not all of them, of course. You still needed to copy valve directory as all game resources located there.
  4. Run the main executable (xash3d.exe or AppImage).

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

If your CPU is x86 compatible, we are building 32-bit code by default. This was done to maintain 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!

If your CPU is NOT x86 compatible or you decided build 64-bit version of engine, you may want to compile Half-Life SDK. This repository contains our fork of HLSDK and restored source code for some of the mods. Not all of them, of course.

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

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
  5. Compile: waf build
  6. Install: waf install --destdir=c:/path/to/any/output/directory

Linux

If compiling 32-bit on amd64, you may need to supply export PKG_CONFIG_PATH=/usr/lib/i386-linux-gnu/pkgconfig prior to running configure.

  1. Examine which build options are available: ./waf --help
  2. Configure build: ./waf configure -T release (You need to pass -8 to compile 64-bit engine on 64-bit x86 processor)
  3. Compile: ./waf build
  4. Install(optional): ./waf install --destdir=/path/to/any/output/directory