omegga 0.1.83 → 1.0.0

package/src/cli/terminal.js

@@ -1,466 +0,0 @@
-const readline = require('readline');
-
-const {
-  chat: { sanitize },
-} = require('../util/index.js');
-
-let log, err, warn;
-
-// the terminal wraps omegga and displays console output and handles console input
-class Terminal {
-  constructor(omegga, options = {}) {
-    this.options = options;
-    this.omegga = omegga;
-
-    this.commands = {};
-
-    // terminal interface
-    this.rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-      terminal: true,
-    });
-    this.rl.setPrompt('> '.brightGreen);
-
-    // shortand fns
-    log = (...args) => this.log('>>'.green, ...args);
-    err = (...args) => this.error('!>'.red, ...args);
-    warn = (...args) => this.warn('W>'.yellow, ...args);
-
-    // print log line if debug is enabled
-    let launcherDone = false;
-    let lastDoneMessage = '';
-    omegga.on('line', l => {
-      if (options.debug) this.log('::'.blue, l);
-      else if (!launcherDone) {
-        if (l.startsWith('DOWNLOADING')) {
-          // TOOD: if someone is proactive enough in the future, you could turn these steps into a legitimate progress bar
-          /* Here's some launcher log lines that might be helpful
-            Grabbing manifest and checking game files...
-            DOWNLOADING MANIFEST | Hold on...
-            DOWNLOADING MANIFEST (100%) | Hold on...
-            DOWNLOADING MANIFEST (100%) | 0 B/s - 13 KiB / 13 KiB (Unknown time remaining...)
-            DOWNLOADING MANIFEST (100%) | Done!
-            Checking launcher and downloading version info...
-            Installing patches and booting...
-            DOWNLOADING BRICKADIA (0%) | Done!
-            DOWNLOADING BRICKADIA (100%) | 110 MiB/s - 584 MiB / 584 MiB (1 second remaining...)
-            DOWNLOADING BRICKADIA (100%) | Nearly done...
-            DOWNLOADING BRICKADIA (100%), INSTALLING BRICKADIA (86%) | Nearly done...
-          */
-          process.stdout.clearLine();
-          process.stdout.cursorTo(0);
-          process.stdout.write(l);
-          // add a newline on "Done!" but prevent newlines on repeat done messages
-          if (l.match(/Done!/) && l !== lastDoneMessage) {
-            lastDoneMessage = l;
-            process.stdout.write('\n');
-          }
-        } else if (l.match(/Disabling core dumps./)) {
-          launcherDone = true;
-        }
-      }
-    });
-
-    // print debug events regardless of debug status
-    omegga.on('debug', l => this.log('?>'.magenta, l));
-
-    // print chat events as players join/leave the server
-    omegga.on('join', p => this.log(`${p.name.underline} joined.`.brightBlue));
-    omegga.on('leave', p => this.log(`${p.name.underline} left.`.brightBlue));
-    omegga.on('chat', (name, message) =>
-      this.log(`${name.brightYellow.underline}: ${message}`)
-    );
-    omegga.on('start', () => {
-      const wsl = require('../util/wsl');
-      log(
-        `Server has started${
-          wsl === 1 ? ' in single thread mode due to WSL1' : ''
-        }. Type ${'/help'.yellow} for more commands`
-      );
-
-      // check if this is WSL2 and wsl2binds is installed
-      if (
-        wsl === 2 &&
-        this.omegga.pluginLoader &&
-        !this.omegga.pluginLoader.plugins.some(p => p.getName() === 'wsl2binds')
-      ) {
-        warn(
-          '####'.yellow,
-          `You are running ${'WSL2'.yellow} and you don't have the ${
-            'wsl2binds'.yellow
-          } plugin.`
-        );
-        warn(
-          '####'.yellow,
-          `The wsl2binds plugin works as a ${
-            'UDP proxy'.underline
-          } between Windows and the WSL2 VM.`
-        );
-        warn('####'.yellow, 'Install it by:');
-        warn('####'.yellow, ' 1. Closing omegga with', '/stop'.green);
-        warn(
-          '####'.yellow,
-          ' 2. Installing wsl2binds with',
-          'omegga install gh:Meshiest/wsl2binds'.green
-        );
-        warn('####'.yellow, ' 3. Restarting', 'omegga'.green);
-      }
-    });
-    omegga.on('mapchange', ({ map }) =>
-      log('Map changed to', (map.charAt(0).toUpperCase() + map.slice(1)).green)
-    );
-    omegga.on('unauthorized', () => {
-      err('Server failed authentication check');
-      process.exit();
-    });
-    omegga.on('error', e => err('Server caught unhandled exception:\n' + e));
-    omegga.on('server:stopped', () =>
-      log('Server has closed. Type', '/stop'.yellow, 'to close omegga')
-    );
-
-    this.rl.on('line', this.handleLine.bind(this));
-
-    // console commands
-    Object.entries({
-      debug: {
-        desc: 'toggle visibility of brickadia console logs',
-        fn() {
-          options.debug = !options.debug;
-          log(
-            'Brickadia logs now',
-            options.debug ? 'visible'.green : 'hidden'.red
-          );
-        },
-      },
-
-      help: {
-        desc: 'list supported commands and their descriptions',
-        fn() {
-          const maxCmdLen = Math.max(
-            ...Object.keys(this.commands).map(s => s.length)
-          );
-          log('Omegga Help Text:\n');
-          this.log(
-            '  Console input not starting with / will be sent in chat from a "SERVER" user'
-          );
-          this.log(
-            '  Console input starting with / will be treated as one of the following commands\n'
-          );
-          this.log(
-            '-- Available Omegga commands (type',
-            '/command'.yellow.underline,
-            'to run)'
-          );
-          Object.keys(this.commands)
-            .sort()
-            .forEach(k => {
-              this.log(
-                '  ',
-                k.yellow.underline,
-                '-'.padStart(maxCmdLen - k.length + 1),
-                this.commands[k].desc
-              );
-            });
-          this.log('');
-        },
-      },
-
-      cmd: {
-        desc: 'run a console command on the brickadia server. requires debug for log to show',
-        fn(...args) {
-          if (!this.omegga.started) {
-            err('Omegga is not running');
-            return;
-          }
-          this.omegga.writeln(args.join(' '));
-        },
-      },
-
-      ban: {
-        desc: 'ban a player',
-        fn(...args) {
-          if (!this.omegga.started) {
-            err('Omegga is not running');
-            return;
-          }
-          if (!args.length) {
-            return err(
-              'usage:',
-              '/ban <name|id> [duration in mins] [reason]'.yellow
-            );
-          }
-          this.omegga.writeln('Chat.Command /ban ' + args.join(' '));
-        },
-      },
-      unban: {
-        desc: 'unban a player',
-        fn(...args) {
-          if (!this.omegga.started) {
-            err('Omegga is not running');
-            return;
-          }
-          if (!args.length) {
-            return err('usage:', '/unban <name|id>'.yellow);
-          }
-          this.omegga.writeln('Chat.Command /unban ' + args.join(' '));
-        },
-      },
-      kick: {
-        desc: 'kick a player',
-        fn(...args) {
-          if (!this.omegga.started) {
-            err('Omegga is not running');
-            return;
-          }
-          if (!args.length) {
-            return err('usage:', '/kick <name|id> [reason]'.yellow);
-          }
-          this.omegga.writeln('Chat.Command /kick ' + args.join(' '));
-        },
-      },
-      grantrole: {
-        desc: 'grant a role to a player',
-        fn(...args) {
-          if (!this.omegga.started) {
-            err('Omegga is not running');
-            return;
-          }
-          if (!args.length) {
-            return err('usage:', '/grantrole <role name> <name|id>'.yellow);
-          }
-          this.omegga.writeln('Chat.Command /grantrole ' + args.join(' '));
-        },
-      },
-      revokerole: {
-        desc: 'revoke a role from a player',
-        fn(...args) {
-          if (!this.omegga.started) {
-            err('Omegga is not running');
-            return;
-          }
-          if (!args.length) {
-            return err('usage:', '/revokerole <role name> <name|id>'.yellow);
-          }
-          this.omegga.writeln('Chat.Command /revokerole ' + args.join(' '));
-        },
-      },
-      clearbricks: {
-        desc: "clear a player's bricks",
-        fn(...args) {
-          if (!this.omegga.started) {
-            err('Omegga is not running');
-            return;
-          }
-          if (!args.length) {
-            return err('usage:', '/clearbricks <name>'.yellow);
-          }
-          this.omegga.writeln(`Bricks.Clear "${args.join(' ')}"`);
-        },
-      },
-      clearallbricks: {
-        desc: 'clear all bricks',
-        fn() {
-          if (!this.omegga.started) {
-            err('Omegga is not running');
-            return;
-          }
-          this.omegga.writeln('Bricks.ClearAll');
-        },
-      },
-
-      status: {
-        desc: 'display server status information. brick count, online players, etc',
-        async fn() {
-          if (!this.omegga.started) {
-            err('Omegga is not running');
-            return;
-          }
-          const msToTime = ms => new Date(ms).toISOString().substr(11, 8);
-          try {
-            const status = await this.omegga.getServerStatus();
-
-            log('Server Status');
-            this.log(`
-  ${status.serverName.yellow}
-    Bricks: ${(status.bricks + '').yellow}
-    Components: ${(status.components + '').yellow}
-    Uptime: ${msToTime(status.time).yellow}
-    Players: ${status.players.length === 0 ? 'none'.grey : ''}
-      ${status.players
-        .map(p => `[${msToTime(p.time).grey}] ${p.name.brightYellow}`)
-        .join('\n      ')}
-`);
-          } catch (e) {
-            err('An error occurred while getting server status');
-          }
-        },
-      },
-
-      stop: {
-        desc: 'stop the server and close Omegga',
-        async fn() {
-          log('Stopping server...');
-          await this.omegga.stop();
-          process.exit();
-        },
-      },
-
-      kill: {
-        desc: 'forcefully kill brickadia server process without closing omegga',
-        async fn() {
-          log('Stopping server...');
-          await this.omegga.stop();
-        },
-      },
-
-      save: {
-        desc: 'Save bricks to a specified file',
-        async fn(...args) {
-          const name = args.join(' ');
-          if (!name.length) return err('usage:', '/save <name>'.yellow);
-          log('Saving bricks');
-          this.omegga.saveBricks(name);
-        },
-      },
-
-      load: {
-        desc: 'Load bricks from a specified file',
-        async fn(...args) {
-          const name = args.join(' ');
-          if (!name.length) return err('usage:', '/load <name>'.yellow);
-          log('Loading bricks');
-          this.omegga.loadBricks(name);
-        },
-      },
-
-      start: {
-        desc: 'start the server if it is stopped',
-        fn() {
-          if (
-            !this.omegga ||
-            (this.omegga && (this.omegga.starting || this.omegga.started))
-          ) {
-            err('Omegga is already running');
-            return;
-          }
-          log('Starting server...');
-          this.omegga.start();
-        },
-      },
-
-      reload: {
-        desc: 'reload available plugins',
-        async fn() {
-          if (!this.omegga.pluginLoader) {
-            err('Omegga is not using plugins');
-            return;
-          }
-
-          log('Unloading current plugins');
-          let success = await this.omegga.pluginLoader.unload();
-          if (!success) {
-            err('Could not unload all plugins');
-            return;
-          }
-
-          log('Scanning for new plugins');
-          success = await this.omegga.pluginLoader.scan();
-          if (!success) {
-            err('Could not scan for plugins');
-            return;
-          }
-
-          log('Starting plugins');
-          success = await this.omegga.pluginLoader.reload();
-          if (success) {
-            const plugins = this.omegga.pluginLoader.plugins
-              .filter(p => p.isLoaded())
-              .map(p => p.getName());
-            log('Loaded', (plugins.length + '').yellow, 'plugins:', plugins);
-          } else {
-            err('Could not load all plugins');
-          }
-        },
-      },
-    }).forEach(([cmd, { desc, fn }]) => this.addCommand(cmd, desc, fn));
-  }
-
-  // add a command
-  addCommand(name, desc, fn) {
-    this.commands[name] = { name, desc, fn: fn.bind(this) };
-  }
-
-  async handleLine(line) {
-    if (line.startsWith('/')) {
-      const [cmd, ...args] = line.slice(1).split(' ');
-      if (!this.commands[cmd]) {
-        err(
-          `unrecognized command /${cmd.underline}. Type /help for more info`.red
-        );
-      } else {
-        try {
-          const res = this.commands[cmd].fn(...args);
-          if (res instanceof Promise) {
-            await res;
-          }
-        } catch (e) {
-          err('unhandled terminal error', e);
-        }
-      }
-    } else if (line.trim().length > 0) {
-      if (this.omegga.started) {
-        // broadcast when the chat does not start with a command
-        this.omegga.broadcast(
-          `"[<b><color=\\"ff00ff\\">SERVER</></>]: ${sanitize(line)}"`
-        );
-        process.stdout.clearLine();
-        this.log(`[${'SERVER'.brightMagenta.underline}]: ${line}`);
-
-        // if omegga is running a webserver - send this message in the chat log
-        if (this.omegga.webserver) {
-          const user = { name: 'SERVER', id: '', web: true, color: 'ff00ff' };
-          // create database entry, send to web ui
-          this.omegga.webserver.io
-            .to('chat')
-            .emit(
-              'chat',
-              await this.omegga.webserver.database.addChatLog('msg', user, line)
-            );
-        }
-      } else {
-        err(
-          'Server is not started yet. type'.red,
-          '/help'.yellow,
-          'for more info'.red
-        );
-      }
-    }
-  }
-
-  // let readline render a log without interrupting user input
-  log(...args) {
-    process.stdout.clearLine();
-    process.stdout.cursorTo(0);
-    console.log(...args);
-    this.rl.prompt(true);
-  }
-
-  // let readline render a warning log without interrupting user input
-  warn(...args) {
-    process.stdout.clearLine();
-    process.stdout.cursorTo(0);
-    console.warn(...args);
-    this.rl.prompt(true);
-  }
-
-  // let readline render an error log without interrupting user input
-  error(...args) {
-    process.stdout.clearLine();
-    process.stdout.cursorTo(0);
-    console.error(...args);
-    this.rl.prompt(true);
-  }
-}
-
-module.exports = Terminal;

