Watch

mirror of https://github.com/0xGingi/runejs.git synced 2026-09-21 11:54:12 -04:00

No description

TypeScript 100%

Find a file

Repository files (latest commit first)
Filename	Latest commit message	Latest commit date
Henning Berge bceb43a5b2 Merge pull request #435 from charles-m-knox/prayer-bury-bones-plugin Prayer: Bury Bones plugin update		2024-09-08 12:39:02 +02:00
.github	Updating Github workflow and Docker to Node v20	2024-02-28 17:47:04 -06:00
.vscode	set up shared vs code config	2022-07-10 10:20:06 +01:00
cache	Replaces Scape Main login music with Scape Scared (halloween theme)	2021-05-17 20:29:55 +02:00
config	Fixin' item on item interactions and adding a variable to disable xtea	2021-11-26 10:20:51 -06:00
data	update the prayer bury bones plugin; add wikiId field to ItemConfig.metadata	2024-09-07 09:42:59 -07:00
src	update the prayer bury bones plugin; add wikiId field to ItemConfig.metadata	2024-09-07 09:42:59 -07:00
.dockerignore	Docker pls	2020-10-18 16:34:23 -05:00
.gitignore	Merge branch 'develop' into vscode-settings	2022-07-27 11:23:46 -05:00
.swcrc	Upgrading to Node v18	2024-02-28 17:43:31 -06:00
CONTRIBUTING.md	add coverage docs	2022-07-10 09:58:23 +01:00
docker-compose.yml	fix: add `data`, `cache` and `config` as volumes	2023-01-15 21:33:25 +00:00
Dockerfile	Updating Github workflow and Docker to Node v20	2024-02-28 17:47:04 -06:00
FEATURES.md	Updating README and adding FEATURES.md	2021-03-13 13:45:45 -06:00
jest.config.ts	repair and test zaffs shop (also fix jest for ts)	2023-02-24 20:17:38 +01:00
LICENSE	Create LICENSE	2019-12-29 10:34:48 -06:00
nodemon.json	ahhhhhhh	2020-10-19 19:36:12 -05:00
package-lock.json	build(deps): bump tar from 6.2.0 to 6.2.1	2024-04-11 15:14:14 +00:00
package.json	Upgrading to Node v18	2024-02-28 17:43:31 -06:00
README.md	Upgrading to Node v18	2024-02-28 17:43:31 -06:00
tsconfig.json	Upgrading to Node v18	2024-02-28 17:43:31 -06:00

README.md

RuneJS Game Server

RuneJS is a RuneScape game server written in 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 game server currently runs a build of RuneScape from October 30th-31st, 2006 (game build #435). No other builds are supported at this time, but may become available in the future.

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!

Setup

Prerequisites

docker and docker-compose
- If on Windows, docker-compose comes with docker

Running the Game Server

Copy the config/server-config.example.json and paste it into the same folder using the name server-config.json
Go into your new server-config.json 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
Build the docker image with docker-compose build
Run the game server with docker-compose up

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.

Additional Commands

Before running these commands, you must:

have NodeJS version 18 or higher installed on your machine
run npm install from the root of this project

npm run game Launches the game server by itself without building
npm run game:dev Builds and launches the game server by itself in watch mode
npm run login Launches the login server by itself without building
npm run update Launches the update server by itself without building
npm run infra Launches both the login and update server without building
npm run standalone Launches all three servers concurrently without building
npm run build:watch Builds the application and watches for changes
npm run build Builds the application
npm run lint Runs the linter against the codebase to look for code style issues