RuneJS

RuneJS is a RuneScape game server written entirely using TypeScript and JavaScript. The aim of this project is to create a game server that is both fun and easy to use, while also providing simple content development systems.

The server runs on the 435 revision of the game, which was a game update made on October 31st, 2006. There are not any plans to convert it to other versions at this time.

RuneJS is completely open-source and open to all pull requests and/or issues. Many plugins have been added by contributor pull requests and we're always happy to have more!

Features

Game Server

RSA + ISAAC ciphering ✔️
Game Update Server ✔️
Authentication ✔️
Server side cache loading ✔️
- Client pathing validation via cache mapdata ✔️
- Item/object/npc definitions ✔️
Packet queueing ✔️

Game World

Bank 🟨
- Withdraw/Deposit 1,5,10,All ✔️
- As note ✔️
- Swap slot ✔️
- Insert mode: ✔️
- Deposit box 🟨
Audio 🟨
- Music 🟨
  - Playing music ✔️
  - Music Regions ❌
  - Music Player tab ❌
- Sounds 🟨
  - Playing sounds ✔️
  - Sound effects for actions 🟨
Climbing ladders 🟨
Climbing stairs 🟨
Lumbridge mill 🟨
- Replacing objects for local player only ❌
- Grain in hopper ✔️
- Operating levers ✔️
- Removing flour if and only if grain has been processed ✔️
Cow milking ✔️
Container filling ✔️
- Buckets, Jugs, Wells, Sinks, Fountains ✔️
- Emptying Containers ✔️
Home Teleport 🟨
- Animation 🟨
Emotes 🟨
- Skillcape emotes 🟨
- Unlockable emotes w/ requirements ✔️
Shops 🟨
- Shop logic ✔️
- World Shops 🟨
  - Al Kahrid gem trader ✔️
  - Louie Armoured legs ✔️
  - Dommik crafting shop ✔️
  - Raneal Super skirt ✔️
  - Bob's axes ✔️
Inventory 🟨
- Swapping items ✔️
- Dropping items ✔️
- Picking up ground items ✔️
- Equipping items 🟨
  - Complete equiment stats and slot info 🟨
  - Wielding logic (Weight, Stats, Equipping) ✔️
Pickables ✔️
- Wheat, Flax, Potato, Onion, Cabbage ✔️
Doors/gates 🟨
- NSEW doors ✔️
- Diagonal doors 🟨
- Double doors ✔️
- Wooden gates ✔️
Clue Scrolls ❌

Skills

Combat 🟨
- Melee 🟨
- Ranged ❌
- Magic ❌
Prayer ❌
Cooking ❌
Fletching ❌
Fishing ❌
Firemaking 🟨
- Fire lighting 🟨
- Chain fires w/ movement 🟨
Herblore ❌
Agility ❌
Thieving ❌
Slayer ❌
Farming ❌
Runecrafting ❌
Construction ❌
Woodcutting 🟨
- Formula for success ✔️
- Chopping Trees ✔️
- Axes ✔️
- Birds nests ✔️
- Stump ids 🟨
- Canoes ❌
Mining 🟨
- Formula for success ✔️
- Mining ores ✔️
- Pickaxes ✔️
- Random gems ✔️
- Gem ores ✔️
- Essence mining ✔️
- Empty Rock ids 🟨
Crafting 🟨
- Spinning wheel ✔️
Smithing 🟨
- Smelting ore to bars ✔️
- Forging 🟨
  - Correct items ✔️
  - Hiding non applicable items 🟨

Quests

Cook's Assistant ✔️

Technical Features

Asynchronous server infrastructure w/ Promises & RxJS
A diverse TypeScript plugin system for easily writing new content based off of in-game actions
A simplified JavaScript plugin system for quickly and easily bootstrapping game content
Flexible quest and dialogue systems for more advanced content development
A basic REST service for polling logged in users and game items
Code compilation via Babel, offering more seamless compilation and redeployment of plugins

Setup

Download and install NodeJS version 13 or higher: https://nodejs.org/en/
Clone the Github Repo: https://github.com/rune-js/server
Install dependencies by navigating to the project in your Terminal or command prompt and running the command npm install
Copy the data/config/server-config-default.yaml and paste it into the same folder using the name server-config.yaml
Go into your new server-config.yaml file and modify your RSA modulus and exponent with the ones matching your game client

You may also modify the server's port and host address from this configuration file

Run the game server and REST service by inputting the command npm start

The game server will spin up and be accessible via port 43594. The REST service can be accessed via port 8888.

Cache Parsing

A separate package was created that RuneJS uses to parse the 435 game cache. This package decodes item definitions, npc definitions, location object definitions, widgets, sprites, and map data (tiles and location objects) for any implementing app to make use of.

The RuneJS cache-parser package can be found here:

REST API

Online players can be polled via the REST protocol for web applications.

API Endpoints:

GET /players : Returns a list of players currently logged into the game server
GET /items?page=x&limit=y : Returns a list of item metadata loaded by the game server
GET /items/{itemId} : Returns details about a specific item by id
PUT /items/{itemId} : Updates an item's configurable server data

Aditional Information

Supported 435 Clients

RuneJS supports the 435 RuneScape game client being renamed by Promises and TheBlackParade:

refactored-client-435

Update Server

RuneJS provides a fully working update server for the 435 client to use. The update server runs alongside the regular game server using the same port, so no additional configuration is required. Simply start the server and then your game client.

Rune-Status/rune-js-server