Installing Ornithe

From Ornithe Wiki
Jump to navigation Jump to search

This guide will only cover installing Ornithe to the Official Minecraft launcher, MultiMC and its derivatives such as PrismLauncher and for a dedicated server. Other launchers may also allow for an automated installation, however as of 2025-04-23 we are not aware of any.

1. Download the installer

Head to our website at https://ornithemc.net/download and grab the installer for your platform. Should the native installer not be available for your platform or not work for you, follow the steps at § Addendum: Using the java-based installer.

2. Installation

Depending on your target environment, this step changes slightly.

2.1. Official Launcher

Due to the difficulties around managing multiple instances using the official launcher its usage in modded scenarios is generally discouraged.

Before starting, make sure that both your game and the launcher are closed.

2.1.1. GUI Installation
  • Select the "Client(Official Launcher)" environment
  • Choose your desired Minecraft version. You might need to enable the "Snapshots" checkbox to choose non-release versions or the "Historical Versions" checkbox to show versions before 1.0.0.
  • Choose your desired loader and loader version. If you're uncertain it's fine to leave it at its defaults of the latest version of Fabric loader.
  • Choose the installation location. This directory should be your .minecraft directory. The Installer will default to the default location, so if you haven't changed anything it should also be fine to leave as-is.
  • The Installer will generate a new profile for Ornithe by default. This behavior can be disabled by unchecking this checkbox.

Now, click "Install", wait for your installation to complete and enjoy the game.

2.1.2. CLI Installation

The CLI offers the same functionality as the Gui. To install for the official launcher, use the client subcommand. Then, add your desired minecraft version as an argument.

$ ornithe-installer-rs client --minecraft-version VERSION

Example:

$ ornithe-installer-rs client --minecraft-version 1.7.2

The --minecraft-version argument may also be shortened to -m.

Additional arguments for other options are available as well:

  • Loader type: --loader-type <TYPE>
  • Loader version: --loader-version <VERSION>
  • Installation directory: -d --dir <DIR>
  • Whether to generate a profile: -p --generate-profile <VALUE>

2.2. MultiMC/PrismLauncher

PrismLauncher is the recommended launcher for Ornithe.

2.2.1. GUI Installation
  • Select the "MultiMC/PrismLauncher" environment
  • Choose your desired Minecraft version. You might need to enable the "Snapshots" checkbox to choose non-release versions or the "Historical Versions" checkbox to show versions before 1.0.0.
  • Choose your desired loader and loader version. If you're uncertain it's fine to leave it at its defaults of the latest version of Fabric loader.
  • Choose the installation location. By default, the installer will output a zip file for your instance into this directory. However, if you have unselected "Generate Instance Zip" this directory should be your launcher's instances directory.

Now, click "Install".

If you generated an instance zip, import it into your launcher, for example by dragging it onto it. Otherwise, restart your launcher for it to reload the instance list.

2.2.2. CLI Installation

The CLI offers the same functionality as the Gui. To install for MultiMC or its derivatives, use the mmc subcommand (or its alias, prism). Then, add your desired minecraft version as an argument.

$ ornithe-installer-rs mmc --minecraft-version VERSION

Example:

$ ornithe-installer-rs mmc --minecraft-version 1.7.2

The --minecraft-version argument may also be shortened to -m.

Additional arguments for other options are available as well:

  • Loader type: --loader-type <TYPE>
  • Loader version: --loader-version <VERSION>
  • Installation directory: -d --dir <DIR>
  • Whether to generate a profile zip: -z --generate-zip <VALUE>
  • Whether to copy the output path to the clipboard: -c --copy-profile-path <VALUE>

2.3. Server

Most likely, your server will not have a graphical environment so you should skip ahead to the Cli Installation.

2.3.1. GUI Installation
  • Select the "Server" environment
  • Choose your desired Minecraft version. You might need to enable the "Snapshots" checkbox to choose non-release versions or the "Historical Versions" checkbox to show versions before 1.0.0.
  • Choose your desired loader and loader version. If you're uncertain it's fine to leave it at its defaults of the latest version of Fabric loader.
  • Choose the installation location. By default, the installer will install into a new server sub-directory in the current directory.
  • If "Download Minecraft Server" is checked, the installer will download the server jar for you. Otherwise, you will have to download it yourself.

Now, click "Install".

You can then start your server with either

java -jar fabric-server-launch.jar nogui

if you selected the Fabric Loader, or

java -jar quilt-server-launch.jar nogui

if you chose the Quilt Loader.

2.3.2. CLI Installation

The CLI generally offers the same functionality as the Gui, with the main addition being the bootstrap functionality. For this, see § 2.3.3. Install & Run (CLI). To install a server, use the server subcommand. Then, add your desired minecraft version as an argument.

$ ornithe-installer-rs server --minecraft-version VERSION

Example:

$ ornithe-installer-rs server --minecraft-version 1.7.2

The --minecraft-version argument may also be shortened to -m.

Additional arguments for other options are available as well:

  • Loader type: --loader-type <TYPE>
  • Loader version: --loader-version <VERSION>
  • Installation directory: -d --dir <DIR>
  • Whether to download the minecraft server jar: --download-minecraft
2.3.3. Install & Run (CLI)

For this, the installer serves as a server bootstrap and the run subcommand of the server subcommand is used.

$ ornithe-installer-rs server --minecraft-version VERSION run

Example:

$ ornithe-installer-rs server --minecraft-version 1.7.2 run

In addition to the arguments available for the server subcommand, additional arguments are available for the run subcommand:

  • Java arguments to pass to the server: --args <ARGS>
  • Java binary to use to start the server: --java <PATH>

The --download-minecraft flag is not applicable and always enabled when the run subcommand is used.

Then, your server will be installed automatically and started afterwards.

Addendum: Using the java-based installer

// TODO