Website | Discord | Rune-Server
disclaimer: All server code has been written from scratch for this project, Jagex has never had any source code leaks.
status: in-development, not ready for players. Contributors are welcome to help out.
This project aims to replicate an authentic RuneScape experience from May 2004. It should be considered an emulator first and foremost, as replicating behaviors by emulating the underlying systems is the biggest focus. The config system and scripting system is as close to authentic as we understand it, and is continually refined as we learn more info.
To Jagex: This project comes out of love for the game. As MMOs age, their previous versions are lost to history. An experience becomes ephemeral and time-limited. We're aware that you have no backups for this era and so we're putting in the effort to recreate what we can.
It won't ever profit off your trademarks. Without this project, this version of the game only lives in our memories. Screenshots and videos are scarce, and the original data is lost to time. This is no easy task.
To players: So happy to have you interested! RuneScape 2 launched on March 29, 2004. We have no copies of that revision, but we do have some client caches from May 2004. This project emulates May 18, 2004, which was live until June 1 of that year. It has Treasure Trails and Big Chompy Bird Hunting. The next revision after this added Elemental Workshop I.
- Download this repo to your computer
- Install our list of dependencies
- Open the folder you downloaded in a command prompt
- Run
npm install
- Run
npm start
Now open http://localhost in your browser and play!
Advanced users: You can customize your setup by copying the .env.example
file to .env
. This is not necessary for a simple localhost setup.
If you run into issues please see our common issues or hop in Discord.
You can instead run setup.sh
to get your repository ready for running the server.
An alternative way to set up your environment is to utilize a Development Container. In order to start the Dev Container, you'll need to install Docker. If you're running Windows, I suggest getting Docker Desktop. Linux users can use whatever means they prefer to install Docker. Once docker is installed, install the VSCode extension Dev Containers.
Follow these steps:
- Make sure Docker is running
- Open VSCode and run
Dev Containers: Clone Repository in Container Volume
- Select
GitHub
as the remote Source - Find your fork of this repo
- Select the branch you want to work from
- Once the startup script is finished, run
npm start
Once the container starts, it automatically starts running setup.sh
. You can cancel this and do the Getting Started steps manually as well.
- NodeJS 20.6+ (22 is fine as well)
- Java 17+
- If you're using VS Code (recommended), we have an extension to install here.
Java is required for our RuneScript compiler, it will be downloded for you the first time you run npm start
.
Content developers (likely you!) can run npm start
to start the server. This will watch for changes to the config and script files as well as automatically rebuild them.
Engine developers can run npm run dev
to start the server. This does what npm start
does above, but also restarts the world when any TypeScript code has changed.
We use vitest
for unit tests.
- You can run the tests with
npm test
.
Test files should be colocated with the source files, i.e. src/foo.ts
should have a test file src/foo.test.ts
.
We use eslint
for linting this project.
- You can run the linter with
npm run lint
. - To run the eslint auto-fixer, you can use
npm run lint -- --fix
.
It's recommended to install a suitable plugin/extension for your IDE, to show you lint results inline.
Please aim to avoid warnings! They are rules that we eventually want to switch to errors.
Configuration for the linter can be found in .eslintrc.cjs
.
bad option: --import
: You are using node an older version of node. We are targeting 20.6+
Thanks to all the current contributors, every PR you submit gets us closer and closer to feature completeness.
Thanks to these indirect or external contributors
- Kris: for all your help theorycrafting and testing, and to his sources as well for teaching him
- Walied: for your work on understanding the client assets (worked on cache formats)
- Dane: for your work on understanding the client (worked on client refactors)
If anyone is not listed here, whether that's intentional to remain anonymous or an oversight, thank you for your help.
This type of project has been a long time coming and I hope to see the trend continue.