Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New page and improvements #119

Merged
merged 1 commit into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion adding-more-mods.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Method 2:
### Minecraft Launcher (vanilla)

1. Open Minecraft Launcher, click on `Installations`
2. Click the folder icon on the profile you've created for the pack (could be named Fabric)
2. Hover on the Fabric installation, click 📂
3. Open [Modrinth, set Loader to Fabric](https://modrinth.com/mods?g=categories:%27fabric%27)
4. Choose any mod you want and go to its _Versions_ page
5. Click `⤓` on the latest version that is compatible with Fabric and your Minecraft version
Expand Down
61 changes: 61 additions & 0 deletions backup-and-uninstall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Backup and uninstall instructions

Sometimes you might want to reinstall the modpack or remove old instances of it. Here's how to do it.

## Backup

Before uninstalling the modpack, it is highly recommended to back up the contents you've made in it.

1. Find the .minecraft folder.
* CurseForge App: right click on the modpack tile → `Open Folder`
* Modrinth App: right click on the modpack tile → `📂 Open folder`
* Prism Launcher: right click on the instance → `Folder` → `.minecraft`
* MultiMC: right click on the instance → `Minecraft Folder`
* Minecraft Launcher: click `Installations` → hover on the instance → click `📁`
2. Find the folders you want to back up.
* `saves` - your local worlds
* `resourcepacks` - if you added any (it is not needed to copy [the modpack defaults](changed-options.md#resource-packs))
* `shaders` - if you use any
* `screenshots` - screenshots you've taken with F2 or F9
* `servers.dat` - your multiplayer servers
* `options.txt` - if you want to keep your vanilla option and all hotkey changes
3. Copy the chosen folders or their contents to your preferred location, such as Desktop or Documents.
4. When you reinstall the modpack, copy the folders/contents back to the aforementioned location.

## Uninstall

### CurseForge App

1. Open CurseForge App
2. Go to `My Modpacks`, right click on Fabulously Optimized
3. Click `🗑️ Delete Profile`
4. Click `Delete`

### Modrinth App

1. Open Modrinth App
2. Right click on Fabulously Optimized
3. Click `🗑️ Delete`

### Prism Launcher

1. Open Prism Launcher
2. Click on Fabulously Optimized
3. Click `🗑️ Delete`
4. Click `Yes`

### MultiMC/MultiMC (auto-update)

1. Open MultiMC
2. Click on Fabulously Optimized
3. Click `Delete`
4. Click `Yes`

### Minecraft Launcher (vanilla)

1. Open Minecraft Launcher, click on `Installations`
2. Hover on the Fabric installation, click 📂
3. Delete `mods`, `config` and optionally `resourcepacks` folders
4. Go to `versions` folder and delete anything prefixed with `fabric-loader-`
5. Back in the launcher, hover on the installation and press `...`, then `Delete`
6. Press `Delete`
2 changes: 1 addition & 1 deletion disabling-mods.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Consider [switching to Prism Launcher instead,](install-instructions.md#prism-la
### Minecraft Launcher (vanilla)

1. Open Minecraft Launcher, click on `Installations`
2. Click the folder icon on the profile you've created for the pack (could be named Fabric)
2. Hover on the Fabric installation, click 📂
3. Click `mods`
4. Rename the specific mod from "modname.jar" to "modname.jar.disabled"
* Don't see ".jar" at the end of the name? [See this page for help.](https://www.thewindowsclub.com/show-file-extensions-in-windows)
Expand Down
20 changes: 14 additions & 6 deletions install-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@ Can't use Minecraft 1.17 and higher due to hardware limits? [Follow this tutoria
1. Select _Minecraft_ from the grid or sidebar
2. Search "Fabulously Optimized"
3. Click `Install`
* Optional: Select the version you want by instead clicking the row → `Versions` → `⤓`.
4. To run the modpack, hover on the modpack icon and click `Play`
5. Once the Minecraft Launcher has opened, click `Play` again

Or directly from the website:

1. Go to [the listing page](https://www.curseforge.com/minecraft/modpacks/fabulously-optimized/) on CurseForge
2. Click `Install` and accept the prompt in your browser
* Optional: Select the version you want by instead clicking `Files` → the version you want → `Install`.
3. The app should open and download should start
4. To run the modpack, hover on the modpack icon and click `Play`
5. Once the Minecraft Launcher has opened, click `Play` again
Expand All @@ -28,6 +30,7 @@ App version 0.6.2 or higher required.

1. Under "Popular packs" section, hover on "Fabulously Optimized"
2. Click `⤓ Install`
* Optional: Select the version you want by instead clicking the tile → `Versions` → `⤓` on the version you want.
3. The modpack will now install.
4. Once installed, hover on the created instance under "Jump back in"
5. Click ▶️ button to play.
Expand All @@ -40,6 +43,7 @@ You need [Java 21](https://prismlauncher.org/wiki/getting-started/installing-jav
2. Select `Modrinth` tab from the left
3. Select "Fabulously Optimized"
4. Click `OK`
* Optional: Select the version you want by selecting it on the dropdown before you click `OK`.
5. The modpack will now install.
6. Once installed, double-click the icon to play.

Expand All @@ -57,6 +61,7 @@ You need [Java 21](https://prismlauncher.org/wiki/getting-started/installing-jav
10. Select `Modrinth` tab from the left
11. Select "Fabulously Optimized"
12. Click `OK`
* Optional: Select the version you want by selecting it on the dropdown before you click `OK`.
13. The modpack will now install.
14. Once installed, double-tap the icon and wait.
15. Tap `Options...` → `Controls...` → `Controller Settings...`
Expand All @@ -74,6 +79,7 @@ You need [Java 21](https://download.fo/java21) to play the game.
2. Select `Modrinth` tab from the left
3. Select "Fabulously Optimized"
4. Click `OK`
* Optional: Select the version you want by selecting it on the dropdown before you click `OK`.
5. The modpack will now install.
6. Once installed, double-click the icon to play.

Expand Down Expand Up @@ -108,7 +114,8 @@ For macOS or Linux [you need Java](https://download.fo/java21) to run the Fabric
1. Download and install [Fabric Loader](https://fabricmc.net/use/) **version 0.15.11**
* Remember that the _installer version_ doesn't matter, what matters is the _loader version_ that appears when you run the installer.
2. Open Minecraft Launcher, click `Installations`, then click 📂 on the Fabric installation
3. [Open this site](https://download.fo/vanilla) and select the version you want, then click the ⬇️ button
3. [Open this site](https://download.fo/vanilla), then click the ⬇️ button
* Optional: Select the version you want by selecting it on the dropdown before you click ⬇️.
* If you got a prompt for popup windows or multiple downloads, please accept it - technical limitation.
* Looking for older versions? Read the "legacy instructions" below.
4. Open the zip file and copy **all folders** [(why?)](vanilla-launcher-faq.md#so-i-just-copy-the-mods-right) to your _.minecraft_ folder
Expand Down Expand Up @@ -161,11 +168,12 @@ Due to technical limits and issues, GDLauncher is no longer supported. It is rec
8. Open GDLauncher
9. Right click on your previously used instance → `Open Folder`
10. Copy the important files and folders over:
* `saves` for your local worlds
* `resourcepacks`, if you use any (do not copy old versions of FO-bundled packs though)
* `screenshots`
* `servers.dat` for your multiplayer servers
* `options.txt`, if you want to keep your vanilla option changes
* `saves` - your local worlds
* `resourcepacks` - if you added any (it is not needed to copy [the modpack defaults](changed-options.md#resource-packs))
* `shaders` - if you use any
* `screenshots` - screenshots you've taken with F2 or F9
* `servers.dat` - your multiplayer servers
* `options.txt` - if you want to keep your vanilla option and all hotkey changes
11. Launch the instance on Prism and confirm everything is correct
12. Uninstall GDLauncher

Expand Down
76 changes: 43 additions & 33 deletions update-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,32 @@
### Disclaimers

- As with any update, *things may break*. Probably not due to the modpack itself, but maybe your launcher, your custom mods or your hard drive. If worried, make backups.
- Upgrades from stable to unstable (alpha, beta) versions are **never** supported (make a separate instance!), while updates from unstable versions to stable ones are.
- Upgrades from stable to unstable (alpha, beta) versions of the modpack are **never** supported (make a separate instance!), while updates from unstable versions to stable ones are.
- Any kind of instance downgrading is **never** supported. Make a separate old instance or use something like [ViaFabricPlus](https://modrinth.com/mod/viafabricplus) if your server hasn't updated yet.
- If you follow these instructions properly, all custom mods and most mod settings you have will persist (except those that need to change). If you want, you can [reset your settings](#resetting-settings) to get the latest changes.

#### Updating mods

* If you are using a supported version of Fabulously Optimized and you haven't added any extra mods, **do not update any mods manually**, just update the modpack instead.
* If you did add extra mods, **update those individually** after you've ensured you're on latest version of Fabulously Optimized.
* Updating mods that are in FO may cause unexpected issues which FO releases would prevent, so manual updates only make your own life harder.
* If you are using an unsupported (legacy) version of Fabulously Optimized, **you may carefully update the mods**.
* Keep in mind that we haven't tested those updates, so you may run into issues and need to revert back to previous versions.
* Some launchers have options to update all mods at once. **Do not use this feature** for reasons listed above.
* Even for legacy versions of FO, updating everything at once like that may cause problems like mod loader mismatch, Minecraft version mismatch, mod platform variances (more recent version on one platform vs another) and so on.
* It is always safer to update each mod individually so that you can see the update was successful and valid for your MC version/mod loader.
* If you did any of the things above and are having issues, simply update Fabulously Optimized again.
* This will reset your mod list to the specified FO version ones, even if you used the same version of FO beforehand.

### CurseForge App

If you haven't changed the mods:

1. Select _Minecraft_ from the grid or sidebar
2. On My Modpacks, right click _Fabulously Optimized_, then `⇄ Change Version`
* Don't see that option? Follow the other instructions below.
3. Select the topmost version, then `Continue`.
3. Click `Continue`.
* Optional: Select the version you want by selecting it on the dropdown before you click `Continue`.
4. Modpack will now update.
5. Run it and check the version difference in the bottom right corner.

Expand All @@ -23,25 +37,28 @@ If you added or removed some mods:
1. Select _Minecraft_ from the grid or sidebar
2. On My Modpacks, click _Fabulously Optimized_
3. Click `⫶`→ `Profile Options`
4. Uncheck "Allow content management for this profile". You can re-enable content management after the update.
4. Uncheck "Allow content management for this profile". This will not affect added content and you can re-enable content management after the update.
5. Click `Continue`
6. Click `⫶` → `⇄ Change Version`.
7. Select the topmost version, then `Continue`.
7. Click `Continue`.
* Optional: Select the version you want by selecting it on the dropdown before you click `Continue`.
8. Modpack will now update.
9. Run it and check the version difference in the bottom right corner.

### Modrinth App

1. Select existing FO instance
2. Click `🔄 Update modpack` on top right
3. Select latest version and click `⇆`
3. Click `⇆`
* Optional: Select the version you want by selecting it on the dropdown before you click `⇆`.

### Prism Launcher

1. Select existing FO instance
2. Click `Edit` on the sidebar
3. Select `Modrinth` on the tab list
4. Click `Update pack`
* Optional: Select the version you want by selecting it on the dropdown before you click `Update pack`.
5. Once the name prompt comes up, click `Yes`

### MultiMC
Expand All @@ -50,15 +67,17 @@ If you added or removed some mods:
2. Select `Modrinth` tab from the left
3. Select "Fabulously Optimized"
4. Click `OK`
* Optional: Select the version you want by selecting it on the dropdown before you click `OK`.
5. The modpack will now install.
6. Click that version you just created, then `Minecraft Folder`
7. Click the previous version, then `Minecraft Folder`
8. Copy the important files and folders over:
* `saves` for your local worlds
* `resourcepacks`, if you use any (do not copy old versions of FO-bundled packs though)
* `screenshots`
* `servers.dat` for your multiplayer servers
* `options.txt`, if you want to keep your vanilla option changes
* `saves` - your local worlds
* `resourcepacks` - if you added any (it is not needed to copy [the modpack defaults](changed-options.md#resource-packs))
* `shaders` - if you use any
* `screenshots` - screenshots you've taken with F2 or F9
* `servers.dat` - your multiplayer servers
* `options.txt` - if you want to keep your vanilla option and all hotkey changes
* Ignore the `Copy all 3 folders!` file, that's for vanilla launcher users
9. Close the folders and run the new version
10. If everything looks right, delete the old version
Expand All @@ -80,11 +99,12 @@ If there is a new Minecraft version:
3. Click that version, then `Minecraft Folder`
4. Click the previous version, then `Minecraft Folder`
5. Copy the important files and folders over:
* `saves` for your local worlds
* `resourcepacks`, if you use any (do not copy the _Mod Menu Helper_ though)
* `screenshots`
* `servers.dat` for your multiplayer servers
* `options.txt`, if you want to keep your vanilla option changes
* `saves` - your local worlds
* `resourcepacks` - if you added any (it is not needed to copy [the modpack defaults](changed-options.md#resource-packs))
* `shaders` - if you use any
* `screenshots` - screenshots you've taken with F2 or F9
* `servers.dat` - your multiplayer servers
* `options.txt` - if you want to keep your vanilla option and all hotkey changes
* Ignore the `Copy all 3 folders!` file, that's for vanilla launcher users
6. Close the folders and run the new version
7. If everything looks right, delete the old version
Expand All @@ -110,8 +130,10 @@ Currently the only way to update is to "reinstall" the pack. Consider installing
1. Download and install [Fabric Loader](https://fabricmc.net/use/) **version 0.15.11**
* Remember that the _installer version_ doesn't matter, what matters is the _loader version_ that appears when you run the installer.
2. Open Minecraft Launcher, click `Installations`, then click 📂 on the Fabric installation
3. [Open this site](https://download.fo/vanilla) and select the version you want, then click the ⬇️ button
3. [Open this site](https://download.fo/vanilla), then click the ⬇️ button
* Optional: Select the version you want by selecting it on the dropdown before you click ⬇️.
* If you got a prompt for popup windows or multiple downloads, please accept it - technical limitation.
* Looking for older versions? Read the "legacy instructions" below.
4. Open the zip file and copy **all folders** [(why?)](vanilla-launcher-faq.md#so-i-just-copy-the-mods-right) to your _.minecraft_ folder
* If asked - replace the files.
5. Recommended: delete `options.txt` to get [FO default settings](changed-options.md)
Expand Down Expand Up @@ -148,30 +170,18 @@ Currently the only way to update is to "reinstall" the pack. Consider installing

No longer supported. [Please migrate to Prism Launcher.](install-instructions.md#gdlauncher)

### Updating mods

* If you are using a supported version of Fabulously Optimized and you haven't added any extra mods, **do not update any mods manually**, just update the modpack instead.
* If you did add extra mods, **update those individually** after you've ensured you're on latest version of Fabulously Optimized.
* Updating mods that are in FO may cause unexpected issues which FO releases would prevent, so manual updates only make your own life harder.
* If you are using an unsupported (legacy) version of Fabulously Optimized, **you may carefully update the mods**.
* Keep in mind that we haven't tested those updates, so you may run into issues and need to revert back to previous versions.
* Some launchers have options to update all mods at once. **Do not use this feature** for reasons listed above.
* Even for legacy versions of FO, updating everything at once like that may cause problems like mod loader mismatch, Minecraft version mismatch, mod platform variances (more recent version on one platform vs another) and so on.
* It is always safer to update each mod individually so that you can see the update was successful and valid for your MC version/mod loader.
* If you did any of the things above and are having issues, simply update Fabulously Optimized again.
* This will reset your mod list to the specified FO version ones, even if you used the same version of FO beforehand.

### Resetting options
## Resetting options

Because the pack is using YOSBR, your vanilla options and most of the mod ones will not change when you upgrade, [despite what is stated in the changelog](https://github.com/Fabulously-Optimized/fabulously-optimized/blob/main/CHANGELOG.md). This is made so that you can upgrade without having to reconfigure your options all the time.

However, at some point you may still want to do that in order to get the latest changes. So:
However, at some point you may still want to do that in order to get the latest changes.

1. Open the modpack folder
* CurseForge Launcher: right click on the modpack tile → `Open Folder`
* CurseForge App: right click on the modpack tile → `Open Folder`
* Modrinth App: right click on the modpack tile → `📂 Open folder`
* Prism Launcher: right click on the instance → `Folder` → `.minecraft`
* MultiMC: right click on the instance → `Minecraft Folder`
* Vanilla launcher: go to `Installations` tab → hover on the instance → click `📁`
* Minecraft Launcher: click `Installations` → hover on the instance → click `📁`
2. Delete the `config` folder
* If you prefer, also delete `options.txt` which stores vanilla options
3. Download [your version of FO again from Modrinth](https://modrinth.com/modpack/fabulously-optimized/versions)
Expand Down
4 changes: 3 additions & 1 deletion vanilla-launcher-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Don't worry, we can fix that!
2. Backup and delete `config` folder and `options.txt` file
* `config` contains all of your mod configs.
* `options.txt` contains vanilla settings and keybinds
* "Backup" means copying the existing folder and file to a different location, in case you need to reference or copy it back later. If you don't care about your existing settings, you don't have to do this.
* "Backup" means copying the existing folder and file to a different location, in case you need to reference or copy it back later.
* If your FO is not up to date, also delete the `mods` folder.
3. Open the ZIP file of Fabulously Optimized that you have or [download it again](https://download.fo/vanilla)
4. Do one of the following:
Expand All @@ -43,6 +43,8 @@ Don't worry, we can fix that!

The MultiMC ZIP is a packaged instance for the launcher called [MultiMC](https://multimc.org). It is distributed in CurseForge because MultiMC itself no longer supports downloading CurseForge modpacks and downloads from CurseForge support the creator of FO. This also allows for an easy installation of FO for vanilla launcher users.

Since FO 6.0.0, this ZIP is no longer distributed in CurseForge and users are advised to use the [official site per instructions](install-instructions.md#minecraft-launcher-vanilla).

### What is in the ZIP file?

- `Fabulously Optimized x.x.x` - the folder containing the MultiMC instance
Expand Down