Installing Ornithe: Difference between revisions
Jump to navigation
Jump to search
(Set up installation guide) |
Space Walker (talk | contribs) (remove chapter numbers as they are automatically assigned) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
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. | 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 | 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. | 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 | Due to the difficulties around managing multiple instances using the official launcher its usage in modded scenarios | ||
| Line 16: | Line 16: | ||
Before starting, make sure that both your game and the launcher are closed. | Before starting, make sure that both your game and the launcher are closed. | ||
===== | ===== GUI Installation ===== | ||
* Select the "Client(Official Launcher)" environment | * Select the "Client(Official Launcher)" environment | ||
* Choose your desired Minecraft version. You might need to enable " | * 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 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. | * 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 | * 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. | Now, click "Install", wait for your installation to complete and enjoy the game. | ||
===== | ===== CLI Installation ===== | ||
The | 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 | $ ornithe-installer-rs client --minecraft-version VERSION | ||
| Line 44: | Line 44: | ||
* Whether to generate a profile: <code>-p --generate-profile <VALUE></code> | * Whether to generate a profile: <code>-p --generate-profile <VALUE></code> | ||
==== | ==== MultiMC/PrismLauncher ==== | ||
PrismLauncher is the recommended launcher for Ornithe. | PrismLauncher is the recommended launcher for Ornithe. | ||
===== | ===== GUI Installation ===== | ||
* Select the "MultiMC/PrismLauncher" environment | * Select the "MultiMC/PrismLauncher" environment | ||
* Choose your desired Minecraft version. You might need to enable " | * 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 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. | * 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. | ||
| Line 60: | Line 60: | ||
Otherwise, restart your launcher for it to reload the instance list. | Otherwise, restart your launcher for it to reload the instance list. | ||
===== | ===== CLI Installation ===== | ||
The | 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 | $ ornithe-installer-rs mmc --minecraft-version VERSION | ||
| Line 79: | Line 79: | ||
* Whether to copy the output path to the clipboard: <code>-c --copy-profile-path <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. | 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 | * Select the "Server" environment | ||
* Choose your desired Minecraft version. You might need to enable " | * 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 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. | * Choose the installation location. By default, the installer will install into a new <code>server</code> sub-directory in the current directory. | ||
| Line 99: | Line 99: | ||
if you chose the Quilt Loader. | if you chose the Quilt Loader. | ||
===== | ===== CLI Installation ===== | ||
The | 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 | $ ornithe-installer-rs server --minecraft-version VERSION | ||
| Line 117: | Line 117: | ||
* Whether to download the minecraft server jar: <code>--download-minecraft</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. | For this, the installer serves as a server bootstrap and the <code>run</code> subcommand of the <code>server</code> subcommand is used. | ||
Latest revision as of 11:19, 12 August 2025
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 § 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
.minecraftdirectory. 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 client subcommand. Then, add your desired minecraft version as an argument.
$ ornithe-installer-rs client --minecraft-version VERSION
Example:
$ ornithe-installer-rs client --minecraft-version 1.7.2
The --minecraft-version argument may also be shortened to -m.
Additional arguments for other options are available as well:
- Loader type:
--loader-type <TYPE> - Loader version:
--loader-version <VERSION> - Installation directory:
-d --dir <DIR> - Whether to generate a profile:
-p --generate-profile <VALUE>
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
instancesdirectory.
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 mmc subcommand (or its alias, prism). Then, add your desired minecraft version as an argument.
$ ornithe-installer-rs mmc --minecraft-version VERSION
Example:
$ ornithe-installer-rs mmc --minecraft-version 1.7.2
The --minecraft-version argument may also be shortened to -m.
Additional arguments for other options are available as well:
- Loader type:
--loader-type <TYPE> - Loader version:
--loader-version <VERSION> - Installation directory:
-d --dir <DIR> - Whether to generate a profile zip:
-z --generate-zip <VALUE> - Whether to copy the output path to the clipboard:
-c --copy-profile-path <VALUE>
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
serversub-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 § 2.3.3. Install & Run (CLI). To install a server, use the server subcommand. Then, add your desired minecraft version as an argument.
$ ornithe-installer-rs server --minecraft-version VERSION
Example:
$ ornithe-installer-rs server --minecraft-version 1.7.2
The --minecraft-version argument may also be shortened to -m.
Additional arguments for other options are available as well:
- Loader type:
--loader-type <TYPE> - Loader version:
--loader-version <VERSION> - Installation directory:
-d --dir <DIR> - Whether to download the minecraft server jar:
--download-minecraft
Install & Run (CLI)
For this, the installer serves as a server bootstrap and the run subcommand of the server subcommand is used.
$ ornithe-installer-rs server --minecraft-version VERSION run
Example:
$ ornithe-installer-rs server --minecraft-version 1.7.2 run
In addition to the arguments available for the server subcommand, additional arguments are available for the run subcommand:
- Java arguments to pass to the server:
--args <ARGS> - Java binary to use to start the server:
--java <PATH>
The --download-minecraft flag is not applicable and always enabled when the run subcommand is used.
Then, your server will be installed automatically and started afterwards.
Addendum: Using the java-based installer
// TODO