diff --git a/how-to/README.md b/how-to/README.md new file mode 100644 index 00000000..efe376f9 --- /dev/null +++ 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 new file mode 100644 index 00000000..c2359ff9 --- /dev/null +++ b/how-to/install/README.md @@ -0,0 +1,24 @@ +--- +hidden: true +icon: down-to-bracket +--- + +# Install + +
Modrinth App
The Modrinth App supports FO with monetary benefits. Thank you!		modrinth-app.md
CurseForge App
The CurseForge App supports FO with monetary benefits. Thank you!		curseforge-app.md
Prism Launcherprism-launcher.md
Minecraft Launchervanilla.md
MultiMCmultimc.md
Steam Decksteam-deck.md
Why am I not seeing my favorite launcher?#other-launchers
+ +
Comparison table + +TODO + +
+ +{% 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 newer 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 new file mode 100644 index 00000000..5f6e401b --- /dev/null +++ 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 **Minecraft** from the grid or from the sidebar +3. Search for `Fabulously Optimized` +4. Click on the **Install** 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 **Versions**, then on the **Download** button +6. Hover over the icon that just appeared +7. Click on the **Play** button. The Minecraft Launcher should open up +8. In the Minecraft Launcher, click on the **Play** 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 **Install** button +3. If you do not want the latest version, click on **Files**, then on the version you want, then on the **Install** 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 **Play** button. The Minecraft Launcher should open up +7. In the Minecraft Launcher, click on the **PLAY** 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 new file mode 100644 index 00000000..f1ffdae8 --- /dev/null +++ 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 **Fabulously Optimized** +3. Click on the **Install** button +4. If you do not want the latest version, click on the tile, then on **Versions**, then on the **Download** button +5. Go to the **Library** section +6. Hover over the newly created **Fabulously Optimized** instance +7. Click on the **Play** 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 **Download** button +3. Click on **Install with Modrinth App**. The Modrinth App should open +4. If you do not want the latest version, click on **Select game version**, 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 **Install** +7. Go to the **Library** +8. Hover over the newly created **Fabulously Optimized** instance +9. Click on **Play**. 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 new file mode 100644 index 00000000..87c3675f --- /dev/null +++ b/how-to/install/multimc.md @@ -0,0 +1,72 @@ +--- +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): + + 1.21.11 + 1.21.10 + 1.21.8 + 1.21.5 + 1.21.4 + 1.21.1 + 1.20.6 + 1.19.4 + 1.18.2 + 1.17.1 + 1.16.5 +3. If you do not want the latest version, you can find lower 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 **OK** 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 **Cancel Launch** + 3. Click on **Download**. A `jar` file should be downloaded + 4. Go back to **MultiMC**. You should find a new instance + 5. Click on the **Fabulously Optimized** instance + 6. Click on **View Mods** + 7. Drag the mod you downloaded in _step 8.3_ and drop it in the mod list +9. Click on **Launch**. 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 **Add Instance** +3. Click on the **Modrinth** tab on the left +4. Click on **Fabulously Optimized** +5. If you do not want the latest version, select the version you want from the dropdown +6. Click on **OK**. Once installed, you should see something +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 new file mode 100644 index 00000000..40fccb91 --- /dev/null +++ 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 **Modrinth** tab on the left +3. Click on **Fabulously Optimized** +4. If you do not want the latest version, select the version you want from the dropdown +5. Click on **OK**. 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 new file mode 100644 index 00000000..91b3f44e --- /dev/null +++ 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 Power button on your Steam Deck +2. Tap on **Switch to Desktop** +3. Select **Discover** from the taskbar +4. Tap the **Search** bar on the top-left corner +5. Tap the **✕** to open the on-screen keyboard +6. Search for **Prism Launcher** +7. Tap **Install** 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 **Games** +13. Tap on **Add a non-Steam game to my library** +14. Select Prism Launcher +15. Tap on **Add selected programs** +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 **Options...**, then on **Controls...**, then on **Controller Settings...** +21. Select your controller +22. Tap on **Done** 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 %} diff --git a/how-to/install/vanilla.md b/how-to/install/vanilla.md new file mode 100644 index 00000000..c456e1a5 --- /dev/null +++ b/how-to/install/vanilla.md @@ -0,0 +1,195 @@ +--- +hidden: true +--- + +# Minecraft Launcher + +{% tabs %} +{% tab title="Installer (recommended)" %} +{% tabs %} +{% tab title="Windows" %} +1. Download the [FO Installer](https://download.fo/vanilla) +2. Open the `exe` installer. If you get a security prompt from Windows, allow the installer to run: + * Click on **More info** + * Click on **Run anyway** + * [Why did I get this prompt?](vanilla.md#why-does-windows-show-the-security-prompt) +3. Select your desired FO and Minecraft versions +4. Click on **Install** +5. Open the [**Minecraft Launcher**](https://minecraft.net/en-us/download). You should find a new installation +6. Launch the newly created **Fabulously Optimized** installation. Minecraft should start up +7. If you can see `Fabulously Optimized` in the bottom-right corner, you're done! + +### Why does Windows show the security prompt? + +TODO +{% endtab %} + +{% tab title="Linux" %} +1. Download the [FO Installer](https://download.fo/vanilla) +2. Open the `appimage` installer. If you get a security prompt from your OS, click on **Run once**. +3. Select your desired FO and Minecraft versions +4. Click on **Install** +5. Open the [**Minecraft Launcher**](https://minecraft.net/en-us/download). You should find a new installation +6. Launch the newly created **Fabulously Optimized** installation. Minecraft should start up +7. If you can see `Fabulously Optimized` in the bottom-right corner, you're done! +{% endtab %} + +{% tab title="macOS 15 Sequoia or later" %} +1. Download the [FO Installer](https://download.fo/vanilla) +2. Open the `dmg` installer. If you get a security prompt from macOS, allow the installer to run: + * Double-click on the **FO Installer**. You will get a warning + * Click on **Done** + * On the menu bar, click on the Apple logo + * Click on **System Settings** + * In the sidebar, click on **Privacy & Security** + * In the right view, scroll down to find a **Open anyway** button + * Click on the **Open anyway** button + * If prompted, authenticate with your password or your fingerprint + * [Why did I get this prompt?](vanilla.md#why-does-macos-15-show-the-security-prompt) +3. Select your desired FO and Minecraft versions +4. Click on **Install** +5. Open the [**Minecraft Launcher**](https://minecraft.net/en-us/download). You should find a new installation +6. Launch the newly created **Fabulously Optimized** installation. Minecraft should start up +7. If you can see `Fabulously Optimized` in the bottom-right corner, you're done! + +### Why does macOS 15+ show the security prompt? + +Apple has implemented a verification system for programs, which costs 99 USD a year. Such an expense is not worth it for FO. + +If you are concerned by this, you can also install FO manually, or use another [launcher compatible with FO](./). By the way, [FO's installer's source code](https://github.com/Fabulously-Optimized/installer) is available if you want to check it. +{% endtab %} + +{% tab title="macOS 14 Sonoma or older" %} +1. Download the [FO Installer](https://download.fo/vanilla) +2. Open the `dmg` installer. If you get a security prompt from macOS, allow the installer to run: + * Right-click on the **FO Installer** + * Click on **Open** + * If a popup prompts again, click on **Open** + * [Why did I get this prompt?](vanilla.md#why-does-macos-14--show-the-security-prompt) +3. Select your desired FO and Minecraft versions +4. Click on **Install** +5. Open the [**Minecraft Launcher**](https://minecraft.net/en-us/download). You should find a new installation +6. Launch the newly created **Fabulously Optimized** installation. Minecraft should start up +7. If you can see `Fabulously Optimized` in the bottom-right corner, you're done! + +### Why does macOS 14- show the security prompt? + +Apple has implemented a verification system for programs, which costs 99 USD a year. Such an expense is not worth it for FO. + +If you are concerned by this, you can also install FO manually, or use another [launcher compatible with FO](./). By the way, [FO's installer's source code](https://github.com/Fabulously-Optimized/installer) is available if you want to check it. +{% endtab %} +{% endtabs %} + +{% hint style="warning" %} +If the installation with the installer fails, or you want a version lower than `5.12.0`, you should install FO manually. + +Please report any issues you encounter on [GitHub](https://github.com/Fabulously-Optimized/installer/issues) or on [Discord](https://download.fo/discord). +{% endhint %} +{% endtab %} + +{% tab title="Manual" %} +{% tabs %} +{% tab title="Minecraft 1.19.4 and above" %} +1. On macOS and Linux, download and install [Java](https://download.fo/java) TODO: what version +2. Download the [Fabric Installer](https://fabricmc.net/use) +3. Open the Fabric Installer +4. Select `version 0.18.1` of the Fabric Loader +5. Click on **Install**. You have now installed the Fabric Loader +6. Open the [**Minecraft Launcher**](https://minecraft.net/en-us/download) +7. Click on **Installations**. You should find a new Fabric installation +8. Click on the **📂 Folder** button next to the Fabric installation +9. Open your **browser** +10. Open the [FO vanilla downloader](https://download.fo/vanilla) +11. If you do not want the latest version, select the version you want from the dropdown +12. Click on the **⬇️ Download** button. A `zip` file should be downloaded. [What does the `zip` file contain?](vanilla.md#what-does-the-zip-file-contain) +13. If you get a prompt about popup windows or multiple downloads, please allow them +14. Extract the `zip` file +15. Open the extracted `zip` file +16. Copy all folders from the extracted `zip` file to the `.minecraft` folder you opened in _step 8_. [Why do I need to copy everything over?](vanilla.md#why-do-i-need-to-copy-everything-over) +17. If you're asked to replace files, replace them +18. If you want the [recommended FO settings](../../info/options.md), delete `options.txt`. This will reset your vanilla options (resource packs, language, keybinds...) but you can reapply them later +19. Go back to the **Minecraft Launcher** +20. Launch the Fabric installation from _step 7_. Minecraft should start up +21. If you can see `Fabulously Optimized` in the bottom-right corner, you're done! + +### What does the `zip` file contain? + +The `zip` file contains the following: + +* `config/`: Configuration files to adjust the mods for the best experience +* `mods/`: The mods included in FO +* `resourcepacks/`: Small resource packs for the best experience. [What do the resource packs do?](../../info/resource-packs.md) +* `Copy all 3 folders!`: A dummy file reminding you to, well, copy all 3 folders! +{% endtab %} + +{% tab title="Minecraft 1.16.1 - 1.19.3" %} +1. Install the appropriate version of Java: + * Minecraft 1.19-1.19.3: [Java 17](https://download.fo/java17) + * Minecraft 1.17-1.18.2: [Java 17](https://download.fo/java17) + * Minecraft 1.16.5: [Java 8](https://download.fo/java8) +2. Download the [Fabric Installer](https://fabricmc.net/use) +3. Open the Fabric Installer +4. Select the appropriate version of the Fabric Loader: + * Minecraft 1.19-1.19.3: `version 0.14.24` + * Minecraft 1.17-1.18.2: `version 0.14.12` + * Minecraft 1.16.5: `version 0.13.3` +5. Click on **Install**. You have now installed the Fabric Loader +6. Open the [**Minecraft Launcher**](https://minecraft.net/en-us/download) +7. Click on **Installations**. You should find a new Fabric installation +8. Click on the **📂 Folder** button next to the Fabric installation +9. In your **browser**, open the [**Files** section on CurseForge](https://www.curseforge.com/minecraft/modpacks/fabulously-optimized/files?showAlphaFiles=show) +10. Click on the appropriate version of FO +11. Click on **Additional files**. You should find a **MultiMC version** +12. Click on the **three dots**, then on **Download file**. A `zip` file should be downloaded. [What does the `zip` file contain?](vanilla.md#what-does-the-multimc-pack-contain) +13. Extract the `zip` file. If you see less than 10 mods in it, you have downloaded the wrong version +14. Go to `Fabulously Optimized *.*.*` > `minecraft`. You should find a `zip` file in there +15. Extract the `zip` file +16. Copy all folders from the `zip`'s `minecraft` folder to the `.minecraft` folder you opened in _step 6_. [Why do I need to copy everything over?](vanilla.md#why-do-i-need-to-copy-everything-over) +17. If you're asked to replace files, replace them +18. If you want the [recommended FO settings](../../info/options.md), delete `options.txt`. This will reset your vanilla options (resource packs, language, keybinds...) but you can reapply them later +19. Go back to the **Minecraft Launcher** +20. Launch the Fabric installation from _step 5_. Minecraft should start up +21. If you can see `Fabulously Optimized` in the bottom-right corner, you're done! + +### What does the MultiMC pack contain? + +The MultiMC `zip` file is a packaged instance for [MultiMC](multimc.md#how-does-it-work), but it was also used for manual installation up to FO 6.0.0. This file was hosted on CurseForge because downloads from there used to support FO with monetary benefits. + +It contains the following: + +* `Fabulously Optimized *.*.*/`: A folder containing the MultiMC instance + * `minecraft/`: The main folder of FO + * `config/`: Configuration files to adjust the mods for the best experience + * `mods/`: The mods included in FO + * `resourcepacks/`: Small resource packs for the best experience. [What do the resource packs do?](../../info/resource-packs.md) + * `Copy all 3 folders!`: A dummy file reminding you to, well, copy all 3 folders! + * `instance.cfg`: A manifest file describing name, icon, type and notes for the instance + * `mmc-pack.json`: A manifest file describing the version of Minecraft, Fabric and of other dependencies + * `pack.png`: An icon for the instance +{% endtab %} +{% endtabs %} + +### Why do I need to copy everything over? + +FO consists of mods, configuration and resource packs, and all three are necessary. [What does the pack contain?](../../info/) + +Copying the `mods` folder alone may result in a number of issues: + +* In some versions the game will not launch at all +* Some of your resource packs will be broken +* Some features, such as zoom, will not work as shown +* New unexpected keybinds will appear +* Confusing mod buttons or popups will appear +* Confusing descriptions in the mod list +* There won't be any FO version number in the title screen + +If you have mistakenly forgotten to copy the other folders, do the following: + +1. Follow _steps 6-8_ from the instructions above to open the installation's folder +2. Locate and delete the `mods` folder +3. If you had modified your settings in-game, move both `config/` and `options.txt` to a different location +4. Follow _steps 9-17_ from the instructions above to copy the missing files over +5. If you had backed up your settings in _step 3_ and you don't want the [recommended FO settings](../../info/options.md), move yours back +6. Follow _steps 19-21_ from the instructions above to complete the installation +{% endtab %} +{% endtabs %}