Big endian support for BSP loader

.github/workflows/c-cpp.yml

@@ -13,6 +13,8 @@ jobs:
       fail-fast: false
       matrix:
         include:
+          # Linux build specifically want oldest Ubuntu as possible
+          # to be crossdistribution compatible, otherwise use ubuntu-latest
           - os: ubuntu-20.04
             targetos: linux
             targetarch: amd64
@@ -34,10 +36,10 @@ jobs:
 #            targetos: motomagx
 #            targetarch: armv6
 
-          - os: ubuntu-20.04
+          - os: ubuntu-latest
             targetos: nswitch
             targetarch: arm64
-          - os: ubuntu-20.04
+          - os: ubuntu-latest
             targetos: psvita
             targetarch: armv7hf
           - os: windows-latest
@@ -47,7 +49,7 @@ jobs:
             targetos: win32
             targetarch: i386
     env:
-      SDL_VERSION: 2.26.2
+      SDL_VERSION: 2.28.1
       GH_CPU_ARCH: ${{ matrix.targetarch }}
       ANDROID_SDK_TOOLS_VER: 4333796
     steps:
@@ -80,7 +82,7 @@ jobs:
       with:
         submodules: recursive
     - name: Build flatpak (Compat.i386)
-      uses: FWGS/flatpak-github-actions/flatpak-builder@v5
+      uses: FWGS/flatpak-github-actions/flatpak-builder@v6.1
       with:
         bundle: ${{ matrix.app }}.flatpak
         manifest-path: scripts/flatpak/${{ matrix.app }}.yml

.gitignore

@@ -60,6 +60,7 @@ Makefile.dep
 ALL_BUILD.*
 INSTALL.*
 ZERO_CHECK.*
+CMakeLists.txt
 
 # Visual Studio
 *.obj
