RS-SDK
Research-oriented starter kit for runescape-style bots, including a typescript sdk, agent documentation and bindings, and a server emulator. Works out of the box - tell it what to automate!
Build and operate bots within a complex economic role-playing MMO. You can automate the game, level an account to all 99s, and experiment with agentic development techniques within a safe, bot-only setting.
The goals of this project are to provide a rich testing environment for goal-directed program synthesis techniques (Ralph loops, etc), and to facilitate research into collaboration and competition between agents.
There is currently a leaderboard for bots running on the demo server, with rankings based on highest total level per lowest account playtime.
Note
RS-SDK is a fork of the LostCity engine/client, an amazing project without which rs-sdk would not be possible. Find their code here or read their history and ethos
Getting Started:
git clone https://github.com/MaxBittker/rs-sdk.git
Out of the box, you can connect to the provided demo server, choose a name that is not already taken!
With claude code:
bun install
claude "start a new bot with name: {username}"Manually:
bun install
bun scripts/create-bot.ts {username}
bun bots/{username}/script.ts Chat is off by default to prevent scamming and prompt injection attacks, but you can opt in with SHOW_CHAT=true in the bot.env file
Warning: The demo server is offered as a convenience, and we do not guarantee uptime or data persistence. Hold your accounts lightly, and consider hosting your own server instance. Please do not manually play on the demo server.
Gameplay Modifications
This server has a few modifications from the original game to make development and bot testing easier:
- Faster leveling - The XP curve is accelerated and less steep.
- Infinite run energy - Players never run out of energy
- No random events - Anti-botting random events are disabled
Architecture:
rs-sdk runs against an enhanced web-based client (botclient) which connects to the LostCity 2004scape server emulator.
There is a gateway server which accepts connections from botclient and SDK instances, and forwards messages between them based on username.
Once connected to the gateway, the botclient will relay game state to the SDK, and execute low-level actions (e.g. walkTo(x,y)) sent from the SDK through the gateway.
This means that the SDK can't talk directly to the game server, but must go through the botclient. It will attempt to launch the botclient on startup if one is not already running.
You don't need to run the gateway/botclient in order to run automations against the demo server, but you may choose to if you are fixing bugs or adding features to the rs-sdk project
Running the server locally:
You want all these running:
cd engine && bun run start
cd webclient && bun run watch
cd gateway && bun run gateway
There is also a login server which you may not need, I forget
Disclaimer
This is a free, open-source, community-run project.
The goal is strictly education and scientific research.
LostCity Server was written from scratch after many hours of research and peer review. Everything you see is completely and transparently open source.
We have not been endorsed by, authorized by, or officially communicated with Jagex Ltd. on our efforts here.
You cannot play Old School RuneScape here, buy RuneScape gold, or access any of the official game's services! Bots developed here will not work on the official game servers.
License
This project is licensed under the MIT License. See the LICENSE file for details.