NeoRTCW

neortcw

neortcw is a Return to Castle Wolfenstein source port, based on iortcw and ioq3. It aims to provide a smoother experience, both for players and developers.

Recent Changes

This fork includes the following changes on top of upstream iortcw:

• Unified build: Replaced the legacy Makefiles with a unified CMake build that produces both SP, MP and ET binaries
• Steam: Automatically detects game files from Steam on all platforms
• Higher tick rate: Bumped server tick rate for smoother gameplay, with client snaps synced accordingly
• Client-side prediction: Locally predicts some gameplay events so the game feels more responsive
• Antilag overhaul: Moved away from OSP-style antilag to a Valve-style approach. Antilag is now enabled by default with more markers, and covers knife and minigun in addition to other hitscan weapons
• Widescreen auto-detection: Automatically detects and applies widescreen settings based on resolution
• High quality out of the box: Bumped default visual quality settings for a better experience

Quick Start Guide

1. Install Return to Castle Wolfenstein and note the installation directory.
2. Clone this repository and build from source (requires CMake >= 3.12 and SDL2):

$ git clone <repo-url> && cd iortcw

$ cmake -B build
$ cmake --build build

3. If you own the game on Steam, this step is not necessary. Files will be detected automatically. Otherwise: Copy the game data from your RTCW installation's Main folder into the main folder next to the built binaries. For singleplayer: pak0.pk3, sp_pak1.pk3, sp_pak2.pk3, sp_pak3.pk3. For multiplayer: mp_bin.pk3, mp_pak0.pk3, mp_pak1.pk3, mp_pak2.pk3, mp_pak3.pk3, mp_pak4.pk3, mp_pak5.pk3, mp_pakmaps0.pk3, mp_pakmaps1.pk3, mp_pakmaps2.pk3, mp_pakmaps3.pk3, mp_pakmaps4.pk3, mp_pakmaps5.pk3, mp_pakmaps6.pk3. 4. Run iowolfsp for singleplayer or iowolfmp for multiplayer from the build output directory.

Compilation and installation

The build system uses CMake (>= 3.12) and builds both singleplayer and multiplayer targets from the project root.

Prerequisites

• CMake 3.12 or later
• GCC, Clang, MSVC or MinGW
• SDL2

Optional system libraries (bundled versions are used automatically if not found): zlib, libjpeg, FreeType, OpenAL, libogg, libvorbis, Opus.

Building on Linux / macOS

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

Binaries will be placed under build/MP/ and build/SP/.

Building on Windows (MinGW or MSVC)

$ cmake -B build -G "Visual Studio 17"
$ cmake --build build --config Release

CMake options

The following options can be passed to cmake via -D<OPTION>=ON|OFF:

• BUILD_MP - Build multiplayer targets (default: ON)
• BUILD_SP - Build singleplayer targets (default: ON)
• BUILD_ET - Build Enemy Territory targets (default: ON)
• USE_RENDERER_DLOPEN - Load renderer as shared library (default: ON)
• USE_OPENAL - Use OpenAL for sound (default: ON)
• USE_OPENAL_DLOPEN - dlopen OpenAL at runtime (default: ON)
• USE_CODEC_VORBIS - Enable Ogg Vorbis codec (default: ON)
• USE_CODEC_OPUS - Enable Opus codec (default: ON)
• USE_VOIP - Enable VoIP support (default: ON)
• USE_MUMBLE - Enable Mumble link support (default: ON)
• USE_FREETYPE - Enable FreeType font rendering (default: ON)
• USE_BLOOM - Enable bloom rendering effect (default: ON)
• USE_INTERNAL_LIBS - Use all bundled libraries (default: OFF)
• USE_INTERNAL_ZLIB - Use bundled zlib (default: OFF)
• USE_INTERNAL_JPEG - Use bundled libjpeg (default: OFF)
• USE_INTERNAL_FREETYPE - Use bundled FreeType (default: OFF)
• USE_INTERNAL_OGG - Use bundled libogg (default: OFF)
• USE_INTERNAL_VORBIS - Use bundled libvorbis (default: OFF)
• USE_INTERNAL_OPUS - Use bundled Opus (default: OFF)

For example, to build only multiplayer with all bundled libraries:

$ cmake -S . -B build -DBUILD_SP=OFF -DUSE_INTERNAL_LIBS=ON
$ cmake --build build

Compiling ET for WebAssembly

Currently, only ET has been ported to emscripten. It builds a browser client and/or a Node.js dedicated server. Both use Emscripten's WebSocket-based socket layer for networking, so WASM clients connect to WASM servers. There's also a master server implementation.

Prerequisites

• Emscripten SDK (emsdk)
• ET game data: place pk3 files in an etmain/ directory
• Node.js + ws package (for dedicated): npm install ws

