@rpgjs/server 4.3.0 → 5.0.0-alpha.1

package/src/rooms/map.ts

@@ -0,0 +1,311 @@
+import { Action, MockConnection, Request, Room, RoomOnJoin } from "@signe/room";
+import { Hooks, IceMovement, ModulesToken, ProjectileMovement, ProjectileType, RpgCommonMap, ZoneData } from "@rpgjs/common";
+import { RpgPlayer, RpgEvent } from "../Player/Player";
+import { generateShortUUID, sync, users } from "@signe/sync";
+import { signal } from "@signe/reactive";
+import { inject } from "@signe/di";
+import { context } from "../core/context";;
+import { finalize, lastValueFrom } from "rxjs";
+import { Subject } from "rxjs";
+import { BehaviorSubject } from "rxjs";
+import { COEFFICIENT_ELEMENTS, DAMAGE_CRITICAL, DAMAGE_PHYSIC, DAMAGE_SKILL } from "../presets";
+
+/**
+ * Interface representing hook methods available for map events
+ * 
+ * These hooks are triggered at specific moments during the event lifecycle
+ */
+export interface EventHooks {
+  /** Called when the event is first initialized */
+  onInit?: () => void;
+  /** Called when the event properties change */
+  onChanges?: (player: RpgPlayer) => void;
+  /** Called when a player performs an action on this event */
+  onAction?: (player: RpgPlayer) => void;
+  /** Called when a player touches this event */
+  onPlayerTouch?: (player: RpgPlayer) => void;
+  /** Called when a player enters a shape */
+  onInShape?: (zone: ZoneData, player: RpgPlayer) => void;
+  /** Called when a player exits a shape */
+  onOutShape?: (zone: ZoneData, player: RpgPlayer) => void;
+
+  onDetectInShape?: (player: RpgPlayer, shape: ZoneData) => void;
+  onDetectOutShape?: (player: RpgPlayer, shape: ZoneData) => void;
+}
+
+/** Type for event class constructor */
+export type EventConstructor = new () => RpgPlayer;
+
+/** Options for positioning and defining an event on the map */
+export type EventPosOption = {
+  /** ID of the event */
+  id?: string,
+
+  /** X position of the event on the map */
+  x: number,
+  /** Y position of the event on the map */
+  y: number,
+  /** 
+   * Event definition - can be either:
+   * - A class that extends RpgPlayer
+   * - An object with hook methods
+   */
+  event: EventConstructor | (EventHooks & Record<string, any>)
+}
+
+@Room({
+  path: "map-{id}",
+  throttleSync: 0
+})
+export class RpgMap extends RpgCommonMap<RpgPlayer> implements RoomOnJoin {
+  @users(RpgPlayer) players = signal({});
+  @sync(RpgPlayer) events = signal({});
+  database = signal({});
+  maps: any[] = []
+  dataIsReady$ = new BehaviorSubject<void>(undefined);
+  globalConfig: any = {}
+  damageFormulas: any = {}
+
+  onJoin(player: RpgPlayer, conn: MockConnection) {
+    player.map = this;
+    player.context = context;
+    player.conn = conn;
+    this.physic.addMovableHitbox(player, player.x(), player.y(), player.hitbox().w, player.hitbox().h, {}, {
+      enabled: true,
+      friction: 0.8,
+      minVelocity: 0.5
+    });
+    this.physic.registerMovementEvents(player.id, () => {
+      player.animationName.set('walk')
+    }, () => {
+      player.animationName.set('stand')
+    })
+    this.dataIsReady$.pipe(
+      finalize(() => {
+        this.hooks
+          .callHooks("server-player-onJoinMap", player, this)
+          .subscribe();
+      })
+    ).subscribe();
+  }
+
+  get hooks() {
+    return inject<Hooks>(context, ModulesToken);
+  }
+
+  @Action('gui.interaction')
+  guiInteraction(player: RpgPlayer, value) {
+    //this.hooks.callHooks("server-player-guiInteraction", player, value);
+    player.syncChanges();
+  }
+
+  @Action('gui.exit')
+  guiExit(player: RpgPlayer, { guiId, data }) {
+    player.removeGui(guiId, data)
+  }
+
+  @Action('action')
+  onAction(player: RpgPlayer, action: any) {
+    const collisions = this.physic.getCollisions(player.id)
+    const events: (RpgEvent | undefined)[] = collisions.map(id => this.getEvent(id))
+    if (events.length > 0) {
+      events.forEach(event => {
+        event?.execMethod('onAction', [player, action]);
+      });
+    }
+    player.execMethod('onInput', [action]);
+  }
+
+  @Action('move')
+  onInput(player: RpgPlayer, input: any) {
+   this.movePlayer(player, input.input)
+  }
+
+  @Request({
+    path: "/map/update",
+    method: "POST",
+  })
+  async updateMap(request: Request) {
+    const map = await request.json()
+    this.data.set(map)
+    this.globalConfig = map.config
+    this.damageFormulas = map.damageFormulas || {};
+    this.damageFormulas = {
+        damageSkill: DAMAGE_SKILL,
+        damagePhysic: DAMAGE_PHYSIC,
+        damageCritical: DAMAGE_CRITICAL,
+        coefficientElements: COEFFICIENT_ELEMENTS,
+        ...this.damageFormulas
+    }
+    await lastValueFrom(this.hooks.callHooks("server-maps-load", this))
+
+    map.events = map.events ?? []
+
+    if (map.id) {
+     const mapFound = this.maps.find(m => m.id === map.id)
+     if (mapFound.events) {
+      map.events = [
+        ...mapFound.events,
+        ...map.events
+       ] 
+     }
+    }
+
+    await lastValueFrom(this.hooks.callHooks("server-map-onBeforeUpdate", map, this))
+
+    this.loadPhysic()
+
+    for (let event of map.events ?? []) {
+      await this.createDynamicEvent(event);
+    }
+
+    this.dataIsReady$.complete()
+    // TODO: Update map
+  }
+
+  addInDatabase(id: string, data: any) {
+    this.database()[id] = data;
+  }
+
+  /**
+   * Creates a dynamic event on the map
+   * 
+   * This method handles both class-based events and object-based events with hooks.
+   * For class-based events, it creates a new instance of the class.
+   * For object-based events, it creates a dynamic class that extends RpgPlayer and 
+   * implements the hook methods from the object.
+   * 
+   * @param eventObj - The event position and definition
+   * 
+   * @example
+   * // Using a class-based event
+   * class MyEvent extends RpgPlayer {
+   *   onInit() {
+   *     console.log('Event initialized');
+   *   }
+   * }
+   * 
+   * map.createDynamicEvent({
+   *   x: 100,
+   *   y: 200,
+   *   event: MyEvent
+   * });
+   * 
+   * // Using an object-based event
+   * map.createDynamicEvent({
+   *   x: 100,
+   *   y: 200,
+   *   event: {
+   *     onInit() {
+   *       console.log('Event initialized');
+   *     },
+   *     onPlayerTouch(player) {
+   *       console.log('Player touched event');
+   *     }
+   *   }
+   * });
+   */
+  async createDynamicEvent(eventObj: EventPosOption) {
+
+    if (!eventObj.event) {
+      // @ts-ignore
+      eventObj = {
+        event: eventObj 
+      }
+    }
+
+    const value = await lastValueFrom(this.hooks.callHooks("server-event-onBeforeCreated", eventObj, this));
+    value.filter(v => v).forEach(v => {
+      eventObj = v
+    })
+
+    const { x, y, event } = eventObj;
+    let id = eventObj.id || generateShortUUID()
+    let eventInstance: RpgPlayer;
+
+    if (this.events()[id]) {
+      console.warn(`Event ${id} already exists on map`);
+      return;
+    }
+
+    // Check if event is a constructor function (class)
+    if (typeof event === 'function') {
+      eventInstance = new event();
+    } 
+    // Handle event as an object with hooks
+    else {
+      // Create a new instance extending RpgPlayer with the hooks from the event object
+      class DynamicEvent extends RpgEvent {
+        onInit?: () => void;
+        onChanges?: (player: RpgPlayer) => void;
+        onAction?: (player: RpgPlayer) => void;
+        onPlayerTouch?: (player: RpgPlayer) => void;
+        onInShape?: (zone: ZoneData, player: RpgPlayer) => void;
+        onOutShape?: (zone: ZoneData, player: RpgPlayer) => void;
+        onDetectInShape?: (player: RpgPlayer, shape: ZoneData) => void;
+        onDetectOutShape?: (player: RpgPlayer, shape: ZoneData) => void;
+
+        constructor() {
+          super();
+          
+          // Copy hooks from the event object
+          const hookObj = event as EventHooks;
+          if (hookObj.onInit) this.onInit = hookObj.onInit.bind(this);
+          if (hookObj.onChanges) this.onChanges = hookObj.onChanges.bind(this);
+          if (hookObj.onAction) this.onAction = hookObj.onAction.bind(this);
+          if (hookObj.onPlayerTouch) this.onPlayerTouch = hookObj.onPlayerTouch.bind(this);
+          if (hookObj.onInShape) this.onInShape = hookObj.onInShape.bind(this);
+          if (hookObj.onOutShape) this.onOutShape = hookObj.onOutShape.bind(this);
+          if (hookObj.onDetectInShape) this.onDetectInShape = hookObj.onDetectInShape.bind(this);
+          if (hookObj.onDetectOutShape) this.onDetectOutShape = hookObj.onDetectOutShape.bind(this);
+        }
+      }
+
+      eventInstance = new DynamicEvent();
+    }
+
+    eventInstance.map = this;
+    eventInstance.context = context;
+
+    eventInstance.x.set(x);
+    eventInstance.y.set(y);
+  
+    this.events()[id] = eventInstance;
+
+    await eventInstance.execMethod('onInit')
+  }
+
+  getEvent<T extends RpgPlayer>(eventId: string): T | undefined {
+    return this.events()[eventId] as T
+  }
+
+  getPlayer(playerId: string): RpgPlayer | undefined {
+    return this.players()[playerId]
+  }
+
+  getEvents(): RpgEvent[] {
+    return Object.values(this.events())
+  }
+
+  removeEvent(eventId: string) {
+    delete this.events()[eventId]
+  }
+
+  showAnimation(animationName: string, object: RpgPlayer) {
+    this.$broadcast({
+      type: 'showEffect',
+      value: {
+        id: 'animation',
+        params: {
+          name: animationName
+        },
+        object: object.id
+      }
+    })
+  }
+}
+
+export interface RpgMap {
+  $send: (conn: MockConnection, data: any) => void; 
+  $broadcast: (data: any) => void;
+}

