Merge branch 'master' into combat

Author: TheBlackParade

.github/workflows/master.yml

@@ -0,0 +1,29 @@
+name: Lint & Build Project
+
+on:
+    pull_request:
+        branches: [ master ]
+    push:
+        branches: [ master ]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        steps:
+            -   name: Checkout Repository
+                uses: actions/checkout@v2
+
+            -   name: Setup Node
+                uses: actions/setup-node@v1
+                with:
+                    node-version: '13.x'
+
+            -   name: Install Node Modules
+                run: npm i
+
+            -   name: Run Linter
+                run: npm run lint
+
+            -   name: Build Project
+                run: npm run build

CONTRIBUTING.md

@@ -1,11 +1,11 @@
-# Contributing to Rune.JS
+# Contributing to RuneJS
 
-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...
+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...
 
 1. Direct ports/copying from Java servers
-    - 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! :)
+    - 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! :)
 2. Additional/outside dependencies
-    - 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.
+    - 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.
     - In some cases this is of course unavoidable, as such we'll handle them on a case-by-case basis. 
 
 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

@@ -7,36 +7,48 @@
 
 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.
 
-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.
+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.
+
+**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!**
 
 ## Features
 
-- RSA and ISAAC ciphering support.
-- Login & input/output packet handling.
-- Player saving/loading via JSON files.
-- Multiplayer support.
-- Map region/chunk handling.
-- Item inventory implementation.
-  - Item definition parsing via the game cache.
-  - Additional item data loading via YAML configuration.
-  - Inventory item swapping.
-- Player equipment with item bonuses & weight.
-- NPC spawning and updating.
-  - NPC spawn loading via YAML configuration.
-- Player & NPC pathing validation via collision and tile maps generated from the 377 game cache.
-- A basic REST service for polling logged in users.
-- Full functional update server.
-- A diverse TypeScript plugin system for easily writing new content based off of in-game actions.
-- Flexible quest and dialogue systems for easy content development.
+- Asynchronous server infrastructure using Promises and RxJS Observables
+- RSA and ISAAC ciphering support
+- Login & input/output packet handling
+- Player saving/loading via JSON files
+- Player credential validation and password hashing
+- Multiplayer support:
+  - Multiplayer rendering
+  - Full chat support
+  - Quadtree collision detection for finding nearby players to synchronize
+- Map-chunk based positioning
+- Item support:
+  - Item definition parsing via the game cache
+  - Additional item data loading via YAML configuration
+  - Inventory items, equipment items, item swapping
+  - Item dropping and picking up
+  - Buying/selling via shops
+- Player equipment:
+  - Equipment bonuses and item weight tracking
+  - Full equipment bonus widget support
+- NPCs and NPC synchronization:
+  - NPC spawn loading via YAML configuration
+- Player & NPC pathing validation via collision and tile maps generated from the game cache
+- A basic REST service for polling logged in users and game items
+- Fully functional game update server
+- A diverse TypeScript plugin system for easily writing new content based off of in-game actions
+- A simplified JavaScript plugin system for quickly and easily bootstrapping game content
+- Flexible quest and dialogue systems for more advanced content development
 
 ## Usage
 
-1. Download and install Node.JS **version 12 or higher**: https://nodejs.org/en/
+1. Download and install NodeJS **version 13 or higher**: https://nodejs.org/en/
 2. Clone the Github Repo: https://github.com/rune-js/server
 3. Install dependencies by navigating to the project in your Terminal or command prompt and running the command npm install
-4. Copy the `data/config/server-config-default.yaml` and paste it into the same folder using the name `server-config.yaml`. 
-5. Go into your new `server-config.yaml` file and modify your RSA modulus and exponent with the ones matching your game client.
-  - You may also modify the server's port and host address from this configuration file.
+4. Copy the `data/config/server-config-default.yaml` and paste it into the same folder using the name `server-config.yaml`
+5. Go into your new `server-config.yaml` file and modify your RSA modulus and exponent with the ones matching your game client
+  - You may also modify the server's port and host address from this configuration file
 6. Run the game server and REST service by inputting the command npm run server
 
 The game server will spin up and be accessible via port 43594. The REST service can be accessed via port 8888.
@@ -56,10 +68,10 @@ Online players can be polled via the REST protocol for web applications.
 
 ##### API Endpoints:
 
-- `GET /players` : Returns a list of players currently logged into the game server.
-- `GET /items?page=x&limit=y` : Returns a list of item metadata loaded by the game server.
-- `GET /items/{itemId}` : Returns details about a specific item by id.
-- `PUT /items/{itemId}` : Updates an item's configurable server data.
+- `GET /players` : Returns a list of players currently logged into the game server
+- `GET /items?page=x&limit=y` : Returns a list of item metadata loaded by the game server
+- `GET /items/{itemId}` : Returns details about a specific item by id
+- `PUT /items/{itemId}` : Updates an item's configurable server data
 
 ## Aditional Information