omegga 0.1.85 → 1.0.0

package/src/info/default_commands.json

@@ -1,26 +0,0 @@
-[
-  "help",
-  "tp",
-  "load",
-  "clearallbricks",
-  "clearbricks",
-  "brickcount",
-  "playercount",
-  "changemap",
-  "listplayers",
-  "listroles",
-  "listteams",
-  "grantrole",
-  "revokerole",
-  "kick",
-  "ban",
-  "unban",
-  "jointeam",
-  "leaveteam",
-  "clearcheckpoint",
-  "spectator",
-  "ghost",
-  "ping",
-  "gettransform",
-  "back"
-]

package/src/lib.js

@@ -1,23 +0,0 @@
-/*
-  Library module, includes all available resources
-*/
-module.exports = {
-  brickadia: {
-    // BrickadiaServer - manages the server child process
-    Server: require('./brickadia/server.js'),
-
-    // config writer for brickadia
-    config: require('./brickadia/config.js'),
-  },
-
-  // brickadia server wrapper, log parser, and plugin runner
-  omegga: require('./omegga/index.js'),
-  // the actual object can be required too
-  Omegga: require('./omegga/server.js'),
-
-  // utility functions
-  util: require('./util/index.js'),
-
-  // config
-  config: require('./config/index.js'),
-};

package/src/main.js

