Ornithe Installer

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 egui-based GUI
• an extensive CLI

GUI

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

The older ornithe installer, on the client tab.