omegga 1.2.9 → 1.4.0

package/README.md

@@ -514,13 +514,32 @@ This is an example `plugin.json`, located inside a plugin folder. The plugin fil
 {
   "formatVersion": 1,
   "omeggaVersion": ">=0.1.32",
-  "emitConfig": "config.json"
+  "emitConfig": "config.json",
+  "dependencies": {
+    "otherPlugin": "https://github.com/owner/repo",
+    "requiredPlugin": { "optional": false },
+    "optionalPlugin": { "optional": true, "repo": "https://github.com/owner/repo" }
+  },
+  "loadPriority": 0,
+  "loadBefore": ["pluginToLoadAfterThis"],
+  "loadAfter": ["pluginToLoadBeforeThis"]
 }
 ```
 
 - `formatVersion` - indicates the plugin file format version
 - `omeggaVersion` - indicates compatible omegga versions ([semver cheatsheet](https://www.npmjs.com/package/semver#user-content-ranges))
 - `emitConfig` - optional, a path to a json file where plugin config will be saved to before the plugin starts.
+- `dependencies` - optional, declares dependencies on other plugins
+  - Can be a string specifying the GitHub repository URL (e.g., `"otherPlugin": "https://github.com/owner/repo"`)
+  - Can be an object with optional properties:
+    - `optional` - if `true`, the plugin will load even if this dependency is missing
+    - `repo` - GitHub repository URL where the dependency can be found (e.g., `"https://github.com/owner/repo"`)
+  - Dependencies are automatically loaded before the dependent plugin
+- `loadPriority` - optional, numeric priority for load order (lower/negative numbers load earlier, higher/positive numbers load later, undefined loads in the middle)
+- `loadBefore` - optional, array of plugin names that should load after this plugin
+- `loadAfter` - optional, array of plugin names that should load before this plugin
+
+**Note:** Omegga will automatically resolve the correct load order based on dependencies, `loadPriority`, `loadBefore`, and `loadAfter` constraints. If there's a cyclic dependency or conflicting constraints, plugins may fail to load.
 
 ## Plugin Store
 
@@ -802,16 +821,32 @@ Register custom `/commands` by returning `{registeredCommands: ['foo', 'bar']}`
 | `loadSaveDataOnPlayer`         | {data: object, player: string, offX, offY, offY}     | Builds brs file from data, loads the file onto a player's clipboard |                                                                 |
 | `changeMap`                    | map (string)                                         | Change map to specified map name, returns success                   | Boolean                                                         |
 | `player.get`                   | target (string)                                      | Gets the player by their name or UUID.                              | `{name, id, controller, state, host: bool}`                     |
-| `player.getRoles`              | target (string)                                      | Target's roles                                                      |                                                                 |
-| `player.getPermissions`        | target (string)                                      | Target's permissions                                                | List of Strings                                                 |
-| `player.getNameColor`          | target (string)                                      | Target's name color                                                 | _RGB Hex Object_ (int, int ,int)                                |
-| `player.getPosition`           | target (string)                                      | Target's position                                                   | _Position Object_                                               |
-| `player.getGhostBrick`         | target (string)                                      | Target's ghost brick                                                | {targetGrid, location(_Location_), orientation}                 |
-| `player.getPaint`              | target (string)                                      | Target's current paint selection                                    | {materialIndex, materialAlpha, material, color)}                |
-| `player.getTemplateBounds`     | target (string)                                      | Target's template/selection bounds                                  | {minBound, maxBound, Center}                                    |
-| `player.getTemplateBoundsData` | target (string)                                      | Target's template/selection as brs-js save data                     | _Brick Object_                                                  |
-| `player.loadSaveData`          | {target, data, offX, offY, offZ}                     | Loads brs-js save data to the targets clipboard                     |                                                                 |
-| `player.loadDataAtGhostBrick`  | {target, data, rotate=true, offX, offY, offZ, quiet} | Loads brs-js save data at the target's selection bounds             |                                                                 |
+| `player.getRoles`              | target (string)                                      | Target's roles                                                      | List of Strings                                                 |
+| `player.getPermissions`        | target (string)                                      | Target's permissions                                                | Record<string, boolean>                                         |
+| `player.getNameColor`          | target (string)                                      | Target's name color                                                 | _RGB Hex String_                                                |
+| `player.getPosition`           | target (string)                                      | Target's position                                                   | [number, number, number] or null                                |
+| `player.getPawn`               | target (string)                                      | Target's pawn name                                                  | string or null                                                  |
+| `player.getGhostBrick`         | target (string)                                      | Target's ghost brick                                                | {targetGrid, location, orientation}                             |
+| `player.getPaint`              | target (string)                                      | Target's current paint selection                                    | {materialIndex, materialAlpha, material, color}                 |
+| `player.isCrouched`            | target (string)                                      | Check if target is crouched                                         | boolean                                                         |
+| `player.isDead`                | target (string)                                      | Check if target is dead                                             | boolean                                                         |
+| `player.getTemplateBounds`     | target (string)                                      | Target's template/selection bounds                                  | {minBound, maxBound, center}                                    |
+| `player.getTemplateBoundsData` | target (string)                                      | Target's template/selection as brs-js save data                     | _BRS Object_                                                    |
+| `player.clearBricks`           | {target, quiet}                                      | Clears target's bricks                                              |                                                                 |
+| `player.loadBricks`            | {target, saveName}                                   | Loads save file to target's clipboard                               |                                                                 |
+| `player.loadSaveData`          | {target, data, offX, offY, offZ}                     | Loads brs-js save data to target's clipboard                        |                                                                 |
+| `player.loadDataAtGhostBrick`  | {target, data, rotate=true, offX, offY, offZ, quiet} | Loads brs-js save data at target's selection bounds                 |                                                                 |
+| `player.kill`                  | target (string)                                      | Kills the target player                                             |                                                                 |
+| `player.damage`                | {target, amount}                                     | Damages target by amount                                            |                                                                 |
+| `player.heal`                  | {target, amount}                                     | Heals target by amount                                              |                                                                 |
+| `player.giveItem`              | {target, item}                                       | Gives target an item                                                |                                                                 |
+| `player.takeItem`              | {target, item}                                       | Removes item from target                                            |                                                                 |
+| `player.setTeam`               | {target, teamIndex}                                  | Sets target's team                                                  |                                                                 |
+| `player.setMinigame`           | {target, index}                                      | Adds target to minigame at index                                    |                                                                 |
+| `player.setScore`              | {target, minigameIndex, score}                       | Sets target's score in minigame                                     |                                                                 |
+| `player.getScore`              | target (string)                                      | Gets target's score in minigame                                     | number                                                          |
+| `player.setLeaderboard`        | {target, key, value}                                 | Sets leaderboard value for target                                   |                                                                 |
+| `player.getLeaderboard`        | target (string)                                      | Gets leaderboard value for target                                   | number or null                                                  |
 | `plugin.get`                   | target (string)                                      | Gets info on the target plugin                                      | Object                                                          |
 | `plugin.emit`                  | [target (string), event (string), ...args (any)]     | Emit a custom event to the target plugin                            |                                                                 |
 
@@ -995,6 +1030,8 @@ rpc.addMethod('stop', async () => 'ok');
 
 ## Environment Variables
 
+These can be set in your shell or in a `.env` file the same directory as a `omegga-config.yml` file.
+
 `omegga` accepts the following environment variables:
 
 - `BRICKADIA_TOKEN` - Specify hosting token instead of using config
@@ -1005,6 +1042,8 @@ rpc.addMethod('stop', async () => 'ok');
 - `BRICKADIA_DIR` - Override the need to use steamcmd and point to a Brickadia install directory (eg. `/home/<USER>/.config/omegga/steam_installs/main/Brickadia`)
 - `STEAM_INSTALLS_DIR` - Set where omegga installs brickadia via steamcmd (default `~/.config/omegga/steam_installs`)
 - `STEAM_APP_ID` - Set the Steam App ID for Brickadia (default `3017590`)
+- `STEAM_USERNAME` - Set the Steam username for downloading Brickadia via steamcmd
+- `STEAM_PASSWORD` - Set the Steam password for downloading Brickadia via steamcmd
 - `VERBOSE` - Set to `true` to enable verbose logging (default `false`)
 - `PACKAGE_NOTIFIER` - When set to `false`, disables the npm update notifier
 - `STEAM_NOTIFIER` - When set to `false`, disables the SteamCMD update notifier

package/dist/brickadia/config.js

@@ -1,96 +1,32 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.write = write;
-exports.read = read;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const file = __importStar(require("../util/file"));
-const softconfig_1 = require("../softconfig");
-const CONFIG_PATH = 'Config/LinuxServer';
-const SERVER_SETTINGS = 'GameUserSettings.ini';
-// Function that writes config
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const fs = require("node:fs");
+const path = require("node:path");
+const file = require("../util/file.js");
+const softconfig = require("../softconfig.js");
+const CONFIG_PATH = "Config/LinuxServer";
+const SERVER_SETTINGS = "GameUserSettings.ini";
 function write(serverPath, config) {
-    var _a, _b, _c;
-    const configPath = path_1.default.join(serverPath, (_a = config.server.savedDir) !== null && _a !== void 0 ? _a : softconfig_1.CONFIG_SAVED_DIR, CONFIG_PATH);
-    const settingsPath = path_1.default.join(configPath, SERVER_SETTINGS);
-    file.mkdir(configPath);
-    fs_1.default.writeFileSync(settingsPath, `[Server__BP_ServerSettings_General_C BP_ServerSettings_General_C]
-ServerName=${config.server.name || ''}
-ServerDescription=${config.server.description || ''}
-ServerPassword=${config.server.password || ''}
+  const configPath = path.join(
+    serverPath,
+    config.server.savedDir ?? softconfig.CONFIG_SAVED_DIR,
+    CONFIG_PATH
+  );
+  const settingsPath = path.join(configPath, SERVER_SETTINGS);
+  file.mkdir(configPath);
+  fs.writeFileSync(
+    settingsPath,
+    `[Server__BP_ServerSettings_General_C BP_ServerSettings_General_C]
+ServerName=${config.server.name || ""}
+ServerDescription=${config.server.description || ""}
+ServerPassword=${config.server.password || ""}
 MaxPlayers=${config.server.players || 20}
-bPubliclyListed=${((_b = config.server.publiclyListed) !== null && _b !== void 0 ? _b : true) ? 'True' : 'False'}
-WelcomeMessage="${((_c = config.server.welcomeMessage) === null || _c === void 0 ? void 0 : _c.replace(/"/g, '\"').replace(/\\/g, '\\\\')) || ''}"`);
-    /*
-  [Server__BP_ServerSettings_General_C BP_ServerSettings_General_C]
-  ServerTypeIndex2=1
-  ServerName=
-  ServerDescription=
-  ServerPassword=
-  MaxPlayers=30
-  bPubliclyListed=True
-  WelcomeMessage="<color=\"0055ff\">Welcome to <b>{2}</>, {1}.</><>a"
-  bGlobalRulesetSelfDamage=True
-  bGlobalRulesetPhysicsDamage=False
-  bGlobalRulesetEnableCameraBlockedEffects=False
-  UploadTimeout=5.000000
-  MaxPrefabBricks=1000
-  MaxPrefabComponents=20
-  MaxPrefabSize=(X=1000,Y=1000,Z=1000)
-  MaxPhysicsObjects=2000
-  MaxPhysicsObjectsPerUser=50
-  MaxPlacementBricks=2000
-  MaxPlacementEntities=10
-  bEnforceApplicatorLimits=False
-  TemplatePlacementTimeout=2.000000
-  MaxSelectionBoxSize=(X=1000,Y=1000,Z=1000)
-  MaxSelectedBricks=1000
-  SelectionTimeout=2.000000
-  
-  [Server__BP_ServerSettingsAutoSave_C BP_ServerSettingsAutoSave_C]
-  bEnableAutoSave=True
-  bAnnounceAutoSave=True
-  AutoSaveInterval=300.000000
-  bIncludeScreenshot=False
-    */
+bPubliclyListed=${config.server.publiclyListed ?? true ? "True" : "False"}
+WelcomeMessage="${config.server.welcomeMessage?.replace(/"/g, '"').replace(/\\/g, "\\\\") || ""}"`
+  );
 }
 function read() {
-    // TODO: Implement server config reading
 }
