Getting Started

Getting Started

Grimreach 0.1.x is a native prototype for Ubuntu/Linux and Android. The client connects to the public game endpoint wss://grimreach.mozrin.com/play by default. The server must be running for movement and other players to appear. See Playing Grimreach for the controls and activities.

Requirements

For ready-made tester downloads, use the latest 0.1.4 release: a Linux x86_64 ZIP, an Android arm64 APK, and SHA-256 checksums. The APK is a debug-signed tester build. Extract the entire Linux ZIP so the executable and .pck remain together; install the APK directly on an arm64 Android device. The APK was not installed on a phone during this release preparation. Issue #27 still tracks macOS and Windows builds.

To build from source, install Go 1.24 or newer and Godot 4.7.2 with the Linux and Android export templates. Android export and installation also need the Android SDK and ADB. The repository's README has the current commands.

Run the desktop client from source

Open client/project.godot in Godot and run the project, or export a Linux debug build from the repository root:

mkdir -p build
godot --headless --path client --export-debug Linux ../build/grimreach-linux.x86_64
./build/grimreach-linux.x86_64

The default public URL is compiled into the client. For a local server started with go run ./server, set the URL in the environment before launching Godot:

GRIMREACH_SERVER_URL=ws://127.0.0.1:8081/play godot --path client

Run the Android client from source

With the Android export template, SDK, and a connected phone:

godot --headless --path client --export-debug Android ../build/grimreach-android.apk
adb install -r build/grimreach-android.apk
adb shell monkey -p com.mozrin.grimreach 1

The Android build uses the public URL by default. Android environment-variable overrides are not provided through the ordinary install flow. Do not use the old TCP/ADB-reverse instructions from the earlier multi-repository prototype.

If it does not connect

Check that the game server and Cloudflare Tunnel are running and that /play routes to http://grimreach_server:8081. The client retries after a lost connection. The Docker and Tunnel page describes the operator setup. Open a bug report with the platform, version, and reproduction steps if the route is up but the client still cannot join.