1. Configure

$ source /path/to/emsdk/emsdk_env.sh
$ mkdir build-et-wasm && cd build-et-wasm

Client only:

$ emcmake cmake .. -DBUILD_MP=OFF -DBUILD_SP=OFF -DBUILD_ET=ON \
  -DGAME_DATA_DIR=/path/to/etmain

Client and dedicated server:

$ emcmake cmake .. -DBUILD_MP=OFF -DBUILD_SP=OFF -DBUILD_ET=ON \
  -DET_BUILD_SERVER=ON -DGAME_DATA_DIR=/path/to/etmain

GAME_DATA_DIR bundles pk3 files into the client's .data file. It is optional for the dedicated server, which reads pk3s from disk at runtime.

2. Build

$ emmake make -j$(nproc)

3. Run the dedicated server

The server reads pk3s from etmain/ relative to the working directory. Copy or symlink your etmain/ directory next to the server files, then:

$ node iowolfetded.wasm32.js +set dedicated 2 +set fs_homepath . +map radar

4. Run the client

Serve the build directory over HTTP (required for WASM):

$ python3 -m http.server 8080

Open http://localhost:8080/iowolfet.wasm32.html in a browser.

Console

New cvars

• cg_fixedAspect ( 0 ) - Use aspect corrected HUD/UI ( 0 = Off, 1 = 4:3 style, 2 = Widescreen style )

• cg_fixedAspectFOV ( 1 ) - Use aspect correct FOV when using cg_fixedAspect cvar ( 0 = Off - Use cg_fov, 1 = Automatic FOV based on resolution )

• cl_autoRecordDemo ( 0 ) - record a new demo on each map change

• cl_aviFrameRate ( 25 )- the framerate to use when capturing video

• cl_aviMotionJpeg ( 1 ) - use the mjpeg codec when capturing video

• cl_guidServerUniq ( 1 ) - makes cl_guid unique for each server

• cl_cURLLib - filename of cURL library to load

• cl_consoleKeys - space delimited list of key names or characters that toggle the console

• cl_mouseAccelStyle ( 0 )- Set to 1 for QuakeLive mouse acceleration behaviour, 0 for standard

• cl_mouseAccelOffset ( 5 ) - Tuning the acceleration curve, see below

• con_autochat ( 1 ) - Set to 0 to disable sending console input text as chat when there is not a slash at the beginning

• con_autoclear ( 1 ) - Set to 0 to disable clearing console input text when console is closed

• in_availableJoysticks - list of available Joysticks

• in_keyboardDebug - print keyboard debug info

• j_forward - Joystick analogue to m_forward, for forward movement speed/direction.

• j_side - Joystick analogue to m_side, for side movement speed/direction.

• j_up - Joystick up movement speed/direction.

• j_pitch - Joystick analogue to m_pitch, for pitch rotation speed/direction.

• j_yaw - Joystick analogue to m_yaw, for yaw rotation speed/direction.

• j_forward_axis - Selects which joystick axis controls forward/back.

• j_side_axis - Selects which joystick axis controls left/right.

• j_up_axis - Selects which joystick axis controls up/down.

• j_pitch_axis - Selects which joystick axis controls pitch.

• j_yaw_axis - Selects which joystick axis controls yaw.

• s_useOpenAL ( 1 ) - use the OpenAL sound backend if available

• s_alPrecache ( 1 ) - cache OpenAL sounds before use

• s_alGain ( 1.0 ) - the value of AL_GAIN for each source

• s_alSources ( 128 ) - the total number of sources to allocate

• s_alDopplerFactor ( 1.0 ) - the value passed to alDopplerFactor

• s_alDopplerSpeed ( 9000 ) - the value passed to alDopplerVelocity

• s_alMinDistance ( 128 ) - the value of AL_REFERENCE_DISTANCE for each source

• s_alMaxDistance ( 1024 )- the maximum distance before sounds starts to become inaudible.

• s_alRolloff ( 2 ) - the value of AL_ROLLOFF_FACTOR for each source

• s_alGraceDistance ( 512 ) - after having passed MaxDistance, length until sounds are completely inaudible

• s_alDriver - which OpenAL library to use

• s_alDevice - which OpenAL device to use

• s_alAvailableDevices - list of available OpenAL devices

• s_alInputDevice - which OpenAL input device to use

• s_alAvailableInputDevices - list of available OpenAL input devices

• s_sdlBits - SDL bit resolution

• s_sdlSpeed - SDL sample rate

• s_sdlChannels - SDL number of channels

• s_sdlDevSamps - SDL DMA buffer size override

• s_sdlMixSamps - SDL mix buffer size override

• s_backend - read only, indicates the current sound backend

• s_muteWhenMinimized - mute sound when minimized

• s_muteWhenUnfocused - mute sound when window is unfocused

