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 ✔️
• Server side cache loading ✔️
  • Client pathing validation via cache mapdata ✔️
  • Item/object/npc definitions ✔️
• Packet queueing ✔️

Game World

• Private & group Player Instances ✔️
• Personal player instance objects and world items ✔️
• Bank :yellow_square:
  • Withdraw/Deposit 1,5,10,All ✔️
  • As note ✔️
  • Swap slot ✔️
  • Insert mode: ✔️
  • Deposit box :yellow_square:
• Audio :yellow_square:
  • Music :yellow_square:
    • Playing music ✔️
    • Music Regions ❌
    • Music Player tab ❌
  • Sounds :yellow_square:
    • Playing sounds ✔️
    • Sound effects for actions :yellow_square:
• Home Teleport ✔️
• Emotes ✔️
  • Skillcape emotes ✔️
  • Unlockable emotes w/ requirements ✔️
• Shop support ✔️
• Inventory support ✔️
  • Swapping items ✔️
  • Dropping items ✔️
  • Picking up ground items ✔️
  • Equipping items ✔️
• Doors/gates :yellow_square:
  • NSEW doors ✔️
  • Diagonal doors :yellow_square:
  • Double doors ✔️
  • Wooden gates ✔️
• Climbing ladders & stairs :yellow_square:
• Clue Scrolls ❌

Skills

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

Quests

• Cook's Assistant ✔️

Technical Features

• Asynchronous server infrastructure w/ Promises & RxJS Observables
• 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
• Code compilation via Babel, offering more seamless compilation and redeployment of plugins

Setup

1. Download and install NodeJS version 13 or higher: https://nodejs.org/en/
2. Clone the Github Repo: https://github.com/rune-js/server
3. Install dependencies by navigating to the project in your Terminal or command prompt and running the command npm install
4. Copy the data/config/server-config.example.yaml and paste it into the same folder using the name server-config.yaml
5. 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

6. 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.

Game Client

The RuneScape Java Client #435 must be used to log into a RuneJS game server.