Ornithe Wiki - User contributions [en]

Installing Ornithe

2026-04-08T10:39:09Z

Owlsys: Only mention PrismLauncher as we no longer support MultiMC

This guide will only cover installing Ornithe to the Official Minecraft launcher, 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.

=== Starting the installer ===

==== Download ====

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 the web version ([[Installing Ornithe#Web]]) may work. Alternatively, follow the steps at [[Installing Ornithe#Addendum: Using the java-based installer|§ Addendum: Using the java-based installer]].

==== Web ====

The native installer is also available at https://ornithemc.net/ornithe-installer-rs. The web version offers the same functionality as the downloadable binary, but results are always provided in a zip file. As such, the location selector is absent.
If you're using the official launcher and need the installer to create a profile for you use the downloadable version.

The steps for the GUI installation are the same as for the
downloadable version. In the case of the official launcher however as we cannot write into the user's filesystem directly, the zip file has to be extracted into the launcher's <code>versions</code> directory manually.

=== Installation ===

Depending on your target environment, this step changes slightly.

==== 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.

===== 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 <code>.minecraft</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for the official launcher, use the <code>client</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== PrismLauncher ====

PrismLauncher is the recommended launcher for Ornithe.

===== GUI Installation =====

* Select the "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 <code>instances</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for PrismLauncher, use the <code>prism</code> subcommand. Then, add your desired minecraft version as an argument.

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

Example:
$ ornithe-installer-rs prism --minecraft-version 1.7.2

The <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== Server ====

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

===== 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 <code>server</code> 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.

===== CLI Installation =====

The CLI generally offers the same functionality as the Gui, with the main addition being the bootstrap functionality. For this, see [[Installing Ornithe#Install & Run (CLI)|§ Install & Run (CLI)]]. To install a server, use the <code>server</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to download the minecraft server jar: <code>--download-minecraft</code>

===== Install & Run (CLI) =====

For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> 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 <code>server</code> subcommand, additional arguments are available for the <code>run</code> subcommand:

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

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

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

==== Addendum: Installing a non-stable intermediary generation (Advanced) ====

This option is exclusive to the CLI.

By appending the argument <code>--gen VERSION</code> it is possible to install any generation of calamus that is available on Ornithe's meta server. This flag can be passed to any of the <code>client</code>, <code>prism</code>, <code>server</code>, <code>game-versions</code> and <code>loader-versions</code> subcommands.

The latest and the currently stable version can be seen at https://meta.ornithemc.net/v3/versions/intermediary_generations.

Example:
$ ornithe-installer-rs game-versions --gen 2

==== Addendum: Excluding Flap from an installation ====

[[Flap]] allows using mods that were compiled for different intermediaries and is included in installations by default. Should this however not be desired, as for example in the context of Speedrunning where any modifications are heavily controlled, an option to disable this behavior is available.

===== GUI =====

Disable the Checkbox "Include Flap".

===== CLI =====

Add the flag <code>--exclude-flap</code>.

Note: For users of the server bootstrap feature ([[Installing Ornithe#Install & Run (CLI)|§ Install & Run (CLI)]]) this flag has to be passed ''before'' the <code>run</code> subcommand/flag.

=== Addendum: Using the java-based installer ===

// TODO

Installing Ornithe

2026-04-02T12:53:41Z

Owlsys: Add section about the web version of the native installer

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.

=== Starting the installer ===

==== Download ====

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 the web version ([[Installing Ornithe#Web]]) may work. Alternatively, follow the steps at [[Installing Ornithe#Addendum: Using the java-based installer|§ Addendum: Using the java-based installer]].

==== Web ====

The native installer is also available at https://ornithemc.net/ornithe-installer-rs. The web version offers the same functionality as the downloadable binary, but results are always provided in a zip file. As such, the location selector is absent.
If you're using the official launcher and need the installer to create a profile for you use the downloadable version.

The steps for the GUI installation are the same as for the
downloadable version. In the case of the official launcher however as we cannot write into the user's filesystem directly, the zip file has to be extracted into the launcher's <code>versions</code> directory manually.

=== Installation ===

Depending on your target environment, this step changes slightly.

==== 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.

===== 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 <code>.minecraft</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for the official launcher, use the <code>client</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== MultiMC/PrismLauncher ====

PrismLauncher is the recommended launcher for Ornithe.

===== 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 <code>instances</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for MultiMC or its derivatives, use the <code>mmc</code> subcommand (or its alias, <code>prism</code>). 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== Server ====

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

===== 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 <code>server</code> 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.

===== CLI Installation =====

The CLI generally offers the same functionality as the Gui, with the main addition being the bootstrap functionality. For this, see [[Installing Ornithe#Install & Run (CLI)|§ Install & Run (CLI)]]. To install a server, use the <code>server</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to download the minecraft server jar: <code>--download-minecraft</code>

===== Install & Run (CLI) =====

For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> 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 <code>server</code> subcommand, additional arguments are available for the <code>run</code> subcommand:

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

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

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

==== Addendum: Installing a non-stable intermediary generation (Advanced) ====

This option is exclusive to the CLI.

By appending the argument <code>--gen VERSION</code> it is possible to install any generation of calamus that is available on Ornithe's meta server. This flag can be passed to any of the <code>client</code>, <code>mmc</code>, <code>server</code>, <code>game-versions</code> and <code>loader-versions</code> subcommands.

The latest and the currently stable version can be seen at https://meta.ornithemc.net/v3/versions/intermediary_generations.

Example:
$ ornithe-installer-rs game-versions --gen 2

==== Addendum: Excluding Flap from an installation ====

[[Flap]] allows using mods that were compiled for different intermediaries and is included in installations by default. Should this however not be desired, as for example in the context of Speedrunning where any modifications are heavily controlled, an option to disable this behavior is available.

===== GUI =====

Disable the Checkbox "Include Flap".

===== CLI =====

Add the flag <code>--exclude-flap</code>.

Note: For users of the server bootstrap feature ([[Installing Ornithe#Install & Run (CLI)|§ Install & Run (CLI)]]) this flag has to be passed ''before'' the <code>run</code> subcommand/flag.

=== Addendum: Using the java-based installer ===

// TODO

Ornithe Installer

2026-04-01T19:04:55Z

Owlsys: Add details about wasm version, remove details about MultiMC as we no longer support it

The Ornithe Installer serves a few purposes:

* Installing a profile into the vanilla (official) launcher
* Generating an instance for PrismLauncher
* Installing (& optionally starting) a server

For this, two different UIs are offered:

* an [https://crates.io/crates/egui egui]-based GUI
* an extensive CLI

=== GUI ===
[[File:Screenshot 20250421 191013.png|alt=Screenshot of the installer GUI, with the "Client" page selected. All options are at their default values. No Minecraft version is selected, the loader is set to "Fabric Loader" with version 0.16.4. The install location is "~/.minecraft", and "Generate Profile" is checked.|thumb|Installer GUI on the "Client" page]]
The GUI is a convenient way to quickly install ornithe on a desktop computer.

All operations are done in a graphical way, the general behavior mimicking the older,
java-based installers of Fabric & Quilt.

=== CLI ===
The CLI is an easy-to-use and intuitive interface when a graphical environment is not available.

The CLI features all options present in the GUI and additionally includes the ability to not only install,

but also directly launch a modded server. This allows the installer to serve as a server bootstrap.

Help:
Usage: ornithe-installer-rs [COMMAND]

Commands:
client, --client
Client installation for the official launcher
prism, --prism
Generate an instance for PrismLauncher
server, --server
Server installation
game-versions, --list-game-versions
List supported game versions. Arguments: [--show-snapshots, --show-historical]
loader-versions, --list-loader-versions
List available loader versions. Arguments: [--show-betas, --loader-type]
intermediary-generations, --intermediary-generations
List the latest & stable intermediary (Calamus) generations
help
Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version

'''Client''' subcommand:
Usage: ornithe-installer-rs {client|--client} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Installation directory [default: ~/.minecraft]
-p, --generate-profile <VALUE> Whether to generate a launch profile [default: true] [possible values: true, false]
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
--exclude-flap Do not include Flap (Cross-Intermediary Remapper)
-h, --help Print help

'''Prism''' subcommand:

Usage: ornithe-installer-rs {prism|--prism} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Output directory [default: .]
-z, --generate-zip <VALUE> Whether to generate an instance zip instead of installing into the directory [default: true] [possible values: true, false]
-c, --copy-profile-path <VALUE> Whether to copy the path of the generated profile to the clipboard [default: false] [possible values: true, false]
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
--exclude-flap Do not include Flap (Cross-Intermediary Remapper)
-h, --help Print help

'''Server''' subcommand:

Usage: ornithe-installer-rs {server|--server} [OPTIONS] --minecraft-version <VERSION> [COMMAND]

Commands:
run Install and run the server
help Print this message or the help of the given subcommand(s)

Options:
-d, --dir <DIR> Installation directory [default: ./server]
--download-minecraft Whether to download the minecraft server jar
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
--exclude-flap Do not include Flap (Cross-Intermediary Remapper)
-h, --help Print help

'''Run''' subcommand (only in combination with '''Server'''):

Usage: ornithe-installer-rs server --minecraft-version <VERSION> run [OPTIONS]

Options:
--args <ARGS> Java arguments to pass to the server (before the server jar)
--java <PATH> The java binary to use to run the server
-h, --help Print help

=== Web ===

As of version 0.4.0, the installer has gained the ability to compile to [https://webassembly.org/ WASM].
This version is automatically deployed to https://ornithemc.net/ornithe-installer-rs. The web version offers the same features as the downloadable binary,
however there are a few restrictions. As such, generated files are bundled in a zip file and then downloaded.
Additionally, operations modifying preexisting files are disabled and hidden because it is not possible for the web page to access them.

==== Web-CLI ====

The CLI can still be accessed in the web version and is controlled using query parameters. Keys are read as long-form arguments and then parsed like on the native version.

Example:
https://ornithemc.net/ornithe-installer-rs/?prism&minecraft-version=1.7.2
This URL will create and download a zip archive of the PrismLauncher instance which can then be imported into the launcher.

=== Legacy Java installer ===

Ornithe also still offers a legacy java-based installer. Forked from the Quilt installer, it is extended with ornithe-specific features such as loader type selection and MultiMC instance generation.
[[File:Ornithe Installer (Java, Client tab).png|thumb|alt=The older ornithe installer, on the client tab. All options are set to their default values: Minecraft version 1.14.4, Launcher type official, Loader type fabric, Loader version 0.16.4, Install location ~/.minecraft. The "Generate profile" checkbox is checked.|The older ornithe installer, on the client tab.]]

Installing Ornithe

2026-03-15T17:11:37Z

Owlsys: fix in-page links

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.

=== 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 [[Installing Ornithe#Addendum: Using the java-based installer|§ Addendum: Using the java-based installer]].

=== Installation ===

Depending on your target environment, this step changes slightly.

==== 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.

===== 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 <code>.minecraft</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for the official launcher, use the <code>client</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== MultiMC/PrismLauncher ====

PrismLauncher is the recommended launcher for Ornithe.

===== 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 <code>instances</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for MultiMC or its derivatives, use the <code>mmc</code> subcommand (or its alias, <code>prism</code>). 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== Server ====

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

===== 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 <code>server</code> 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.

===== CLI Installation =====

The CLI generally offers the same functionality as the Gui, with the main addition being the bootstrap functionality. For this, see [[Installing Ornithe#Install & Run (CLI)|§ Install & Run (CLI)]]. To install a server, use the <code>server</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to download the minecraft server jar: <code>--download-minecraft</code>

===== Install & Run (CLI) =====

For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> 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 <code>server</code> subcommand, additional arguments are available for the <code>run</code> subcommand:

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

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

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

==== Addendum: Installing a non-stable intermediary generation (Advanced) ====

This option is exclusive to the CLI.

By appending the argument <code>--gen VERSION</code> it is possible to install any generation of calamus that is available on Ornithe's meta server. This flag can be passed to any of the <code>client</code>, <code>mmc</code>, <code>server</code>, <code>game-versions</code> and <code>loader-versions</code> subcommands.

The latest and the currently stable version can be seen at https://meta.ornithemc.net/v3/versions/intermediary_generations.

Example:
$ ornithe-installer-rs game-versions --gen 2

==== Addendum: Excluding Flap from an installation ====

[[Flap]] allows using mods that were compiled for different intermediaries and is included in installations by default. Should this however not be desired, as for example in the context of Speedrunning where any modifications are heavily controlled, an option to disable this behavior is available.

===== GUI =====

Disable the Checkbox "Include Flap".

===== CLI =====

Add the flag <code>--exclude-flap</code>.

Note: For users of the server bootstrap feature ([[Installing Ornithe#Install & Run (CLI)|§ Install & Run (CLI)]]) this flag has to be passed ''before'' the <code>run</code> subcommand/flag.

=== Addendum: Using the java-based installer ===

// TODO

Installing Ornithe

2026-03-15T17:06:16Z

Owlsys: Document excluding flap from installations

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.

=== 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 [[Installing Ornithe#Addendum: Using the java-based installer|§ Addendum: Using the java-based installer]].

=== Installation ===

Depending on your target environment, this step changes slightly.

==== 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.

===== 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 <code>.minecraft</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for the official launcher, use the <code>client</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== MultiMC/PrismLauncher ====

PrismLauncher is the recommended launcher for Ornithe.

===== 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 <code>instances</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for MultiMC or its derivatives, use the <code>mmc</code> subcommand (or its alias, <code>prism</code>). 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== Server ====

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

===== 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 <code>server</code> 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.

===== CLI Installation =====

The CLI generally offers the same functionality as the Gui, with the main addition being the bootstrap functionality. For this, see [[Installing Ornithe#2.3.3. Install & Run (CLI)|§ 2.3.3. Install & Run (CLI)]]. To install a server, use the <code>server</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to download the minecraft server jar: <code>--download-minecraft</code>

===== Install & Run (CLI) =====

For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> 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 <code>server</code> subcommand, additional arguments are available for the <code>run</code> subcommand:

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

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

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

==== Addendum: Installing a non-stable intermediary generation (Advanced) ====

This option is exclusive to the CLI.

By appending the argument <code>--gen VERSION</code> it is possible to install any generation of calamus that is available on Ornithe's meta server. This flag can be passed to any of the <code>client</code>, <code>mmc</code>, <code>server</code>, <code>game-versions</code> and <code>loader-versions</code> subcommands.

The latest and the currently stable version can be seen at https://meta.ornithemc.net/v3/versions/intermediary_generations.

Example:
$ ornithe-installer-rs game-versions --gen 2

==== Addendum: Excluding Flap from an installation ====

[[Flap]] allows using mods that were compiled for different intermediaries and is included in installations by default. Should this however not be desired, as for example in the context of Speedrunning where any modifications are heavily controlled, an option to disable this behavior is available.

===== GUI =====

Disable the Checkbox "Include Flap".

===== CLI =====

Add the flag <code>--exclude-flap</code>.

Note: For users of the [[Installing Ornithe#2.3.3. Install & Run (CLI)|server bootstrap]] this flag has to be passed ''before'' the <code>run</code> subcommand/flag.

=== Addendum: Using the java-based installer ===

// TODO

Ornithe Installer

2026-03-15T16:54:21Z

Owlsys: Update help section to reflect added `--exclude-flap` flag

The Ornithe Installer serves a few purposes:

* Installing a profile into the vanilla (official) launcher
* Generating an instance for MultiMC or MultiMC-based launchers
* Installing (& optionally starting) a server

For this, two different UIs are offered:

* an [https://crates.io/crates/egui egui]-based GUI
* an extensive CLI

=== GUI ===
[[File:Screenshot 20250421 191013.png|alt=Screenshot of the installer GUI, with the "Client" page selected. All options are at their default values. No Minecraft version is selected, the loader is set to "Fabric Loader" with version 0.16.4. The install location is "~/.minecraft", and "Generate Profile" is checked.|thumb|Installer GUI on the "Client" page]]
The GUI is a convenient way to quickly install ornithe on a desktop computer.

All operations are done in a graphical way, the general behavior mimicking the older,
java-based installers of Fabric & Quilt.

=== Cli ===
The CLI is an easy-to-use and intuitive interface when a graphical environment is not available.

The CLI features all options present in the GUI and additionally includes the ability to not only install,

but also directly launch a modded server. This allows the installer to serve as a server bootstrap.

Help:
Usage: ornithe-installer-rs [COMMAND]

Commands:
client, --client
Client installation for the official launcher
mmc, --mmc
Generate an instance for MultiMC/PrismLauncher [aliases: prism]
server, --server
Server installation
game-versions, --list-game-versions
List supported game versions. Arguments: [--show-snapshots, --show-historical]
loader-versions, --list-loader-versions
List available loader versions. Arguments: [--show-betas, --loader-type]
intermediary-generations, --intermediary-generations
List the latest & stable intermediary (Calamus) generations
help
Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version

'''Client''' subcommand:
Usage: ornithe-installer-rs {client|--client} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Installation directory [default: ~/.minecraft]
-p, --generate-profile <VALUE> Whether to generate a launch profile [default: true] [possible values: true, false]
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
--exclude-flap Do not include Flap (Cross-Intermediary Remapper)
-h, --help Print help

'''Mmc''' subcommand:

Usage: ornithe-installer-rs {mmc|--mmc} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Output directory [default: .]
-z, --generate-zip <VALUE> Whether to generate an instance zip instead of installing into the directory [default: true] [possible values: true, false]
-c, --copy-profile-path <VALUE> Whether to copy the path of the generated profile to the clipboard [default: false] [possible values: true, false]
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
--exclude-flap Do not include Flap (Cross-Intermediary Remapper)
-h, --help Print help

'''Server''' subcommand:

Usage: ornithe-installer-rs {server|--server} [OPTIONS] --minecraft-version <VERSION> [COMMAND]

Commands:
run Install and run the server
help Print this message or the help of the given subcommand(s)

Options:
-d, --dir <DIR> Installation directory [default: ./server]
--download-minecraft Whether to download the minecraft server jar
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
--exclude-flap Do not include Flap (Cross-Intermediary Remapper)
-h, --help Print help

'''Run''' subcommand (only in combination with '''Server'''):

Usage: ornithe-installer-rs server --minecraft-version <VERSION> run [OPTIONS]

Options:
--args <ARGS> Java arguments to pass to the server (before the server jar)
--java <PATH> The java binary to use to run the server
-h, --help Print help

=== Legacy Java installer ===

Ornithe also still offers a legacy java-based installer. Forked from the Quilt installer, it is extended with ornithe-specific features such as loader type selection and MultiMC instance generation.
[[File:Ornithe Installer (Java, Client tab).png|thumb|alt=The older ornithe installer, on the client tab. All options are set to their default values: Minecraft version 1.14.4, Launcher type official, Loader type fabric, Loader version 0.16.4, Install location ~/.minecraft. The "Generate profile" checkbox is checked.|The older ornithe installer, on the client tab.]]

Flap

2026-03-14T11:35:48Z

Owlsys: Create page for Flap

Flap is a javaagent allowing for pre-launch cross-intermediary remapping of mods.

=== Installation ===

Flap is currently shipped by the native [[Ornithe Installer]] by default. It is not included by the java-based installer as of 2026-03-14.

=== Supported Intermediaries ===

Flap supports the following intermediary variants out of the box:

* Official (Upstream Fabric)
* LegacyFabric (Version 1 & Version 2)
* Babric (Old Format & New Format)
* Ornithe (Version 1 & Version 2)
* Antiquity (obfuscated)

=== Configuration ===

Should Flap not detect a mod's variant correctly it is possible to override it.

==== Config File ====

Flap will read a config file at <code>config/flap/mod_variants.json</code>

Example:

{
"modid": "ORNITHE_V2"
}

==== JVM Properties ====

Flap will also check system properties at <code>flap.intermediary_variant_fallback.modid</code>.

Example:

-Dflap.intermediary_variant_fallback.modid=ORNITHE_V2

Installing Ornithe

2026-03-14T11:15:46Z

Owlsys: add example to using unstable intermediary generations

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.

=== 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 [[Installing Ornithe#Addendum: Using the java-based installer|§ Addendum: Using the java-based installer]].

=== Installation ===

Depending on your target environment, this step changes slightly.

==== 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.

===== 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 <code>.minecraft</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for the official launcher, use the <code>client</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== MultiMC/PrismLauncher ====

PrismLauncher is the recommended launcher for Ornithe.

===== 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 <code>instances</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for MultiMC or its derivatives, use the <code>mmc</code> subcommand (or its alias, <code>prism</code>). 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== Server ====

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

===== 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 <code>server</code> 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.

===== CLI Installation =====

The CLI generally offers the same functionality as the Gui, with the main addition being the bootstrap functionality. For this, see [[Installing Ornithe#2.3.3. Install & Run (CLI)|§ 2.3.3. Install & Run (CLI)]]. To install a server, use the <code>server</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to download the minecraft server jar: <code>--download-minecraft</code>

===== Install & Run (CLI) =====

For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> 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 <code>server</code> subcommand, additional arguments are available for the <code>run</code> subcommand:

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

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

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

==== Addendum: Installing a non-stable intermediary generation (Advanced) ====

This option is exclusive to the CLI.

By appending the argument <code>--gen VERSION</code> it is possible to install any generation of calamus that is available on Ornithe's meta server. This flag can be passed to any of the <code>client</code>, <code>mmc</code>, <code>server</code>, <code>game-versions</code> and <code>loader-versions</code> subcommands.

The latest and the currently stable version can be seen at https://meta.ornithemc.net/v3/versions/intermediary_generations.

Example:
$ ornithe-installer-rs game-versions --gen 2

=== Addendum: Using the java-based installer ===

// TODO

Installing Ornithe

2026-02-17T19:55:34Z

Owlsys: Add missing subcommands to docs for --gen argument

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.

=== 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 [[Installing Ornithe#Addendum: Using the java-based installer|§ Addendum: Using the java-based installer]].

=== Installation ===

Depending on your target environment, this step changes slightly.

==== 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.

===== 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 <code>.minecraft</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for the official launcher, use the <code>client</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== MultiMC/PrismLauncher ====

PrismLauncher is the recommended launcher for Ornithe.

===== 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 <code>instances</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for MultiMC or its derivatives, use the <code>mmc</code> subcommand (or its alias, <code>prism</code>). 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== Server ====

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

===== 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 <code>server</code> 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.

===== CLI Installation =====

The CLI generally offers the same functionality as the Gui, with the main addition being the bootstrap functionality. For this, see [[Installing Ornithe#2.3.3. Install & Run (CLI)|§ 2.3.3. Install & Run (CLI)]]. To install a server, use the <code>server</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to download the minecraft server jar: <code>--download-minecraft</code>

===== Install & Run (CLI) =====

For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> 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 <code>server</code> subcommand, additional arguments are available for the <code>run</code> subcommand:

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

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

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

==== Addendum: Installing a non-stable intermediary generation (Advanced) ====

This option is exclusive to the CLI.

By appending the argument <code>--gen VERSION</code> it is possible to install any generation of calamus that is available on Ornithe's meta server. This flag can be passed to any of the <code>client</code>, <code>mmc</code>, <code>server</code>, <code>game-versions</code> and <code>loader-versions</code> subcommands.
The latest and the currently stable version can be seen at https://meta.ornithemc.net/v3/versions/intermediary_generations.

=== Addendum: Using the java-based installer ===

// TODO

Installing Ornithe

2026-02-13T22:30:32Z

Owlsys: Add section about installing non-stable intermediary generations

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.

=== 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 [[Installing Ornithe#Addendum: Using the java-based installer|§ Addendum: Using the java-based installer]].

=== Installation ===

Depending on your target environment, this step changes slightly.

==== 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.

===== 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 <code>.minecraft</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for the official launcher, use the <code>client</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== MultiMC/PrismLauncher ====

PrismLauncher is the recommended launcher for Ornithe.

===== 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 <code>instances</code> 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.

===== CLI Installation =====

The CLI offers the same functionality as the Gui. To install for MultiMC or its derivatives, use the <code>mmc</code> subcommand (or its alias, <code>prism</code>). 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== Server ====

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

===== 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 <code>server</code> 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.

===== CLI Installation =====

The CLI generally offers the same functionality as the Gui, with the main addition being the bootstrap functionality. For this, see [[Installing Ornithe#2.3.3. Install & Run (CLI)|§ 2.3.3. Install & Run (CLI)]]. To install a server, use the <code>server</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to download the minecraft server jar: <code>--download-minecraft</code>

===== Install & Run (CLI) =====

For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> 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 <code>server</code> subcommand, additional arguments are available for the <code>run</code> subcommand:

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

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

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

==== Addendum: Installing a non-stable intermediary generation (Advanced) ====

This option is exclusive to the CLI.

By appending the argument <code>--gen VERSION</code> it is possible to install any generation of calamus that is available on Ornithe's meta server. This flag can be passed to any of the <code>client</code>, <code>mmc</code> and <code>server</code> subcommands.
The latest and the currently stable version can be seen at https://meta.ornithemc.net/v3/versions/intermediary_generations.

=== Addendum: Using the java-based installer ===

// TODO

Ornithe Installer

2026-01-29T21:34:19Z

Owlsys: Fix help formatting

The Ornithe Installer serves a few purposes:

* Installing a profile into the vanilla (official) launcher
* Generating an instance for MultiMC or MultiMC-based launchers
* Installing (& optionally starting) a server

For this, two different UIs are offered:

* an [https://crates.io/crates/egui egui]-based GUI
* an extensive CLI

=== GUI ===
[[File:Screenshot 20250421 191013.png|alt=Screenshot of the installer GUI, with the "Client" page selected. All options are at their default values. No Minecraft version is selected, the loader is set to "Fabric Loader" with version 0.16.4. The install location is "~/.minecraft", and "Generate Profile" is checked.|thumb|Installer GUI on the "Client" page]]
The GUI is a convenient way to quickly install ornithe on a desktop computer.

All operations are done in a graphical way, the general behavior mimicking the old,

java-based installers of Fabric & Quilt.

=== Cli ===
The CLI is an easy-to-use and intuitive interface when a graphical environment is not available.

The CLI features all options present in the GUI and additionally includes the ability to not only install,

but also directly launch a modded server. This allows the installer to serve as a server bootstrap.

Help:
Usage: ornithe-installer-rs [COMMAND]

Commands:
client, --client
Client installation for the official launcher
mmc, --mmc
Generate an instance for MultiMC/PrismLauncher [aliases: prism]
server, --server
Server installation
game-versions, --list-game-versions
List supported game versions. Arguments: [--show-snapshots, --show-historical]
loader-versions, --list-loader-versions
List available loader versions. Arguments: [--show-betas, --loader-type]
intermediary-generations, --intermediary-generations
List the latest & stable intermediary (Calamus) generations
help
Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version

'''Client''' subcommand:
Usage: ornithe-installer-rs {client|--client} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Installation directory [default: ~/.minecraft]
-p, --generate-profile <VALUE> Whether to generate a launch profile [default: true] [possible values: true, false]
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Mmc''' subcommand:

Usage: ornithe-installer-rs {mmc|--mmc} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Output directory [default: .]
-z, --generate-zip <VALUE> Whether to generate an instance zip instead of installing into the directory [default: true] [possible values: true, false]
-c, --copy-profile-path <VALUE> Whether to copy the path of the generated profile to the clipboard [default: false] [possible values: true, false]
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Server''' subcommand:

Usage: ornithe-installer-rs {server|--server} [OPTIONS] --minecraft-version <VERSION> [COMMAND]

Commands:
run Install and run the server
help Print this message or the help of the given subcommand(s)

Options:
-d, --dir <DIR> Installation directory [default: ./server]
--download-minecraft Whether to download the minecraft server jar
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Run''' subcommand (only in combination with '''Server'''):

Usage: ornithe-installer-rs server --minecraft-version <VERSION> run [OPTIONS]

Options:
--args <ARGS> Java arguments to pass to the server (before the server jar)
--java <PATH> The java binary to use to run the server
-h, --help Print help

=== Legacy Java installer ===

Ornithe also still offers a legacy java-based installer. Forked from the Quilt installer, it is extended with ornithe-specific features such as loader type selection and MultiMC instance generation.
[[File:Ornithe Installer (Java, Client tab).png|thumb|alt=The older ornithe installer, on the client tab. All options are set to their default values: Minecraft version 1.14.4, Launcher type official, Loader type fabric, Loader version 0.16.4, Install location ~/.minecraft. The "Generate profile" checkbox is checked.|The older ornithe installer, on the client tab.]]

Ornithe Installer

2026-01-29T21:32:49Z

Owlsys: Add help for gen cli argument

The Ornithe Installer serves a few purposes:

* Installing a profile into the vanilla (official) launcher
* Generating an instance for MultiMC or MultiMC-based launchers
* Installing (& optionally starting) a server

For this, two different UIs are offered:

* an [https://crates.io/crates/egui egui]-based GUI
* an extensive CLI

=== GUI ===
[[File:Screenshot 20250421 191013.png|alt=Screenshot of the installer GUI, with the "Client" page selected. All options are at their default values. No Minecraft version is selected, the loader is set to "Fabric Loader" with version 0.16.4. The install location is "~/.minecraft", and "Generate Profile" is checked.|thumb|Installer GUI on the "Client" page]]
The GUI is a convenient way to quickly install ornithe on a desktop computer.

All operations are done in a graphical way, the general behavior mimicking the old,

java-based installers of Fabric & Quilt.

=== Cli ===
The CLI is an easy-to-use and intuitive interface when a graphical environment is not available.

The CLI features all options present in the GUI and additionally includes the ability to not only install,

but also directly launch a modded server. This allows the installer to serve as a server bootstrap.

Help:
Usage: ornithe-installer-rs [COMMAND]

Commands:
client, --client
Client installation for the official launcher
mmc, --mmc
Generate an instance for MultiMC/PrismLauncher [aliases: prism]
server, --server
Server installation
game-versions, --list-game-versions
List supported game versions. Arguments: [--show-snapshots, --show-historical]
loader-versions, --list-loader-versions
List available loader versions. Arguments: [--show-betas, --loader-type]
intermediary-generations, --intermediary-generations
List the latest & stable intermediary (Calamus) generations
help
Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version

'''Client''' subcommand:
Usage: ornithe-installer-rs {client|--client} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Installation directory [default: ~/.minecraft]
-p, --generate-profile <VALUE> Whether to generate a launch profile [default: true] [possible values: true, false]
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Mmc''' subcommand:

Usage: ornithe-installer-rs {mmc|--mmc} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Output directory [default: .]
-z, --generate-zip <VALUE> Whether to generate an instance zip instead of installing into the directory [default: true] [possible values: true, false]
-c, --copy-profile-path <VALUE> Whether to copy the path of the generated profile to the clipboard [default: false] [possible values: true, false]
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Server''' subcommand:

Usage: ornithe-installer-rs {server|--server} [OPTIONS] --minecraft-version <VERSION> [COMMAND]

Commands:
run Install and run the server
help Print this message or the help of the given subcommand(s)

Options:
-d, --dir <DIR> Installation directory [default: ./server]
--download-minecraft Whether to download the minecraft server jar
--gen <GENERATION> The Intermediary Generation (Calamus)
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Run''' subcommand (only in combination with '''Server'''):

Usage: ornithe-installer-rs server --minecraft-version <VERSION> run [OPTIONS]

Options:
--args <ARGS> Java arguments to pass to the server (before the server jar)
--java <PATH> The java binary to use to run the server
-h, --help Print help

=== Legacy Java installer ===

Ornithe also still offers a legacy java-based installer. Forked from the Quilt installer, it is extended with ornithe-specific features such as loader type selection and MultiMC instance generation.
[[File:Ornithe Installer (Java, Client tab).png|thumb|alt=The older ornithe installer, on the client tab. All options are set to their default values: Minecraft version 1.14.4, Launcher type official, Loader type fabric, Loader version 0.16.4, Install location ~/.minecraft. The "Generate profile" checkbox is checked.|The older ornithe installer, on the client tab.]]

Main Page

2025-08-05T12:00:44Z

Owlsys: Add link to dev env setup page

== Welcome to the Ornithe Project Wiki! ==
This page is under construction, please be patient!

=== Introduction Guides ===

==== Using Ornithe ====

* [[Installing Ornithe]]

==== Developing for Ornithe ====

* [[Setting up a Mod Development Environment]]

Main Page

2025-06-07T19:28:27Z

Owlsys: Add introductory section

Ploceus

2025-05-29T17:41:18Z

Owlsys: Update Categorization to differentiate between Mod & Toolchain development

Ploceus is Ornithe's [https://wiki.fabricmc.net/documentation:fabric_loom Fabric Loom] plugin adding additional Ornithe-specific functionality.

* Using alternative version manifests by default
* Depending on [[Ornithe Standard Libraries|OSL]]
* Applying additional patches (Exceptions and LVTs for versions where they're stripped)
* Upgrading old libraries

=== Using Ploceus ===
The easiest option to make use of Ploceus is to start with [https://github.com/OrnitheMC/ornithe-template-mod Ornithe's Template Mod].

Should you need to add it to an already existing project these steps should cover your needs:

==== Adding Ornithe's maven repository for plugin resolution ====

<code>settings.gradle</code>
<code>settings.gradle</code>
pluginManagement {
repositories {
/* ... (Other repositories) */
maven { url = "https://maven.ornithemc.net/releases" }
maven { url = "https://maven.orntithemc.net/snapshots"
}
}

<code>settings.gradle.kts</code>
pluginManagement {
repositories {
/* ... (Other repositories) */
maven("https://maven.ornithemc.net/releases")
maven("https://maven.orntithemc.net/snapshots")
}
}

==== Apply the plugin ====

<code>build.gradle</code>
plugins {
/* ... (Other plugins) */
id "ploceus" version "<version>"
}

<code>build.gradle.kts</code>
plugins {
/* ... (Other plugins) */
id("ploceus") version "<version>"
}
[[Category:Mod Development]]

Ploceus

2025-05-29T17:26:23Z

Owlsys: Create Page

Installing Ornithe

2025-04-23T13:57:25Z

Owlsys: add instructions for historical versions checkbox

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 [[Installing Ornithe#Addendum: Using the java-based installer|§ 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 <code>.minecraft</code> 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 <code>client</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== 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 <code>instances</code> 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 <code>mmc</code> subcommand (or its alias, <code>prism</code>). 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== 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 <code>server</code> 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 [[Installing Ornithe#2.3.3. Install & Run (CLI)|§ 2.3.3. Install & Run (CLI)]]. To install a server, use the <code>server</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to download the minecraft server jar: <code>--download-minecraft</code>

===== 2.3.3. Install & Run (CLI) =====

For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> 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 <code>server</code> subcommand, additional arguments are available for the <code>run</code> subcommand:

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

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

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

=== Addendum: Using the java-based installer ===

// TODO

Installing Ornithe

2025-04-23T10:55:12Z

Owlsys: fix page links

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.

=== Step 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 [[Installing Ornithe#Addendum: Using the java-based installer|§ Addendum: Using the java-based installer]].

=== Step 2: Installation ===

Depending on your target environment, this step changes slightly.

==== Step 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.

===== Step 2.1.1: Gui Installation =====

* Select the "Client(Official Launcher)" environment
* Choose your desired Minecraft version. You might need to enable "Show Snapshots" to choose non-release versions.
* 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 <code>.minecraft</code> 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.

===== Step 2.1.2: Cli Installation =====

The Cli offers the same functionality as the Gui. To install for the official launcher, use the <code>client</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== Step 2.2: MultiMC/PrismLauncher ====

PrismLauncher is the recommended launcher for Ornithe.

===== Step 2.2.1: Gui Installation =====

* Select the "MultiMC/PrismLauncher" environment
* Choose your desired Minecraft version. You might need to enable "Show Snapshots" to choose non-release versions.
* 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 <code>instances</code> 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.

===== Step 2.2.2: Cli Installation =====

The Cli offers the same functionality as the Gui. To install for MultiMC or its derivatives, use the <code>mmc</code> subcommand (or its alias, <code>prism</code>). 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== Step 2.3: Server ====

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

===== Step 2.3.1: Gui Installation =====

* Select the "Server" environment
* Choose your desired Minecraft version. You might need to enable "Show Snapshots" to choose non-release versions.
* 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 <code>server</code> 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.

===== Step 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 [[Installing Ornithe#Step 2.3.3: Install & Run (Cli)|§ Step 2.3.3: Install & Run (Cli)]]. To install a server, use the <code>server</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to download the minecraft server jar: <code>--download-minecraft</code>

===== Step 2.3.3: Install & Run (Cli) =====

For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> 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 <code>server</code> subcommand, additional arguments are available for the <code>run</code> subcommand:

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

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

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

=== Addendum: Using the java-based installer ===

// TODO

Installing Ornithe

2025-04-23T10:51:19Z

Owlsys: Set up installation guide

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.

=== Step 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 {{Installing Ornithe#Addendum:_Using_the_java-based_installer|Installing Ornithe|Addendum: Using the java-based installer}}.

=== Step 2: Installation ===

Depending on your target environment, this step changes slightly.

==== Step 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.

===== Step 2.1.1: Gui Installation =====

* Select the "Client(Official Launcher)" environment
* Choose your desired Minecraft version. You might need to enable "Show Snapshots" to choose non-release versions.
* 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 <code>.minecraft</code> 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 un-checking this checkbox.

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

===== Step 2.1.2: Cli Installation =====

The Cli offers the same functionality as the Gui. To install for the official launcher, use the <code>client</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== Step 2.2: MultiMC/PrismLauncher ====

PrismLauncher is the recommended launcher for Ornithe.

===== Step 2.2.1: Gui Installation =====

* Select the "MultiMC/PrismLauncher" environment
* Choose your desired Minecraft version. You might need to enable "Show Snapshots" to choose non-release versions.
* 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 <code>instances</code> 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.

===== Step 2.2.2: Cli Installation =====

The Cli offers the same functionality as the Gui. To install for MultiMC or its derivatives, use the <code>mmc</code> subcommand (or its alias, <code>prism</code>). 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

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

==== Step 2.3: Server ====

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

===== Step 2.3.1: Gui Installation =====

* Select the "Server" environment
* Choose your desired Minecraft version. You might need to enable "Show Snapshots" to choose non-release versions.
* 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 <code>server</code> 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.

===== Step 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 {{Installing_Ornithe#Step_2.3.3:_Install_&_Run_(Cli)|Installing Ornithe|Install & Run}}. To install a server, use the <code>server</code> 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 <code>--minecraft-version</code> argument may also be shortened to <code>-m</code>.

Additional arguments for other options are available as well:

* Loader type: <code>--loader-type <TYPE></code>
* Loader version: <code>--loader-version <VERSION></code>
* Installation directory: <code>-d --dir <DIR></code>
* Whether to download the minecraft server jar: <code>--download-minecraft</code>

===== Step 2.3.3: Install & Run (Cli) =====

For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> 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 <code>server</code> subcommand, additional arguments are available for the <code>run</code> subcommand:

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

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

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

=== Addendum: Using the java-based installer ===

// TODO

Ornithe Installer

2025-04-22T07:45:04Z

Owlsys: Expand installer page with descriptions of GUI, CLI and java-based installer

The Ornithe Installer servers a few purposes:

* Installing a profile into the vanilla (official) launcher
* Generating an instance for MultiMC or MultiMC-based launchers
* Installing (& optionally starting) a server

For this, two different UIs are offered:

* an [https://crates.io/crates/egui egui]-based GUI
* an extensive CLI

=== Gui ===
[[File:Screenshot 20250421 191013.png|alt=Screenshot of the installer GUI, with the "Client" page selected. All options are at their default values. No Minecraft version is selected, the loader is set to "Fabric Loader" with version 0.16.4. The install location is "~/.minecraft", and "Generate Profile" is checked.|thumb|Installer GUI on the "Client" page]]
The GUI is a convenient way to quickly install ornithe on a desktop computer.

All operations are done in a graphical way, the general behavior mimicking the old,

java-based installers of Fabric & Quilt.

=== Cli ===
The CLI is an easy-to-use and intuitive interface when a graphical environment is not available.

The CLI features all options present in the GUI and additionally includes the ability to not only install,

but also directly launch a modded server. This allows the installer to serve as a server bootstrap.

Help:
Usage: ornithe-installer-rs [COMMAND]

Commands:
client, --client
Client installation for the official launcher
mmc, --mmc
Generate an instance for MultiMC/PrismLauncher [aliases: prism]
server, --server
Server installation
game-versions, --list-game-versions
List supported game versions
loader-versions, --list-loader-versions
List available loader versions
help
Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version

'''Client''' subcommand:
Usage: ornithe-installer-rs {client|--client} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Installation directory [default: ~/.minecraft]
-p, --generate-profile <VALUE> Whether to generate a launch profile [default: true] [possible values: true, false]
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Mmc''' subcommand:

Usage: ornithe-installer-rs {mmc|--mmc} [OPTIONS] --minecraft-version <VERSION>

Options:
-d, --dir <DIR> Output directory [default: .]
-z, --generate-zip <VALUE> Whether to generate an instance zip instead of installing into the directory [default: true] [possible values: true, false]
-c, --copy-profile-path <VALUE> Whether to copy the path of the generated profile to the clipboard [default: false] [possible values: true, false]
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Server''' subcommand:

Usage: ornithe-installer-rs {server|--server} [OPTIONS] --minecraft-version <VERSION> [COMMAND]

Commands:
run Install and run the server
help Print this message or the help of the given subcommand(s)

Options:
-d, --dir <DIR> Installation directory [default: ./server]
--download-minecraft Whether to download the minecraft server jar
-m, --minecraft-version <VERSION> Minecraft version to use
--loader-type <TYPE> Loader type to use [default: fabric] [possible values: fabric, quilt]
--loader-version <VERSION> Loader version to use [default: latest]
-h, --help Print help

'''Run''' subcommand (only in combination with '''Server'''):

Usage: ornithe-installer-rs server --minecraft-version <VERSION> run [OPTIONS]

Options:
--args <ARGS> Java arguments to pass to the server (before the server jar)
--java <PATH> The java binary to use to run the server
-h, --help Print help

=== Legacy Java installer ===

Ornithe also still offers a legacy java-based installer. Forked from the Quilt installer, it is extended with ornithe-specific features such as loader type selection and MultiMC instance generation.
[[File:Ornithe Installer (Java, Client tab).png|thumb|alt=The older ornithe installer, on the client tab. All options are set to their default values: Minecraft version 1.14.4, Launcher type official, Loader type fabric, Loader version 0.16.4, Install location ~/.minecraft. The "Generate profile" checkbox is checked.|The older ornithe installer, on the client tab.]]

File:Ornithe Installer (Java, Client tab).png

2025-04-22T07:36:40Z

Owlsys:

The older ornithe installer, on the client tab

File:Screenshot 20250421 191013.png

2025-04-22T07:14:10Z

Owlsys:

Screenshot of the installer GUI on the "Client" page.

Ornithe Installer

2025-04-21T17:08:38Z

Owlsys: Create Installer Page