Skirda/SkirdaElectronLauncher
4
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity

Updated Mod Management (markdown)

Daniel Scalzi 2018-08-16 00:29:59 -04:00
parent 6228c1b511
commit 74a9e7cb53
1 changed files with 62 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
Mod-Management.md

@ -2,4 +2,65 @@
<h1 align="center">Mod Management</h1>
<p align="center">Customize your in-game experience with ease by managing mods with the launcher.</p>
<p align="center">Customize your in-game experience with ease by managing mods with the launcher.</p>
<p align="center"><img src="https://user-images.githubusercontent.com/9703873/43767341-dd4a5c9a-9a02-11e8-8ea6-b9b13b131e6f.png" height="75%" width="75%" alt="Mod Settings"></p>
<p align="center"><em>Mod Management Tab. Accessible in the settings menu.</em></p>
## 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.
<img src="https://camo.githubusercontent.com/b6e1c9d1c1096821bfce33668f7ae8ba15409e0c/68747470733a2f2f692e6779617a6f2e636f6d2f64323638343964636437336437386563373130353031336530363265393434662e676966" height="75%" width="75%" alt="Switch Servers">
## 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.
<img src="https://i.imgur.com/0yc91Nu.png" height="50%" width="50%" alt="Required Mods">
#### 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.
<img src="https://i.imgur.com/LPE7k8r.png" height="50%" width="50%" alt="Optional Mods">
### 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.
<img src="https://i.imgur.com/8ZcwDRh.png" height="50%" width="50%" alt="Sub Mods">
## 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.
<img src="https://i.imgur.com/t8SCjOj.png" height="50%" width="50%" alt="Drop-In Mods">
#### 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).*