ref: dx2: zbuffer and clear

Same flag is used in gl4es's CMakeLists

.cirrus.yml

@@ -1,23 +0,0 @@
-task:
-  name: freebsd-14-amd64
-  freebsd_instance:
-    image_family: freebsd-14-0
-  setup_script:
-    - pkg update
-    - pkg install -y pkgconf git sdl2 python fontconfig opus
-    - git submodule update --init --recursive
-  test_script:
-    - ./scripts/cirrus/build_freebsd.sh dedicated
-    - ./scripts/cirrus/build_freebsd.sh full
-
-task:
-  name: freebsd-15-amd64
-  freebsd_instance:
-    image_family: freebsd-15-0-snap
-  setup_script:
-    - pkg update
-    - pkg install -y pkgconf git sdl2 python fontconfig opus
-    - git submodule update --init --recursive
-  test_script:
-    - ./scripts/cirrus/build_freebsd.sh dedicated
-    - ./scripts/cirrus/build_freebsd.sh full

.clang-format

@@ -0,0 +1,113 @@
+Language: Cpp
+Standard: c++17
+UseTab: ForContinuationAndIndentation
+TabWidth: 4
+IndentWidth: 4
+ContinuationIndentWidth: 4
+IndentCaseLabels: false
+IndentPPDirectives: None
+NamespaceIndentation: None
+AccessModifierOffset: -4
+IndentAccessModifiers: false
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterCaseLabel: true
+  AfterClass: true
+  AfterControlStatement: Always
+  AfterEnum: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterStruct: true
+  AfterUnion: true
+  AfterExternBlock: false
+  BeforeCatch: true
+  BeforeElse: true
+  BeforeWhile: true
+  IndentBraces: false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+  SplitEmptyNamespace: false
+MaxEmptyLinesToKeep: 2
+KeepEmptyLinesAtTheStartOfBlocks: false
+KeepEmptyLinesAtEOF: false
+SeparateDefinitionBlocks: Always
+InsertNewlineAtEOF: true
+LineEnding: LF
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+BinPackArguments: true
+BinPackParameters: true
+AlwaysBreakAfterReturnType: None
+AlwaysBreakAfterDefinitionReturnType: None
+AllowShortFunctionsOnASingleLine: None
+AllowShortBlocksOnASingleLine: Empty
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+AllowShortEnumsOnASingleLine: false
+BreakBeforeBinaryOperators: All
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeColon
+PointerAlignment: Right
+DerivePointerAlignment: false
+ReferenceAlignment: Pointer
+SpaceAroundPointerQualifiers: Default
+SpacesInParens: Custom
+SpacesInParensOptions:
+  ExceptDoubleParentheses: true
+  InCStyleCasts: false
+  InConditionalStatements: true
+  InEmptyParentheses: false
+  Other: true
+# XashCollapseParens: true
+SpaceBeforeParens: Never
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeSquareBrackets: false
+SpaceInEmptyBlock: false
+SpacesInAngles: Never
+SpacesInContainerLiterals: false
+SpacesInSquareBrackets: false
+Cpp11BracedListStyle: false
+SpacesBeforeTrailingComments: 1
+SpacesInLineCommentPrefix:
+  Minimum: 1
+  Maximum: -1
+AlignAfterOpenBracket: DontAlign
+AlignArrayOfStructures: None
+AlignConsecutiveAssignments:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+AlignConsecutiveBitFields:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+AlignConsecutiveDeclarations:
+  Enabled: false
+  AcrossEmptyLines: false
+  AcrossComments: false
+  AlignCompound: false
+AlignConsecutiveMacros:
+  Enabled: true
+  AcrossEmptyLines: false
+  AcrossComments: false
+AlignEscapedNewlines: Left
+AlignOperands: Align
+AlignTrailingComments:
+  Kind: Always
+  OverEmptyLines: 0
+ColumnLimit: 0
+ReflowComments: false
+SortIncludes: Never
+SortUsingDeclarations: false
+InsertBraces: false
+RemoveBracesLLVM: false
+FixNamespaceComments: false

.github/workflows/c-cpp.yml

@@ -15,35 +15,34 @@ jobs:
         include:
           # Linux build specifically want oldest Ubuntu as possible
           # to be crossdistribution compatible, otherwise use ubuntu-latest
-          - os: ubuntu-20.04
+          - os: ubuntu-22.04
             targetos: linux
             targetarch: amd64
-          - os: ubuntu-20.04
+          - os: ubuntu-22.04
             targetos: linux
             targetarch: i386
-          - os: ubuntu-20.04
+          - os: ubuntu-22.04-arm
             targetos: linux
             targetarch: arm64
-            cross: true
-          - os: ubuntu-20.04
+          - os: ubuntu-22.04-arm
             targetos: linux
             targetarch: armhf
-            cross: true
-          - os: ubuntu-20.04
+          - os: ubuntu-24.04 # riscv64 would benefit from having latest compilers
             targetos: linux
             targetarch: riscv64
             cross: true
-          - os: ubuntu-20.04
+          - os: ubuntu-22.04
             targetos: linux
             targetarch: ppc64el
             cross: true
-#          - os: ubuntu-aarch64-20.04
+#          - os: ubuntu-latest
 #            targetos: linux
-#            targetarch: aarch64
-          - os: ubuntu-20.04
+#            targetarch: e2k-8c
+#            cross: true
+          - os: ubuntu-latest
             targetos: android
             targetarch: multiarch
-#          - os: ubuntu-20.04
+#          - os: ubuntu-22.04
 #            targetos: motomagx
 #            targetarch: armv6
 
@@ -56,22 +55,28 @@ jobs:
           - os: windows-latest
             targetos: win32
             targetarch: amd64
-          - os: windows-2019 # always use the oldest possible for 32-bit because of older compilers, and better support of certain legacy OSes
+          - os: windows-2022 # always use the oldest possible for 32-bit because of older compilers, and better support of certain legacy OSes
             targetos: win32
             targetarch: i386
           - os: macos-14 # arm64 as per github documentation
             targetos: apple
             targetarch: arm64
-          - os: macos-13 # x86 as per github documentation (will they fix it before they deprecate this version?..)
+          - os: macos-latest
+            targetos: ios
+            targetarch: arm64
+          - os: macos-15-intel
             targetos: apple
             targetarch: amd64
     env:
-      SDL_VERSION: 2.30.11
+      SDL_VERSION: 2.32.10
+      FFMPEG_VERSION: 8.1
+      YY_THUNKS_VERSION: v1.2.1
       GH_CPU_ARCH: ${{ matrix.targetarch }}
+      GH_CPU_OS: ${{ matrix.targetos }}
       GH_CROSSCOMPILING: ${{ matrix.cross }}
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
       with:
         submodules: recursive
     - name: Install dependencies
@@ -81,26 +86,27 @@ jobs:
         FWGS_PFX_PASSWORD: ${{ secrets.FWGS_PFX_PASSWORD }}
       run: bash scripts/gha/build_${{ matrix.targetos }}.sh
     - name: Upload engine (artifacts)
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v7
       with:
         name: artifact-${{ matrix.targetos }}-${{ matrix.targetarch }}
         path: artifacts/*
   flatpak:
     runs-on: ubuntu-latest
+    continue-on-error: true
     strategy:
       matrix:
         include:
           - app: su.xash.Engine.Compat.i386
     container:
-      image: bilelmoussaoui/flatpak-github-actions:freedesktop-24.08
+      image: ghcr.io/flathub-infra/flatpak-github-actions:freedesktop-25.08
       options: --privileged
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
       with:
         submodules: recursive
     - name: Build flatpak (Compat.i386)
-      uses: FWGS/flatpak-github-actions/flatpak-builder@v6.3
+      uses: FWGS/flatpak-github-actions/flatpak-builder@v6.5
       with:
         bundle: ${{ matrix.app }}.flatpak
         manifest-path: scripts/flatpak/${{ matrix.app }}.yml
@@ -110,32 +116,10 @@ jobs:
     needs: [build, flatpak]
     if: ${{ github.event_name == 'push' }}
     steps:
+    - name: Checkout
+      uses: actions/checkout@v6
     - name: Remove old release, fetch artifacts, repackage binaries and upload new release
       env:
         GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        RELEASE_TAG: ${{ github.ref_name == 'master' && 'continuous' || format('continuous-{0}', github.ref_name) }}
-      run: |
-        gh release delete "$RELEASE_TAG" \
-          --yes \
-          --cleanup-tag \
-          --repo "$GITHUB_REPOSITORY" || true
-        sleep 20s
-        gh run download "$GITHUB_RUN_ID" \
-          --dir artifacts/ \
-          --repo "$GITHUB_REPOSITORY"
-        pushd artifacts/
-        echo "Found artifacts:"
-        ls
-        for i in $(find -mindepth 1 -maxdepth 1 -type d); do
-          mv "$i"/* .
-          rm -rf "$i"
-        done
-        echo "Repackaged artifacts:"
-        ls -R
-        popd
-        sleep 20s
-        gh release create "$RELEASE_TAG" artifacts/* \
-          --title "Xash3D FWGS Continuous ${{ github.ref_name }} Build" \
-          --target $GITHUB_SHA \
-          --repo "$GITHUB_REPOSITORY" \
-          --prerelease
+        BASE_BUILDNUM_DATE: "2015-04-01"
+      run: bash scripts/gha/make_release.sh "Xash3D FWGS" "${{ github.ref_name }}"

.gitignore

@@ -222,7 +222,7 @@ publish/
 # Publish Web Output
 *.[Pp]ublish.xml
 *.azurePubxml
-# TODO: Comment the next line if you want to checkin your web deploy settings 
+# TODO: Comment the next line if you want to checkin your web deploy settings
 # but database connection strings (with potential passwords) will be unencrypted
 *.pubxml
 *.publishproj
@@ -318,6 +318,12 @@ build-*
 *.includes
 *.files
 
+# ios
+ios/cl_dlls/*
+ios/dlls/*
+ios/*.framework
+scripts/ios/mod-build
+
 # Waf
 build_current
 *waf-*/
@@ -339,9 +345,32 @@ __pycache__
 .history/*
 .cache/*
 enc_temp_folder/
+Taskfile.yml
 
 # KDevelop4
 *.kdev4
 
 # ccls langauge server
 .ccls-*
+
+# JetBrains
+.idea/
+cmake-build-*
+
+# some Android-specific build stuff
+3rdparty/SDL
+3rdparty/hlsdk-portable
+!scripts/build-ninja.py
+
+# slop
+CLAUDE.md
+AGENTS.md
+GEMINI.md
+.claude/
+.gemini/
+.cursor*
+.windsurf*
+.aider*
+.continue/
+.codeium/
+.github/copilot-instructions.md

.gitmodules

@@ -27,10 +27,22 @@
 	url = https://github.com/FWGS/MultiEmulator
 [submodule "3rdparty/libogg/libogg"]
 	path = 3rdparty/libogg/libogg
-	url = https://gitlab.xiph.org/xiph/ogg.git
+	url = https://github.com/xiph/ogg.git
 [submodule "3rdparty/vorbis/vorbis-src"]
 	path = 3rdparty/vorbis/vorbis-src
-	url = https://gitlab.xiph.org/xiph/vorbis.git
+	url = https://github.com/xiph/vorbis.git
 [submodule "3rdparty/opusfile/opusfile"]
 	path = 3rdparty/opusfile/opusfile
-	url = https://gitlab.xiph.org/xiph/opusfile.git
+	url = https://github.com/xiph/opusfile.git
+[submodule "3rdparty/libbacktrace/libbacktrace"]
+	path = 3rdparty/libbacktrace/libbacktrace
+	url = https://github.com/ianlancetaylor/libbacktrace
+[submodule "3rdparty/maintui"]
+	path = 3rdparty/maintui
+	url = https://github.com/FWGS/xash3d-maintui.git
+[submodule "3rdparty/library_suffix"]
+	path = 3rdparty/library_suffix
+	url = https://github.com/FWGS/library-suffix.git
+[submodule "3rdparty/mbedtls/mbedtls"]
+	path = 3rdparty/mbedtls/mbedtls
+	url = https://github.com/FWGS/mbedtls-releases.git

3rdparty/extras/wscript

@@ -23,7 +23,6 @@ def build(bld):
 
 	bld(features='zip',
 		name = 'extras.pk3',
-		files = srcdir.ant_glob('**/*'),
+		files = srcdir.ant_glob('**/*', excl=['scripts/**']),
 		relative_to = srcdir,
-		compresslevel = 0,
 		install_path = install_path)

3rdparty/gl4es/wscript

@@ -13,10 +13,14 @@ def configure(conf):
 
 def build(bld):
 	gl4es_srcdir = bld.path.find_node('gl4es/src')
-
+	cflags = []
+	if bld.env.COMPILER_CC != 'msvc':
+		cflags += ['-w', '-fvisibility=hidden', '-std=gnu99']
+	else:
+		cflags += ['-wd4098']
 	bld.stlib(source   = gl4es_srcdir.ant_glob(['gl/*.c', 'gl/*/*.c', 'glx/hardext.c']),
 		target   = 'gl4es',
 		includes = ['gl4es/src', 'gl4es/src/gl', 'gl4es/src/glx', 'gl4es/include'],
 		defines  = ['NOX11', 'NO_GBM', 'NO_INIT_CONSTRUCTOR', 'DEFAULT_ES=2', 'NOEGL', 'NO_LOADER', 'STATICLIB'],
-		cflags   = ['-w', '-fvisibility=hidden', '-std=gnu99'],
+		cflags   = cflags,
 		export_includes = '.')

3rdparty/libbacktrace/wscript

@@ -0,0 +1,195 @@
+#! /usr/bin/env python
+# encoding: utf-8
+
+from waflib import TaskGen
+from waflib.Tools.c_config import DEFKEYS
+
+FRAGMENT_ATOMIC='''int i;
+int main(void) {
+	__atomic_load_n(&i, __ATOMIC_ACQUIRE);
+	__atomic_store_n(&i, 1, __ATOMIC_RELEASE);
+	return 0;
+}'''
+
+FRAGMENT_SYNC='''int i;
+int main (void) {
+	__sync_bool_compare_and_swap (&i, i, i);
+	__sync_lock_test_and_set (&i, 1);
+	__sync_lock_release (&i);
+	return 0;
+}'''
+
+FRAGMENT_GETPAGESIZE='''#include <unistd.h>
+int main(void) { return getpagesize(); }'''
+
+FRAGMENT_GETEXECNAME='''#include <stdlib.h>
+int main(void) { return getexecname() != 0; }'''
+
+FRAGMENT_STRNLEN='''#include <string.h>
+int main(int argc, char **argv) { return (int)strnlen(argv[0], 10); }'''
+
+FRAGMENT_DL_ITERATE_PHDR='''#include <%s>
+int main(void) { return dl_iterate_phdr(0, 0); }'''
+
+FRAGMENT_FCNTL='''#include <fcntl.h>
+int main(void) { return fcntl(0, 0, 0); }'''
+
+FRAGMENT_GETIPINFO='''#include "unwind.h"
+struct _Unwind_Context *context;
+int ip_before_insn = 0;
+int main(void) { return _Unwind_GetIPInfo(context, &ip_before_insn); }'''
+
+FRAGMENT_LOADQUERY='''#include <sys/ldr.h>
+#include <sys/debug.h>
+int main(void) { return loadquery(0, 0, 0); }'''
+
+FRAGMENT_KERN_PROC='''#include <sys/sysctl.h>
+#if !defined(%s) || !defined(KERN_PROC_PATHNAME)
+#error
+#endif
+int main(void) { return 0; }'''
+
+FRAGMENT_LSTAT='''#include <sys/stat.h>
+struct stat st;
+int main(int argc, char **argv) { return lstat(argv[0], &st); }'''
+
+FRAGMENT_READLINK='''#include <unistd.h>
+char buf[100];
+int main(int argc, char **argv) { return readlink(argv[0], buf, sizeof(buf)); }'''
+
+def options(opt):
+	pass
+
+def configure(conf):
+	# add unsupported platforms here
+	if conf.env.DEST_OS in ['nswitch', 'psvita', 'dos', 'irix']:
+		conf.env.DISABLE_LIBBACKTRACE = True
+		return
+
+	# win32 has it's own dbghelp-based backtrace, that's why we ship PDBs
+	if conf.env.COMPILER_CC == 'msvc':
+		conf.env.DISABLE_LIBBACKTRACE = True
+		return
+
+	if not conf.path.find_dir('libbacktrace') or not conf.path.find_dir('libbacktrace/config'):
+		conf.fatal('Can\'t find libbacktrace submodule. Run `git submodule update --init --recursive`.')
+		return
+
+	conf.define('BACKTRACE_ELF_SIZE', 64 if conf.env.DEST_SIZEOF_VOID_P == 8 else 32)
+	conf.define('BACKTRACE_XCOFF_SIZE', 64 if conf.env.DEST_SIZEOF_VOID_P == 8 else 32)
+	conf.define('_ALL_SOURCE', 1)
+	conf.define('_GNU_SOURCE', 1)
+	conf.define('_POSIX_PTHREAD_SEMANTICS', 1)
+	conf.define('_TANDEM_SOURCE', 1)
+	conf.define('__EXTENSIONS__', 1)
+	conf.define('_DARWIN_USE_64_BIT_INODE', 1)
+	conf.define('_LARGE_FILES', 1)
+	conf.check_large_file(compiler='c', execute=False, mandatory=False) # sets _FILE_OFFSET_BITS
+
+	conf.env.CFLAGS_EXTRAFLAGS = conf.filter_cflags(['-funwind-tables', '-g'], [])
+
+	if conf.filter_cflags(['-frandom-seed=test'], []):
+		conf.env.HAVE_FRANDOM_SEED = True
+
+	def check_header(hdr):
+		return {'header_name':hdr, 'msg':'... %s header' % hdr, 'mandatory':False, 'id':hdr, 'compiler': 'c'}
+
+	def check_frag(frag, msg, define, **kw):
+		return dict({'fragment': frag, 'msg':'... %s' % msg, 'mandatory': False, 'define_name': define, 'compiler': 'c'}, **kw)
+
+	conf.multicheck(
+		check_header('dlfcn.h'),
+		check_header('inttypes.h'),
+		check_header('link.h'),
+		check_header('sys/link.h'),
+		check_header('mach-o/dyld.h'),
+		check_header('memory.h'),
+		check_header('stdint.h'),
+		check_header('stdlib.h'),
+		check_header('strings.h'),
+		check_header('string.h'),
+		check_header('sys/ldr.h'),
+		check_header('sys/mman.h'),
+		check_header('sys/stat.h'),
+		check_header('sys/types.h'),
+		check_header('tlhelp32.h'),
+		check_header('unistd.h'),
+		check_header('windows.h'),
+
+		check_frag(FRAGMENT_ATOMIC, '__atomic extensions', 'HAVE_ATOMIC_FUNCTIONS'),
+		check_frag(FRAGMENT_SYNC, ' __sync extensions', 'HAVE_SYNC_FUNCTIONS'),
+		check_frag(FRAGMENT_GETPAGESIZE, ' getpagesize function', 'HAVE_DECL_GETPAGESIZE'),
+		check_frag(FRAGMENT_STRNLEN, ' strnlen function', 'HAVE_DECL_STRNLEN'),
+		check_frag(FRAGMENT_DL_ITERATE_PHDR % 'link.h', ' dl_iterate_phdr function in link.h', 'HAVE_DL_ITERATE_PHDR_LINK_H', after_tests=['link.h']),
+		check_frag(FRAGMENT_DL_ITERATE_PHDR % 'sys/link.h', ' dl_iterate_phdr function in sys/link.h', 'HAVE_DL_ITERATE_PHDR_SYS_LINK_H', after_tests=['sys/link.h']),
+		check_frag(FRAGMENT_FCNTL, 'fnctl function', 'HAVE_FCNTL'),
+		check_frag(FRAGMENT_GETEXECNAME, 'getexecname function','HAVE_GETEXECNAME'),
+		check_frag(FRAGMENT_GETIPINFO, '_Unwind_GetIPInfo function', 'HAVE_GETIPINFO'),
+		check_frag(FRAGMENT_KERN_PROC % 'KERN_PROC', 'KERN_PROC and KERN_PROC_PATHNAME defines', 'HAVE_KERN_PROC'),
+		check_frag(FRAGMENT_KERN_PROC % 'KERN_PROC_ARGS', 'KERN_PROC_ARGS and KERN_PROC_PATHNAME defines', 'HAVE_KERN_PROC_ARGS'),
+		check_frag(FRAGMENT_LOADQUERY, 'loadquery function', 'HAVE_LOADQUERY'),
+		check_frag(FRAGMENT_LSTAT, 'lstat function', 'HAVE_LSTAT'),
+		check_frag(FRAGMENT_READLINK, 'readlink function', 'HAVE_READLINK'),
+
+#		{'lib':'lzma', 'define_name':'HAVE_LIBLZMA', 'uselib_store':'lzma', 'msg':'... lzma library', 'mandatory':False},
+#		{'lib':'z', 'define_name':'HAVE_ZLIB', 'uselib_store':'z', 'msg':'... zlib library', 'mandatory':False},
+#		{'lib':'zstd', 'define_name':'HAVE_ZSTD', 'uselib_store':'zstd', 'msg':'... zstd library', 'mandatory':False},
+		msg='Checking for in parallel'
+	)
+
+	if conf.is_defined('HAVE_DL_ITERATE_PHDR_LINK_H') or conf.is_defined('HAVE_DL_ITERATE_PHDR_SYS_LINK_H'):
+		conf.define('HAVE_DL_ITERATE_PHDR', 1)
+
+	conf.env[DEFKEYS].sort()
+
+	conf.write_config_header()
+
+	conf.define('BACKTRACE_SUPPORTED', 1)
+	conf.define('BACKTRACE_USES_MALLOC', 0)
+	conf.define('BACKTRACE_SUPPORTS_THREADS', 1)
+	conf.define('BACKTRACE_SUPPORTS_DATA', conf.env.DEST_BINFMT in ['elf', 'mac-o'])
+
+	conf.write_config_header('backtrace-supported.h')
+
+@TaskGen.feature('frandomseed')
+@TaskGen.after_method('propagate_uselib_vars')
+def process_frandom_seed(ctx):
+	tasks = getattr(ctx, 'compiled_tasks', [])
+
+	for task in tasks:
+		out = task.outputs[0]
+		task.env.CFLAGS = list(task.env.CFLAGS) # need a copy
+		task.env.CFLAGS += ['-frandom-seed=%s' % out.path_from(out.ctx.bldnode)]
+
+def build(bld):
+	if bld.env.DISABLE_LIBBACKTRACE:
+		return
+
+	sources = ['atomic.c', 'dwarf.c', 'fileline.c', 'posix.c', 'print.c', 'sort.c', 'state.c', 'backtrace.c', 'simple.c']
+
+	if bld.env.DEST_OS == 'win32':
+		sources += ['read.c', 'alloc.c']
+	else:
+		# we specifically only want mmap-based allocators because calling malloc is not safe from signal handlers
+		sources += ['mmap.c', 'mmapio.c']
+
+	if bld.env.DEST_BINFMT == 'pe':
+		sources += ['pecoff.c']
+	elif bld.env.DEST_BINFMT == 'mac-o':
+		sources += ['macho.c']
+	elif bld.env.DEST_BINFMT == 'elf':
+		sources += ['elf.c']
+	else:
+		sources += ['unknown.c']
+
+	task = bld.stlib(
+		source = ['libbacktrace/' + i for i in sources],
+		# while we're using upstream libbacktrace, sometimes compiler picks up it's own version that isn't built with required options
+		target = 'backtrace_custom',
+		features = 'frandomseed' if bld.env.HAVE_FRANDOM_SEED else '',
+		use = 'EXTRAFLAGS lzma z zstd',
+		includes = '. libbacktrace/',
+		export_defines = 'HAVE_LIBBACKTRACE=1',
+		export_includes = 'libbacktrace/'
+	)
+

3rdparty/mbedtls/compat.c

@@ -0,0 +1,107 @@
+/*
+compat.c - mbedTLS platform overrides for targets upstream doesn't cover
+Copyright (C) 2026 Xash3D FWGS contributors
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+*/
+
+/*
+WinXP: legacy CryptGenRandom via advapi32
+Source: ttps://learn.microsoft.com/en-us/windows/win32/api/wincrypt/nf-wincrypt-cryptgenrandom
+
+PSVita: sceKernelGetRandomNumber from psp2/kernel/rng.h (64-byte cap).
+Source: https://github.com/vitasdk/vita-headers/blob/master/include/psp2/kernel/rng.h
+
+NSwitch: randomGet from libnx.
+Source: https://github.com/switchbrew/libnx/blob/master/nx/include/switch/kernel/random.h
+*/
+
+#include "mbedtls/platform.h"
+#include "psa/crypto.h"
+
+#if defined( MBEDTLS_PLATFORM_MS_TIME_ALT )
+
+mbedtls_ms_time_t mbedtls_ms_time( void )
+{
+	extern double Platform_DoubleTime( void );
+
+	return (mbedtls_ms_time_t)( Platform_DoubleTime() * 1000.0 );
+}
+
+#endif /* MBEDTLS_PLATFORM_MS_TIME_ALT */
+
+#if defined( MBEDTLS_PSA_DRIVER_GET_ENTROPY )
+#if defined( _WIN32 ) && !defined( _WIN64 )
+#include <windows.h>
+#include <wincrypt.h>
+int mbedtls_platform_get_entropy( psa_driver_get_entropy_flags_t flags, size_t *estimate_bits, unsigned char *output, size_t output_size )
+{
+	if( flags != 0 )
+		return PSA_ERROR_NOT_SUPPORTED;
+
+	HCRYPTPROV prov;
+	if( !CryptAcquireContextW( &prov, NULL, NULL, PROV_RSA_FULL,
+		CRYPT_VERIFYCONTEXT | CRYPT_SILENT ))
+		return PSA_ERROR_INSUFFICIENT_ENTROPY;
+
+	if( !CryptGenRandom( prov, (DWORD)output_size, output ))
+	{
+		CryptReleaseContext( prov, 0 );
+		return PSA_ERROR_INSUFFICIENT_ENTROPY;
+	}
+
+	CryptReleaseContext( prov, 0 );
+	*estimate_bits = 8 * output_size;
+	return 0;
+}
+#elif defined( __vita__ )
+#include <psp2/kernel/rng.h>
+
+int mbedtls_platform_get_entropy( psa_driver_get_entropy_flags_t flags, size_t *estimate_bits, unsigned char *output, size_t output_size )
+{
+	if( flags != 0 )
+		return PSA_ERROR_NOT_SUPPORTED;
+
+	size_t total = 0;
+	while( total < output_size )
+	{
+		size_t chunk = output_size - total;
+
+		if( chunk > 64 )
+			chunk = 64;
+
+		if( sceKernelGetRandomNumber( output + total, chunk ) != 0 )
+			return PSA_ERROR_INSUFFICIENT_ENTROPY;
+
+		total += chunk;
+	}
+
+	*estimate_bits = 8 * output_size;
+	return 0;
+}
+
+#elif defined( __SWITCH__ )
+#include <switch.h>
+
+int mbedtls_platform_get_entropy( psa_driver_get_entropy_flags_t flags, size_t *estimate_bits, unsigned char *output, size_t output_size )
+{
+	if( flags != 0 )
+		return PSA_ERROR_NOT_SUPPORTED;
+
+	randomGet( output, output_size );
+	*estimate_bits = 8 * output_size;
+	return 0;
+}
+#else
+#error "MBEDTLS_PSA_DRIVER_GET_ENTROPY enabled but no platform impl in compat.c"
+#endif
+
+#endif /* MBEDTLS_PSA_DRIVER_GET_ENTROPY */

3rdparty/mbedtls/wscript

@@ -0,0 +1,67 @@
+#! /usr/bin/env python
+# encoding: utf-8
+
+def options(opt):
+	grp = opt.add_option_group('mbedTLS options')
+	grp.add_option('--disable-mbedtls', action='store_false', dest='MBEDTLS', default=True,
+		help='disable bundled mbedTLS and built-in HTTPS support [default: enabled]')
+
+def configure(conf):
+	conf.env.MBEDTLS = conf.options.MBEDTLS
+	if not conf.env.MBEDTLS:
+		return
+
+	if not conf.path.find_dir('mbedtls') or not conf.path.find_dir('mbedtls/library'):
+		conf.fatal('Can\'t find mbedtls submodule. Run `git submodule update --init --recursive`.')
+
+	if not conf.path.find_dir('mbedtls/tf-psa-crypto/core'):
+		conf.fatal('mbedTLS nested submodule tf-psa-crypto is missing. Run `git submodule update --init --recursive`.')
+
+def build(bld):
+	if not bld.env.MBEDTLS:
+		return
+
+	sources = bld.path.ant_glob([
+		'mbedtls/library/*.c',
+		'mbedtls/tf-psa-crypto/core/*.c',
+		'mbedtls/tf-psa-crypto/extras/*.c',
+		'mbedtls/tf-psa-crypto/platform/*.c',
+		'mbedtls/tf-psa-crypto/utilities/*.c',
+		'mbedtls/tf-psa-crypto/drivers/builtin/src/*.c',
+	])
+
+	sources += ['compat.c']
+
+	defines = [
+		'MBEDTLS_USER_CONFIG_FILE="xash_mbedtls_config.h"',
+		'TF_PSA_CRYPTO_USER_CONFIG_FILE="xash_psa_config.h"',
+	]
+
+	includes = [
+		'.',
+		'mbedtls/include',
+		'mbedtls/library',
+		'mbedtls/tf-psa-crypto/include',
+		'mbedtls/tf-psa-crypto/drivers/builtin/include',
+		'mbedtls/tf-psa-crypto/core',
+		'mbedtls/tf-psa-crypto/drivers/builtin/src',
+		'mbedtls/tf-psa-crypto/utilities',
+		'mbedtls/tf-psa-crypto/extras',
+		'mbedtls/tf-psa-crypto/platform',
+		'mbedtls/tf-psa-crypto/dispatch',
+	]
+
+	bld.stlib(
+		source = sources,
+		target = 'mbedtls',
+		features = 'c',
+		includes = includes,
+		defines = defines,
+		export_defines = ['XASH_MBEDTLS'],
+		export_includes = [
+			'.',
+			'mbedtls/include',
+			'mbedtls/tf-psa-crypto/include',
+			'mbedtls/tf-psa-crypto/drivers/builtin/include',
+		]
+	)

3rdparty/mbedtls/xash_mbedtls_config.h

@@ -0,0 +1,36 @@
+#ifndef XASH_MBEDTLS_CONFIG_H
+#define XASH_MBEDTLS_CONFIG_H
+
+#undef MBEDTLS_NET_C
+#undef MBEDTLS_PKCS7_C
+#undef MBEDTLS_TIMING_C
+#undef MBEDTLS_SSL_SRV_C
+#undef MBEDTLS_SSL_PROTO_DTLS
+#undef MBEDTLS_SSL_DTLS_ANTI_REPLAY
+#undef MBEDTLS_SSL_DTLS_CONNECTION_ID
+#undef MBEDTLS_SSL_DTLS_HELLO_VERIFY
+#undef MBEDTLS_SSL_DTLS_SRTP
+#undef MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
+#undef MBEDTLS_SSL_COOKIE_C
+#undef MBEDTLS_SSL_CACHE_C
+#undef MBEDTLS_SSL_TICKET_C
+#undef MBEDTLS_SSL_SESSION_TICKETS
+#undef MBEDTLS_SSL_RENEGOTIATION
+#undef MBEDTLS_SSL_CONTEXT_SERIALIZATION
+#undef MBEDTLS_SSL_KEYING_MATERIAL_EXPORT
+#undef MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
+#undef MBEDTLS_SSL_ALL_ALERT_MESSAGES
+#undef MBEDTLS_SSL_ALPN
+#undef MBEDTLS_SSL_ENCRYPT_THEN_MAC
+#undef MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
+#undef MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
+#undef MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
+#undef MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
+#undef MBEDTLS_X509_CREATE_C
+#undef MBEDTLS_X509_CRT_WRITE_C
+#undef MBEDTLS_X509_CSR_PARSE_C
+#undef MBEDTLS_X509_CSR_WRITE_C
+#undef MBEDTLS_X509_CRL_PARSE_C
+#undef MBEDTLS_VERSION_FEATURES
+
+#endif /* XASH_MBEDTLS_CONFIG_H */

3rdparty/mbedtls/xash_psa_config.h

@@ -0,0 +1,82 @@
+#ifndef XASH_PSA_CONFIG_H
+#define XASH_PSA_CONFIG_H
+
+#if (defined( _WIN32 ) && !defined( _WIN64 )) || defined( __vita__ ) || defined( __SWITCH__ )
+/* WinXP, PSVita and NSwitch use entropy paths upstream doesn't cover.
+   compat.c provides mbedtls_platform_get_entropy() for all three. */
+#undef MBEDTLS_PSA_BUILTIN_GET_ENTROPY
+#define MBEDTLS_PSA_DRIVER_GET_ENTROPY
+#endif
+
+#if defined( __vita__ ) || defined( __SWITCH__ )
+/* Upstream has no Vita/NSW support; compat.c fills in */
+#define MBEDTLS_PLATFORM_MS_TIME_ALT
+#endif
+
+#undef MBEDTLS_FS_IO
+#undef MBEDTLS_PSA_ITS_FILE_C
+#undef MBEDTLS_PSA_CRYPTO_STORAGE_C
+#undef MBEDTLS_SELF_TEST
+#undef MBEDTLS_HMAC_DRBG_C
+#undef MBEDTLS_LMS_C
+#undef MBEDTLS_NIST_KW_C
+#undef MBEDTLS_PKCS5_C
+
+#undef PSA_WANT_ALG_CCM
+#undef PSA_WANT_ALG_CCM_STAR_NO_TAG
+#undef PSA_WANT_ALG_CBC_NO_PADDING
+#undef PSA_WANT_ALG_CBC_PKCS7
+#undef PSA_WANT_ALG_CFB
+#undef PSA_WANT_ALG_CMAC
+#undef PSA_WANT_ALG_CTR
+#undef PSA_WANT_ALG_ECB_NO_PADDING
+#undef PSA_WANT_ALG_OFB
+#undef PSA_WANT_ALG_STREAM_CIPHER
+#undef PSA_WANT_ALG_JPAKE
+#undef PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
+#undef PSA_WANT_ALG_TLS12_PSK_TO_MS
+#undef PSA_WANT_ALG_FFDH
+#undef PSA_WANT_ALG_PBKDF2_HMAC
+#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
+#undef PSA_WANT_KEY_TYPE_PASSWORD
+#undef PSA_WANT_KEY_TYPE_PASSWORD_HASH
+#undef PSA_WANT_ALG_SHA3_224
+#undef PSA_WANT_ALG_SHA3_256
+#undef PSA_WANT_ALG_SHA3_384
+#undef PSA_WANT_ALG_SHA3_512
+#undef PSA_WANT_ALG_SHAKE128
+#undef PSA_WANT_ALG_SHAKE256
+#undef PSA_WANT_ALG_SHA_224
+#undef PSA_WANT_ALG_SHA_1
+#undef PSA_WANT_ALG_MD5
+#undef PSA_WANT_ALG_RIPEMD160
+#undef PSA_WANT_KEY_TYPE_ARIA
+#undef PSA_WANT_KEY_TYPE_CAMELLIA
+#undef PSA_WANT_ECC_BRAINPOOL_P_R1_256
+#undef PSA_WANT_ECC_BRAINPOOL_P_R1_384
+#undef PSA_WANT_ECC_BRAINPOOL_P_R1_512
+#undef PSA_WANT_ECC_SECP_K1_256
+#undef PSA_WANT_ECC_MONTGOMERY_448
+#undef PSA_WANT_ECC_SECP_R1_521
+#undef PSA_WANT_DH_RFC7919_2048
+#undef PSA_WANT_DH_RFC7919_3072
+#undef PSA_WANT_DH_RFC7919_4096
+#undef PSA_WANT_DH_RFC7919_6144
+#undef PSA_WANT_DH_RFC7919_8192
+#undef PSA_WANT_KEY_TYPE_DH_KEY_PAIR_BASIC
+#undef PSA_WANT_KEY_TYPE_DH_KEY_PAIR_EXPORT
+#undef PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE
+#undef PSA_WANT_KEY_TYPE_DH_KEY_PAIR_IMPORT
+#undef PSA_WANT_KEY_TYPE_DH_PUBLIC_KEY
+#undef PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT
+#undef PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT
+#undef PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
+#undef PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
+#undef PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
+#undef MBEDTLS_PEM_WRITE_C
+#undef MBEDTLS_PK_WRITE_C
+#undef MBEDTLS_PK_PARSE_EC_COMPRESSED
+#undef MBEDTLS_PK_PARSE_EC_EXTENDED
+#undef MBEDTLS_ASN1_WRITE_C
+
+#endif /* XASH_PSA_CONFIG_H */

