Making plugins able to be hot-reloaded with the ::plugins command.

package.json

@@ -5,9 +5,11 @@
     "main": "src/game-server.ts",
     "scripts": {
         "server": "npm start",
-        "start": "ts-node -r tsconfig-paths/register src/main.ts",
+        "start": "npm run build && concurrently \"npm run watch-plugins\" \"node dist/main.js\"",
         "lint": "tslint --project tsconfig.json",
-        "fake-players": "npm start -- --fakePlayers"
+        "fake-players": "npm start -- --fakePlayers",
+        "build": "tsc --project tsconfig.json && tscpaths -p tsconfig.json -s ./src -o ./dist",
+        "watch-plugins": "nodemon --watch src/plugins/ --exec \"npm run build\" -e ts"
     },
     "repository": {
         "type": "git",
@@ -35,13 +37,17 @@
         "yargs": "^15.0.2"
     },
     "devDependencies": {
+        "@halkeye/tscpaths": "0.0.9",
         "@types/body-parser": "^1.17.1",
         "@types/express": "^4.17.2",
         "@types/hapi__joi": "^16.0.6",
         "@types/js-yaml": "^3.12.1",
         "@types/node": "^12.12.6",
         "@types/uuid": "^3.4.6",
         "@types/yargs": "^13.0.4",
+        "chokidar": "^3.3.1",
+        "concurrently": "^5.1.0",
+        "nodemon": "^2.0.2",
         "tsconfig-paths": "^3.9.0",
         "tslint": "^5.20.1"
     }

src/game-server.ts

@@ -1,33 +1,37 @@
 import * as net from 'net';
-import { join } from 'path';
 import yargs from 'yargs';
+import { watch } from 'chokidar';
 
 import { RsBuffer } from './net/rs-buffer';
 import { World } from './world/world';
 import { ClientConnection } from './net/client-connection';
 import { logger } from '@runejs/logger';
 import { GameCache } from '@runejs/cache-parser';
-import { loadPlugins } from '@server/plugins/plugin-loader';
 import { NpcActionPlugin, setNpcPlugins } from '@server/world/mob/player/action/npc-action';
 import { plugins as npcPlugins } from '@server/plugins/npc-plugin/npc-plugins';
 import { ObjectActionPlugin, setObjectPlugins } from '@server/world/mob/player/action/object-action';
 import { plugins as objectPlugins } from '@server/plugins/object-plugin/object-plugins';
+import { loadPlugins } from '@server/plugins/plugin-loader';
 
 const GAME_SERVER_PORT = 43594;
+export let gameCache;
+export let world;
 