• sv_dlRate - bandwidth allotted to PK3 file downloads via UDP, in kbyte/s

• sv_dlURL - the base of the HTTP or FTP site that holds custom pk3 files for your server

• com_ansiColor - enable use of ANSI escape codes in the terminal

• com_altivec - enable use of altivec on PowerPC systems

• com_standalone (read only) - If set to 1, RTCW is running in standalone mode

• com_basegame - Use a different base than main. If no original RTCW pak files are found, this will enable running in standalone mode

• com_homepath - Specify name that is to be appended to the home path

• com_legacyprotocol - Specify protocol version number for legacy RTCW 1.4 protocol, see "Network protocols" section below (startup only)

• com_legacyversion - Use vanilla RTCW 1.41 version string for game server browser visibility

• com_maxfpsUnfocused - Maximum frames per second when unfocused

• com_maxfpsMinimized - Maximum frames per second when minimized

• com_busyWait - Will use a busy loop to wait for rendering next frame when set to non-zero value

• com_pipefile - Specify filename to create a named pipe through which other processes can control the server while it is running. ( Nonfunctional on Windows. )

• com_gamename - Gamename sent to master server in getservers[Ext] query and infoResponse "gamename" infostring value. Also used for filtering local network games.

• com_protocol - Specify protocol version number for current iortcw protocol, see "Network protocols" section below (startup only)

• sv_banFile - Name of the file that is used for storing the server bans

• net_ip6 - IPv6 address to bind to

• net_port6 - port to bind to using the ipv6 address

• net_mcast6addr - multicast address to use for scanning for IPv6 servers on the local network

• net_mcastiface - outgoing interface to use for scan

• net_enabled - enable networking, bitmask. Add up number for option to enable it:

  Enable IPv4 networking: 1

  Enable IPv6 networking: 2

  Prioritize IPv6 over IPv4: 4

  Disable multicast support: 8

• r_allowResize - make window resizable

• r_ext_texture_filter_anisotropic - anisotropic texture filtering

• r_zProj - distance of observer camera to projection plane in quake3 standard units

• r_greyscale - desaturate textures, useful for anaglyph, supports values in the range of 0 to 1

• r_stereoEnabled - enable stereo rendering for techniques like shutter glasses (untested)

• r_anaglyphMode - Enable rendering of anaglyph images

  red-cyan glasses: 1 red-blue: 2 red-green: 3 green-magenta: 4

  To swap the colors for left and right eye just add 4 to the value for the wanted color combination. For red-blue and red-green you probably want to enable r_greyscale

• r_stereoSeparation - Control eye separation. Resulting separation is r_zProj divided by this value in quake3 standard units. See also http://wiki.ioquake3.org/Stereo_Rendering for more information

• r_marksOnTriangleMeshes - Support impact marks on md3 models, MOD developers should increase the mark triangle limits in cg_marks.c if they intend to use this.

• r_sdlDriver - read only, indicates the SDL driver backend being used

• r_noborder - Remove window decoration from window managers, like borders and titlebar.

• r_screenshotJpegQuality - Controls quality of jpeg screenshots captured using screenshotJPEG

• r_aviMotionJpegQuality - Controls quality of video capture when cl_aviMotionJpeg is enabled

• r_mode -2 - This new video mode automatically uses the desktop resolution.

New commands

• video [filename]- start video capture (use with demo command)
• stopvideo - stop video capture
• stopmusic - stop background music
• minimize - Minimize the game and show desktop
• togglemenu - causes escape key event for opening/closing menu, or going to a previous menu. works in binds, even in UI
• print - print out the contents of a cvar
• unset - unset a user created cvar
• banaddr ( range ) - ban an IP address range from joining a game on this server, valid ( range ) is either playernum or CIDR notation address range.
• exceptaddr ( range ) - exempt an IP address range from a ban.
• bandel ( range ) - delete ban (either range or ban number)
• exceptdel ( range ) - delete exception (either range or exception number)
• listbans - list all currently active bans and exceptions
• rehashbans - reload the banlist from serverbans.dat
• flushbans - delete all bans
• net_restart - restart network subsystem to change latched settings
• game_restart ( fs_game ) - Switch to another mod
• which ( filename/path ) - print out the path on disk to a loaded item
• execq ( filename ) - quiet exec command, doesn't print "execing file.cfg"
• kicknum ( client number ) - kick a client by number, same as clientkick command
• kickall - kick all clients, similar to "kick all" ( but kicks everyone even if someone is named "all" )
• kickbots - kick all bots, similar to "kick allbots" (but kicks all bots even if someone is named "allbots")
• tell ( client num ) msg - send message to a single client (new to server)
• cvar_modified [filter] - list modified cvars, can filter results (such as "r*" for renderer cvars) like cvarlist which lists all cvars
• addbot random - the bot name "random" now selects a random bot