3rdparty/opus/wscript

@@ -23,6 +23,17 @@ int main (void) {
 	int * array = alloca(foo);
 }'''
 
+FRAGMENT_LRINT='''#include <math.h>
+#include <stdlib.h>
+int main (int argc, char **argv) {
+	return lrint%s((%s)atof(argv[1]));
+}'''
+
+# assuming MSVC always enables NEON
+FRAGMENT_NEON='''#if !defined __ARM_NEON__ && !defined _MSC_VER
+#error
+#endif'''
+
 def options(opt):
 	pass
 
@@ -31,15 +42,61 @@ def configure(conf):
 		conf.fatal('Can\'t find opus submodule. Run `git submodule update --init --recursive`.')
 		return
 
+	if conf.check_cc(fragment=FRAGMENT_LRINT % ('', 'double'), msg = 'Checking for C99 lrint', use = 'M', mandatory = False):
+		conf.define('HAVE_LRINT', 1)
+
+	if conf.check_cc(fragment=FRAGMENT_LRINT % ('f', 'float'), msg = 'Checking for C99 lrintf', use = 'M', mandatory = False):
+		conf.define('HAVE_LRINTF', 1)
+
 	# Check for C99 variable-size arrays, or alloca() as fallback
 	if conf.check_cc(fragment=FRAGMENT_VLA, msg = 'Checking for C99 VLA support', mandatory = False):
 		conf.define('VAR_ARRAYS', 1)
 	elif conf.check_cc(fragment=FRAGMENT_ALLOCA_H, msg = 'Checking for alloca in alloca.h header', mandatory = False):
 		conf.define('USE_ALLOCA', 1)
 		conf.define('HAVE_ALLOCA_H', 1)
-	elif conf.check_cc(fragmenmt=FRAGMENT_STDLIB_H, msg = 'Checking for alloca.h in stdlib.h', mandatory = False):
+	elif conf.check_cc(fragment=FRAGMENT_STDLIB_H, msg = 'Checking for alloca.h in stdlib.h', mandatory = False):
 		conf.define('USE_ALLOCA', 1)
 
+	if conf.env.DEST_CPU in ['thumb', 'arm']:
+		if conf.check(header_name='arm_neon.h', mandatory = False):
+			if conf.check(fragment=FRAGMENT_NEON, msg = 'Checking if compiler enabled NEON', mandatory = False):
+				conf.env.HAVE_NEON = True
+				conf.define('OPUS_ARM_MAY_HAVE_NEON_INTR', 1)
+				conf.define('OPUS_ARM_PRESUME_NEON', 1)
+	elif conf.env.DEST_CPU.startswith('x86'):
+		if conf.check(header_name='xmmintrin.h', mandatory = False):
+			if conf.env.COMPILER_CC != 'msvc':
+				conf.env.CFLAGS += ['-msse']
+			conf.define('OPUS_X86_MAY_HAVE_SSE', 1)
+			if conf.env.DEST_SIZEOF_VOID_P > 4:
+				conf.define('OPUS_X86_PRESUME_SSE', 1)
+
+		if conf.check(header_name='emmintrin.h', mandatory = False):
+			if conf.env.COMPILER_CC != 'msvc':
+				conf.env.CFLAGS += ['-msse2']
+			conf.define('OPUS_X86_MAY_HAVE_SSE2', 1)
+			if conf.env.DEST_SIZEOF_VOID_P > 4:
+				conf.define('OPUS_X86_PRESUME_SSE2', 1)
+
+		# on x86_64 we enable both SSE and SSE2, so RTCD can be disabled (it's actually doesn't even build with RTCD enabled)
+		if conf.env.DEST_SIZEOF_VOID_P == 4:
+			if conf.check(header_name='cpuid.h', mandatory=False):
+				conf.define('CPU_INFO_BY_C', 1)
+			else:
+				conf.define('CPU_INFO_BY_ASM', 1)
+
+			conf.define('OPUS_HAVE_RTCD', 1)
+
+#		if conf.check(header_name='smmintrin.h', mandatory = False):
+#			if conf.env.COMPILER_CC != 'msvc':
+#				conf.env.CFLAGS += ['-msse4.1']
+#			conf.define('OPUS_X86_MAY_HAVE_SSE4_1', 1)
+
+#		if conf.check(header_name='immintrin.h', mandatory = False):
+#			if conf.env.COMPILER_CC != 'msvc':
+#				conf.env.CFLAGS += ['-mavx']
+#			conf.define('OPUS_X86_MAY_HAVE_AVX', 1)
+
 	# TODO: ARM/x86 intrinsics detection
 	# TODO: maybe call autotools/cmake/meson instead?
 
@@ -55,8 +112,23 @@ def build(bld):
 		'opus/src/opus_compare.c',
 		'opus/celt/opus_custom_demo.c'
 	])
