diff --git a/Mod-Management.md b/Mod-Management.md index d3a95a0..2e03996 100644 --- a/Mod-Management.md +++ b/Mod-Management.md @@ -2,4 +2,65 @@
Customize your in-game experience with ease by managing mods with the launcher.
\ No newline at end of file +Customize your in-game experience with ease by managing mods with the launcher.
+ + +Mod Management Tab. Accessible in the settings menu.
+ +## Mod Management Tab + +All mod management can be done through the mod managament tab in settings. You can only manage mods for the selected server, which will be displayed on the top of the tab. To quickly manage another server configuration, you can use the switch button. Note that this will update the selected server for the entire launcher. + + + +## Built-In Mods + +Built-in mods are provided by WesterosCraft and automatically updated by the launcher. These mods are not stored in the `mods` folder, and are dynamically loaded when the game is launched. Built-in mods can be either **required** or **optional**. + +#### Required Mods + +Required mods are required to join the server and are always enabled. + + + +#### Optional Mods + +Optional mods are not required to join the server, and are typically provided simply to enhance the overall experience. These mods can be toggled freely. + + + +### Sub Mods + +Mods can also declare sub mods. This is typical when one mod required another to function properly. In order to enable a sub mod, its parent must also be enabled. For example, in the following image, Macro/Keybind Mod is enabled, however it will not be loaded when the game starts. This is because its parent, LiteLoader, is not enabled. + + + +## Drop-In Mods + +Drop-In mods are custom mods added and managed by the user. These are stored locally in the mods folder for the specific server instance. + + + +#### Add Drop-Ins + +Click the **Add Mods** button. This will open the system file explorer to the mods folder. Move all custom mods to that folder. When you've finished, press F5 while the launcher is focused to refresh the list. + +#### Remove Drop-Ins + +To remove a drop-in mod, simply click the **Remove** button. If you delete a mod from the mods folder directly, press F5 while the launcher is focused to refresh the list. + +#### Toggle Drop-Ins + +You can toggle drop-in mods by clicking their respective toggle switch. When a drop-in is disabled, the `.disabled` extension is added to the mod file. The `.disabled` extension is removed upon being reenabled. + +#### Mods Folder Location + +You can find the mods folder at the following locations, where `{SERVER}` is the server id. For example, the ID of the 1.11.2 production server is `WesterosCraft-1.11.2`. + +* **Windows** `AppData/Roaming/.westeroscraft/instances/{SERVER}/mods` +* **macOS** `~/Library/Application Support/.westeroscraft/instances/{SERVER}/mods` +* **Linux** `/home/.westeroscraft/instances/{SERVER}/mods` + +--- + +*Mod Management added in [Alpha Update 17](https://github.com/WesterosCraftCode/ElectronLauncher/releases/tag/v0.0.1-alpha.17).* \ No newline at end of file