[DRAFT] Trading

.babelrc

@@ -4,7 +4,7 @@
         "@babel/preset-typescript",
         [ "@babel/preset-env", {
             "targets": {
-                "node": "14"
+                "node": "16"
             },
             "modules": "commonjs"
         } ]
@@ -14,7 +14,8 @@
         [ "babel-plugin-module-resolver", {
             "root": [ "./src" ],
             "alias": {
-                "@engine": "./dist/game-engine",
+                "@engine": "./dist/engine",
+                "@server": "./dist/server",
                 "@plugins": "./dist/plugins"
             }
         } ]

.github/workflows/build.yml

@@ -2,7 +2,7 @@ name: Lint & Build Project
 
 on:
     pull_request:
-        branches: [ master, develop ]
+        branches: [ master, develop, feature/** ]
     push:
         branches: [ master, develop ]
 
@@ -25,5 +25,8 @@ jobs:
             -   name: Run Linter
                 run: npm run lint
 
+            -   name: Run Typecheck
+                run: npm run typecheck
+
             -   name: Build Project
                 run: npm run build

.gitignore

@@ -18,10 +18,11 @@ yarn-error.log*
 
 # Editor directories.ts and files
 .idea
-.vscode
 *.suo
 *.ntvs*
 *.njsproj
 *.sln
 *.sw?
 /.vs
+
+/coverage/

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+	"editor.tabSize": 4,
+	"files.trimTrailingWhitespace": true,
+	"files.trimFinalNewlines": true,
+	"files.insertFinalNewline": true
+}

CONTRIBUTING.md

@@ -35,3 +35,44 @@ We do have a few coding styles and lint rules we'd like all contributors to adhe
 - Use TypeScript getters/setters instead of specific getter/setter methods
   - `public get myVar(): number` instead of `public getMyVar(): number`
   - `public set myVar(myVar: number)` instead of `public setMyVar(myVar: number)`
+
+## Testing
+
+Unit tests can be written using Jest. To execute the test suite, run `npm test`
+
+- Test files should be located next to the file under test, and called `file-name.test.ts`
+- Tests should use the `when / then` pattern made up of composable `describe` statements
+- Make use of `beforeEach` to set up state before each test
+
+After running the tests, you can find code coverage in the `./coverage/` folder.
+
+### When / Then testing pattern
+
+Tests should be broken down into a series of `describe` statements, which set up their own internal state when possible.
+
+```ts
+describe('when there is a player', () => {
+  let player: Player
+
+  beforeEach(() => {
+    player = createMockPlayer()
+  })
+
+  describe('when player is wearing a hat', () => {
+    beforeEach(() => {
+      player.equipment().set(0, someHatItem)
+    })
+
+    test('should return true', () => {
+      const result = isWearingHat(player)
+
+      expect(result).toEqual(true)
+    })
+  })
+})
+```
+
+There are two main benefits to this kind of design:
+
+- It serves as living documentation: from reading the `beforeEach` block you can clearly see how the prerequisite of "player is wearing a hat" is achieved
+- It allows for easy expansion of test cases: future developers can add further statements inside "when player is wearing a hat" if they want to make use of that setup

Dockerfile

@@ -1,14 +1,15 @@
-FROM node:14
+FROM node:16
 WORKDIR /usr/src/app
 COPY package.json ./
 COPY package-lock.json ./
 
-RUN npm install
+RUN npm ci
 
 COPY src ./src
 COPY tsconfig.json ./
+COPY .babelrc ./
 
-RUN npm build
+RUN npm run build
 
 EXPOSE 43594
-CMD [ "npm", "start" ]
+CMD [ "npm", "run", "start:standalone" ]

README.md

@@ -1,37 +1,29 @@
-![RuneJS](https://i.imgur.com/pmkdSfc.png)
+[![RuneJS Discord Server](https://img.shields.io/discord/678751302297059336?label=RuneJS%20Discord&logo=discord)](https://discord.gg/5P74nSh)
 
-# RuneJS
+[![RuneJS](https://i.imgur.com/QSXNzwC.png)](https://github.com/runejs/)
 
-[![RuneJS Discord Server](https://img.shields.io/discord/678751302297059336?label=RuneJS%20Discord&logo=discord)](https://discord.gg/5P74nSh)
+# RuneJS Game Server
 
-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.
+RuneJS is a RuneScape game server written in 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.
 
-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.
+The game server currently runs a build of RuneScape from October 30th-31st, 2006 (game build #435). No other builds are supported at this time, but may become available in the future.
 
 **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!**
 
 ![RuneJS Lumbridge](https://i.imgur.com/KVCqKSb.png)
 
 ## Setup
 
-1. Download and install NodeJS **version 14 or higher**: https://nodejs.org/en/
-2. Clone the Github Repo: https://github.com/runejs/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 with `npm start`
-
-The game server will spin up and be accessible via port 43594.
+### Prerequisites
 
-### Setup using docker
+- [`docker`](https://docs.docker.com/get-docker/) and [`docker-compose`](https://docs.docker.com/compose/install/)
+  - If on Windows, `docker-compose` comes with `docker`
 
-1. Download and install Docker and Docker Compose: first https://docs.docker.com/get-docker/ then https://docs.docker.com/compose/install/ 
-2. Copy the `config/server-config.example.yaml` and paste it into the same folder using the name `server-config.yaml`
-3. Go into your new `server-config.yaml` file and modify your RSA modulus and exponent with the ones matching your game client
+1. Copy the `config/server-config.example.json` and paste it into the same folder using the name `server-config.json`
+2. Go into your new `server-config.json` 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. Build the docker image with `docker-compose build`
-5. Run the game server with `docker-compose up'
+3. Build the docker image with `docker-compose build`
+4. Run the game server with `docker-compose up'
 
 The game server will spin up and be accessible via port 43594.
 
@@ -40,12 +32,18 @@ The game server will spin up and be accessible via port 43594.
 The [RuneScape Java Client #435](https://github.com/runejs/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
+
+Before running these commands, you must:
+
+1. have [NodeJS **version 16 or higher**](https://nodejs.org/en/) installed on your machine
+2. run `npm install` from the root of this project
+
+* `npm run game` Launches the game server by itself without building
+* `npm run game:dev` Builds and launches the game server by itself in watch mode
+* `npm run login` Launches the login server by itself without building
+* `npm run update` Launches the update server by itself without building
+* `npm run infra` Launches both the login and update server without building
+* `npm run 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

config/server-config.example.json

@@ -12,6 +12,7 @@
     "loginServerPort": 43591,
     "rsaMod": "119568088839203297999728368933573315070738693395974011872885408638642676871679245723887367232256427712869170521351089799352546294030059890127723509653145359924771433131004387212857375068629466435244653901851504845054452735390701003613803443469723435116497545687393297329052988014281948392136928774011011998343",
     "rsaExp": "12747337179295870166838611986189126026507945904720545965726999254744592875817063488911622974072289858092633084100280214658532446654378876853112046049506789703022033047774294965255097838909779899992870910011426403494610880634275141204442441976355383839981584149269550057129306515912021704593400378690444280161",
+    "encryptionEnabled": true,
     "playerSavePath": "./data/saves",
 
     "showWelcome": true,

data/config/items/equipment/standard-metals/adamant-armour.json

@@ -9,7 +9,8 @@
                         "defence": 30
                     }
                 }
-            }
+            },
+            "groups": ["adamant_metal", "equipment"]
         }
     },
 
@@ -31,7 +32,8 @@
                 "magic": -4,
                 "ranged": 31
             }
-        }
+        },
+        "groups": ["legs"]
     },
 
     "rs:adamant_plateskirt": {
@@ -52,6 +54,7 @@
                 "magic": -4,
                 "ranged": 31
             }
-        }
+        },
+        "groups": ["legs"]
     }
 }

data/config/items/equipment/standard-metals/black-armour.json

@@ -9,7 +9,8 @@
                         "defence": 10
                     }
                 }
-            }
+            },
+            "groups": ["black_metal", "equipment"]
         }
     },
 
@@ -31,7 +32,8 @@
                 "magic": -4,
                 "ranged": 20
             }
-        }
+        },
+        "groups": ["legs"]
     },
 
     "rs:black_plateskirt": {
@@ -52,6 +54,7 @@
                 "magic": -4,
                 "ranged": 20
             }
-        }
+        },
+        "groups": ["legs"]
     }
 }

data/config/items/equipment/standard-metals/bronze-armour.json

@@ -1,5 +1,20 @@
 {
+    "presets": {
+        "rs:bronze_armour_base": {
+            "tradable": true,
+            "equippable": true,
+            "equipment_data": {
+                "requirements": {
+                    "skills": {
+                        "defence": 1
+                    }
+                }
+            },
+            "groups": ["bronze_metal", "equipment"]
+        }
+    },
     "rs:bronze_platelegs": {
+        "extends": "rs:bronze_armour_base",
         "game_id": 1075,
         "examine": "These look pretty heavy.",
         "weight": 9.071,
@@ -18,11 +33,13 @@
                 "magic": -4,
                 "ranged": 7
             }
-        }
+        },
+        "groups": ["legs"]
     },
 
     "rs:bronze_plateskirt": {
         "game_id": 1087,
+        "extends": "rs:bronze_armour_base",
         "examine": "Designer leg protection.",
         "weight": 8.164,
         "tradable": true,
@@ -40,6 +57,7 @@
                 "magic": -4,
                 "ranged": 7
             }
-        }
+        },
+        "groups": ["legs"]
     }
 }

data/config/items/equipment/standard-metals/bronze-weapons.json

@@ -1,6 +1,21 @@
 {
+    "presets": {
+        "rs:bronze_weapon_base": {
+            "tradable": true,
+            "equippable": true,
+            "equipment_data": {
+                "requirements": {
+                    "skills": {
+                        "defence": 1
+                    }
+                }
+            },
+            "groups": ["bronze_metal", "equipment", "weapon"]
+        }
+    },
     "rs:bronze_dagger": {
         "game_id": 1205,
+        "extends": "rs:bronze_weapon_base",
         "tradable": true,
         "weight": 0.453,
         "equippable": true,
@@ -9,7 +24,7 @@
             "equipment_type": "one_handed",
             "requirements": {
                 "quests": {
-                    "goblin_diplomacy": 20
+                    "tyn:goblin_diplomacy": 20
                 }
             },
             "offensive_bonuses": {
@@ -28,6 +43,7 @@
             "weapon_info": {
                 "style": "dagger"
             }
-        }
+        },
+        "groups": ["main_hand", "dagger"]
     }
 }