Skip to content

Commit 6e31cad

Browse files
authored
Merge pull request #344 from HeraticAssassin/patch-1
Update README.md
2 parents 45a2f19 + 5e733a9 commit 6e31cad

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,17 @@ The server runs on the 435 revision of the game, which was a game update made on
2424

2525
The game server will spin up and be accessible via port 43594.
2626

27+
### Setup using docker
28+
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.yaml` and paste it into the same folder using the name `server-config.yaml`
31+
3. Go into your new `server-config.yaml` file and modify your RSA modulus and exponent with the ones matching your game client
32+
- 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'
35+
36+
The game server will spin up and be accessible via port 43594.
37+
2738
## Game Client
2839

2940
The [RuneScape Java Client #435](https://github.com/runejs/refactored-client-435) must be used to log into a RuneJS game server.

0 commit comments

Comments
 (0)