Installation

Installing Omegga

Contents

• Install
• WSL
• WSL2 Networking

Check out Running Omegga when it's installed!

Install

You can run omegga in the Windows Subsystem for Linux (I recommend Ubuntu or Debian) or on an actual linux install.

Do not install omegga or run brickadia/omegga as root/superuser

Quick Setup (automatically download launcher)

1. Install linux if you haven't already (Windows Install)

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

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
. ~/.nvm/nvm.sh
nvm install 14
npm i -g omegga

Then head over to Running Omegga!

Manual Setup (you install stuff)

Omegga depends on:

• Linux
  • Windows Install (WSL 1 or WSL 2)
    • Windows Ubuntu
• Node v14+ (ubuntu/deb)
  • nvm makes installing node very easy.
• One of:
  • tar (most linuxes come with this, though you can sudo apt install tar)
  • Brickadia linux launcher
    • Note: Brickadia launcher 1.5 does not work in WSL1.

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

# point development omegga to global npm bin, lets you run `omegga` as a CLI command
npm link

# build the web ui (once)
npm run dist

Check out Running Omegga when it's installed!

WSL

These are simple instructions to get Windows System for Linux installed.

Note: WSL 2 at the moment requires the wsl2binds plugin. You can install it with omegga install gh:Meshiest/wsl2binds

To enable WSL, run this in powershell as an administrator:

dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart

Then in the Microsoft Store, download a linux:

• Ubuntu

More Advanced Instructions here if the above is not sufficient.

If you're getting an EACCES error when running npm i -g omegga in WSL 1

1. Set your WSL to WSL 2
2. npm i -g omegga in wsl2
3. Set your WSL back to WSL 1

To set WSL version from 2 to 1:

1. Check WSL version with wsl -l -v in cmd
2. In Administator cmd, run wsl --set-version <distribution name> 1 where <distribution name> is Ubuntu, Debian, etc. (From the NAME section of the previous command)

WSL2 Networking

WSL2 has its own network. The wsl2binds plugin (omegga install gh:Meshiest/wsl2binds) automatically forwards UDP traffic to the server. It will print out the netsh command you will need to run for the Web UI to work properly.