@@ -333,3 +334,6 @@ __pycache__
 .history/*
 .cache/*
 enc_temp_folder/
+
+# KDevelop4
+*.kdev4

Documentation/gameinfo.md

@@ -0,0 +1,112 @@
+# Game definition and information file
+
+gameinfo.txt is an essential part of any Xash3D based game. It allows basic customization for games creators, like setting game title, DLL paths, etc.
+
+This document defines gameinfo.txt syntax, supported keys and liblist.gam conversion rules for the latest version of the engine. Note for engine developers, keep this document in sync with an implementation.
+
+## gameinfo.txt syntax
+
+* gameinfo.txt is a simple list of keys and values, separated by newline.
+* You can add single line comments using double slashes (//).
+* Keys can accept integer, float, string or boolean values.
+* Boolean keys use 0 as false and 1 as true value.
+* To have spaces in string values, you must enclose them in double quotes. Then, to have double quotes, you must escape it with backslash, and to have a backslash you need to use double backslashes.
+
+The example:
+```
+// this is a comment :)
+// this is another comment
+some_integer_key 123
+
+this_is_float_key 13.37 // optional comment
+
+enable_feature 1 // boolean, 1 to enable, 0 to disable
+
+example_string_key string_value
+example_spaces "string with spaces"
+example_title "Fate\\Stay Night" // engine will parse it as Fate\Stay Night
+```
+
+## gameinfo.txt keys
+
+This is a list of all gameinfo.txt keys supported by the engine. Be aware that the engine will silently skip all unrecognized keys.
+
+| Key              | Type       | Default value   | Description |
+| ---------------- | ---------- | --------------- | ----------- |
+| `ambient0`       | string     | Empty string    | Automatic ambient sound |
+| `ambient1`       | string     | Empty string    | Automatic ambient sound |
+| `ambient2`       | string     | Empty string    | Automatic ambient sound |
+| `ambient3`       | string     | Empty string    | Automatic ambient sound |
+| `basedir`        | string     | `valve`         | Game base directory, used to share assets between games |
+| `date`           | string     | Empty string    | Game release date. Unused. |
+| `dllpath`        | string     | `cl_dlls`       | Game DLL path. Engine will search custom DLLs (client or menu, for example) in this directory, except `gamedll`, see below. |
+| `fallback_dir`   | string     | Empty string    | Additional game base directory |
+| `gamedir`        | string     | Current gamedir | Game directory, ignored in FWGS, as game directory is defined by the game directory name |
+| `gamedll`        | string     | `dlls/hl.dll`   | Game server DLL for 32-bit x86 Windows (see LibraryNaming.md for details) |
+| `gamemode`       | string     | Empty string    | Game type. When set to `singleplayer_only` or `multiplayer_only` marks the game as SP or MP only respectively, hiding the option in game UI. Omitting this key or using custom values mark the game as both MP and SP compatible. |
+| `icon`           | string     | `game.ico`      | Game icon. Engine will automatically append .ico and may automatically switch to .tga icon as well |
+| `max_beams`      | integer    | 128             | Beams limit, 64 min, 512 max |
+| `max_edicts`     | integer    | 900             | Entities limit, 600 min, 8192 max (protocol limit). In FWGS, minimum is 64. |
+| `max_particles`  | integer    | 4096            | Particles limit, 1024 min, 131072 max |
+| `max_tempents`   | integer    | 500             | Temporary entities limit. 300 min, 2048 max |
+| `mp_entity`      | string     | `info_player_deathmatch` | Entity used to mark maps as multiplayer |
+| `mp_filter`      | string     | Empty string    | When set, used to filter multiplayer maps instead of `mp_entity`.<br>If the map name starts with the same characters as this filter, it's considered a multiplayer map |
+| `nomodels`       | boolean    | 0               | When set to 1, disallows changing player model in UI |
+| `noskills`       | boolean    | 0               | When set to 1, disallows selection of game difficulty |
+| `secure`         | boolean    | 0               | When set to 1, original Unkle Mike's engine will completely disable developer mode. FWGS ignores but preserves this value for compatibility. |
+| `size`           | integer    | 0               | Game directory size in bytes, used in Change Game dialog only |
+| `startmap`       | string     | `c0a0`          | The name of the map used in new game |
+| `sp_entity`      | string     | `info_player_start` | Entity used to mark map as single player. Used in map validation |
+| `title`          | string     | `New Game`      | Game title, used in window title, default server name, etc. |
+| `trainmap`       | string     | `t0a0`          | The name of the training map (Hazard Course) |
+| `type`           | string     | Empty string    | Game type, used in Change Game UI. |
+| `url_info`       | string     | Empty string    | Game homepage URL, used in Change Game UI |
+| `url_update`     | string     | Empty string    | Game updates URL, used in Settings UI |
+| `version`        | float      | 1.0             | Game version, used in Change Game dialog and in server info |
+
+## FWGS-specific gameinfo.txt keys
+
+These strings are specific to Xash3D FWGS.
+
+| Key                     | Type       | Default value            | Description |
+| ----------------------- | ---------- | ------------------------ | ----------- |
+| `autosave_aged_count`   | integer    | 2                        | Auto saves limit used in saves rotation |
+| `gamedll_linux`         | string     | Generated from `gamedll` | Game server DLL for 32-bit x86 Linux (see LibraryNaming.md for details) |
+| `gamedll_osx`           | string     | Generated from `gamedll` | Game server DLL for 32-bit x86 macOS (see LibraryNaming.md for details) |
+| `internal_vgui_support` | boolean    | 0                        | Only for programmers! Required to be set as 1 for PrimeXT!<br>When set to 1, the engine will not load vgui_support DLL, as VGUI support is done (or intentionally ignored) on the game side. |
+| `render_picbutton_text` | boolean    | 0                        | When set to 1, the UI will not use prerendered `btns_main.bmp` and dynamically render them instead |
+| `quicksave_aged_count`  | integer    | 2                        | Quick saves limit used in saves rotation |
+
+## Note on GoldSrc liblist.gam support
+
+As Xash3D accidentally supports GoldSrc games, it also supports parsing liblist.gam.\
+Xash3D will use this file if gameinfo.txt is absent, or if its modification timestamp is older than liblist.gam.
+
+For game creators who plan supporting only Xash3D, using this file is not recommended.
+
+The table below defines conversion rules from liblist.gam to gameinfo.txt. Some keys' interpretation does differ from `gameinfo.txt`, in this case a note will be left. If `liblist.gam` key isn't present in this table, it's ignored.
+
+| `liblist.gam` key | `gameinfo.txt` key | Note |
+| ----------------- | ------------------ | ---- |
+| `edicts`          | `max_edicts`       |      |
+| `fallback_dir`    | `fallback_dir`     |      |
+| `game`            | `title`            |      |
+| `gamedir`         | `gamedir`          |      |
+| `gamedll`         | `gamedll`          |      |
+| `gamedll_linux`   | `gamedll_linux`    |      |
+| `gamedll_osx`     | `gamedll_osx`      |      |
+| `icon`            | `icon`             |      |
+| `mpentity`        | `mp_entity`        |      |
+| `mpfilter`        | `mp_filter`        |      |
+| `nomodels`        | `nomodels`         |      |
+| `secure`          | `secure`           | In GoldSrc it's used to mark the multiplayer game as anti-cheat enabled.<br>Original Xash3D misinterprets its value for disallowing console and developer mode.<br>FWGS ignores this key but preserves for compatibility. |
+| `startmap`        | `startmap`         |      |
+| `size`            | `size`             |      |
+| `trainingmap`     | `trainmap`         |      |
+| `trainmap`        | `trainmap`         |      |
+| `type`            | `type` & `gamemode`| In `liblist.gam` this key works as both `type` and `gamemode`.<br>If value is `singleplayer_only` or `multiplayer_only` the game is marked as SP or MP only, and `gameinfo.txt` type set to `Single` or `Multiplayer`.<br>Any custom value will mark the game as both SP and MP compatible, and type is set to whatever custom value. |
+| `url_dl`          | `url_update`       |      |
+| `url_info`        | `url_info`         |      |
+| `version`         | `version`          |      |
+
+

Documentation/opensource-mods.md

@@ -17,7 +17,7 @@ Mirrored on github - https://github.com/JoelTroch/am_src_rebirth
 Mirrored on github - https://github.com/nekonomicon/BattleGrounds
 
 ## Bubblemod
-Download page on official site - http://www.bubblemod.org/dl_default.php (dead link!)
+Download page on official site(WM snapshot) - [http://www.bubblemod.org/dl_default.php](https://web.archive.org/web/20130717133158/http://www.bubblemod.org/dl_default.php)
 
 Mirrored on github - https://github.com/HLSources/BubbleMod
 
@@ -85,6 +85,9 @@ Official gitlab repository - https://gitlab.com/Sockman/hltopdown
 ## Half-Life: Update
 Official github repository - https://github.com/Fograin/hl-subsmod-ex
 
+## Half-Life: Rally
+Official gitlab repository - https://gitlab.com/hlrally/src
+
 ## Half-Life: Weapon Edition
 Available on ModDB - https://www.moddb.com/mods/half-life-weapon-edition/downloads/half-life-weapon-edition-1508-alpha-open-src
 

Documentation/ports.md

@@ -2,38 +2,32 @@ Xash3D FWGS is intended to be easily ported to specific platform, however main i
 
 This page is about merged ports to main source tree and responsible for it developers.
 
-For porting guidelines, look here(TODO!)
+For porting guidelines, look engine-porting-guide.md.
 
 Status: 
-* **Supported**: active, confirmed to be fully functional.
+* **Supported**: active, was confirmed to be fully functional.
 * **In progress**: active, under development.
-* **Incomplete**:  not active, but some work was accepted to main repository before
 * **Old Engine**: port was for old engine fork
 * **Not maintained**: lack of human resources
-* **Not merged**: was done in third-party fork, real status unknown
 * **Deprecated**: not supported anymore
 
-Table is sorted by status.
+Table is sorted by status and platform.
 
 | Platform        | Status                     | Maintainer               | Note
 | --------        | ------                     | ----------               | ----
-| Windows         | Supported                  | @a1batross, @SNMetamorph |
+| Android         | Supported                  | @Velaron                 |
 | *BSD            | Supported                  | @nekonomicon             |
-| GNU/Linux(x86, amd64, arm) | Supported       | @a1batross, @mittorn     |
-| Android         | Supported                  | @a1batross, @mittorn     |
-| MotoMAGX        | Supported                  | @a1batross               |
-| GNU/Linux(elbrus) | Supported                | @a1batross, @mittorn     | Rare and eventual access to e2k machine
-| Haiku           | Supported                  | not maintained           | Was added by #478 and #483
 | DOS4GW          | Supported                  | @mittorn                 |
-| GNU/Linux(mipsel) | Supported                | @mittorn                 |
+| GNU/Linux       | Supported                  | @a1batross, @mittorn     |
+| Haiku           | Supported                  | not maintained           | Was added by #478 and #483
+| macOS           | Supported                  | @sofakng                 | 
+| MotoMAGX        | Supported                  | @a1batross               |
 | PSVita          | Supported                  | @fgsfdsfgs               |
 | Switch          | Supported                  | @fgsfdsfgs               |
-| Wii             | In progress                | Collaborative effort     | [GitHub Repository](https://github.com/saucesaft/xash3d-wii) 
+| Windows         | Supported                  | @a1batross, @SNMetamorph |
 | PSP             | In progress                | @Crow_bar, @Velaron      | [GitHub Repository](https://github.com/Crow-bar/xash3d-fwgs)
+| Wii             | In progress                | Collaborative effort     | [GitHub Repository](https://github.com/saucesaft/xash3d-wii)
 | Emscripten      | Old Engine                 | not maintained           | 
-| Oculus Quest    | Old Engine fork            | @DrBeef                  | [GitHub Repository](https://github.com/DrBeef/Lambda1VR)
-| PSVita          | Old Engine fork            | not maintained           | [GitHub Repository](https://github.com/fgsfdsfgs/vitaXash3D)
-| Switch          | Old Engine fork            | not maintained           | [GitHub Repository](https://github.com/switchports/xash3d-switch)
 | 3DS             | Old Engine fork            | not maintained           | [GitHub Repository](https://github.com/masterfeizz/Xash3DS)
-| macOS           | Deprecated                 | not maintained           | See GitHub issue #61
+| Oculus Quest    | Old Engine fork            | @DrBeef                  | [GitHub Repository](https://github.com/DrBeef/Lambda1VR)
 | iOS             | Deprecated                 | not maintained           | See GitHub issue #61

common/backends.h

@@ -18,21 +18,17 @@ GNU General Public License for more details.
 // video backends (XASH_VIDEO)
 #define VIDEO_NULL    0
 #define VIDEO_SDL     1
-#define VIDEO_ANDROID 2
 #define VIDEO_FBDEV   3
 #define VIDEO_DOS     4
 
-
 // audio backends (XASH_SOUND)
 #define SOUND_NULL     0
 #define SOUND_SDL      1
-#define SOUND_OPENSLES 2
 #define SOUND_ALSA     3
 
 // input (XASH_INPUT)
 #define INPUT_NULL    0
 #define INPUT_SDL     1
-#define INPUT_ANDROID 2
 #define INPUT_EVDEV   3
 
 // timer (XASH_TIMER)
@@ -45,16 +41,13 @@ GNU General Public License for more details.
 // messageboxes (XASH_MESSAGEBOX)
 #define MSGBOX_STDERR  0
 #define MSGBOX_SDL     1
-#define MSGBOX_ANDROID 2
 #define MSGBOX_WIN32   3
 #define MSGBOX_NSWITCH 4
 
-
 // library loading (XASH_LIB)
 #define LIB_NULL 0
 #define LIB_POSIX 1
 #define LIB_WIN32 2
 #define LIB_STATIC 3
 
-
 #endif /* BACKENDS_H */

