From 20d9fc5b5356a1054cb104ba6651b77184abf0db Mon Sep 17 00:00:00 2001
From: bigfoot547 <bigfoot@figboot.dev>
Date: Sun, 24 Dec 2023 04:26:00 -0600
Subject: initial commit

---
 USAGE.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 USAGE.md

(limited to 'USAGE.md')

diff --git a/USAGE.md b/USAGE.md
new file mode 100644
index 0000000..802cf3e
--- /dev/null
+++ b/USAGE.md
@@ -0,0 +1,40 @@
+- `l2su instance add <name> [at <directory>] [--force]`
+- `l2su instance list`
+- `l2su instance remove <name> [--delete]`
+- `l2su instance rename <name> <newname>`
+
+- `l2su user add`
+- `l2su user remove <username-or-uuid-or-nickname>`
+- `l2su user nick <username-or-uuid-or-nickname> [<new-nickname>]` - handy for users with long annoying names like `______HAHA______`
+
+- `l2su version list remote`
+- `l2su version list local`
+- `l2su version install <mojang-version>`
+
+- `l2su profile add <name> <instance> <version>`
+- `l2su profile delete <name>`
+- `l2su profile rename <name> <newname>`
+- `l2su profile set <name> <setting> <value>`
+- `l2su profile get <name> <setting>`
+- `l2su profile info <name>`
+
+- `l2su launch <profile-name> [<user>] [--force] [--detach] [--nodetach] [-- [<vm arguments>]] [++ [<game arguments>]]`
+  - `--force`: launches without interaction, even if offline
+  - `--detach`: prevents the launcher from staying open (despite profile settings, this is the default)
+  - `--nodetach`: keeps the launcher running and printing game logs to stdout/stderr
+  - `<vm arguments>`: arguments passed without interpretation (besides checking for `++`) to the JVM
+  - `<game arguments>`: arguments passed without interpretation to the game
+- `l2su launch2 <instance> <version> <user> [--force] [--detach] [--nodetach] [-- [<vm arguments>]] [++ [<game arguments>]]`
+
+- `l2su version`
+- `l2su help`
+
+# profile settings
+- `instance`: the instance that this profile 
+- `version`: the version of the game to use
+- `user`: a user that should be the default selected when using `l2su launch`
+- `vm-opts`: VM options to use for the profile
+- `runtime`: `null` for mojang-provided launcher, or an absolute path to a java runtime to use
+- `launch-method`: `jni` or `traditional`
+- `detach`: `true` to return control back to the shell after launching the game successfully
+- `resolution`: a value like `1280x720` to pass to the game as a custom resolution value
-- 
cgit v1.2.3-70-g09d2