-export const serverDir = join(__dirname, '../');
-export const gameCache = new GameCache(join(serverDir, 'cache'));
-export const world = new World();
-world.init();
-
-loadPlugins<NpcActionPlugin>('npc-plugin', npcPlugins).then(plugins => setNpcPlugins(plugins));
-loadPlugins<ObjectActionPlugin>('object-plugin', objectPlugins).then(plugins => setObjectPlugins(plugins));
-
-if(yargs.argv.fakePlayers) {
-    world.generateFakePlayers();
+export async function injectPlugins(): Promise<void> {
+    await loadPlugins<NpcActionPlugin>('npc-plugin', npcPlugins).then(plugins => setNpcPlugins(plugins));
+    await loadPlugins<ObjectActionPlugin>('object-plugin', objectPlugins).then(plugins => setObjectPlugins(plugins));
 }
 
 export function runGameServer(): void {
+    gameCache = new GameCache('cache');
+    world = new World();
+    world.init();
+    injectPlugins();
+
+    if(yargs.argv.fakePlayers) {
+        world.generateFakePlayers();
+    }
+
     net.createServer(socket => {
         logger.info('Socket opened');
         // socket.setNoDelay(true);
@@ -53,4 +57,13 @@ export function runGameServer(): void {
     }).listen(GAME_SERVER_PORT, '127.0.0.1');
 
     logger.info(`Game server listening on port ${GAME_SERVER_PORT}.`);
+
+    const watcher = watch('dist/plugins/');
+    watcher.on('ready', function() {
+        watcher.on('all', function() {
+            Object.keys(require.cache).forEach(function(id) {
+                if (/[\/\\]plugins[\/\\]/.test(id)) delete require.cache[id];
+            });
+        })
+    });
 }

src/plugins/object-plugin/doors/door-plugin.ts

@@ -51,8 +51,8 @@ const rightHingeDir: { [key: string]: string } = {
 };
 
 export const action: objectAction = (player: Player, door: LandscapeObject, position: Position, cacheOriginal: boolean): void => {
-    player.packetSender.chatboxMessage(`door ${door.objectId}`);
     let opening = true;
+
     let doorConfig = doors.find(d => d.closed === door.objectId);
     let hingeConfig;
     let replacementDoorId: number;

src/plugins/plugin-loader.ts

@@ -2,7 +2,7 @@ export async function loadPlugins<T>(prefix: string, pluginList: string[]): Prom
     const plugins: T[] = [];
 
     for(const pluginPath of pluginList) {
-        const plugin = await import(`@server/plugins/${prefix}/${pluginPath}`);
+        const plugin = await import(`./${prefix}/${pluginPath}`);
         plugins.push(plugin.default as T);
     }
 

src/world/config/item-data.ts

@@ -1,8 +1,6 @@
 import { readFileSync, writeFileSync } from 'fs';
 import { ItemDefinition } from '@runejs/cache-parser';
 import { logger } from '@runejs/logger/dist/logger';
-import { join } from 'path';
-import { serverDir } from '@server/game-server';
 import { JSON_SCHEMA, safeLoad, safeDump } from 'js-yaml';
 
 export enum EquipmentSlot {
@@ -106,13 +104,13 @@ export function saveItemData(itemDetailsMap: Map<number, ItemDetails>): void {
     });
 
     try {
-        const backupItemData = safeLoad(readFileSync(join(serverDir, 'data/config/item-data.yaml'), 'utf8'), { schema: JSON_SCHEMA }) as ItemData[];
+        const backupItemData = safeLoad(readFileSync('data/config/item-data.yaml', 'utf8'), { schema: JSON_SCHEMA }) as ItemData[];
 
         if(backupItemData && backupItemData.length !== 0) {
-            writeFileSync(join(serverDir, 'data/config/item-data-backup.yaml'), safeDump(backupItemData, { schema: JSON_SCHEMA }), 'utf8');
+            writeFileSync('data/config/item-data-backup.yaml', safeDump(backupItemData, { schema: JSON_SCHEMA }), 'utf8');
         }
 
-        writeFileSync(join(serverDir, 'data/config/item-data.yaml'), safeDump(itemArray, { schema: JSON_SCHEMA }), 'utf8');
+        writeFileSync('data/config/item-data.yaml', safeDump(itemArray, { schema: JSON_SCHEMA }), 'utf8');
     } catch(error) {
         logger.error('Error saving game item data: ' + error);
     }
@@ -122,7 +120,7 @@ export function parseItemData(itemDefinitions: Map<number, ItemDefinition>): Map
     try {
         logger.info('Parsing additional item data...');
 
-        const itemDataList = safeLoad(readFileSync(join(serverDir, 'data/config/item-data.yaml'), 'utf8'), { schema: JSON_SCHEMA }) as ItemData[];
+        const itemDataList = safeLoad(readFileSync('data/config/item-data.yaml', 'utf8'), { schema: JSON_SCHEMA }) as ItemData[];
 
         if(!itemDataList || itemDataList.length === 0) {
             throw 'Unable to read item data.';

src/world/config/npc-spawn.ts

@@ -1,8 +1,6 @@
 import { logger } from '@runejs/logger/dist/logger';
 import { JSON_SCHEMA, safeLoad } from 'js-yaml';
 import { readFileSync } from 'fs';
-import { join } from 'path';
-import { serverDir } from '@server/game-server';
 import { Direction } from '@server/world/direction';
 
 export interface NpcSpawn {
@@ -18,7 +16,7 @@ export function parseNpcSpawns(): NpcSpawn[] {
     try {
         logger.info('Parsing npc spawns...');
 
-        const npcSpawns = safeLoad(readFileSync(join(serverDir, 'data/config/npc-spawns.yaml'), 'utf8'), { schema: JSON_SCHEMA }) as NpcSpawn[];
+        const npcSpawns = safeLoad(readFileSync('data/config/npc-spawns.yaml', 'utf8'), { schema: JSON_SCHEMA }) as NpcSpawn[];
 
         if(!npcSpawns || npcSpawns.length === 0) {
             throw 'Unable to read npc spawns.';

src/world/mob/player/action/input-command-action.ts

@@ -1,6 +1,6 @@
 import { Player } from '../player';
 import { logger } from '@runejs/logger/dist/logger';
-import { world } from '@server/game-server';
+import { injectPlugins, world } from '@server/game-server';
 import { interfaceIds } from '../game-interface';
 import { npcAction } from '@server/world/mob/player/action/npc-action';
 
@@ -88,7 +88,7 @@ const commands: { [key: string]: commandHandler } = {
         player.packetSender.showChatboxInterface(interfaceId);
     },
 
-    sound: (player: Player, args: string[]) => {
+    sound: (player, args) => {
         if(args.length !== 1 && args.length !== 2) {
             throw `sound soundId [volume?]`;
         }
@@ -110,6 +110,14 @@ const commands: { [key: string]: commandHandler } = {
         }
 
         player.packetSender.playSound(soundId, volume);
+    },
+
+    plugins: player => {
+        player.packetSender.chatboxMessage('Reloading plugins...');
+
+        injectPlugins()
+            .then(() => player.packetSender.chatboxMessage('Plugins reloaded.'))
+            .catch(() => player.packetSender.chatboxMessage('Error reloading plugins.'));
     }
 
 };

src/world/mob/player/action/npc-action.ts

@@ -25,7 +25,7 @@ let npcInteractions: NpcActionPlugin[] = [
 ];
 
 /**
- * Sets the list of NPC interaction plugins. Only to be called on server startup!
+ * Sets the list of NPC interaction plugins.
  * @param plugins The plugin list.
  */
 export const setNpcPlugins = (plugins: NpcActionPlugin[]): void => {

src/world/mob/player/action/object-action.ts

@@ -24,7 +24,7 @@ export interface ObjectActionPlugin {
 let objectInteractions: ObjectActionPlugin[] = [];
 
 /**
- * Sets the list of object interaction plugins. Only to be called on server startup!
+ * Sets the list of object interaction plugins.
  * @param plugins The plugin list.
  */
 export const setObjectPlugins = (plugins: ObjectActionPlugin[]): void => {

src/world/mob/player/player-data.ts

@@ -1,5 +1,4 @@
 import { Item } from '@server/world/items/item';
-import { serverDir } from '@server/game-server';
 import { writeFileSync, readFileSync, existsSync } from 'fs';
 import { join } from 'path';
 import { logger } from '@runejs/logger/dist/logger';
@@ -80,7 +79,7 @@ export const defaultSettings = (): PlayerSettings => {
 
 export function savePlayerData(player: Player): boolean {
     const fileName = player.username.toLowerCase() + '.json';
-    const filePath = join(serverDir, 'data/saves', fileName);
+    const filePath = join('data/saves', fileName);
 
     const playerSave: PlayerSave = {
         username: player.username,
@@ -106,7 +105,7 @@ export function savePlayerData(player: Player): boolean {
 
 export function loadPlayerSave(username: string): PlayerSave {
     const fileName = username.toLowerCase() + '.json';
-    const filePath = join(serverDir, 'data/saves', fileName);
+    const filePath = join('data/saves', fileName);
 
     if(!existsSync(filePath)) {
         return null;

tsconfig.json

@@ -11,11 +11,11 @@
         "sourceMap": true,
         "baseUrl": ".",
         "allowJs": true,
+        "outDir": "./dist/",
         "paths": {
             "@server/*": ["src/*"]
         },
         "types": [
-            "webpack-env",
             "node"
         ],
         "lib": [