Skip to content

OrnitheMC/ornithe-installer-rs

Repository files navigation

Ornithe Installer

Installer for Ornithe offering a gui and cli to install a profile for the official launcher, generate an instance for MultiMC/PrismLauncher and install/bootstrap a server.

Usage

If no command-line arguments are specified, the GUI will be opened. Should it not be possible to open the GUI, the CLI help message will be printed.

The help message can also be accessed using the --help flag or the help subcommand.

The CLI supports a few options that are not present in the GUI:

  • Installing & running a server in a single step
    • passing arguments to the server
    • specifying a java binary to use to run the server

Usage - Web

This project is also deployed at https://ornithemc.net/ornithe-installer-rs. The web version offers all the same features but outputs are always bundled in a zip file, therefore pre-existing files can also not be modified (e.g. the launcher_profiles.json file used by the official launcher in order to generate a profile). The CLI can also be accessed on the web and is used through query parameters. These are converted into long-form arguments before being parsed as usual.

Building

Requirements: a recent rust toolchain

To build:

$ cargo build --release

Binaries are then output in the target/release directory.

License

This installer is licensed under the Apache-2.0 license. For more details see the included LICENSE file.

About

installer for ornithe, written in rust

Resources

License

Stars

Watchers

Forks

Contributors