Add documentation for the UI Launcher, upgrade documentation to Andraste 0.2.2

Author: MeFisto94

content/modules/ROOT/images/dnd-open-with.png

@@ -1,8 +1,10 @@
 * xref:glossary.adoc[Glossary]
 * Getting Started
-** xref:creating-the-first-mod.adoc[Creating a first mod]
-** xref:creating-the-first-plugin.adoc[Creating a first plugin]
+** xref:getting-started/ui-launcher.adoc[The UI Launcher]
+** xref:getting-started/creating-the-first-mod.adoc[Creating a first mod]
+** xref:getting-started/creating-the-first-plugin.adoc[Creating a first plugin]
 * Advanced topics
+** xref:cli-launcher.adoc[The CLI Launcher]
 ** xref:mod-information.adoc[The mod.json file]
 ** Features
 *** xref:features/builtin/vfs.adoc[The builtin VFS feature]

content/modules/ROOT/images/ui-add-profile-1.png

@@ -0,0 +1,79 @@
+= Launching Games using the CLI Launcher
+:author: MeFisto94
+:revnumber: 1.0
+:revdate: 2024/05/02
+
+The CLI Launcher is an integral part of every xref:glossary.adoc#_framework[framework] distribution.
+It may not be the version built by the Andraste team, but tailored to the specifics of the game.
+This is exactly it's purpose. Making sure the game launches and bootstrapping the framework
+appropriately.
+
+Since it's command line arguments function as some sort of API, it is expected that every CLI
+launcher *at least* supports the subset of the https://github.com/AndrasteFramework/Launcher[Generic Andraste Launcher].
+If this is not the case, the UI Launcher may not even be capable of launching the specific framework.
+
+NOTE: This documentation page aims to be a quick start, not a full and up-to-date reference
+manual for the command line arguments. When in doubt, consult the application or the source code.
+
+== Command line arguments
+
+NOTE: For Andraste 0.1.X, the launcher supported drag and dropping the game application on top of it. This is *NOT* supported anymore as of Andraste 0.2.X
+
+TIP: You can always use `Andraste.Launcher.exe --help` to see the built in help for all the command
+arguments.
+
+=== Overview
+The CLI is structured like this: `Andraste.Launcher.exe [global arguments] subcommand [command arguments]`, where the subcommand is one of `launch`, `attach` and `monitor`.
+
+The most common option is `launch`, which will launch the passed application, as opposed to `attach`
+and `monitor`, which will both attach to a running process, but `attach` requires a PID, while
+`monitor` will wait until the passed application is running and then attach to that.
+
+=== Mandatory Arguments
+The Launcher at least needs the following command line arguments to work:
+
+The Game Executable Path::
+This is the application that will be launched and inside of which an andraste framework is spawned.
+Prefer to enter an absolute path here and don't forget to use `""` so you don't need to escape spaces.
++
+The flag used for this is `--file`, as in `--file="C:\WINDOWS\system32\notepad.exe"`
++
+With the optional `--commandLine="foo"` flag, you can append things to the command line when
+starting the application. Some games expect the graphics backend, vsync or windowed mode here.
+
+The "mods.json" Path::
+The launcher needs to know which mods to pull from where, so you hand it a path to your mods.json,
+which is essentially the "profile folder" in UI terms.
++
+The flag used for this is `--modsJsonPath`, as in `--modsJsonPath="C:\WINDOWS\totally-not-mods.json"`
++
+NOTE: The launcher also supports `--modsPath` as the path to a folder of mods where it will
+derive the `mods.json` automatically. This is useful when debugging the framework, but for
+any serious use-case, especially for shortcuts/steam or third-party launchers, *do use* the
+mods.json file as it represents your profile settings and has a higher expressivity.
+
+The Framework DLL Path::
+The launcher needs to know which xref:glossary.adoc#_framework[framework] distribution to boot.
+This is typically just a relative path, as the launcher resides inside said distribution, but
+there may be multiple DLLs (e.g. one game specific, one `Andraste.Payload.Generic.dll`).
++
+The flag used for this is `--frameworkDll` as in `--frameworkDll="C:\WINDOWS\NotepadFramework.dll"`
++
+This flag is optional and may fall back to `Andraste.Payload.Generic.dll`
+
+=== Global Arguments
+==== Non Interactive mode
+When launching andraste with `--non-interactive`, the launcher will omit the default behavior
+of reading the payload logging files and redirecting them to stdout.
+
+== Installing mods with the generic CLI Launcher
+In the same directory as the `Andraste.Launcher.exe`, there should be a `mods`
+folder. If not, create one.
+
+Installing mods is now as simple as placing every mod inside that folder.
+In case your mod came zipped, you have to unzip it.
+
+TIP: If the mod hasn't been found/loaded (check the logs), make sure the
+directory structure is correct: `mods` -> `mod-name` footnote:[This should
+correspond to the `slug` in the `mod.json`, but is not mandatory, just good
+practice] -> `mod.json`

