Add: Documentation on Mod Packs

SinjuSigne · Oct 14, 2022 · 85672ae · 85672ae
1 parent f3910db
commit 85672ae
Show file tree

Hide file tree

Showing 13 changed files with 139 additions and 20 deletions.
diff --git a/docs/CreatingModPacks.md b/docs/CreatingModPacks.md
@@ -0,0 +1,61 @@
+# Creating Mod Packs
+
+!!! info
+
+    Mod Packs are an upcoming Reloaded 1.21.0 feature. They are not yet available in the currently released version.
+
+For information on installing mod packs, please see [Installing Mod Packs](./InstallingModPacks.md).
+
+## 1. Open Editor
+
+!!! info
+
+    You can find the mod pack editor in the (three gears) `Manage Mods` menu.  
+
+![Mod Pack Mod Example](./Images/EditModPack_Locator.png)
+
+When opened, a blank pack editor would appear on the screen.  
+
+![Mod Pack Mod Example](./Images/EditModPack_Blank.png)
+
+Click on the top left where it says (`Click to Edit`) to edit the mod pack's welcome screen.
+
+## 2. Add A Description
+
+!!! info "About Markdown"
+
+    Reloaded uses Markdown [(tutorial)](https://commonmark.org/help/tutorial/index.html) for mod pack descriptions.  
+
+    If you ever use *italics* and **bolds** in your Discord/Reddit posts, you're probably familiar with a small bit of Markdown. Markdown files use the file extension `.md` and can be saved/opened with any text editor.  
+
+!!! tip
+
+    Markdown editors such as [Dilinger](https://dillinger.io) and [Typora](https://typora.io) allow you to preview your formatted text in real time.  
+
+![Mod Pack Mod Example](./Images/EditModPack_1.png)
+
+To add a description to your mod, click `Set Description` and select a markdown file.  
+To add an image, click `Add Image`. Clicking `Remove Image` will remove currently shown image.
+
+## 3. Adding Mods
+
+In order to add a mod to the pack, press the `Add Mod` button and select a mod from the list.  
+If possible (i.e. mod author includes those), the pack creator will automatically add the description and images for you.  
+
+!!! info 
+
+    The `.r2pack` files do not contain the mods themselves, only images and text. The mods are only downloaded once user selects their mods and begins the download process.
+
+Mods must have [working update support](./EnablingUpdateSupport.md). The `Add Mod` dialog will not show mods that don't have update support enabled.
+
+To select a mod for editing, click the mod title from the list below the title/main section of the pack. If you want to remove a mod, open that mod's page and click `Remove Mod`.
+
+## 4. Testing Packs
+
+When you are happy with the changes you made, you can click `Test Pack`.  
+
+![Mod Pack Mod Example](./Images/InstallModPack_1.png)
+
+Selecting this option will display the pack install screen, as seen by the end user.  
+
+When you are happy with your result, press `Save Pack`.  
diff --git a/docs/Images/EditModPack_1.png b/docs/Images/EditModPack_1.png
diff --git a/docs/Images/EditModPack_2.png b/docs/Images/EditModPack_2.png
diff --git a/docs/Images/EditModPack_Blank.png b/docs/Images/EditModPack_Blank.png
diff --git a/docs/Images/EditModPack_Locator.png b/docs/Images/EditModPack_Locator.png
diff --git a/docs/Images/InstallModPack_1.png b/docs/Images/InstallModPack_1.png
diff --git a/docs/Images/InstallModPack_2.png b/docs/Images/InstallModPack_2.png
diff --git a/docs/Images/InstallModPack_3.png b/docs/Images/InstallModPack_3.png
diff --git a/docs/Images/InstallModPack_4.png b/docs/Images/InstallModPack_4.png
diff --git a/docs/Images/InstallModPack_File.png b/docs/Images/InstallModPack_File.png
diff --git a/docs/Images/InstallModPack_Web.png b/docs/Images/InstallModPack_Web.png
diff --git a/docs/InstallingModPacks.md b/docs/InstallingModPacks.md
@@ -0,0 +1,55 @@
+# Installing Mod Packs
+
+!!! info
+
+    Mod Packs are an upcoming Reloaded 1.21.0 feature. They are not yet available in the currently released version.
+
+Mod packs are a functionality which allows for fast installation of multiple mods at the same time. It is particularly helpful in helping new users get setup fast.  
+
+If you wish to know how to create mod packs, please see [Creating Mod Packs](./CreatingModPacks.md).
+
+## Installing From File
+
+Downloaded mod packs use the `.r2file` extension and can be opened by directly doubleclicking from explorer. 
+
+![Mod Pack File Example](./Images/InstallModPack_File.png)
+
+Once opened, the mod pack will greet you with a welcome screen:  
+
+![Mod Pack Mod Example](./Images/InstallModPack_1.png)
+
+## Installing From Web Browser
+
+Any download to an `.r2pack` file can be prefixed with `r2pack:`.  
+
+For example, the link `https://website.com/Reloaded.r2pack` can be turned into `r2pack:https://website.com/Reloaded.r2pack`.  
+
+When done inside a web browser, a prompt will appear to download and open the file with Reloaded.  
+
+![Mod Pack Web Example](./Images/InstallModPack_Web.png)
+
+!!! note 
+
+    If you have a very slow internet connection, very large packs might take a bit for the window to pop up; as it has to download the whole `.r2pack` file first, which contains all images.  
+
+## The Complete Experience
+
+!!! info
+
+    Shows the step by step experience of a typical mod pack installation.
+
+First appears the welcome screen:  
+
+![Mod Pack Confirmation](./Images/InstallModPack_1.png)
+
+Then you select whether to install (or skip) each individual mod:  
+
+![Mod Pack Confirmation](./Images/InstallModPack_2.png)
+
+And confirm which mods you want to download:  
+
+![Mod Pack Confirmation](./Images/InstallModPack_3.png)
+
+The mods download while a slideshow is being presented:  
+
+![Mod Pack Installation](./Images/InstallModPack_4.png)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -57,18 +57,21 @@ nav:
     - Quick Start: QuickStart.md
     - Frequently Asked Questions: FAQ.md
     - Linux Setup Guide: LinuxSetupGuide.md
+    - Installing Mod Packs: InstallingModPacks.md
     - Advanced:
-        - NuGet Sources: NuGetSources.md
-        - Injection Methods: InjectionMethods.md
-        - Misc & Experimental Features: ExperimentalFeatures.md
+      - NuGet Sources: NuGetSources.md
+      - Injection Methods: InjectionMethods.md
+      - Misc & Experimental Features: ExperimentalFeatures.md
   - For Modders:
     - Getting Started: 
-        - 1. Creating Your Mod: CreatingMods.md
-        - 2. Adding Functionality: AddingModFunctionality.md
+      - 1. Creating Your Mod: CreatingMods.md
+      - 2. Adding Functionality: AddingModFunctionality.md
     - Releasing Mods:
-        - 1. Enabling Update Support: EnablingUpdateSupport.md
-        - 2. Creating a Release: CreatingRelease.md
-        - Extras (Optional): CreatingReleaseExtras.md
+      - 1. Enabling Update Support: EnablingUpdateSupport.md
+      - 2. Creating a Release: CreatingRelease.md
+      - Extras (Optional): CreatingReleaseExtras.md
+    - Creating Mod Packs: CreatingModPacks.md
+
   - For Programmers:
     - Getting Started: 
         - 1. Setting Up Development Environment: DevelopmentEnvironmentSetup.md
@@ -88,19 +91,19 @@ nav:
     - Mod Template Features: ModTemplate.md
     - Writing Native Mods: NativeMods.md
     - Internal Libraries: 
-        - Introduction: InternalLibrariesIntro.md
-        - I/O Library: InternalLibrariesIO.md
-        - Community Index: InternalLibrariesCommunity.md
-        - Packaging: InternalLibrariesPackaging.md
-        - Update: InternalLibrariesUpdate.md
-        - Server: InternalLibrariesServer.md
+      - Introduction: InternalLibrariesIntro.md
+      - I/O Library: InternalLibrariesIO.md
+      - Community Index: InternalLibrariesCommunity.md
+      - Packaging: InternalLibrariesPackaging.md
+      - Update: InternalLibrariesUpdate.md
+      - Server: InternalLibrariesServer.md
     - Miscellaneous:
-        - Adding Mod Update Support: AddingUpdateSupport.md
-        - API Overview: APIOverview.md
-        - Optimizing Mods: OptimizingMods.md
-        - Shared Libraries: https://github.com/Sewer56/Reloaded.SharedLib.Hooks
-        - Writing Mods for Actively Developed Games/Apps: https://github.com/Sewer56/Reloaded.SharedLib.Hooks#supporting-actively-developed-applications
-        - Troubleshooting: Troubleshooting.md
+      - Adding Mod Update Support: AddingUpdateSupport.md
+      - API Overview: APIOverview.md
+      - Optimizing Mods: OptimizingMods.md
+      - Shared Libraries: https://github.com/Sewer56/Reloaded.SharedLib.Hooks
+      - Writing Mods for Actively Developed Games/Apps: https://github.com/Sewer56/Reloaded.SharedLib.Hooks#supporting-actively-developed-applications
+      - Troubleshooting: Troubleshooting.md
   - For Contributors:
     - Building Reloaded: BuildingReloaded.md
     - Project Structure: ProjectStructure.md