Updating README and adding FEATURES.md

jameshallam93 · Mar 13, 2021 · fd95cf8 · fd95cf8
1 parent 7e6d42c
commit fd95cf8
Show file tree

Hide file tree

Showing 3 changed files with 123 additions and 106 deletions.
diff --git a/FEATURES.md b/FEATURES.md
@@ -0,0 +1,106 @@
+[![RuneJS Discord Server](https://img.shields.io/discord/678751302297059336?label=RuneJS%20Discord&logo=discord)](https://discord.gg/5P74nSh)
+
+
+![RuneJS](https://i.imgur.com/pmkdSfc.png)
+
+# RuneJS Feature List
+
+## Game Server
+
+* RSA + ISAAC ciphering :heavy_check_mark:
+* Game Update Server :heavy_check_mark:
+* Authentication Server :heavy_check_mark:
+* Server side cache loading :heavy_check_mark:
+    * Client pathing validation via cache mapdata :heavy_check_mark:
+    * Item/object/npc definitions :heavy_check_mark:
+* Packet queueing  :heavy_check_mark:
+
+### Technical Features
+
+* Asynchronous server infrastructure w/ Promises & RxJS Observables
+* 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
+* Code compilation via Babel, offering more seamless compilation and redeployment of plugins
+
+## Game World
+
+* Private & group Player Instances :heavy_check_mark:
+* Personal player instance objects and world items :heavy_check_mark:
+* Bank :heavy_check_mark:
+    * Withdraw/Deposit 1,5,10,All :heavy_check_mark:
+    * As note  :heavy_check_mark:
+    * Swap slot :heavy_check_mark:
+    * Insert mode: :heavy_check_mark:
+    * Deposit box :heavy_check_mark:
+* Audio :yellow_square:
+    * Music :yellow_square:
+        * Playing music :heavy_check_mark:
+        * Music Regions :x:
+        * Music Player tab :x:
+    * Sounds :yellow_square:
+        * Playing sounds :heavy_check_mark:
+        * Sound effects for actions :yellow_square:
+* Home Teleport :heavy_check_mark:
+* Emotes :heavy_check_mark:
+    * Skillcape emotes :heavy_check_mark:
+    * Unlockable emotes w/ requirements :heavy_check_mark:
+* Shop support :heavy_check_mark:
+* Inventory support :heavy_check_mark:
+    * Swapping items :heavy_check_mark:
+    * Dropping items :heavy_check_mark:
+    * Picking up ground items :heavy_check_mark:
+    * Equipping items :heavy_check_mark:
+* Doors/gates :yellow_square:
+    * NSEW doors :heavy_check_mark:
+    * Diagonal doors :yellow_square:
+    * Double doors :heavy_check_mark:
+    * Wooden gates :heavy_check_mark:
+* Climbing ladders & stairs :yellow_square:
+* Clue Scrolls :x:
+
+### Quests
+* Cook's Assistant :heavy_check_mark:
+
+### Skills
+
+* Combat :yellow_square:
+    * Melee :yellow_square:
+    * Ranged :x:
+    * Magic :x:
+* Prayer :x:
+* Cooking :x:
+* Fletching :x:
+* Fishing :x:
+* Firemaking :yellow_square:
+    * Fire lighting :yellow_square:
+    * Chain fires w/ movement :yellow_square:
+* Herblore :x:
+* Agility :x:
+* Thieving :x:
+* Slayer :x:
+* Farming :x:
+* Runecrafting :x:
+* Construction :x:
+* Woodcutting :yellow_square:
+    * Formula for success :heavy_check_mark:
+    * Chopping Trees :heavy_check_mark:
+    * Axes :heavy_check_mark:
+    * Birds nests  :heavy_check_mark:
+    * Stump ids :yellow_square:
+    * Canoes :x:
+* Mining :yellow_square:
+    * Formula for success :heavy_check_mark:
+    * Mining ores :heavy_check_mark:
+    * Pickaxes :heavy_check_mark:
+    * Random gems  :heavy_check_mark:
+    * Gem ores :heavy_check_mark:
+    * Essence mining :heavy_check_mark:
+    * Empty Rock ids :yellow_square:
+* Crafting :yellow_square:
+    * Spinning wheel :heavy_check_mark:
+* Smithing :yellow_square:
+    * Smelting ore to bars :heavy_check_mark:
+    * Forging :yellow_square:
+        * Correct items :heavy_check_mark:
+        * Hiding non-applicable items :yellow_square:
diff --git a/README.md b/README.md
@@ -11,120 +11,31 @@ The server runs on the 435 revision of the game, which was a game update made on
 
 **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
-
-### Game Server
-
-* RSA + ISAAC ciphering :heavy_check_mark:
-* Game Update Server :heavy_check_mark:
-* Authentication Server :heavy_check_mark:
-* Server side cache loading :heavy_check_mark:
-    * Client pathing validation via cache mapdata :heavy_check_mark:
-    * Item/object/npc definitions :heavy_check_mark:
-* Packet queueing  :heavy_check_mark:
-
-### Game World
-
-* Private & group Player Instances :heavy_check_mark:
-* Personal player instance objects and world items :heavy_check_mark:
-* Bank :heavy_check_mark: 
-    * Withdraw/Deposit 1,5,10,All :heavy_check_mark:
-    * As note  :heavy_check_mark: 
-    * Swap slot :heavy_check_mark:
-    * Insert mode: :heavy_check_mark:
-    * Deposit box :heavy_check_mark: 
-* Audio :yellow_square:
-    * Music :yellow_square:
-        * Playing music :heavy_check_mark:
-        * Music Regions :x:
-        * Music Player tab :x:
-    * Sounds :yellow_square:
-        * Playing sounds :heavy_check_mark:
-        * Sound effects for actions :yellow_square:
-* Home Teleport :heavy_check_mark:
-* Emotes :heavy_check_mark:
-    * Skillcape emotes :heavy_check_mark:
-    * Unlockable emotes w/ requirements :heavy_check_mark:
-* Shop support :heavy_check_mark:
-* Inventory support :heavy_check_mark:
-    * Swapping items :heavy_check_mark:
-    * Dropping items :heavy_check_mark:
-    * Picking up ground items :heavy_check_mark:
-    * Equipping items :heavy_check_mark:
-* Doors/gates :yellow_square: 
-    * NSEW doors :heavy_check_mark:
-    * Diagonal doors :yellow_square:
-    * Double doors :heavy_check_mark: 
-    * Wooden gates :heavy_check_mark: 
-* Climbing ladders & stairs :yellow_square:
-* Clue Scrolls :x:
-
-### Skills
-
-* Combat :yellow_square:
-    * Melee :yellow_square:
-    * Ranged :x:
-    * Magic :x:
-* Prayer :x:
-* Cooking :x:
-* Fletching :x:
-* Fishing :x:
-* Firemaking :yellow_square:
-    * Fire lighting :yellow_square:
-    * Chain fires w/ movement :yellow_square:
-* Herblore :x:
-* Agility :x:
-* Thieving :x:
-* Slayer :x:
-* Farming :x:
-* Runecrafting :x:
-* Construction :x:
-* Woodcutting :yellow_square: 
-    * Formula for success :heavy_check_mark:
-    * Chopping Trees :heavy_check_mark: 
-    * Axes :heavy_check_mark:
-    * Birds nests  :heavy_check_mark: 
-    * Stump ids :yellow_square: 
-    * Canoes :x:
-* Mining :yellow_square: 
-    * Formula for success :heavy_check_mark:
-    * Mining ores :heavy_check_mark: 
-    * Pickaxes :heavy_check_mark:
-    * Random gems  :heavy_check_mark: 
-    * Gem ores :heavy_check_mark:
-    * Essence mining :heavy_check_mark:
-    * Empty Rock ids :yellow_square: 
-* Crafting :yellow_square: 
-    * Spinning wheel :heavy_check_mark:
-* Smithing :yellow_square: 
-    * Smelting ore to bars :heavy_check_mark:
-    * Forging :yellow_square:
-        * Correct items :heavy_check_mark:
-        * Hiding non applicable items :yellow_square: 
-
-### Quests
-* Cook's Assistant :heavy_check_mark:
-
-### Technical Features
-
-* Asynchronous server infrastructure w/ Promises & RxJS Observables
-* 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
-* Code compilation via Babel, offering more seamless compilation and redeployment of plugins
+![RuneJS Lumbridge](https://prnt.sc/10krr67)
 
 ## Setup
 
-1. Download and install NodeJS **version 13 or higher**: https://nodejs.org/en/
+1. Download and install NodeJS **version 14 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.example.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 start`
+6. Run the game server with `npm start`
 
 The game server will spin up and be accessible via port 43594.
 
 ## Game Client
 
 The [RuneScape Java Client #435](https://github.com/rune-js/refactored-client-435) must be used to log into a RuneJS game server.
+
+## Additional Commands
+* `npm run start:game` Launches the game server by itself without building
+* `npm run start:game:dev` Builds and launches the game server by itself in watch mode
+* `npm run start:login` Launches the login server by itself without building
+* `npm run start:update` Launches the update server by itself without building
+* `npm run start:infra` Launches both the login and update server without building
+* `npm run start:standalone` Launches all three servers concurrently without building
+* `npm run build:watch` Builds the application and watches for changes
+* `npm run build` Builds the application
+* `npm run lint` Runs the linter against the codebase to look for code style issues
diff --git a/package.json b/package.json
@@ -1,12 +1,12 @@
 {
     "name": "@runejs/server",
     "version": "1.0.0-alpha.0",
-    "description": "",
-    "main": "src/game-engine/game-server.ts",
+    "description": "A RuneScape game server emulator written in TypeScript.",
+    "main": "dist/index.js",
     "scripts": {
         "start": "npm run build && concurrently \"npm run build:watch\" \"npm run start:infra\" \"npm run start:game\"",
         "start:game": "nodemon --delay 5000ms --max-old-space-size=2048 dist/index.js",
-        "start:game:dev": "concurrently \"npm run build:watch\" \"npm run start:game\"",
+        "start:game:dev": "npm run build && concurrently \"npm run build:watch\" \"npm run start:game\"",
         "start:login": "node --max-old-space-size=1024 dist/game-engine/login-server.js",
         "start:update": "node --max-old-space-size=1024 dist/game-engine/update-server.js",
         "start:infra": "concurrently \"npm run start:update\" \"npm run start:login\"",