RunicGateway/installer
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

fix(cli): game-neutral --help for --game and --site-url #43

Merged
whitlocktech merged 1 commits from fix/help-neutral-wording into main 2026-10-22 14:47:39 -05:00
Conversation 1 Commits 1 Files Changed 1 +7 -6
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/cli.rs
View File

@@ -56,7 +56,7 @@ pub enum PatchChoice {
No, No,
} }
/// Which game's shard side this run is about (docs/modules/rust/PLAN.md §34.2.3). ServUO is the /// Which game this run sets up (docs/modules/rust/PLAN.md §34.2.3). ServUO is the
/// default, so every command line written before Rust existed means exactly what it meant. /// default, so every command line written before Rust existed means exactly what it meant.
#[derive(Debug, Clone, Copy, PartialEq, Eq)] #[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Game { pub enum Game {
@@ -94,7 +94,8 @@ pub struct Cli {
pub patches_unsupported_servuo: bool, pub patches_unsupported_servuo: bool,
/// `--host <name>`: the hostname to print in the website URLs. /// `--host <name>`: the hostname to print in the website URLs.
pub host: Option<String>, pub host: Option<String>,
/// `--site-url <url>`: the site's base URL, for the Admin → Shard (uo-link) link. /// `--site-url <url>`: the site's base URL, printed as a link to the admin page that takes
/// the values.
pub site_url: Option<String>, pub site_url: Option<String>,
/// `--yes`: assume the default answer to every prompt. /// `--yes`: assume the default answer to every prompt.
pub assume_yes: bool, pub assume_yes: bool,
@@ -128,7 +129,7 @@ impl Default for Cli {
} }
pub const USAGE: &str = "\ pub const USAGE: &str = "\
Runic Gateway installer — connects a ServUO shard, or Rust servers, to a Runic Runic Gateway installer — connects a ServUO server, or Rust servers, to a Runic
Gateway website. Gateway website.
Usage: runicgateway-installer <COMMAND> [OPTIONS] Usage: runicgateway-installer <COMMAND> [OPTIONS]
@@ -144,7 +145,7 @@ Commands:
removes only its own plugin file and keeps the plugin config. removes only its own plugin file and keeps the plugin config.
Options: Options:
--game <servuo|rust> Which game's shard side. Default servuo. --game <servuo|rust> Which game this run sets up. Default servuo.
--verify install, update. Dry run: report every --verify install, update. Dry run: report every
change that would be made, write nothing. change that would be made, write nothing.
--servuo <PATH> install, doctor, update. The ServUO root, --servuo <PATH> install, doctor, update. The ServUO root,
@@ -161,7 +162,7 @@ Options:
--host <NAME> install. The hostname to print in the --host <NAME> install. The hostname to print in the
website URLs. website URLs.
--site-url <URL> install. Your site's base URL, for the --site-url <URL> install. Your site's base URL, for the
Admin → Shard (uo-link) link. admin page link it prints at the end.
--yes Assume the default answer to every prompt. --yes Assume the default answer to every prompt.
On uninstall it means yes: that prompt On uninstall it means yes: that prompt
defaults to no, and typing `uninstall defaults to no, and typing `uninstall
@@ -194,7 +195,7 @@ Environment:
set it. set it.
The installer never contacts your website, never deletes anything from your The installer never contacts your website, never deletes anything from your
ServUO tree, and never starts or stops your shard. ServUO tree, and never starts or stops your game server.
"; ";
/// Parses arguments **without** the program name. /// Parses arguments **without** the program name.