README for Users

Using shared libraries instead of qvm:

To force RTCW-MP to use shared libraries, run it with the following parameters: +set vm_cgame 0 +set vm_game 0 +set vm_ui 0

Help! iortcw won't give me an fps of X anymore when setting com_maxfps!

iortcw now uses the select() system call to wait for the rendering of the next frame when com_maxfps was hit. This will improve your CPU load considerably in these cases. However, not all systems may support a granularity for its timing functions that is required to perform this waiting correctly. For instance, iortcw tells select() to wait 2 milliseconds, but really it can only wait for a multiple of 5ms, i.e. 5, 10, 15, 20... ms. In this case you can always revert back to the old behaviour by setting the cvar:

com_busyWait 1

Using HTTP/FTP Download Support (Server)

You can enable redirected downloads on your server even if it's not an iortcw server. You simply need to use the 'sets' command to put the sv_dlURL cvar into your SERVERINFO string and ensure sv_allowDownloads is set to 1

sv_dlURL is the base of the URL that contains your custom .pk3 files the client will append both fs_game and the filename to the end of this value. For example, if you have sv_dlURL set to "http://yoursite.org", fs_game is "main", and the client is missing "test.pk3", it will attempt to download from the URL "http://yoursite.org/main/test.pk3"

• sv_allowDownload's value is now a bitmask made up of the following flags:

  1 - ENABLE

  4 - do not use UDP downloads

  8 - do not ask the client to disconnect when using HTTP/FTP

Server operators who are concerned about potential "leeching" from their HTTP servers from other iortcw servers can make use of the HTTP_REFERER that iortcw sets which is "ioQ3://{SERVER_IP}:{SERVER_PORT}". For example, Apache's mod_rewrite can restrict access based on HTTP_REFERER.

On a sidenote, downloading via UDP has been improved and yields higher data rates now. You can configure the maximum bandwidth for UDP downloads via the cvar sv_dlRate. Due to system-specific limits the download rate is capped at about 1 Mbyte/s per client, so curl downloading may still be faster.

Using HTTP/FTP Download Support (Client)

Simply setting cl_allowDownload to 1 will enable HTTP/FTP downloads assuming iortcw was compiled with USE_CURL=1 (the default).

• Like sv_allowDownload, cl_allowDownload also uses a bitmask value supporting the following flags: 1 - ENABLE 2 - do not use HTTP/FTP downloads 4 - do not use UDP downloads

When iortcw is built with USE_CURL_DLOPEN=1 (default), it will use the value of the cvar cl_cURLLib as the filename of the cURL library to dynamically load.

Multiuser Support on Windows systems

On Windows, all user specific files such as autogenerated configuration, demos, videos, screenshots, and autodownloaded pk3s are now saved in a directory specific to the user who is running iortcw.

On NT-based such as Windows XP, this is usually a directory named: "C:\Documents and Settings%USERNAME%\My Docuemtns\RTCW"

On Windows Vista, Windows 7, and Windows 10 will use a directory like: "C:\Users%USERNAME%\Documents\RTCW"

You can revert to the old single-user behaviour by setting the fs_homepath cvar to the directory where iortcw is installed. For example:

ioWolfMP.exe +set fs_homepath "c:\iortcw"

or

ioWolfSP.exe +set fs_homepath "c:\iortcw"

Note that this cvar MUST be set as a command line parameter.

SDL Keyboard Differences

iortcw clients have different keyboard behaviour compared to the original RTCW clients.

SDL > 1.2.9 does not support disabling dead key recognition. In order to send dead key characters ( e.g. ~, ', `, and ^ ), you must key a Space ( or sometimes the same character again ) after the character to send it on many international keyboard layouts.

The SDL client supports many more keys than the original RTCW client. For example the keys: "Windows", "SysReq", "ScrollLock", and "Break". For non-US keyboards, all of the so called "World" keys are now supported as well as F13, F14, F15, and the country-specific mode/meta keys.

On many international layouts the default console toggle keys are also dead keys, meaning that dropping the console potentially results in unintentionally initiating the keying of a dead key. Furthermore SDL 1.2's dead key support is broken by design and RTCW doesn't support non-ASCII text entry, so the chances are you won't get the correct character anyway.

If you use such a keyboard layout, you can set the cvar cl_consoleKeys. This is a space delimited list of key names that will toggle the console. The key names are the usual RTCW names e.g. "~", "`", "c", "BACKSPACE", "PAUSE", "WINDOWS" etc. It's also possible to use ASCII characters, by hexadecimal number. Some example values for cl_consoleKeys:

"~ ` 0x7e 0x60"           Toggle on ~ or ` (the default)
"WINDOWS"                 Toggl