@@ -1,332 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-require('colors');
-
-const pkg = require('../package');
-const soft = require('./softconfig.js');
-const Omegga = require('./omegga/server.js');
-const config = require('./config/index.js');
-const {
-  Terminal,
-  auth,
-  config: omeggaConfig,
-  pluginUtil,
-} = require('./cli/index.js');
-const file = require('./util/file.js');
-
-const updateNotifier = require('update-notifier');
-const notifier = updateNotifier({
-  isGlobal: true,
-  pkg: pkg,
-  updateCheckInterval: 1000 * 60 * 60 * 24,
-}).notify();
-
-/*
-// TODO: let omegga bundle config (roles, bans, server config) to zip
-// TODO: let omegga unbundle config from zip to current omegga dir
-*/
-
-const err = (...args) => console.error('!>'.red, ...args);
-const log = (...args) => console.log('>>'.green, ...args);
-const verboseLog = (...args) => {
-  if (!global.VERBOSE) return;
-  if (Omegga.log) Omegga.log('V>'.magenta, ...args);
-  else console.log('V>'.magenta, ...args);
-};
-
-// write a default config file
-const createDefaultConfig = () => {
-  log('Created default config file');
-  config.write(soft.CONFIG_FILENAMES[0] + '.yml', config.defaultConfig);
-  file.mkdir('data/Saved/Builds');
-  file.mkdir('plugins');
-  return config.defaultConfig;
-};
-
-const program = require('commander')
-  .description(pkg.description)
-  .version(pkg.version)
-  .option(
-    '-d, --debug',
-    'Print all console logs rather than just chat messages'
-  )
-  .option('-v, --verbose', 'Print extra messages for debugging purposes')
-  .action(async () => {
-    const { debug, verbose } = program.opts();
-    global.VERBOSE = verbose;
-
-    // default working directory is the one specified in config
-    let workDir = config.store.get('defaultOmegga');
-    verboseLog('Using working directory', workDir.yellow);
-
-    // check if a local install exists
-    const localInstall = fs.existsSync(soft.LOCAL_LAUNCHER);
-
-    // if there's a config in the current directory, use that one instead
-    if (config.find('.')) workDir = '.';
-
-    // check if configured path exists
-    if (!fs.existsSync(workDir)) {
-      err('configured omegga default path does not exist');
-      process.exit(1);
-      return;
-    }
-    if (!fs.statSync(workDir).isDirectory) {
-      err('configured omegga default path is not a directory');
-      process.exit(1);
-      return;
-    }
-
-    // find the config for the working directory
-    const configFile = config.find(workDir);
-    let conf;
-
-    // create a default config file if it does not already exist, otherwise load in the existing one
-    if (!configFile) {
-      verboseLog('Creating a new config');
-      conf = createDefaultConfig();
-    } else {
-      verboseLog('Reading config file from', configFile.yellow);
-      conf = config.read(configFile);
-    }
-
-    // if local install is provided
-    if (localInstall) {
-      verboseLog("Using omegga's brickadia-launcher");
-      conf.server.__LOCAL = true;
-    }
-
-    // check if the auth files don't exist
-    if (
-      !auth.exists(path.join(workDir, soft.DATA_PATH, 'Saved/Auth')) &&
-      !auth.exists()
-    ) {
-      const success = await auth.prompt({
-        debug,
-        email: process.env.BRICKADIA_USER ?? null,
-        password: process.env.BRICKADIA_PASS ?? null,
-        branch: conf?.server?.branch ?? null,
-      });
-      if (!success) {
-        err('Start aborted - could not generate auth tokens');
-        process.exit(1);
-        return;
-      }
-    }
-
-    // build options
-    const options = {
-      // default enable web ui (set to false)
-      noweb: typeof conf.omegga.webui === 'boolean' && !conf.omegga.webui,
-      // default enable https (set to true, will not be https if it can't generate)
-      https: typeof conf.omegga.https !== 'boolean' || conf.omegga.https,
-      port: conf.omegga.port || soft.DEFAULT_PORT,
-      debug,
-    };
-
-    verboseLog('Launching with options', options);
-
-    // setup the server
-    const server = new Omegga(workDir, conf, options);
-    verboseLog('Created omegga object');
-
-    if (verbose) {
-      server.on('*', ev => ev !== 'line' && verboseLog('EVENT'.green, ev));
-    }
-
-    // create a terminal
-    Omegga.setTerminal(new Terminal(server, options));
-
-    if (notifier.update) {
-      Omegga.log(
-        '>>'.green,
-        `Update is available (${('v' + notifier.update.latest).yellow})! Run`,
-        'npm i -g omegga'.yellow,
-        'to update!'
-      );
-    }
-
-    Omegga.log(
-      '>>'.green,
-      `Launching brickadia server on port ${
-        ('' + (conf.server.port || 7777)).green
-      }...`
-    );
-
-    // start the server
-    verboseLog('Starting Omegga');
-    server.start();
-  });
-
-program
-  .command('init')
-  .description('Sets up the current directory as a brickadia server')
-  .action(() => {
-    const configFile = config.find('.');
-    if (configFile) {
-      err('Config file already exists:', configFile.yellow.underline);
-      process.exit(1);
-      return;
-    }
-    createDefaultConfig();
-  });
-
-program
-  .command('config [field] [value]')
-  .description(
-    "Configure Omegga's default behavior.\n" +
-      'Type ' +
-      'omegga config list'.yellow.underline +
-      ' for current settings and available fields'
-  )
-  .action((field, value) => {
-    if (!field) field = 'list';
-    omeggaConfig(field, value, program.opts());
-  });
-
-program
-  .command('auth')
-  .option('-g, --global', 'Remove global auth files')
-  .option('-l, --local', 'Remove local auth files')
-  .option('-w, --workdir', 'Remove configured location auth files')
-  .option('-u, --email <email>', 'User email (must provide password)')
-  .option('-p, --pass <password>', 'User password (must provide email)')
-  .option('-v, --verbose', 'Print extra messages for debugging purposes')
-  .description(
-    'Generates server auth tokens from brickadia account email+password'
-  )
-  .action(
-    async ({
-      email,
-      pass: password,
-      local: localAuth,
-      workDir,
-      global: globalAuth,
-    }) => {
-      const { verbose, debug } = program.opts();
-      global.VERBOSE = verbose;
-      const workdirPath = path.join(
-        config.store.get('defaultOmegga'),
-        'data/Saved/Auth'
-      );
-
-      if (globalAuth || localAuth) {
-        if (globalAuth) {
-          log('Clearing auth files from', auth.AUTH_PATH.yellow);
-          auth.clean();
-        }
-        if (workDir) {
-          log('Clearing auth files from', workdirPath.yellow);
-          await file.rmdir(workdirPath);
-        }
-        if (localAuth) {
-          const localPath = path.resolve('data/Saved/Auth');
-          log('Clearing auth files from', localPath.yellow);
-          await file.rmdir(localPath);
-        }
-        return;
-      } else {
-        let branch;
-
-        // if there's a config in the current directory, use that one instead
-        if (config.find('.')) workDir = '.';
-
-        // check if configured path exists
-        if (fs.existsSync(workDir) && fs.statSync(workDir).isDirectory) {
-          // find the config for the working directory
-          const configFile = config.find(workDir);
-          try {
-            // read the config and extract the branch
-            const conf = config.read(configFile);
-            branch = conf?.server?.branch;
-          } catch (err) {
-            err('Error reading config file');
-            verboseLog(err);
-          }
-        }
-
-        // auth with that branch
-        auth.prompt({ email, password, debug, branch });
-      }
-    }
-  );
-
-program
-  .command('info')
-  .alias('n')
-  .description(
-    'Shows server name, description, port, install info, and installed plugins'
-  )
-  .action(() => {
-    err('not implemented yet');
-    // TODO: implement config parsing
-  });
-
-program
-  .command('install <pluginUrl...>')
-  .alias('i')
-  .description('Installs a plugin to the current brickadia server')
-  .option('-f, --force', 'Forcefully re-install existing plugin') // TODO: implement install --force
-  .option('-v, --verbose', 'Print extra messages for debugging purposes')
-  .action(plugins => {
-    if (!require('hasbin').sync('git')) {
-      err('git'.yellow, 'must be installed to install plugins.');
-      process.exit(1);
-      return;
-    }
-
-    if (!config.find('.')) {
-      err(
-        'Not an omegga directory, run ',
-        'omegga init'.yellow,
-        'to setup one.'
-      );
-      process.exit(1);
-      return;
-    }
-    const { verbose, force } = program.opts();
-    global.VERBOSE = verbose;
-    pluginUtil.install(plugins, { verbose, force });
-  });
-
-program
-  .command('update [pluginNames...]')
-  .alias('u')
-  .description('Updates all or selected installed plugins to latest versions')
-  .option('-f, --force', 'Forcefully re-upgrade existing plugin') // TODO: implement update --force
-  .option('-v, --verbose', 'Print extra messages for debugging purposes')
-  .action(plugins => {
-    if (!config.find('.')) {
-      err(
-        'Not an omegga directory, run ',
-        'omegga init'.yellow,
-        'to setup one.'
-      );
-      process.exit(1);
-      return;
-    }
-    const { verbose, force } = program.opts();
-    global.VERBOSE = verbose;
-    pluginUtil.update(plugins, { verbose, force });
-  });
-
-program
-  .command('check [pluginNames...]')
-  .description('Checks plugins for compatibility issues')
-  .option('-v, --verbose', 'Print extra messages for debugging purposes')
-  .action(plugins => {
-    if (!config.find('.')) {
-      err(
-        'Not an omegga directory, run ',
-        'omegga init'.yellow,
-        'to setup one.'
-      );
-      process.exit(1);
-      return;
-    }
-    const { verbose } = program.opts();
-    global.VERBOSE = verbose;
-    pluginUtil.check(plugins, { verbose });
-  });
-
-program.parse(process.argv);

