Client-Mod

• Client-Mod is a small modification of the Half-Life client part for Xash3D FWGS and GoldSource

Added a new control with additional buttons to activate Configuration->Touch->Touch options, select preset New and click Activate.

Added server name to no vgui scoreboard, player model name (included in vgui), curent map name, number of current players, and current date with time.

Added commands:

cl_autojump [0/1] - Will jump automatically as soon as you touch the ground while +jump is held. Taken from OpenAG.

• When this command is enabled the jump button may not work, solved by command cl_lw 1.

+ducktap — Performs a duck tap automatically as soon as you touch the ground (presses +duck for 1 frame). Taken from OpenAG.

hud_color "r g b" - Sets hud color, values must be enclosed in quotation marks. example: hud_color "255 0 255". Taken from OpenAG.

hud_weapon [0/1] - Draw current weapon in HUD, default value is 1. Taken from OpenAG.

cl_logchat [0/1/2 ] - Value 1 logs only messages from players. Value 2 logs system messages and players, default value is 0.

cl_chatsound [0/1/2] - Value 1 play system and players chat notification sound, Value 2 logs only from players, default value is 1.

cl_chatsound_path ["path"] - Path to chat notification playing sound, defaut path "misc/talk.wav".

hud_vis [0/1] - The color of armor and health indicators will change depending on their number, default value is 0.

• Comands starting with vis_health and vis_battery work with hud_vis 1. They change the color of the health indicator and change depending on their number.
• Example: vis_health60 "0 255 0" is the green color of health when it is greater than 60, the same with vis_battery.

vis_battery100 "r g b"
vis_battery80 "r g b"
vis_battery60 "r g b"
vis_battery40 "r g b"
vis_battery20 "r g b"

vis_health100 "r g b"
vis_health60 "r g b"
vis_health80 "r g b"
vis_health40 "r g b"
vis_health20 "r g b"

cl_weaponlowering [0/1] - The weapon in the player's hand will lower depending on the speed of movement, default value is 1.
cl_weaponsway [0/1] - Swaying of the weapon when moving, default value is 1.
cl_weaponlag [0/1] - Weapon lag when turnings, default value is 1.

hud_speedometer [0/1] - Shows the player's speed, default value is 0. Taken from OpenAG.
hud_speedometer_below_cross [0/1] - Adjusts the position of the speedometer to the sight, defaut value is 0.

hud_jumpspeed [0/1] - Shows the player's speed at the moment of the jump, default value is 0. Taken from OpenAG.
hud_jumpspeed_below_cross [0/1] - Adjusts the position of the jumpspeed to the sight, defaut value is 0.
hud_jumpspeed_height [0/1] - Adjusts the positio jumpspeed, defaut value is 0.

hud_watermark [0/1] - Shows client author and build date, defaut value is 1.

hud_rainbow [0/1] - Paints HUD rainbow, default value is 0. Taken from OpenAG.
hud_rainbow_sat [value], default value is 100.
hud_rainbow_val [value], default value is 100.
hud_rainbow_speed [value], default value is 40.
hud_rainbow_xphase [value], default value is 0.4.
hud_rainbow_yphase [value], default value is 0.7.
hud_rainbow_chat [0/1], default value is 0.
hud_rainbow_deathnotice [0/1], default value is 0.
hud_rainbow_statusbar [0/1], default value is 0.

cl_gauss_balls [0/1] - Small bouncing balls from Gauss hits, defaut value is 1.
cl_gauss_hits [0/1] - A large glowing sprite from a Gauss hits, defaut value is 1.
cl_hidecorpses [0/1] - Hides the corpses of players. defaut value is 0.

cl_killsound [0/1] - Sound plays when you kill player, defaut value is 1. Taken from OpenAG.
cl_killsound_path ["path"] - Path to playing sound, defaut path "buttons/bell1.wav". Taken from OpenAG.

cl_cross [0/1] - Custom crosshair, defaut value 0.
cl_cross_color "r g b" - Custom crosshair color, defaut value "255 255 255".
cl_cross_alpha [value] - Crosshair alpha, defaut value 255.
cl_cross_size [value] - Crosshair size, defaut value 1.
cl_cross_gap [value] - Crosshair distance from the middle, defaut value 2.
cl_cross_thickness [value] - Thickness crosshair, defaut value 5.
cl_cross_outline [value] - Crosshairs outline defaut value 1.
cl_cross_top_line [0/1], defaut value 1.
cl_cross_bottom_line [0/1], defaut value 1.
cl_cross_left_line [0/1], defaut value 1.
cl_cross_right_line [0/1], defaut value 1.
cl_cross_dot [0/1] ,defaut value 1.
cl_cross_dot_size [value], defaut value 1.
cl_cross_dot_color "r g b", defaut value "255 255 255".

cl_viewmodel_ofs_right [value] — Offsets the gun viewmodel to the right (or to the left if cl_righthand is set to 1), 0 for no offset. Taken from OpenAG.
cl_viewmodel_ofs_forward [value] — Offsets the gun viewmodel forward, 0 for no offset. Taken from OpenAG.
cl_viewmodel_ofs_up [value] — Offsets the gun viewmodel upwards, 0 for no offset. Taken from OpenAG.

Build Instructions

Windows x86.

Prerequisites

Install and run Visual Studio Installer. The installer allows you to choose specific components. Select Desktop development with C++. You can untick everything you don't need in Installation details, but you must keep MSVC ticked. You may also keep C++ CMake tools for Windows ticked as you'll need cmake. Alternatively you can install cmake from the cmake.org and during installation tick Add to the PATH....

Opening command prompt

