Skip to content

Commit 918f86c

Browse files
Updating readme
1 parent 0755f80 commit 918f86c

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,39 @@
77

88
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.
99

10-
Currently the server is set up for 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.
10+
Currently, 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.
11+
12+
**The project 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!**
1113

1214
## Features
1315

1416
- RSA and ISAAC ciphering support.
1517
- Login & input/output packet handling.
1618
- Player saving/loading via JSON files.
19+
- Player credential validation and password hashing.
1720
- Multiplayer support.
18-
- Map region/chunk handling.
19-
- Item inventory implementation.
21+
- Map-chunk based positioning.
22+
- Item support:
2023
- Item definition parsing via the game cache.
2124
- Additional item data loading via YAML configuration.
22-
- Inventory item swapping.
23-
- Player equipment with item bonuses & weight.
24-
- NPC spawning and updating.
25+
- Inventory items, equipment items, item swapping.
26+
- Item dropping and picking up.
27+
- Buying/selling via shops.
28+
- Player equipment:
29+
- Equipment bonuses and item weight tracking.
30+
- Full equipment bonus widget support.
31+
- NPCs and NPC updating:
2532
- NPC spawn loading via YAML configuration.
26-
- Player & NPC pathing validation via collision and tile maps generated from the 377 game cache.
27-
- A basic REST service for polling logged in users.
28-
- Full functional update server.
33+
- Player & NPC pathing validation via collision and tile maps generated from the game cache.
34+
- A basic REST service for polling logged in users and game items.
35+
- Fully functional game update server.
2936
- A diverse TypeScript plugin system for easily writing new content based off of in-game actions.
30-
- Flexible quest and dialogue systems for easy content development.
37+
- A simplified JavaScript plugin system for quickly and easily bootstrapping game content.
38+
- Flexible quest and dialogue systems for more advanced content development.
3139

3240
## Usage
3341

34-
1. Download and install Node.JS **version 13 or higher**: https://nodejs.org/en/
42+
1. Download and install NodeJS **version 13 or higher**: https://nodejs.org/en/
3543
2. Clone the Github Repo: https://github.com/rune-js/server
3644
3. Install dependencies by navigating to the project in your Terminal or command prompt and running the command npm install
3745
4. Copy the `data/config/server-config-default.yaml` and paste it into the same folder using the name `server-config.yaml`.

0 commit comments

Comments
 (0)