package/src/config/authorizer.js

@@ -1,37 +0,0 @@
-/*
-  Determine if email+password combo is valid
-*/
-
-const BrickadiaServer = require('../brickadia/server.js');
-const config = require('../softconfig.js');
-const { store } = require('../config/index.js');
-
-const invalidRegExp =
-  /^(Error: AuthState is Invalid on dedicated server - exiting\.|Changing AuthState from \w+ to Invalid\.)$/;
-const validRegExp = /^Changing AuthState from \w+ to ValidOnline\.$/;
-
-module.exports = (email, password) =>
-  new Promise(resolve => {
-    // create a server with these credentials
-    const server = new BrickadiaServer(config.DATA_PATH, {
-      credentials: { email, password },
-      server: {
-        port: 7775,
-        __LEGACY: store.get('legacyBin'),
-      },
-    });
-
-    // wait for the invalid auth line or valid auth line, then kill the server
-    server.on('line', line => {
-      if (line.match(invalidRegExp)) {
-        server.stop();
-        resolve(false);
-      } else if (line.match(validRegExp)) {
-        server.stop();
-        resolve(true);
-      }
-    });
-
-    // start the server
-    server.start();
-  });

package/src/config/formats/format_js.js

@@ -1,6 +0,0 @@
-module.exports = {
-  extension: 'js',
-  encoding: 'string',
-  reader: str => JSON.parse(str),
-  writer: blob => JSON.stringify(blob, 0, 2),
-};

