Installing on Linux

Quick Setup

Get Omegga on Debian, Ubuntu, Fedora, or Arch with:

curl -fsSL https://omegga.brickadia.dev/install.sh | bash

This bash script will ask before installing anything, and refuses to install omegga as root. Read what it does. Windows users need WSL first: this script will not run on windows, and omegga is not supported on Windows.

It checks what is installed, offers to install missing dependencies, installs node through nvm, and installs omegga. Nothing is installed without asking first, and running it twice is safe. Read the source: tools/install.sh.

Flags go after -s --, because the script is stdin here:

# report what is missing and stop
curl -fsSL https://omegga.brickadia.dev/install.sh | bash -s -- --dry-run

# take the recommended answer to everything, for a container build or a panel
curl -fsSL https://omegga.brickadia.dev/install.sh | bash -s -- --yes

It knows the package names for Debian, Ubuntu, Fedora and Arch, and their derivatives. On anything else it still reports what is missing and installs node and omegga; only the package names are left to you.

Manual Quick Setup

1. Install linux if you haven’t already (Windows Install is not that bad)

2. If you type whoami and it says “root”, create a new user and come back. This step is usually only necessary for people using a VPS.

3. Update the packages you already have, then install the ones omegga needs. Skipping the update step causes several of the errors below:

   sudo apt update && sudo apt upgrade
   
   sudo apt install curl git build-essential python3 wget tar openssl lib32gcc-s1
   

   What each of those is for. The names differ elsewhere:

   Fedora	sudo dnf install curl git gcc gcc-c++ make python3 wget tar openssl glibc.i686 libgcc.i686 libstdc++.i686
   Arch	sudo pacman -S --needed curl git base-devel python wget tar openssl lib32-gcc-libs

   The 32-bit packages are for steamcmd. On Arch they come from the multilib repository, which ships disabled: uncomment [multilib] and the Include line under it in /etc/pacman.conf first.

4. Run these commands (Installs a node installer, installs node, installs omegga):

   # download nvm
   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
   
   # activate nvm
   . ~/.nvm/nvm.sh
   
   # install node version 24
   nvm install 24
   
   # install omegga
   npm i -g omegga
   

5. Head over to Running Omegga or troubleshoot below. To run it in a container instead of installing it, see Containers.

Install Troubleshooting

If you are having issues running omegga, see Troubleshooting for a potential fix. This section is for issues with installing.

• If you are on Ubuntu and the output of which npm is /bin/npm

  sudo apt purge nodejs # uninstall old version of nodejs
  # restart install instructions from this point
  nvm install 24 # install node version 24 via nvm
  

• If you get an error like “sh: 28: cd: can't cd to .”, you need to be in bash (and probably type cd to navigate out of root directory):

  bash # use bash instead of sh
  cd # navigate home
  

• If you get an error like “gyp info find Python using Python version 3.8.10 found at /usr/bin/python3” you need to install python3:

  sudo apt install python3
  npm i -g omegga
  

• If you get an error like “gyp ERR! stack Error: not found: make” you need to install build-essential:

  sudo apt update && sudo apt upgrade # refresh the package index first
  sudo apt install build-essential # install make
  npm i -g omegga # re-run omegga install
  

• If you get an error like “Unable to fetch some archives, maybe run apt-get update” you need to run this before running your original command:

  sudo apt update && sudo apt upgrade
  

• If you are having trouble installing with nvm and are running Ubuntu/Debian, run the following commands (installs node, installs omegga) instead or install node&npm from NodeSource Binary Distributions.

  curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
  sudo apt-get install -y nodejs
  npm i -g omegga
  

Manual Setup (you install stuff)

Omegga depends on:

• linux
  • Windows Install (WSL 1 or WSL 2)
• Node v23+ (ubuntu/deb, but nvm from Quick Setup is better)
• One of:
  • tar (most linuxes come with this, though you can sudo apt install tar)
  • Brickadia linux launcher

Packages

sudo apt install curl git build-essential python3 wget tar openssl lib32gcc-s1 covers all of these on Debian and Ubuntu.

SteamCMD is not on that list: omegga asks to install it on the first start, into ~/.config/omegga/steam, or uses one already on PATH.

Omegga is installed as a global npm package

npm i -g omegga

Alternatively, you can use a development/local omegga.

# clone omegga
git clone https://github.com/brickadia-community/omegga.git && cd omegga

# install dependencies
npm i

# point development omegga to global npm bin
npm link

# build the web ui, build omegga's typescript, and the plugin omegga.d.ts
npm run dist

If you accidentally install both from Github and npm i -g omegga, you can run npm unlink omegga to stop npm from using the git one.

Any errors, see Troubleshooting for a potential fix.

Creating a New User

If you are running as root (terminal prompt ends with ‘#’ instead of ‘$’ or running whoami says “root”), create a new user.

The following commands will create a user named brickadia. Feel free to replace it to user or your own name.

# create the user
useradd -m brickadia
# set the new user's password
passwd brickadia
# allow "sudo apt install ...." to work in this user
usermod -aG sudo brickadia

# become this user, navigate to user's home, and run bash
su brickadia -c "cd && bash"

# if you were root, you would be in /root (root's home) instead of /home/brickadia
# this fixes some issues when installing omegga on a VPS