Skip to content

Commit

Permalink
alpha.2 to update all RuneJS packages and game engine to Node v16
Browse files Browse the repository at this point in the history
  • Loading branch information
Katilith committed Mar 1, 2022
1 parent 4f7fc38 commit 4c452a3
Show file tree
Hide file tree
Showing 59 changed files with 8,918 additions and 2,844 deletions.
2 changes: 1 addition & 1 deletion .babelrc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"@babel/preset-typescript",
[ "@babel/preset-env", {
"targets": {
"node": "14"
"node": "16"
},
"modules": "commonjs"
} ]
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM node:14
FROM node:16
WORKDIR /usr/src/app
COPY package.json ./
COPY package-lock.json ./
Expand Down
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
![RuneJS](https://i.imgur.com/pmkdSfc.png)
[![RuneJS Discord Server](https://img.shields.io/discord/678751302297059336?label=RuneJS%20Discord&logo=discord)](https://discord.gg/5P74nSh)

# RuneJS
[![RuneJS](https://i.imgur.com/QSXNzwC.png)](https://github.com/runejs/)

[![RuneJS Discord Server](https://img.shields.io/discord/678751302297059336?label=RuneJS%20Discord&logo=discord)](https://discord.gg/5P74nSh)
# RuneJS Game Server

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.
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 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.
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!**

![RuneJS Lumbridge](https://i.imgur.com/KVCqKSb.png)

## Setup

1. Download and install NodeJS **version 14 or higher**: https://nodejs.org/en/
1. Download and install NodeJS **version 16 or higher**: https://nodejs.org/en/
2. Clone the Github Repo: https://github.com/runejs/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
4. Copy the `config/server-config.example.json` and paste it into the same folder using the name `server-config.json`
5. *Optional:* Go into the new `server-config.json` file and modify the RSA modulus and exponent with the ones matching your desired game client
- You may also modify the server's port and host address from this configuration file
6. Run the game server with `npm start`

Expand All @@ -27,8 +27,8 @@ The game server will spin up and be accessible via port 43594.
### Setup using docker

1. Download and install Docker and Docker Compose: first https://docs.docker.com/get-docker/ then https://docs.docker.com/compose/install/
2. Copy the `config/server-config.example.yaml` and paste it into the same folder using the name `server-config.yaml`
3. Go into your new `server-config.yaml` file and modify your RSA modulus and exponent with the ones matching your game client
2. Copy the `config/server-config.example.json` and paste it into the same folder using the name `server-config.json`
3. 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
4. Build the docker image with `docker-compose build`
5. Run the game server with `docker-compose up'
Expand All @@ -40,12 +40,12 @@ The game server will spin up and be accessible via port 43594.
The [RuneScape Java Client #435](https://github.com/runejs/refactored-client-435) must be used to log into a RuneJS game server.

## Additional Commands
* `npm run start:game` Launches the game server by itself without building
* `npm run start:game:dev` Builds and launches the game server by itself in watch mode
* `npm run start:login` Launches the login server by itself without building
* `npm run start:update` Launches the update server by itself without building
* `npm run start:infra` Launches both the login and update server without building
* `npm run start:standalone` Launches all three servers concurrently without building
* `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
8 changes: 4 additions & 4 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
version: "3.8"

services:
rune-js-server:
image: node:14
container_name: server
runejs_game_server:
image: node:16
container_name: runejs_game_server
ports:
- "43594:43594"
volumes:
Expand All @@ -13,4 +13,4 @@ services:

networks:
default:
name: rune_js_network
name: runejs_network
Loading

0 comments on commit 4c452a3

Please sign in to comment.