Skip to content

Commit 6622b47

Browse files
authored
Merge pull request #387 from Jameskmonger/docker-instructions
docs: remove non-docker setup docs
2 parents 301fa7e + 5ed4a98 commit 6622b47

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,16 @@ The game server currently runs a build of RuneScape from October 30th-31st, 2006
1414

1515
## Setup
1616

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
2618

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`
2821

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
3224
- 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'
3527

3628
The game server will spin up and be accessible via port 43594.
3729

@@ -40,6 +32,12 @@ The game server will spin up and be accessible via port 43594.
4032
The [RuneScape Java Client #435](https://github.com/runejs/refactored-client-435) must be used to log into a RuneJS game server.
4133

4234
## 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+
4341
* `npm run game` Launches the game server by itself without building
4442
* `npm run game:dev` Builds and launches the game server by itself in watch mode
4543
* `npm run login` Launches the login server by itself without building

0 commit comments

Comments
 (0)