omegga 1.8.0 → 1.9.0

package/dist/omegga/server.js

@@ -4,6 +4,7 @@ const logger = require("../logger.js");
 const softconfig = require("../softconfig.js");
 const version = require("../version.js");
 const index$2 = require("../util/index.js");
+const brdb = require("../util/brdb.js");
 const file = require("../util/file.js");
 const index = require("../webserver/backend/index.js");
 const brs = require("brs-js");
@@ -17,6 +18,26 @@ const index$1 = require("./matchers/index.js");
 const plugin = require("./plugin.js");
 const wrapper = require("./wrapper.js");
 const MISSING_CMD = '"Command not found. Type <color=\\"ffff00\\">/help</> for a list of commands or <color=\\"ffff00\\">/plugins</> for plugin information."';
+const WHOLE_WORLD_EXTENT = 1e9;
+function brsRemoved(version2) {
+  return version2 > 0 && version2 >= commands.PREFAB_VERSION;
+}
+function warnRemoved(version2, method, since, release, replacement) {
+  if (!(version2 > 0 && version2 >= since)) return false;
+  logger.default.warnp(
+    `omegga.${method}() uses a console command removed in Brickadia ${release}. This call has no effect - use ${replacement} instead.`
+  );
+  return true;
+}
+function writeTempPrefab(omegga, saveData) {
+  const ref = omegga._tempSavePrefix + Date.now() + "_" + omegga._tempCounter.save++;
+  const file$1 = path.join(omegga.prefabPath, ref + ".brz");
+  if (!file$1.startsWith(omegga.prefabPath))
+    throw "prefab file not in Saved/Prefabs directory";
+  file.mkdir(omegga.prefabPath);
+  fs.writeFileSync(file$1, new Uint8Array(brs.writeBrzLegacy(saveData)));
+  return { ref, file: file$1 };
+}
 class Omegga extends wrapper.default {
   /**
    * Omegga instance
@@ -53,6 +74,7 @@ class Omegga extends wrapper.default {
     const savedDir = cfg.server.savedDir ?? softconfig.CONFIG_SAVED_DIR;
     this.savePath = path.join(this.path, softconfig.DATA_PATH, savedDir, "Builds");
     this.worldPath = path.join(this.path, softconfig.DATA_PATH, savedDir, "Worlds");
+    this.prefabPath = path.join(this.path, softconfig.DATA_PATH, savedDir, "Prefabs");
     this.presetPath = path.join(this.path, softconfig.DATA_PATH, savedDir, "Presets");
     this.configPath = path.join(this.path, softconfig.DATA_PATH, savedDir, "Server");
     logger.default.verbose("Creating directories");
@@ -455,22 +477,49 @@ class Omegga extends wrapper.default {
   }
   clearRegion(region, options) {
     let target = "";
-    if (options && typeof options.target === "object")
-      target = " " + options.target.id;
-    if (typeof target === "string" && !index$2.uuid.match(target)) {
-      const player = this.getPlayer(target);
-      if (player) target = " " + player.id;
+    const rawTarget = options?.target;
+    if (rawTarget) {
+      if (typeof rawTarget === "object") target = rawTarget.id;
+      else if (index$2.uuid.match(rawTarget)) target = rawTarget;
+      else target = this.getPlayer(rawTarget)?.id ?? "";
+    }
+    const center = region.center.join(" ");
+    const extent = region.extent.join(" ");
+    if (brsRemoved(this.version)) {
+      const bricks = options?.bricks ?? true ? 1 : 0;
+      const entities = options?.entities ?? false ? 1 : 0;
+      this.writeln(
+        `${this.Console.World.ClearRegion} ${center} ${extent} ${bricks} ${entities}${target ? " " + target : ""}`
+      );
+      return;
     }
     this.writeln(
-      `${this.Console.Bricks.ClearRegion} ${region.center.join(" ")} ${region.extent.join(
-        " "
-      )}${target}`
+      `${this.Console.Bricks.ClearRegion} ${center} ${extent}${target ? " " + target : ""}`
     );
   }
-  clearAllBricks(quiet = false) {
+  clearAllBricks(options = {}) {
+    const {
+      quiet = false,
+      bricks = true,
+      entities = false
+    } = typeof options === "boolean" ? { quiet: options } : options;
+    if (brsRemoved(this.version)) {
+      this.writeln(
+        `${this.Console.World.ClearAll} ${bricks ? 1 : 0} ${entities ? 1 : 0} ${quiet ? 1 : 0}`
+      );
+      return;
+    }
     this.writeln(`${this.Console.Bricks.ClearAll} ${quiet ? 1 : ""}`);
   }
   saveBricks(saveName, region) {
+    if (warnRemoved(
+      this.version,
+      "saveBricks",
+      commands.PREFAB_VERSION,
+      "EA3",
+      "savePrefab"
+    ))
+      return;
     if (!saveName) return;
     if (!(saveName.startsWith('"') && saveName.endsWith('"')))
       saveName = `"${saveName}"`;
@@ -483,6 +532,14 @@ class Omegga extends wrapper.default {
     else this.writeln(`${this.Console.Bricks.Save} ${saveName}`);
   }
   async saveBricksAsync(saveName, region) {
+    if (warnRemoved(
+      this.version,
+      "saveBricksAsync",
+      commands.PREFAB_VERSION,
+      "EA3",
+      "savePrefabAsync"
+    ))
+      return;
     if (!saveName) return;
     let saveNameClean = saveName;
     if (!(saveName.startsWith('"') && saveName.endsWith('"')))
@@ -509,6 +566,14 @@ class Omegga extends wrapper.default {
     correctPalette = false,
     correctCustom = false
   } = {}) {
+    if (warnRemoved(
+      this.version,
+      "loadBricks",
+      commands.PREFAB_VERSION,
+      "EA3",
+      "loadPrefab"
+    ))
+      return;
     if (!(saveName.startsWith('"') && saveName.endsWith('"')))
       saveName = `"${saveName}"`;
     this.writeln(
@@ -522,6 +587,14 @@ class Omegga extends wrapper.default {
     correctPalette = false,
     correctCustom = false
   } = {}) {
+    if (warnRemoved(
+      this.version,
+      "loadBricksOnPlayer",
+      commands.EA2_VERSION,
+      "EA2",
+      "loadPrefabOnPlayer"
+    ))
+      return;
     player = typeof player === "string" ? this.getPlayer(player) : player;
     if (!player) return;
     if (!(saveName.startsWith('"') && saveName.endsWith('"')))
@@ -536,6 +609,9 @@ class Omegga extends wrapper.default {
   getWorlds() {
     return fs.existsSync(this.worldPath) ? glob.sync(this.worldPath + "/**/*.brdb") : [];
   }