package/tsconfig.json

@@ -1,27 +1,30 @@
 {
     "compilerOptions": {
-        "target": "ES2020",
-        "module": "ES2020",
-        "outDir": "./lib",
-        "rootDir": "./src",
-        "strict": true,
-        "sourceMap": true,
-        "strictNullChecks": true,
-        "strictPropertyInitialization": false,
-        "moduleResolution": "node",
-        "esModuleInterop": true,
-        "removeComments": false,
-        "noUnusedParameters": false,
-        "noUnusedLocals": false,
-        "noImplicitThis": false,
-        "noImplicitAny": false,
-        "noImplicitReturns": false,
-        "declaration": true,
-        "experimentalDecorators": true,
-        "emitDecoratorMetadata": true,
-        "stripInternal": true
+      "target": "ES2020",
+      "lib": ["dom", "esnext"],
+      "module": "ES2020",
+      "outDir": "./lib",
+      "rootDir": "./src",
+      "strict": true,
+      "sourceMap": true,
+      "strictNullChecks": true,
+      "strictPropertyInitialization": false,
+      "moduleResolution": "node",
+      "esModuleInterop": true,
+      "removeComments": false,
+      "noUnusedParameters": false,
+      "noUnusedLocals": false,
+      "noImplicitThis": false,
+      "noImplicitAny": false,
+      "noImplicitReturns": false,
+      "declaration": true,
+      "experimentalDecorators": true, 
+      "emitDecoratorMetadata": true,
+      "stripInternal": true,
+      "skipLibCheck": true,
     },
     "include": [
-        "src"
-    ]
-}
+        "src",
+        "node_modules/canvasengine/*"
+, "../common/src/database"    ],
+  }

