omegga 0.1.85 → 1.0.2

package/templates/safe-ts/omegga.plugin.ts

@@ -0,0 +1,29 @@
+import OmeggaPlugin, { OL, PS, PC } from 'omegga';
+
+type Config = { foo: string };
+type Storage = { bar: string };
+
+export default class Plugin implements OmeggaPlugin<Config, Storage> {
+  omegga: OL;
+  config: PC<Config>;
+  store: PS<Storage>;
+
+  constructor(omegga: OL, config: PC<Config>, store: PS<Storage>) {
+    this.omegga = omegga;
+    this.config = config;
+    this.store = store;
+  }
+
+  async init() {
+    // Write your plugin!
+    this.omegga.on('cmd:test', (speaker: string) => {
+      this.omegga.broadcast(`Hello, ${speaker}!`);
+    });
+
+    return { registeredCommands: ['test'] };
+  }
+
+  async stop() {
+    // Anything that needs to be cleaned up...
+  }
+}

package/templates/safe-ts/plugin.json

@@ -0,0 +1,4 @@
+{
+  "formatVersion": 1,
+  "omeggaVersion": ">={{omeggaVersion}}"
+}

package/templates/safe-ts/setup.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# This script will be run when the plugin is installed...
+[[ -f "package.json" ]] && npm i

package/templates/safe-ts/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "noEmit": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "target": "es2020",
+    "baseUrl": "."
+  }
+}

package/templates/unsafe/README.md