-//# sourceMappingURL=config.js.map
+exports.read = read;
+exports.write = write;
+//# sourceMappingURL=config.js.map

package/dist/brickadia/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/brickadia/config.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAWA,sBAqDC;AAED,oBAEC;AAnED,4CAAoB;AACpB,gDAAwB;AAExB,mDAAqC;AAErC,8CAAgD;AAChD,MAAM,WAAW,GAAG,oBAAoB,CAAC;AACzC,MAAM,eAAe,GAAG,sBAAsB,CAAC;AAE/C,8BAA8B;AAC9B,SAAgB,KAAK,CAAC,UAAkB,EAAE,MAAe;;IACvD,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAC1B,UAAU,EACV,MAAA,MAAM,CAAC,MAAM,CAAC,QAAQ,mCAAI,6BAAgB,EAC1C,WAAW,CACZ,CAAC;IACF,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;IAE5D,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAEvB,YAAE,CAAC,aAAa,CACd,YAAY,EACZ;aACS,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE;oBACjB,MAAM,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE;iBAClC,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE;aAChC,MAAM,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE;kBACtB,CAAC,MAAA,MAAM,CAAC,MAAM,CAAC,cAAc,mCAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;kBACzD,CAAA,MAAA,MAAM,CAAC,MAAM,CAAC,cAAc,0CAAE,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,KAAI,EAAE,GAAG,CAChG,CAAC;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA+BE;AACJ,CAAC;AAED,SAAgB,IAAI;IAClB,wCAAwC;AAC1C,CAAC"}
+{"version":3,"file":"config.js","sources":["../../src/brickadia/config.ts"],"sourcesContent":["import { IConfig } from '@config/types';\nimport fs from 'node:fs';\nimport path from 'node:path';\n\nimport * as file from '../util/file';\n\nimport { CONFIG_SAVED_DIR } from '@/softconfig';\nconst CONFIG_PATH = 'Config/LinuxServer';\nconst SERVER_SETTINGS = 'GameUserSettings.ini';\n\n// Function that writes config\nexport function write(serverPath: string, config: IConfig) {\n  const configPath = path.join(\n    serverPath,\n    config.server.savedDir ?? CONFIG_SAVED_DIR,\n    CONFIG_PATH,\n  );\n  const settingsPath = path.join(configPath, SERVER_SETTINGS);\n\n  file.mkdir(configPath);\n\n  fs.writeFileSync(\n    settingsPath,\n    `[Server__BP_ServerSettings_General_C BP_ServerSettings_General_C]\nServerName=${config.server.name || ''}\nServerDescription=${config.server.description || ''}\nServerPassword=${config.server.password || ''}\nMaxPlayers=${config.server.players || 20}\nbPubliclyListed=${(config.server.publiclyListed ?? true) ? 'True' : 'False'}\nWelcomeMessage=\"${config.server.welcomeMessage?.replace(/\"/g, '\\\"').replace(/\\\\/g, '\\\\\\\\') || ''}\"`,\n  );\n\n  /*\n[Server__BP_ServerSettings_General_C BP_ServerSettings_General_C]\nServerTypeIndex2=1\nServerName=\nServerDescription=\nServerPassword=\nMaxPlayers=30\nbPubliclyListed=True\nWelcomeMessage=\"<color=\\\"0055ff\\\">Welcome to <b>{2}</>, {1}.</><>a\"\nbGlobalRulesetSelfDamage=True\nbGlobalRulesetPhysicsDamage=False\nbGlobalRulesetEnableCameraBlockedEffects=False\nUploadTimeout=5.000000\nMaxPrefabBricks=1000\nMaxPrefabComponents=20\nMaxPrefabSize=(X=1000,Y=1000,Z=1000)\nMaxPhysicsObjects=2000\nMaxPhysicsObjectsPerUser=50\nMaxPlacementBricks=2000\nMaxPlacementEntities=10\nbEnforceApplicatorLimits=False\nTemplatePlacementTimeout=2.000000\nMaxSelectionBoxSize=(X=1000,Y=1000,Z=1000)\nMaxSelectedBricks=1000\nSelectionTimeout=2.000000\n\n[Server__BP_ServerSettingsAutoSave_C BP_ServerSettingsAutoSave_C]\nbEnableAutoSave=True\nbAnnounceAutoSave=True\nAutoSaveInterval=300.000000\nbIncludeScreenshot=False\n  */\n}\n\nexport function read() {\n  // TODO: Implement server config reading\n}\n"],"names":["CONFIG_SAVED_DIR","file.mkdir"],"mappings":";;;;;;AAOA,MAAM,cAAc;AACpB,MAAM,kBAAkB;AAGjB,SAAS,MAAM,YAAoB,QAAiB;AACzD,QAAM,aAAa,KAAK;AAAA,IACtB;AAAA,IACA,OAAO,OAAO,YAAYA,WAAAA;AAAAA,IAC1B;AAAA,EAAA;AAEF,QAAM,eAAe,KAAK,KAAK,YAAY,eAAe;AAE1DC,OAAAA,MAAW,UAAU;AAErB,KAAG;AAAA,IACD;AAAA,IACA;AAAA,aACS,OAAO,OAAO,QAAQ,EAAE;AAAA,oBACjB,OAAO,OAAO,eAAe,EAAE;AAAA,iBAClC,OAAO,OAAO,YAAY,EAAE;AAAA,aAChC,OAAO,OAAO,WAAW,EAAE;AAAA,kBACrB,OAAO,OAAO,kBAAkB,OAAQ,SAAS,OAAO;AAAA,kBACzD,OAAO,OAAO,gBAAgB,QAAQ,MAAM,GAAI,EAAE,QAAQ,OAAO,MAAM,KAAK,EAAE;AAAA,EAAA;AAmChG;AAEO,SAAS,OAAO;AAEvB;;;"}