If cmake was installed with Visual Studio Installer, you'll need to run Developer command prompt for VS via Windows Start menu. If cmake was installed with cmake installer, you can run the regular Windows cmd.

Inside the prompt navigate to the hlsdk directory, using cd command, e.g.

cd C:\Users\username\projects\Client-Mod

Note: if Client-Mod is unpacked on another disk, nagivate there first:

D:
cd projects\Client-Mod

Building

Сonfigure the project:

cmake -A Win32 -B build

Note that you must repeat the configuration step if you modify CMakeLists.txt files or want to reconfigure the project with different parameters.

The next step is to compile the libraries:

cmake --build build --config Release

hl.dll and client.dll will appear in the build/dlls/Release and build/cl_dll/Release directories.

If you have a mod and want to automatically install libraries to the mod directory, set GAMEDIR variable to the directory name and CMAKE_INSTALL_PREFIX to your Half-Life or Xash3D installation path:

cmake -A Win32 -B build -DGAMEDIR=mod -DCMAKE_INSTALL_PREFIX="C:\Program Files (x86)\Steam\steamapps\common\Half-Life"

Then call cmake with --target install parameter:

cmake --build build --config Release --target install

Choosing Visual Studio version

You can explicitly choose a Visual Studio version on the configuration step by specifying cmake generator:

cmake -G "Visual Studio 16 2019" -A Win32 -B build

Editing code in Visual Studio

After the configuration step, CLIENT-MOD.sln should appear in the build directory. You can open this solution in Visual Studio and continue developing there.

Linux x86

Prerequisites

Install C++ compilers, cmake and x86 development libraries for C, C++ and SDL2. On Ubuntu/Debian:

sudo apt install cmake build-essential gcc-multilib g++-multilib libsdl2-dev:i386

Building

cmake -B build -S .
cmake --build build

Note that the libraries built this way might be not compatible with Steam Half-Life. If you have such issue you can configure it to build statically with c++ and gcc libraries:

cmake .. -DCMAKE_C_FLAGS="-static-libstdc++ -static-libgcc"

Linux x86. Build in your own chroot

Prerequisites

Use the most suitable way for you to create an old distro 32-bit chroot. E.g. on Ubuntu/Debian you can use debootstrap.

sudo apt install debootstrap schroot
sudo mkdir -p /var/choots
sudo debootstrap --arch=i386 jessie /var/chroots/jessie-i386 # On Ubuntu type trusty instead of jessie
sudo chroot /var/chroots/jessie-i386

# inside chroot
apt install cmake build-essential gcc-multilib g++-multilib libsdl2-dev
exit

Create and adapt the following config in /etc/schroot/chroot.d/jessie.conf (you can choose a different name):

[jessie]
type=directory
description=Debian jessie i386
directory=/var/chroots/jessie-i386/
users=yourusername
groups=adm
root-groups=root
preserve-environment=true
personality=linux32

Insert your actual user name in place of yourusername.

Building

Prepend any make or cmake call with schroot -c jessie --:

schroot --chroot jessie -- cmake -B build-in-chroot -S .
schroot --chroot jessie -- cmake --build build-in-chroot

Android

TODO

Nintendo Switch

Prerequisites

1. Set up dkp-pacman.
2. Install dependency packages:

sudo dkp-pacman -S switch-dev dkp-toolchain-vars switch-mesa switch-libdrm_nouveau switch-sdl2

3. Make sure the DEVKITPRO environment variable is set to the devkitPro SDK root:

export DEVKITPRO=/opt/devkitpro

4. Install libsolder:

source $DEVKITPRO/switchvars.sh
git clone https://github.com/fgsfdsfgs/libsolder.git
make -C libsolder install

Building using CMake

mkdir build && cd build
aarch64-none-elf-cmake -G"Unix Makefiles" -DCMAKE_PROJECT_CLIENT-MOD_INCLUDE="$DEVKITPRO/portlibs/switch/share/SolderShim.cmake" ..
make -j

Building using waf

./waf configure -T release --nswitch
./waf build

PlayStation Vita

Prerequisites

1. Set up VitaSDK.
2. Install vita-rtld:

   git clone https://github.com/fgsfdsfgs/vita-rtld.git && cd vita-rtld
   mkdir build && cd build
   cmake -DCMAKE_BUILD_TYPE=Release ..
   make -j2 install
   

Building with waf:

./waf configure -T release --psvita
./waf build

Building with CMake:

mkdir build && cd build
cmake -G"Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE="$VITASDK/share/vita.toolchain.cmake" -DCMAKE_PROJECT_CLIENT-MOD_INCLUDE="$VITASDK/share/vrtld_shim.cmake" ..
make -j

Other platforms

Building on other architectures (e.g x86_64 or arm) and POSIX-compliant OSes (e.g. FreeBSD) is supported.

Prerequisites

Install C and C++ compilers (like gcc or clang), cmake and make.

Building

cmake -B build -S .
cmake --build build

Building with waf

To use waf, you need to install python (2.7 minimum)

(./waf configure -T release)
(./waf)

Build options

Some useful build options that can be set during the cmake step.

• GOLDSOURCE_SUPPORT - allows to turn off/on the support for GoldSource input. Set to ON by default on Windows and Linux, OFF on other platforms.
• USE_VGUI - whether to use VGUI library. OFF by default. You need to init vgui_support submodule in order to build with VGUI.

This list is incomplete. Look at CMakeLists.txt to see all available options.

Prepend option names with -D when passing to cmake. Boolean options can take values OFF and ON. Example:

cmake .. -DUSE_VGUI=ON -DGOLDSOURCE_SUPPORT=ON -DCROWBAR_IDLE_ANIM=ON -DCROWBAR_FIX_RAPID_CROWBAR=ON