From fb87d7c0b3fcab2365ea82ebb949c7285164b0d6 Mon Sep 17 00:00:00 2001 From: Alibek Omarov Date: Sat, 28 Oct 2023 09:58:09 +0300 Subject: [PATCH] readme: wording, add icon, add donate.md link [skip ci] --- README.md | 42 ++++++++++++++++++------------------------ 1 file changed, 18 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index fe9464d2..4b44723e 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,27 @@ -# Xash3D FWGS Engine +# Xash3D FWGS Engine Xash3D FWGS icon [![GitHub Actions Status](https://github.com/FWGS/xash3d-fwgs/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/FWGS/xash3d-fwgs/actions/workflows/c-cpp.yml) [![FreeBSD Build Status](https://img.shields.io/cirrus/github/FWGS/xash3d-fwgs?label=freebsd%20build)](https://cirrus-ci.com/github/FWGS/xash3d-fwgs) [![Discord Server](https://img.shields.io/discord/355697768582610945.svg)](http://fwgsdiscord.mentality.rip/) \ -[![Download Stable](https://img.shields.io/badge/download-stable-yellow)](https://github.com/FWGS/xash3d-fwgs/releases/latest) [![Download Testing](https://img.shields.io/badge/downloads-testing-orange)](https://github.com/FWGS/xash3d-fwgs/releases/tag/continuous) +[![Download Stable](https://img.shields.io/badge/download-stable-yellow)](https://github.com/FWGS/xash3d-fwgs/releases/latest) [![Download Testing](https://img.shields.io/badge/downloads-testing-orange)](https://github.com/FWGS/xash3d-fwgs/releases/tag/continuous) -Xash3D FWGS is a fork of Xash3D Engine by Unkle Mike with extended features and crossplatform. +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 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 -``` +Xash3D FWGS is a heavily modified fork of an original [Xash3D Engine](https://www.moddb.com/engines/xash3d-engine) by Unkle Mike. + +## Donate +[![Donate to FWGS button](https://img.shields.io/badge/Donate_to_FWGS-%3C3-magenta)](Documentation/donate.md) \ +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](Documentation/donate.md). ## Fork features -* HLSDK 2.4 support. -* Crossplatform: supported x86 and ARM on Windows/Linux/BSD/Android. ([see docs for more info](Documentation/ports.md)) -* 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. +* Steam Half-Life (HLSDK 2.4) support. +* Crossplatform and modern compilers support: supports Windows, Linux, BSD & Android on x86 & ARM and [many more](Documentation/ports.md). +* 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. -* 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. +* External VGUI support module. +* PNG & KTX2 image format support. +* [A set of small improvements](Documentation/), without broken compatibility. ## Installation & Running 0) Get Xash3D FWGS binaries: you can use [testing](https://github.com/FWGS/xash3d-fwgs/releases/tag/continuous) build or you can compile engine from source code.