package/src/config/formats/format_yml.js

@@ -1,8 +0,0 @@
-const yaml = require('js-yaml');
-
-module.exports = {
-  extension: 'yml',
-  encoding: 'string',
-  reader: str => yaml.safeLoad(str),
-  writer: blob => yaml.safeDump(blob),
-};

package/src/config/index.js

@@ -1,81 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const soft = require('../softconfig.js');
-
-const Configstore = require('configstore');
-
-const store = new Configstore(
-  soft.PROJECT_NAME,
-  {
-    defaultOmegga: '.',
-    legacyBin: '',
-  },
-  {
-    globalConfigPath: true,
-  }
-);
-
-// find all format_EXT.js files in the formats path
-const formats = fs
-  .readdirSync(path.join(__dirname, 'formats'))
-  // all formats match the format_EXT.js pattern
-  .filter(file => file.match(/format_[a-z]+\.js/))
-  // require all the formats
-  .map(file => require('./formats/' + file))
-  // format has a valid extension, reader, and writer
-  .filter(
-    format =>
-      format.extension &&
-      format.extension.match(/^[a-z]+$/) &&
-      format.encoding &&
-      format.encoding.match(/^(string|buffer)$/) &&
-      format.reader &&
-      typeof format.reader === 'function' &&
-      format.writer &&
-      typeof format.writer === 'function'
-  );
-
-// create read/write funcs for the provided formats
-module.exports = {
-  defaultConfig: {
-    omegga: {
-      webui: true,
-      port: process.env.OMEGGA_PORT
-        ? Number(process.env.OMEGGA_PORT)
-        : soft.DEFAULT_PORT,
-      https: true,
-    },
-    server: {
-      port: process.env.BRICKADIA_PORT
-        ? Number(process.env.BRICKADIA_PORT)
-        : 7777,
-      map: 'Plate',
-      branch: 'main-server',
-    },
-  },
-
-  // config store
-  store,
-
-  // Writes save data to a file
-  // function(path, blob) -> void
-  write: require('./writer.js')(formats),
-
-  // reads save data from a file
-  // function(path) -> config
-  read: require('./reader.js')(formats),
-
-  // open config at a specified path
-  find(dir = '.') {
-    // find the first config file matching these config file names
-    for (const f of soft.CONFIG_FILENAMES) {
-      for (const { extension } of formats) {
-        const file = path.join(dir, f + '.' + extension);
-        if (fs.existsSync(file)) return file;
-      }
-    }
-
-    return undefined;
-  },
-};

