Summary

RS-SDK is a research-oriented starter kit for developing Runescape-style automation bots, designed for coding agents and researchers. It addresses the need for a controlled environment to experiment with agentic AI, goal-directed program synthesis, and complex MMO botting. The project provides a full-stack solution, including a TypeScript SDK, agent documentation, and a server emulator, enabling rapid bot development, testing, and research into agent collaboration and competition.

How It Works

The architecture comprises an enhanced web-based client (botclient) that interfaces with a LostCity 2004scape server emulator. A gateway server orchestrates communication between botclient and SDK instances. The botclient acts as an intermediary, relaying game state to the SDK and executing low-level actions requested by the SDK. This design ensures bots operate within a managed, simulated environment, facilitating development and testing. RS-SDK is a fork of the LostCity engine.

Quick Start & Requirements

Installation is straightforward via bun install. Bots can be created using bun scripts/create-bot.ts {username} or the claude CLI. The project requires the bun runtime. Out-of-the-box functionality connects to a provided demo server, though users are warned about its uptime and data persistence guarantees. For local development, users must run the engine, webclient, and gateway components.

Highlighted Details

• Optimized for research into goal-directed program synthesis (e.g., Ralph loops) and agentic development techniques.
• Features a leaderboard for bots, ranking them by total level achieved versus account playtime.
• The modified demo server accelerates leveling, provides infinite run energy, and disables random events to simplify bot testing.
• Includes a TypeScript SDK, agent documentation, and a server emulator for a comprehensive development experience.

Maintenance & Community

The provided README does not detail specific contributors, sponsorships, or community channels like Discord or Slack. It notes the project's origin as a fork of the LostCity engine/client.

Licensing & Compatibility

This project is licensed under the MIT License. Bots developed using RS-SDK are intended strictly for educational and scientific research and are incompatible with official Jagex game servers.

Limitations & Caveats

The demo server is a convenience feature with no guarantees on uptime or data persistence; users should "hold your accounts lightly." Manual play on the demo server is prohibited. Bots are not transferable to official RuneScape servers, and the project's scope is limited to research and education.