Skip to content

Commit 99f5488

Browse files
More consistency fixes.
1 parent c6e0d94 commit 99f5488

File tree

2 files changed

+36
-32
lines changed

2 files changed

+36
-32
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Contributing to Rune.JS
1+
# Contributing to RuneJS
22

3-
Rune.JS was created with the intention of utilizing JavaScript/TypeScript and Node's innovative features. RxJS was imported for reactive programming as well, opening up opportunities for easy content development. As such, there are a few things we're looking to avoid...
3+
RuneJS was created with the intention of utilizing JavaScript/TypeScript and Node's innovative features. RxJS was imported for reactive programming as well, opening up opportunities for easy content development. As such, there are a few things we're looking to avoid...
44

55
1. Direct ports/copying from Java servers
6-
- This defeats the purpose of Rune.JS by implementing basic flows that any regular Java-based server would use. Think outside the box and really utilize ES6, TypeScript, Node, and RxJS! :)
6+
- This defeats the purpose of RuneJS by implementing basic flows that any regular Java-based server would use. Think outside the box and really utilize ES6, TypeScript, Node, and RxJS! :)
77
2. Additional/outside dependencies
8-
- Sometimes additional dependencies can not be avoided, but we'd like to avoid them as much as possible. Rune.JS intends to be simple and easy for anyone to pick up, without requiring the user to set up any databases or additional third party systems.
8+
- Sometimes additional dependencies cannot be avoided, but we'd like to avoid them as much as possible. RuneJS intends to be simple and easy for anyone to pick up, without requiring the user to set up any databases or additional third party systems.
99
- In some cases this is of course unavoidable, as such we'll handle them on a case-by-case basis.
1010

1111
Ultimately if you're looking to contribute, it's best to check in with us on Discord to see if we're already working on a specific feature or have plans for it already. Add us at **TheBlackParade#1260**

README.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,38 +13,42 @@ The server runs on the 435 revision of the game, which was a game update made on
1313

1414
## Features
1515

16-
- RSA and ISAAC ciphering support.
17-
- Login & input/output packet handling.
18-
- Player saving/loading via JSON files.
19-
- Player credential validation and password hashing.
20-
- Multiplayer support.
21-
- Map-chunk based positioning.
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
2226
- Item support:
23-
- Item definition parsing via the game cache.
24-
- Additional item data loading via YAML configuration.
25-
- Inventory items, equipment items, item swapping.
26-
- Item dropping and picking up.
27-
- Buying/selling via shops.
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
2832
- Player equipment:
29-
- Equipment bonuses and item weight tracking.
30-
- Full equipment bonus widget support.
31-
- NPCs and NPC updating:
32-
- NPC spawn loading via YAML configuration.
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.
36-
- A diverse TypeScript plugin system for easily writing new content based off of in-game actions.
37-
- A simplified JavaScript plugin system for quickly and easily bootstrapping game content.
38-
- Flexible quest and dialogue systems for more advanced content development.
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
3943

4044
## Usage
4145

4246
1. Download and install NodeJS **version 13 or higher**: https://nodejs.org/en/
4347
2. Clone the Github Repo: https://github.com/rune-js/server
4448
3. Install dependencies by navigating to the project in your Terminal or command prompt and running the command npm install
45-
4. Copy the `data/config/server-config-default.yaml` and paste it into the same folder using the name `server-config.yaml`.
46-
5. Go into your new `server-config.yaml` file and modify your RSA modulus and exponent with the ones matching your game client.
47-
- You may also modify the server's port and host address from this configuration file.
49+
4. Copy the `data/config/server-config-default.yaml` and paste it into the same folder using the name `server-config.yaml`
50+
5. Go into your new `server-config.yaml` file and modify your RSA modulus and exponent with the ones matching your game client
51+
- You may also modify the server's port and host address from this configuration file
4852
6. Run the game server and REST service by inputting the command npm run server
4953

5054
The game server will spin up and be accessible via port 43594. The REST service can be accessed via port 8888.
@@ -64,10 +68,10 @@ Online players can be polled via the REST protocol for web applications.
6468

6569
##### API Endpoints:
6670

67-
- `GET /players` : Returns a list of players currently logged into the game server.
68-
- `GET /items?page=x&limit=y` : Returns a list of item metadata loaded by the game server.
69-
- `GET /items/{itemId}` : Returns details about a specific item by id.
70-
- `PUT /items/{itemId}` : Updates an item's configurable server data.
71+
- `GET /players` : Returns a list of players currently logged into the game server
72+
- `GET /items?page=x&limit=y` : Returns a list of item metadata loaded by the game server
73+
- `GET /items/{itemId}` : Returns details about a specific item by id
74+
- `PUT /items/{itemId}` : Updates an item's configurable server data
7175

7276
## Aditional Information
7377

0 commit comments

Comments
 (0)