Fabulously-Optimized · its-miroma · Jan 16, 2025 · Jan 17, 2025 · Jan 19, 2025 · Jan 22, 2025
diff --git a/how-to/README.md b/how-to/README.md
@@ -0,0 +1,6 @@
+---
+hidden: true
+icon: arrow-progress
+---
+
+# How to...
diff --git a/how-to/install/README.md b/how-to/install/README.md
@@ -0,0 +1,24 @@
+---
+hidden: true
+icon: down-to-bracket
+---
+
+# Install
+
+<table data-card-size="large" data-view="cards"><thead><tr><th align="center"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>Modrinth App</strong><br>The Modrinth App supports FO with monetary benefits. Thank you!</td><td><a href="modrinth-app.md">modrinth-app.md</a></td></tr><tr><td align="center"><strong>CurseForge App</strong><br>The CurseForge App supports FO with monetary benefits. Thank you!</td><td><a href="curseforge-app.md">curseforge-app.md</a></td></tr><tr><td align="center"><strong>Prism Launcher</strong></td><td><a href="prism-launcher.md">prism-launcher.md</a></td></tr><tr><td align="center"><strong>Minecraft Launcher</strong></td><td><a href="vanilla.md">vanilla.md</a></td></tr><tr><td align="center"><strong>MultiMC</strong></td><td><a href="multimc.md">multimc.md</a></td></tr><tr><td align="center"><strong>Steam Deck</strong></td><td><a href="steam-deck.md">steam-deck.md</a></td></tr><tr><td align="center">Why am I not seeing my favorite launcher?</td><td><a href="../../about/unsupported.md#other-launchers">#other-launchers</a></td></tr></tbody></table>
+
+<details><summary>Comparison table</summary>
+
+TODO
+
+</details>
+
+{% hint style="success" %}
+FO does not require any special setup server-side: any server compatible with vanilla should be supported.
+
+Read more [tips regarding server setup](../../about/servers.md).
+{% endhint %}
+
+{% hint style="info" %}
+Are you unable to play Minecraft 1.17 or higher due to hardware limitations? Follow this [tutorial to work around the compatibility issue](https://gist.github.com/Kichura/9fa44010d8ed9e5733d258292e327001), then try again.
+{% endhint %}
diff --git a/how-to/install/curseforge-app.md b/how-to/install/curseforge-app.md
@@ -0,0 +1,34 @@
+---
+hidden: true
+---
+
+# CurseForge App
+
+{% tabs %}
+{% tab title="Via app" %}
+1. Open the [**CurseForge App**](https://www.curseforge.com/download/app#download-options)
+2. Select <kbd>**Minecraft**</kbd> from the grid or from the sidebar
+3. Search for `Fabulously Optimized`
+4. Click on the <kbd>**Install**</kbd> button. Once installed, you should see a new icon for FO
+5. If you do not want the latest version, click on the row, then on <kbd>**Versions**</kbd>, then on the <kbd>**Download**</kbd> button
+6. Hover over the icon that just appeared
+7. Click on the <kbd>**Play**</kbd> button. The Minecraft Launcher should open up
+8. In the Minecraft Launcher, click on the <kbd>**Play**</kbd> button. Minecraft should open up
+9. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!
+{% endtab %}
+
+{% tab title="Via website" %}
+1. Open [FO's listing on CurseForge](https://download.fo/curseforge)
+2. Click on the <kbd>**Install**</kbd> button
+3. If you do not want the latest version, click on <kbd>**Files**</kbd>, then on the version you want, then on the <kbd>**Install**</kbd> button
+4. If a prompt appears asking to open in the CurseForge App, accept it. The CurseForge App should open, and the download should start. Once installed, you should see a new icon for FO
+5. Hover over the icon that just appeared
+6. Click on the <kbd>**Play**</kbd> button. The Minecraft Launcher should open up
+7. In the Minecraft Launcher, click on the <kbd>**PLAY**</kbd> button. Minecraft should open up
+8. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!
+{% endtab %}
+{% endtabs %}
+
+{% hint style="success" %}
+The CurseForge App supports FO with monetary benefits. Thank you!
+{% endhint %}
diff --git a/how-to/install/modrinth-app.md b/how-to/install/modrinth-app.md
@@ -0,0 +1,39 @@
+---
+hidden: true
+---
+
+# Modrinth App
+
+{% hint style="warning" %}
+These instructions are for Modrinth App version 0.9.2 or higher.
+{% endhint %}
+
+{% tabs %}
+{% tab title="Via app" %}
+1. Open the [**Modrinth App**](https://modrinth.com/app)
+2. Under the **Discover a modpack** section, click on <kbd>**Fabulously Optimized**</kbd>
+3. Click on the <kbd>**Install**</kbd> button
+4. If you do not want the latest version, click on the tile, then on <kbd>**Versions**</kbd>, then on the <kbd>**Download**</kbd> button
+5. Go to the <kbd>**Library**</kbd> section
+6. Hover over the newly created **Fabulously Optimized** instance
+7. Click on the <kbd>**Play**</kbd> button. Minecraft should open up
+8. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!
+{% endtab %}
+
+{% tab title="Via website" %}
+1. Open [FO's listing on Modrinth](https://download.fo/modrinth)
+2. Click on the <kbd>**Download**</kbd> button
+3. Click on <kbd>**Install with Modrinth App**</kbd>. The Modrinth App should open
+4. If you do not want the latest version, click on <kbd>**Select game version**</kbd>, then select the desired version
+5. If a prompt appears asking to open in the Modrinth App, accept it. The Modrinth App should open, and the download should start.
+6. Once installed, click on <kbd>**Install**</kbd>
+7. Go to the <kbd>**Library**</kbd>
+8. Hover over the newly created **Fabulously Optimized** instance
+9. Click on <kbd>**Play**</kbd>. Minecraft should open up
+10. If you can see the newly installed content in the Mod Menu, you're done!
+{% endtab %}
+{% endtabs %}
+
+{% hint style="success" %}
+The Modrinth App supports FO with monetary benefits. Thank you!
+{% endhint %}
diff --git a/how-to/install/multimc.md b/how-to/install/multimc.md
@@ -0,0 +1,69 @@
+---
+hidden: true
+---
+
+# MultiMC
+
+[MultiMC](https://multimc.org/) does not support automatic updates by default. However, FO has developed a custom MultiMC pack to perform updates automatically. Read more about the [MultiMC auto-updating pack](multimc.md#how-does-it-work)
+
+{% tabs %}
+{% tab title="Automatic Updates" %}
+{% hint style="warning" %}
+While this variant allows for automatic updates within a specific Minecraft version, it is more difficult to update across Minecraft versions and to disable FO's mods.
+
+Consider using [Prism Launcher](prism-launcher.md), which has a similar interface and a version manager.
+{% endhint %}
+
+1. Download and install [Java 21](https://download.fo/java21)
+2. Download FO's MultiMC pack for your preferred Minecraft version from [GitHub Releases](https://github.com/Fabulously-Optimized/fabulously-optimized/releases):
+
+   <a class="button primary" href="https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v6.6.0-alpha.8/Fabulously.Optimized.MC.1.21.5.auto-update.zip">1.21.5</a>
+   <a class="button secondary" href="https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v6.6.0-alpha.8/Fabulously.Optimized.MC.1.21.4.auto-update.zip">1.21.4</a>
+   <a class="button secondary" href="https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v6.6.0-alpha.8/Fabulously.Optimized.MC.1.21.1.auto-update.zip">1.21.1</a>
+   <a class="button secondary" href="https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v5.12.0-beta.11/Fabulously.Optimized.MC.1.20.6.auto-update.zip">1.20.6</a>
+   <a class="button secondary" href="https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v4.10.0/Fabulously.Optimized.MC.1.19.4.auto-update.zip">1.19.4</a>
+   <a class="button secondary" href="https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.12.2/Fabulously.Optimized.MC.1.18.2.auto-update.zip">1.18.2</a>
+   <a class="button secondary" href="https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.2.3/Fabulously.Optimized.MC.1.17.1.auto-update.zip">1.17.1</a>
+   <a class="button secondary" href="https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.2.3/Fabulously.Optimized.MC.1.16.5.auto-update.zip">1.16.5</a>
+3. If you do not want the latest version, you can find older ones in [GitHub Releases](https://github.com/Fabulously-Optimized/fabulously-optimized/releases)
+4. Open [**MultiMC**](https://multimc.org/)
+5. Drag the `zip` file and drop it inside of MultiMC's window. A window should pop up
+6. Click on <kbd>**OK**</kbd> in that window. Something should happen
+7. Double-click on that window. The download should start
+8. If you are asked to download a mod manually:
+   1. Open the given address in your browser. The mod's page should open up
+   2. Click on <kbd>**Cancel Launch**</kbd>
+   3. Click on <kbd>**Download**</kbd>. A `jar` file should be downloaded
+   4. Go back to **MultiMC**. You should find a new instance
+   5. Click on the <kbd>**Fabulously Optimized**</kbd> instance
+   6. Click on <kbd>**View Mods**</kbd>
+   7. Drag the mod you downloaded in _step 8.3_ and drop it in the mod list
+9. Click on <kbd>**Launch**</kbd>. Minecraft should open up
+10. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!
+
+### How Does It Work?
+
+The MultiMC auto-updating pack launches [`packwiz`](https://github.com/comp500/packwiz) every time it is opened. `packwiz` is a mod handling tool which will add and update any missing FO mods indicated in a `pack.toml` file.
+
+Since the update checker runs on every launch, you'll get a skippable error if you play offline. The updater only manages FO's mods, not the [mods added manually](../add-mods/multimc.md). The updater does not work across Minecraft versions, so you'll need to install it again every time.
+
+MultiMC does not natively support automatic updates of packs: see [issue #2640](https://github.com/MultiMC/MultiMC5/issues/2640) and [issue #3037](https://github.com/MultiMC/MultiMC5/issues/3057). FO chose to use `packwiz` because it is also used for the [vanilla installer](vanilla.md).
+{% endtab %}
+
+{% tab title="Easier Installation" %}
+{% hint style="warning" %}
+Installing FO through these instructions means that every update will require manual configuration.
+
+Consider using [Prism Launcher](prism-launcher.md), which has a similar interface and a version manager.
+{% endhint %}
+
+1. Download and install [Java 21](https://download.fo/java21)
+2. In [**MultiMC**](https://multimc.org/), click on <kbd>**Add Instance**</kbd>
+3. Click on the <kbd>**Modrinth**</kbd> tab on the left
+4. Click on <kbd>**Fabulously Optimized**</kbd>
+5. If you do not want the latest version of FO, select the version you want from the dropdown
+6. Click on <kbd>**OK**</kbd>. Once installed, something should happen
+7. Double-click on the icon. Minecraft should open up
+8. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!
+{% endtab %}
+{% endtabs %}
diff --git a/how-to/install/prism-launcher.md b/how-to/install/prism-launcher.md
@@ -0,0 +1,13 @@
+---
+hidden: true
+---
+
+# Prism Launcher
+
+1. Open the [**Prism Launcher**](https://prismlauncher.org/)
+2. Click on the <kbd>**Modrinth**</kbd> tab on the left
+3. Click on <kbd>**Fabulously Optimized**</kbd>
+4. If you do not want the latest version, select the version you want from the dropdown
+5. Click on <kbd>**OK**</kbd>. Once installed, you should see something
+6. Double-click on the icon to play. Minecraft should open up
+7. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!
diff --git a/how-to/install/steam-deck.md b/how-to/install/steam-deck.md
@@ -0,0 +1,36 @@
+---
+hidden: true
+---
+
+# Steam Deck
+
+You'll install FO on your Steam Deck via [Prism Launcher](prism-launcher.md).
+
+1. Hold down the <kbd>Power</kbd> button on your Steam Deck
+2. Tap on <kbd>**Switch to Desktop**</kbd>
+3. Select <kbd>**Discover**</kbd> from the taskbar
+4. Tap the <kbd>**Search**</kbd> bar on the top-left corner
+5. Tap the <kbd>**✕**</kbd> to open the on-screen keyboard
+6. Search for <kbd>**Prism Launcher**</kbd>
+7. Tap <kbd>**Install**</kbd> on the first result
+8. Launch the **Prism Launcher**
+9. Go through Prism Launcher's initial setup process
+10. Close Prism Launcher
+11. Open the **Steam** app
+12. Tap on <kbd>**Games**</kbd>
+13. Tap on <kbd>**Add a non-Steam game to my library**</kbd>
+14. Select Prism Launcher
+15. Tap on <kbd>**Add selected programs**</kbd>
+16. Close the Steam app
+17. Launch **Return to Gaming Mode**
+18. Launch **Prism Launcher** from your game library
+19. Follow the [instructions for the Prism Launcher](prism-launcher.md). Once you've opened Minecraft, come back here
+20. Tap on <kbd>**Options...**</kbd>, then on <kbd>**Controls...**</kbd>, then on <kbd>**Controller Settings...**</kbd>
+21. Select your controller
+22. Tap on <kbd>**Done**</kbd> three times
+23. You can launch the game from your game library from now on
+24. If you want a better icon in your game library, follow the [instructions for setting up artwork](https://prismlauncher.org/download/steam-deck/#setting-up-artwork)
+
+{% hint style="warning" %}
+If you get Deck-related issues, try asking on [r/SteamDeck on Reddit](https://old.reddit.com/r/steamdeck). FO moderators might not be able to help you.
+{% endhint %}