Skip to content

Commit 8dfbe55

Browse files
its-miromaits-miroma
committed
rewrite(how-to/install): initial commit
1 parent b4a19d1 commit 8dfbe55

File tree

8 files changed

+386
-0
lines changed

8 files changed

+386
-0
lines changed

‎how-to/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
hidden: true
3+
icon: arrow-progress
4+
---
5+
6+
# How to...

‎how-to/install/README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
hidden: true
3+
icon: down-to-bracket
4+
---
5+
6+
# Install
7+
8+
<table 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> <a data-footnote-ref href="#user-content-fn-1"><strong>⭐</strong></a></td><td><a href="modrinth-app.md">modrinth-app.md</a></td></tr><tr><td align="center"><strong>CurseForge App</strong> <a data-footnote-ref href="#user-content-fn-2"><strong>⭐</strong></a></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>
9+
10+
{% hint style="success" %}
11+
FO does not require any special setup server-side: any server compatible with vanilla should be supported.
12+
13+
Read more [tips regarding server setup](../../about/servers.md).
14+
{% endhint %}
15+
16+
{% hint style="info" %}
17+
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.
18+
{% endhint %}
19+
20+
<!-- TODO: Comparison table -->
21+
22+
[^1]: The Modrinth App supports FO with monetary benefits
23+
24+
[^2]: The CurseForge App supports FO with monetary benefits