package/src/omegga/auth.js

@@ -1,138 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const Omegga = require('./server.js');
-const soft = require('../softconfig.js');
-const file = require('../util/file.js');
-const { write: writeConfig } = require('../brickadia/config.js');
-require('colors');
-
-const verboseLog = (...args) => {
-  if (!global.VERBOSE) return;
-  if (Omegga.log) Omegga.log('V>'.magenta, ...args);
-  else console.log('V>'.magenta, ...args);
-};
-
-// remove the temporary install
-async function removeTempDir() {
-  if (fs.existsSync(soft.TEMP_DIR_NAME)) {
-    verboseLog('Removing temporary auth directory');
-
-    // attempt to remove the temporary dir
-    try {
-      await file.rmdir(soft.TEMP_DIR_NAME);
-    } catch (e) {
-      // ignore fail - the directory probably doesn't exist
-    }
-  }
-}
-
-// read the auth files into a buffer
-function readAuthFiles() {
-  const files = {};
-  for (const f of soft.BRICKADIA_AUTH_FILES) {
-    files[f] = fs.readFileSync(
-      path.join(soft.TEMP_DIR_NAME, soft.DATA_PATH, 'Saved/Auth', f)
-    );
-  }
-  return files;
-}
-
-// write auth files object to a server path
-function writeAuthFiles(dstDir, files) {
-  for (const f in files) {
-    fs.writeFileSync(path.join(dstDir, f), files[f]);
-  }
-}
-
-// from credentials, build brickadia auth tokens
-async function genAuthFiles(email, password, { debug = false, branch }) {
-  verboseLog('Generating auth files');
-
-  // remove existing temporary install path
-  await removeTempDir();
-
-  if (fs.existsSync(soft.LOCAL_LAUNCHER)) {
-    verboseLog('Generating auth with local launcher');
-  }
-
-  // dummy omegga config
-  const config = {
-    server: {
-      port: 7777,
-      publiclyListed: false,
-      name: 'omegga auth init',
-      __LOCAL: fs.existsSync(soft.LOCAL_LAUNCHER),
-      branch,
-    },
-    credentials: { email, password },
-  };
-
-  // dummy omegga launch options
-  const options = {
-    noauth: true,
-    noplugin: true,
-    noweb: true,
-    debug,
-  };
-
-  // create a dummy omegga
-  const omegga = new Omegga(soft.TEMP_DIR_NAME, config, options);
-
-  // create the unlisted server config
-  writeConfig(soft.TEMP_DIR_NAME, config);
-
-  omegga.start();
-
-  const success = await new Promise((resolve, reject) => {
-    let resolved = false;
-    // auth succeeded if the server starts
-    omegga.once('start', () => {
-      verboseLog('Auth succeeded');
-      resolved = true;
-      resolve(true);
-
-      // immediately stop the server
-      omegga.stop();
-    });
-
-    // auth failed if we get 'unauthorized'
-    omegga.once('unauthorized', () => {
-      verboseLog('Auth failed');
-      resolved = true;
-      resolve(false);
-
-      // immediately stop the server
-      omegga.stop();
-    });
-
-    let finished = false;
-    const finish =
-      name =>
-      (...args) => {
-        if (finished) return;
-        finished = true;
-        verboseLog('Brickadia', name, 'with code', ...args);
-        if (!resolved) reject('temp server could not start');
-      };
-
-    // if the server closes and the promise hasn't resolved, reject
-    omegga.once('closed', finish('closed'));
-    omegga.once('exit', finish('exited'));
-    omegga.once('server:stopped', finish('stopped'));
-  });
-
-  // read the auth files on success
-  const files = success ? readAuthFiles() : null;
-
-  // remove temp dir
-  removeTempDir();
-
-  // return auth files (or null)
-  return files;
-}
-
-module.exports = {
-  genAuthFiles,
-  writeAuthFiles,
-};