common/defaults.h

@@ -52,26 +52,6 @@ SETUP BACKENDS DEFINITIONS
 				#endif
 			#endif // XASH_MESSAGEBOX
 		#endif
-	#elif XASH_ANDROID
-		// we are building for Android platform, use Android APIs
-		#ifndef XASH_VIDEO
-			#define XASH_VIDEO VIDEO_ANDROID
-		#endif // XASH_VIDEO
-
-		#ifndef XASH_INPUT
-			#define XASH_INPUT INPUT_ANDROID
-		#endif // XASH_INPUT
-
-		#ifndef XASH_SOUND
-			#define XASH_SOUND SOUND_OPENSLES
-		#endif // XASH_SOUND
-
-		#ifndef XASH_MESSAGEBOX
-			#define XASH_MESSAGEBOX MSGBOX_ANDROID
-		#endif // XASH_MESSAGEBOX
-
-		#define XASH_USE_EVDEV 1
-		#define XASH_DYNAMIC_DLADDR
 	#elif XASH_LINUX
 		// we are building for Linux without SDL2, can draw only to framebuffer yet
 		#ifndef XASH_VIDEO
@@ -171,6 +151,8 @@ Default build-depended cvar and constant values
 	#define DEFAULT_MODE_WIDTH   960
 	#define DEFAULT_MODE_HEIGHT  544
 	#define DEFAULT_ALLOWCONSOLE 1
+#elif XASH_ANDROID
+	#define DEFAULT_TOUCH_ENABLE "1"
 #elif XASH_MOBILE_PLATFORM
 	#define DEFAULT_TOUCH_ENABLE "1"
 	#define DEFAULT_M_IGNORE     "1"
@@ -204,7 +186,7 @@ Default build-depended cvar and constant values
 #endif // DEFAULT_ALLOWCONSOLE
 
 #ifndef DEFAULT_FULLSCREEN
-	#define DEFAULT_FULLSCREEN 1
+	#define DEFAULT_FULLSCREEN "1" // must be a string
 #endif // DEFAULT_FULLSCREEN
 
 #endif // DEFAULTS_H