@@ -0,0 +1,29 @@
+<!--
+
+When uploading your plugin to github/gitlab
+start your repo name with "omegga-"
+
+example: https://github.com/{{author}}/omegga-{{shortName}}
+
+Your plugin will be installed via omegga install gh:{{author}}/{{shortName}}
+
+-->
+
+# {{name}}
+
+An unsafe plugin for [omegga](https://github.com/brickadia-community/omegga).
+
+This is an auto-generated README file. Please change it before publishing your plugin!
+
+Be sure to edit the script in `setup.sh` to configure your plugin on install, or
+remove it entirely if it is unnecessary.
+
+## Install
+
+`omegga install gh:{{author}}/{{shortName}}`
+
+_TODO: more steps...?_
+
+## Usage
+
+_TODO: include some usage information_

package/templates/unsafe/doc.json

@@ -0,0 +1,7 @@
+{
+  "name": "{{shortName}}",
+  "description": "A safe Omegga plugin.",
+  "author": "{{author}}",
+  "config": {},
+  "commands": []
+}

package/templates/unsafe/omegga.main.js

@@ -0,0 +1,15 @@
+module.exports = class Plugin {
+  constructor(omegga, config, store) {
+    this.omegga = omegga;
+    this.config = config;
+    this.store = store;
+  }
+
+  async init() {
+    // Write your plugin!
+  }
+
+  async stop() {
+    // Anything that needs to be cleaned up...
+  }
+}

package/templates/unsafe/plugin.json

@@ -0,0 +1,4 @@
+{
+  "formatVersion": 1,
+  "omeggaVersion": ">={{omeggaVersion}}"
+}

package/templates/unsafe/setup.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# This script will be run when the plugin is installed...
+[[ -f "package.json" ]] && npm i

package/.babelrc.json

@@ -1,5 +0,0 @@
-{
-  "plugins": [
-    "@babel/plugin-proposal-class-properties"
-  ]
-}

package/.github/workflows/lint.yml

@@ -1,26 +0,0 @@
-name: Lint
-
-on: push
-
-jobs:
-  run-linters:
-    name: Run linters
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Check out Git repository
-        uses: actions/checkout@v2
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 12
-
-      - name: Install Node.js dependencies
-        run: npm install
-
-      - name: Run linters
-        uses: wearerequired/lint-action@v1
-        with:
-          github_token: ${{ secrets.github_token }}
-          prettier: true

package/.prettierrc

@@ -1,7 +0,0 @@
-{
-  "singleQuote": true,
-  "semi": true,
-  "arrowParens": "avoid",
-  "endOfLine": "lf",
-  "printWidth": 80
-}

package/.vscode/extensions.json

@@ -1,5 +0,0 @@
-{
-  "recommendations": [
-    "rvest.vs-code-prettier-eslint"
-  ]
-}

package/src/OMEGGA_LEGACY_INSTALL

@@ -1,44 +0,0 @@
-#!/usr/bin/env bash
-
-# THIS FILE ONLY EXISTS FOR USERS WHO DO NOT HAVE ACCESS TO THE BRICKADIA LAUNCHER
-# IT WILL BE DEPRECATED ONCE A5 COMES OUT
-
-TAR_FILE=Brickadia_Alpha4_Patch1_CL3642_Linux.tar.xz
-BRICKADIA_URL=https://static.brickadia.com/builds/CL3642/$TAR_FILE
-LEGACY_PATH=$HOME/.config/omegga/Legacy
-FILE=$LEGACY_PATH/$TAR_FILE
-BINARY_PATH=$LEGACY_PATH/Brickadia/Binaries/Linux/BrickadiaServer-Linux-Shipping
-FILEZ=$FILE.xz
-
-if ! [[ $(which tar) && $(which wget) ]]; then
-  echo ">! Missing dependencies, please run:" >&2
-  echo "  apt-get install wget tar" >&2
-  echo
-  exit 0
-fi;
-
-if ! [[ $(which omegga) ]]; then
-  echo ">! how on earth are you running this without omegga" >&2
-  exit 1
-fi;
-
-if [[ -f $BINARY_PATH ]]; then
-  echo ">> Legacy binary already installed!"
-  exit 0
-fi
-
-mkdir -p $LEGACY_PATH
-
-if [[ -f $FILE ]]; then
-  echo ">> Legacy tar already downloaded!"
-else
-  echo ">> Downloading Brickadia tar"
-  wget $BRICKADIA_URL -P $LEGACY_PATH
-fi
-
-if [[ -f $BINARY_PATH ]]; then
-  echo ">> Legacy binary already installed?!"
-else
-  echo ">> Extracting Brickadia tar"
-  tar xJf $FILE -C $LEGACY_PATH
-fi

package/src/brickadia/config.js

@@ -1,42 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const file = require('../util/file.js');
-
-const CONFIG_PATH = 'Saved/Config/LinuxServer';
-const SERVER_SETTINGS = '/ServerSettings.ini';
-
-// Function that writes config
-module.exports = {
-  write(serverPath, config) {
-    const configPath = path.join(serverPath, CONFIG_PATH);
-    const settingsPath = path.join(configPath, SERVER_SETTINGS);
-
-    file.mkdir(configPath);
-
-    fs.writeFileSync(
-      settingsPath,
-      `[Server__BP_ServerSettings_General_C BP_ServerSettings_General_C]
-MaxSelectedBricks=1000
-MaxPlacedBricks=1000
-SelectionTimeout=2.000000
-PlaceTimeout=2.000000
-ServerName=${config.server.name || ''}
-ServerDescription=${config.server.description || ''}
-ServerPassword=${config.server.password || ''}
-MaxPlayers=${config.server.players || 20}
-bPubliclyListed=${
-        typeof config.server.publiclyListed === 'undefined' ||
-        config.server.publiclyListed
-          ? 'True'
-          : 'False'
-      }
-WelcomeMessage="${config.server.welcomeMessage || ''}"
-bGlobalRulesetSelfDamage=True
-bGlobalRulesetPhysicsDamage=False`
-    );
-  },
-  read() {
-    // TODO: Implement server config reading
-  },
-};

package/src/brickadia/server.js

@@ -1,227 +0,0 @@
-/*
-  Brickadia Server Wrapper
-  Manages IO with the game server
-*/
-const { EventEmitter } = require('events');
-const { spawn } = require('child_process');
-const readline = require('readline');
-const path = require('path');
-const stripAnsi = require('strip-ansi');
-require('colors');
-
-const verboseLog = (...args) => {
-  if (!global.VERBOSE) return;
-  if (Omegga.log) Omegga.log('V>'.magenta, ...args);
-  else console.log('V>'.magenta, ...args);
-};
-
-const errorLog = (...args) => {
-  if (Omegga.error) Omegga.error('!>'.red, ...args);
-  else console.error('!>'.red, ...args);
-};
-
-const warnLog = (...args) => {
-  if (Omegga.error) Omegga.warn('W>'.yellow, ...args);
-  else console.warn('W>'.yellow, ...args);
-};
-
-// list of errors that can be solved by yelling at the user
-const knownErrors = [
-  {
-    name: 'MISSING_LIBGL',
-    solution: 'apt-get install libgl1-mesa-glx libglib2.0-0',
-    match:
-      /error while loading shared libraries: libGL\.so\.1: cannot open shared object file/,
-  },
-  {
-    name: 'MISSING_GLIB',
-    solution: 'apt-get install libgl1-mesa-glx libglib2.0-0',
-    match:
-      /error while loading shared libraries: libgthread-2\.0\.so\.0: cannot open shared object file/,
-  },
-];
-
-// Start a brickadia server
-class BrickadiaServer extends EventEmitter {
-  #child = null;
-  #errInterface = null;
-  #outInterface = null;
-
-  constructor(dataPath, config) {
-    super();
-    this.config = config;
-    // use the data path if it's absolute, otherwise build an absolute path
-    this.path =
-      path.isAbsolute(dataPath) || dataPath.startsWith('/')
-        ? dataPath
-        : path.join(process.cwd(), dataPath);
-
-    this.lineListener = this.lineListener.bind(this);
-    this.errorListener = this.errorListener.bind(this);
-    this.exitListener = this.exitListener.bind(this);
-  }
-
-  // start the server child process
-  start() {
-    const { email, password } = this.config.credentials || {};
-    verboseLog(
-      'Starting server',
-      (!email && !password ? 'without' : 'with').yellow,
-      'credentials'
-    );
-    verboseLog(
-      'Running',
-      (this.config.server.__LOCAL
-        ? path.join(__dirname, '../../tools/brickadia.sh')
-        : 'brickadia launcher'
-      ).yellow
-    );
-    if (typeof this.config.server.branch === 'string')
-      verboseLog('Using branch', this.config.server.branch.yellow);
-
-    // handle local launcher support
-    const launchArgs = [
-      this.config.server.__LOCAL
-        ? path.join(__dirname, '../../tools/brickadia.sh')
-        : 'brickadia',
-      this.config.server.branch && `--branch=${this.config.server.branch}`,
-      '--server',
-      '--',
-    ];
-
-    // Either unbuffer or stdbuf must be used because brickadia's output is buffered
-    // this means that multiple lines can be bundled together if the output buffer is not full
-    // unfortunately without stdbuf or unbuffer, the output would not happen immediately
-    this.#child = spawn(
-      'stdbuf',
-      [
-        '--output=L',
-        '--',
-        ...launchArgs,
-        this.config.server.map && `${this.config.server.map}`,
-        '-NotInstalled',
-        '-log',
-        require('../util/wsl') === 1 ? '-OneThread' : null,
-        this.path ? `-UserDir="${this.path}"` : null,
-        email ? `-User="${email}"` : null, // remove email argument if not provided
-        password ? `-Password="${password}"` : null, // remove password argument if not provided
-        `-port="${this.config.server.port}"`,
-      ].filter(Boolean)
-    ); // remove unused arguments
-
-    verboseLog('Spawn process', this.#child ? this.#child.pid : 'failed'.red);
-
-    this.#child.stdin.setEncoding('utf8');
-    this.#outInterface = readline.createInterface({
-      input: this.#child.stdout,
-      terminal: false,
-    });
-    this.#errInterface = readline.createInterface({
-      input: this.#child.stderr,
-      terminal: false,
-    });
-    this.attachListeners();
-    verboseLog('Attached listeners');
-  }
-
-  // write a string to the child process
-  write(line) {
-    if (line.length >= 512) {
-      // show a warning
-      warnLog(
-        'WARNING'.yellow,
-        'The following line was called and is',
-        'longer than allowed limit'.red
-      );
-      warnLog(line.replace(/\n$/, ''));
-      // throw a fake error to get the line number
-      try {
-        throw new Error('Console Line Too Long');
-      } catch (err) {
-        warnLog(err);
-      }
-      return;
-    }
-    if (this.#child) {
-      verboseLog('WRITE'.green, line.replace(/\n$/, ''));
-      this.#child.stdin.write(line);
-    }
-  }
-
-  // write a line to the child process
-  writeln(line) {
-    this.write(line + '\n');
-  }
-
-  // forcibly kills the server
-  stop() {
-    if (!this.#child) {
-      verboseLog('Cannot stop server as no subprocess exists');
-      return;
-    }
-
-    verboseLog('Forcibly stopping server');
-    // kill the process
-    this.#child.kill('SIGINT');
-
-    // ...kill it again just to make sure it's dead
-    spawn('kill', ['-9', this.#child.pid]);
-  }
-
-  // detaches listeners
-  cleanup() {
-    if (!this.#child) return;
-
-    verboseLog('Cleaning up brickadia server');
-
-    // detach listener
-    this.detachListeners();
-
-    this.#child = null;
-    this.#outInterface = null;
-    this.#errInterface = null;
-  }
-
-  // attaches proxy event listeners
-  attachListeners() {
-    this.#outInterface.on('line', this.lineListener);
-    this.#errInterface.on('line', this.errorListener);
-    this.#child.on('exit', this.exitListener);
-    this.#child.on('close', () => {});
-  }
-
-  // removes previously attached proxy event listeners
-  detachListeners() {
-    this.#outInterface.off('line', this.lineListener);
-    this.#errInterface.off('line', this.errorListener);
-    this.#child.off('exit', this.exitListener);
-    this.#child.removeAllListeners('close');
-  }
-
-  // -- listeners for basic events (line, err, exit)
-  errorListener(line) {
-    verboseLog('ERROR'.red, line);
-    this.emit('err', line);
-    for (const { match, solution, name, message } of knownErrors) {
-      if (line.match(match)) {
-        errorLog(
-          `Encountered ${name.red}. ${
-            solution ? 'Known fix:\n  ' + solution : message || 'Unknown error.'
-          }`
-        );
-      }
-    }
-  }
-
-  exitListener(...args) {
-    verboseLog('Exit listener fired');
-    this.emit('closed', ...args);
-    this.cleanup();
-  }
-
-  lineListener(line) {
-    this.emit('line', stripAnsi(line));
-  }
-}
-
-module.exports = BrickadiaServer;

package/src/cli/auth.js

@@ -1,104 +0,0 @@
-const passwordPrompt = require('password-prompt');
-const readline = require('readline');
-const path = require('path');
-const fs = require('fs');
-require('colors');
-
-const { genAuthFiles, writeAuthFiles } = require('../omegga/auth.js');
-const file = require('../util/file.js');
-const soft = require('../softconfig.js');
-
-const AUTH_PATH = path.join(soft.CONFIG_HOME, soft.CONFIG_AUTH_DIR);
-
-// prompt user for email
-const emailPrompt = text =>
-  new Promise(resolve => {
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    });
-
-    rl.question(text, email => {
-      rl.close();
-      resolve(email);
-    });
-  });
-
-// async function to prompt for credentials
-async function prompt() {
-  console.log(
-    '>>'.green,
-    'Enter',
-    'Brickadia'.green.underline,
-    'credentials (not stored)'
-  );
-  return [
-    await emailPrompt('     ' + 'email'.yellow.underline + ': '),
-    await passwordPrompt('  ' + 'password'.yellow.underline + ': '),
-  ];
-}
-
-async function authFromPrompt({ email, password, debug = false, branch }) {
-  let files;
-
-  if (!email || !password) {
-    // prompt for user credentials
-    try {
-      [email, password] = await prompt();
-    } catch (err) {
-      console.error('!>'.red, 'Error prompting credentials\n', err);
-      return false;
-    }
-  }
-
-  // generate auth tokens
-  console.log('>>'.green, 'Generating auth tokens...');
-  const timeout = setTimeout(() => {
-    console.log('>>'.green, 'Probably also installing the game...');
-  }, 10000);
-  try {
-    files = await genAuthFiles(email, password, { debug, branch });
-    clearTimeout(timeout);
-  } catch (err) {
-    clearTimeout(timeout);
-    console.error('!>'.red, 'Error generating tokens:', err);
-    return false;
-  }
-
-  if (!files) {
-    console.error('!>'.red, 'Authentication Failed');
-    return;
-  }
-
-  // save the tokens to the config path (will be copied when omegga starts)
-  try {
-    console.log('>>'.green, 'Storing auth tokens...');
-    file.mkdir(AUTH_PATH);
-    writeAuthFiles(AUTH_PATH, files);
-  } catch (err) {
-    console.error('!>'.red, 'Error writing tokens to config\n', err);
-    return false;
-  }
-
-  console.log('>>'.green, 'Auth tokens successfully generated!');
-  return true;
-}
-
-// check if auth files exist
-function authExists(dir) {
-  return soft.BRICKADIA_AUTH_FILES.every(f =>
-    fs.existsSync(path.join(dir || AUTH_PATH, f))
-  );
-}
-
-// delete auth files stored in config
-function deleteAuthFiles() {
-  file.rmdir(AUTH_PATH);
-}
-
-module.exports = {
-  prompt: authFromPrompt,
-  exists: authExists,
-  clean: deleteAuthFiles,
-  AUTH_PATH,
-};

