Skip to content

Commit ee71f11

Browse files
Updating readme
1 parent 1724641 commit ee71f11

File tree

1 file changed

+58
-28
lines changed

1 file changed

+58
-28
lines changed

README.md

Lines changed: 58 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -12,34 +12,64 @@ The server runs on the 435 revision of the game, which was a game update made on
1212
**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!**
1313

1414
## Features
15-
16-
- Asynchronous server infrastructure using Promises and RxJS Observables
17-
- RSA and ISAAC ciphering support
18-
- Login & input/output packet handling
19-
- Player saving/loading via JSON files
20-
- Player credential validation and password hashing
21-
- Multiplayer support:
22-
- Multiplayer rendering
23-
- Full chat support
24-
- Quadtree collision detection for finding nearby players to synchronize
25-
- Map-chunk based positioning
26-
- Item support:
27-
- Item definition parsing via the game cache
28-
- Additional item data loading via YAML configuration
29-
- Inventory items, equipment items, item swapping
30-
- Item dropping and picking up
31-
- Buying/selling via shops
32-
- Player equipment:
33-
- Equipment bonuses and item weight tracking
34-
- Full equipment bonus widget support
35-
- NPCs and NPC synchronization:
36-
- NPC spawn loading via YAML configuration
37-
- Player & NPC pathing validation via collision and tile maps generated from the game cache
38-
- A basic REST service for polling logged in users and game items
39-
- Fully functional game update server
40-
- A diverse TypeScript plugin system for easily writing new content based off of in-game actions
41-
- A simplified JavaScript plugin system for quickly and easily bootstrapping game content
42-
- Flexible quest and dialogue systems for more advanced content development
15+
16+
### Game Server
17+
18+
* RSA + ISAAC ciphering :heavy_check_mark:
19+
* Game Update Server :heavy_check_mark:
20+
* Authentication :heavy_check_mark:
21+
* Server side cache loading :heavy_check_mark:
22+
* Client pathing validation via cache mapdata :heavy_check_mark:
23+
* Item/object/npc definitions :heavy_check_mark:
24+
* Packet queueing :heavy_check_mark:
25+
26+
### Game World
27+
28+
* Bank :white_check_mark:
29+
* Withdraw/Deposit 1,5,10,All :heavy_check_mark:
30+
* As note :x:
31+
* Swap slot :heavy_check_mark:
32+
* Insert mode: :x:
33+
* Audio :white_check_mark:
34+
* Music :white_check_mark:
35+
* Playing music :heavy_check_mark:
36+
* Music Regions :x:
37+
* Music Player tab :x:
38+
* Sounds :white_check_mark:
39+
* Playing sounds :heavy_check_mark:
40+
* Sound effects for actions :white_check_mark:
41+
* Climbing ladders :white_check_mark:
42+
* Climbing stairs :white_check_mark:
43+
* Lumbridge mill :white_check_mark:
44+
* Replacing objects for local player only :x:
45+
46+
### Skills
47+
48+
* Woodcutting :white_check_mark:
49+
* Formula for success :white_check_mark:
50+
* Chopping Trees :white_check_mark:
51+
* Axes :heavy_check_mark:
52+
* Birds nests :x:
53+
* Stump ids :white_check_mark:
54+
* Mining
55+
* Formula for success :white_check_mark:
56+
* Mining ores :white_check_mark:
57+
* Pickaxes :heavy_check_mark:
58+
* Random gems :x:
59+
* Gem ores :x:
60+
* Essence mining :x:
61+
* Empty Rock ids :white_check_mark:
62+
* Crafting
63+
* Spinning wheel :heavy_check_mark:
64+
65+
### Technical Features
66+
67+
* Asynchronous server infrastructure w/ Promises & RxJS
68+
* A diverse TypeScript plugin system for easily writing new content based off of in-game actions
69+
* A simplified JavaScript plugin system for quickly and easily bootstrapping game content
70+
* Flexible quest and dialogue systems for more advanced content development
71+
* A basic REST service for polling logged in users and game items
72+
* Code compilation via Babel, offering more seamless compilation and redeployment of plugins
4373

4474
## Setup
4575

0 commit comments

Comments
 (0)