package/src/config/reader.js

@@ -1,27 +0,0 @@
-const fs = require('fs');
-const validate = require('./validator.js');
-
-// given a list of formats, generate a function to write to any of those formats
-module.exports = formats => path => {
-  // find the config format that matches this extension
-  const ext = path.split('.').pop().toLowerCase();
-  const format = formats.find(f => f.extension === ext);
-  if (!format) throw 'missing format';
-
-  if (!fs.existsSync(path)) throw 'missing file';
-
-  // read the config file
-  const data = fs.readFileSync(path);
-
-  // parse the config file
-  const blob = format.reader(
-    format.encoding === 'string' ? data.toString() : data
-  );
-
-  // validate the config blob
-  const result = validate(blob);
-  if (!result.valid) throw result.errors;
-
-  // return the parsed config
-  return blob;
-};

package/src/config/validator.js

@@ -1,32 +0,0 @@
-const allowedKeys = ['omegga', 'credentials', 'server'];
-
-// low effort js object validation
-module.exports = obj => {
-  if (typeof obj !== 'object')
-    return { valid: false, errors: ['not an object'] };
-
-  if (Object.keys(obj).some(k => !allowedKeys.includes(k)))
-    return { valid: false, errors: ['contains invalid keys'] };
-
-  if (!obj.server || typeof obj.server !== 'object')
-    return { valid: false, errors: ['missing/invalid server category'] };
-
-  if (typeof obj.server.port !== 'number')
-    return { valid: false, errors: ['server.port must be a number'] };
-
-  if (obj.server.branch && typeof obj.server.branch !== 'string')
-    return { valid: false, errors: ['server.branch must be a string'] };
-
-  if (obj.omegga) {
-    if (typeof obj.omegga !== 'object')
-      return { valid: false, errors: ['invalid omegga category'] };
-
-    if (
-      typeof obj.omegga.port !== 'undefined' &&
-      typeof obj.omegga.port !== 'number'
-    )
-      return { valid: false, errors: ['omegga.port must be a nubmer'] };
-  }
-
-  return { valid: true, errors: [] };
-};

package/src/config/writer.js

@@ -1,20 +0,0 @@
-const fs = require('fs');
-const validate = require('./validator.js');
-
-// given a list of formats, generate a function for write to any of those formats
-module.exports = formats => (path, blob) => {
-  // find the config format that matches this extension
-  const ext = path.split('.').pop().toLowerCase();
-  const format = formats.find(f => f.extension === ext);
-  if (!format) throw 'missing format';
-
-  // validate the config blob
-  const result = validate(blob);
-  if (!result.valid) throw result.errors;
-
-  // encode the config data into the format
-  const data = format.writer(blob);
-
-  // write the encoded config to file
-  fs.writeFileSync(path, data);
-};