package/vite.config.ts

@@ -0,0 +1,21 @@
+import { defineConfig } from 'vite'
+import dts from 'vite-plugin-dts'
+
+export default defineConfig({
+  plugins: [
+    dts({ 
+      include: ['src/**/*.ts'],
+      outDir: 'dist'
+    })
+  ],
+  build: {
+    target: 'esnext',
+    sourcemap: true,
+    minify: false,
+    lib: {
+      entry: 'src/index.ts',
+      formats: ['es'],
+      fileName: 'index'
+    }
+  },
+})

package/CHANGELOG.md

@@ -1,174 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [4.3.0](https://github.com/RSamaium/RPG-JS/compare/v4.2.2...v4.3.0) (2024-01-29)
-
-
-### Bug Fixes
-
-* server url env ([e6a1237](https://github.com/RSamaium/RPG-JS/commit/e6a1237e360f7a25e2e8194127473e8a74d0b0ab))
-
-
-
-
-
-## [4.2.2](https://github.com/RSamaium/RPG-JS/compare/v4.2.1...v4.2.2) (2024-01-15)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-## [4.2.1](https://github.com/RSamaium/RPG-JS/compare/v4.2.0...v4.2.1) (2024-01-12)
-
-
-### Bug Fixes
-
-*  lag after action ([d057e17](https://github.com/RSamaium/RPG-JS/commit/d057e1736475e03a0553882a53b96a4d77e65acf))
-* [#277](https://github.com/RSamaium/RPG-JS/issues/277) #community-256 ([924ec6d](https://github.com/RSamaium/RPG-JS/commit/924ec6d6636b51eeb46cb1509c7244f69a8adb49)), closes [#community-256](https://github.com/RSamaium/RPG-JS/issues/community-256)
-* simple-room exports ([9592d18](https://github.com/RSamaium/RPG-JS/commit/9592d186cdb7d66dba4fe7b49d31b2fc97686677))
-
-
-
-
-
-# [4.2.0](https://github.com/RSamaium/RPG-JS/compare/v4.1.3...v4.2.0) (2023-12-09)
-
-
-### Features
-
-* inject function ([902e62f](https://github.com/RSamaium/RPG-JS/commit/902e62ff4fdd9b5bd26ee7d5be9ccae2b051f248))
-
-
-
-
-
-## [4.1.3](https://github.com/RSamaium/RPG-JS/compare/v4.1.2...v4.1.3) (2023-11-17)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-## [4.1.2](https://github.com/RSamaium/RPG-JS/compare/v4.1.1...v4.1.2) (2023-10-30)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-## [4.1.1](https://github.com/RSamaium/RPG-JS/compare/v4.1.0...v4.1.1) (2023-10-27)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-# [4.1.0](https://github.com/RSamaium/RPG-JS/compare/v4.0.5...v4.1.0) (2023-10-20)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-## 4.0.5 (2023-10-18)
-
-
-### Bug Fixes
-
-* flickering motion of an event as it moves ([b2b8832](https://github.com/RSamaium/RPG-JS/commit/b2b8832a1582933afb64c698f40d1b0e72021780))
-
-
-
-
-
-## 4.0.4 (2023-10-13)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-## 4.0.3 (2023-10-10)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-## 4.0.2 (2023-10-03)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-## 4.0.1 (2023-10-03)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-# 4.0.0-rc.13 (2023-09-09)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-# 4.0.0-rc.12 (2023-09-08)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-# 4.0.0-rc.11 (2023-08-30)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-# 4.0.0-rc.10 (2023-08-28)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-# 4.0.0-rc.9 (2023-08-25)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-# 4.0.0-rc.8 (2023-08-23)
-
-**Note:** Version bump only for package @rpgjs/server
-
-
-
-
-
-# [4.0.0-rc.5](https://github.com/RSamaium/RPG-JS/compare/v4.0.0-rc.4...v4.0.0-rc.5) (2023-08-16)
-
-**Note:** Version bump only for package @rpgjs/server

package/LICENSE

@@ -1,19 +0,0 @@
-Copyright (C) 2020 by Samuel Ronce
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

package/browser/manifest.json

@@ -1,7 +0,0 @@
-{
-  "src/index.ts": {
-    "file": "rpg.server.umd.cjs",
-    "isEntry": true,
-    "src": "src/index.ts"
-  }
-}