package/src/cli/config.js

@@ -1,77 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const { store } = require('../config/index.js');
-
-const err = (...args) => console.error('!>'.red, ...args);
-const log = (...args) => console.log('>>'.green, ...args);
-
-const fields = {
-  default: {
-    desc: 'default omegga project directory when running omegga in a non-configured folder',
-    example: 'omegga config default $(pwd)',
-    default: '.',
-    get() {
-      let val = store.get('defaultOmegga') || '.';
-      if (val === '.') val += ' [current working dir]'.grey;
-      return val;
-    },
-    set(val) {
-      if (!val) {
-        val = '.';
-      }
-
-      // check if the path is valid
-      if (val !== '.' && !path.isAbsolute(val)) {
-        err('setting must be an absolute path or "."');
-        process.exit(1);
-        return;
-      }
-      if (!fs.existsSync(val)) {
-        err('given path does not exist');
-        process.exit(1);
-        return;
-      }
-      if (!fs.statSync(val).isDirectory) {
-        err('given path is not for a directory');
-        process.exit(1);
-        return;
-      }
-
-      // update the setting
-      store.set('defaultOmegga', val);
-      log('Set', 'default'.green, 'to', val.green);
-    },
-  },
-};
-
-module.exports = (field, value, _opts = {}) => {
-  // list command lists all fields, current setting, and description
-  if (field === 'list') {
-    log('Configurable fields:');
-    const maxLen = Math.max(...Object.keys(fields).map(f => f.length));
-    for (const key in fields) {
-      const field = fields[key];
-      console.log(
-        '\n  ' + key.yellow.underline,
-        '-'.padStart(maxLen - key.length + 1),
-        field.desc
-      );
-      console.log('    current'.brightGreen + ':', field.get());
-      console.log('    default:', field.default);
-      console.log('    example'.brightBlue + ':', field.example);
-    }
-    console.log();
-  } else if (fields[field]) {
-    // a valid field was entered - run the set command
-    fields[field].set(value);
-  } else {
-    // no valid field was entered
-    err(
-      'invalid field, run',
-      'omegga config list'.yellow.underline,
-      'for a list of available fields'
-    );
-    process.exit(1);
-  }
-};

package/src/cli/index.js

@@ -1,6 +0,0 @@
-module.exports = {
-  Terminal: require('./terminal.js'),
-  auth: require('./auth.js'),
-  config: require('./config.js'),
-  pluginUtil: require('./plugin.js'),
-};