fabulously-optimized/README.md
Miroma d396ede3ed
Update README.md (#813)
<!--
Thanks for submitting a pull request!

- Translation PRs are not accepted, use Crowdin instead:
https://fabulously-optimized.gitbook.io/modpack/readme/language-support#modpack
- Mod and config changes are not accepted, use issues to propose them:
https://github.com/Fabulously-Optimized/fabulously-optimized/issues
- Major changes should be discussed as an issue or on Discord first.

-->

I'm creating a new PR to fix the problems with the linter from #812.

Preview at <https://github.com/its-miroma/fo/tree/readme>

- [x] Add right-aligned FO icon
- [x] Add Table of Contents
- [x] Change "Launcher Comparison" table
- [x] Flip rows and columns, because items (Launchers) are usually
placed as rows, plus if hypothetically there was a new one that would
give a one-line diff
- [x] Remove "Can be used offline" column, because all launchers support
that, and specified that above
- [x] Remove "Windows, macOS, Linux support" column, for the same reason
- [x] Remove "Unique feature" column, because I think FO, and especially
this `README.md`, is not the right place to see which features launchers
have
  - [ ] ~~Place the table in a collapsible block~~
  - [ ] Add launcher icons?
- [x] Add "Resource Packs" section, with links to download them.
- [x] Add "Contribute" section, linking to <https://download.fo/thanks>
- [x] Merge `CREDITS.md` into "Credits" section
- [x] Merge `Resource Packs/README.md` into "Resource Packs" section
- [x] Use [reference
links](https://github.github.com/gfm/#reference-link) which help
readability of the source file and make it more maintainable
- [x] Add badges
  - [x] Enable Discord widget
- [ ] Move `INCLUDED-MODS.md` to the wiki?
- [x] Add MultiMC auto update information
  - [ ] Move MultiMC auto update to the wiki?
- [ ] Update `DEVELOPER-README.md`
  - [ ] Perhaps move to `CONTRIBUTING.md`?
  - [ ] Add link to "Contributing" section in `README.md`
  - [ ] Add link to `CODE_OF_CONDUCT.md` in `CONTRIBUTING.md`
  - [ ] Add link to `CODE_OF_CONDUCT.md` to the wiki?

---------

Co-authored-by: Madis Otenurm <Madis0@users.noreply.github.com>
2024-03-20 20:48:14 +01:00

16 KiB

FO logo

Fabulously Optimized

Official Website Support and Contribute Read the Wiki

Mod list Changed Options Resource Packs Help us Translate

Discord GitHub Mastodon

A simple Minecraft modpack focusing on performance and graphics enhancements.

Download

Installation Guide CurseForge Modrinth

By downloading Fabulously Optimized, you have acknowledged the disclaimers.

We recommend and support five launchers, all of which can be used offline on 🪟 Windows, 🐧 Linux and 🍏 macOS.

See this table for a comparison between the launchers:

Launcher Tutorial Install Upgrade Add mods Support us and mods
CurseForge App 🔗 Open  Easy  Easy  Easy  Yes
Modrinth App 🔗 Open  Easy  Easy  Easy  Yes
Prism Launcher 🔗 Open  Easy  Easy  Easy ⏺️[2]
MultiMC 🔗 Open  Easy  Manual  Manual ⏺️[2]
MultiMC (auto-update) 🔗 Open  Easy ⏺️[1]  Manual ⏺️[2]
Minecraft Launcher (vanilla) 🔗 Open  Manual  Manual  Manual ⏺️[2]

Note

[1]: Updates to the modpack within the same Minecraft version are automatic. The modpack cannot be updated automatically across Minecraft versions.

[2]: These launchers support the modpack and its mods by increasing their download count, but not with monetary benefits.

Download Resource Packs separately

FO includes some resource packs for a better experience, but they can also be downloaded separately.

Resource Pack CurseForge Modrinth Planet Minecraft
Chat Reporting Helper CurseForge Modrinth Planet Minecraft
Fast Better Grass CurseForge Modrinth Planet Minecraft

Credits

Special thanks to:

  • jellysquid3 for creating Sodium, Lithium, Phosphor which were the initial inspiration for creating the modpack
  • LambdAurora for creating the list of OptiFine alternatives which the pack does get some mod ideas from, and LambDynamicLights
  • comp500 for creating Jumploader - a mod that made the modpack possible in Minecraft 1.16.x, Indium - mod that provided the rendering API for Sodium for increased mod compatibility and packwiz - a tool that makes the MultiMC auto-update happen
  • Mod devs who have joined the Discord and are discussing the modpack's development there
  • All developers who made the mods that are, have been and will be in the modpack
  • Everyone who uses, tests and shares the modpack!