Merge pull request #314 from runejs/feature/construction

Construction: Adding new rooms + house saving/loading

Author: Tynarus

.gitignore

@@ -2,6 +2,7 @@ node_modules
 .DS_Store
 /dist
 /data/dump
+/data/houses
 /data/saves/*.json
 /data/config/server-config.yaml
 

package.json

@@ -5,16 +5,14 @@
     "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": "nodemon --delay 5000ms --max-old-space-size=2048 dist/main.js",
         "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\"",
         "start:standalone": "concurrently \"npm run start:infra\" \"npm run start:game\"",
         "lint": "eslint -c .eslintrc.js --ext .ts src",
-        "lint-fix": "eslint -c .eslintrc.js --ext .ts src --fix",
-        "fake-players": "concurrently \"npm run build:watch\" \"node --max-old-space-size=4096 dist/index.js -fakePlayers\"",
-        "fake-players-tick": "concurrently \"npm run build:watch\" \"node --max-old-space-size=4096 dist/index.js -fakePlayers -tickTime\"",
+        "lint:fix": "eslint -c .eslintrc.js --ext .ts src --fix",
         "build:watch": "babel ./src --out-dir dist --extensions \".ts,.tsx,.js\" --source-maps --watch",
         "build": "rimraf dist && babel ./src --out-dir dist --extensions \".ts,.tsx,.js\" --source-maps"
     },

src/game-engine/net/outbound-packets.ts

@@ -71,22 +71,22 @@ export class OutboundPackets {
     //packet - 129 - freezes client?
     //packet - 202 - directly to login screen
 
-    public sendProjectile(position: Position, offsetX: number, offsetY: number, id: number, startHeight: number, endHeight: number, speed: number, lockon: number, delay: number) {
-        this.updateReferencePosition(position);
-        
-        const packet = new Packet(1);
-        packet.put(0);
-        packet.put(offsetY, 'byte');
-        packet.put(offsetX, 'byte');
-        packet.put(lockon, 'SHORT', 'BIG_ENDIAN');
-        packet.put(id, 'SHORT', 'BIG_ENDIAN');
-        packet.put(startHeight);
-        packet.put(endHeight);
-        packet.put(delay, 'SHORT', 'BIG_ENDIAN');
-        packet.put(speed, 'SHORT', 'BIG_ENDIAN');
-        packet.put(16);
-        packet.put(64);
-        this.queue(packet);
+    public sendProjectile(position: Position, offsetX: number, offsetY: number, id: number, startHeight: number, endHeight: number, speed: number, lockon: number, delay: number) {
+        this.updateReferencePosition(position);
+        
+        const packet = new Packet(1);
+        packet.put(0);
+        packet.put(offsetY, 'byte');
+        packet.put(offsetX, 'byte');
+        packet.put(lockon, 'SHORT', 'BIG_ENDIAN');
+        packet.put(id, 'SHORT', 'BIG_ENDIAN');
+        packet.put(startHeight);
+        packet.put(endHeight);
+        packet.put(delay, 'SHORT', 'BIG_ENDIAN');
+        packet.put(speed, 'SHORT', 'BIG_ENDIAN');
+        packet.put(16);
+        packet.put(64);
+        this.queue(packet);
     } 
     public updateFriendStatus(friendName: string, worldId: number): void {
         const packet = new Packet(156);
@@ -630,11 +630,11 @@ export class OutboundPackets {
                     const constructedChunk: ConstructedChunk | null = mapData.chunks[level][mapTileOffsetX][mapTileOffsetY];
                     packet.putBits(1, constructedChunk === null ? 0 : 1)
                     if (constructedChunk !== null) {
-                        const { templatePosition, rotation } = constructedChunk;
+                        const { templatePosition, orientation } = constructedChunk;
                         packet.putBits(2, templatePosition?.level & 0x3);
                         packet.putBits(10, templatePosition?.x / 8);
                         packet.putBits(11, templatePosition?.y / 8);
-                        packet.putBits(2, rotation || 0);
+                        packet.putBits(2, orientation || 0);
                         packet.putBits(1, 0); // unused
                     }
                 }

src/game-engine/plugins/content-plugin.ts

@@ -24,7 +24,7 @@ export async function loadPluginFiles(): Promise<ContentPlugin[]> {
     const relativeDir = join('..', '..', 'plugins');
     const plugins: ContentPlugin[] = [];
 
-    for await(const path of getFiles(pluginDir, { type: 'whitelist', list: ['.plugin.js'] })) {
+    for await(const path of getFiles(pluginDir, { type: 'whitelist', list: ['.plugin.js', 'index.js'] })) {
         const location = join(relativeDir, path.substring(pluginDir.length).replace('.js', ''));
 
         try {

src/game-engine/world/index.ts

@@ -171,7 +171,7 @@ export class World {
 
         const tileX = objectTile.templatePosition.x;
         const tileY = objectTile.templatePosition.y;
-        const tileOrientation = objectTile.rotation;
+        const tileOrientation = objectTile.orientation;
 
         const objectLocalX = objectPosition.x - (objectChunk.position.x + 6) * 8;
         const objectLocalY = objectPosition.y - (objectChunk.position.y + 6) * 8;
@@ -197,7 +197,7 @@ export class World {
         realObject.y = objectPosition.y;
         realObject.level = objectPosition.level;
 
-        let rotation = realObject.orientation + objectTile.rotation;
+        let rotation = realObject.orientation + objectTile.orientation;
         if(rotation > 3) {
             rotation -= 4;
         }

src/game-engine/world/map/region.ts

@@ -4,7 +4,7 @@
  * chunk: 8x8 tile chunk within a map.
  */
 import { Position } from '@engine/world/position';