‎how-to/install/curseforge-app.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
hidden: true
3+
---
4+
5+
# How to Install: CurseForge App
6+
7+
## Through the CurseForge App
8+
9+
1. Open the [**CurseForge App**](https://curseforge.com/download/app#download-options)
10+
2. Select **Minecraft** from the grid or from the sidebar
11+
3. Search for `Fabulously Optimized`
12+
4. Click on the Install button. Once installed, you should see a new icon for FO
13+
5. If you do not want the latest version, click on the row, then on `Versions`, then on the download button
14+
6. Hover over the icon that just appeared
15+
7. Click the Play button. The Minecraft Launcher should open up
16+
8. In the Minecraft Launcher, click on the Play button. Minecraft should open up
17+
9. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!
18+
19+
## Through the CurseForge website
20+
21+
1. Open [FO's listing on CurseForge](https://download.fo/curseforge)
22+
2. Click on the Install button
23+
3. If you do not want the latest version, click on `Files`, then on the version you want, then on the Install button
24+
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
25+
5. Hover over the icon that just appeared
26+
6. Click the Play button. The Minecraft Launcher should open up
27+
7. In the Minecraft Launcher, click on the Play button. Minecraft should open up
28+
8. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!

‎how-to/install/modrinth-app.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
hidden: true
3+
---
4+
5+
# How to Install: Modrinth App
6+
7+
{% hint style="warning" %}
8+
These instructions are for Modrinth App version 0.9.2 or higher.
9+
{% endhint %}
10+
11+
1. Open the [**Modrinth App**](https://modrinth.com/app)
12+
2. Under the **Discover a modpack** section, click on "Fabulously Optimized"
13+
3. Click on the Install button
14+
4. If you do not want the latest version, click on the tile, then on `Versions`, then on the download button
15+
5. Go to the **Library** section
16+
6. Hover over the newly created FO instance
17+
7. Click on the Play button. Minecraft should open up
18+
8. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!

‎how-to/install/multimc.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
hidden: true
3+
---
4+
5+
# How to Install: MultiMC
6+
7+
[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)
8+
9+
{% hint style="info" %}
10+
You may also want to use one of the other [launchers supported by FO](./), which offer easier installation, updates and mod management.
11+
{% endhint %}
12+
13+
{% tabs %}
14+
{% tab title="Automatic Updates (recommended)" %}
15+
1. Download and install [Java 21](https://download.fo/java21)
16+
2. Download FO's MultiMC pack for your preferred Minecraft version from [GitHub Releases](https://github.com/Fabulously-Optimized/fabulously-optimized/releases):
17+
* [`1.21.4`](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v6.5.0-alpha.1/Fabulously.Optimized.MC.1.21.4.auto-update.zip)
18+
* [`1.21.3`](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v6.4.0-alpha.5/Fabulously.Optimized.MC.1.21.3.auto-update.zip)
19+
* [`1.21.1`](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v6.2.2/Fabulously.Optimized.MC.1.21.1.auto-update.zip)
20+
* [`1.20.6`](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v5.12.0-beta.11/Fabulously.Optimized.MC.1.20.6.auto-update.zip)
21+
* [`1.19.4`](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v4.10.0/Fabulously.Optimized.MC.1.19.4.auto-update.zip)
22+
* [`1.18.2`](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.12.2/Fabulously.Optimized.MC.1.18.2.auto-update.zip)
23+
* [`1.17.1`](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.2.3/Fabulously.Optimized.MC.1.17.1.auto-update.zip)
24+
* [`1.16.5`](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.2.3/Fabulously.Optimized.MC.1.16.5.auto-update.zip)
25+
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)
26+
4. Open [**MultiMC**](https://multimc.org/)
27+
5. Drag the `zip` file and drop it inside of MultiMC's window. A window should pop up
28+
6. Click **OK** in that window. Something should happen <!-- TODO: what though?? -->
29+
7. Double-click on that window. The download should start
30+
8. If you are asked to download a mod manually:
31+
1. Open the given address in your browser. The mod's page should open up
32+
2. Click on **Cancel Launch**
33+
3. Click on **Download**. A `jar` file should be downloaded
34+
4. Go back to **MultiMC**
35+
5. Click on the instance you just created
36+
6. Click on **View Mods**
37+
7. Drag the mod you downloaded in _step 8.3_ and drop it in the mod list
38+
9. Click on **Launch**. Minecraft should open up
39+
10. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!
40+
41+
## How Does It Work?
42+
43+
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.
44+
45+
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.
46+
47+
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).
48+
49+
Before FO 6.0.0, the MultiMC auto-updating pack was distributed on CurseForge, but that has changed for the following reasons:
50+
51+
* CurseForge's UI for downloading the MultiMC auto-updating pack became confusing
52+
* The pack had to be re-uploaded on every update, which was often unnecessary
53+
* The pack's downloads via CurseForge [might not support FO](https://support.curseforge.com/en/support/solutions/articles/9000197898-rewards-program-terms-of-service#1.-Description-of-Rewards-Program) as previously thought
54+
* The pack proved to have unexpected issues that do not exist with other launchers
55+
{% endtab %}
56+
57+
{% tab title="Easier Installation" %}
58+
1. Download and install [Java 21](https://download.fo/java21)
59+
2. In [**MultiMC**](https://multimc.org/), click on **Add Instance**
60+
3. Click on the **Modrinth** tab on the left
61+
4. Click on **Fabulously Optimized**
62+
5. If you do not want the latest version of FO, select the version you want from the dropdown
63+
6. Click on **OK**. Once installed, something should happen <!-- TODO: what though ?? -->
64+
7. Double-click on the icon. Minecraft should open up
65+
8. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!
66+
{% endtab %}
67+
{% endtabs %}

‎how-to/install/prism-launcher.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
hidden: true
3+
---
4+
5+
# How to Install: Prism Launcher
6+
7+
1. Open the [**Prism Launcher**](https://prismlauncher.org/)
8+
2. Click on the **Modrinth** tab on the left
9+
3. Click on **Fabulously Optimized**
10+
4. If you do not want the latest version, select the version you want from the dropdown
11+
5. Click on **OK**. Once installed, you should see something <!-- TODO: what though? -->
12+
6. Double-click the icon to play. Minecraft should open up
13+
7. If you can see `Fabulously Optimized` in the bottom-right corner, you're done!

‎how-to/install/steam-deck.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
hidden: true
3+
---
4+
5+
# How to Install: Steam Deck
6+
7+
You'll install FO on your Steam Deck via [Prism Launcher](prism-launcher.md).
8+
9+
1. Hold down the Power button on your Steam Deck
10+
2. Tap on **Switch to Desktop**
11+
3. Select **Discover** from the taskbar
12+
4. Tap the Search bar on the top-left corner
13+
5. Tap the X to open the on-screen keyboard
14+
6. Search for **Prism Launcher**
15+
7. Tap **Install** on the first result
16+
8. Launch the **Prism Launcher**
17+
9. Go through Prism Launcher's initial setup process
18+
10. Close Prism Launcher
19+
11. Open the **Steam** app
20+
12. Tap on **Games**, then on **Add a non-Steam game to my library**, then select Prism Launcher, then tap on **Add selected programs**
21+
13. Close the Steam app
22+
14. Launch **Return to Gaming Mode**
23+
15. Launch **Prism Launcher** from your game library
24+
16. Follow the [instructions for the Prism Launcher](prism-launcher.md). Once you've opened Minecraft, come back here
25+
17. Tap on **Options...**, then on **Controls...**, then on **Controller Settings...**
26+
18. Select your controller
27+
19. Tap on **Done** three times
28+
20. You can launch the game from your game library from now on
29+
21. 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)
30+
31+
{% hint style="warning" %}
32+
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.
33+
{% endhint %}

0 commit comments

Comments
 (0)