Installation

1. Installation#

The easiest way to install OpenSim Creator is to download a prebuilt installer from the GitHub Releases Page.

OpenSim Creator is also regularly built from source using GitHub Actions, so if you want a bleeding-edge—but unreleased—build of OpenSim Creator, check out the GitHub Actions Page (note: you must be logged into GitHub to see artifact download links).

1.1. Installing on Windows (10 or newer)#

  • Download an installer exe from the GitHub Releases Page

  • Run the .exe, continue past any security warnings

  • Follow the familiar next, next, finish installation wizard

  • Run OpenSim Creator by typing OpenSim Creator in your start menu, or browse to its installation location (defaults to C:\Program Files\OpenSimCreator\).

1.2. Installing on MacOS (Ventura or newer)#

  • Download a dmg-based installer from the GitHub Releases Page

  • Double click the dmg file to mount it

  • Drag the osc icon into your Applications directory

  • Browse to the Applications directory in the MacOS Finder directory

  • Right-click the osc application, click open, continue past any security warnings to run osc for the first time

  • After running it the first time, you can boot it as normal (e.g. Command+Space, osc, Enter)

Note

You may need to right-click the osc application to open it twice.

The reason why is because MacOS _really_ doesn’t like running unsigned binaries, but the OpenSim Creator project is too cheap to join the Apple developer program.

1.3. Installing on Ubuntu (20 or newer)#

  • Download a deb-based installer from the GitHub Releases Page

  • Double-click the .deb package and install it through your package manager UI.

  • Alternatively, you can install the deb file through the command line with:

    apt-get install -yf ~/Downloads/osc-X.X.X_amd64.deb # or similar

  • Once installed, the osc or OpenSim Creator shortcuts should be available from your desktop, or you can browse to the installation location (/opt/osc)

1.4. Building from Source#

See Building From Source for an explanation of how to do this.