Skip to content

INSTALL.md

Latest commit

 

History

History
193 lines (136 loc) · 5.91 KB

INSTALL.md

File metadata and controls

193 lines (136 loc) · 5.91 KB

RTDink -- Build Instructions

See README.md for download links if you just want to play the game.

Platform Overview

Platform Build System Notes
Windows Visual Studio 2017+ Proton SDK sibling layout, uses FMOD for audio
Linux CMake Proton SDK cloned inside project, uses SDL2 + SDL2_mixer for audio
iOS Xcode Proton SDK sibling layout, uses FMOD for audio
Android Gradle + CMake Proton SDK sibling layout, uses FMOD for audio
macOS Xcode Broken/unmaintained
HTML5 Emscripten See Proton HTML5 setup

All platforms require the Dink Smallwood game data (dink/ directory) to play. See README.md for how to obtain it.

Most platforms (except Linux) expect the Proton SDK sibling layout -- RTDink is cloned inside the Proton directory:

proton/
  shared/          <-- Proton SDK
  RTDink/          <-- this repo

Windows

Full step-by-step instructions are in README.md, including FMOD setup and required DLLs.

The short version:

proton/
  shared/          <-- Proton SDK
  RTDink/          <-- this repo
    windows_vs2017/
      iPhoneRTDink.sln
  1. Clone Proton SDK
  2. Clone this repo inside the Proton directory
  3. Run media\update_media.bat
  4. Set up FMOD (see README.md)
  5. Open windows_vs2017/iPhoneRTDink.sln in Visual Studio
  6. Build Release GL | x64, copy DLLs and game data to bin/

iOS

The Xcode project at the repo root (RTDink.xcodeproj) includes iOS targets. It uses the Proton SDK sibling layout:

proton/
  shared/          <-- Proton SDK
  RTDink/
    RTDink.xcodeproj
  1. Clone Proton SDK
  2. Clone this repo inside the Proton directory
  3. Open RTDink.xcodeproj in Xcode
  4. Select the iOS target/device and build
  5. You will need an Apple Developer account for device deployment

Android

The Android build uses Gradle with CMake for native code. It uses the Proton SDK sibling layout:

proton/
  shared/          <-- Proton SDK
  RTDink/
    AndroidGradle/
      app/
        src/main/cpp/CMakeLists.txt   <-- references ../../../../../../shared
  1. Clone Proton SDK
  2. Clone this repo inside the Proton directory
  3. Copy AndroidGradle/local.properties_removethispart_ to AndroidGradle/local.properties and edit it with your Android SDK path, keystore info, and package name
  4. Run media\update_media.bat to prepare assets (or ensure bin/interface and bin/audio exist)
  5. Open AndroidGradle/ in Android Studio
  6. PrepareResources.bat runs automatically during the build to copy assets and shared Java sources from the Proton SDK
  7. Build and deploy

Note: The game data for Android comes from bin/dink_for_android/ (a trimmed version of the game data). See PrepareResources.bat for details on what gets packaged into the APK.

macOS (broken/unmaintained)

Note: The macOS build has not been maintained for a long time and likely does not build without fixes. It is left here for reference.

The Xcode project is at the repo root (RTDink.xcodeproj). Same sibling layout as Windows:

proton/
  shared/          <-- Proton SDK
  RTDink/
    RTDink.xcodeproj
  1. Clone Proton SDK
  2. Clone this repo inside the Proton directory
  3. Open RTDink.xcodeproj in Xcode
  4. Build and run (may require fixes)

Linux

Install via Flatpak (recommended for most users)

No build required. Use the correct bundle for your CPU:

# Install Flatpak if needed (Debian/Ubuntu)
sudo apt install flatpak

# Download and install (example for x86_64)
wget https://www.rtsoft.com/dink/DinkSmallwoodHD-x86_64.flatpak
flatpak install --user DinkSmallwoodHD-x86_64.flatpak

# Run
flatpak run com.rtsoft.DinkSmallwoodHD

On ARM, use DinkSmallwoodHD-aarch64.flatpak instead.

Build from source

Quick setup (Ubuntu/Debian)

The easiest way is to use the automated script from the repo root:

./linux_setup.sh

This installs dependencies, clones the Proton SDK, and builds RTDink. Game data is included in the repo.

Manual build

Prerequisites

  • C++ Compiler: GCC 7+ or Clang 7+
  • CMake: 3.10 or newer
  • Development libraries:
sudo apt update
sudo apt install build-essential cmake libgl1-mesa-dev libx11-dev \
  libpng-dev zlib1g-dev libbz2-dev libcurl4-openssl-dev libsdl2-dev libsdl2-mixer-dev

Build steps

# 1. Clone Proton SDK inside the project root
git clone https://github.com/SethRobinson/proton.git

# 2. Configure and build
mkdir build && cd build
cmake ..
make -j$(nproc)

# 3. Run (game data is in the repo under bin/dink)
./RTDinkApp

CMake automatically creates symlinks for interface/, audio/, and dink/ so the binary finds resources when run from build/.

Troubleshooting

  • Missing dependencies: Install any missing -dev packages as reported by CMake.
  • No game data: The dink/ game data is included in the repo (under bin/dink/). If it is missing, the game will crash when starting a new game.

Notes

  • The Linux CMake build is independent from the Windows/macOS project files -- they can coexist safely.
  • The Linux build uses SDL2 + SDL2_mixer for audio instead of FMOD (no proprietary dependencies).
  • Proton SDK must be obtained separately on each platform.
  • Contributions and bug reports are welcome!