content/modules/ROOT/images/ui-add-profile-2.png

@@ -120,7 +120,7 @@ namespace Andraste.Examples.HelloWorld
 
 == Step 2: Creating a basic mod.json file
 
-This works exactly the same as in the xref:creating-the-first-mod.adoc[Creating a first mod] tutorial.
+This works exactly the same as in the xref:getting-started/creating-the-first-mod.adoc[Creating a first mod] tutorial.
 
 == Step 3: Using the plugin feature
 Andraste's functionality is split into features.

content/modules/ROOT/images/ui-add-profile-3.png

@@ -0,0 +1,84 @@
+= Launching Games using the generic GUI Launcher
+:author: MeFisto94
+:revnumber: 1.0
+:revdate: 2024/05/02
+
+The GUI Launcher is an application that primarly manages your _profiles_. Profiles are your
+isolated modding environments. Every profile has an associated game path, xref:glossary.adoc#\_framework[framework], mods folder and settings for that mods (load order, enabled status, version).
+
+NOTE: As opposed to other Andraste components, the GUI Launcher is very decoupled from the actual
+game you want to launch. As a result, the generic GUI Launcher should be capable of launching almost
+every game and andraste framework flavor. This means you can use the same launcher for multiple
+games even!
+
+== Getting Started
+=== Overview over the main menus
+.The Main Screen
+image::ui-homescreen.png["A screenshot of the main UI"]
+
+.The Profile Manager
+image::ui-profile-manager.png["A screenshot of the UI profile manager"]
+
+=== Create your first profile
+Everything in the UI Launcher revolves around profiles. As such, your first action has to be to
+create a profile. Click on the Profile Manager and there click on "Add Profile".
+
+This will open a wizard, whose steps look like the following:
+
+.Add Profile Wizard: Enter information about the game
+image::ui-add-profile-1.png["Add Profile Wizard Page 1"]
+
+On the first wizard page, you have to tell your profile which game to launch and which launch
+arguments (command line) to use. Most of the time, this is blank, but if you were launching
+the game with different arguments, you may want to adjust this here.
+
+.Add Profile Wizard: Give your profile a name
+image::ui-add-profile-2.png["Add Profile Wizard Page 2"]
+
+.Add Profile Wizard: Choose a path where your profile (and mods) will be stored.
+image::ui-add-profile-3.png["Add Profile Wizard Page 3"]
+
+On the third wizard page, the prefilled profile location should probably be fine, _unless_ you are
+planning on installing a lot of heavy mods and know you don't have enough disk storage on that
+partition. In that case, just pick a different location.
+
+.Add Profile Wizard: Choose the Andraste Framework Distribution to use
+image::ui-add-profile-4.png["Add Profile Wizard Page 4"]
+
+Andraste frameworks are a more advanced topic, covered xref:glossary.adoc#\_framework[here],
+but in most cases, picking the bundled framework should be fine. It will default to the most recent
+"generic" framework at the time of downloading the UI Launcher.
+
+NOTE: If any mod/plugin you download demands a specific version of andraste, you'll most likely
+need to download it and use the "external andraste framework" option here.
+
+=== Adding Mods to your profile
+Click on the "Mod Folder" button, it should open the correct folder in your Windows Explorer.
+Installing mods is now as simple as placing every mod inside that folder. In case your mod came
+zipped, you have to unzip it.
+You then have to press "Refresh Mods" for them to appear in your profile.
+
+TIP: If the mod hasn't been found/loaded (check the logs), make sure the
+directory structure is correct: `mods` -> `mod-name` footnote:[This should
+correspond to the `slug` in the `mod.json`, but is not mandatory, just good
+practice] -> `mod.json`
+
+
+=== Switching between profiles
+In case you have more than one profile, you can switch between them on the drop down next to 
+"Manage Profiles".
+
+In order to keep that drop down list small to the most relevant entries, you can "enable" profiles
+in the profile manager. Only enabled profiles will appear in the drop down.
+
+The list of mods should auto reload, but you can always press "Refresh Mods"
+
+NOTE: This isn't the best design decision and may change in the future. 
+
+== Advanced Profile Settings
+=== Profile Settings Dialog
+As opposed to the wizard, editing a profile has a more technical appearance, but the fields are the
+same.
+
+.The Profile Edit Dialog
+image::ui-edit-profile.png["The profile edit dialog"]

content/modules/ROOT/images/ui-add-profile-4.png

@@ -1,6 +1,6 @@
 = The Glossary
 :author: MeFisto94
