OService

Multiplayer networking library for DragonRuby Game Toolkit with LAN, Steam, and GOG¹ support. Built on Unet and OSSP.

🛠 Building OService

⚠️ Before Building!

OService does not include DragonRuby

You must manually link the headers before starting the build process.

1. Locate your DragonRuby folder
2. Copy dragonruby.h and dragonruby.h.include from the DragonRuby include/ directory
3. Paste them into the oservice/include/ folder

🐳 Docker Build

The easiest way to build is via Docker. Once the build completes, your compiled file oservice.so will be waiting in the build/ folder

Run the following commands in your terminal:

docker compose build 
docker compose down --rmi local

Or run the script build-docker.sh

Steam Build

If you need Steam integration, you must provide the args UNET_MODULE_STEAM and STEAM_APP_ID.

docker compose build \
--build-arg UNET_MODULE_STEAM=ON \
--build-arg STEAM_APP_ID=(your app id)

Dev Build

If you need a dev build of OService provide the value dev for the arg BUILD_MODE

docker compose build \
--build-arg BUILD_MODE=dev 

Windows

Use MSVC. GCC/MSYS2 may work but hasn’t been tested recently.

macOS

1. Run build-unix.
2. Sign the extension if you plan to distribute it³.

Linux

1. Run build-unix.
2. Run patchelf --set-rpath $ORIGIN oservice.so so the Steam library is loaded from the same directory.

Steam

1. Add UNET_MODULE_STEAM=ON to build-unix or pass it to CMake².
2. Add STEAM_APP_ID=(your app id) the same way.

LAN & ENet

• Enabled by default, can be disabled when launching OService from your app.

Usage

See documentation.

Place libraries as shown below. steam_api64.dll must be in the game root.

- "game root directory"
    - "game executable"
    - steam_api64.dll
    - native
        - linux-amd64
            - libsteam_api.so
            - oservice.so
        - macos
            - libsteam_api.dylib
            - oservice.dylib
        - windows-amd64
            - oservice.dll

Debugging

• On macOS, resign the DragonRuby app to allow attaching a debugger.
• On Linux, use LD_DEBUG=libs ./dragonruby dr-socket-unet to list missing dependencies.

Notes

¹ GOG support exists, but is untested (I do not have a dev account).<br> ² Requires a Steamworks account.<br> ³ Requires an Apple certificate.