@@ -14,24 +14,16 @@ The game server currently runs a build of RuneScape from October 30th-31st, 2006
14
14
15
15
## Setup
16
16
17
- 1 . Download and install NodeJS ** version 16 or higher** : https://nodejs.org/en/
18
- 2 . Clone the Github Repo: https://github.com/runejs/server
19
- 3 . Install dependencies by navigating to the project in your Terminal or command prompt and running the command npm install
20
- 4 . Copy the ` config/server-config.example.json ` and paste it into the same folder using the name ` server-config.json `
21
- 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
22
- - You may also modify the server's port and host address from this configuration file
23
- 6 . Run the game server with ` npm start `
24
-
25
- The game server will spin up and be accessible via port 43594.
17
+ ### Prerequisites
26
18
27
- ### Setup using docker
19
+ - [ ` docker ` ] ( https://docs.docker.com/get-docker/ ) and [ ` docker-compose ` ] ( https://docs.docker.com/compose/install/ )
20
+ - If on Windows, ` docker-compose ` comes with ` docker `
28
21
29
- 1 . Download and install Docker and Docker Compose: first https://docs.docker.com/get-docker/ then https://docs.docker.com/compose/install/
30
- 2 . Copy the ` config/server-config.example.json ` and paste it into the same folder using the name ` server-config.json `
31
- 3 . Go into your new ` server-config.json ` file and modify your RSA modulus and exponent with the ones matching your game client
22
+ 1 . Copy the ` config/server-config.example.json ` and paste it into the same folder using the name ` server-config.json `
23
+ 2 . Go into your new ` server-config.json ` file and modify your RSA modulus and exponent with the ones matching your game client
32
24
- You may also modify the server's port and host address from this configuration file
33
- 4 . Build the docker image with ` docker-compose build `
34
- 5 . Run the game server with `docker-compose up'
25
+ 3 . Build the docker image with ` docker-compose build `
26
+ 4 . Run the game server with `docker-compose up'
35
27
36
28
The game server will spin up and be accessible via port 43594.
37
29
@@ -40,6 +32,12 @@ The game server will spin up and be accessible via port 43594.
40
32
The [ RuneScape Java Client #435 ] ( https://github.com/runejs/refactored-client-435 ) must be used to log into a RuneJS game server.
41
33
42
34
## Additional Commands
35
+
36
+ Before running these commands, you must:
37
+
38
+ 1 . have [ NodeJS ** version 16 or higher** ] ( https://nodejs.org/en/ ) installed on your machine
39
+ 2 . run ` npm install ` from the root of this project
40
+
43
41
* ` npm run game ` Launches the game server by itself without building
44
42
* ` npm run game:dev ` Builds and launches the game server by itself in watch mode
45
43
* ` npm run login ` Launches the login server by itself without building
0 commit comments