Omu Dev Environment Setup

Ever wanted to dive into the codebase of Omu or run a localhost but didn’t know how to?

Setting up a dev env can be a bit of a headache, so here’s a quick and dirty guide to getting everything up and running.

mwAlwarmrrrAwwlurrl wlmwarwurlMurmwAlwar mwaraarrrmAaArmwAlwarmwrrr wlAmurwlAmurwrlurllmwarmwrrr mwAlwaruuRlmmrmwAlwarmlwar wurlMurwlAmurmAaAr mlarwrurrlmwrrrmrrrAwmar uuRlmmrwlurrlmaaAr arrmawmwrrr lmwarlmwarwlurrl mwrrrmrrrAwmaruuRlmmr aarrrmaaArwlAmuruuRlmmrwrlurll mwaarrwurlMur mlwarmlarmwrrrmlar mlararrmawmwAlwarwlmwarwlurrl mmarwurlMurmmarAlwuRmlmwar mrrrAwmlar wlurrlwlAmur wlurrlwrlurllaarrrmarmlwar aarrrmlwaruuRlmmrmlwar.

> This is mostly a Windows tutorial, but if you’re on Linux, I’m sure you already know how to tweak all commands.

Translated from Marish

There is also an official guide here.

TL;DR

wlAmurmaaArwlmwar wlmwarmar lmwarwurlMurmrrrAw wlarrullmwarAlwuRmuuRlmmrmwaarr arrmawwrlurll aarrrmAaArAlwuRm marmrrrAw mrrrAwmwarwlarrul wlurrlwrlurllarrmaw.

> There is a full tutorial further down the page.

Translated from Marish

Initial Setup

1. Open Powershell

2. Run the following commands and follow the instructions:

   initial_setup.ps1

   winget install Git.Git
   winget install Python.Python.3.13
   winget install Microsoft.DotNet.SDK.9

3. Close Powershell

4. Open Powershell again

5. Run the following commands:

   clone_repo.ps1

   cd ~
   git clone https://github.com/ProjectOmu/OmuStation.git

6. Open the OmuStation folder inside your home directory

7. Double click on RUN_THIS

Start Server and Client

1. Double click on runserver (The Windows Batch File, not the Shell Script) and wait until it’s up
2. Double click on runclient (The Windows Batch File, not the Shell Script)

Update the Project

1. Open Powershell
2. Run the following commands:

   update_repo.ps1

   cd ~/OmuStation
   git pull

Full Tutorial

1. Open Powershell
   

2. Type the following into it to install git then press enter:

   install_git.ps1

   winget install Git.Git

   
   It’ll ask you if you agree, press y.
   
   Then wait for the admin prompt and press yes in there as well.
   
   
   Then Wait until it’s done.
   

3. Repeat the same thing with python:

   install_python.ps1

   winget install Python.Python.3.13

   

4. Repeat the same thing again with the dotnet sdk:
   

   install_dotnet.ps1

   winget install Microsoft.DotNet.SDK.9

   This will show an admin prompt again, click yes then wait until it’s done installing.

5. Close Powershell

6. Reopen Powershell

7. Change the directory to your home directory by typing the following text into the powershell window and then press enter:

   change_directory.ps1

   cd ~

   

8. Then run the following to download the server files:

   clone_repo.ps1

   git clone https://github.com/ProjectOmu/OmuStation.git

   

9. Then open the OmuStation folder in your home directory:
   

10. Double click RUN_THIS:
    
    This should open a new powershell window and close after a while again.
    

11. Double click on runserver (Make sure it’s the Windows Batch File, not the Shell Script)
    
    Another Powershell window should open, it should build and run the server:
    
    Wait until this is done, this is when the text changes to the actual games server:
    

12. Double click on runclient (Make sure it’s the Windows Batch File, not the Shell Script)
    
    Wait until the game launches, then click connect and you’re in