+  getPrefabs() {
+    return fs.existsSync(this.prefabPath) ? glob.sync(this.prefabPath + "/**/*.brz") : [];
+  }
   getSavePath(saveName) {
     const file2 = path.join(
       this.savePath,
@@ -551,42 +627,12 @@ class Omegga extends wrapper.default {
     return fs.existsSync(file2) ? file2 : void 0;
   }
   async getWorldRevisions(worldName) {
-    if (!this.started || this.starting || this.stopping) {
-      throw new Error("Server is not started");
-    }
     worldName = worldName.replace(/\.brdb$/i, "");
-    if (!worldName || !this.getWorldPath(worldName)) {
+    const path2 = this.getWorldPath(worldName);
+    if (!worldName || !path2) {
       throw new Error(`World "${worldName}" does not exist`);
     }
-    let numRevisions = 0;
-    const revisionsRaw = await this.watchLogChunk(
-      `${this.Console.World.ListRevisions} "${worldName}"`,
-      /^LogBRBundleManager: (There are (?<numRevisions>\d+) revisions|Revision (?<revision>\d+) - (?<date>[\d.-]+): (?<note>.+))$/,
-      {
-        last: (match) => Number(match.groups.reverse) === numRevisions,
-        first: (match) => {
-          if (match.groups?.numRevisions !== void 0) {
-            numRevisions = Number(match.groups.numRevisions);
-            return true;
-          }
-          return false;
-        }
-      }
-    );
-    if (!revisionsRaw) return [];
-    return revisionsRaw.map((match) => {
-      if (match.groups?.numRevisions !== void 0) {
-        return null;
-      }
-      const revision = match.groups.revision ? Number(match.groups.revision) : 0;
-      const dateStr = match.groups.date.replace(
-        /(\d{4})\.(\d{2})\.(\d{2})-(\d{2})\.(\d{2})\.(\d{2})/,
-        "$1-$2-$3T$4:$5:$6Z"
-      );
-      const date = new Date(dateStr);
-      const note = match.groups.note || "";
-      return { index: revision, date, note };
-    }).filter(Boolean);
+    return brdb.readBrdbRevisions(path2) ?? [];
   }
   async loadWorld(worldName) {
     worldName = worldName.replace(/\.brdb$/i, "");
@@ -733,6 +779,14 @@ class Omegga extends wrapper.default {
     correctPalette = false,
     correctCustom = false
   } = {}) {
+    if (brsRemoved(this.version)) {
+      const { ref, file: file2 } = writeTempPrefab(this, saveData);
+      this.loadPrefab(ref, { offX, offY, offZ });
+      setTimeout(() => {
+        if (fs.existsSync(file2)) fs.unlinkSync(file2);
+      }, 5e3);
+      return;
+    }
     const saveFile = this._tempSavePrefix + Date.now() + "_" + this._tempCounter.save++;
     this.writeSaveData(saveFile, saveData);
     await this.watchLogChunk(
@@ -759,6 +813,22 @@ class Omegga extends wrapper.default {
   } = {}) {
     player = typeof player === "string" ? this.getPlayer(player) : player;
     if (!player) return;
+    if (brsRemoved(this.version)) {
+      const { ref, file: file2 } = writeTempPrefab(this, saveData);
+      this.givePrefabToPlayer(ref, player);
+      setTimeout(() => {
+        if (fs.existsSync(file2)) fs.unlinkSync(file2);
+      }, 5e3);
+      return;
+    }
+    if (warnRemoved(
+      this.version,
+      "loadSaveDataOnPlayer",
+      commands.EA2_VERSION,
+      "EA2",
+      "loadPrefabOnPlayer"
+    ))
+      return;
     const saveFile = this._tempSavePrefix + Date.now() + "_" + this._tempCounter.save++;
     this.writeSaveData(saveFile, saveData);
     await this.watchLogChunk(
@@ -777,6 +847,54 @@ class Omegga extends wrapper.default {
     }
   }
   async getSaveData(region) {
+    if (brsRemoved(this.version)) {
+      const ref = this._tempSavePrefix + Date.now() + "_" + this._tempCounter.save++;
+      const file2 = await this.savePrefabAsync(ref, { region });
+      if (!file2) return void 0;
+      try {
+        const MAIN_GRID = 1;
+        const reader = brs.WorldReader.from(new Uint8Array(fs.readFileSync(file2)));
+        const bricks = [...reader.bricks(MAIN_GRID)].map((b) => ({
+          ...b,
+          physical_index: 0,
+          components: {}
+        }));
+        let brickOffset = 0;
+        for (const chunk of reader.brickChunkIndex(MAIN_GRID)) {
+          if (chunk.numComponents > 0) {
+            const { components } = reader.componentChunk(
+              MAIN_GRID,
+              chunk.index
+            );
+            for (const c of components) {
+              const brick = bricks[brickOffset + c.brickIndex];
+              if (brick) brick.components[c.typeName] = c.data ?? {};
+            }
+          }
+          brickOffset += chunk.numBricks;
+        }
+        return {
+          version: 10,
+          map: this.currentMap ?? "Unknown",
+          author: { id: this.host?.id ?? "", name: this.host?.name ?? "" },
+          host: { id: this.host?.id ?? "", name: this.host?.name ?? "" },
+          description: "",
+          brick_count: bricks.length,
+          mods: [],
+          brick_assets: reader.brickAssets(),
+          colors: [],
+          materials: reader.materials(),
+          physical_materials: [],
+          brick_owners: reader.brickOwners(),
+          game_version: this.version,
+          save_time: new Uint8Array(),
+          bricks,
+          components: {}
+        };
+      } finally {
+        if (fs.existsSync(file2)) fs.unlinkSync(file2);
+      }
+    }
     const saveFile = this._tempSavePrefix + Date.now() + "_" + this._tempCounter.save++;
     await this.saveBricksAsync(saveFile, region);
     const savePath = this.getSavePath(saveFile);
@@ -787,6 +905,93 @@ class Omegga extends wrapper.default {
     }
     return void 0;
   }
+  /**
+   * Load a prefab into the world (EA3). `path` is a bundle
+   * path ref such as `Prefabs/Uploads/<hash>.brz`.
+   * br.Prefab.Load <Path> [Offset X Y Z] [At Original Position] [Orientation]
+   *   [Root Entity Persistent Index] [Mirror Axes] [Override User Id]
+   */
+  loadPrefab(path2, {
+    offX = 0,
+    offY = 0,
+    offZ = 0,
+    atOriginalPosition = false,
+    orientation = 0,
+    rootEntityPersistentIndex = -1,
+    mirrorAxes = 0,
+    overrideUserId = ""
+  } = {}) {
+    if (!path2) return;
+    const rootPart = rootEntityPersistentIndex >= 0 ? ` ${rootEntityPersistentIndex} ${mirrorAxes}${overrideUserId ? ` "${overrideUserId}"` : ""}` : "";
+    this.writeln(
+      `${this.Console.Prefab.Load} "${path2}" ${offX} ${offY} ${offZ} ${atOriginalPosition ? 1 : 0} ${orientation}${rootPart}`
+    );
+  }
+  /**
+   * Load a prefab onto a player (EA3). Replaces the
+   * removed {@link loadBricksOnPlayer}; backed by `br.Prefab.GiveToPlayer`.
+   * @param path prefab bundle path ref
+   * @param player player name/id or player object
+   * @param options give options (preserve ownership)
+   */
+  loadPrefabOnPlayer(path2, player, { preserveOwnership = false } = {}) {
+    this.givePrefabToPlayer(path2, player, { preserveOwnership });
+  }
+  /**
+   * Save the world (or a region of it) as a prefab (EA3).
+   * `path` is the destination bundle path ref (e.g. `Prefabs/MyPrefab.brz`).
+   * br.Prefab.SaveRegion <Path> <Center X Y Z> <Extent X Y Z> [Include Entities]
+   *   [Root Entity Persistent Index] [Filter User Id]
+   * @param path destination prefab bundle path ref
+   * @param options save options; omit `region` to capture the whole world
+   */
+  savePrefab(path2, {
+    region,
+    entities = true,
+    rootEntityPersistentIndex = -1,
+    userId = ""
+  } = {}) {
+    if (!path2) return;
+    const center = (region?.center ?? [0, 0, 0]).join(" ");
+    const extent = (region?.extent ?? [
+      WHOLE_WORLD_EXTENT,
+      WHOLE_WORLD_EXTENT,
+      WHOLE_WORLD_EXTENT
+    ]).join(" ");
+    this.writeln(
+      `${this.Console.Prefab.SaveRegion} "${path2}" ${center} ${extent} ${entities ? 1 : 0} ${rootEntityPersistentIndex}${userId ? ` "${userId}"` : ""}`
+    );
+  }
+  /**
+   * Save a prefab and resolve once the prefab file has been written to disk.
+   * @param path destination prefab bundle path ref
+   * @param options same options as {@link savePrefab}
+   * @returns the absolute path to the written prefab, or null on timeout
+   */
+  async savePrefabAsync(path$1, options) {
+    if (!path$1) return null;
+    this.savePrefab(path$1, options);
+    const name = path$1.replace(/^Prefabs[\\/]/i, "").replace(/\.brz$/i, "");
+    const file2 = path.join(this.prefabPath, name + ".brz");
+    const deadline = Date.now() + 3e4;
+    while (Date.now() < deadline) {
+      if (fs.existsSync(file2)) return file2;
+      await new Promise((resolve) => setTimeout(resolve, 100));
+    }
+    return null;
+  }
+  /**
+   * Give a prefab to a player's inventory (EA3).
+   * br.Prefab.GiveToPlayer <Path> <Player Name or User Id> [Preserve Ownership]
+   */
+  givePrefabToPlayer(path2, player, { preserveOwnership = false } = {}) {
+    if (!path2) return;
+    const target = typeof player === "object" ? player.id : player;
+    if (!target) return;
+    this.writeln(
+      `${this.Console.Prefab.GiveToPlayer} "${path2}" "${target}" ${preserveOwnership ? 1 : 0}`
+    );
+  }
   // TODO: switch this to use worlds...
   async changeMap(map) {
     if (!map) return;