FWGS/xash3d-fwgs
2
0
Fork 0
mirror of https://github.com/FWGS/xash3d-fwgs synced 2024-11-21 17:37:32 +01:00
Code Issues 2 Projects Releases Wiki Activity
2,696 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%
new_vgui_support_api
Go to file
Alibek Omarov fa90a4aaa2 Documentation: add doc explaining VGUI2 support status, and how to enable it
2023-05-02 08:55:03 +03:00
.github/workflows github: attempt to avoid release draft issue by sleeping for 20s 2023-04-19 16:32:21 +03:00
3rdparty 3rdparty: vgui_support: update submodule 2023-05-02 08:55:03 +03:00
common engine: simplify XASH_USE_EVDEV macro usage by giving it's defined positive value 2023-03-27 17:28:19 +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: add doc explaining VGUI2 support status, and how to enable it 2023-05-02 08:55:03 +03:00
engine engine: client: vgui: add funcs for VGUI2 support to the new API, change VGui_Startup to include VGUI2 initialization 2023-05-02 08:55:03 +03:00
filesystem filesystem: add new export FS_GetFullDiskPath, similar to FS_GetDiskPath, but generates full path to the file, including searchpath 2023-05-02 08:52:54 +03:00
game_launch game_launch: add icons that were used for Android port 2023-04-30 00:56:28 +03:00
pm_shared Trim all trailing whitespace 2021-01-04 20:55:10 +03:00
public public: move FOV calculating functions out of libpublic, as they are very specific to engine view 2023-04-26 05:22:34 +03:00
ref engine: client: implement v_dark in engine, instead of making it ref-specific 2023-04-28 16:52:22 +03:00
scripts scripts: gha: set --disable-werror for building HLSDK 2023-04-25 13:10:12 +03:00
utils utils: mdldec: add size argument to COM_FileBase calls 2023-04-26 05:20:45 +03:00
.cirrus.yml ci: upgrade freebsd tasks 2022-06-03 19:53:58 +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 gitignore: add enc_temp_folder by the request of @SNMetamorph 2022-08-19 22:18:22 +03:00
.gitmodules 3rdparty: add xash-extras submodule 2022-09-11 01:38:17 +03:00
CONTRIBUTING.md
README.md readme: update. 2022-11-05 10:45:47 +06:00
waf waifu: upgrade to latest revision 2023-04-13 18:43:08 +03:00
waf.bat waf.bat: use unicode charset 2022-08-09 13:47:38 +03:00
wscript Revert "wscript: check malloc.h first to make checks on Windows slightly faster" 2023-04-25 12:39:47 +03:00

README.md

Xash3D FWGS Engine

GitHub Actions 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.
  • Voice support.
  • External filesystem module like in GoldSrc engine.
  • External vgui support module.
  • PNG image format support.
  • A set of small improvements, without broken compatibility.

Planned fork features

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

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