ra2yrcpp

Library for interacting with Red Alert 2 Yuri's Revenge game process with protobuf based protocol over TCP. Inspired by s2client-api.

Usage

Get sources from here, or use git (use --depth 1 if you want just the latest commit):

git clone --recurse-submodules https://github.com/shmocz/ra2yrcpp.git

Download the latest release and extract the contents to folder of your choice, e.g. ra2yrcpp. Download spawner and patch it:

python ./scripts/patch_gamemd.py \
  --auto-patch \
  --build-dir ra2yrcpp \
  --input yr-patches/release/cncnet/gamemd-spawn.exe \
  --output ra2yrcpp/gamemd-spawn-ra2yrcpp.exe

Warning You cannot use the modified spawner in any online games played over CnCNet. Not only is this against their ToS, but the ra2yrcpp-specific spawner is incompatible with the standard version.

Copy ra2yrcpp/libra2yrcpp.dll and ra2yrcpp/gamemd-spawn-ra2yrcpp.exe to the CnCNet installation folder. If you wish to launch the game via official CnCNet client, then overwrite the original gamemd-spawn.exe with the patched spawner. When the game is started, the DLL will be loaded with WebSocket server bound to port 14521.

The following environment variables control the behaviour of the service:

• RA2YRCPP_ALLOWED_HOSTS_REGEX: Regex matching the hosts allowed to connect (default: "0.0.0.0|127.0.0.1")
• RA2YRCPP_PORT: The server port (default: 14521)
• RA2YRCPP_RECORD_PATH: Path to state record file (disabled by default)
• RA2YRCPP_RECORD_TRAFFIC: Path to traffic record file (disabled by default)

Building

ra2yrcpp depends on following software:

• argparse
• asio
• cmake
• fmt
• protobuf
• websocketpp
• wine (Optional: see section about cross-compilation and protoc)
• xbyak
• zlib

All dependencies except cmake, python, zlib and wine are already included as submodules.

For clang-cl, zlib sources might be needed:

git clone -b v1.2.8 https://github.com/madler/zlib.git 3rdparty/zlib

Build with Docker (recommended)

For convenience, a Docker image is provided for both MinGW and clang-cl toolchains with all necessary dependencies to build the application and related components. MinGW toolchain is used by default.

Build the images:

docker-compose build builder

Build the library with docker:

./scripts/tools.sh docker-build

General build instructions (for developers)

Obtain protobuf

Warning Builds of libprotobuf lack compatibility across different compilers. Attempting to link a MinGW compiled library in MSVC/clang-cl toolchain, or vice versa, will result in errors.

If you built the main docker image then protobuf has already been built and you can copy the files from there:

mkdir -p opt/usr
docker-compose cp -L builder:/usr/i686-w64-mingw32 opt/usr
docker-compose cp -L builder:/usr/bin/protoc opt/bin

Build

Pick a toolchain of your choice, release type and the build script:

export CMAKE_TOOLCHAIN_FILE=<toolchain-path>
export CMAKE_RELEASE_TYPE=Release
./scripts/tools.sh build-cpp

This performs the build and installation under cbuild/<toolchain-id>-<release-type>.

Alternatively invoke cmake directly:

mkdir -p build pkg
cmake \
  -DCMAKE_INSTALL_PREFIX=pkg \
  --toolchain <toolchain-path> \
  -S . -B build \
  cmake --build build --config Release --target all -j $(nproc) \
  cmake --build build --config Release --target install

The following build options are available:

• RA2YRCPP_BUILD_MAIN_DLL Whether to build the main YRpp-dependent DLL and related utilities. Default: ON
• RA2YRCPP_BUILD_TESTS Whether to build test executables. Default: ON
• RA2YRCPP_DEBUG_LOG Enable debug logging even for non-debug targets. Default: OFF
• RA2YRCPP_SYSTEM_PROTOBUF Use system protobuf headers instead of the submodule. Useful when working on native builds. Default: OFF

Build using clang-cl

Clang-cl requires MSVC SDK, which will be downloaded when building the clang-cl-msvc.Dockerfile image. Once downloaded, modify the toolchain file at toolchains/clang-cl-msvc.cmake to point to correct SDK paths.

Also get the static zlib library, and adjust ZLIB_LIBRARY in the toolchain file accordingly. On Linux systems the library might be present if MinGW cross compilation toolchain has been installed.

Execute build with:

export CMAKE_TOOLCHAIN_FILE=toolchains/clang-cl-msvc.cmake
./scripts/tools.sh build-cpp

the build and install directories will be performed to cbuild/<toolchain-name>-$CMAKE_RELEASE_TYPE, under the names build and pkg respectively.

Build using MinGW

The instructions are identical to clang-cl, consult the reference toolchain file at mingw-w64-i686.cmake.

export CMAKE_TOOLCHAIN_FILE=toolchains/mingw-w64-i686.cmake
./scripts/tools.sh build-cpp

Build core library natively without YRpp

The core component and it's related tests do not depend on Windows, and can be built natively using RA2YRCPP_BUILD_MAIN_DLL=OFF CMake option. This is useful when debugging code of the main service. You can specify additional compile/link options for test executables in the RA2YRCPP_EXTRA_FLAGS variable. For instance, to enable ASan and UBSan on GCC or Clang:

set(RA2YRCPP_EXTRA_FLAGS -fsanitize=address -fsanitize=undefined)

Using different protobuf version

Warning Currently supported only for native builds (RA2YRCPP_BUILD_MAIN_DLL=OFF)

Newer versions of protobuf use abseil library and may require additional linking flags. These can be specified in the toolchain file like this:

set(PROTOBUF_EXTRA_LIBS absl_status absl_log_internal_check_op absl_log_internal_message)

Exact list of libraries may vary across systems and protobuf versions.

Options

Recording game data

Warning The uncompressed recording can be very large. Consider downsampling or transforming it into less verbose format for further processing.

A callback is created to save game state at the beginning of each frame. To output these to a file, set the environment variable RA2YRCPP_RECORD_PATH=<name>.pb.gz. The states are stored as compressed consecutive serialized protobuf messages. After exiting the game, the recording can be dumped as lines of JSON strings with the tool ra2yrcppcli.exe.

Troubleshooting

The game doesn't start

This can happen if ra2yrcpp cannot load zlib DLL. Ensure that zlib1.dll is placed in the same folder as gamemd-spawn.exe.

The game freezes shortly after loading

Anti-cheat mechanism tends to cause this. Use the non-hardened version of the spawner available here.

Credits

• shmocz
• CnCNet Contributors
• Phobos and YRpp contributors

Legal and license

This project has no direct association to Electronic Arts Inc. Command and Conquer, Yuri's Revenge, Red Alert, Westwood Studios, EA GAMES, the EA GAMES logo and Electronic Arts are trademarks or registered trademarks of Electronic Arts Inc. in the U.S. and/or other countries. All rights reserved.