-:revnumber: 1.0
+:revnumber: 1.1
 :revdate: 2022/11/17
 
 == Mod vs Plugin
@@ -12,4 +12,19 @@ application or game in any given way, for us is called Mod (modification).
 
 Plugins, in contrast, are a specific species of mods: They contain code
 modifications, such as hooks to game functions or writing to game memory,
-as opposed to asset-only changing modifications.
+as opposed to asset-only changing modifications.
+
+== Framework
+When talking about the "framework", we refer to the integral andraste component that is responsible
+for launching and hooking into the game. The framework provides all kinds of functionality for
+mod/plugin authors to use.
+
+There can be various _flavours_ of the framework, as some games may want to replace specific
+components to be more specific for their game. If this doesn't happen, we talk about the 
+_generic framwork_ (i.e. game agnostic, provided by the andraste team).
+
+When managing your UI Launcher _profiles_, you may have to manage framework versions that can
+mean varying andraste versions _and_ flavours.
+
+In contrast to the framework, there is the UI Launcher at the outer
+level and mods/plugins being driven by the framework.

content/modules/ROOT/images/ui-add-profile-5.png

@@ -1,7 +1,7 @@
 = Andraste Framework Overview
 :author: MeFisto94
-:revnumber: 1.0
-:revdate: 2022/11/15
+:revnumber: 1.1
+:revdate: 2024/05/02
 
 == What is Andraste?
 Andraste, at it's core, is a generic modding framework, aiming to bring a modern
@@ -14,50 +14,20 @@ possibility to write code modifications in .NET languages, that interface
 seamlessly with the native code of the game.
 
 == Getting Started
-=== Launching Games using the generic CLI Launcher
-NOTE: Other Launchers may have a different launch procedure, but this one is
-universally usable, for when no one wrote a game specific launcher yet.
-
-The generic CLI Launcher expects up to two command line arguments:
-```
-Andraste.Launcher.exe "C:\Path\To\Game.exe" [optional DLL Name] [-- optional flags passed to the app]
-```
-
-This means, that in most cases you're fine by just dragging the game exe ontop
-of the Andraste.Launcher.exe and save that as a shortcut to use.
-
-.Drag and Dropping the Game Application by Drag and Dropping onto the Launcher
-image::dnd-open-with.png["Drag and Dropping the Game Application onto the Launcher"]
-
-TIP: You can also create a shortcut, or even better: add the Launcher.exe to Steam and just set the
-launch arguments there. That way you can easily launch Andraste and the Game as if it was on steam!
+Starting with Version 0.2.2, Andraste comes with a GUI Launcher that should be your preferred way of launching applications
+and managing the related mods and framework versions. You should only have to use the CLI launcher when having to 
+embed Andraste into a different (game specific) launcher or adding your modpack as a steam foreign game.
 
-NOTE: The default for "optional DLL Name" currently is Andraste.Payload.Generic.dll, which should work well for every game.
+=== Launching Games using the generic UI Launcher
+See xref:getting-started/ui-launcher.adoc[here] for more information about the UI Launcher
 
-NOTE: Choosing a different DLL is for advanced users only and is only listed
-for completeness. It is only ever relevant if there's a non-generic version of
-Andraste that provides additional features for specific games, but does NOT have
-a specific Launcher yet. *IF* it has, always prefer that Launcher over this one.
-
-=== Installing mods with the generic CLI Launcher
-NOTE: Other Launchers may have different (additional) ways of installing mods,
-but this one should apply to every launcher and it especially applies to the
-generic CLI launcher.
-
-In the same directory as the `Andraste.Launcher.exe`, there should be a `mods`
-folder. If not, create one.
-
-Installing mods is now as simple as placing every mod inside that folder.
-In case your mod came zipped, you probably have to unzip it.
+=== Launching Games using the generic CLI Launcher
+If you really want to use the generic CLI Launcher, see it's dedicated subpage xref:cli-launcher.adoc[here]
 
-TIP: If the mod hasn't been found/loaded (check the logs), make sure the
-directory structure is correct: `mods` -> `mod-name` footnote:[This should
-correspond to the `slug` in the `mod.json`, but is not mandatory, just good
-practice] -> `mod.json`
 
 === Creating a first mod
-See xref:creating-the-first-mod.adoc[here] for a step-by-step tutorial on
+See xref:getting-started/creating-the-first-mod.adoc[here] for a step-by-step tutorial on
 creating modifications (i.e. non code changes).
 
-See xref:creating-the-first-plugin.adoc[here] for a step-by-step tutorial on
+See xref:getting-started/creating-the-first-plugin.adoc[here] for a step-by-step tutorial on
 creating plugins (i.e. code changes).