-import { Room } from '@plugins/skills/construction/con-house';
+import { Room } from '@plugins/skills/construction/house';
 
 
 export type RegionType = 'mapfile' | 'region' | 'chunk';
@@ -28,10 +28,10 @@ export const regionSizes: RegionSizeMap = {
 
 export abstract class ConstructedChunk {
 
-    public rotation: number;
+    public orientation: number;
 
     protected constructor(rotation: number = 0) {
-        this.rotation = rotation;
+        this.orientation = rotation;
     }
 
     public abstract getTemplatePosition(): Position;

src/game-engine/world/position.ts

@@ -222,6 +222,14 @@ export class Position {
         return this._y - 8 * this.chunkY;
     }
 
+    public get localX(): number {
+        return this._x - 8 * (this.chunkX + 6);
+    }
+
+    public get localY(): number {
+        return this._y - 8 * (this.chunkY + 6);
+    }
+
     public get x(): number {
         return this._x;
     }

src/index.ts src/main.tssrc/index.ts renamed to src/main.ts

@@ -4,25 +4,99 @@ import { Position } from '@engine/world/position';
 export const MAP_SIZE = 13;
 
 
-export type RoomType = 'empty' | 'empty_grass' | 'garden_1' | 'garden_2' | 'parlor';
+export type RoomType =
+    'empty'
+    | 'empty_grass'
+    | 'garden'
+    | 'formal_garden'
+    | 'parlor'
+    | 'kitchen'
+    | 'dining_room'
+    | 'bedroom'
+    | 'skill_hall'
+    | 'quest_hall'
+    | 'portal_chamber'
+    | 'combat_room'
+    | 'games_room'
+    | 'treasure_room'
+    | 'chapel'
+    | 'study'
+    | 'throne_room'
+    | 'workshop'
+    | 'oubliette'
+    | 'costume_room';
 
 
-export type RoomTemplateMap = {
-    [key in RoomType]: Position;
+export const RoomStyle = {
+    basic_wood: 0,
+    basic_stone: 1,
+    whitewashed_stone: 2,
+    fremennik_wood: 3,
+    tropical_wood: 4,
+    fancy_stone: 5
 };
 
-export const roomTemplates: RoomTemplateMap = {
-    empty: new Position(1856, 5056),
-    empty_grass: new Position(1864, 5056),
-    garden_1: new Position(1856, 5064),
-    garden_2: new Position(1872, 5064),
-    parlor: new Position(1856, 5112),
+
+/**
+ * A map of room types to their respective world map template positions within the game.
+ */
+export const roomTemplates: { [key in RoomType]: Position } = {
+    empty:          new Position(1856, 5056),
+    empty_grass:    new Position(1864, 5056),
+    garden:         new Position(1856, 5064),
+    formal_garden:  new Position(1872, 5064),
+    parlor:         new Position(1856, 5112),
+    kitchen:        new Position(1872, 5112),
+    dining_room:    new Position(1888, 5112),
+    bedroom:        new Position(1904, 5112),
+    skill_hall:     new Position(1864, 5104),
+    quest_hall:     new Position(1912, 5104),
+    portal_chamber: new Position(1864, 5088),
+    combat_room:    new Position(1880, 5088),
+    games_room:     new Position(1896, 5088),
+    treasure_room:  new Position(1912, 5088),
+    chapel:         new Position(1872, 5096),
+    study:          new Position(1888, 5096),
+    throne_room:    new Position(1904, 5096),
+    workshop:       new Position(1856, 5096),
+    oubliette:      new Position(1904, 5080),
+    costume_room:   new Position(1904, 5064, 0)
+};
+
+
+/**
+ * A map of room builder widget button ids to their respective room types.
+ */
+export const roomBuilderButtonMap: { [key: number]: RoomType } = {
+    160: 'parlor',
+    161: 'garden',
+    162: 'kitchen',
+    163: 'dining_room',
+    164: 'workshop',
+    165: 'bedroom',
+    166: 'skill_hall',
+    167: 'games_room',
+    168: 'combat_room',
+    169: 'quest_hall',
+    170: 'study',
+    171: 'costume_room',
+    172: 'chapel',
+    173: 'portal_chamber',
+    174: 'formal_garden',
+    175: 'throne_room',
+    176: 'oubliette',
+    177: 'treasure_room', // @TODO dungeon corridor
+    178: 'treasure_room', // @TODO dungeon junction
+    179: 'treasure_room', // @TODO dungeon stair
+    180: 'treasure_room'
 };
 
 
 export const instance1 = new Position(6400, 6400);
 export const instance1PohSpawn = new Position(6400 + 36, 6400 + 36);
 export const instance1Max = new Position(6400 + 64, 6400 + 64);
 export const instance2 = new Position(6400, 6464);
-export const instance2PohSpawn = new Position(6400 + 36, 6464 + 36);
+export const instance2PohSpawn = new Position(6400 + 36, 6464 + 36); // for reference
 export const instance2Max = new Position(6400 + 64, 6464 + 64);
+
+// Standard home outer door ids: closed[13100, 13101], open[13102, 13103]