-	includes = ['opus/include/', 'opus/celt/', 'opus/silk/', 'opus/silk/float/']
-	defines = ['OPUS_BUILD', 'FLOAT_APPROX', 'PACKAGE_VERSION="1.4.0"', 'CUSTOM_MODES']
+
+	includes = ['opus', 'opus/include/', 'opus/celt/', 'opus/silk/', 'opus/silk/float/']
+
+	if bld.env.DEST_CPU in ['thumb', 'arm']:
+		if bld.env.HAVE_NEON:
+			sources += bld.path.ant_glob(['opus/silk/arm/*.c', 'opus/celt/arm/*.c'])
+			includes += ['opus/silk/arm', 'opus/celt/arm']
+	elif bld.env.DEST_CPU.startswith('x86'):
+		sources += ['opus/silk/x86/x86_silk_map.c',
+			'opus/celt/x86/pitch_sse.c',
+			'opus/celt/x86/pitch_sse2.c',
+			'opus/celt/x86/vq_sse2.c',
+			'opus/celt/x86/x86_celt_map.c',
+			'opus/celt/x86/x86cpu.c']
+		includes += ['opus/silk/x86', 'opus/celt/x86']
+
+	defines = ['OPUS_BUILD', 'FLOAT_APPROX', 'PACKAGE_VERSION="1.4.0"', 'CUSTOM_MODES', 'ENABLE_HARDENING']
 
 	bld.stlib(
 		source = sources,

3rdparty/yy-thunks/wscript

@@ -0,0 +1,59 @@
+#! /usr/bin/env python
+# encoding: utf-8
+
+import hashlib
+from waflib import Task, TaskGen, Logs
+
+OBJ_NAME = 'YY_Thunks_for_WinXP.obj'
+OBJ_SHA256 = '51a13c4b667c82181d357e274a50308a273be63f5f85ae958465774857721573'
+DLL_LINKFLAGS = ['-ENTRY:DllMainCRTStartupForYY_Thunks', '-alternatename:_YY_ThunksOriginalDllMainCRTStartup@12=__DllMainCRTStartup@12']
+
+class copy_yy_thunks(Task.Task):
+	color = 'CYAN'
+	def run(self):
+		return self.outputs[0].write(self.inputs[0].read('rb'), 'wb')
+
+@TaskGen.feature('yy_thunks')
+def add_yy_thunks_obj(self):
+	src = self.path.find_node(OBJ_NAME)
+	out = self.path.find_or_declare(OBJ_NAME)
+	self.compiled_tasks = [self.create_task('copy_yy_thunks', src, out)]
+
+@TaskGen.feature('cshlib', 'cxxshlib')
+@TaskGen.after_method('process_use')
+def apply_yy_thunks_dll(self):
+	if 'yy_thunks' not in self.to_list(getattr(self, 'use', [])):
+		return
+
+	try:
+		self.bld.get_tgen_by_name('yy_thunks')
+	except Exception:
+		return
+	self.env.append_value('LINKFLAGS', DLL_LINKFLAGS)
+
+def options(opt):
+	pass
+
+def configure(conf):
+	if conf.env.DEST_OS != 'win32' or conf.env.COMPILER_CC != 'msvc':
+		return
+
+	if conf.env.MSVC_TARGETS[0] not in ['amd64_x86', 'x86']:
+		return
+
+	obj = conf.path.find_node(OBJ_NAME)
+	if not obj:
+		Logs.warn('YY-Thunks: %s not found, XP compatibility disabled' % OBJ_NAME)
+		return
+
+	with open(obj.abspath(), 'rb') as f:
+		digest = hashlib.sha256(f.read()).hexdigest()
+
+	if digest != OBJ_SHA256:
+		conf.fatal('%s checksum mismatch: expected %s, got %s' % (OBJ_NAME, OBJ_SHA256, digest))
+
+	conf.env.YY_THUNKS = True
+
+def build(bld):
+	if bld.env.YY_THUNKS:
+		bld(name='yy_thunks', features='yy_thunks')

CONTRIBUTING.md

@@ -29,10 +29,11 @@
 
 * This project uses mixed Quake's and HLSDK's C/C++ code style convention. 
 * In short:
-  * Use spaces in parenthesis.
+  * Use spaces in parenthesis, but not when two parentheses are consecutive.
   * Only tabs for indentation.
   * Any brace must have it's own line.
   * Short blocks, if statements and loops on single line are allowed.
+  * Prefer generic utilities from libpublic over rolling your own.
   * Avoid magic numbers.
   * While macros are powerful, it's better to avoid overusing them.
   * If you unsure, try to mimic code style from anywhere else of engine source code.
@@ -45,3 +46,8 @@
   Tags can be any: subsystem, simple feature name or even just a filename, without extension.
   Just keep them always same, it helps keep history clean and commit messages short.
 
+## LLM-based tools usage.
+
+While we wouldn't recommend using any LLM-based (also misleadingly called AI) tools, we understand that they are here to stay.
+
+Whether you're reporting bug or contributing the code, you take complete authorship and responsibility over provided content and the same rules will apply to you as for everybody else, so validate the bug report or the patch before sending it.

Documentation/api/README.md

@@ -1,5 +0,0 @@
-# Welcome to the GoldSource API docs
-
-This documentation is an attempt on explaining inner workings of Valve's Half-Life (R) engine, also known as GoldSource, from programmer's perspective. A deep knowledge of Quake (NQ, QW and Q2) engines is required.
-
-Everything discussed here is it's author assumption based on studying Xash3D source code and reverse engineering Half-Life mods. Xash3D API extensions is out of scope of this document and will be explained separately.

Documentation/api/client/01-init.md

@@ -1,20 +0,0 @@
-# Initializing client.dll
-
-`client.dll` has got multiple ways of initialization during it's life but we will go through the simplest and the most common route here.
-
-Here we expect that reader has knowledge of loading dynamic shared objects on their platform. On Windows it's done through `LoadLibrary`/`GetProcAddress`/`FreeLibrary` functions, on POSIX-complaint systems it's done through `dlopen`/`dlsym`/`dlclose` functions.
-
-## client.dll lifetime
-
-`client.dll` is expected to be loaded during client initialization and unloaded on client shutdown. Essentially, in non-dedicated builds, it always exists during the engine lifetime. Judging by the API, it might look like `client.dll` might be safely unloaded and loaded again, for example for implementing classic `Change Game` functionality from WON versions of Half-Life, but in practice it's nearly impossible to do this clean in standard and portable manner. If you want to implement changing games, consider using `execv`-like functions.
-
-## client.dll exported functions
-
-The first thing you should do, is to acquire pointers to all exported functions, which you can find in the next chapter. Some of them are optional, and might not present in the `client.dll`, and will be labeled as such.
-
-## client.dll initialization process
-
-1. The first function you call is `Initialize` function, which lets `client.dll` to store a copy of an engine API functions.
-2. Since SDK 2.0, `client.dll` have player movement code in it, which you must initialize through `HUD_PlayerMoveInit` function. `client.dll` might want to override player hulls, which can be grabbed with `HUD_GetHullBounds` function.
-3. HUD functionality must be started up with `HUD_Init` function and can be de-initialized with `HUD_Shutdown` export function.
-4. And finally, SDK 2.1 brings studio model renderer, which has separate set of API functions, which must be initialized with `HUD_GetStudioModelInterface` function.

Documentation/api/client/02-exports.md

@@ -1,286 +0,0 @@
-# List of client.dll exported functions
-
-### `int Initialize( cl_enginefuncs_t *enginefuncs, int version )`
-
-> [!IMPORTANT]
-> This function is only called once.
-
-Called after loading DLL and exports engine API to the `client.dll`.
-* `enginefuncs` must be set to a pointer to a struct filled with engine function pointers, it will be described in next chapters.
-* `version` must be always set to `7`. (HLSDK 1.0 uses version `6`, and is binary incompatible with `7`).
-Return value: `0` on error, otherwise success.
-
-### `void HUD_PlayerMoveInit( struct playermove_s *ppmove, int server )`
-
-> [!IMPORTANT]
-> This function is only called once.
-
-Called on player movement prediction initialization, before HUD. In GoldSrc, engine only runs prediction loop, the players physics are implemented in `client.dll`.
-* `ppmove` must be set to a pointer to a client instance of player movement structure, which also exports it's own API and will be discussed in the next chapters.
-* `server` must be always set to `0` on client side.
-This function is called only once.
-
-### `void HUD_Init( void )`
-
-> [!IMPORTANT]
-> This function is only called once.
-
-Called to initialize the HUD. At this moment engine should be ready to register new commands, console variables and user messages. No rendering or loading graphics done at this moment.
-
-### `int HUD_GetStudioModelInterface( int version, struct r_studio_interface_s **ppinterface, struct engine_studio_api_s *pstudio )`
-
-> [!IMPORTANT]
-> This function is only called once.
-
-This function is called after initializing HUD and exports studio model interface to the `client.dll`.
-* `version` must be always set to `1`.
-* `ppinterface` will be set by `client.dll` to a pointer to `r_studio_interface_s` structure.
-* `pstudio` must be set to a pointer to `engine_studio_api_s` structure. The studio model interface will be discussed in the next chapters.
-Return value: `0` on error, otherwise success.
-
-### `void HUD_Shutdown( void )`
-
-> [!IMPORTANT]
-> This function is only called once.
-
-Called at client shutdown.
-
-### `int HUD_GetHullBounds( int hull, vec3_t mins, vec3_t maxs )`
-
-> [!IMPORTANT]
-> This function is only called once.
-
-Called by the engine after `HUD_PlayerMoveInit` to let `client.dll` override hull bounds used for in player movement prediction.
-
-* `hull` is the hull index (0: player standing, 1: player crouched, 2: point hull, 3: large hull).
-* `mins` will contain hull mins.
-* `maxs` will contain hull maxs.
-Return value: if 0, don't override this hull and stop reading, non-zero means hull is valid _and_ there is more.
-
-> [!NOTE]
-> This function is broken in most implementations. It might return non-zero value, but don't write anything to the `mins` and `maxs` vectors, so be prepared to have some default values.
-
-### `int HUD_VidInit( void )`
-
-Called when client receives `svc_serverdata` message. It is called before any parsing of that message is done, thus the state is preserved from the previous connection. It lets `client.dll` to re-initialize graphics, if required. At this point, engine is expected to have video subsystem running, but no rendering is done here.
-
-### `int HUD_Redraw( float flTime, int intermission )`
-
-Called each frame to redraw the HUD. Only 2D is drawn here.
-* `flTime` must be set to `cl.time`, i.e. synchronized with server.
-* `intermission` must be set to `1` during intermission (set through `svc_intermission` message), otherwise it's set to `0`.
-Return value: ignored.
-
-### `void HUD_Reset( void )`
-
-Called on demo recording or playback start and stop.
-
-### `int HUD_UpdateClientData( client_data_t *cdata, float flTime )`
-
-Called each frame after taking input.
-* `cdata` contains pointer to `client_data_t` structure, populated by engine.
-* `flTime` must be set to `cl.time`, i.e. synchronized with server.
-Return value: if non-zero, will override engine viewangles and FOV value.
-
-### `void HUD_PlayerMove( struct playermove_s *pmove, int server )`
-
-When prediction is enabled, use this function to run player movement prediction. Note that this correlates to QW/Q2's prediction mechanism. It does not include weapon prediction.
-
-* `pmove` is a pointer to playermove object
-* `server` must be always set to `0`
-
-### `char HUD_PlayerMoveTexture( char *name )`
-
-Not used in the engine.
-
-### `int HUD_ConnectionlessPacket( const netadr_t *from, const char *args, char *response_buffer, int *response_buffer_size )`
-
-Called by the engine on unknown connectionless packets. Lets `client.dll` and `server.dll` have custom query protocol.
-
-* `from` is set to network address where this packet is coming from.
-* `args` raw network buffer, minus the connectionless packet header (0xFFFFFFFF).
-* `response_buffer` set by `client.dll` if there is a response.
-* `response_buffer_size` is initialized by the engine with buffer maximum size. Set by `client.dll` if there is a response.
-Return value: non-zero if handled.
-
-### `void HUD_Frame( double time )`
-
-Called each frame after sending command to the remote server. No rendering is normally done in this function.
-
-* `time` is the local delta time between previous and this frame (i.e. `host.frametime`)
-
-### `void HUD_PostRunCmd( struct local_state_s *from, struct local_state_s *to, usercmd_t *cmd, int runfuncs, double time, unsigned int random_seed )`
-
-Always called after `HUD_PlayerMove`, even if movement prediction is disabled. Used for weapon prediction stuff.
-
-* `from` is a pointer to `local_state_s` object of the previous predicted frame
-* `to` is a pointer to `local_state_s` object of this current frame
-* `cmd` is current user command
-* `runfuncs` is set to `1` if this frame was never predicted before, and to `0` if it is being predicted again
-* `random_seed` is set to `incoming_acknowledged` plus number of predicted frames starting with `1`. This way it's synchronized between client and server.
-
-### `int HUD_Key_Event( int down, int key, const char *current_binding )`
-
-Called on keyboard event.
-
-* `down` is set to `1` if key is being pressed or set to `0` on being released.
-* `key` is set to the key number. The key IDs are predefined.
-* `current_binding` is set to a null-terminated string with commands bound to this key
-Return value: `0` if `client.dll` wants engine to ignore that key.
-
-### `int HUD_AddEntity( int type, struct cl_entity_s *ent, const char *modelname )`
-
-Called before adding entity to the rendering list.
-
-* `type` is set to an entity type, see `entity_state_t::entityType`
-* `ent` is a pointer to `cl_entity_t` object.
-* `modelname` is a null-terminated string with that entity model name.
-Return value: `0` if `client.dll` wants engine to not draw this entity.
-
-### `void HUD_CreateEntities( void )`
-
-Called each frame after all network entities (including players) are linked to let `client.dll` spawn client-side entities.
-
-### `void HUD_StudioEvent( const struct mstudioevent_s *event, const struct cl_entity_s *ent )`
-
-Studio models have events tied to the frame, on which engine calls this function.
-
-* `event` is a pointer to a studio event object
-* `ent` is a pointer to a client entity object
-
-### `void HUD_TxferLocalOverrides( struct entity_state_s *state, const struct clientdata_s *client )`
-
-When client processes entity updates, for local client it might be truncated, don't have enough precision, miss some critical info, so engine calls this function as `client.dll` might choose to use client data came from `svc_clientdata` message. Note that it is called on raw, non-interpolated networked entity state.
-
-* `state` is a pointer to the local client entity state coming from the network
-* `client` is a pointer to local client data object
-
-### `void HUD_ProcessPlayerState( struct entity_state_s *dst, const struct entity_state_s *src )`
-
-When client processes entity updates, it calls this function for player entities as `client.dll` might want to override some data or fill the missing parts, but usually it just copies from `src` to `dst`.
-
-* `src` is a target pointer to the player entity data (stored in frames, for example)
-* `dst` is a source pointer to the player entity data coming from network
-
-### `void HUD_TxferPredictionData( struct entity_state_s *ps, const struct entity_state_s *pps, struct clientdata_s *pcd, const struct clientdata_s *ppcd, struct weapon_data_s *wd, const weapon_data_s *pwd )`
-
-When client receives `svc_clientdata` message, this function is called before any parsing is done, so that the `client.dll` fills in data from prediction.
-
-* `ps`, `pcd`, `wd` are pointers to current network frame data.
-* `pps`, `ppcd`, `pwd` are pointers to predicted frame data.
-
-### `void HUD_TempEntUpdate( double frametime, double client_time, double cl_gravity, TEMPENTITY **ppTempEntFree, TEMPENTITY **ppTempEntActive, int ( *AddVisibleEntity )( cl_entity_t *pEntity ), void ( *TempEntPlaySound)( TEMPENTITY *pTemp, float damp ))`
-
-Called each frame after network entities are processed and after `HUD_CreateEntities`, to let `client.dll` process temporary entities logic.
-
-* `frametime` is the delta between `cl.time` and `cl.oldtime`, i.e. server time.
-* `client_time` is `cl.time`
-* `gravity` is the synchronized gravity value from the server
-* `ppTempEntFree` is a pointer to the head of linked list of free temp entities
-* `ppTempEntActive` is a pointer to the head of linked list of active temp entities
-* `AddVisibleEntity` is a pointer to function that lets `client.dll` add this entity to the rendering list.
-* `TempEntPlaySound` is a pointer to function that's called by `client.dll` when temp entity needs to play predefined hit sound. The `damp` argument of this argument only makes sound to NOT play, if it's zero or negative.
-
-### `void HUD_DrawNormalTriangles( void )`
-
-Called each rendering frame to let `client.dll` draw custom solid triangles through TriAPI or direct OpenGL calls.
-
-### `void HUD_DrawTransparentTriangles( void )`
-
-Called each rendering frame to let `client.dll` draw custom transparent triangles through TriAPI or direct OpenGL calls.
-
-### `struct cl_entity_s *HUD_GetUserEntity( int index )`
-
-Called by engine when beam start/end indices are negative, thus allowing attaching beams to a temporary or client-only entity.
-
-* `index` is the fixed up entity index, as beam start/end indices encode real entity index in low 12 bits (i.e. `beament_start & 0xFFF`).
-
-### `void Demo_ReadBuffer( int size, unsigned char *buffer )`
-
-Called by engine on demo playback, if `client.dll` saved some custom data on demo recording prior.
-
-* `size` is the size of buffer in bytes
-* `buffer` is the pointer to custom data stored by `client.dll` in demo
-
-### `void CAM_Think( void )`
-
-Called each frame before rendering starts to let `client.dll` run custom camera logic, like advanced thirdperson follow camera for example.
-
-### `int CL_IsThirdPerson( void )`
-
-Returns non-zero value if camera is in thirdperson mode, lets engine figure out whether add local client entity to the rendering list or not.
-
-### `void CL_CameraOffset( vec3_t offset )`
-
-Not used in the engine.
-
-### `void CL_CreateMove( float frametime, usercmd_t *cmd, int active )`
-
-Called when `usercmd_t` is being created to let `client.dll` record user commands before they are being sent over the network.
-
-* `frametime` is the delta time between previous and current frames.
-* `cmd` is the pointer to `usercmd_t` object, where player's intentions and impulses are added.
-* `active` is set to `1` when client is finished signing on to the server (as movement commands are being sent even if client is not fully spawned yet).
-
-### `void IN_ActivateMouse( void )`
-
-Called from similarly named NQ/QW function.
-
-### `void IN_DeactivateMouse( void )`
-
-Called from similarly named NQ/QW function.
-
-### `void IN_MouseEvent( int mstate )`
-
-Called from similarly named NQ/QW function.
-
-### `void IN_Accumulate( void )`
-
-Called from similarly named NQ/QW function.
-
-### `void IN_ClearStates( void )`
-
-Called from similarly named NQ/QW function.
-
-### `void V_CalcRefdef( struct ref_params_s *params )`
-
-Called each frame before rendering starts. This is close to the similarly named function found in NQ/QW and lets `client.dll` to run custom view logic.
-
-* `params` is the refdef parameters object. It is also used as return value and might request from the engine to not draw anything (by `onlyClientDraws` field) or to run this multiple times (by `nextview` field)
-
-### `kbutton_t *KB_Find( const char *name )`
-
-Called by engine to find extra keys and their state.
-
-Only few are really used by the engine:
-* `in_mlook` for mouse look
-* `in_jlook` for joystick look
-* `in_graph` for net_graph toggle
-
-Return value: returns pointer to `kbutton_t` if found. `kbutton_t` structure matches the same structure that can be found in NQ and QW.
-
-### `void HUD_DirectorMessage( int size, void *buf )`
-
-> [!IMPORTANT]
-> This function is optional.
-
-Called to notify `client.dll` about an `svc_director` message. This feature is used for HLTV, though mods use it to spawn text messages or execute commands (bypassing `svc_stufftext` filter in old `client.dll`) but `svc_director` message structure isn't enforced by engine, so it in theory mods might modify it for their own needs.
-
-* `size` is the size of the payload
-* `buf` raw `svc_director` payload
-
-### `void HUD_VoiceStatus( int entindex, qboolean talking )`
-
-> [!IMPORTANT]
-> This function is optional.
-
-Called to notify `client.dll` about a client status of using voice chat.
-* `entindex` an entity index (client index plus one, because zero is always world). When set to -1, notifies `client.dll` about local client recording. When set to -2, notifies `client.dll` about a loopback (i.e. local client's voice message was sent to server and received back)
-* `talking` if true, this client is talking
-
-### `void HUD_ChatInputPosition( int *x, int *y )`
-
-> [!IMPORTANT]
-> This function is optional.
-
-When called, returns desired X and Y positions of chat box.

Documentation/api/client/README.md

@@ -1,9 +0,0 @@
-# What is client.dll in GoldSource?
-
-One of technical differences a programmer working with Quake engine might notice is the client.dll file. Historically, it appeared somewhere in between Alpha 0.52 and NetTest1 development and judging by Half-Life SDK 1.0 was meant to handle HUD rendering. The time moved forward, SDK 2.0 finalized `client.dll` API at version 7, added an in-game UI, custom input processing, player movement and weapon prediction, very basic rendering through TriAPI. SDK 2.1 added ability to re-define studio model rendering, and so on.
-
-It somewhat resembles `cgame` module from Quake 3, but more crudely designed and sometimes feels like an afterthought, considering how many engine internal structures it exposes and the main point of incompatibilities with mods, which these days sometimes use `client.dll` as a way to inject custom rendering into the game.
-
-In this document I will try to go through each step, letting you, dear reader, implement your own GoldSrc compatible API in your Quake fork, targetting vanilla Half-Life `client.dll` from latest update, which at the time of writing, is 25-th anniversary update.
-
-Despite that we call it `client.dll`, since SDK 2.4 (unofficial naming, it's the first SDK Valve published on GitHub) it is considered portable and only has SDL2 and VGUI libraries in it's external dependences. It's only called this way to avoid possible misunderstandings with engine developers, who might interpret client as `cl_` prefixed part of Quake engine.

Documentation/api/client/xx-structs.md

@@ -1,120 +0,0 @@
-# `client.dll` shared structs and enums
-
-GoldSource exposes a lot of structs to `client.dll`. Some of them are specific to `client.dll` and only used for passing data between engine and client, some of them are used in the engine everywhere, but still exposed in the public SDK. However, many mods rely on internal structs as well, and I will try to shed light on them as well.
-
-When implementing them in C, consider the default to 32-bit systems alignment of 4 bytes and ILP32 data type model.
-
-This file won't have API structs, for that, there should be separate chapters.
-
-## Enums
-
-### Entity types enum
-
-This enum has no real name.
-
-| Value | Description     |
-|-------|-----------------|
-| `0`   | Normal entities |
-| `1`   | Players         |
-| `2`   | Temp entities   |
-| `3`   | Beams           |
-| `4`   | Fragmented entities. |
-
-### edict->solid
-
-It matches QuakeWorld definition.
-
-## `client_data_t`
-
-Used only to pass data to `client.dll` through `HUD_UpdateClientData`.
-
-| Type     | Name          | Description                                                  |
-|----------|---------------|--------------------------------------------------------------|
-| `vec3_t` | `origin`      | Local client origin. Cannot be changed by `client.dll` here. |
-| `vec3_t` | `viewangles`  | Local client viewangles. This and next fields can be changed by `client.dll` |
-| `int`    | `iWeaponBits` | Bit vector of weapons held by client.                        |
-| `float`  | `fov`         | Local client's field of view.                                |
-
-## `netadr_t`
-
-Matches Quake-2 structure with the similar name.
-
-## `local_state_t`
-
-Only consists of another structs. All of these structs are used to store prediction data, so one `local_state_t` for each predicted frame.
-
-| Type                | Name          | Description                          |
-|---------------------|---------------|--------------------------------------|
-| `entity_state_t`    | `playerstate` | Contains local player's entity state |
-| `clientdata_t`      | `client`      | Additional information about local client. _Do not get confused with `client_data_t`, note the underscore._ |
-| `weapon_data_t[64]` | `weapondata`  | Array of 64 predictable weapons.     |
-
-## `entity_state_t`
-
-This structure is similar to the one that can be found in QW, but contains much more data, though most of these fields are not used by the engine, but might be used by mods.
-
-| Type        | Name           | Description                                          |
-|-------------|----------------|------------------------------------------------------|
-| `int`       | `entityType`   | Entity type (see entity type enum above)             |
-| `int`       | `number`       | Index of this entity on the server                   |
-| `float`     | `msg_time`     | Server time at which this entity had been updated    |
-| `int`       | `messagenum`   | `parsecount` at which this entity had been updated   |
-| `vec3_t`    | `origin`       | Non-interpolated entity position                     |
-| `vec3_t`    | `angles`       | Non-interpolated entity angles                       |
-| `int`       | `modelindex`   | Server model index                                   |
-| `int`       | `sequence`     | Model animation sequence                             |
-| `int`       | `frame`        | Model animation frame                                |
-| `int`       | `colormap`     | Texture's top and bottom colors, like Quake          |
-| `short`     | `skin`         | Texture number                                       |
-| `short`     | `solid`        | `edict->solid` enum                                  |
-| `int`       | `effects`      | Bitmask of entity effects                            |
-| `float`     | `scale`        | Entity scale value                                   |
-| `byte`      | `eflags`       | |
-| `int`       | `eflags`       | |
-| `int`       | `eflags`       | |
-| `color24`   | `eflags`       | |
-| `int`       | `eflags`       | |
-| `int`       | `eflags`       | |
-| `float`     | `eflags`       | |
-| `float`     | `eflags`       | |
-| `int`       | `eflags`       | |
-| `byte[4]`   | `eflags`       | |
-| `byte[4]`   | `eflags`       | |
-| `vec3_t`    | `eflags`       | |
-| `vec3_t`    | `eflags`       | |
-| `vec3_t`    | `eflags`       | |
-| `vec3_t`    | `maxs`       | |
-| `int`   | `eflags`       | |
-| `int`   | `eflags`       | |
-| `float`   | `eflags`       | |
-| `float`   | `eflags`       | |
-| `int`   | `eflags`       | |
-| `int`   | `eflags`       | |
-| `int`   | `eflags`       | |
-| `qboolean` | `eflags`       | |
-| `int`   | `eflags`       | |
-| `int`   | `eflags`       | |
-| `vec3_t`   | `eflags`       | |
-| `int`   | `eflags`       | |
-| `int`   | `eflags`       | |
-| `int`   | `eflags`       | |
-| `int`   | `eflags`       | |
-| `float`    | `eflags`       | |
-| `float`    | `eflags`       | |
-| `int`   | `eflags`       | |
-| `vec3_t`   | `eflags`       | |
-| `vec3_t`   | `eflags`       | |
-| `float`    | `eflags`       | |
-| `float`    | `eflags`       | |
-| `int`   | `iuser1`       | Few more extra fields for mods |
-| `int`   | `iuser2`       | |
-| `int`   | `iuser3`       | |
-| `int`   | `iuser4`       | |
-| `float`   | `fuser1`       | |
-| `float`   | `fuser2`       | |
-| `float`   | `fuser3`       | |
-| `float`   | `fuser4`       | |
-| `vec3_t`   | `vuser1`       | |
-| `vec3_t`   | `vuser2`       | |
-| `vec3_t`   | `vuser3`       | |
-| `vec3_t`   | `vuser4`       | |

Documentation/development/engine-porting-guide.md

@@ -22,7 +22,7 @@ The other yet unsupported configuration is the big endian.
 
 2) Open `public/build.h` file. Add appropriate checks for your operating system and/or CPU architecture. It shouldn't be hard.
 
-Also, you'll need to build [Half-Life SDK](https://github.com/FWGS/hlsdk-xash3d/). It has same `public/build.h` so reflect changes into it. Note that to be compatible with HLSDK proprietary license, it's relicensed as public domain under [Unlicense](https://unlicense.org).
+Also, you'll need to build [Half-Life SDK](https://github.com/FWGS/hlsdk-portable/). It has same `public/build.h` so reflect changes into it. Note that to be compatible with HLSDK proprietary license, it's relicensed as public domain under [Unlicense](https://unlicense.org).
 
 We have a library naming scheme that allows us and game creators to distribute binaries for different platforms in one archive. Read `Documentation/extensions/library-naming.md` for more information.
 

Documentation/development/setting-up-qt-creator.md

@@ -0,0 +1,103 @@
+## Setting up Xash3D FWGS in Qt Creator
+
+### Intro
+
+Most versions of Qt Creator support using `compile_commands.json` as a project
+file and Waf supports generating this file in a compliant format. In this
+tutorial we will leverage that features.
+
+The tutorial is written using Qt Creator 18.0, but I urge you to use whatever
+latest Qt Creator version is available, as it's often has important bug fixes.
+
+### Step 1. Configure the build.
+
+`compile_commands.json` file, as it can be guessed from it's name, contains
+every command used to invoke compiler during build. As the build process
+depends on the build configuration, we have to configure it first. I'm not
+going to get into details here, as basics of compiling Xash3D FWGS already
+explained in `README.md`, located in repository root.
+
+Save the configure step command somewhere, as it's going to be used later.
+
+### Step 2. Generate `compile_commands.json` file.
+
+Usually, this file is located in `build` directory after a successful build.
+However, it's also possible to generate it manually by running follow command:
+
+On *nix systems:
+
+```
+$ ./waf clangdb
+```
+
+Or on Windows:
+
+```
+> waf.bat clangdb
+```
+
+### Step 3. Load the project in Qt Creator.
+
+To do this, you need to be sure that `Compilation Databases` plugin is enabled.
+As it's considered experimental, it probably needs to be enabled manually. It
+can be done in `Help` -> `About Plugins...`. Locate it in `Build Systems`
+category, put the checkbox and press `OK`. The IDE will ask for restart, so do
+this.
+
+After IDE has been restarted, you can use `File` -> `Open File or Project...`.
+Navigate to Xash3D FWGS directory, then to `build` directory and select
+`compile_commands.json` file. If everything is done correctly, IDE will ask to
+set up the project. Press `Configure Project` button, as most options there are
+usually unapplicable to us.
+
+Next IDE will show project tree, however you might not see any files. This is
+happens as Qt Creator "thinks" our project root located in `build` directory.
+Thankfully it provides a way to override this. To fix it, click with right
+mouse button on the root of project tree (it's usually called something like
+`build [master]`) and select `Change Root Directory`. In opened window choose
+Xash3D FWGS repository root and press `OK`.
+
+### Step 4. Tell IDE how to build this project.
+
+Open `Projects` on the left menu and choose `Build Settings` tab. You should
+see an empty configuration for build and clean steps. Press on `Add Build Step`
+button and choose `Custom Process Step`.
+
+In created step you should see `Command`, `Arguments` and `Working Directory`.
+
+For the command, choose the Python executable. For arguments, use configure
+command for Waf from the first step. Working directory is usually set by IDE
+to `%{buildDir}`. You need to select the upper directory, where the `waf` is
+located. To save some time, it can be specified as `%{buildDir}/../`.
+
+Add another custom step, fill it with the same command and working directory.
+For arguments use `waf build`.
+
+Below you should see `Clean steps`. Create a clean step the same way, fill the
+arguments and working directory as usual, for arguments use `waf clean`.
+
+### Step 5. Tell IDE how to copy built binaries.
+
+Now select `Deploy Settings` tab. Press `Add Deploy Step` -> `Custom Process
+Step`. Again, same command and working directory. In arguments field type:
+`waf install --destdir="<here put where Xash binaries should be copied to>"`.
+
+### Step 6. Finally, set up Qt Creator to run the engine.
+
+Select the `Run Settings` tab. Below you might see familiar text fields:
+`Executable`, `Command line arguments` and `Working directory`.
+
+For working directory click on `Browse...` button and select the folder where
+Xash3D executable will be copied to, from previous step.
+
+For executable type `./xash3d` if you're on *nix or `xash3d.exe` if you're on
+Windows. The command line arguments are the same you use to run the engine. Can
+be empty as well, but I personally use `-dev 2 -log` for extra verbosity.
+
+### Outro
+
+At this moment, you should be able to press `Run` button, wait until build
+finishes and see running Xash3D FWGS. On Windows to use the debugger you might
+need the `CDB` debugger and appropriate `qtcreatorcdbext` binary for debugging
+32-bit applications and a separate for 64-bit, but that's left as an exercise
+for the reader and a potential improvement for this document.

Documentation/donate.md

@@ -2,23 +2,34 @@
 
 On this page you can find links where you can support each developer individually, who has provided public sponsorship information.
 
-### [a1batross](https://github.com/a1batross)
+## [a1batross](https://github.com/a1batross)
 
-* Initial Xash3D SDL2/Linux port author, Xash3D FWGS engine maintainer, creator of non-commercial Flying With Gauss organization.
-* Boosty page: https://boosty.to/a1ba
+Initial Xash3D SDL2/Linux port author, Xash3D FWGS engine maintainer, creator of non-commercial Flying With Gauss organization.
 
-### [nekonomicon](https://github.com/nekonomicon)
+* [Boosty page](https://boosty.to/a1ba)
 
-* [hlsdk-portable](https://github.com/FWGS/hlsdk-portable), [mdldec](../utils/mdldec), [opensource-mods.md](opensource-mods.md) maintainer and Xash3D FWGS [contributor](https://github.com/FWGS/xash3d-fwgs/commits?author=nekonomicon) (*BSD/clang port, PNG support, etc).
-* Boosty page: https://boosty.to/nekonomicon
+## [nekonomicon](https://github.com/nekonomicon)
 
-### [Velaron](https://github.com/Velaron)
-* [cs16-client](https://github.com/Velaron/cs16-client) & [tf15-client](https://github.com/Velaron/tf15-client) maintainer and Xash3D FWGS [contributor](https://github.com/FWGS/xash3d-fwgs/commits?author=Velaron) (Android port, voice chat, etc).
-* BuyMeACoffee page: https://www.buymeacoffee.com/velaron
+[hlsdk-portable](https://github.com/FWGS/hlsdk-portable), [mdldec](../utils/mdldec), [opensource-mods.md](opensource-mods.md) maintainer and Xash3D FWGS [contributor](https://github.com/FWGS/xash3d-fwgs/commits?author=nekonomicon) (*BSD/clang port, PNG support, etc).
 
-### [SNMetamorph](https://github.com/SNMetamorph)
-* [PrimeXT](https://github.com/SNMetamorph/PrimeXT) & [GoldSrc Monitor](https://github.com/SNMetamorph/goldsrc-monitor) maintainer and Xash3D FWGS [contributor](https://github.com/FWGS/xash3d-fwgs/commits?author=SNMetamorph) (Windows port, voice chat, etc).
-* BTC: `16GAzK3qei5AwBW7sggXp3yNcFHBtdpxXj`
-* ETH (ERC20): `0xb580eeca9756e3881f9d6d026e28db28eb72a383`
-* USDT (ERC20): `0xb580eeca9756e3881f9d6d026e28db28eb72a383`
-* USDC (ERC20): `0xb580eeca9756e3881f9d6d026e28db28eb72a383`
+* [Boosty page](https://boosty.to/nekonomicon)
+
+## [Velaron](https://github.com/Velaron)
+
+[cs16-client](https://github.com/Velaron/cs16-client) & [tf15-client](https://github.com/Velaron/tf15-client) maintainer and Xash3D FWGS [contributor](https://github.com/FWGS/xash3d-fwgs/commits?author=Velaron) (Android port, voice chat, etc).
+
+* [Boosty page](https://boosty.to/velaron)
+
+## [SNMetamorph](https://github.com/SNMetamorph)
+
+[PrimeXT](https://github.com/SNMetamorph/PrimeXT) & [GoldSrc Monitor](https://github.com/SNMetamorph/goldsrc-monitor) maintainer and Xash3D FWGS [contributor](https://github.com/FWGS/xash3d-fwgs/commits?author=SNMetamorph) (Windows port, voice chat, etc).
+
+* [Boosty page](https://boosty.to/snmetamorph)
+* [Other donation methods](https://snmetamorph.github.io/donate)
+
+## [$_Vladislav](https://github.com/Vladislav4KZ)
+
+[YaPB Project](https://github.com/yapb) member and [contributor](https://github.com/yapb/yapb/commits?author=Vladislav4KZ) ([Docs](https://github.com/yapb/docs), [Nav Graphs](https://github.com/yapb/graph), [RU translation](https://github.com/yapb/yapb/blob/master/cfg/addons/yapb/conf/lang/ru_lang.cfg)), Xash3D FWGS [tester](https://github.com/FWGS/xash3d-fwgs/issues?q=is%3Aissue%20state%3Aopen%20author%3AVladislav4KZ) and [contributor](https://github.com/FWGS/xash3d-fwgs/commits?author=Vladislav4KZ) (gyro-aim support, scr-parser, etc.), [CS16Client](https://github.com/Velaron/cs16-client) [contributor](https://github.com/Velaron/cs16-client/commits?author=Vladislav4KZ).
+
+* [Boosty page](https://boosty.to/rasstaman1337)
+* [PayPal link](https://paypal.me/rasstaman1337)

Documentation/extensions/addon-folders.md

@@ -0,0 +1,16 @@
+# Addon folders in Xash3D FWGS
+
+Xash3D FWGS supports both GoldSource-style addon folders and has few own. Each directory can have it's own archives that will be mounted with lower priority than directory itself.
+
+Below is the mounts map, in order of precedence from least important to most important.
+
+|--------------------|------|
+| Directory          | Note |
+|--------------------|------|
+| `$game/downloaded` | Always added. Used to store server downloads.|
+| `$game`            | This is the game directory.  |
+| `$game/custom`     | Always added. Used for user modifications content. |
+| `$game_hd`         | Added with `fs_mount_hd` set to non-zero value. Used for high definition content, similar to GoldSrc.. |
+| `$game_addon`      | Added with `fs_mount_addon` set to non-zero value. Used for user modifications content, similar to GoldSrc. |
+| `$game_lv`         | Added with `fs_mount_lv` set to non-zero value. Used for low-violence content, similar to GoldSrc. |
+| `$game_$language`  | Added with `fs_mount_l10n` set to non-zero value. Language is controlled with `ui_language` cvar or `-language` command line switch. Used for localization content, similar to GoldSrc. |

Documentation/extensions/library-naming.md

@@ -42,3 +42,6 @@ Issue #3: Some mods (like The Specialists, Tyrian, ...) already apply suffixes _
 Resolution: On x86 on **Win/Lin/Mac**, don't change anything. Otherwise, strip the _i?86 part and follow the usual scheme.
 
 See discussion: https://github.com/FWGS/xash3d-fwgs/issues/39
+
+Issue #4: When distributing game libraries on Android inside an APK, they couldn't be loaded.
+Resolution: Enable `useLegacyPackaging` option in build.gradle, when distributing games in APK. Always force game libraries to have `lib` prefix on Android, regardless if they are packaged in APK or not..

Documentation/extensions/litwater.md

@@ -0,0 +1,19 @@
+## Lightmapped water
+
+Xash3D FWGS supports lightmapped water, as an extension. It adds three new cvars and new worldspawn key values.
+
+### For level designers:
+
+If you're a level designer and intend to make your level to have lightmapped water, you can put these keyvalues to worldspawn entity description (always first entity in entities list):
+
+| Key                    | Value   | Description |
+| ---------------------- | ------- | ----------- |
+| `_litwater`            | integer | Set to any non-zero value to enable lightmapped water. Overrides `gl_litwater_force` cvar value. |
+| `_litwater_minlight`   | integer | Minimal lightmap value water surface will receive. Helps to avoid too dark areas when water isn't properly lit. If not set, defaults to zero. |
+| `_litwater_scale`      | float   | Scales up lightmap value for water surfaces. If not set, defaults to 1.0. |
+
+### For players:
+
+Some of the maps already have computed lightmap for water surfaces and sometimes water has been properly lit but the support hasn't been declared by the level designer.
+
+As a player, you can enable it in `Video options` menu or through console with `gl_litwater_force` cvar. There are also `gl_litwater_minlight` and `gl_litwater_scale` cvars that function similar to keys above. The default values has been set to `192` and `1.25` respectively to slightly avoid issues with maps that wasn't intended to have lightmapped water.

Documentation/extensions/native-object.md

@@ -16,6 +16,7 @@ Only these objects are guaranteed to be available on all targets.
 |-------------|-----------|
 | `VFileSystem009` | Provides C++ interface to filesystem, binary-compatible with Valve's VFileSystem009. |
 | `XashFileSystemXXX` | Provides C interface to filesystem. This interface is unstable and not recommended for generic use, outside of engine internals. For more info about current version look into `filesystem.h`. |
+| `MenuFactory` | Returns a `CreateInterface` function pointer (`pfnCreateInterface_t`) for the currently loaded menu library. |
 
 #### Android-specific objects
 

Documentation/extensions/steam-broker.md

@@ -0,0 +1,139 @@
+# Steam API Broker Protocol Specification
+
+## Overview
+
+Due to proprietary nature of Steamworks SDK, it cannot be run on same amount
+of platforms supported by Xash3D FWGS, neither we can link library directly due to
+GNU GPLv3 license. 
+
+However, here comes the broker, by running it (in trusted
+network, preferrably) on a machine that has Steam client installed, the
+engine can communicate with it, acquiring needed information to log-in into
+Steam protected multiplayer servers.
+
+## Key Characteristics
+
+Broker uses a simple TCP-based binary protocol with the following properties:
+
+- Single active session per connection: once a session is activated, the broker will reject all other TCP connections until the session is terminated.
+- All messages follow a consistent structure with a header, length, and payload: this is called a "frame".
+- Stateful interactions: commands affect the session state, and certain commands are only valid in specific states.
+- Numeric parameters are encoded in little-endian format for compatibility with majority of platforms.
+---
+
+## Frame Format
+
+All communication uses a fixed frame structure:
+
+| Field | Size | Type | Description |
+|-------|------|------|-------------|
+| Header | 4 bytes | ASCII | Frame start signature |
+| Length | 2 bytes | uint16_t (LE) | Size of payload in bytes |
+| Payload | N bytes | Binary | Command string or response data |
+
+**Notes**:
+- Header must be exactly `SBRK` (`53 42 52 4B` in hexadecimal form)
+- Maximum frame size: soft limit is 4096 bytes, hard limit is 65535 bytes (due to uint16_t usage)
+
+---
+
+## Session Lifecycle
+
+```
+┌──────────────┐
+│     IDLE     │ ← Initial state, accepts new TCP connections
+└──────────────┘
+       │ sb_gamedir
+       ↓
+┌──────────────┐
+│    ACTIVE    │ ← Session established, rejecting all of other TCP connections
+└──────────────┘
+       │ sb_connect
+       ↓
+┌──────────────┐
+│    ACTIVE    │ ← Client getting auth ticket to connect to game server
+└──────────────┘
+       │ sb_disconnect
+       ↓
+┌──────────────┐
+│     ...      │ ← Client announcing disconnect from game server, could connect somewhere again
+└──────────────┘
+       │ 
+       ↓
+┌──────────────┐
+│    ACTIVE    │ ← Client shutting down game, terminating broker to reset Steam client state
+└──────────────┘
+       │ sb_terminate
+       ↓
+┌──────────────┐
+│  RESTARTING  │
+└──────────────┘
+```
+
+---
+
+## Commands
+
+All commands listed below are meant to be sent from client to broker as payload of a frame. The broker will parse the command string and respond accordingly.
+
+### Session activation
+
+Activates the session and signaling game startup.
+
+**Format**: `sb_gamedir <gamedir>`
+
+**Response**: None
+
+---
+
+### Authentication ticket request
+
+Requests authentication ticket for a game server.
+
+**Precondition**: Session must be active
+
+**Format**: `sb_connect <ip:port> <server_steamid> <secure> <challenge>`
+
+**Parameters**:
+
+| Name | Description |
+|------|------------------|
+| `<ip:port>` | Game server address (e.g., `127.0.0.1:27015`) |
+| `<server_steamid>` | Server SteamID |
+| `<secure>` | 0 = insecure, 1 = secure |
+| `<challenge>` | Random value for reply prevention |
+
+
+**Response Format**:
+
+| Field | Size | Type | Description |
+|-------|------|------|-------------|
+| Header | 11 bytes | string | `"sb_connect\n"` |
+| Challenge | 4 bytes | int32_t (LE) | Echo of challenge from request |
+| SteamID | 8 bytes | uint64_t (LE) | Client SteamID from configuration |
+| Size | 4 bytes | uint32_t (LE) | Length of ticket in bytes |
+| Ticket | N bytes | - | Authentication ticket data |
+
+---
+
+### Server disconnection announcement
+
+Notifies broker of disconnection from game server.
+
+**Precondition**: Session must be active
+
+**Format**: `sb_disconnect <ip:port> <challenge>`
+
+**Response**: None
+
+---
+
+### Session termination
+
+Signaling game shutdown to broker and resetting Steam client state.
+
+**Format**: `sb_terminate`
+
+**Response**: None
+
+---

Documentation/extensions/xrcon-protocol.md

@@ -0,0 +1,181 @@
+# XRCON Protocol Specification
+
+## Overview
+
+XRCON is a TCP-based remote console protocol implemented as a server within the engine. It provides an alternative to the legacy RCON (which operates over UDP as out-of-band packets). XRCON uses a framed binary protocol over a single persistent TCP connection, accepting at most one client at a time.
+
+Key characteristics:
+
+- Based on TCP (stream-oriented, reliable)
+- Default port is 27000
+- Maximum only one concurrent client
+- Binary framed protocol with a 12-byte header + variable-length payload
+
+
+
+## Configuration
+
+The XRCON server is controlled by two configuration variables, both restricted to privileged users:
+
+| Variable | Default | Description |
+|---|---|---|
+| `xrcon_enable` | `0` (disabled) | Master switch; when enabled, the server starts listening for connections |
+| `xrcon_address` | `127.0.0.1:27000` | Bind address and port; supports both IPv4 and IPv6. Changing this at runtime triggers a XRCON server restart (stop + rebind) |
+
+By default, XRCON binds only to localhost (`127.0.0.1`), providing a degree of access control. The server will not start listening until explicitly enabled.
+
+
+
+## Frame Format
+
+All XRCON messages are encapsulated in a framed binary format. Each frame consists of a fixed 12-byte header followed by a variable-length payload.
+
+### Header (12 bytes)
+
+| Offset | Size | Field | Description |
+|---|---|---|---|
+| 0 | 4 | Type | 4-character message type string (null-terminated, occupies 5 bytes in the structure but the 5th byte is padding) |
+| 4 | 4 | Version | Protocol version (32-bit unsigned integer, network byte order) |
+| 8 | 2 | Length | Total frame length in bytes, including the header (16-bit unsigned integer, network byte order) |
+| 10 | 2 | Handle | Handle or sequence number (16-bit unsigned integer, network byte order; currently always zero) |
+
+
+### Protocol Version
+
+The current protocol version is `0x000000D4` (212 decimal). The server also accepts `0x00D40000` for compatibility with certain third-party clients (e.g., CS2RemoteConsole).
+
+### Maximum Frame Size
+
+- Maximum payload per frame: 4096 bytes
+- Maximum total packet size (header + payload): approximately 4136 bytes
+- Receive buffer size: 4096 + 64 bytes
+- Transmit buffer size: 16384 bytes (4 × maximum frame size)
+
+### Byte Order
+
+Multi-byte integer fields (version, length, handle) are transmitted in **network byte order** (big-endian).
+
+
+
+## Message Types
+
+| Type | Direction | Description |
+|---|---|---|
+| `CMND` | Client → Server | Execute a console command |
+| `PRNT` | Server → Client | Console output / print message |
+| `CHAN` | Server → Client | Channel list (channel metadata) |
+| `AINF` | Server → Client | Application / server info |
+| `ADON` | Server → Client | Additional info / server name |
+
+### CMND — Client Command
+
+**Direction**: Client → Server
+
+Sent by the client to execute a console command on the server.
+
+| Section | Size | Description |
+|---|---|---|
+| Header | 12 bytes | Type = `"CMND"`, version, length, handle |
+| Payload | Variable | Raw command string (null-terminated) |
+
+The command string is injected into the engine's command buffer for execution. There is **no authentication** — any connected client may execute arbitrary commands.
+
+### PRNT — Server Print
+
+**Direction**: Server → Client
+
+Sent by the server to stream console output to the connected client.
+
+| Section | Size | Description |
+|---|---|---|
+| Header | 12 bytes | Type = `"PRNT"`, version, length, handle |
+| Channel ID | 4 bytes | Channel identifier (unsigned 32-bit integer; always 0 for "Console") |
+| Padding | 20 bytes | Reserved (5 × 32-bit unsigned integers, all zero) |
+| Red | 1 byte | Red color component (always 255) |
+| Green | 1 byte | Green color component (always 255) |
+| Blue | 1 byte | Blue color component (always 255) |
+| Alpha | 1 byte | Alpha / opacity component (always 255) |
+| Text | Variable | The console output text (up to 4096 bytes) |
+
+
+### CHAN — Channel List
+
+**Direction**: Server → Client
+
+Sent by the server during the initial handshake (and potentially later) to describe the available console output channels.
+
+| Section | Size | Description |
+|---|---|---|
+| Header | 12 bytes | Type = `"CHAN"`, version, length, handle |
+| Channel Count | 2 bytes | Number of channel records (unsigned 16-bit integer; always 1) |
+
+Each channel record (58 bytes):
+
+| Field | Size | Description |
+|---|---|---|
+| Channel ID | 4 bytes | Unique channel identifier (unsigned 32-bit integer; always 0) |
+| Unknown 1 | 4 bytes | Reserved (unsigned 32-bit integer; always 0) |
+| Unknown 2 | 4 bytes | Reserved (unsigned 32-bit integer; always 0) |
+| Default Verbosity | 4 bytes | Default verbosity level (unsigned 32-bit integer; always 5) |
+| Current Verbosity | 4 bytes | Current verbosity level (unsigned 32-bit integer; always 5) |
+| Red | 1 byte | Red color component for the channel (always 255) |
+| Green | 1 byte | Green color component (always 255) |
+| Blue | 1 byte | Blue color component (always 255) |
+| Alpha | 1 byte | Alpha component (always 255) |
+| Name | 34 bytes | Channel name string, null-padded (always `"Console"`) |
+
+Total payload size for this frame: 2 + 58 = 60 bytes.
+
+### AINF — Application Info
+
+**Direction**: Server → Client
+
+Sent by the server immediately after a client connects, before `ADON` and `CHAN`.
+
+| Section | Size | Description |
+|---|---|---|
+| Header | 12 bytes | Type = `"AINF"`, version, length, handle |
+| Payload | 77 bytes | All zeros (placeholder / reserved for structured application information) |
+
+This packet currently serves as a placeholder and contains no meaningful data. It may be extended in future versions to carry structured metadata about the server application.
+
+### ADON — Additional Info
+
+**Direction**: Server → Client
+
+Sent by the server immediately after `AINF` during the connection handshake.
+
+| Section | Size | Description |
+|---|---|---|
+| Header | 12 bytes | Type = `"ADON"`, version, length, handle |
+| Unknown | 2 bytes | Reserved (unsigned 16-bit integer; always 0) |
+| Name Length | 2 bytes | Length of the name string (unsigned 16-bit integer) |
+| Name | Variable | Server name / identifier string (e.g., `"HLDS"`) |
+
+This packet carries the server application name, which is a short string identifying the server type (e.g., `"HLDS"` for Half-Life Dedicated Server).
+
+
+
+## Security
+
+XRCON has **no built-in authentication or encryption**. There is no password validation or transport-layer security. Any client that can establish a TCP connection to the XRCON port has full command execution access to the engine console.
+
+The only security measures are:
+
+1. **Default localhost binding**: The server binds to `127.0.0.1` by default, accepting connections only from the local machine.
+2. **Disabled by default**: The `xrcon_enable` variable defaults to `0`, so the server does not listen unless explicitly enabled.
+3. **Privileged variables**: Both configuration variables are restricted to privileged users and cannot be modified through unprivileged console commands or external access.
+
+
+
+## Comparison with Legacy RCON
+
+| Feature | XRCON | Legacy RCON |
+|---|---|---|
+| Transport | TCP (stream) | UDP (datagram, out-of-band) |
+| Port | Configurable, default 27000 | Game port (default 27015) |
+| Framing | Binary frame header | Plain text over UDP |
+| Authentication | None | Password-based |
+| Max clients | 1 | Multiple |
+| Interaction format | Full console access | Request-response only for submitted command |
+| Supported environments | Client and server | Server only |

Documentation/goldsrc-protocol-support.md

@@ -1,15 +1,18 @@
 # Support for GoldSrc network protocol
-This feature is still work-in-progress, but for now it's available for all users, and we appreciate any bug-reports and contributions around it.
-
 For connecting to GoldSrc-based servers, use this command:
 ```
 connect ip:port gs
 ```
 
-But keep in mind, there are requirement for server to be able to accept connections from Xash3D-based clients: it should use Reunion or Dproto.
-Without this requirement, you will just get "Steam validation rejected" error on connecting.
+You need to use [Steam API broker](https://github.com/FWGS/steam-broker) and have purchased Half-Life 1 on your Steam account to be able to join GoldSrc servers.
 
-That is because proper authorization with Steam API is not implemented in engine yet (but we have plans on it).
+Broker will run on your PC and will be responsible for communicating with Steam client and obtaining auth tickets.
+Also, make sure to set that broker as current ticket generator using console or edit `config.cfg` file manually:
+```
+cl_ticket_generator steam
+```
 
-Also, we encountered that some GoldSrc-based servers are recognizing Xash3D clients as "fake clients" and banning/kicking them. Maybe this problem will be
+If you want to join GoldSrc servers from other device (Android/iOS or console), make sure to set proper broker IP address with `cl_steam_broker_addr` console variable. Default value assumed that broker is running on the same device as game client.
+
+By the way, we encountered that some GoldSrc-based servers are recognizing Xash3D clients as "fake clients" and banning/kicking them. Maybe this problem will be
 solved along with better compatibility with GoldSrc behavior, but may be not - we don't know logic behind this fake client checks.

Documentation/gpl_copyright_header.h

@@ -0,0 +1,15 @@
+/*
+filename.ext - do not include this file, only copy the header
+Copyright (C) 2015-2025 Xash3D FWGS contributors
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+*/
+

Documentation/not-supported-mod-list-and-reasons-why.md

@@ -2,10 +2,19 @@
 
 |Name							|Version			|Why not working						|What was made for that
 |----							|-------			|---------------						|----------------------
-|Blue Shift						|The latest steam release	|Uses vgui2 library which xash3d does not support		|Recreated source code here: https://github.com/FWGS/hlsdk-xash3d/tree/bshift
-|Counter Strike						|1.6(The latest steam release)	|Uses vgui2 library which xash3d does not support		|Some work on vgui2 support was made here: https://github.com/FWGS/xash3d/tree/vinterface
-|Counter Strike: Condition Zero				|The latest steam release	|Uses vgui2 library which xash3d does not support		|Some work on vgui2 support was made here: https://github.com/FWGS/xash3d/tree/vinterface
-|Counter Strike: Condition Zero - Deleted scenes	|The latest steam release	|Uses vgui2 library which xash3d does not support		|Some work on vgui2 support was made here: https://github.com/FWGS/xash3d/tree/vinterface
-|Day of Defeat						|The latest steam release	|Uses vgui2 library which xash3d does not support		|Some work on vgui2 support was made here: https://github.com/FWGS/xash3d/tree/vinterface
-|Sven-Coop						|5.0+				|Uses custom GoldSrc engine					|
-
+|Area 51						|Update 1			|Uses outdated BSP31 map format and custom HLFX SDK libraries.	|You can try [this tool](https://hlfx.ru/forum/showthread.php?threadid=5250) to convert maps but there no warranty if it works.
+|Arrange Mod: Rebirth					|v150				|No idea yet.							|
+|Blue Shift						|The latest steam release	|Uses vgui2 library which xash3d does not support.		|Recreated source code here: https://github.com/FWGS/hlsdk-portable/tree/bshift.
+|Counter Strike						|Beta 6.5-			|Uses an old WON HL 1.0.0.16- interface.			|
+|							|1.4				|Has encrypted blob instead of normal client.dll.		|You can try [this tool](https://aluigi.altervista.org/papers/hldlldec.zip) to decrypt client.dll but there no warranty if it works.
+|							|1.5				|Has encrypted blob instead of normal client.dll.		|Decrypted blob here: https://csm.dev/threads/cs-1-5-client-dll-decrypted-patched-for-usage.38845.
+|							|1.6(The latest steam release)	|Uses vgui2 library which xash3d does not support.		|Some work on vgui2 support was made here: https://github.com/FWGS/xash3d/tree/vinterface. Recreated Client Source Code here: https://github.com/Velaron/cs16-client.
+|Counter Strike: Condition Zero				|The latest steam release	|Uses vgui2 library which xash3d does not support.		|Some work on vgui2 support was made here: https://github.com/FWGS/xash3d/tree/vinterface. Recreated Client Source Code here: https://github.com/Velaron/cs16-client.
+|Counter Strike: Condition Zero - Deleted scenes	|The latest steam release	|Uses vgui2 library which xash3d does not support. Uses new sequences code on engine-side that was never used in any other mods before.		|Some work on vgui2 support was made here: https://github.com/FWGS/xash3d/tree/vinterface.
+|Day of Defeat						|The latest steam release	|Uses vgui2 library which xash3d does not support.		|Some work on vgui2 support was made here: https://github.com/FWGS/xash3d/tree/vinterface.
+|Half-Life: Extended					|Day One demo			|Uses many hooks to GoldSource engine and version check.	|Just wait new version or use more old version.
+|Icon of Hell						|Beta 0.99			|Uses outdated BSP31 map format and paranoia 2 libraries.	|You can try [this tool](https://hlfx.ru/forum/showthread.php?threadid=5250) to convert maps and use Paranoia 2: The Savior 1.51 libraries but there no warranty if it works.
+|Paranoia 2: The Savior					|All builds older 1.51		|Uses an old renderer interface and engine features.		|
+|Rebellion						|1.0				|Uses an old WON HL 1.0.0.16- interface.			|Recreated source code here: https://github.com/FWGS/hlsdk-portable/tree/rebellion.
+|Sven-Coop						|5.0+				|Uses custom GoldSrc engine.					|
+|Time Shadows						|Beta 0.1			|Uses Direct3D renderer.					|

Documentation/opensource-mods.md

@@ -16,6 +16,9 @@ Mirrored on github - https://github.com/JoelTroch/am_src_rebirth
 ## Battle Grounds
 Mirrored on github - https://github.com/nekonomicon/BattleGrounds
 
+## Brain Bread
+Official github repository - https://github.com/IronOak-Studios/BrainBread
+
 ## Bubblemod
 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)
 
@@ -32,18 +35,27 @@ Version 1.9 mirrored on github - https://github.com/solidi/hl-mods/tree/master/c
 ## Cold Ice Ressurection
 Mirrored on github - https://github.com/solidi/hl-mods/tree/master/cir
 
+## Counter-Life
+Available on ModDB - https://www.moddb.com/mods/counter-life/downloads/cl-version-1-source-code
+
 ## Cthulhu
 Uploaded to github by Oleg Cherkasky - https://github.com/gunrunners-paradise/Cthulhu-HLmod-SDK
 
 ## Deathmatch Classic
 Available in Valve's Half-Life repository - https://github.com/ValveSoftware/halflife/tree/master/dmc
 
+## Delta Particles
+Available on ModDB - https://www.moddb.com/mods/half-life-delta/downloads/delta-particles-full-sources-maps-and-c-code
+
 ## Earth Special Forces
 Alpha 2.0 - https://www.gamers-desire.de/details/2830
 
 ## ESHQ
 Official github repository - https://github.com/adslbarxatov/xash3d-for-ESHQ
 
+## Feline
+Available on ModDB - https://www.moddb.com/mods/feline-10/downloads/feline-sdk
+
 ## Flat-Life
 Available on GamerLab - http://gamer-lab.com/eng/code_mods_goldsrc/Half-Life_2D_(Flat-Life)
 
@@ -58,6 +70,9 @@ Version 3.0, mirrored on github - https://github.com/nekonomicon/Go-mod30
 ## GT mod
 Available on GamerLab - http://gamer-lab.com/eng/code_mods_goldsrc/GT_mod_(Polnie_ishodniki)
 
+## Half-Force
+Available on ModDB - https://www.moddb.com/mods/half-force/downloads/half-force-v20-sdk
+
 ## Half-Life: Advanced Deathmatch
 Mirrored on github - https://github.com/solidi/hl-mods/tree/master/hla
 
@@ -70,6 +85,9 @@ Available on ModDB - https://www.moddb.com/mods/half-life-echoes
 ## Half-Life: Expanded Arsenal
 Available on ModDB - https://www.moddb.com/mods/half-life-expanded-arsenal
 
+## Half-Life: Field Intensity
+Branch **field_intensity_1.7** in halflife-featureful - https://github.com/FreeSlave/halflife-featureful/tree/field_intensity_1.7
+
 ## Half-Life: Gravgun mod
 Branch **gravgun** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/gravgun
 
@@ -91,6 +109,9 @@ Official github repository - https://github.com/Fograin/hl-subsmod-ex
 ## Half-Life: Rally
 Official gitlab repository - https://gitlab.com/hlrally/src
 
+## Half-Life: RXT
+Available on ModDB - https://www.moddb.com/mods/half-life-rxt/downloads/rxt-source-code-v57
+
 ## 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
 
@@ -112,15 +133,25 @@ Official github repository - https://github.com/HeathGames/half_rats_parasomnia_
 ## Half-Screwed
 Official github repository - https://github.com/desukuran/half-screwed
 
+## Halo: GoldSource
+Available on ModDB - https://www.moddb.com/mods/halo-goldsrc/downloads/halo-gold-source-summer-2025-release-v10-sdk
+
 ## Headcrab Frenzy
 Version 1.3 on ModDB - https://www.moddb.com/mods/headcrab-frenzy/downloads/headcrab-frenzy-13-beta-source-code
 
 ## Heart of Evil
 Mirrored on github - https://github.com/nekonomicon/HeartOfEvil
 
+Mirrored on github (Includes maps and models source files) - https://github.com/malortie/heart-of-evil-source-files
+
 ## Ingram Chillin' Mod
 Official SourceForge repository - https://sourceforge.net/projects/icm-hl/
 
+## Master Sword
+Official github repository of Master Sword Classic - https://github.com/BerntA/MasterSwordClassic
+
+Official github repository of Master Sword Rebirth - https://github.com/MSRevive/MasterSwordRebirth
+
 ## MechMod
 Official github repository - https://github.com/vermagav/mechmod
 
@@ -144,6 +175,9 @@ Prealpha, mirrored on github - https://github.com/a1batross/Paranoia2_ancient
 
 Version 1.51, mirrored on github - https://github.com/a1batross/Paranoia2_original
 
+## Public Enemy
+Official github repository - https://github.com/IronOak-Studios/Public-Enemy
+
 ## Raven City
 *Unfinished mod*
 
@@ -175,6 +209,9 @@ Mirrored on code.idtech.space - https://code.idtech.space/vera/halflife-wastelan
 ## Wizard Wars
 Download page on official site - http://www.thothie.com/ww/
 
+## Wrong Door
+Available on ModDB - https://www.moddb.com/mods/wrong-door/downloads/wrong-door-sdk
+
 ## XashXT
 Mirrored on github - https://github.com/a1batross/XashXT_original
 
@@ -199,7 +236,7 @@ Branch **redempt** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tr
 OpenAG by YaLTeR - https://github.com/YaLTeR/OpenAG
 
 ## Afraid of Monsters
-malortie's recreation - https://github.com/malortie/hl-aom
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-aom
 
 Branch **aom** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/aom
 
@@ -207,17 +244,17 @@ Branch **aom** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/a
 Reverse-engineered code: branch **aomdc** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/aomdc
 
 ## Azure Sheep
-malortie's recreation - https://github.com/malortie/hl-asheep
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-asheep
 
 Reverse-engineered code: branch **asheep** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/asheep
 
 ## Big Lolly
-malortie's recreation - https://github.com/malortie/hl-biglolly
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-biglolly
 
 Branch **biglolly** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/biglolly
 
 ## Black Ops
-malortie's recreation - https://github.com/malortie/hl-blackops
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-blackops
 
 Branch **blackops** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/blackops
 
@@ -240,13 +277,16 @@ Reverse-engineered code of server part by s1lentq - https://github.com/s1lentq/R
 ## Counter Strike Online
 CSO-like Xash3D-based mod, CSMoE - https://github.com/MoeMod/CSMoE
 
+## Crack-Life
+Reverse-engineered code: branch **cracklife** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/cracklife
+
 ## Crack-Life: Campaign Mode
 Recreation by lostgamer aka nillerusr - https://github.com/LostGamerHL/crack_life
 
 Reverse-engineered code: branch **clcampaign** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/clcampaign
 
 ## Escape from the Darkness
-malortie's recreation - https://github.com/malortie/hl-eftd
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-eftd
 
 Reverse-engineered code: branch **eftd** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/eftd
 
@@ -277,7 +317,7 @@ Reverse-engineered code: branch **rebellion** in hlsdk-portable - https://github
 Branch **hl_urbicide** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/hl_urbicide
 
 ## Half-Life: Visitors
-malortie's recreation - https://github.com/malortie/hl-visitors
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-visitors
 
 Reverse-engineered code: branch **visitors** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/visitors
 
@@ -285,17 +325,17 @@ Reverse-engineered code: branch **visitors** in hlsdk-portable - https://github.
 Branch **half-secret** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/half-secret
 
 ## Night at the Office
-malortie's recreation - https://github.com/malortie/hl-nato
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-nato
 
 Branch **noffice** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/noffice
 
 ## Poke 646
-malortie's recreation - https://github.com/malortie/hl-poke646
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-poke646
 
 Reverse-engineered code: branch **poke646** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/poke646
 
 ## Poke 646: Vendetta
-malortie's recreation - https://github.com/malortie/hl-poke646-vendetta
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-poke646-vendetta
 
 Reverse-engineered code: branch **poke646_vendetta** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/poke646_vendetta
 
@@ -312,19 +352,19 @@ Branch **sewer_beta** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable
 Reverse-engineered code by Velaron - https://github.com/Velaron/tf15-client
 
 ## The Gate
-malortie's recreation - https://github.com/malortie/hl-thegate
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-thegate
 
 Reverse-engineered code: branch **thegate** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/thegate
 
 ## They Hunger
-malortie's recreation - https://github.com/malortie/hl-theyhunger
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-theyhunger
 
 Reverse-engineered code: branch **theyhunger** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/theyhunger
 
 They Hunger: Tactical - https://www.moddb.com/mods/they-hunger-tactical/downloads/tht-source-code-documentation
 
 ## Times of Troubles
-malortie's recreation - https://github.com/malortie/hl-tot
+malortie's recreation - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-tot
 
 Branch **tot** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/tot
 
@@ -342,11 +382,14 @@ Deathmatch Quaked - https://www.moddb.com/games/deathmatch-classic/downloads/dmq
 
 Branch **dmc** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/dmc
 
+## Delta Particles
+Branch **delta_particles** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/delta_particles
+
 ## Half-Life: Echoes
 Branch **echoes** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/echoes
 
 ## Half-Life: Invasion
-Port to HLSDK 2.4 by malortie - https://github.com/malortie/hl-invasion
+Port to HLSDK 2.4 by malortie - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-invasion
 
 Port to Linux by fmoraw - https://github.com/fmoraw/hlinvasion
 
@@ -365,7 +408,7 @@ Port to Linux - https://github.com/fmoraw/NS
 Version 1.2: branch **sohl1.2** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/sohl1.2
 
 ## Swiss Cheese Halloween 2002
-Just more playable version by malortie - https://github.com/malortie/hl-shall
+Just more playable version by malortie - https://github.com/HL1-Mods-Reimplementations-and-Ports/hl-shall
 
 Branch **halloween** in hlsdk-portable - https://github.com/FWGS/hlsdk-portable/tree/halloween
 

Documentation/ports.md

@@ -22,6 +22,7 @@ Table is sorted by status and platform.
 | PSVita          | Supported                  | @fgsfdsfgs               |
 | Switch          | Supported                  | @fgsfdsfgs               |
 | Windows         | Supported                  | @a1batross, @SNMetamorph |
+| iOS             | Supported                  | @ksagameng2              |
 | DOS4GW          | Orphaned                   | N/A                      | Haven't been confirmed to work for a very long time
 | Haiku           | Orphaned                   | N/A                      | Was added by #478 and #483
 | IRIX            | Orphaned                   | N/A                      | Undone, compiles but requires big endian port
@@ -35,4 +36,3 @@ Table is sorted by status and platform.
 | Emscripten      | Old Engine                 | N/A                      | 
 | 3DS             | Old Engine fork            | N/A                      | [GitHub Repository](https://github.com/masterfeizz/Xash3DS)
 | Oculus Quest    | Old Engine fork            | N/A                      | [GitHub Repository](https://github.com/DrBeef/Lambda1VR)
-| iOS             | Deprecated                 | N/A                      | See GitHub issue #61

Documentation/protocol/01-introduction.md

@@ -0,0 +1,11 @@
+# Xash3D FWGS protocol support
+
+Xash3D FWGS currently supports four network protocols:
+* Version 49, introduced in Xash3D in around 2018.
+* Version 48, used in Xash3D FWGS 0.19 and earlier. Deprecated and to be removed in the future.
+* GoldSrc version 48, used in current GoldSource version.
+* Quake version 15, only used for demo playback for Quake Wrapper mod.
+
+On the server side, we only support Xash3D 49 protocol, but bugcomp `gsmrf` mode can convert GoldSrc 48 messages into Xash3D 49 on the fly, for some mods that directly write engine internal messages.
+
+In the following documents we will only cover version 49, as everything else is either not Xash3D specific or deprecated.

Documentation/protocol/02-connectionless.md

@@ -0,0 +1,366 @@
+# Xash3D 49 connectionless protocol
+
+Connectionless protocol defines four common message sources and destinations, they can be:
+* `S` for Server
+* `C` for Client
+* `M` for Master
+* `A` for Anything else
+
+All connectionless packets have `\xff\xff\xff\xff` (32-bit integer set to all ones) in it's header. Let's go through each of possible direction in this document.
+
+<!--TOC-->
+
+- [Any](#any)
+  - [Any to Any](#any-to-any)
+    - [`A2A_PING` and `A2A_GOLDSRC_PING`](#a2a_ping-and-a2a_goldsrc_ping)
+    - [`A2A_ACK` and `A2A_GOLDSRC_ACK`](#a2a_ack-and-a2a_goldsrc_ack)
+    - [Deprecated queries](#deprecated-queries)
+      - [`A2A_NETINFO`](#a2a_netinfo)
+      - [`A2A_INFO`](#a2a_info)
+  - [Any to Client](#any-to-client)
+    - [`A2C_PRINT` and `A2C_GOLDSRC_PRINT`](#a2c_print-and-a2c_goldsrc_print)
+  - [Any to Server and Server to Any](#any-to-server-and-server-to-any)
+    - [GoldSrc server queries](#goldsrc-server-queries)
+    - [`A2S_GOLDSRC_INFO`](#a2s_goldsrc_info)
+    - [`A2S_GOLDSRC_PLAYERS`](#a2s_goldsrc_players)
+    - [`A2S_GOLDSRC_RULES`](#a2s_goldsrc_rules)
+  - [Any to Master](#any-to-master)
+    - [`S2M_SCAN_REQUEST`](#s2m_scan_request)
+  - [Master to Any](#master-to-any)
+    - [`M2A_SERVERSLIST`](#m2a_serverslist)
+- [Master and game server](#master-and-game-server)
+  - [Server to Master](#server-to-master)
+    - [`S2M_HEARTBEAT`](#s2m_heartbeat)
+    - [`S2M_SHUTDOWN`](#s2m_shutdown)
+    - [`S2M_INFO`](#s2m_info)
+  - [Master to Server](#master-to-server)
+    - [`M2S_CHALLENGE`](#m2s_challenge)
+    - [`M2S_NAT_CONNECT`](#m2s_nat_connect)
+- [Client and game server](#client-and-game-server)
+  - [Client to Server](#client-to-server)
+    - [`C2S_BANDWIDTHTEST`](#c2s_bandwidthtest)
+    - [`C2S_GETCHALLENGE`](#c2s_getchallenge)
+    - [`C2S_CONNECT`](#c2s_connect)
+  - [Server to Client](#server-to-client)
+    - [`S2C_BANDWIDTHTEST`](#s2c_bandwidthtest)
+    - [`S2C_CHALLENGE`](#s2c_challenge)
+    - [`S2C_CONNECTION`](#s2c_connection)
+    - [`S2C_ERRORMSG`](#s2c_errormsg)
+    - [`S2C_REJECT`](#s2c_reject)
+
+<!--TOC-->
+
+## Any
+
+### Any to Any
+
+#### `A2A_PING` and `A2A_GOLDSRC_PING`
+
+Simple ping message.
+* Request, in ASCII: `ping` or `i` in GoldSrc format
+* Response is always `A2A_ACK` or `A2A_GOLDSRC_ACK`
+
+#### `A2A_ACK` and `A2A_GOLDSRC_ACK`
+
+Simple ack message.
+* Request, in ASCII: `ack` or `j` in GoldSrc format
+* Response: none
+
+#### Deprecated queries
+
+These text-based Xash protocol queries are deprecated in favor of [GoldSrc server queries](#goldsrc-server-queries), which Xash3D FWGS servers implement as well. New implementations must not send them. The server still responds to `A2A_INFO` for compatibility with older clients, `A2A_NETINFO` is not handled anymore.
+
+##### `A2A_NETINFO`
+
+Used to implement Half-Life's NetAPI. 
+* Request message, in ASCII: `netinfo <version> <context> <request_id>`
+  - `version` must be 49, as text.
+  - `context` can be any 32-bit signed integer value, encoded as text.
+  - `request_id` see `common/net_api.h`
+
+* Response message, in ASCII: `netinfo <context> <request_id> <response>`
+  - `context` same as in request.
+  - `request_id` same as in request.
+  - `response` is server's response, depending on request type. Always encoded as Quake info string.
+
+Possible requests and response formats:
+* Request ID `1` will make server respond with empty response string. 
+* Request ID `2` makes server respond with all server game rule cvars where the key is cvar name and the value is cvar value. One additional key `rules` with total amount of cvars is added.
+* Request ID `3` makes server respond with players list, where:
+  - `p<id>name` is set to player's name
+  - `p<id>frags` is set to player's kill count
+  - `p<id>time` is set to player's total play time
+  - `players` is total player's list.
+  - Alternatively, it can respond with `neterror` set to `forbidden` if server does not wish to expose it's player list.
+* Request ID `4` makes server to respond with common game details:
+  - `hostname` is server's name
+  - `gamedir` is game directory name
+  - `current` is total player count
+  - `max` is max players limit
+  - `map` is server's current level
+* On any other server will respond with `neterror` set to `undefined`
+* If protocol version doesn't match, server responds with `neterror` set to `protocol`
+
+##### `A2A_INFO`
+
+Used to request server's details.
+* Request message, in ASCII: `info <version>`
+  - `version` must be 49, as text
+* Response message, in ASCII: `info\n<response>`
+  - `response` is Quake info string, otherwise it's an error message.
+
+* Response info string format:
+  - `p` is set to protocol version (FWGS extension)
+  - `map` is server's current level
+  - `dm` set to 1 if current game mode is deathmatch otherwise 0
+  - `team` set to 1 if current game mode includes teamplay otherwise 0
+  - `coop` set to 1 if current game mode is cooperative otherwise 0
+  - `numcl` is total player count
+  - `maxcl` is max players limit
+  - `gamedir` is game directory name
+  - `password` set to 1 if server is protected with password otherwise 0
+  - `host` is server's name
+
+### Any to Client
+
+#### `A2C_PRINT` and `A2C_GOLDSRC_PRINT`
+
+Simple print message.
+* Header: `\xff\xff\xff\xff`
+* Request, in ASCII: `print <message>` or `l<message>` in GoldSrc format.
+* Response: none
+
+### Any to Server and Server to Any
+
+#### GoldSrc server queries
+
+These match Source Engine Query messages used in GoldSrc and Source engine and implemented for compatibility with existing server browsers and monitoring tools. The client uses them to query GoldSrc servers in the server browser, and as text-based Xash protocol queries are [deprecated](#deprecated-queries), it will use them to query Xash servers as well. Read documentation for them on VDC: https://developer.valvesoftware.com/wiki/Server_queries
+
+Unlike other connectionless messages these are binary: integers are little-endian, floats are 32-bit IEEE 754 and strings are null-terminated.
+
+`A2S_GOLDSRC_PLAYERS` and `A2S_GOLDSRC_RULES` requests carry a 32-bit challenge, `A2S_GOLDSRC_INFO` may have one appended after the query string. When no challenge is known yet, `\xff\xff\xff\xff` is sent in it's place. The server may answer with a challenge instead of the data: byte `A` (`0x41`) followed by a 32-bit challenge value, 9 bytes total with the header. The request is then repeated with the received challenge. Don't confuse this message with textual `S2C_GOLDSRC_CHALLENGE` used during connection, they only share the first byte.
+
+Responses that don't fit into a single packet (usually rules) come from GoldSrc servers split into fragments. Such packets start with `\xfe\xff\xff\xff` instead of `\xff\xff\xff\xff`, followed by a 32-bit sequence number, same in all fragments of one response, and a byte with total fragment count in the lower 4 bits and this fragment's index in the upper 4 bits. Fragment payloads concatenated in index order form a normal `\xff\xff\xff\xff` message. Xash servers never split query responses and send them as single datagrams.
+
+#### `A2S_GOLDSRC_INFO`
+
+Used to request server's details.
+
+* Request: `TSource Engine Query\0`, optionally followed by a 32-bit challenge. Xash servers ignore it.
+* Response: byte `I` (`S2A_GOLDSRC_INFO`), followed by:
+  - byte: protocol version, 48 on GoldSrc, 49 on Xash3D FWGS
+  - string: server's name
+  - string: server's current level
+  - string: game directory name
+  - string: game description
+  - int16: Steam AppID, always 0 on Xash servers
+  - byte: total player count, bots included
+  - byte: max players limit
+  - byte: bot count
+  - byte: server type, `d` for dedicated or `l` for listen server
+  - byte: server's operating system, `w` for Windows, `l` for Linux, `m` for macOS
+  - byte: set to 1 if server is protected with password otherwise 0
+  - byte: set to 1 if server is VAC secured, Xash servers put the `secure` value from gameinfo here
+  - string: server's version
+
+Same as the Source engine response format but without the extra data flag and its fields.
+
+Legacy GoldSrc servers respond with the obsolete `m` format (`S2A_GOLDSRC_LEGACY_INFO`) instead, see VDC for its layout. Xash servers never send it but the client understands it and assumes protocol 48.
+
+#### `A2S_GOLDSRC_PLAYERS`
+
+Used to request server's player list.
+
+* Request: byte `U` (`0x55`), then a 32-bit challenge.
+* Response: byte `D` (`S2A_GOLDSRC_PLAYERS`), followed by a byte with total player count, then for each player:
+  - byte: player's index. Xash servers send sequential indexes starting from 0, GoldSrc servers always send 0 here.
+  - string: player's name
+  - int32: player's kill count
+  - float: time in seconds the player is connected, -1.0 for bots on Xash servers
+
+Xash server doesn't respond at all if the player list is empty, the server is protected with password or exposing the player list is disabled with `sv_expose_player_list` cvar.
+
+#### `A2S_GOLDSRC_RULES`
+
+Used to request server's game rules.
+
+* Request: byte `V` (`0x56`), then a 32-bit challenge.
+* Response: byte `E` (`S2A_GOLDSRC_RULES`), followed by an int16 with total rule count, then rule name and rule value strings for each.
+
+Only server cvars (`FCVAR_SERVER`) are sent. Values of protected cvars (`FCVAR_PROTECTED`) are replaced with `1` if the value is set otherwise `0`. If there are no cvars to expose, server doesn't respond at all.
+
+### Any to Master
+
+#### `S2M_SCAN_REQUEST`
+
+* Request: `1<region><IP:Port>\0<info>`
+  - Format of this message is loosely based on https://developer.valvesoftware.com/wiki/Master_Server_Query_Protocol
+  - `info` however adds few additional fields:
+    - `clver` set to engine's version
+    - `nat` set to 1 to filter only servers behind NAT and tell master to notify servers about scan
+    - `commit` set to engine's build commit hash
+    - `branch` set to engine's build branch
+    - `os` set to which operating system engine has been built
+    - `arch` set to which CPU architecture engine has been built
+    - `buildnum` set to engine's build number
+    - `key` set to random 32-bit value formatted as hex, used to validate master responses
+* Response: `M2A_SERVERSLIST`
+
+### Master to Any
+
+#### `M2A_SERVERSLIST`
+
+* Request: `f\xff<key><reserved><IP:Port>...`
+  - `key` is random 32-bit value set in `S2M_SCAN_REQUEST`
+  - `reserved` is single reserved 8-bit byte
+  - Following is list of IP addresses in binary form: 6-bytes for IPv4 address + port and 18-bytes for IPv6 address + port
+  - If port is 0, it means the end of list, otherwise it's the last IP used for pagination (not implemented in Xash3D)
+* Response: client doesn't make response to master server but might request `A2S_GOLDSRC_INFO` from servers
+
+## Master and game server
+
+### Server to Master
+
+#### `S2M_HEARTBEAT`
+
+Used to update game server information on the master server.
+
+* Request: `q\xff<heartbeat challenge>`
+  - `heartbeat challenge` is random 32-bit value, used to prevent faked/forged source IP addresses.
+* Response: `M2S_CHALLENGE`
+
+#### `S2M_SHUTDOWN`
+
+Used to notify master server about server shutdown, but due to security reasons must be ignored by any master implementation.
+
+* Request: `\x62\x0a`
+* Response: none
+
+#### `S2M_INFO`
+
+Game server info response on `M2S_CHALLENGE`.
+
+* Request: `0\n<info>`
+  - `info` is Quake info string containing server information passed to master server. It contains following fields:
+    - `protocol` is always 49
+    - `challenge` is master challenge
+    - `players` is total player count, without bots
+    - `max` is max players limits
+    - `bots` is total bot count
+    - `gamedir` is set to game directory
+    - `map` is server's current level
+    - `type` set to `d` for dedicated or `l` for listen server
+    - `password` set to `1` if server protected with password set otherwise `0`
+    - `os` always `w`
+    - `secure` always `0`
+    - `lan` always `0`
+    - `version` engine version
+    - `region` always `255`
+    - `product` same as `gamedir`
+    - `nat` set to `1` if server is behind NAT
+* Response: none
+
+### Master to Server
+
+#### `M2S_CHALLENGE`
+
+Master's respoonse on game server's heartbeat message.
+
+* Request: `s<master challenge><heartbeat challenge>`
+  - `master challenge` contains 32-bit value, used in server response to prevent faked/forged source IP addresses.
+  - `heartbat challenge` cotnains 32-bit value, used in heartbeat request to prevent faked/forged source IP addresses.
+* Response: `S2M_INFO`.
+
+#### `M2S_NAT_CONNECT`
+
+Master server's message with client IP address and port, used in NAT punching.
+
+* Request: `c <IP:Port>`
+* Response: `S2C_INFO` to a specified client address.
+
+## Client and game server
+
+### Client to Server
+
+#### `C2S_BANDWIDTHTEST`
+
+Used to figure out network MTU. The message is optional and server might choose to not implement it or respond with challenge.
+
+* Request, in ASCII: `bandwidth <version> <max_size>`
+  - `version` must be 49, as text.
+  - `max_size` is requested maximum packet size.
+
+* Possible responses:
+  - `S2C_BANDWIDTHTEST`
+  - `S2C_CHALLENGE`
+  - `A2A_PRINT` followed by `S2C_REJECT`
+  - `S2C_ERRORMSG` (as FWGS extension) followed by `A2A_PRINT` and `S2C_REJECT`.
+
+#### `C2S_GETCHALLENGE`
+
+Used to validate client's address to prevent faked/forged source IP addresses.
+
+* Header: `\xff\xff\xff\xff`
+* Request, in ASCII: `getchallenge steam`
+  - `steam` argument is optional and can be ignored by the server, as it's only kept for compatibility with similar GoldSrc 48 message.
+
+* Possible responses:
+  - `S2C_CHALLENGE`
+
+#### `C2S_CONNECT`
+
+Used to build a connection with the server.
+
+* Header: `\xff\xff\xff\xff`
+* Request, in ASCII: `connect <version> <challenge> "<protinfo>" "<userinfo>"`
+  - `version` must be 49, as text.
+  - `challenge` must be challenge value, as text.
+  - `protinfo` is a Quake info string, containing protocol extensions and other connection information.
+    - `uuid` is this client's unique ID (FWGS extension) hasheed with MD5.
+    - `qport` is random integer value from 1 to 65535, unique for this engine run.
+    - `ext` is an integer value OR'ed with requested protocol extensions. Currently only extension is `NET_EXT_SPLITSIZE` with the value of `1`, which tells server to split messages based on `cl_dlmax` value from `userinfo`. 
+  - `userinfo` contains initial user info, encoded as Quake info string.
+* Possible responses:
+  - `A2A_PRINT` followed by `S2C_REJECT`
+  - `S2C_ERRORMSG` (as FWGS extension) followed by `A2A_PRINT` and `S2C_REJECT`.
+  - `S2C_CONNECTION`
+
+### Server to Client
+
+#### `S2C_BANDWIDTHTEST`
+
+* Request: `testpacket<crc><blob>`
+  - `crc` is 32-bit CRC of `blob`
+  - `blob` random data
+* There is no required response to this message
+
+Total message size doesn't exceed request max size.
+
+#### `S2C_CHALLENGE`
+
+* Request, in ASCII: `challenge <value>`
+  - `value` is challenge value that client must include in it's response
+* Response: `C2S_CONNECT`
+
+#### `S2C_CONNECTION`
+
+* Request, in ASCII: `client_connect <protinfo>`
+  - `protinfo` is an optional Quake info string, contains following optional fields:
+     - `ext` is an integer value OR'ed with allowed protocol extension. Bit fields match requested in `ext` field in `C2S_CONNECT`
+     - `cheats` set to 1 if server allows cheats otherwise 0
+* Response: there is no out of band from the client but client will proceed to building netchan and switch client-server interaction to it.
+
+#### `S2C_ERRORMSG`
+
+Show client error message. Doesn't mean connection reject, only used for UI.
+
+* Request, in ASCII: `errormsg <message>`
+  - `message` contains error message
+* Response: none
+
+#### `S2C_REJECT`
+
+Client has been rejected in connection.
+
+* Request, in ASCII: `disconnect`
+* Response: client can cope, get depressed or mentally tell server to fuck off.

Documentation/protocol/03-netchan.md

@@ -0,0 +1,3 @@
+# Xash3D 49 netchan protocol
+
+TBD...

Documentation/protocol/http-server-list.md

@@ -0,0 +1,72 @@
+# Static HTTP server list
+
+Replacement for the UDP `S2M_SCAN_REQUEST` / `M2A_SERVERSLIST` exchange
+described in [02-connectionless.md](02-connectionless.md). Read-only HTTP,
+no NAT punching, no filtering or pagination in the request.
+
+## URL
+
+`xashcomm.lst` carries a base URL per source:
+
+```
+masterstatic http://master.example.org/server-list
+```
+
+The engine appends `/v1/servers/<gamedir>` and `GET`s the result. For
+`gamedir = valve`:
+
+```
+GET http://master.example.org/server-list/v1/servers/valve
+```
+
+Trailing slashes on the base URL are stripped. Multiple `masterstatic`
+lines are allowed; results are merged.
+
+The request is bare: no body, no auth, no cookies, no compressed encodings.
+Only the standard `User-Agent` is set. `POST` / `PUT` / `DELETE` are not
+used; servers register out of band.
+
+## Response
+
+UTF-8 text, parsed line by line. Each line is tokenized with
+`COM_ParseFileSafe` (whitespace separates, `//` and `#` start line
+comments, `"..."` quotes a token). Blank lines and comment-only lines
+are ignored. One directive per line:
+
+* `ip <address>` — Xash3D server (protocol 49).
+* `gs <address>` — GoldSrc server (protocol 48).
+
+`<address>` is parsed by `NET_StringToAdr` (`1.2.3.4:27015`,
+`[2001:db8::1]:27015`, hostnames). Port defaults to `27015`. Lines
+starting with an unknown directive are skipped entirely, so new keywords
+with any number of operands can be added without breaking older clients.
+
+`Content-Type` is not inspected, `text/plain; charset=utf-8` expected.
+
+### Example
+
+```
+# diffusion servers
+ip 192.0.2.10:27015
+ip [2001:db8::1]:27015
+gs 198.51.100.5:27015
+```
+
+A file with zero records is valid and represents an empty list.
+
+### Versioning
+
+The `/v1/` segment is fixed in this revision. A future protocol revision
+adds a sibling `/v2/...` resource without breaking older clients.
+
+## Client behaviour
+
+Each `ip` / `gs` record from the response triggers a probe to the listed
+address, identical to a server discovered through the UDP master. DNS
+errors, non-200 responses, and malformed bodies are reported to the
+console.
+
+## Server behaviour
+
+Any static HTTP server works. A typical setup is a periodic job that
+probes a set of known addresses and writes `v1/servers/<gamedir>`.

Documentation/psvita.md

@@ -2,11 +2,14 @@
 
 ### Prerequisites
 1. Make sure your PSVita is [set up to run homebrew applications](https://vita.hacks.guide/).
-2. Install [kubridge](https://github.com/TheOfficialFloW/kubridge/releases/) by copying `kubridge.suprx` to your taiHEN plugins folder (usually `ux0:/tai`) and add it to your `config.txt`, for example:
+2. Install [kubridge](https://github.com/TheOfficialFloW/kubridge/releases/). It is recommended to use kubridge version `0.1`, because other versions aren't tested, we don't know are they suitable or not.
+
+   Worth to notice, we got reports that automatic plugins management app EasyPlugin have issues with installing kubridge plugin, so it's better to install it manually: by copying `kubridge.suprx` to your taiHEN plugins folder (usually `ux0:/tai`, but could be `ur0:/tai`) and add it to your `config.txt`, for example:
    ```
    *KERNEL
    ux0:tai/kubridge.skprx
    ```
+
 3. Install `libshacccg.suprx` by following [this guide](https://cimmerian.gitbook.io/vita-troubleshooting-guide/shader-compiler/extract-libshacccg.suprx).
 
 ### Installation

Documentation/public-servers-rules-and-recommendations.md

@@ -1,15 +0,0 @@
-As online community is growing, we don't want to keep bad or invalid servers on the Internet Games list. It's a common rules for all Xash3D server owners who are using default master server. 
-
-1. Breaking master server or clients is prohibited in any way. If you found a serious bug, contact us at contact 'at' fwgs.ru or post an issue at GitHub.
-
-2. Changing settings, exploiting vulnerabilities of clients is prohibited in any way. If you found a serious bug, contact us at contact 'at' fwgs.ru or post an issue at GitHub.
-
-2. Agressive advertisement and spam on other servers is prohibited in any way.
-
-3. If your server is require downloading custom content, it should be available for everyone. Recommended way to deliver custom content is FastDL.
-
-4. It's recommended to keep your server is up-to-date. You may use our public Debian/Ubuntu/Arch Linux [repository](https://github.com/FWGS/xash3d/wiki/How-to-set-up-a-Xash3D-Dedicated-Server-on-Debian-or-Ubuntu) to simplify updating process.
-
-Just follow these rules to not get banned on our master server. Good luck, have fun!
-
-

Documentation/touch-controls.md

@@ -0,0 +1,149 @@
+# Touch controls configuring
+
+## Introduction
+
+Thanks to mittorn, we have the ability to fully customize the controls in Xash3D. The new config allows you to not only add and change control buttons, but also create custom menus. There is also a built-in visual editor available, which simplifies the customization process without the need for manual file editing.
+
+## Editor mode usage
+
+1. Launch Xash3D and start the game.
+2. To enter the edit mode, click on the gear icon (command `touch_enableedit`).
+3. In the edit mode, the grid is displayed. The number of cells can be changed with the command `touch_grid_count` (default is 50). The grid can be disabled with the command `touch_grid_enable 0`.
+
+*Touch controls layout editor*
+![](images/editor.jpg)
+
+*Touch profiles window*
+![](images/touch-profiles.jpg)
+
+*Touch buttons parameters window*
+![](images/touch-buttons.jpg)
+
+## Layout editor features
+
+* **Moving buttons**: click on a button, drag it to the desired location, and release.
+* **Resizing buttons**: place your first finger on the top left corner of the button, and use your second finger to resize it.
+* **Hiding/showing buttons**: select the button (it will turn red), then use the menu:
+    * **Close**: closes the editing mode (`touch_disableedit`).
+    * **Reset**: resets the button to its default values.
+    * **Hide/Show**: hides or shows the button (`touch_hide <name>` / `touch_show <name>`).
+
+## Working with configuration files / console
+
+All changes made in the visual editor are automatically saved to the touch profile file. The files are located in the `touch_profiles` folder inside game directory. The file name depends on the selected profile.
+
+### Common commands in configuration files
+
+```
+// Comment: lines starting with // are ignored.
+
+// Swipe zones for movement. Specify how far you need to swipe to speed up.
+// The default values ​​are set to be optimal for a small swipe to immediately walk quickly.
+touch_forwardzone "0.060000" ; touch_sidezone "0.060000"
+
+// Sensitivity settings (pitch - horizontal, yaw - vertical).
+touch_pitch ; touch_yaw
+
+// Grid settings (see above).
+touch_grid_count ; touch_grid_enable
+
+// Draws a border around the button.
+touch_set_stroke <thickness> <c> <v> <e> <t>
+(<r> - red; <g> - green; <b> - blue; <a> - alpha/transparency)
+
+// Show (1) or hide (0) client buttons.
+touch_setclientonly
+
+// Removes all buttons from the screen.
+touch_removeall
+
+// Shows all available buttons in the configuration file.
+touch_list
+
+// Saves the config after editing. You can specify a new file name.
+touch_config_file command.cfg
+```
+
+*The full list of buttons in the standard `touch.cfg` file, displayed in the console when using `touch_list`.*
+![](images/example2.jpg)
+
+
+## Adding new buttons
+
+To add a new button, use the console command:
+
+```
+touch_addbutton "digits" "touch/key_1.png" "toggle_digits" 0.340000 0.782222 0.400000 0.888889 255 255 255 100 0
+```
+
+### Parameters of `touch_addbutton` command
+
+| Parameter | Description |
+| --- | --- |
+| `"digits"` | Unique name of the button. |
+| `"touch/key_1.png"` | Path to the icon file (`.png` format). If the icon is not needed, leave `""`. |
+| `"toggle_digits"` | Command to execute after clicking (for example, `"buy"` for purchase). |
+| `0.340000` | X coordinate of the upper-left corner of the button. |
+| `0.782222` | Y coordinate of the upper-left corner of the button. |
+| `0.400000` | X coordinate of the lower-right corner of the button. |
+| `0.888889` | Y coordinate of the lower-right corner of the button. |
+| `255 255 255` | Button color in RGB format. |
+| `100` | Button transparency (0 - fully transparent, 255 - fully opaque). |
+| `0` | Flags (see next section). |
+
+## List of flags
+
+Flags define the behavior of the button. Their values ​​are powers of two:
+
+| Flag | Value | Description |
+| --- | --- | --- |
+| `TOUCH_FL_HIDE` | 1 | Hides the button (not displayed in the game, but visible in the editor). |
+| `TOUCH_FL_NOEDIT` | 2 | Disables editing of the button in the editor. |
+| `TOUCH_FL_CLIENT` | 4 | The button is client-side (not saved in the main control file). |
+| `TOUCH_FL_MP` | 8 | The button is displayed only in multiplayer. |
+| `TOUCH_FL_SP` | 16 | The button is displayed only in singleplayer. |
+| `TOUCH_FL_DEF_SHOW` | 32 | The button is always displayed on startup. |
+| `TOUCH_FL_DEF_HIDE` | 64 | The button is always hidden on startup. |
+| `TOUCH_FL_DRAW_ADDITIVE` | 128 | The button colors are added together in blend mode. |
+| `TOUCH_FL_STROKE` | 256 | Enables outline stroke around the button. |
+
+Flags can be combined by adding their values ​​together. For example, `5 = 1 + 4` is the combination of `TOUCH_FL_HIDE` and `TOUCH_FL_CLIENT` flags, which is a hidden client button.
+
+*In the image below, the `spray`, `scores`, `messagemode` buttons are displayed simultaneously with the flag 8 and `loadquick`, `savequick` with the flag 16, and each is displayed in the corresponding game mode.*
+![](images/example1.jpg)
+
+## Useful commands
+
+* `touch_hide <pattern>`: hides buttons by pattern.
+* `touch_setcommand`: changes the command bound to a button.
+* `touch_settexture`: quickly changes the button image.
+* `touch_setcolor`: sets the button color.
+* `touch_exportconfig`: exports the current configuration, including aspect ratio.
+
+## Usage examples
+
+* `touch_hide menu*` hides all buttons with names starting with `menu`.
+* `touch_setcolor "attack" 255 160 0 128` changes the color of the primary fire button from opaque white to translucent orange, similar to the color of the HUD in Half-Life.
+
+    *Result of executing this command*
+    ![](images/example3.jpg)
+
+* Example of adding a new button with a custom icon (the `lastinv` command is used - quick change between weapons)
+    ![](images/example4.jpg)
+
+    *View of this button in layout editor*
+    ![](images/example5.jpg)
+
+## Tips
+
+* To prevent the `look` and `move` buttons from interfering with editing other elements, place them before the others in the configuration file.
+* And vice versa, to make a button appear on top of others, place it at the end of the configuration file.
+* You can assign commands to buttons that change other buttons, see the previous section "Usage examples".
+* After editing each parameter of each individual button in the Touch Buttons section, do not forget to press Save, otherwise the applied parameters will not be saved.
+* To create your own icon for the button, you can use any graphics editor (for Android, Photo Editor by iudesk is suitable). Saving conditions:
+    * Image format - `.png` with transparency (e.g. alpha channel)
+    * Aspect ratio / size - 1:1 / 256x256
+    * Path to the icons location - `touch/gfx` inside game directory.
+    
+### Additional links
+* [Handy palette for selecting color in RGB format](https://www.rapidtables.com/web/color/RGB_Color.html)

README.md

@@ -1,6 +1,10 @@
+> [!CAUTION]
+> **Only download Xash3D FWGS from official sources.** Third-party builds, "modded launchers", "optimized" repacks and random mirrors are frequently bundled with malware, miners, spyware and credential stealers. We cannot vouch for anything we did not build. Get official binaries only from the [releases page](https://github.com/FWGS/xash3d-fwgs/releases/tag/continuous).
+
 # Xash3D FWGS Engine <img align="right" width="128" height="128" src="https://github.com/FWGS/xash3d-fwgs/raw/master/game_launch/icon-xash-material.png" alt="Xash3D FWGS icon" />
-[![builds.sr.ht status](https://builds.sr.ht/~a1batross/xash3d-fwgs.svg)](https://builds.sr.ht/~a1batross/xash3d-fwgs?) [![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)
+[![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?logo=Discord&label=International%20Discord%20chat)](http://xash.su/discord/) [![Russian speakers Telegram Chat](https://img.shields.io/badge/Russian_speakers_Telegram_chat-gray?logo=Telegram)](https://t.me/flyingwithgauss) \
+[![Download Daily Build](https://img.shields.io/badge/downloads-testing-orange)](https://github.com/FWGS/xash3d-fwgs/releases/tag/continuous)
 
 Xash3D ([pronounced](https://ipa-reader.com/?text=ks%C9%91%CA%82) `[ksɑʂ]`) 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.
 
@@ -35,15 +39,22 @@ You still needed to copy `valve` directory as all game resources located there.
 
 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.
+### Android
+0) Install the APK file.
+1) Copy `valve` directory to a folder named `xash` in the Internal storage.
+2) Run games from within the app.
+
+## Reporting issues
 * Issues are accepted in both English and Russian.
-* Before sending a PR, check if you followed our contribution guide in CONTRIBUTING.md file.
+* They are only accepted if you run legally acquired product (e.g. Half-Life in Steam).
+
+## Contributing code
+* Check the CONTRIBUTING.md file.
 
 ## Build instructions
 We are using Waf build system. If you have some Waf-related questions, I recommend you to read [Waf Book](https://waf.io/book/).
 
-NOTE: NEVER USE GitHub's ZIP ARCHIVES. GitHub doesn't include external dependencies we're using!
+**NOTE: NEVER USE GitHub's ZIP ARCHIVES. GitHub doesn't include external dependencies we're using!**
 
 ### Prerequisites
 If your CPU is x86 compatible and you're on Windows or Linux, 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.
@@ -65,24 +76,43 @@ This repository contains our fork of HLSDK and restored source code for Half-Lif
 * Only for 32-bit engine on 64-bit x86 operating system:
   * Enable i386 on your system: `$ sudo dpkg --add-architecture i386`.
   * Install `aptitude` ([why?](https://github.com/FWGS/xash3d-fwgs/issues/1828#issuecomment-2415131759)):  `$ sudo apt update && sudo apt upgrade && sudo apt install aptitude`
-  * Install development tools: `$ sudo aptitude --without-recommends install git build-essential gcc-multilib g++-multilib libsdl2-dev:i386 libfontconfig-dev:i386 libfreetype-dev:i386 libopus-dev:i386 libbz2-dev:i386`.
+  * Install development tools: `$ sudo aptitude --without-recommends install git build-essential gcc-multilib g++-multilib libsdl2-dev:i386 libfreetype-dev:i386 libopus-dev:i386 libbz2-dev:i386 libvorbis-dev:i386 libopusfile-dev:i386 libogg-dev:i386`.
   * Set PKG_CONFIG_PATH environment variable to point at 32-bit libraries: `$ export PKG_CONFIG_PATH=/usr/lib/i386-linux-gnu/pkgconfig`.
 
 * For 64-bit engine on 64-bit x86 and other non-x86 systems:
-  * Install development tools: `$ sudo apt install git build-essential python libsdl2-dev libfontconfig-dev libfreetype6-dev libopus-dev libbz2-dev`.
+  * Install development tools: `$ sudo apt install git build-essential python libsdl2-dev libfreetype6-dev libopus-dev libbz2-dev libvorbis-dev libopusfile-dev libogg-dev`.
 
 * Clone this repostory: `$ git clone --recursive https://github.com/FWGS/xash3d-fwgs`.
 
 ##### RedHat/Fedora
 * Only for 32-bit engine on 64-bit x86 operating system:
-  * Install development tools: `$ sudo dnf install git gcc gcc-c++ glibc-devel.i686 SDL2-devel.i686 opus-devel.i686 fontconfig-devel.i686 freetype-devel.i686 bzip2-devel.i686`.
+  * Install development tools: `$ sudo dnf install git gcc gcc-c++ glibc-devel.i686 SDL3-devel.i686 sdl2-compat-devel.i686 opus-devel.i686 freetype-devel.i686 bzip2-devel.i686 libvorbis-devel.i686 opusfile-devel.i686 libogg-devel.i686`.
   * Set PKG_CONFIG_PATH environment variable to point at 32-bit libraries: `$ export PKG_CONFIG_PATH=/usr/lib/pkgconfig`.
 
 * For 64-bit engine on 64-bit x86 and other non-x86 systems:
-  * Install development tools: `$ sudo dnf install git gcc gcc-c++ SDL2-devel opus-devel fontconfig-devel freetype-devel bzip2-devel`.
+  * Install development tools: `$ sudo dnf install git gcc gcc-c++ SDL3-devel sdl2-compat-devel opus-devel freetype-devel bzip2-devel libvorbis-devel opusfile-devel libogg-devel`.
 
 * Clone this repostory: `$ git clone --recursive https://github.com/FWGS/xash3d-fwgs`.
 
+#### Android (Windows/Linux/macOS)
+* Install [Android Studio](https://developer.android.com/studio) (or the command line tools).
+* Install [Python](https://python.org) (at least 2.7, latest is better).
+* Install [Git](https://git-scm.com/download/win).
+* Install [Ninja](https://ninja-build.org/).
+* Install [CMake](https://cmake.org/) (for some dependencies).
+
+* Clone this repostory: `$ git clone --recursive https://github.com/FWGS/xash3d-fwgs`.
+
+#### iOS/iPadOS
+* Install Xcode from the appstore.
+* Install [Homebrew package manager](https://brew.sh).
+
+* Install build dependencies by running: `brew install python`.
+
+* Clone the SDL2 repo `$ git clone --recursive https://github.com/libsdl-org/SDL.git -b SDL2` and compile the iOS framework by navigating to SDL/Xcode/SDL and opening the Xcode project.
+
+* Clone this repository: `$ git clone --recursive https://github.com/FWGS/xash3d-fwgs`.
+
 ### Building
 #### Windows (Visual Studio)
 0) Open command line.
@@ -99,3 +129,19 @@ If compiling 32-bit on amd64, make sure `PKG_CONFIG_PATH` from the previous step
 1) Configure build: `./waf configure` (you need to pass `-8` to compile 64-bit engine on 64-bit x86 processor).
 2) Compile: `./waf build`.
 3) Install: `./waf install --destdir=/path/to/any/output/directory`.
+
+#### Android (Windows/Linux/macOS)
+To build you should clone [SDL](https://github.com/libsdl-org/SDL) from `SDL2` branch and [HLSDK-portable](https://github.com/FWGS/hlsdk-portable) `mobile-hacks` branch repositories to 3rdparty folder, after that you should be able to open the project in Android Studio from `android` directory or manually call Gradle to build the APK.
+
+#### iOS/iPadOS (MacOS only)
+0) (optional) Examine which build options are available: `./waf --help`.
+1) Configure build: `./waf configure --ios --enable-bundled-deps --sdl2 (path/to/SDL2.framework)`, set `--ios-simulator` instead of `--ios` if you want to build for simulator.
+2) Compile `./waf build`.
+3) Navigate to `build` and copy your compiled SDL2.framework there, then add your game dylibs to `build/ios/libs/(gamedir)/(dlls/cl_dlls)`(You can also run `scripts/ios/buildhlsdk.sh` instead to automatically create an ipa with hlsdk dylibs)
+4) Run `scripts/ios/createipa.sh` to create an installable ipa
+
+### Running tests
+
+Tests are enabled with `--enable-tests` passed to `./waf configure` and can be run with `./waf --alltests`.
+
+This builds both standalone unit tests and a separate engine test binary (`xash3d_tests`) that embeds engine-level tests. The engine test binary requires no game assets.

SECURITY.md

@@ -0,0 +1,18 @@
+# Xash3D FWGS Security Policy
+
+## Supported versions
+
+Because we don't have clear release cycle yet, support is only provided to the
+latest engine versions from `master` branch. You can use `host_ver` command in
+console to fetch detailed info about the engine build.
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in this project, it can be reported
+privately though `Security` tab on GitHub:
+https://github.com/FWGS/xash3d-fwgs/security
+
+Alternatively, you can report them publicly on the `Issues` tab:
+https://github.com/FWGS/xash3d-fwgs/issues
+
+In both cases, expect a reply within approximately a week.

android/.gitignore

@@ -11,4 +11,5 @@ local.properties
 release/
 *.hprof
 .vscode/
-*.bak
+*.bak
+.kotlin/

android/app/CMakeLists.txt

@@ -1,60 +0,0 @@
-cmake_minimum_required(VERSION 3.6)
-
-# Only used to build Android project
-
-project(XASH_ANDROID)
-
-# armeabi-v7a requires cpufeatures library
-include(AndroidNdkModules)
-android_ndk_import_module_cpufeatures()
-
-find_package(PythonInterp 2.7 REQUIRED)
-
-get_filename_component(C_COMPILER_ID ${CMAKE_C_COMPILER} NAME_WE)
-get_filename_component(CXX_COMPILER_ID ${CMAKE_CXX_COMPILER} NAME_WE)
-
-if("${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
-	set(BUILD_TYPE "debug")
-else()
-	set(BUILD_TYPE "release")
-	list(APPEND WAF_EXTRA_ARGS --enable-poly-opt --enable-lto)
-endif()
-
-if(CMAKE_SIZEOF_VOID_P MATCHES "8")
-	set(64BIT ON CACHE BOOL "" FORCE)
-	list(APPEND WAF_EXTRA_ARGS -8) # only required for x86 when testing this cmakelist under linux
-endif()
-
-set(CMAKE_VERBOSE_MAKEFILE ON)
-
-set(WAF_CC "${CMAKE_C_COMPILER} --target=${CMAKE_C_COMPILER_TARGET}")
-set(WAF_CXX "${CMAKE_CXX_COMPILER} --target=${CMAKE_CXX_COMPILER_TARGET}")
-
-# not cleanest way to get upper directory
-set(ENGINE_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../")
-
-execute_process(
-	COMMAND ${CMAKE_COMMAND} -E env
-	CC=${WAF_CC} CXX=${WAF_CXX}
-	AR=${CMAKE_AR} STRIP=${CMAKE_STRIP}
-	${PYTHON_EXECUTABLE} waf configure -T ${BUILD_TYPE} ${WAF_EXTRA_ARGS} cmake
-	--check-c-compiler=${C_COMPILER_ID} --check-cxx-compiler=${CXX_COMPILER_ID}
-	-s "${ENGINE_SOURCE_DIR}/SDL" --skip-sdl2-sanity-check --enable-bundled-deps
-	WORKING_DIRECTORY "${ENGINE_SOURCE_DIR}"
-)
-
-add_subdirectory("${ENGINE_SOURCE_DIR}/3rdparty/hlsdk-portable" hlsdk-portable)
-
-# try to build minimal SDL. Enable features as we're gonna use them
-set(SDL_RENDER OFF)
-set(SDL_POWER OFF)
-set(SDL_VULKAN OFF)
-set(SDL_DISKAUDIO OFF)
-set(SDL_DUMMYAUDIO OFF)
-set(SDL_DUMMYVIDEO OFF)
-set(SDL_VULKAN OFF)
-set(SDL_OFFSCREEN OFF)
-set(SDL_STATIC OFF)
-add_subdirectory("${ENGINE_SOURCE_DIR}/3rdparty/SDL" SDL)
-add_subdirectory("${ENGINE_SOURCE_DIR}/" xash3d-fwgs)
-add_subdirectory("${ENGINE_SOURCE_DIR}/3rdparty/mainui" mainui)

android/app/build.gradle.kts

@@ -1,129 +1,155 @@
+import com.android.build.api.dsl.ApplicationExtension
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import java.time.LocalDateTime
 import java.time.Month
 import java.time.temporal.ChronoUnit
 
 plugins {
-    id("com.android.application")
-    id("org.jetbrains.kotlin.android")
+	alias(libs.plugins.android.application)
 }
 
-android {
-    namespace = "su.xash.engine"
-    ndkVersion = "27.2.12479018"
+extensions.configure<ApplicationExtension> {
+	namespace = "su.xash.engine"
+	ndkVersion = "29.0.14206865"
+	compileSdk = 35
 
-    defaultConfig {
-        applicationId = "su.xash"
-        applicationIdSuffix = "engine"
-        versionName = "0.21"
-        versionCode = getBuildNum()
-        minSdk = 21
-        targetSdk = 34
-        compileSdk = 34
+	defaultConfig {
+		applicationId = "su.xash.engine"
+		versionName = "0.21-" + getGitHash()
+		versionCode = getBuildNum()
+		minSdk = 21
+		targetSdk = 35
 
-        externalNativeBuild {
-            cmake {
-                abiFilters("armeabi-v7a", "arm64-v8a", "x86", "x86_64")
-                arguments("-DANDROID_USE_LEGACY_TOOLCHAIN_FILE=OFF")
-            }
-        }
-    }
+		buildConfigField("String", "GIT_HASH", "\"${getGitHash()}\"")
 
-    externalNativeBuild {
-        cmake {
-            version = "3.22.1"
-            path = file("CMakeLists.txt")
-        }
-    }
+		externalNativeBuild {
+			val engineRoot = projectDir.parentFile.parent
 
-    compileOptions {
-        sourceCompatibility = JavaVersion.VERSION_1_8
-        targetCompatibility = JavaVersion.VERSION_1_8
-    }
+			experimentalProperties["ninja.abiFilters"] = setOf("armeabi-v7a", "arm64-v8a", "x86")
+			experimentalProperties["ninja.path"] = File(engineRoot, "wscript").path
+			experimentalProperties["ninja.configure"] = "run-python"
+			experimentalProperties["ninja.arguments"] = setOf(
+				File(engineRoot, "scripts/configure-ninja.py").path,
+				engineRoot,
+				"--variant=\${ndk.variantName}",
+				"--abi=\${ndk.abi}",
+				"--configuration-dir=\${ndk.buildRoot}",
+				"--ndk-version=\${ndk.moduleNdkVersion}",
+				"--min-sdk-version=\${ndk.minPlatform}",
+				"--ndk-root=${androidComponents.sdkComponents.ndkDirectory.get()}",
+				// shut up, fake options
+				"-p:Configuration=\${ndk.variantName}",
+				"-p:Platform=\${ndk.abi}"
+			)
+		}
+	}
 
-    kotlinOptions {
-        jvmTarget = "1.8"
-    }
+	compileOptions {
+		sourceCompatibility = JavaVersion.VERSION_11
+		targetCompatibility = JavaVersion.VERSION_11
+	}
 
-    buildTypes {
-        debug {
-            isMinifyEnabled = false
-            isShrinkResources = false
-            isDebuggable = true
-            applicationIdSuffix = ".test"
-            proguardFiles(
-                getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro"
-            )
-        }
+	kotlin {
+		compilerOptions {
+			jvmTarget = JvmTarget.JVM_11
+		}
+	}
 
-        release {
-            isMinifyEnabled = true
-            isShrinkResources = true
-            proguardFiles(
-                getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro"
-            )
-        }
+	buildFeatures {
+		viewBinding = true
+		buildConfig = true
+	}
 
-        register("asan") {
-            initWith(getByName("debug"))
-        }
+	signingConfigs {
+		create("androidDebugKey") {
+			storeFile = File(projectDir.parentFile, "debug.keystore")
+			storePassword = "android"
+			keyAlias = "androiddebugkey"
+			keyPassword = "android"
+		}
+	}
 
-        register("continuous") {
-            initWith(getByName("release"))
-            applicationIdSuffix = ".test"
-        }
-    }
+	lint {
+		abortOnError = false
+	}
 
-    sourceSets {
-        getByName("main") {
-            assets.srcDirs("../../3rdparty/extras/xash-extras", "../moddb")
-            java.srcDir("../../3rdparty/SDL/android-project/app/src/main/java")
-        }
-    }
+/*
+	androidResources {
+		noCompress += ""
+	}
+*/
 
-    lint {
-        abortOnError = false
-    }
+	packaging {
+		jniLibs {
+			keepDebugSymbols.add("**/*.so")
+			useLegacyPackaging = true
+		}
+	}
 
-    buildFeatures {
-        viewBinding = true
-        buildConfig = true
-    }
+	sourceSets {
+		getByName("main") {
+			assets.directories.add("../../3rdparty/extras/xash-extras")
+			java.directories.add("../../3rdparty/SDL/android-project/app/src/main/java")
+		}
+	}
 
-    androidResources {
-        noCompress += ""
-    }
+	buildTypes {
+		debug {
+			isMinifyEnabled = false
+			isShrinkResources = false
+			isDebuggable = true
+			applicationIdSuffix = ".test"
+			proguardFiles(
+				getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro"
+			)
+			buildConfigField("boolean", "ENABLE_AUTO_UPDATE", "false")
+		}
 
-    packaging {
-        jniLibs {
-            useLegacyPackaging = true
-        }
-    }
+		release {
+			isMinifyEnabled = true
+			isShrinkResources = true
+			proguardFiles(
+				getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro"
+			)
+			buildConfigField("boolean", "ENABLE_AUTO_UPDATE", "false")
+		}
+
+		register("asan") {
+			initWith(getByName("debug"))
+		}
+
+		register("continuous") {
+			initWith(getByName("release"))
+			applicationIdSuffix = ".test"
+			buildConfigField("boolean", "ENABLE_AUTO_UPDATE", "true")
+			signingConfig = signingConfigs.getByName("androidDebugKey")
+		}
+	}
 }
 
 dependencies {
-    implementation("com.google.android.material:material:1.11.0")
-    implementation("androidx.appcompat:appcompat:1.6.1")
-    implementation("androidx.constraintlayout:constraintlayout:2.1.4")
-    implementation("androidx.navigation:navigation-fragment-ktx:2.7.7")
-    implementation("androidx.navigation:navigation-ui-ktx:2.7.7")
-    implementation("androidx.cardview:cardview:1.0.0")
-    implementation("androidx.annotation:annotation:1.7.1")
-    implementation("androidx.fragment:fragment-ktx:1.6.2")
-    implementation("androidx.preference:preference-ktx:1.2.1")
-    implementation("androidx.swiperefreshlayout:swiperefreshlayout:1.1.0")
-    implementation("androidx.work:work-runtime-ktx:2.9.0")
-//    implementation "androidx.legacy:legacy-support-v4:1.0.0"
+	implementation(libs.material)
 
-    implementation("com.madgag.spongycastle:prov:1.58.0.0")
-    implementation("in.dragonbra:javasteam:1.2.0")
+	implementation(libs.appcompat)
+	implementation(libs.navigation.runtime.ktx)
+	implementation(libs.navigation.fragment.ktx)
+	implementation(libs.navigation.ui.ktx)
+	implementation(libs.preference.ktx)
+	implementation(libs.swiperefreshlayout)
 
-    implementation("ch.acra:acra-http:5.11.2")
+	implementation(libs.acra.http)
 }
 
 fun getBuildNum(): Int {
-    val now = LocalDateTime.now()
-    val releaseDate = LocalDateTime.of(2015, Month.APRIL, 1, 0, 0, 0)
-    val qBuildNum = releaseDate.until(now, ChronoUnit.DAYS)
-    val minuteOfDay = now.hour * 60 + now.minute
-    return (qBuildNum * 10000 + minuteOfDay).toInt()
+	val now = LocalDateTime.now()
+	val releaseDate = LocalDateTime.of(2015, Month.APRIL, 1, 0, 0, 0)
+	val qBuildNum = releaseDate.until(now, ChronoUnit.DAYS)
+	val minuteOfDay = now.hour * 60 + now.minute
+	return (qBuildNum * 10000 + minuteOfDay).toInt()
+}
+
+fun getGitHash(): String {
+	val process = ProcessBuilder("git", "rev-parse", "--short", "HEAD").directory(project.rootDir)
+		.redirectErrorStream(true).start()
+	return process.inputStream.bufferedReader().readText().trim()
 }

android/app/proguard-rules.pro

@@ -1,3 +1,25 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile
+
 -keep class su.xash.engine.XashActivity {
     java.lang.String loadAndroidID();
     java.lang.String getAndroidID();
@@ -87,3 +109,8 @@
     void hapticRun(int, float, int);
     void hapticStop(int);
 }
+
+# Unexpected reference to missing service class: META-INF/services/javax.annotation.processing.Processor.
+-dontwarn javax.annotation.processing.Processor
+-dontwarn javax.annotation.processing.AbstractProcessor
+-dontwarn javax.annotation.processing.SupportedOptions

android/app/run-python

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+exec python $@

android/app/run-python.bat

@@ -0,0 +1 @@
+python %*

android/app/src/debug/res/values/strings.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources>
-    <string name="app_name" translatable="false">Xash3D FWGS (Test)</string>
-    <string name="authority" translatable="false">su.xash.engine.test.documents</string>
-</resources>
+	<string name="app_name" translatable="false">Xash3D FWGS (Test)</string>
+	<string name="authority" translatable="false">su.xash.engine.test.documents</string>
+</resources>

android/app/src/main/AndroidManifest.xml

@@ -1,101 +1,113 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    xmlns:tools="http://schemas.android.com/tools"
-    android:allowAudioPlaybackCapture="true"
-    android:installLocation="preferExternal"
-    tools:targetApi="q">
-    <!-- OpenGL ES 1.1 -->
-    <uses-feature android:glEsVersion="0x00010000" />
-    <!-- Touchscreen support -->
-    <uses-feature
-        android:name="android.hardware.touchscreen"
-        android:required="false" />
-    <!-- Game controller support -->
-    <uses-feature
-        android:name="android.hardware.bluetooth"
-        android:required="false" />
-    <uses-feature
-        android:name="android.hardware.gamepad"
-        android:required="false" />
-    <uses-feature
-        android:name="android.hardware.usb.host"
-        android:required="false" />
-    <!-- External mouse input events -->
-    <uses-feature
-        android:name="android.hardware.type.pc"
-        android:required="false" />
-    <!-- Audio recording support -->
-    <uses-feature
-        android:name="android.hardware.microphone"
-        android:required="false" />
-    <!-- Allow downloading to the external storage on Android 5.1 and older -->
-    <uses-permission
-        android:name="android.permission.WRITE_EXTERNAL_STORAGE"
-        android:maxSdkVersion="22" />
-    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"
-        android:maxSdkVersion="32" />
-    <!-- Allow access to Bluetooth devices -->
-    <!-- Currently this is just for Steam Controller support and requires setting SDL_HINT_JOYSTICK_HIDAPI_STEAM -->
-    <uses-permission
-        android:name="android.permission.BLUETOOTH"
-        android:maxSdkVersion="30" />
-    <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
-    <!-- Allow access to the vibrator -->
-    <uses-permission android:name="android.permission.VIBRATE" />
-    <!-- Allow recording audio -->
-    <uses-permission android:name="android.permission.RECORD_AUDIO" />
-    <!-- Allow internet access -->
-    <uses-permission android:name="android.permission.INTERNET" />
-    <!-- Dedicated server -->
-    <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
+	android:allowAudioPlaybackCapture="true"
+	android:installLocation="preferExternal">
+	<!-- OpenGL ES 1.1 -->
+	<uses-feature android:glEsVersion="0x00010000" />
+	<!-- Touchscreen support -->
+	<uses-feature
+		android:name="android.hardware.touchscreen"
+		android:required="false" />
+	<!-- Game controller support -->
+	<uses-feature
+		android:name="android.hardware.bluetooth"
+		android:required="false" />
+	<uses-feature
+		android:name="android.hardware.gamepad"
+		android:required="false" />
+	<uses-feature
+		android:name="android.hardware.usb.host"
+		android:required="false" />
+	<!-- External mouse input events -->
+	<uses-feature
+		android:name="android.hardware.type.pc"
+		android:required="false" />
+	<!-- Audio recording support -->
+	<uses-feature
+		android:name="android.hardware.microphone"
+		android:required="false" />
+	<!-- Allow downloading to the external storage on Android 5.1 and older -->
+	<uses-permission
+		android:name="android.permission.WRITE_EXTERNAL_STORAGE"
+		android:maxSdkVersion="29" />
+	<uses-permission
+		android:name="android.permission.READ_EXTERNAL_STORAGE"
+		android:maxSdkVersion="29" />
+	<uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />
+	<!-- Allow access to Bluetooth devices -->
+	<!-- Currently this is just for Steam Controller support and requires setting SDL_HINT_JOYSTICK_HIDAPI_STEAM -->
+	<uses-permission
+		android:name="android.permission.BLUETOOTH"
+		android:maxSdkVersion="30" />
+	<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
+	<!-- Allow access to the vibrator -->
+	<uses-permission android:name="android.permission.VIBRATE" />
+	<!-- Allow recording audio -->
+	<uses-permission android:name="android.permission.RECORD_AUDIO" />
+	<!-- Allow internet access -->
+	<uses-permission android:name="android.permission.INTERNET" />
+	<!-- Dedicated server -->
+	<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+	<!-- Self-update: install downloaded APK -->
+	<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
 
-    <application
-        android:name=".MainApplication"
-        android:allowBackup="true"
-        android:hardwareAccelerated="true"
-        android:icon="@mipmap/ic_launcher"
-        android:label="@string/app_name"
-        android:roundIcon="@mipmap/ic_launcher"
-        android:theme="@style/Theme.App"
-        android:usesCleartextTraffic="true">
-        <activity
-            android:name=".MainActivity"
-            android:exported="true">
-            <intent-filter>
-                <action android:name="android.intent.action.MAIN" />
+	<application
+		android:name=".MainApplication"
+		android:allowBackup="true"
+		android:hardwareAccelerated="true"
+		android:icon="@mipmap/ic_launcher"
+		android:label="@string/app_name"
+		android:roundIcon="@mipmap/ic_launcher"
+		android:theme="@style/Theme.App"
+		android:networkSecurityConfig="@xml/network_security_config"
+		android:usesCleartextTraffic="true"
+		android:requestLegacyExternalStorage="true">
+		<activity
+			android:name=".MainActivity"
+			android:exported="true">
+			<intent-filter>
+				<action android:name="android.intent.action.MAIN" />
 
-                <category android:name="android.intent.category.LAUNCHER" />
-            </intent-filter>
-        </activity>
-        <activity
-            android:name=".XashActivity"
-            android:alwaysRetainTaskState="true"
-            android:configChanges="orientation|uiMode|screenLayout|screenSize|smallestScreenSize|keyboard|keyboardHidden|navigation|touchscreen"
-            android:exported="true"
-            android:launchMode="singleTask"
-            android:preferMinimalPostProcessing="true"
-            android:windowSoftInputMode="adjustResize"
-            tools:targetApi="r">
-            <intent-filter>
-                <action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />
-            </intent-filter>
-        </activity>
+				<category android:name="android.intent.category.LAUNCHER" />
+			</intent-filter>
+		</activity>
+		<provider
+			android:name="androidx.core.content.FileProvider"
+			android:authorities="${applicationId}.fileprovider"
+			android:exported="false"
+			android:grantUriPermissions="true">
+			<meta-data
+				android:name="android.support.FILE_PROVIDER_PATHS"
+				android:resource="@xml/paths" />
+		</provider>
+		<receiver
+			android:name=".model.InstallStatusReceiver"
+			android:exported="false">
+			<intent-filter>
+				<action android:name="su.xash.engine.INSTALL_RESULT" />
+			</intent-filter>
+		</receiver>
 
-        <provider
-            android:name=".XashDocumentsProvider"
-            android:authorities="@string/authority"
-            android:exported="true"
-            android:grantUriPermissions="true"
-            android:permission="android.permission.MANAGE_DOCUMENTS">
-            <intent-filter>
-                <action android:name="android.content.action.DOCUMENTS_PROVIDER" />
-            </intent-filter>
-        </provider>
-    </application>
-
-    <queries>
-        <intent>
-            <action android:name="su.xash.engine.MOD" />
-        </intent>
-    </queries>
-</manifest>
+		<activity
+			android:name=".XashActivity"
+			android:alwaysRetainTaskState="true"
+			android:configChanges="orientation|uiMode|screenLayout|screenSize|smallestScreenSize|keyboard|keyboardHidden|navigation|touchscreen"
+			android:exported="true"
+			android:launchMode="singleTask"
+			android:preferMinimalPostProcessing="true"
+			android:windowSoftInputMode="adjustResize">
+			<intent-filter>
+				<action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />
+			</intent-filter>
+		</activity>
+	</application>
+	<queries>
+		<intent>
+			<action android:name="su.xash.engine.MOD" />
+		</intent>
+		<intent>
+			<action android:name="android.intent.action.SENDTO" />
+			<data android:scheme="mailto" />
+		</intent>
+	</queries>
+</manifest>

android/app/src/main/java/su/xash/engine/AndroidBug5497Workaround.java

@@ -1,49 +0,0 @@
-package su.xash.engine;
-
-import android.app.Activity;
-import android.graphics.Rect;
-import android.view.View;
-import android.widget.FrameLayout;
-
-public class AndroidBug5497Workaround {
-    // For more information, see https://code.google.com/p/android/issues/detail?id=5497
-    // To use this class, simply invoke assistActivity() on an Activity that already has its content view set.
-
-    public static void assistActivity(Activity activity) {
-        new AndroidBug5497Workaround(activity);
-    }
-
-    private View mChildOfContent;
-    private int usableHeightPrevious;
-    private FrameLayout.LayoutParams frameLayoutParams;
-
-    private AndroidBug5497Workaround(Activity activity) {
-        FrameLayout content = activity.findViewById(android.R.id.content);
-        mChildOfContent = content.getChildAt(0);
-        mChildOfContent.getViewTreeObserver().addOnGlobalLayoutListener(this::possiblyResizeChildOfContent);
-        frameLayoutParams = (FrameLayout.LayoutParams) mChildOfContent.getLayoutParams();
-    }
-
-    private void possiblyResizeChildOfContent() {
-        int usableHeightNow = computeUsableHeight();
-        if (usableHeightNow != usableHeightPrevious) {
-            int usableHeightSansKeyboard = mChildOfContent.getRootView().getHeight();
-            int heightDifference = usableHeightSansKeyboard - usableHeightNow;
-            if (heightDifference > (usableHeightSansKeyboard / 4)) {
-                // keyboard probably just became visible
-                frameLayoutParams.height = usableHeightSansKeyboard - heightDifference;
-            } else {
-                // keyboard probably just became hidden
-                frameLayoutParams.height = usableHeightSansKeyboard;
-            }
-            mChildOfContent.requestLayout();
-            usableHeightPrevious = usableHeightNow;
-        }
-    }
-
-    private int computeUsableHeight() {
-        Rect r = new Rect();
-        mChildOfContent.getWindowVisibleDisplayFrame(r);
-        return (r.bottom - r.top);
-    }
-}

android/app/src/main/java/su/xash/engine/DedicatedActivity.kt

@@ -1,4 +1,3 @@
 package su.xash.engine
 
-class DedicatedActivity {
-}
+class DedicatedActivity {}

android/app/src/main/java/su/xash/engine/DedicatedService.kt

@@ -4,8 +4,8 @@ import android.app.Service
 import android.content.Intent
 import android.os.IBinder
 
-class DedicatedService: Service() {
-    override fun onBind(intent: Intent?): IBinder? {
-        TODO("Not yet implemented")
-    }
-}
+class DedicatedService : Service() {
+	override fun onBind(intent: Intent?): IBinder? {
+		TODO("Not yet implemented")
+	}
+}

android/app/src/main/java/su/xash/engine/MainActivity.kt

@@ -1,35 +1,186 @@
 package su.xash.engine
 
+import android.content.ActivityNotFoundException
+import android.content.Context
+import android.content.Intent
 import android.os.Bundle
+import android.provider.Settings
+import androidx.appcompat.app.AlertDialog
 import androidx.appcompat.app.AppCompatActivity
+import androidx.core.net.toUri
+import androidx.lifecycle.lifecycleScope
 import androidx.navigation.NavController
 import androidx.navigation.fragment.NavHostFragment
 import androidx.navigation.ui.AppBarConfiguration
 import androidx.navigation.ui.navigateUp
 import androidx.navigation.ui.setupActionBarWithNavController
+import com.google.android.material.dialog.MaterialAlertDialogBuilder
+import kotlinx.coroutines.launch
 import su.xash.engine.databinding.ActivityMainBinding
+import su.xash.engine.model.AppUpdater
+import su.xash.engine.util.CrashReports
+import su.xash.engine.util.monospaceTextView
+import su.xash.engine.util.showDownloadProgressDialog
+import java.io.File
+import java.text.SimpleDateFormat
+import java.util.Date
+import java.util.Locale
 
 class MainActivity : AppCompatActivity() {
-    private lateinit var binding: ActivityMainBinding
-    private lateinit var appBarConfiguration: AppBarConfiguration
-    private lateinit var navController: NavController
+	private lateinit var binding: ActivityMainBinding
+	private lateinit var appBarConfiguration: AppBarConfiguration
+	private lateinit var navController: NavController
 
-    override fun onCreate(savedInstanceState: Bundle?) {
-        super.onCreate(savedInstanceState)
+	override fun onCreate(savedInstanceState: Bundle?) {
+		super.onCreate(savedInstanceState)
 
-        binding = ActivityMainBinding.inflate(layoutInflater)
-        setContentView(binding.root)
+		binding = ActivityMainBinding.inflate(layoutInflater)
+		setContentView(binding.root)
 
-        setSupportActionBar(binding.toolbar)
+		setSupportActionBar(binding.toolbar)
 
-        val navHostFragment =
-            supportFragmentManager.findFragmentById(R.id.fragmentContainerView) as NavHostFragment
-        navController = navHostFragment.navController
-        appBarConfiguration = AppBarConfiguration(navController.graph)
-        setupActionBarWithNavController(navController, appBarConfiguration)
-    }
+		val navHostFragment =
+			supportFragmentManager.findFragmentById(R.id.fragmentContainerView) as NavHostFragment
+		navController = navHostFragment.navController
+		appBarConfiguration = AppBarConfiguration(navController.graph)
+		setupActionBarWithNavController(navController, appBarConfiguration)
 
-    override fun onSupportNavigateUp(): Boolean {
-        return navController.navigateUp(appBarConfiguration) || super.onSupportNavigateUp()
-    }
+		CrashReports.prune(this)
+		showPendingCrashReport()
+
+		checkForEngineUpdate()
+	}
+
+	private fun checkForEngineUpdate() {
+		val prefs = getSharedPreferences(UPDATE_PREFS, Context.MODE_PRIVATE)
+		val now = System.currentTimeMillis()
+		if (now - prefs.getLong(KEY_LAST_CHECK, 0L) < CHECK_INTERVAL_MS)
+			return
+
+		val updater = AppUpdater(this)
+		lifecycleScope.launch {
+			val info = updater.checkForUpdate()
+			prefs.edit().putLong(KEY_LAST_CHECK, now).apply()
+			if (info == null)
+				return@launch
+			if (prefs.getInt(KEY_DISMISSED_BUILDNUM, -1) >= info.buildNum)
+				return@launch
+			val changelog = updater.fetchChangelog(BuildConfig.GIT_HASH, info.tagName)
+			showEngineUpdateDialog(updater, info.buildNum, changelog, prefs)
+		}
+	}
+
+	private fun showEngineUpdateDialog(
+		updater: AppUpdater,
+		remoteBuildNum: Int,
+		changelog: List<AppUpdater.CommitInfo>?,
+		prefs: android.content.SharedPreferences,
+	) {
+		val builder = MaterialAlertDialogBuilder(this)
+			.setTitle(R.string.engine_update_available)
+			.setMessage(getString(R.string.engine_update_message, remoteBuildNum))
+			.setPositiveButton(R.string.engine_update_download) { _, _ ->
+				showEngineDownloadDialog(updater)
+			}
+			.setNegativeButton(R.string.engine_update_later) { _, _ ->
+				prefs.edit().putInt(KEY_DISMISSED_BUILDNUM, remoteBuildNum).apply()
+			}
+
+		if (!changelog.isNullOrEmpty()) {
+			val text = buildString {
+				append(getString(R.string.engine_update_changelog_header))
+				val shown = changelog.take(CHANGELOG_MAX_LINES)
+				for (c in shown)
+					append("\n• ").append(c.subject)
+				val extra = changelog.size - shown.size
+				if (extra > 0)
+					append("\n").append(getString(R.string.engine_update_changelog_more, extra))
+			}
+			builder.setView(monospaceTextView(this, text))
+		}
+
+		builder.show()
+	}
+
+	private fun showEngineDownloadDialog(updater: AppUpdater) {
+		if (!updater.canInstall()) {
+			promptForInstallPermission()
+			return
+		}
+		showDownloadProgressDialog(
+			ctx = this,
+			titleRes = R.string.engine_update_downloading,
+			cancelable = true,
+			scope = lifecycleScope,
+			download = { onProgress -> updater.downloadAndInstall(onProgress) },
+		)
+	}
+
+	private fun promptForInstallPermission() {
+		MaterialAlertDialogBuilder(this)
+			.setTitle(R.string.engine_update_permission_needed)
+			.setMessage(R.string.engine_update_permission_message)
+			.setPositiveButton(R.string.engine_update_open_settings) { _, _ ->
+				val packageIntent = Intent(Settings.ACTION_MANAGE_UNKNOWN_APP_SOURCES,
+					"package:$packageName".toUri())
+				try {
+					startActivity(packageIntent)
+				} catch (_: ActivityNotFoundException) {
+					try {
+						startActivity(Intent(Settings.ACTION_MANAGE_UNKNOWN_APP_SOURCES))
+					} catch (_: ActivityNotFoundException) {
+						// no settings screen — nothing more we can do
+					}
+				}
+			}
+			.setNegativeButton(android.R.string.cancel, null)
+			.show()
+	}
+
+	override fun onSupportNavigateUp(): Boolean {
+		return navController.navigateUp(appBarConfiguration) || super.onSupportNavigateUp()
+	}
+
+	private fun showPendingCrashReport() {
+		val pending = CrashReports.pendingStacktrace(this)
+		if (!pending.exists() || pending.length() == 0L)
+			return
+
+		val historyDir = CrashReports.historyDir(this).apply { mkdirs() }
+		val ts = SimpleDateFormat("yyyyMMdd-HHmmss", Locale.US).format(Date())
+		val entryDir = File(historyDir, "crash-$ts").apply { mkdirs() }
+
+		moveOrCopy(pending, File(entryDir, CrashReports.STACKTRACE_NAME))
+		moveOrCopy(CrashReports.pendingSysinfo(this), File(entryDir, CrashReports.SYSINFO_NAME))
+		moveOrCopy(CrashReports.pendingIntent(this), File(entryDir, CrashReports.INTENT_NAME))
+		moveOrCopy(CrashReports.pendingEngineLog(this), File(entryDir, CrashReports.ENGINELOG_NAME))
+
+		val entry = CrashReports.Entry(entryDir)
+		AlertDialog.Builder(this)
+			.setTitle(R.string.crash_dialog_title)
+			.setView(monospaceTextView(this, entry.summary()))
+			.setPositiveButton(R.string.crash_send_to_developers) { _, _ -> CrashReports.sendByEmail(this, entry) }
+			.setNeutralButton(R.string.crash_share) { _, _ -> CrashReports.share(this, entry) }
+			.setNegativeButton(R.string.crash_dismiss, null)
+			.show()
+	}
+
+	private fun moveOrCopy(src: File, dst: File) {
+		if (!src.exists())
+			return
+
+		if (src.renameTo(dst))
+			return
+
+		src.copyTo(dst, overwrite = true)
+		src.delete()
+	}
+
+	companion object {
+		private const val CHANGELOG_MAX_LINES = 15
+		private const val UPDATE_PREFS = "app_updater"
+		private const val KEY_LAST_CHECK = "last_check_ms"
+		private const val KEY_DISMISSED_BUILDNUM = "dismissed_buildnum"
+		private const val CHECK_INTERVAL_MS = 24 * 60 * 60 * 1000L
+	}
 }

android/app/src/main/java/su/xash/engine/MainApplication.kt

@@ -3,26 +3,25 @@ package su.xash.engine
 import android.app.Application
 import android.content.Context
 import android.os.StrictMode
-import org.acra.config.httpSender
 import org.acra.data.StringFormat
 import org.acra.ktx.initAcra
 
 class MainApplication : Application() {
-    override fun attachBaseContext(base: Context?) {
-        super.attachBaseContext(base)
+	override fun attachBaseContext(base: Context?) {
+		super.attachBaseContext(base)
 
-        if (!BuildConfig.DEBUG) {
+		if (!BuildConfig.DEBUG) {
             initAcra {
                 buildConfigClass = BuildConfig::class.java
                 reportFormat = StringFormat.JSON
 
-                httpSender {
-                    uri = "http://bodis.pp.ua:5000/report"
-                }
+//                httpSender {
+//                    uri = "http://bodis.pp.ua:5000/report"
+//                }
             }
-        } else {
-            // enable strict mode to detect memory leaks etc.
-            StrictMode.enableDefaults();
-        }
-    }
-}
+		} else {
+			// enable strict mode to detect memory leaks etc.
+			StrictMode.enableDefaults();
+		}
+	}
+}

android/app/src/main/java/su/xash/engine/XashActivity.java

@@ -1,10 +1,12 @@
 package su.xash.engine;
 
 import android.annotation.SuppressLint;
+import android.content.Intent;
 import android.content.pm.ActivityInfo;
 import android.content.res.AssetManager;
 import android.os.Build;
 import android.os.Bundle;
+import android.os.Environment;
 import android.provider.Settings.Secure;
 import android.util.Log;
 import android.view.KeyEvent;
@@ -12,137 +14,201 @@ import android.view.WindowManager;
 
 import org.libsdl.app.SDLActivity;
 
+import su.xash.engine.util.AndroidBug5497Workaround;
+import su.xash.engine.util.CrashReports;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.List;
+
 public class XashActivity extends SDLActivity {
-    private boolean mUseVolumeKeys;
-    private String mPackageName;
-    private static final String TAG = "XashActivity";
+	private boolean mUseVolumeKeys;
+	private String mPackageName;
+	private static final String TAG = "XashActivity";
 
-    @Override
-    protected void onCreate(Bundle savedInstanceState) {
-        super.onCreate(savedInstanceState);
+	@Override
+	protected void onCreate(Bundle savedInstanceState) {
+		super.onCreate(savedInstanceState);
 
-        setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_SENSOR_LANDSCAPE);
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
-            //getWindow().addFlags(WindowManager.LayoutParams.LAYOUT_IN_DISPLAY_CUTOUT_MODE_SHORT_EDGES);
-            getWindow().getAttributes().layoutInDisplayCutoutMode = WindowManager.LayoutParams.LAYOUT_IN_DISPLAY_CUTOUT_MODE_SHORT_EDGES;
-        }
+		setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_SENSOR_LANDSCAPE);
+		if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
+			//getWindow().addFlags(WindowManager.LayoutParams.LAYOUT_IN_DISPLAY_CUTOUT_MODE_SHORT_EDGES);
+			getWindow().getAttributes().layoutInDisplayCutoutMode = WindowManager.LayoutParams.LAYOUT_IN_DISPLAY_CUTOUT_MODE_SHORT_EDGES;
+		}
 
-        AndroidBug5497Workaround.assistActivity(this);
-    }
+		AndroidBug5497Workaround.assistActivity(this);
+	}
 
-    @Override
-    public void onDestroy()
-    {
-        super.onDestroy();
+	@Override
+	public void onDestroy() {
+		super.onDestroy();
 
-        // Now that we don't exit from native code, we need to exit here, resetting
-        // application state (actually global variables that we don't cleanup on exit)
-        //
-        // When the issue with global variables will be resolved, remove that exit() call
-        System.exit(0);
-    }
+		// Now that we don't exit from native code, we need to exit here, resetting
+		// application state (actually global variables that we don't cleanup on exit)
+		//
+		// When the issue with global variables will be resolved, remove that exit() call
+		System.exit(0);
+	}
 
-    @Override
-    protected String[] getLibraries() {
-        return new String[]{"SDL2", "xash"};
-    }
+	@Override
+	protected String[] getLibraries() {
+		return new String[]{"SDL2", "xash"};
+	}
 
-    @SuppressLint("HardwareIds")
-    private String getAndroidID() {
-        return Secure.getString(getContentResolver(), Secure.ANDROID_ID);
-    }
+	@SuppressLint("HardwareIds")
+	private String getAndroidID() {
+		return Secure.getString(getContentResolver(), Secure.ANDROID_ID);
+	}
 
-    @SuppressLint("ApplySharedPref")
-    private void saveAndroidID(String id) {
-        getSharedPreferences("xash_preferences", MODE_PRIVATE).edit().putString("xash_id", id).commit();
-    }
+	@SuppressLint("ApplySharedPref")
+	private void saveAndroidID(String id) {
+		getSharedPreferences("xash_preferences", MODE_PRIVATE).edit().putString("xash_id", id).commit();
+	}
 
-    private String loadAndroidID() {
-        return getSharedPreferences("xash_preferences", MODE_PRIVATE).getString("xash_id", "");
-    }
+	private String loadAndroidID() {
+		return getSharedPreferences("xash_preferences", MODE_PRIVATE).getString("xash_id", "");
+	}
 
-    @Override
-    public String getCallingPackage() {
-        if (mPackageName != null) {
-            return mPackageName;
-        }
+	@Override
+	public String getCallingPackage() {
+		if (mPackageName != null) {
+			return mPackageName;
+		}
 
-        return super.getCallingPackage();
-    }
+		return super.getCallingPackage();
+	}
 
-    private AssetManager getAssets(boolean isEngine) {
-        AssetManager am = null;
+	private AssetManager getAssets(boolean isEngine) {
+		AssetManager am = null;
 
-        if (isEngine) {
-            am = getAssets();
-        } else {
-            try {
-                am = getPackageManager().getResourcesForApplication(getCallingPackage()).getAssets();
-            } catch (Exception e) {
-                Log.e(TAG, "Unable to load mod assets!");
-                e.printStackTrace();
-            }
-        }
+		if (isEngine) {
+			am = getAssets();
+		} else {
+			try {
+				am = getPackageManager().getResourcesForApplication(getCallingPackage()).getAssets();
+			} catch (Exception e) {
+				Log.e(TAG, "Unable to load mod assets!");
+				e.printStackTrace();
+			}
+		}
 
-        return am;
-    }
+		return am;
+	}
 
-    private String[] getAssetsList(boolean isEngine, String path) {
-        AssetManager am = getAssets(isEngine);
+	private String[] getAssetsList(boolean isEngine, String path) {
+		AssetManager am = getAssets(isEngine);
 
-        try {
-            return am.list(path);
-        } catch (Exception e) {
-            e.printStackTrace();
-        }
+		try {
+			return am.list(path);
+		} catch (Exception e) {
+			e.printStackTrace();
+		}
 
-        return new String[]{};
-    }
+		return new String[]{};
+	}
 
-    @Override
-    public boolean dispatchKeyEvent(KeyEvent event) {
-        if (SDLActivity.mBrokenLibraries) {
-            return false;
-        }
+	@Override
+	public boolean dispatchKeyEvent(KeyEvent event) {
+		if (SDLActivity.mBrokenLibraries) {
+			return false;
+		}
 
-        int keyCode = event.getKeyCode();
-        if (!mUseVolumeKeys) {
-            if (keyCode == KeyEvent.KEYCODE_VOLUME_DOWN ||
-                    keyCode == KeyEvent.KEYCODE_VOLUME_UP ||
-                    keyCode == KeyEvent.KEYCODE_CAMERA ||
-                    keyCode == KeyEvent.KEYCODE_ZOOM_IN ||
-                    keyCode == KeyEvent.KEYCODE_ZOOM_OUT) {
-                return false;
-            }
-        }
+		int keyCode = event.getKeyCode();
+		if (!mUseVolumeKeys) {
+			if (keyCode == KeyEvent.KEYCODE_VOLUME_DOWN || keyCode == KeyEvent.KEYCODE_VOLUME_UP || keyCode == KeyEvent.KEYCODE_CAMERA || keyCode == KeyEvent.KEYCODE_ZOOM_IN || keyCode == KeyEvent.KEYCODE_ZOOM_OUT) {
+				return false;
+			}
+		}
 
-        return getWindow().superDispatchKeyEvent(event);
-    }
+		return getWindow().superDispatchKeyEvent(event);
+	}
 
-    // TODO: REMOVE LATER, temporary launchers support?
-    @Override
-    protected String[] getArguments() {
-        String gamedir = getIntent().getStringExtra("gamedir");
-        if (gamedir == null) gamedir = "valve";
-        nativeSetenv("XASH3D_GAME", gamedir);
+	private static void appendStringExtra(StringBuilder sb, Intent intent, String key) {
+		String value = intent.getStringExtra(key);
+		if (value != null)
+			sb.append("  ").append(key).append(" = ").append(value).append('\n');
+	}
 
-        String gamelibdir = getIntent().getStringExtra("gamelibdir");
-        if (gamelibdir != null) nativeSetenv("XASH3D_GAMELIBDIR", gamelibdir);
+	// record intent info, so that it could be consumed later for crash reporting
+	private void recordLaunchInfo() {
+		// do not overwrite current launch info with pending crash log, shouldn't happen but might
+		File pendingCrash = new File(getFilesDir(), "crashes/" + CrashReports.STACKTRACE_NAME);
+		if (pendingCrash.exists() && pendingCrash.length() > 0)
+			return;
 
-        String pakfile = getIntent().getStringExtra("pakfile");
-        if (pakfile != null) nativeSetenv("XASH3D_EXTRAS_PAK2", pakfile);
+		// write Android version, fingerprint, supported abis, etc
+		CrashReports.writeSystemInfo(this);
 
-        mUseVolumeKeys = getIntent().getBooleanExtra("usevolume", false);
-        mPackageName = getIntent().getStringExtra("package");
+		// now create intent info and pass it to crash reporting
+		Intent intent = getIntent();
+		if (intent == null)
+			return;
+		StringBuilder sb = new StringBuilder();
+		sb.append("Action: ").append(intent.getAction()).append('\n');
+		sb.append("Data: ").append(intent.getDataString()).append('\n');
+		sb.append("Calling package: ").append(getCallingPackage()).append('\n');
+		sb.append("Extras:\n");
+		// only write intent extras that we care about
+		appendStringExtra(sb, intent, "gamedir");
+		appendStringExtra(sb, intent, "gamelibdir");
+		appendStringExtra(sb, intent, "pakfile");
+		appendStringExtra(sb, intent, "basedir");
+		appendStringExtra(sb, intent, "package");
+		appendStringExtra(sb, intent, "argv");
+		sb.append("  usevolume = ").append(intent.getBooleanExtra("usevolume", false)).append('\n');
+		String[] env = intent.getStringArrayExtra("env");
+		if (env != null)
+			sb.append("  env = ").append(Arrays.toString(env)).append('\n');
+		CrashReports.writeIntentInfo(this, sb.toString());
+	}
 
-        String[] env = getIntent().getStringArrayExtra("env");
-        if (env != null) {
-            for (int i = 0; i < env.length; i += 2)
-                nativeSetenv(env[i], env[i + 1]);
-        }
+	// TODO: REMOVE LATER, temporary launchers support?
+	@Override
+	protected String[] getArguments() {
+		File crashDir = new File(getFilesDir(), "crashes");
+		crashDir.mkdirs();
+		nativeSetenv("XASH3D_CRASH_DIR", crashDir.getAbsolutePath());
 
-        String argv = getIntent().getStringExtra("argv");
-        if (argv == null) argv = "-console -log";
-        return argv.split(" ");
-    }
+		recordLaunchInfo();
+
+		String gamedir = getIntent().getStringExtra("gamedir");
+		if (gamedir == null) gamedir = "valve";
+		nativeSetenv("XASH3D_GAME", gamedir);
+
+		String gamelibdir = getIntent().getStringExtra("gamelibdir");
+		if (gamelibdir != null) nativeSetenv("XASH3D_GAMELIBDIR", gamelibdir);
+
+		String rodir = System.getenv("XASH3D_RODIR");
+		if (rodir == null) {
+			// FIXME: we are using rodir as a supplier for downloaded game libraries
+			rodir = getFilesDir().getAbsolutePath() + "/gamelibs";
+			nativeSetenv("XASH3D_RODIR", rodir);
+		}
+		Log.i(TAG, "XASH3D_RODIR = " + rodir);
+
+		String pakfile = getIntent().getStringExtra("pakfile");
+		if (pakfile != null) nativeSetenv("XASH3D_EXTRAS_PAK2", pakfile);
+
+		String basedir = getIntent().getStringExtra("basedir");
+		if (basedir != null) {
+			nativeSetenv("XASH3D_BASEDIR", basedir);
+		} else {
+			String rootPath = Environment.getExternalStorageDirectory().getAbsolutePath() + "/xash";
+			nativeSetenv("XASH3D_BASEDIR", rootPath);
+		}
+
+		mUseVolumeKeys = getIntent().getBooleanExtra("usevolume", false);
+		mPackageName = getIntent().getStringExtra("package");
+
+		String[] env = getIntent().getStringArrayExtra("env");
+		if (env != null) {
+			for (int i = 0; i < env.length; i += 2)
+				nativeSetenv(env[i], env[i + 1]);
+		}
+
+		String argv = getIntent().getStringExtra("argv");
+		if (argv == null) argv = "-console -log";
+
+		return argv.split(" ");
+	}
 }

android/app/src/main/java/su/xash/engine/XashDocumentsProvider.java

@@ -1,253 +0,0 @@
-package su.xash.engine;
-
-import android.annotation.TargetApi;
-import android.content.res.AssetFileDescriptor;
-import android.database.Cursor;
-import android.database.MatrixCursor;
-import android.graphics.Point;
-import android.os.Build;
-import android.os.CancellationSignal;
-import android.os.ParcelFileDescriptor;
-import android.provider.DocumentsContract.Document;
-import android.provider.DocumentsContract.Root;
-import android.provider.DocumentsProvider;
-import android.webkit.MimeTypeMap;
-import java.io.File;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-
-@TargetApi(Build.VERSION_CODES.KITKAT)
-public class XashDocumentsProvider extends DocumentsProvider {
-    private static final String ALL_MIME_TYPES = "*/*";
-    private File mRootDir;
-
-    private static final String TAG = "XashDocumentsProvider";
-
-    @Override
-    public boolean onCreate() {
-        mRootDir = getContext().getExternalFilesDir(null);
-
-        return true;
-    }
-
-    private static final String[] DEFAULT_ROOT_PROJECTION = new String[]{Root.COLUMN_ROOT_ID,
-            Root.COLUMN_MIME_TYPES,
-            Root.COLUMN_FLAGS,
-            Root.COLUMN_ICON,
-            Root.COLUMN_TITLE,
-            Root.COLUMN_SUMMARY,
-            Root.COLUMN_DOCUMENT_ID,
-            Root.COLUMN_AVAILABLE_BYTES};
-
-    private static final String[] DEFAULT_DOCUMENT_PROJECTION = new String[]{Document.COLUMN_DOCUMENT_ID,
-            Document.COLUMN_MIME_TYPE,
-            Document.COLUMN_DISPLAY_NAME,
-            Document.COLUMN_LAST_MODIFIED,
-            Document.COLUMN_FLAGS,
-            Document.COLUMN_SIZE};
-
-    @Override
-    public Cursor queryRoots(String[] projection) {
-        final MatrixCursor result = new MatrixCursor(projection != null ? projection : DEFAULT_ROOT_PROJECTION);
-
-        final String appName = getContext().getString(R.string.app_name);
-        final String docId = getDocIdForFile(mRootDir);
-
-        int flags;
-
-        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) {
-            flags = Root.FLAG_LOCAL_ONLY | Root.FLAG_SUPPORTS_CREATE | Root.FLAG_SUPPORTS_SEARCH;
-        } else {
-            flags = Root.FLAG_LOCAL_ONLY | Root.FLAG_SUPPORTS_CREATE | Root.FLAG_SUPPORTS_SEARCH | Root.FLAG_SUPPORTS_IS_CHILD;
-        }
-
-        final MatrixCursor.RowBuilder row = result.newRow();
-        row.add(Root.COLUMN_ROOT_ID, docId);
-        row.add(Root.COLUMN_DOCUMENT_ID, docId);
-        row.add(Root.COLUMN_SUMMARY, null);
-        row.add(Root.COLUMN_FLAGS, flags);
-        row.add(Root.COLUMN_TITLE, appName);
-        row.add(Root.COLUMN_MIME_TYPES, ALL_MIME_TYPES);
-        row.add(Root.COLUMN_AVAILABLE_BYTES, mRootDir.getFreeSpace());
-        row.add(Root.COLUMN_ICON, R.mipmap.ic_launcher);
-
-        return result;
-    }
-
-    @Override
-    public Cursor queryDocument(String documentId, String[] projection) throws FileNotFoundException {
-        final MatrixCursor result = new MatrixCursor(projection != null ? projection : DEFAULT_DOCUMENT_PROJECTION);
-
-        includeFile(result, documentId, null);
-
-        return result;
-    }
-
-    @Override
-    public Cursor queryChildDocuments(String parentDocumentId, String[] projection, String sortOrder) throws FileNotFoundException {
-        final MatrixCursor result = new MatrixCursor(projection != null ? projection : DEFAULT_DOCUMENT_PROJECTION);
-
-        final File parent = getFileForDocId(parentDocumentId);
-        final File[] filesList = parent.listFiles();
-
-        if (filesList != null) {
-            for (File file : filesList) {
-                includeFile(result, null, file);
-            }
-        }
-
-        return result;
-    }
-
-    @Override
-    public ParcelFileDescriptor openDocument(final String documentId, String mode, CancellationSignal signal) throws FileNotFoundException {
-        final File file = getFileForDocId(documentId);
-
-        final int accessMode = ParcelFileDescriptor.parseMode(mode);
-
-        return ParcelFileDescriptor.open(file, accessMode);
-    }
-
-    @Override
-    public AssetFileDescriptor openDocumentThumbnail(String documentId, Point sizeHint, CancellationSignal signal) throws FileNotFoundException {
-        final File file = getFileForDocId(documentId);
-
-        final ParcelFileDescriptor pfd = ParcelFileDescriptor.open(file, ParcelFileDescriptor.MODE_READ_ONLY);
-
-        return new AssetFileDescriptor(pfd, 0, file.length());
-    }
-
-    @Override
-    public String createDocument(String parentDocumentId, String mimeType, String displayName) throws FileNotFoundException {
-        File newFile = new File(parentDocumentId, displayName);
-
-        int noConflictId = 1;
-
-        while (newFile.exists()) {
-            newFile = new File(parentDocumentId, displayName + " (" + noConflictId++ + ")");
-        }
-
-        try {
-            boolean succeeded;
-
-            if (Document.MIME_TYPE_DIR.equals(mimeType)) {
-                succeeded = newFile.mkdir();
-            } else {
-                succeeded = newFile.createNewFile();
-            }
-
-            if (!succeeded) {
-                throw new FileNotFoundException("Failed to create document with id " + newFile.getPath());
-            }
-        } catch (IOException e) {
-            throw new FileNotFoundException("Failed to create document with id " + newFile.getPath());
-        }
-
-        return newFile.getPath();
-    }
-
-    @Override
-    public void deleteDocument(String documentId) throws FileNotFoundException {
-        File file = getFileForDocId(documentId);
-
-        if (file.isDirectory()) {
-            if (!deleteDirectory(file)) {
-                throw new FileNotFoundException("Failed to delete document with id " + documentId);
-            }
-        } else if (!file.delete()) {
-            throw new FileNotFoundException("Failed to delete document with id " + documentId);
-        }
-    }
-
-    @Override
-    public String getDocumentType(String documentId) throws FileNotFoundException {
-        File file = getFileForDocId(documentId);
-
-        return getMimeType(file);
-    }
-
-    @Override
-    public boolean isChildDocument(String parentDocumentId, String documentId) {
-        return documentId.startsWith(parentDocumentId);
-    }
-
-    private static File getFileForDocId(String docId) throws FileNotFoundException {
-        final File f = new File(docId);
-
-        if (!f.exists()) throw new FileNotFoundException(f.getAbsolutePath() + " not found");
-
-        return f;
-    }
-
-    private static String getDocIdForFile(File file) {
-        return file.getAbsolutePath();
-    }
-
-    private static String getMimeType(File file) {
-        if (file.isDirectory()) {
-            return Document.MIME_TYPE_DIR;
-        } else {
-            final String name = file.getName();
-            final int lastDot = name.lastIndexOf('.');
-
-            if (lastDot >= 0) {
-                final String extension = name.substring(lastDot + 1).toLowerCase();
-                final String mime = MimeTypeMap.getSingleton().getMimeTypeFromExtension(extension);
-
-                if (mime != null) return mime;
-            }
-
-            return "application/octet-stream";
-        }
-    }
-
-    private static boolean deleteDirectory(File dir) {
-        final File[] allContents = dir.listFiles();
-
-        if (allContents != null) {
-            for (File file : allContents) {
-                deleteDirectory(file);
-            }
-        }
-        return dir.delete();
-    }
-
-    private void includeFile(MatrixCursor result, String docId, File file) throws FileNotFoundException {
-        if (docId == null) {
-            docId = getDocIdForFile(file);
-        } else {
-            file = getFileForDocId(docId);
-        }
-
-        int flags = 0;
-
-        if (file.isDirectory()) {
-            if (file.canWrite()) {
-                flags |= Document.FLAG_DIR_SUPPORTS_CREATE;
-            }
-        } else if (file.canWrite()) {
-            flags |= Document.FLAG_SUPPORTS_WRITE;
-        }
-
-        File parentFile = file.getParentFile();
-        if (parentFile != null && parentFile.canWrite()) {
-            flags |= Document.FLAG_SUPPORTS_DELETE;
-        }
-
-        final String displayName = file.getName();
-        final String mimeType = getMimeType(file);
-
-        if (mimeType.startsWith("image/")) {
-            flags |= Document.FLAG_SUPPORTS_THUMBNAIL;
-        }
-
-        final MatrixCursor.RowBuilder row = result.newRow();
-        row.add(Document.COLUMN_DOCUMENT_ID, docId);
-        row.add(Document.COLUMN_DISPLAY_NAME, displayName);
-        row.add(Document.COLUMN_SIZE, file.length());
-        row.add(Document.COLUMN_MIME_TYPE, mimeType);
-        row.add(Document.COLUMN_LAST_MODIFIED, file.lastModified());
-        row.add(Document.COLUMN_FLAGS, flags);
-        row.add(Document.COLUMN_ICON, R.mipmap.ic_launcher);
-    }
-}

android/app/src/main/java/su/xash/engine/adapters/GameAdapter.kt

@@ -14,64 +14,57 @@ import su.xash.engine.ui.library.LibraryViewModel
 
 
 class GameAdapter(private val libraryViewModel: LibraryViewModel) :
-    ListAdapter<Game, GameAdapter.GameViewHolder>(DiffCallback()) {
+	ListAdapter<Game, GameAdapter.GameViewHolder>(DiffCallback()) {
 
-    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): GameAdapter.GameViewHolder {
-        val binding = CardGameBinding.inflate(LayoutInflater.from(parent.context), parent, false)
-        return GameViewHolder(binding)
-    }
+	override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): GameAdapter.GameViewHolder {
+		val binding = CardGameBinding.inflate(LayoutInflater.from(parent.context), parent, false)
+		return GameViewHolder(binding)
+	}
 
-    override fun onBindViewHolder(holder: GameAdapter.GameViewHolder, position: Int) {
-        return holder.bind(getItem(position))
-    }
+	override fun onBindViewHolder(holder: GameAdapter.GameViewHolder, position: Int) {
+		return holder.bind(getItem(position))
+	}
 
-    private class DiffCallback : DiffUtil.ItemCallback<Game>() {
-        override fun areItemsTheSame(oldItem: Game, newItem: Game): Boolean {
-            return oldItem.basedir.name == newItem.basedir.name
-        }
+	private class DiffCallback : DiffUtil.ItemCallback<Game>() {
+		override fun areItemsTheSame(oldItem: Game, newItem: Game): Boolean {
+			return oldItem.basedir.name == newItem.basedir.name
+		}
 
-        override fun areContentsTheSame(oldItem: Game, newItem: Game): Boolean {
-            return oldItem.basedir.name == newItem.basedir.name && oldItem.installed == newItem.installed
-        }
+		override fun areContentsTheSame(oldItem: Game, newItem: Game): Boolean {
+			return oldItem.basedir.name == newItem.basedir.name
+		}
 
-    }
+	}
 
-    inner class GameViewHolder(val binding: CardGameBinding) :
-        RecyclerView.ViewHolder(binding.root) {
-        fun bind(game: Game) {
-            binding.apply {
-                gameTitle.text = game.title
+	inner class GameViewHolder(val binding: CardGameBinding) :
+		RecyclerView.ViewHolder(binding.root) {
+		fun bind(game: Game) {
+			binding.apply {
+				gameTitle.text = game.title
 
-                if (game.icon != null) {
-                    gameIcon.setImageBitmap(game.icon)
-                } else {
-                    gameIcon.visibility = View.GONE
-                }
+				if (game.icon != null) {
+					gameIcon.setImageBitmap(game.icon)
+				} else {
+					gameIcon.visibility = View.GONE
+				}
 
-                if (game.cover != null) {
-                    gameCover.setImageBitmap(game.cover)
-                } else {
-                    gameCover.visibility = View.GONE
-                }
+				if (game.cover != null) {
+					gameCover.setImageBitmap(game.cover)
+				} else {
+					gameCover.visibility = View.GONE
+				}
 
-                if (!game.installed) {
-                    launchButton.visibility = View.GONE
-                    settingsButton.visibility = View.GONE
-                    progressIndicator.visibility = View.VISIBLE
-                    return
-                }
+				settingsButton.setOnClickListener {
+					libraryViewModel.setSelectedGame(game)
+					it.findNavController()
+						.navigate(R.id.action_libraryFragment_to_gameSettingsFragment)
+				}
 
-                settingsButton.setOnClickListener {
-                    libraryViewModel.setSelectedGame(game)
-                    it.findNavController()
-                        .navigate(R.id.action_libraryFragment_to_gameSettingsFragment)
-                }
-
-                root.setOnClickListener { libraryViewModel.startEngine(it.context, game) }
-                launchButton.setOnClickListener {
-                    libraryViewModel.startEngine(it.context, game)
-                }
-            }
-        }
-    }
-}
+				root.setOnClickListener { libraryViewModel.startEngine(it.context, game) }
+				launchButton.setOnClickListener {
+					libraryViewModel.startEngine(it.context, game)
+				}
+			}
+		}
+	}
+}

android/app/src/main/java/su/xash/engine/model/AppUpdater.kt

@@ -0,0 +1,205 @@
+package su.xash.engine.model
+
+import android.app.PendingIntent
+import android.content.Context
+import android.content.Intent
+import android.content.pm.PackageInstaller
+import android.os.Build
+import android.util.Log
+import kotlinx.coroutines.CancellationException
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.ensureActive
+import kotlinx.coroutines.withContext
+import org.json.JSONException
+import org.json.JSONObject
+import su.xash.engine.BuildConfig
+import java.io.File
+import java.io.FileOutputStream
+import java.io.IOException
+import java.net.HttpURLConnection
+import java.net.URL
+import kotlin.coroutines.coroutineContext
+
+class AppUpdater(private val context: Context) {
+
+	data class UpdateInfo(val buildNum: Int, val tagName: String)
+	data class CommitInfo(val sha: String, val subject: String)
+
+	fun canInstall(): Boolean =
+		Build.VERSION.SDK_INT < Build.VERSION_CODES.O ||
+			context.packageManager.canRequestPackageInstalls()
+
+	suspend fun checkForUpdate(): UpdateInfo? {
+		if (!BuildConfig.ENABLE_AUTO_UPDATE) return null
+		return withContext(Dispatchers.IO) {
+			var connection: HttpURLConnection? = null
+			try {
+				connection = URL(RELEASE_API_URL).openConnection() as HttpURLConnection
+				connection.connectTimeout = 5000
+				connection.readTimeout = 5000
+				connection.setRequestProperty("Accept", "application/vnd.github+json")
+				connection.connect()
+
+				if (connection.responseCode != HttpURLConnection.HTTP_OK) {
+					Log.w(TAG, "Release API check failed: HTTP ${connection.responseCode}")
+					return@withContext null
+				}
+
+				val release = JSONObject(connection.inputStream.bufferedReader().readText())
+				val body = release.optString("body", "")
+				val tagName = release.optString("tag_name").ifEmpty { TAG_CONTINUOUS }
+
+				// buildnum is days-since-2015-04-01, same metric as VERSION_CODE / 10000
+				val remote = BUILDNUM_REGEX.find(body)?.groupValues?.get(1)?.toIntOrNull()
+				val localDays = BuildConfig.VERSION_CODE / 10000
+				Log.i(TAG, "Remote buildnum: $remote (tag=$tagName), local: $localDays")
+
+				if (remote != null && remote - localDays >= STALENESS_DAYS)
+					UpdateInfo(remote, tagName)
+				else
+					null
+			} catch (e: CancellationException) {
+				throw e
+			} catch (e: IOException) {
+				Log.w(TAG, "Update check failed: ${e.message}")
+				null
+			} catch (e: JSONException) {
+				Log.w(TAG, "Update check parse failed: ${e.message}")
+				null
+			} finally {
+				connection?.disconnect()
+			}
+		}
+	}
+
+	suspend fun fetchChangelog(fromRef: String, toRef: String): List<CommitInfo>? {
+		if (fromRef.isEmpty() || toRef.isEmpty())
+			return null
+		return withContext(Dispatchers.IO) {
+			var connection: HttpURLConnection? = null
+			try {
+				connection = URL("$COMPARE_API_BASE/$fromRef...$toRef").openConnection() as HttpURLConnection
+				connection.connectTimeout = 5000
+				connection.readTimeout = 5000
+				connection.setRequestProperty("Accept", "application/vnd.github+json")
+				connection.connect()
+
+				if (connection.responseCode != HttpURLConnection.HTTP_OK) {
+					Log.w(TAG, "Compare API failed: HTTP ${connection.responseCode}")
+					return@withContext null
+				}
+
+				val json = JSONObject(connection.inputStream.bufferedReader().readText())
+				val commits = json.optJSONArray("commits") ?: return@withContext null
+				val result = ArrayList<CommitInfo>(commits.length())
+				for (i in 0 until commits.length()) {
+					val c = commits.getJSONObject(i)
+					val sha = c.optString("sha").ifEmpty { continue }
+					val msg = c.optJSONObject("commit")?.optString("message") ?: continue
+					val subject = msg.substringBefore('\n').trim()
+					if (subject.isNotEmpty())
+						result.add(CommitInfo(sha, subject))
+				}
+				// GitHub returns oldest first
+				result.reverse()
+				result
+			} catch (e: CancellationException) {
+				throw e
+			} catch (e: IOException) {
+				Log.w(TAG, "Changelog fetch failed: ${e.message}")
+				null
+			} catch (e: JSONException) {
+				Log.w(TAG, "Changelog parse failed: ${e.message}")
+				null
+			} finally {
+				connection?.disconnect()
+			}
+		}
+	}
+
+	suspend fun downloadAndInstall(onProgress: (Long, Long) -> Unit): Result<Unit> {
+		return withContext(Dispatchers.IO) {
+			val tempFile = File(context.cacheDir, "xash3d-fwgs-update.apk")
+			var connection: HttpURLConnection? = null
+			try {
+				connection = URL(APK_URL).openConnection() as HttpURLConnection
+				connection.connectTimeout = 10000
+				connection.readTimeout = 30000
+				connection.instanceFollowRedirects = true
+				connection.connect()
+
+				if (connection.responseCode != HttpURLConnection.HTTP_OK)
+					return@withContext Result.failure(IOException("HTTP ${connection.responseCode}"))
+
+				val total = connection.contentLengthLong
+				var downloaded = 0L
+				var lastEmit = 0L
+
+				connection.inputStream.use { input ->
+					FileOutputStream(tempFile).use { output ->
+						val buffer = ByteArray(65536)
+						while (true) {
+							coroutineContext.ensureActive()
+							val read = input.read(buffer)
+							if (read < 0)
+								break
+							output.write(buffer, 0, read)
+							downloaded += read
+							val now = System.currentTimeMillis()
+							if (now - lastEmit >= PROGRESS_INTERVAL_MS) {
+								lastEmit = now
+								withContext(Dispatchers.Main) { onProgress(downloaded, total) }
+							}
+						}
+					}
+				}
+				withContext(Dispatchers.Main) { onProgress(downloaded, total) }
+
+				Log.i(TAG, "Downloaded APK: ${tempFile.length()} bytes -> ${tempFile.absolutePath}")
+
+				triggerInstall(tempFile)
+				Result.success(Unit)
+			} catch (e: CancellationException) {
+				tempFile.delete()
+				throw e
+			} catch (e: IOException) {
+				tempFile.delete()
+				Result.failure(e)
+			} finally {
+				connection?.disconnect()
+			}
+		}
+	}
+
+	private fun triggerInstall(apk: File) {
+		val installer = context.packageManager.packageInstaller
+		val params = PackageInstaller.SessionParams(PackageInstaller.SessionParams.MODE_FULL_INSTALL)
+		val sessionId = installer.createSession(params)
+		installer.openSession(sessionId).use { session ->
+			session.openWrite("base.apk", 0, apk.length()).use { out ->
+				apk.inputStream().use { it.copyTo(out) }
+				session.fsync(out)
+			}
+			val statusIntent = Intent(INSTALL_ACTION).setPackage(context.packageName)
+			val piFlags = PendingIntent.FLAG_UPDATE_CURRENT or
+				if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) PendingIntent.FLAG_MUTABLE else 0
+			val pi = PendingIntent.getBroadcast(context, sessionId, statusIntent, piFlags)
+			session.commit(pi.intentSender)
+		}
+	}
+
+	companion object {
+		private const val TAG = "AppUpdater"
+		private const val STALENESS_DAYS = 3
+		private const val PROGRESS_INTERVAL_MS = 100L
+		private const val TAG_CONTINUOUS = "continuous"
+		private const val INSTALL_ACTION = "su.xash.engine.INSTALL_RESULT"
+		private const val APK_URL =
+			"https://github.com/FWGS/xash3d-fwgs/releases/download/continuous/xash3d-fwgs-android.apk"
+		private const val RELEASE_API_URL =
+			"https://api.github.com/repos/FWGS/xash3d-fwgs/releases/tags/continuous"
+		private const val COMPARE_API_BASE =
+			"https://api.github.com/repos/FWGS/xash3d-fwgs/compare"
+		private val BUILDNUM_REGEX = Regex("""buildnum\s+(\d+)""")
+	}
+}

android/app/src/main/java/su/xash/engine/model/BackgroundBitmap.kt

@@ -1,89 +1,90 @@
 package su.xash.engine.model
 
-import android.content.Context
 import android.graphics.Bitmap
 import android.graphics.Canvas
-import androidx.documentfile.provider.DocumentFile
 import su.xash.engine.util.TGAReader
+import java.io.File
+import java.io.FileInputStream
 import java.util.Scanner
 
 
 object BackgroundBitmap {
-    private const val BACKGROUND_ROWS = 3
-    private const val BACKGROUND_COLUMNS = 4
-    private const val BACKGROUND_WIDTH = 800
-    private const val BACKGROUND_HEIGHT = 600
+	private const val BACKGROUND_ROWS = 3
+	private const val BACKGROUND_COLUMNS = 4
+	private const val BACKGROUND_WIDTH = 800
+	private const val BACKGROUND_HEIGHT = 600
 
-    fun createBackground(ctx: Context, file: DocumentFile): Bitmap {
-        var bitmap =
-            Bitmap.createBitmap(BACKGROUND_WIDTH, BACKGROUND_HEIGHT, Bitmap.Config.ARGB_8888)
-        var canvas = Canvas(bitmap)
-        var x: Int
-        var y = 0
-        var width: Int
-        var height = 0
+	fun createBackground(file: File): Bitmap {
+		var bitmap =
+			Bitmap.createBitmap(BACKGROUND_WIDTH, BACKGROUND_HEIGHT, Bitmap.Config.ARGB_8888)
+		var canvas = Canvas(bitmap)
+		var x: Int
+		var y = 0
+		var width: Int
+		var height = 0
 
-        var bgLayout = file.findFile("resource")?.findFile("HD_BackgroundLayout.txt")
-        if (bgLayout == null) {
-            bgLayout = file.findFile("resource")?.findFile("BackgroundLayout.txt")
-        }
+		val resourceFolder = File(file, "resource")
+		var bgLayout = File(resourceFolder, "HD_BackgroundLayout.txt")
+		if (!bgLayout.exists()) {
+			bgLayout = File(resourceFolder, "BackgroundLayout.txt")
+		}
 
-        if (bgLayout == null) {
-            val dir = file.findFile("resource")?.findFile("background")
-            for (i in 0 until BACKGROUND_ROWS) {
-                x = 0
-                for (j in 0 until BACKGROUND_COLUMNS) {
-                    val filename = "${BACKGROUND_WIDTH}_${i + 1}_${'a' + j}_loading.tga"
-                    val bmpFile = dir?.findFile(filename)
-                    val bmpImage = loadTga(ctx, bmpFile!!)
+		if (!bgLayout.exists()) {
+			val dir = File(resourceFolder, "background")
+			for (i in 0 until BACKGROUND_ROWS) {
+				x = 0
+				for (j in 0 until BACKGROUND_COLUMNS) {
+					val filename = "${BACKGROUND_WIDTH}_${i + 1}_${'a' + j}_loading.tga"
+					val bmpFile = File(dir, filename)
+					val bmpImage = loadTga(bmpFile)
 
-                    canvas.drawBitmap(bmpImage, x.toFloat(), y.toFloat(), null)
-                    x += bmpImage.width
-                    height = bmpImage.height
+					canvas.drawBitmap(bmpImage, x.toFloat(), y.toFloat(), null)
+					x += bmpImage.width
+					height = bmpImage.height
 
-                }
-                y += height
-            }
-            return bitmap
-        }
+				}
+				y += height
+			}
+			return bitmap
+		}
 
-        ctx.contentResolver.openInputStream(bgLayout.uri).use { inputStream ->
-            Scanner(inputStream).use { scanner ->
-                while (scanner.hasNext()) {
-                    when (val str = scanner.next()) {
-                        "resolution" -> {
-                            width = scanner.nextInt()
-                            height = scanner.nextInt()
-                            bitmap = Bitmap.createBitmap(width, height, Bitmap.Config.ARGB_8888)
-                            canvas = Canvas(bitmap)
-                        }
+		FileInputStream(bgLayout).use { inputStream ->
+			Scanner(inputStream).use { scanner ->
+				while (scanner.hasNext()) {
+					when (val str = scanner.next()) {
+						"resolution" -> {
+							width = scanner.nextInt()
+							height = scanner.nextInt()
+							bitmap = Bitmap.createBitmap(width, height, Bitmap.Config.ARGB_8888)
+							canvas = Canvas(bitmap)
+						}
 
-                        else -> {
-                            var bmpFile = file
-                            str.split("/").forEach { bmpFile = bmpFile.findFile(it)!! }
-                            //skip
-                            scanner.next()
-                            x = scanner.nextInt()
-                            y = scanner.nextInt()
-                            val bmp = loadTga(ctx, bmpFile)
-                            canvas.drawBitmap(bmp, x.toFloat(), y.toFloat(), null)
-                        }
-                    }
-                }
-            }
-        }
-        return bitmap
-    }
+						else -> {
+							var bmpFile = file
+							str.split("/").forEach { bmpFile = File(bmpFile, it) }
+							//skip
+							scanner.next()
+							x = scanner.nextInt()
+							y = scanner.nextInt()
+							val bmp = loadTga(bmpFile)
+							canvas.drawBitmap(bmp, x.toFloat(), y.toFloat(), null)
+						}
+					}
+				}
+			}
+		}
+		return bitmap
+	}
 
-    private fun loadTga(ctx: Context, file: DocumentFile): Bitmap {
-        ctx.contentResolver.openInputStream(file.uri).use {
-            val buffer = it?.readBytes()
-            val pixels = TGAReader.read(buffer, TGAReader.ARGB)
+	private fun loadTga(file: File): Bitmap {
+		FileInputStream(file).use {
+			val buffer = it.readBytes()
+			val pixels = TGAReader.read(buffer, TGAReader.ARGB)
 
-            val width = TGAReader.getWidth(buffer)
-            val height = TGAReader.getHeight(buffer)
+			val width = TGAReader.getWidth(buffer)
+			val height = TGAReader.getHeight(buffer)
 
-            return Bitmap.createBitmap(pixels, 0, width, width, height, Bitmap.Config.ARGB_8888)
-        }
-    }
-}
+			return Bitmap.createBitmap(pixels, 0, width, width, height, Bitmap.Config.ARGB_8888)
+		}
+	}
+}

android/app/src/main/java/su/xash/engine/model/Game.kt

@@ -5,129 +5,253 @@ import android.content.Intent
 import android.content.pm.PackageInfo
 import android.content.pm.PackageManager
 import android.graphics.Bitmap
-import android.net.Uri
-import android.provider.MediaStore
-import androidx.documentfile.provider.DocumentFile
+import android.graphics.BitmapFactory
+import androidx.core.net.toUri
+import com.google.android.material.dialog.MaterialAlertDialogBuilder
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.launch
+import su.xash.engine.R
 import su.xash.engine.XashActivity
+import su.xash.engine.util.showDownloadProgressDialog
+import java.io.File
+import java.io.FileInputStream
 
+class Game(val ctx: Context, val basedir: File, val gameInfoFile: File) {
+	private var iconName = "game.ico"
+	var title = "Unknown Game"
+	var icon: Bitmap? = null
+	var cover: Bitmap? = null
 
-class Game(val ctx: Context, val basedir: DocumentFile, var installed: Boolean = true) {
-    private var iconName = "game.ico"
-    var title = "Unknown Game"
-    var icon: Bitmap? = null
-    var cover: Bitmap? = null
+	val mobileHacksGames = arrayOf("aom", "bdlands", "biglolly", "bshift", "caseclosed",
+		"hl_urbicide", "induction", "redempt", "secret",
+		"sewer_beta", "tot", "valve", "vendetta")
 
-    private val pref = ctx.getSharedPreferences(basedir.name, Context.MODE_PRIVATE)
+	// a1ba: follow the behavior of Xash3D's game_launch.
+	// for hl mods we put `valve` as game directory
+	// for any other game that's not hl this string must be replaced with your
+	// main game directory
+	// mods always use -game command line parameter
+	var defaultGameDir = "valve"
 
-    init {
-        basedir.findFile("gameinfo.txt")?.let {
-            parseGameInfo(it)
-        } ?: basedir.findFile("liblist.gam")?.let { parseGameInfo(it) }
+	private val pref = ctx.getSharedPreferences(basedir.name, Context.MODE_PRIVATE)
 
-        basedir.findFile(iconName)
-            ?.let { icon = MediaStore.Images.Media.getBitmap(ctx.contentResolver, it.uri) }
+	init {
+		parseGameInfo(gameInfoFile)
 
-        try {
-            cover = BackgroundBitmap.createBackground(ctx, basedir)
-        } catch (e: Exception) {
-            e.printStackTrace()
-        }
-    }
+		val iconFile = File(basedir, iconName)
+		if (iconFile.exists()) {
+			icon = BitmapFactory.decodeFile(iconFile.path)
+		}
 
-    fun startEngine(ctx: Context) {
-        ctx.startActivity(Intent(ctx, XashActivity::class.java).apply {
-            flags = Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK
-            putExtra("gamedir", basedir.name)
-            putExtra("argv", pref.getString("arguments", "-console -log"))
-            putExtra("usevolume", pref.getBoolean("use_volume_buttons", false))
-            //.putExtra("gamelibdir", getGameLibDir(context))
-            //.putExtra("package", getPackageName()) }
-        })
-    }
+		try {
+			cover = BackgroundBitmap.createBackground(basedir)
+		} catch (e: Exception) {
+			e.printStackTrace()
+		}
+	}
 
-    private fun parseGameInfo(file: DocumentFile) {
-        ctx.contentResolver.openInputStream(file.uri).use { inputStream ->
-            inputStream?.bufferedReader().use { reader ->
-                reader?.forEachLine {
-                    val tokens = it.split("\\s+".toRegex(), limit = 2)
-                    if (tokens.size >= 2) {
-                        val k = tokens[0]
-                        val v = tokens[1].trim('"')
+	fun startEngine(ctx: Context) {
+		val packageNames = getPackageNamesForGameDir(basedir.name)
+		var externalGame = false
+		var commandLineArgs = ""
 
-                        if (k == "title" || k == "game") title = v
-                        if (k == "icon") iconName = v
-                    }
-                }
-            }
-        }
-    }
+		if (basedir.name != defaultGameDir)
+			commandLineArgs += "-game ${basedir.name} "
 
-    private fun getPackageName(): String? {
-//        return if (mDbEntry != null) {
-//            mDbEntry.getPackageName()
-//        } else null
-        return null
-    }
+		if (packageNames != null) {
+			if (packageNames.contains("su.xash.engine")) {
+				commandLineArgs += "-dll @hl "
+			} else if (packageNames.contains("su.xash.cs16client")) {
+				if (pref.getBoolean("enable_yapb_bots", true)) {
+					commandLineArgs += "-dll @yapb "
+				}
+				externalGame = true
+			}
+		}
 
-    private fun getGameLibDir(ctx: Context): String? {
-        val pkgName = getPackageName()
-        if (pkgName != null) {
-            val pkgInfo: PackageInfo = try {
-                ctx.packageManager.getPackageInfo(pkgName, 0)
-            } catch (e: PackageManager.NameNotFoundException) {
-                e.printStackTrace()
-                ctx.startActivity(
-                    Intent(
-                        Intent.ACTION_VIEW, Uri.parse("market://details?id=$pkgName")
-                    ).setFlags(Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK)
-                )
-                return null
-            }
-            return pkgInfo.applicationInfo.nativeLibraryDir
-        }
-        return ctx.applicationInfo.nativeLibraryDir
-    }
+		commandLineArgs += pref.getString("arguments", "-console -log") ?: ""
 
-    companion object {
-        fun getGames(ctx: Context, file: DocumentFile): List<Game> {
-            val games = mutableListOf<Game>()
+		if (externalGame && packageNames != null) {
+			var packageName: String? = null
+			var gameLibDir: String? = null
 
-            if (checkIfGamedir(file)) {
-                games.add(Game(ctx, file))
-            } else {
-                file.listFiles().forEach {
-                    if (it.isDirectory) {
-                        if (checkIfGamedir(it)) {
-                            games.add(Game(ctx, it))
-                        }
-                    }
-                }
-            }
+			for (pn in packageNames) {
+				gameLibDir = try {
+					getGameLibDir(ctx, pn)
+				} catch (e: PackageManager.NameNotFoundException) {
+					null
+				} catch (e: Exception) {
+					e.printStackTrace()
+					null
+				}
 
-            return games
-        }
+				if (gameLibDir != null) {
+					packageName = pn
+					break
+				}
+			}
 
-        fun checkIfGamedir(file: DocumentFile): Boolean {
-            // exclude unfinished downloads
-            if (file.name?.startsWith('.') == true)
-                return false
+			if (gameLibDir == null) {
+				MaterialAlertDialogBuilder(ctx).apply {
+					setTitle(R.string.game_apk_required)
+					setMessage(R.string.game_apk_message)
+					setPositiveButton(R.string.game_apk_install) { _, _ ->
+						val intent = Intent(Intent.ACTION_VIEW,
+							getDownloadPageForGameDir(basedir.name).toUri())
+						ctx.startActivity(intent)
+					}
+					show()
+				}
+				return
+			}
 
-            file.findFile("liblist.gam")?.let { return true }
-            file.findFile("gameinfo.txt")?.let { return true }
-            return false
-        }
-    }
+			launchEngine(ctx, commandLineArgs, packageName = packageName, gameLibDir = gameLibDir)
+			return
+		}
+
+		if (packageNames == null) {
+			// Unknown game — try to use downloaded libraries from hlsdk-mega-build
+			val downloader = GameLibDownloader(ctx)
+			val args = commandLineArgs
+
+			if (downloader.isDownloaded(basedir.name)) {
+				downloader.logExistingLibs(basedir.name)
+				launchEngine(ctx, args)
+				return
+			}
+
+			val scope = CoroutineScope(Dispatchers.Main + SupervisorJob())
+			scope.launch {
+				when (val r = downloader.lookupBuild(basedir.name)) {
+					is GameLibDownloader.Lookup.Available -> showDownloadDialog(ctx, downloader, args)
+					is GameLibDownloader.Lookup.NotInManifest -> launchEngine(ctx, args)
+					is GameLibDownloader.Lookup.Error -> showManifestErrorDialog(ctx, args, r.cause)
+				}
+			}
+			return
+		}
+
+		launchEngine(ctx, commandLineArgs)
+	}
+
+	private fun showDownloadDialog(ctx: Context, downloader: GameLibDownloader, commandLineArgs: String) {
+		showDownloadProgressDialog(
+			ctx = ctx,
+			titleRes = R.string.downloading_game_libs,
+			cancelable = true,
+			scope = CoroutineScope(Dispatchers.Main + SupervisorJob()),
+			download = { onProgress -> downloader.download(basedir.name, onProgress) },
+			onSuccess = { launchEngine(ctx, commandLineArgs) },
+		)
+	}
+
+	private fun showManifestErrorDialog(ctx: Context, commandLineArgs: String, cause: Throwable) {
+		MaterialAlertDialogBuilder(ctx)
+			.setTitle(R.string.manifest_error_title)
+			.setMessage(ctx.getString(R.string.manifest_error_message, cause.message ?: cause.javaClass.simpleName))
+			.setPositiveButton(R.string.launch_anyway) { _, _ -> launchEngine(ctx, commandLineArgs) }
+			.setNegativeButton(android.R.string.cancel, null)
+			.show()
+	}
+
+	private fun launchEngine(
+		ctx: Context,
+		commandLineArgs: String,
+		packageName: String? = null,
+		gameLibDir: String? = null
+	) {
+		ctx.startActivity(Intent(ctx, XashActivity::class.java).apply {
+			flags = Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK
+
+			putExtra("gamedir", defaultGameDir)
+			putExtra("argv", commandLineArgs)
+			putExtra("usevolume", pref.getBoolean("use_volume_buttons", false))
+			putExtra("basedir", basedir.parent)
+
+			if (gameLibDir != null) putExtra("gamelibdir", gameLibDir)
+			if (packageName != null) putExtra("package", packageName)
+		})
+	}
+
+	private fun parseGameInfo(file: File) {
+		FileInputStream(file).use { inputStream ->
+			inputStream.bufferedReader().use { reader ->
+				reader.forEachLine {
+					val tokens = it.split("\\s+".toRegex(), limit = 2)
+					if (tokens.size >= 2) {
+						val k = tokens[0]
+						val v = tokens[1].trim('"')
+
+						if (k == "title" || k == "game") title = v
+						if (k == "icon") iconName = v
+					}
+				}
+			}
+		}
+	}
+
+	private fun getPackageNamesForGameDir(gamedir: String): Array<String>? {
+		if (gamedir.equals("cstrike", ignoreCase = true)
+			|| gamedir.equals("czero", ignoreCase = true))
+			return arrayOf("su.xash.cs16client.test", "su.xash.cs16client")
+
+		if (gamedir.equals("tfc", ignoreCase = true))
+			return arrayOf("su.xash.tf15client.test", "su.xash.tf15client")
+
+		// mobile_hacks hlsdk-portable branch allows us to have few more mods out of the box
+		if (mobileHacksGames.any { it.equals(gamedir, ignoreCase = true) })
+			return arrayOf("su.xash.engine")
+
+		return null
+	}
+
+	private fun getDownloadPageForGameDir(gamedir: String): String {
+		if (gamedir.equals("cstrike", ignoreCase = true)
+			|| gamedir.equals("czero", ignoreCase = true))
+			return "https://github.com/Velaron/cs16-client/releases/download/continuous/CS16Client-Android.apk"
+
+		if (gamedir.equals("tfc", ignoreCase = true))
+			return "https://github.com/Velaron/tf15-client/releases/download/continuous/TF15Client-Android.apk"
+
+		// just so we don't return null
+		return "https://github.com/FWGS/xash3d-fwgs/releases/download/continuous/xash3d-fwgs-android.apk"
+	}
+
+	private fun getGameLibDir(ctx: Context, packageName: String): String? {
+		val packageInfo: PackageInfo = ctx.packageManager.getPackageInfo(packageName, 0)
+		return packageInfo.applicationInfo?.nativeLibraryDir
+	}
+
+	companion object {
+		fun getGames(ctx: Context, root: File): List<Game> {
+			val games = mutableListOf<Game>()
+
+			root.listFiles()?.forEach {
+				if (it.isDirectory) {
+					val subDirGameInfoFile = checkIfGamedir(it)
+					if (subDirGameInfoFile != null) {
+						games.add(Game(ctx, it, subDirGameInfoFile))
+					}
+				}
+			}
+
+			return games
+		}
+
+		fun checkIfGamedir(gamedir: File): File? {
+			gamedir.listFiles()?.forEach {
+				if (it.isFile) {
+					if (it.name.equals("liblist.gam", ignoreCase = true))
+						return it
+
+					if (it.name.equals("gameinfo.txt", ignoreCase = true))
+						return it
+				}
+			}
+
+			return null
+		}
+	}
 }
-
-//    Intent intent = new Intent("su.xash.engine.MOD");
-//                for (ResolveInfo info : context.getPackageManager()
-//                        .queryIntentActivities(intent, PackageManager.GET_META_DATA)) {
-//                        String packageName = info.activityInfo.applicationInfo.packageName;
-//                        String gameDir = info.activityInfo.applicationInfo.metaData.getString(
-//                        "su.xash.engine.gamedir");
-//                        Log.d(TAG, "package = " + packageName + " gamedir = " + gameDir);
-//                        }
-
-//public void startEngine(Context context) {
-//    context.startActivity(new Intent(context, XashActivity.class).setFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP).putExtra("gamedir", getGameDir()).putExtra("argv", getArguments()).putExtra("usevolume", getVolumeState()).putExtra("gamelibdir", getGameLibDir(context)).putExtra("package", getPackageName()));
-//}

android/app/src/main/java/su/xash/engine/model/GameLibDownloader.kt

@@ -0,0 +1,377 @@
+package su.xash.engine.model
+
+import android.content.Context
+import android.os.Build
+import android.util.Log
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.ensureActive
+import kotlinx.coroutines.withContext
+import org.json.JSONObject
+import java.io.File
+import java.io.FileOutputStream
+import java.io.IOException
+import java.net.HttpURLConnection
+import java.net.URL
+import java.security.MessageDigest
+import java.util.zip.ZipInputStream
+import kotlin.coroutines.coroutineContext
+
+class GameLibDownloader(private val context: Context) {
+
+	private val prefs get() = context.getSharedPreferences("gamelib_metadata", Context.MODE_PRIVATE)
+
+	// converts Android's ABI to library-suffix's arch names
+	fun getArch(): String? {
+		for (abi in Build.SUPPORTED_ABIS) {
+			when (abi) {
+				"arm64-v8a" -> return "arm64"
+				"armeabi-v7a" -> return "armv7l"
+				"x86_64" -> return "amd64"
+				"x86" -> return "i386"
+			}
+		}
+		return null
+	}
+
+	fun getLibsBaseDir(): File = File(context.filesDir, "gamelibs")
+
+	fun isDownloaded(gamedir: String): Boolean {
+		val dir = File(getLibsBaseDir(), gamedir)
+		if (dir.isDirectory && dir.list()?.isNotEmpty() == true)
+			return true
+
+		// zips extract to the case used in the manifest (e.g. "CAd"); the user's
+		// folder name might differ in case, so do a case-insensitive lookup too.
+		val base = getLibsBaseDir()
+		val match = base.listFiles()?.firstOrNull {
+			it.isDirectory && it.name.equals(gamedir, ignoreCase = true)
+		}
+		return match != null && (match.list()?.isNotEmpty() == true)
+	}
+
+	data class ManifestEntry(
+		val modKey: String,
+		val platformArch: String,
+		val filename: String,
+		val sha256: String,
+		val sourceJson: String?
+	)
+
+	data class SourceInfo(
+		val url: String?,
+		val branch: String?,
+		val commit: String?
+	)
+
+	private fun manifestCacheFile(): File = File(context.cacheDir, "hlsdk-manifest.json")
+
+	private suspend fun fetchManifest(): JSONObject? = fetchManifestOrError().first
+
+	private suspend fun fetchManifestOrError(): Pair<JSONObject?, Throwable?> {
+		val cacheFile = manifestCacheFile()
+		var connection: HttpURLConnection? = null
+		try {
+			connection = URL(MANIFEST_URL).openConnection() as HttpURLConnection
+			connection.connectTimeout = 10000
+			connection.readTimeout = 15000
+			connection.instanceFollowRedirects = true
+			connection.connect()
+
+			if (connection.responseCode != HttpURLConnection.HTTP_OK) {
+				val err = IOException("HTTP ${connection.responseCode} fetching manifest")
+				Log.w(TAG, "Manifest fetch failed: ${err.message}")
+				val cached = readCachedManifest(cacheFile)
+				return if (cached != null) cached to null else null to err
+			}
+
+			val text = connection.inputStream.bufferedReader().use { it.readText() }
+			val json = JSONObject(text)
+			val versionError = checkManifestVersion(json)
+			if (versionError != null) {
+				Log.w(TAG, "Manifest rejected: ${versionError.message}")
+				return null to versionError
+			}
+			cacheFile.writeText(text)
+			return json to null
+		} catch (e: Exception) {
+			Log.w(TAG, "Manifest fetch failed: ${e.message}")
+			val cached = readCachedManifest(cacheFile)
+			return if (cached != null) cached to null else null to e
+		} finally {
+			connection?.disconnect()
+		}
+	}
+
+	private fun readCachedManifest(cacheFile: File): JSONObject? {
+		if (!cacheFile.exists())
+			return null
+		val json = try {
+			JSONObject(cacheFile.readText())
+		} catch (_: Exception) {
+			return null
+		}
+		return if (checkManifestVersion(json) == null) json else null
+	}
+
+	private fun checkManifestVersion(json: JSONObject): IOException? {
+		if (!json.has("version"))
+			return IOException("Manifest missing 'version' field")
+		val v = json.opt("version")
+		if (v !is Int || v != MANIFEST_VERSION)
+			return IOException("Unsupported manifest version: $v (expected $MANIFEST_VERSION)")
+		return null
+	}
+
+	private fun lookupEntry(manifest: JSONObject, gamedir: String): ManifestEntry? {
+		val arch = getArch() ?: return null
+		val platformArch = "android-$arch"
+		val mods = manifest.optJSONObject("mods") ?: return null
+
+		// Find mod key case-insensitively
+		var modKey: String? = null
+		val keys = mods.keys()
+		while (keys.hasNext()) {
+			val k = keys.next()
+			if (k.equals(gamedir, ignoreCase = true)) {
+				modKey = k
+				break
+			}
+		}
+		if (modKey == null)
+			return null
+
+		val builds = mods.optJSONObject(modKey)?.optJSONObject("builds") ?: return null
+		val build = builds.optJSONObject(platformArch) ?: return null
+		val filename = build.optString("filename", "")
+		val sha256 = build.optString("sha256", "")
+		if (filename.isEmpty() || sha256.isEmpty())
+			return null
+
+		val sourceJson = build.optJSONObject("source")?.toString()
+		return ManifestEntry(modKey, platformArch, filename, sha256.lowercase(), sourceJson)
+	}
+
+	fun getSourceInfo(gamedir: String): SourceInfo? {
+		val raw = prefs.getString("${gamedir}_source", null) ?: return null
+		return try {
+			val o = JSONObject(raw)
+			SourceInfo(
+				url = o.optString("url").ifEmpty { null },
+				branch = o.optString("branch").ifEmpty { null },
+				commit = o.optString("commit").ifEmpty { null },
+			)
+		} catch (_: Exception) {
+			null
+		}
+	}
+
+	fun getDownloadTime(gamedir: String): Long =
+		prefs.getLong("${gamedir}_download_time", 0L)
+
+	sealed class Lookup {
+		data class Available(val entry: ManifestEntry) : Lookup()
+		object NotInManifest : Lookup()
+		data class Error(val cause: Throwable) : Lookup()
+	}
+
+	suspend fun lookupBuild(gamedir: String): Lookup {
+		return withContext(Dispatchers.IO) {
+			val (manifest, error) = fetchManifestOrError()
+			if (manifest == null)
+				return@withContext Lookup.Error(error ?: IOException("Failed to fetch manifest"))
+			val entry = lookupEntry(manifest, gamedir)
+				?: return@withContext Lookup.NotInManifest
+			Lookup.Available(entry)
+		}
+	}
+
+	suspend fun isUpdateAvailable(gamedir: String): Boolean {
+		return withContext(Dispatchers.IO) {
+			val manifest = fetchManifest() ?: return@withContext false
+			val entry = lookupEntry(manifest, gamedir) ?: return@withContext false
+			val storedSha = prefs.getString("${gamedir}_sha256", null)
+			storedSha == null || !storedSha.equals(entry.sha256, ignoreCase = true)
+		}
+	}
+
+	private fun urlForFilename(filename: String): String = "$RELEASE_BASE_URL/$filename"
+
+	private suspend fun tryDownload(
+		url: String,
+		dest: File,
+		onProgress: (Long, Long) -> Unit
+	): Exception? {
+		var connection: HttpURLConnection? = null
+		try {
+			connection = URL(url).openConnection() as HttpURLConnection
+			connection.connectTimeout = 10000
+			connection.readTimeout = 30000
+			connection.instanceFollowRedirects = true
+			connection.connect()
+
+			val code = connection.responseCode
+			if (code !in 200..299)
+				return IOException("HTTP $code: $url")
+
+			val total = connection.contentLengthLong
+			var downloaded = 0L
+			var lastEmit = 0L
+
+			connection.inputStream.use { input ->
+				FileOutputStream(dest).use { output ->
+					val buffer = ByteArray(65536)
+					while (true) {
+						coroutineContext.ensureActive()
+						val read = input.read(buffer)
+						if (read < 0)
+							break
+						output.write(buffer, 0, read)
+						downloaded += read
+						val now = System.currentTimeMillis()
+						if (now - lastEmit >= PROGRESS_INTERVAL_MS) {
+							lastEmit = now
+							withContext(Dispatchers.Main) { onProgress(downloaded, total) }
+						}
+					}
+				}
+			}
+			withContext(Dispatchers.Main) { onProgress(downloaded, total) }
+
+			return null
+		} catch (e: Exception) {
+			return e
+		} finally {
+			connection?.disconnect()
+		}
+	}
+
+	suspend fun download(gamedir: String, onProgress: (Long, Long) -> Unit): Result<Unit> {
+		return withContext(Dispatchers.IO) {
+			val manifest = fetchManifest()
+				?: return@withContext Result.failure(IOException("Failed to fetch manifest"))
+
+			val entry = lookupEntry(manifest, gamedir)
+				?: return@withContext Result.failure(IOException("No build for '$gamedir' on ${getArch() ?: "this arch"}"))
+
+			val url = urlForFilename(entry.filename)
+			val tempFile = File(context.cacheDir, entry.filename)
+
+			try {
+				coroutineContext.ensureActive()
+				Log.i(TAG, "Downloading $url -> ${tempFile.absolutePath}")
+				val error = tryDownload(url, tempFile, onProgress)
+				if (error != null)
+					return@withContext Result.failure(error)
+
+				val actualSha = computeSHA256(tempFile)
+				Log.i(TAG, "Downloaded ${tempFile.length()} bytes, SHA-256: $actualSha (expected ${entry.sha256})")
+
+				if (!actualSha.equals(entry.sha256, ignoreCase = true))
+					return@withContext Result.failure(IOException("SHA-256 mismatch: expected ${entry.sha256}, got $actualSha"))
+
+				val destDir = getLibsBaseDir()
+				destDir.mkdirs()
+				val destCanon = destDir.canonicalPath
+
+				// Remove any prior install (possibly under a differently-cased dir) so we
+				// don't leave behind .so files from an older build.
+				destDir.listFiles()?.forEach {
+					if (it.isDirectory && it.name.equals(entry.modKey, ignoreCase = true))
+						it.deleteRecursively()
+				}
+
+				Log.i(TAG, "Extracting to ${destDir.absolutePath}")
+
+				val extractedFiles = mutableListOf<String>()
+				ZipInputStream(tempFile.inputStream()).use { zip ->
+					var zipEntry = zip.nextEntry
+					while (zipEntry != null) {
+						coroutineContext.ensureActive()
+						if (!zipEntry.isDirectory) {
+							val outFile = File(destDir, zipEntry.name)
+							if (!outFile.canonicalPath.startsWith(destCanon + File.separator))
+								throw SecurityException("Zip path traversal: ${zipEntry.name}")
+							outFile.parentFile?.mkdirs()
+							FileOutputStream(outFile).use { zip.copyTo(it) }
+							// ZipInputStream doesn't restore Unix permissions; shared libraries
+							// need the execute bit so dlopen can mmap them with PROT_EXEC
+							if (outFile.name.endsWith(".so"))
+								outFile.setExecutable(true, false)
+							extractedFiles.add("  ${outFile.absolutePath} (${outFile.length()} bytes, executable: ${outFile.canExecute()})")
+						}
+						zip.closeEntry()
+						zipEntry = zip.nextEntry
+					}
+				}
+
+				Log.i(TAG, "Extracted ${extractedFiles.size} files:")
+				extractedFiles.forEach { Log.i(TAG, it) }
+
+				prefs.edit()
+					.putString("${gamedir}_sha256", entry.sha256)
+					.putString("${gamedir}_filename", entry.filename)
+					.putString("${gamedir}_source", entry.sourceJson)
+					.putLong("${gamedir}_download_time", System.currentTimeMillis())
+					.apply()
+
+				Result.success(Unit)
+			} catch (e: Exception) {
+				// Best-effort: rewinding to a clean state on failure
+				File(getLibsBaseDir(), entry.modKey).deleteRecursively()
+				Result.failure(e)
+			} finally {
+				tempFile.delete()
+			}
+		}
+	}
+
+	fun logExistingLibs(gamedir: String) {
+		val gameDir = File(getLibsBaseDir(), gamedir)
+		val resolved = if (gameDir.exists()) {
+			gameDir
+		} else {
+			getLibsBaseDir().listFiles()?.firstOrNull {
+				it.isDirectory && it.name.equals(gamedir, ignoreCase = true)
+			}
+		}
+
+		if (resolved == null) {
+			Log.i(TAG, "Game libs dir does not exist for $gamedir")
+			return
+		}
+
+		Log.i(TAG, "Existing game libs under ${resolved.absolutePath}:")
+		resolved.walkTopDown().filter { it.isFile }.forEach {
+			Log.i(TAG, "  ${it.absolutePath} (${it.length()} bytes)")
+		}
+		val storedSha = prefs.getString("${gamedir}_sha256", null)
+		val downloadTime = prefs.getLong("${gamedir}_download_time", 0L)
+		Log.i(TAG, "Archive SHA-256: $storedSha")
+		if (downloadTime > 0L)
+			Log.i(TAG, "Downloaded at: ${java.util.Date(downloadTime)}")
+	}
+
+	private fun computeSHA256(file: File): String {
+		val digest = MessageDigest.getInstance("SHA-256")
+		file.inputStream().use { input ->
+			val buffer = ByteArray(65536)
+			while (true) {
+				val read = input.read(buffer)
+				if (read < 0)
+					break
+				digest.update(buffer, 0, read)
+			}
+		}
+		return digest.digest().joinToString("") { "%02x".format(it) }
+	}
+
+	companion object {
+		private const val TAG = "GameLibDownloader"
+		private const val PROGRESS_INTERVAL_MS = 100L
+		private const val RELEASE_BASE_URL =
+			"https://github.com/FWGS/hlsdk-mega-build/releases/download/continuous"
+		private const val MANIFEST_URL =
+			"$RELEASE_BASE_URL/manifest.json"
+		private const val MANIFEST_VERSION = 1
+	}
+}

android/app/src/main/java/su/xash/engine/model/InstallStatusReceiver.kt

@@ -0,0 +1,42 @@
+package su.xash.engine.model
+
+import android.content.BroadcastReceiver
+import android.content.Context
+import android.content.Intent
+import android.content.pm.PackageInstaller
+import android.os.Build
+import android.util.Log
+import android.widget.Toast
+import su.xash.engine.R
+
+class InstallStatusReceiver : BroadcastReceiver() {
+	override fun onReceive(context: Context, intent: Intent) {
+		val status = intent.getIntExtra(PackageInstaller.EXTRA_STATUS, -1)
+		when (status) {
+			PackageInstaller.STATUS_PENDING_USER_ACTION -> {
+				val confirm: Intent? = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+					intent.getParcelableExtra(Intent.EXTRA_INTENT, Intent::class.java)
+				} else {
+					@Suppress("DEPRECATION")
+					intent.getParcelableExtra(Intent.EXTRA_INTENT)
+				}
+				confirm?.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
+				confirm?.let { context.startActivity(it) }
+			}
+			PackageInstaller.STATUS_SUCCESS -> Log.i(TAG, "Install succeeded")
+			else -> {
+				val msg = intent.getStringExtra(PackageInstaller.EXTRA_STATUS_MESSAGE).orEmpty()
+				Log.w(TAG, "Install status $status: $msg")
+				Toast.makeText(
+					context,
+					context.getString(R.string.engine_install_failed, msg),
+					Toast.LENGTH_LONG,
+				).show()
+			}
+		}
+	}
+
+	companion object {
+		private const val TAG = "InstallStatus"
+	}
+}

android/app/src/main/java/su/xash/engine/model/ModDatabase.kt

@@ -1,59 +0,0 @@
-package su.xash.engine.model
-
-import org.json.JSONArray
-import org.json.JSONObject
-import java.io.InputStream
-
-class ModDatabase(inputStream: InputStream) {
-    val entries = mutableListOf<Entry>()
-
-    companion object {
-        const val VERSION = 1
-
-        fun getFilename(): String {
-            return "v${VERSION}.json"
-        }
-    }
-
-    init {
-        inputStream.bufferedReader().use {
-            val jsonArray = JSONArray(it.readText())
-
-            for (i in 0..<jsonArray.length()) {
-                entries.add(Entry(jsonArray.getJSONObject(i)))
-            }
-        }
-    }
-
-    fun getByGameDir(gamedir: String): Entry? {
-        return entries.filter { it.gamedir.equals(gamedir) }.firstOrNull()
-    }
-
-
-    inner class Entry(jsonObject: JSONObject) {
-        var name: String? = null
-        var appid: Int? = null
-        var gamedir: String? = null
-
-        // TODO Depots
-        var pkgname: String? = null
-
-        init {
-            if (jsonObject.has("name")) {
-                name = jsonObject.getString("name");
-            }
-
-            if (jsonObject.has("app_id")) {
-                appid = jsonObject.getInt("app_id");
-            }
-
-            if (jsonObject.has("gamedir")) {
-                gamedir = jsonObject.getString("gamedir");
-            }
-
-            if (jsonObject.has("package_name")) {
-                pkgname = jsonObject.getString("package_name");
-            }
-        }
-    }
-}

android/app/src/main/java/su/xash/engine/ui/library/LibraryFragment.kt

@@ -1,94 +1,184 @@
 package su.xash.engine.ui.library
 
-import android.annotation.SuppressLint
+import android.Manifest
 import android.content.Intent
+import android.content.pm.PackageManager
+import android.net.Uri
+import android.os.Build
 import android.os.Bundle
-import android.util.Log
+import android.os.Environment
+import android.provider.Settings
 import android.view.LayoutInflater
 import android.view.Menu
 import android.view.MenuInflater
 import android.view.MenuItem
 import android.view.View
 import android.view.ViewGroup
+import androidx.activity.result.contract.ActivityResultContracts
+import androidx.core.app.ActivityCompat
+import androidx.core.content.ContextCompat
 import androidx.core.view.MenuProvider
 import androidx.fragment.app.Fragment
 import androidx.fragment.app.activityViewModels
 import androidx.lifecycle.Lifecycle
-import androidx.lifecycle.lifecycleScope
-import androidx.lifecycle.repeatOnLifecycle
 import androidx.navigation.fragment.findNavController
-import kotlinx.coroutines.launch
+import com.google.android.material.dialog.MaterialAlertDialogBuilder
+import su.xash.engine.BuildConfig
 import su.xash.engine.R
 import su.xash.engine.adapters.GameAdapter
 import su.xash.engine.databinding.FragmentLibraryBinding
 
+
 class LibraryFragment : Fragment(), MenuProvider {
-    private var _binding: FragmentLibraryBinding? = null
-    private val binding get() = _binding!!
+	private var _binding: FragmentLibraryBinding? = null
+	private val binding get() = _binding!!
 
-    private val libraryViewModel: LibraryViewModel by activityViewModels()
+	private val libraryViewModel: LibraryViewModel by activityViewModels()
 
-    override fun onCreateView(
-        inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
-    ): View? {
-        _binding = FragmentLibraryBinding.inflate(inflater, container, false)
+	private val startActivityForResult =
+		registerForActivityResult(ActivityResultContracts.StartActivityForResult()) {
+			if (checkStoragePermissions()) {
+				libraryViewModel.reloadGames(requireContext())
+			}
+		}
 
-        val adapter = GameAdapter(libraryViewModel)
-        binding.gamesList.adapter = adapter
+	private val requiredPermissions = arrayOf(
+		Manifest.permission.READ_EXTERNAL_STORAGE,
+		Manifest.permission.WRITE_EXTERNAL_STORAGE
+	)
 
-        requireActivity().addMenuProvider(this, viewLifecycleOwner, Lifecycle.State.RESUMED)
+	private val requestPermissionLauncher = registerForActivityResult(
+		ActivityResultContracts.RequestMultiplePermissions()
+	) { permissions ->
+		val granted = permissions.entries.all { it.value }
+		if (granted) {
+			libraryViewModel.reloadGames(requireContext())
+		} else {
+			checkStoragePermissions()
+		}
+	}
 
-        return binding.root
-    }
+	private fun checkStoragePermissions(): Boolean {
+		if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
+			if (!Environment.isExternalStorageManager()) {
+				MaterialAlertDialogBuilder(requireContext()).apply {
+					setTitle(R.string.file_access_required)
+					setMessage(R.string.file_access_message)
+					setPositiveButton(R.string.open_settings) { _, _ ->
+						startActivityForResult.launch(
+							Intent(Settings.ACTION_MANAGE_APP_ALL_FILES_ACCESS_PERMISSION).setData(
+								Uri.fromParts("package", BuildConfig.APPLICATION_ID, null)
+							)
+						)
+					}
+					setNeutralButton(R.string.done_check_permissions) { dialog, _ ->
+						checkStoragePermissions()
+					}
+					setCancelable(false)
+					show()
 
-    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
-        binding.swipeRefresh.setOnRefreshListener { libraryViewModel.reloadGames(requireContext()) }
+					return false
+				}
+			} else {
+				return true
+			}
+		} else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+			val permissionsNeeded = requiredPermissions.filter {
+				ContextCompat.checkSelfPermission(
+					requireContext(),
+					it
+				) != PackageManager.PERMISSION_GRANTED
+			}.toTypedArray()
 
-        libraryViewModel.isReloading.observe(viewLifecycleOwner) {
-            binding.swipeRefresh.isRefreshing = it
-        }
+			if (!permissionsNeeded.isEmpty()) {
+				val showRationale = permissionsNeeded.any {
+					ActivityCompat.shouldShowRequestPermissionRationale(requireActivity(), it)
+				}
 
-        libraryViewModel.installedGames.observe(viewLifecycleOwner) {
-            (binding.gamesList.adapter as GameAdapter).submitList(it)
-        }
+				MaterialAlertDialogBuilder(requireContext()).apply {
+					setTitle(R.string.external_storage_required)
+					setMessage(R.string.external_storage_message)
+					setPositiveButton(R.string.open_settings) { _, _ ->
+						if (showRationale) {
+							requestPermissionLauncher.launch(permissionsNeeded)
+						} else {
+							val intent =
+								Intent(Settings.ACTION_APPLICATION_DETAILS_SETTINGS).apply {
+									data =
+										Uri.fromParts("package", requireContext().packageName, null)
+								}
+							startActivity(intent)
+						}
+					}
+					setNeutralButton(R.string.done_check_permissions) { _, _ ->
+						checkStoragePermissions()
+					}
+					setCancelable(false)
+					show()
+				}
 
-        libraryViewModel.workInfos.observe(viewLifecycleOwner) {
-            libraryViewModel.refreshDownloads(requireContext())
-        }
+				return false
+			} else {
+				return true
+			}
+		} else {
+			return true
+		}
+	}
 
-        libraryViewModel.downloads.observe(viewLifecycleOwner) {
-            libraryViewModel.reloadGames(requireContext())
-        }
-    }
+	override fun onCreateView(
+		inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
+	): View {
+		_binding = FragmentLibraryBinding.inflate(inflater, container, false)
 
-    override fun onDestroyView() {
-        super.onDestroyView()
-        _binding = null
-    }
+		val adapter = GameAdapter(libraryViewModel)
+		binding.gamesList.adapter = adapter
 
-    override fun onCreateMenu(menu: Menu, menuInflater: MenuInflater) {
-        menuInflater.inflate(R.menu.menu_library, menu)
-    }
+		requireActivity().addMenuProvider(this, viewLifecycleOwner, Lifecycle.State.RESUMED)
 
-    override fun onMenuItemSelected(menuItem: MenuItem): Boolean {
-        when (menuItem.itemId) {
-            R.id.action_browse -> {
-                startActivity(
-                    Intent(Intent.ACTION_VIEW).setDataAndType(
-                        null, "vnd.android.document/directory"
-                    )
-                )
-            }
+		return binding.root
+	}
 
-            R.id.action_install -> {
-                findNavController().navigate(R.id.action_libraryFragment_to_setupFragment)
-            }
+	override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+		binding.swipeRefresh.setOnRefreshListener { libraryViewModel.reloadGames(requireContext()) }
 
-            R.id.action_settings -> {
-                findNavController().navigate(R.id.action_libraryFragment_to_appSettingsFragment)
-            }
-        }
+		libraryViewModel.isReloading.observe(viewLifecycleOwner) {
+			binding.swipeRefresh.isRefreshing = it
+		}
 
-        return false
-    }
-}
+		libraryViewModel.installedGames.observe(viewLifecycleOwner) {
+			(binding.gamesList.adapter as GameAdapter).submitList(it)
+		}
+
+		if (checkStoragePermissions()) {
+			libraryViewModel.reloadGames(requireContext())
+		}
+	}
+
+	override fun onDestroyView() {
+		super.onDestroyView()
+		_binding = null
+	}
+
+	override fun onCreateMenu(menu: Menu, menuInflater: MenuInflater) {
+		menuInflater.inflate(R.menu.menu_library, menu)
+	}
+
+	override fun onMenuItemSelected(menuItem: MenuItem): Boolean {
+		when (menuItem.itemId) {
+			R.id.action_settings -> {
+				findNavController().navigate(R.id.action_libraryFragment_to_appSettingsFragment)
+			}
+		}
+
+		return false
+	}
+
+	override fun onResume() {
+		super.onResume()
+
+		if (checkStoragePermissions()) {
+			libraryViewModel.reloadGames(requireContext())
+		}
+	}
+}

android/app/src/main/java/su/xash/engine/ui/library/LibraryViewModel.kt

@@ -3,125 +3,56 @@ package su.xash.engine.ui.library
 import android.app.Application
 import android.content.Context
 import android.content.SharedPreferences
-import android.net.Uri
-import androidx.documentfile.provider.DocumentFile
+import android.os.Environment
 import androidx.lifecycle.AndroidViewModel
 import androidx.lifecycle.LiveData
 import androidx.lifecycle.MutableLiveData
-import androidx.lifecycle.ViewModel
-import androidx.lifecycle.lifecycleScope
 import androidx.lifecycle.viewModelScope
-import androidx.preference.PreferenceManager
-import androidx.work.Data
-import androidx.work.OneTimeWorkRequestBuilder
-import androidx.work.OutOfQuotaPolicy
-import androidx.work.WorkInfo
-import androidx.work.WorkManager
 import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 import su.xash.engine.model.Game
-import su.xash.engine.model.ModDatabase
-import su.xash.engine.workers.FileCopyWorker
-import su.xash.engine.workers.KEY_FILE_URI
-import java.util.Locale
-
-const val TAG_INSTALL = "TAG_INSTALL"
+import su.xash.engine.util.Nomedia
+import java.io.File
 
 class LibraryViewModel(application: Application) : AndroidViewModel(application) {
-    val installedGames: LiveData<List<Game>> get() = _installedGames
-    private val _installedGames = MutableLiveData(emptyList<Game>())
+	val installedGames: LiveData<List<Game>> get() = _installedGames
+	private val _installedGames = MutableLiveData(emptyList<Game>())
 
-    val downloads: LiveData<List<Game>> get() = _downloads
-    private val _downloads = MutableLiveData(emptyList<Game>())
+	val isReloading: LiveData<Boolean> get() = _isReloading
+	private val _isReloading = MutableLiveData(false)
 
-    val isReloading: LiveData<Boolean> get() = _isReloading
-    private val _isReloading = MutableLiveData(false)
+	val selectedItem: LiveData<Game> get() = _selectedItem
+	private val _selectedItem = MutableLiveData<Game>()
 
-    private val workManager = WorkManager.getInstance(application.applicationContext)
-    val workInfos: LiveData<List<WorkInfo>> = workManager.getWorkInfosByTagLiveData(TAG_INSTALL)
+	private val appPreferences: SharedPreferences =
+		application.getSharedPreferences("app_preferences", Context.MODE_PRIVATE)
 
-    val selectedItem: LiveData<Game> get() = _selectedItem
-    private val _selectedItem = MutableLiveData<Game>()
+	fun reloadGames(ctx: Context) {
+		if (isReloading.value == true) {
+			return
+		}
+		_isReloading.value = true
 
-    val appPreferences = application.getSharedPreferences("app_preferences", Context.MODE_PRIVATE)
-    val modDb: ModDatabase
+		viewModelScope.launch {
+			withContext(Dispatchers.IO) {
+				val rootPath = appPreferences.getString("game_path", null)
+					?: (Environment.getExternalStorageDirectory().absolutePath + "/xash")
+				val root = File(rootPath)
 
-    init {
-        modDb = application.assets.open(ModDatabase.getFilename()).use { ModDatabase(it) }
-        reloadGames(application.applicationContext)
-    }
+				Nomedia.ensureNomedia(root)
 
-    fun reloadGames(ctx: Context) {
-        if (isReloading.value == true) {
-            return
-        }
-        _isReloading.value = true
+				_installedGames.postValue(Game.getGames(ctx, root))
+				_isReloading.postValue(false)
+			}
+		}
+	}
 
-        viewModelScope.launch {
-            withContext(Dispatchers.IO) {
-                val games = mutableListOf<Game>()
-                val root = DocumentFile.fromFile(ctx.getExternalFilesDir(null)!!)
+	fun setSelectedGame(game: Game) {
+		_selectedItem.value = game
+	}
 
-                val installedGames = Game.getGames(ctx, root)
-                    .filter { p -> _downloads.value?.any { p.basedir.name == it.basedir.name } == false }
-
-                games.addAll(installedGames)
-                downloads.value?.let { games.addAll(it) }
-
-                _installedGames.postValue(games)
-                _isReloading.postValue(false)
-            }
-        }
-    }
-
-    fun refreshDownloads(ctx: Context) {
-        viewModelScope.launch {
-            withContext(Dispatchers.IO) {
-                val games = mutableListOf<Game>()
-
-                workInfos.value?.filter {
-                    it.state == WorkInfo.State.RUNNING && !it.progress.getString(FileCopyWorker.Input)
-                        .isNullOrEmpty()
-                }?.forEach {
-                    val uri = Uri.parse(it.progress.getString(FileCopyWorker.Input))
-                    val file = DocumentFile.fromTreeUri(ctx, uri)
-                    games.addAll(Game.getGames(ctx, file!!))
-                    games.forEach { g -> g.installed = false }
-                }
-
-                _downloads.postValue(games)
-            }
-        }
-    }
-
-    fun installGame(uri: Uri) {
-        val data = Data.Builder().putString(KEY_FILE_URI, uri.toString()).build()
-        val request = OneTimeWorkRequestBuilder<FileCopyWorker>().run {
-            setInputData(data)
-            addTag(TAG_INSTALL)
-            build()
-        }
-        workManager.enqueue(request)
-    }
-
-    fun setSelectedGame(game: Game) {
-        _selectedItem.value = game
-    }
-
-    fun uninstallGame(game: Game) {
-        viewModelScope.launch {
-            withContext(Dispatchers.IO) {
-                game.installed = false
-                game.basedir.delete()
-                _installedGames.postValue(_installedGames.value)
-            }
-        }
-    }
-
-    fun startEngine(ctx: Context, game: Game) {
-        game.startEngine(ctx)
-    }
-}
+	fun startEngine(ctx: Context, game: Game) {
+		game.startEngine(ctx)
+	}
+}

android/app/src/main/java/su/xash/engine/ui/settings/AppSettingsFragment.kt

@@ -8,24 +8,24 @@ import androidx.fragment.app.Fragment
 import su.xash.engine.databinding.FragmentAppSettingsBinding
 
 class AppSettingsFragment : Fragment() {
-    private var _binding: FragmentAppSettingsBinding? = null
-    private val binding get() = _binding!!
+	private var _binding: FragmentAppSettingsBinding? = null
+	private val binding get() = _binding!!
 
-    override fun onCreateView(
-        inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
-    ): View? {
-        _binding = FragmentAppSettingsBinding.inflate(inflater, container, false)
-        return binding.root
-    }
+	override fun onCreateView(
+		inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
+	): View {
+		_binding = FragmentAppSettingsBinding.inflate(inflater, container, false)
+		return binding.root
+	}
 
-    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
-        super.onViewCreated(view, savedInstanceState)
-        childFragmentManager.beginTransaction()
-            .add(binding.settingsFragment.id, AppSettingsPreferenceFragment()).commit();
-    }
+	override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+		super.onViewCreated(view, savedInstanceState)
+		childFragmentManager.beginTransaction()
+			.add(binding.settingsFragment.id, AppSettingsPreferenceFragment()).commit();
+	}
 
-    override fun onDestroyView() {
-        super.onDestroyView()
-        _binding = null
-    }
+	override fun onDestroyView() {
+		super.onDestroyView()
+		_binding = null
+	}
 }

android/app/src/main/java/su/xash/engine/ui/settings/AppSettingsPreferenceFragment.kt

@@ -1,12 +1,19 @@
 package su.xash.engine.ui.settings
 
 import android.os.Bundle
+import androidx.navigation.fragment.findNavController
+import androidx.preference.Preference
 import androidx.preference.PreferenceFragmentCompat
 import su.xash.engine.R
 
 class AppSettingsPreferenceFragment() : PreferenceFragmentCompat() {
-    override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
-        preferenceManager.sharedPreferencesName = "app_preferences";
-        setPreferencesFromResource(R.xml.app_preferences, rootKey);
-    }
+	override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
+		preferenceManager.sharedPreferencesName = "app_preferences";
+		setPreferencesFromResource(R.xml.app_preferences, rootKey);
+
+		findPreference<Preference>("crash_logs")?.setOnPreferenceClickListener {
+			findNavController().navigate(R.id.action_appSettingsFragment_to_crashLogsFragment)
+			true
+		}
+	}
 }

android/app/src/main/java/su/xash/engine/ui/settings/CrashLogsFragment.kt

@@ -0,0 +1,68 @@
+package su.xash.engine.ui.settings
+
+import android.os.Bundle
+import androidx.appcompat.app.AlertDialog
+import androidx.preference.Preference
+import androidx.preference.PreferenceFragmentCompat
+import su.xash.engine.R
+import su.xash.engine.util.CrashReports
+import su.xash.engine.util.monospaceTextView
+import java.text.SimpleDateFormat
+import java.util.Date
+import java.util.Locale
+
+class CrashLogsFragment : PreferenceFragmentCompat() {
+	override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
+		preferenceScreen = preferenceManager.createPreferenceScreen(requireContext())
+		populate()
+	}
+
+	override fun onResume() {
+		super.onResume()
+		populate()
+	}
+
+	private fun populate() {
+		val ctx = requireContext()
+		preferenceScreen.removeAll()
+
+		val dirs = CrashReports.historyDir(ctx).listFiles()
+			?.filter { it.isDirectory }
+			?.sortedByDescending { it.lastModified() }
+			?: emptyList()
+
+		if (dirs.isEmpty()) {
+			preferenceScreen.addPreference(Preference(ctx).apply {
+				setTitle(R.string.crash_logs_empty)
+				isSelectable = false
+			})
+			return
+		}
+
+		val fmt = SimpleDateFormat("yyyy-MM-dd HH:mm:ss", Locale.US)
+		dirs.forEach { dir ->
+			preferenceScreen.addPreference(Preference(ctx).apply {
+				title = fmt.format(Date(dir.lastModified()))
+				summary = dir.name
+				setOnPreferenceClickListener {
+					showCrashLog(CrashReports.Entry(dir))
+					true
+				}
+			})
+		}
+	}
+
+	private fun showCrashLog(entry: CrashReports.Entry) {
+		val ctx = requireContext()
+		AlertDialog.Builder(ctx)
+			.setTitle(entry.name)
+			.setView(monospaceTextView(ctx, entry.summary()))
+			.setPositiveButton(R.string.crash_send_to_developers) { _, _ -> CrashReports.sendByEmail(ctx, entry) }
+			.setNeutralButton(R.string.crash_share) { _, _ -> CrashReports.share(ctx, entry) }
+			.setNegativeButton(R.string.crash_log_delete) { _, _ ->
+				entry.dir.deleteRecursively()
+				populate()
+			}
+			.show()
+	}
+}

android/app/src/main/java/su/xash/engine/ui/settings/GameSettingsFragment.kt

@@ -6,59 +6,52 @@ import android.view.View
 import android.view.ViewGroup
 import androidx.fragment.app.Fragment
 import androidx.fragment.app.activityViewModels
-import androidx.navigation.fragment.findNavController
-import su.xash.engine.R
 import su.xash.engine.databinding.FragmentGameSettingsBinding
 import su.xash.engine.ui.library.LibraryViewModel
 
 class GameSettingsFragment : Fragment() {
-    private var _binding: FragmentGameSettingsBinding? = null
-    private val binding get() = _binding!!
+	private var _binding: FragmentGameSettingsBinding? = null
+	private val binding get() = _binding!!
 
-    private val libraryViewModel: LibraryViewModel by activityViewModels()
+	private val libraryViewModel: LibraryViewModel by activityViewModels()
 
-    override fun onCreateView(
-        inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
-    ): View? {
-        _binding = FragmentGameSettingsBinding.inflate(inflater, container, false)
-        return binding.root
-    }
+	override fun onCreateView(
+		inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
+	): View {
+		_binding = FragmentGameSettingsBinding.inflate(inflater, container, false)
+		return binding.root
+	}
 
-    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
-        super.onViewCreated(view, savedInstanceState)
+	override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+		super.onViewCreated(view, savedInstanceState)
 
-        val game = libraryViewModel.selectedItem.value!!
+		val game = libraryViewModel.selectedItem.value!!
 
-        binding.gameCard.apply {
-            gameTitle.text = game.title
+		binding.gameCard.apply {
+			gameTitle.text = game.title
 
-            if (game.icon != null) {
-                gameIcon.setImageBitmap(game.icon)
-            } else {
-                gameIcon.visibility = View.GONE
-            }
+			if (game.icon != null) {
+				gameIcon.setImageBitmap(game.icon)
+			} else {
+				gameIcon.visibility = View.GONE
+			}
 
-            if (game.cover != null) {
-                gameCover.setImageBitmap(game.cover)
-            } else {
-                gameCover.visibility = View.GONE
-            }
+			if (game.cover != null) {
+				gameCover.setImageBitmap(game.cover)
+			} else {
+				gameCover.visibility = View.GONE
+			}
 
-            buttonsContainer.visibility = View.GONE
-        }
+			buttonsContainer.visibility = View.GONE
+		}
 
-        childFragmentManager.beginTransaction()
-            .add(binding.settingsFragment.id, GameSettingsPreferenceFragment(game))
-            .commit();
+		childFragmentManager.beginTransaction()
+			.add(binding.settingsFragment.id, GameSettingsPreferenceFragment(game))
+			.commit();
+	}
 
-        binding.bottomNavigation.menu.findItem(R.id.action_uninstall).setOnMenuItemClickListener {
-            libraryViewModel.uninstallGame(game)
-            findNavController().popBackStack()
-        }
-    }
-
-    override fun onDestroyView() {
-        super.onDestroyView()
-        _binding = null
-    }
+	override fun onDestroyView() {
+		super.onDestroyView()
+		_binding = null
+	}
 }

android/app/src/main/java/su/xash/engine/ui/settings/GameSettingsPreferenceFragment.kt

@@ -1,40 +1,93 @@
 package su.xash.engine.ui.settings
 
+import android.content.Intent
 import android.os.Bundle
+import androidx.core.net.toUri
 import androidx.preference.ListPreference
+import androidx.preference.Preference
 import androidx.preference.PreferenceFragmentCompat
 import androidx.preference.SwitchPreferenceCompat
 import su.xash.engine.R
 import su.xash.engine.model.Game
+import su.xash.engine.model.GameLibDownloader
+import java.text.DateFormat
+import java.util.Date
 
 class GameSettingsPreferenceFragment(val game: Game) : PreferenceFragmentCompat() {
-    override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
-        preferenceManager.sharedPreferencesName = game.basedir.name;
-        setPreferencesFromResource(R.xml.game_preferences, rootKey);
+	override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
+		preferenceManager.sharedPreferencesName = game.basedir.name;
+		setPreferencesFromResource(R.xml.game_preferences, rootKey);
 
-        val packageList = findPreference<ListPreference>("package_name")!!
-        packageList.entries = arrayOf(getString(R.string.app_name))
-        packageList.entryValues = arrayOf(requireContext().packageName)
+		val packageList = findPreference<ListPreference>("package_name")!!
+		packageList.entries = arrayOf(getString(R.string.app_name))
+		packageList.entryValues = arrayOf(requireContext().packageName)
 
-        if (packageList.value == null) {
-            packageList.setValueIndex(0);
-        }
+		if (packageList.value == null) {
+			packageList.setValueIndex(0);
+		}
 
-        val separatePackages = findPreference<SwitchPreferenceCompat>("separate_libraries")!!
-        val clientPackage = findPreference<ListPreference>("client_package")!!
-        val serverPackage = findPreference<ListPreference>("server_package")!!
-        separatePackages.setOnPreferenceChangeListener { _, newValue ->
-            if (newValue == true) {
-                packageList.isVisible = false
-                clientPackage.isVisible = true
-                serverPackage.isVisible = true
-            } else {
-                packageList.isVisible = true
-                clientPackage.isVisible = false
-                serverPackage.isVisible = false
-            }
+		if (game.basedir.name.equals("cstrike", ignoreCase = true)
+			|| game.basedir.name.equals("czero", ignoreCase = true)) {
+			val enableYaPBBots = findPreference<SwitchPreferenceCompat>("enable_yapb_bots")!!
+			enableYaPBBots.isVisible = true
+		}
 
-            true
-        }
-    }
+		populateDownloadedBuildInfo()
+
+		val separatePackages = findPreference<SwitchPreferenceCompat>("separate_libraries")!!
+		val clientPackage = findPreference<ListPreference>("client_package")!!
+		val serverPackage = findPreference<ListPreference>("server_package")!!
+		separatePackages.setOnPreferenceChangeListener { _, newValue ->
+			if (newValue == true) {
+				packageList.isVisible = false
+				clientPackage.isVisible = true
+				serverPackage.isVisible = true
+			} else {
+				packageList.isVisible = true
+				clientPackage.isVisible = false
+				serverPackage.isVisible = false
+			}
+
+			true
+		}
+	}
+
+	private fun populateDownloadedBuildInfo() {
+		val downloader = GameLibDownloader(requireContext())
+		val source = downloader.getSourceInfo(game.basedir.name) ?: return
+		val downloadedAt = downloader.getDownloadTime(game.basedir.name)
+
+		val urlPref = findPreference<Preference>("source_url")!!
+		urlPref.isVisible = true
+		urlPref.summary = source.url ?: "—"
+		urlPref.isEnabled = source.url != null
+		urlPref.setOnPreferenceClickListener {
+			source.url?.let {
+				startActivity(Intent(Intent.ACTION_VIEW, it.toUri()))
+			}
+			true
+		}
+
+		val branchPref = findPreference<Preference>("source_branch")!!
+		branchPref.isVisible = true
+		branchPref.summary = source.branch ?: "—"
+
+		val commitPref = findPreference<Preference>("source_commit")!!
+		commitPref.isVisible = true
+		commitPref.summary = source.commit ?: "—"
+		commitPref.isEnabled = source.commit != null && source.url != null
+		commitPref.setOnPreferenceClickListener {
+			// FIXME: GitHub-styled URL!
+			val target = "${source.url!!.trimEnd('/')}/commit/${source.commit}"
+			startActivity(Intent(Intent.ACTION_VIEW, target.toUri()))
+			true
+		}
+
+		val timePref = findPreference<Preference>("downloaded_at")!!
+		timePref.isVisible = true
+		timePref.summary = if (downloadedAt > 0L)
+			DateFormat.getDateTimeInstance().format(Date(downloadedAt))
+		else
+			"—"
+	}
 }

android/app/src/main/java/su/xash/engine/ui/setup/SetupFragment.kt

@@ -1,48 +0,0 @@
-package su.xash.engine.ui.setup
-
-import android.os.Bundle
-import android.view.LayoutInflater
-import android.view.View
-import android.view.ViewGroup
-import androidx.fragment.app.Fragment
-import androidx.fragment.app.activityViewModels
-import androidx.viewpager2.adapter.FragmentStateAdapter
-import su.xash.engine.databinding.FragmentSetupBinding
-import su.xash.engine.ui.setup.pages.LocationPageFragment
-import su.xash.engine.ui.setup.pages.WelcomePageFragment
-
-class SetupFragment : Fragment() {
-    private var _binding: FragmentSetupBinding? = null
-    private val binding get() = _binding!!
-    private val setupViewModel: SetupViewModel by activityViewModels()
-
-    private lateinit var setupPageAdapter: SetupPageAdapter
-
-    override fun onCreateView(
-        inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
-    ): View? {
-        _binding = FragmentSetupBinding.inflate(inflater, container, false)
-        return binding.root
-    }
-
-    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
-        setupPageAdapter = SetupPageAdapter(this)
-        binding.viewPager.isUserInputEnabled = false
-        binding.viewPager.adapter = setupPageAdapter
-
-        setupViewModel.pageNumber.observe(viewLifecycleOwner) {
-            binding.viewPager.setCurrentItem(it, true)
-        }
-    }
-
-    override fun onDestroyView() {
-        super.onDestroyView()
-        _binding = null
-    }
-}
-
-class SetupPageAdapter(fragment: Fragment) : FragmentStateAdapter(fragment) {
-    val pages = listOf(WelcomePageFragment(), LocationPageFragment())
-    override fun getItemCount(): Int = 2
-    override fun createFragment(position: Int): Fragment = pages[position]
-}

android/app/src/main/java/su/xash/engine/ui/setup/SetupViewModel.kt

@@ -1,25 +0,0 @@
-package su.xash.engine.ui.setup
-
-import android.app.Application
-import android.net.Uri
-import androidx.documentfile.provider.DocumentFile
-import androidx.lifecycle.AndroidViewModel
-import androidx.lifecycle.LiveData
-import androidx.lifecycle.MutableLiveData
-import su.xash.engine.MainApplication
-import su.xash.engine.model.Game
-
-class SetupViewModel(application: Application) : AndroidViewModel(application) {
-    val pageNumber: LiveData<Int> get() = _pageNumber
-    private val _pageNumber = MutableLiveData(0)
-
-    fun checkIfGameDir(uri: Uri): Boolean {
-        val ctx = getApplication<MainApplication>().applicationContext
-        val file = DocumentFile.fromTreeUri(ctx, uri)!!
-        return Game.checkIfGamedir(file)
-    }
-
-    fun setPageNumber(pos: Int) {
-        _pageNumber.value = pos
-    }
-}

android/app/src/main/java/su/xash/engine/ui/setup/pages/LocationPageFragment.kt

@@ -1,59 +0,0 @@
-package su.xash.engine.ui.setup.pages
-
-import android.content.Intent
-import android.os.Bundle
-import android.view.LayoutInflater
-import android.view.View
-import android.view.ViewGroup
-import androidx.activity.result.contract.ActivityResultContracts
-import androidx.fragment.app.Fragment
-import androidx.fragment.app.activityViewModels
-import androidx.navigation.fragment.findNavController
-import com.google.android.material.dialog.MaterialAlertDialogBuilder
-import su.xash.engine.R
-import su.xash.engine.databinding.PageLocationBinding
-import su.xash.engine.ui.library.LibraryViewModel
-import su.xash.engine.ui.setup.SetupViewModel
-
-class LocationPageFragment : Fragment() {
-    private var _binding: PageLocationBinding? = null
-    private val binding get() = _binding!!
-    private val setupViewModel: SetupViewModel by activityViewModels()
-    private val libraryViewModel: LibraryViewModel by activityViewModels()
-
-    override fun onCreateView(
-        inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
-    ): View? {
-        _binding = PageLocationBinding.inflate(inflater, container, false)
-        return binding.root
-    }
-
-    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
-        binding.pageButton.setOnClickListener {
-            getGamesDirectory.launch(null)
-        }
-    }
-
-    override fun onDestroyView() {
-        super.onDestroyView()
-        _binding = null
-    }
-
-    private val getGamesDirectory =
-        registerForActivityResult(ActivityResultContracts.OpenDocumentTree()) {
-            it?.let {
-                if (!setupViewModel.checkIfGameDir(it)) {
-                    MaterialAlertDialogBuilder(requireContext()).apply {
-                        setTitle(R.string.error)
-                        setMessage(R.string.setup_location_empty)
-                        setPositiveButton(R.string.ok) { dialog, _ -> dialog.dismiss() }
-                        show()
-                    }
-                } else {
-                    requireContext().contentResolver.takePersistableUriPermission(it, Intent.FLAG_GRANT_READ_URI_PERMISSION)
-                    libraryViewModel.installGame(it)
-                    findNavController().navigate(R.id.action_setupFragment_to_libraryFragment)
-                }
-            }
-        }
-}

android/app/src/main/java/su/xash/engine/ui/setup/pages/WelcomePageFragment.kt

@@ -1,35 +0,0 @@
-package su.xash.engine.ui.setup.pages
-
-import android.os.Bundle
-import android.view.LayoutInflater
-import android.view.View
-import android.view.ViewGroup
-import androidx.fragment.app.Fragment
-import androidx.fragment.app.activityViewModels
-import su.xash.engine.databinding.PageWelcomeBinding
-import su.xash.engine.ui.setup.SetupViewModel
-
-class WelcomePageFragment : Fragment() {
-    private var _binding: PageWelcomeBinding? = null
-    private val binding get() = _binding!!
-    private val setupViewModel: SetupViewModel by activityViewModels()
-
-    override fun onCreateView(
-        inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
-    ): View? {
-        _binding = PageWelcomeBinding.inflate(inflater, container, false)
-        return binding.root
-    }
-
-    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
-        binding.pageButton.setOnClickListener {
-            setupViewModel.setPageNumber(1)
-        }
-        setupViewModel.setPageNumber(0)
-    }
-
-    override fun onDestroyView() {
-        super.onDestroyView()
-        _binding = null
-    }
-}

android/app/src/main/java/su/xash/engine/util/AndroidBug5497Workaround.java

@@ -0,0 +1,49 @@
+package su.xash.engine.util;
+
+import android.app.Activity;
+import android.graphics.Rect;
+import android.view.View;
+import android.widget.FrameLayout;
+
+public class AndroidBug5497Workaround {
+	// For more information, see https://code.google.com/p/android/issues/detail?id=5497
+	// To use this class, simply invoke assistActivity() on an Activity that already has its content view set.
+
+	public static void assistActivity(Activity activity) {
+		new AndroidBug5497Workaround(activity);
+	}
+
+	private View mChildOfContent;
+	private int usableHeightPrevious;
+	private FrameLayout.LayoutParams frameLayoutParams;
+
+	private AndroidBug5497Workaround(Activity activity) {
+		FrameLayout content = activity.findViewById(android.R.id.content);
+		mChildOfContent = content.getChildAt(0);
+		mChildOfContent.getViewTreeObserver().addOnGlobalLayoutListener(this::possiblyResizeChildOfContent);
+		frameLayoutParams = (FrameLayout.LayoutParams) mChildOfContent.getLayoutParams();
+	}
+
+	private void possiblyResizeChildOfContent() {
+		int usableHeightNow = computeUsableHeight();
+		if (usableHeightNow != usableHeightPrevious) {
+			int usableHeightSansKeyboard = mChildOfContent.getRootView().getHeight();
+			int heightDifference = usableHeightSansKeyboard - usableHeightNow;
+			if (heightDifference > (usableHeightSansKeyboard / 4)) {
+				// keyboard probably just became visible
+				frameLayoutParams.height = usableHeightSansKeyboard - heightDifference;
+			} else {
+				// keyboard probably just became hidden
+				frameLayoutParams.height = usableHeightSansKeyboard;
+			}
+			mChildOfContent.requestLayout();
+			usableHeightPrevious = usableHeightNow;
+		}
+	}
+
+	private int computeUsableHeight() {
+		Rect r = new Rect();
+		mChildOfContent.getWindowVisibleDisplayFrame(r);
+		return (r.bottom - r.top);
+	}
+}