mirrors/fabulously-optimized
1
0
Fork 1
mirror of https://github.com/Fabulously-Optimized/fabulously-optimized.git synced 2024-05-18 05:22:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
its-miroma 2024-02-29 15:14:58 +01:00
parent 13f9f17697
commit 6c1a44d639
No known key found for this signature in database
3 changed files with 165 additions and 74 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
CREDITS.md
View file

@ -1,20 +0,0 @@
# Credits
### Direct contributions
* [TheYTG123](https://www.curseforge.com/members/theytg123/projects) on CurseForge who helped me with Jumploader to release the 1.16.3 version a little faster
* [triphora](https://github.com/triphora) who suggested and helped with the Modrinth format and formerly moderated FO Discord server
* [RozeFound](https://github.com/RozeFound) for helping with Python scripts and providing lots of constructive feedback for the pack
* [TheMadHau5](https://github.com/themadhau5), [redbrain](https://github.com/redbrain), [Kichura](https://github.com/Kichura) for the [fancy mod table](https://github.com/Fabulously-Optimized/fabulously-optimized/blob/main/INCLUDED-MODS.md)
* [RaptaG](https://github.com/RaptaG) and [Ultrasonic1209](https://github.com/Ultrasonic1209) for the [Packwiz mod ignoring tutorials](https://fabulously-optimized.gitbook.io/modpack/readme/multimc-auto-update#can-i-ignore-some-of-the-mods)
* Other people creating pull requests for [the main project](https://github.com/Fabulously-Optimized/fabulously-optimized/graphs/contributors) and [the wiki](https://github.com/Fabulously-Optimized/wiki/graphs/contributors)
* [People who have created videos about the modpack](https://github.com/Fabulously-Optimized/fabulously-optimized#reviews)
* Everyone who has suggested ideas and reported bugs!
### Additional thanks
* [jellysquid3](https://github.com/jellysquid3) for creating [Sodium](https://www.curseforge.com/minecraft/mc-mods/sodium), [Lithium](https://www.curseforge.com/minecraft/mc-mods/lithium), [Phosphor](https://www.curseforge.com/minecraft/mc-mods/phosphor) which were my initial inspiration for creating the modpack
* [LambdAurora](https://github.com/LambdAurora) for creating [the list of OptiFine alternatives](https://lambdaurora.dev/optifine_alternatives) which the pack does get some mod ideas from, [LambDynamicLights](https://www.curseforge.com/minecraft/mc-mods/lambdynamiclights) and [LambdaBetterGrass](https://www.curseforge.com/minecraft/mc-mods/lambdabettergrass)
* [comp500](https://github.com/comp500) for creating [Jumploader](https://www.curseforge.com/minecraft/mc-mods/jumploader) - a mod that made the modpack possible in Minecraft 1.16.x, [Indium](https://modrinth.com/mod/indium) - mod that provided the rendering API for Sodium for increased mod compatibility and [packwiz](https://github.com/comp500/packwiz) - a tool that makes the MultiMC auto-update and in the future, vanilla installer happen
* Mod devs that have joined my 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!

214
README.md
View file

@ -1,49 +1,165 @@
# Fabulously Optimized
A Fabric-based Minecraft modpack focusing on performance and graphics enhancements.
[**📜 Mod list**](INCLUDED-MODS.md) | [**🎛️ Changed options**](https://wiki.download.fo/readme/changed-options) | [**❤️ Support and contribute**](https://download.fo/thanks)
<a href="https://wiki.download.fo/"><img alt="Wiki" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/documentation/gitbook_vector.svg"></a>
<a href="https://download.fo/translate"><img alt="Translate" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/translate/generic-plural_vector.svg"></a>
<a href="https://download.fo/rate"><img alt="Rate" height="40" src="https://github.com/PSGitHubUser1/fabulously-optimized/assets/90406016/c2b91fcf-0d7c-41ec-8af6-b4a5671c8bed"></a>
<a href="https://download.fo/discord"><img alt="Discord" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/social/discord-plural_vector.svg"></a>
<a href="https://download.fo/mastodon"><img alt="Mastodon" height="40" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/social/mastodon-plural_vector.svg"></a>
## Downloads
[![Download from CurseForge](https://cf.way2muchnoise.eu/full_fabulously-optimized_downloads%20on%20CurseForge.svg?badge_style=for_the_badge)](https://download.fo/curseforge) [![Modrinth](https://img.shields.io/modrinth/dt/fabulously-optimized?logo=modrinth&color=darkgreen&label=Download%20from%20Modrinth&style=for-the-badge)](https://download.fo/modrinth)
<a href="https://download.fo/install"><img alt="How to install" height="28" src="https://github.com/Fabulously-Optimized/fabulously-optimized/assets/8611110/0aaed593-9791-4d24-8a64-8552e6bffa07"></a>
<sub>By downloading Fabulously Optimized, you have acknowledged [the disclaimers](https://download.fo/terms).</sub>
We encourage using CurseForge App, Modrinth App, Prism Launcher, MultiMC, or official Minecraft Launcher.
Not sure which edition is right for you? Check this handy table!
| Feature/Edition | [CurseForge App](https://www.curseforge.com/download/app) | [Modrinth App](https://modrinth.com/app) | [Prism Launcher](https://prismlauncher.org/) | [MultiMC](https://multimc.org) | [MultiMC](https://multimc.org) (auto-update) | [Minecraft Launcher](https://www.minecraft.net/en-us/download) (vanilla - manual install) |
|---|---|---|---|---|---|---|
| Installation tutorial | [Tutorial](https://wiki.download.fo/readme/install-instructions#curseforge-app) | [Tutorial](https://wiki.download.fo/readme/install-instructions#modrinth-app) | [Tutorial](https://wiki.download.fo/readme/install-instructions#prism-launcher) | [Tutorial](https://wiki.download.fo/readme/install-instructions#multimc) | [Tutorial](https://wiki.download.fo/readme/install-instructions#multimc-auto-update) | [Tutorial](https://wiki.download.fo/readme/install-instructions#minecraft-launcher-vanilla) |
| Easy install | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
| Easy pack upgrade | ✅ | ✅ | ✅ | ❌ | ✅ | ❌ |
| Easy pack upgrade for newer MC | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
| Add mods with few clicks | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
| Supports the modpack and mods | ✅ | ✅ | ●¹ | ●¹ | ●¹ | ●¹ |
| Can be used offline | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Windows, macOS, Linux support | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Unique feature | 1-click install from site | Import from other launchers | Steam Deck support | Nostalgic UI | Always up to date | Familiarity |
¹ Supports the modpack by increasing its download count, but not with monetary benefits.
<details>
<summary>Alternative downloads</summary>
_These downloads may not fully support the modpack or the mods :(_
* [MultiMC (auto-update)](https://wiki.download.fo/readme/multimc-auto-update): [1.16.5](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.2.3/Fabulously.Optimized.MC.1.16.5.auto-update.zip) | [1.17.1](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.2.3/Fabulously.Optimized.MC.1.17.1.auto-update.zip) | [1.18.2](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.12.2/Fabulously.Optimized.MC.1.18.2.auto-update.zip) | [1.19.4](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v4.10.0/Fabulously.Optimized.MC.1.19.4.auto-update.zip) | [1.20.2](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v5.6.5/Fabulously.Optimized.MC.1.20.2.auto-update.zip) | [1.20.4](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v5.8.0-beta.11/Fabulously.Optimized.MC.1.20.4.auto-update.zip)
* [GitHub releases](https://github.com/Fabulously-Optimized/fabulously-optimized/releases)
* Chat Reporting Helper resource pack: [CurseForge](https://www.curseforge.com/minecraft/texture-packs/chat-reporting-helper) |
[Modrinth](https://modrinth.com/resourcepack/chat-reporting-helper) |
[Planet Minecraft](https://www.planetminecraft.com/texture-pack/chat-reporting-helper) (bundled in FO)
* Fast Better Grass resource pack: [CurseForge](https://www.curseforge.com/minecraft/texture-packs/fast-better-grass) | [Modrinth](https://modrinth.com/resourcepack/fast-better-grass) | [Planet Minecraft](https://www.planetminecraft.com/texture-pack/fast-better-grass) (bundled in FO)
</details>
<img
src="https://download.fo/icon.png"
alt="Fabulously Optimized logo"
align="right" width="10%" height="10%"
/>
# [Fabulously Optimized][url-website] #
<!-- ( ): add badges -->
[`Website`][url-website]
[`Wiki`][url-wiki]
[`Discord`][url-discord]
[`Mastodon`][url-mastodon]
[`❤️ Support & Contribute`][url-thanks]
[`GitHub`][url-github]
[`Translate`][url-translate]
[`Rate`][url-rate]
> Tell your friends to [download.fo][url-website]!
A simple Minecraft modpack focusing on performance
and graphics enhancements.
- [Mods][file-mods]
- [Options][url-options]
- [Resource Packs][url-rp]
## Downloads ##
> By downloading Fabulously Optimized, you have
> acknowledged the [disclaimers][url-terms].
[`CurseForge`][url-cf]
[`Modrinth`][url-modrinth]
[`Installation Guide`][url-install]
We recommend and support the following launchers:
- [CurseForge App][url-app-cf]
- [Modrinth App][url-app-modrinth]
- [Prism Launcher][url-app-prism]
- [MultiMC][url-app-multimc]
- [Minecraft Launcher (vanilla)][url-app-vanilla]
- Or download from [GitHub releases][url-app-github]
Read more in the [Installation Guide][url-install].
<details><summary>Compare the launchers</summary>
All launchers can be used offline, and they run on
🪟 Windows, 🐧 Linux and 🍏 macOS.
| Launcher | Tutorial | Installing | Upgrading | Adding mods | Supporting modpack and mods |
| ------------------------------------------------- | ----------------------------- | :--------: | :-------: | :---------: | :-------------------------: |
| 🔨 [CurseForge App][url-app-cf] | [Open][url-tutorial-cf] | ✅ Easy | ✅ Easy | ✅ Easy | ✅ Yes |
| ⭐ [Modrinth App][url-app-modrinth] | [Open][url-tutorial-modrinth] | ✅ Easy | ✅ Easy | ✅ Easy | ✅ Yes |
| 💎 [Prism Launcher][url-app-prism] | [Open][url-tutorial-prism] | ✅ Easy | ✅ Easy | ✅ Easy | ➖ Partially |
| 🪟 [MultiMC][url-app-multimc] | [Open][url-tutorial-multimc] | ✅ Easy | ❌ Manual | ❌ Manual | ➖ Partially |
| 🔄️ [MultiMC (auto-update)][url-app-multimc] | [Open][url-tutorial-mmcu] | ✅ Easy | ❌ Manual* | ❌ Manual | ➖ Partially |
| 🧊 [Minecraft Launcher (vanilla)][url-app-vanilla] | [Open][url-tutorial-vanilla] | ❌ Manual | ❌ Manual | ❌ Manual | ➖ Partially |
| 🐙 [GitHub releases][url-app-github] | _None_ | ❌ Manual | ❌ Manual | ❌ Manual | ❌ No |
*: Upgrading to newer MC is manual (?)
➖: These launchers support the modpack by increasing
its download count, but not with monetary benefits.
<!-- ( ): MultiMC auto-update
- more info at <https://wiki.download.fo/readme/multimc-auto-update>
- [1.16.5](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.2.3/Fabulously.Optimized.MC.1.16.5.auto-update.zip)
- [1.17.1](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.2.3/Fabulously.Optimized.MC.1.17.1.auto-update.zip)
- [1.18.2](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v3.12.2/Fabulously.Optimized.MC.1.18.2.auto-update.zip)
- [1.19.4](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v4.10.0/Fabulously.Optimized.MC.1.19.4.auto-update.zip)
- [1.20.2](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v5.6.5/Fabulously.Optimized.MC.1.20.2.auto-update.zip)
- [1.20.4](https://github.com/Fabulously-Optimized/fabulously-optimized/releases/download/v5.8.0-beta.11/Fabulously.Optimized.MC.1.20.4.auto-update.zip)
-->
</details>
### Resource Packs ###
FO includes some resource packs [for a better experience][url-rp],
and they can also be downloaded separately.
| Resource Pack | CurseForge | Modrinth | Planet Minecraft |
| ------------------------- | --------------------------- | ------------------------------- | ---------------------------------- |
| **Chat Reporting Helper** | [CurseForge][url-rp-crh-cf] | [Modrinth][url-rp-crh-modrinth] | [Planet Minecraft][url-rp-crh-pmc] |
| **Fast Better Grass** | [CurseForge][url-rp-fbg-cf] | [Modrinth][url-rp-fbg-modrinth] | [Planet Minecraft][url-rp-fbg-pmc] |
## Contribute ##
Thanks for your interest in contributing to FO! There are many things
you can help us with:
- Tell your friends to [download.fo][url-website] by sharing the link!
- [Leave a ❤️ and comment on AlternativeTo][url-rate]
- Play using the [CurseForge App][url-cf] or the [Modrinth App][url-modrinth]
- And more... see [our Thanks page][url-thanks]
All contributions must respect the [Code of Conduct][file-conduct].
### Credits ###
<details><summary>Direct contributions</summary>
- [TheYTG123](https://www.curseforge.com/members/theytg123/projects) on CurseForge who helped me with Jumploader to release the 1.16.3 version a little faster
- [triphora](https://github.com/triphora) who suggested and helped with the Modrinth format and formerly moderated FO Discord server
- [RozeFound](https://github.com/RozeFound) for helping with Python scripts and providing lots of constructive feedback for the pack
- [TheMadHau5](https://github.com/themadhau5), [redbrain](https://github.com/redbrain), [Kichura](https://github.com/Kichura) for the [fancy mod table](https://github.com/Fabulously-Optimized/fabulously-optimized/blob/main/INCLUDED-MODS.md)
- [RaptaG](https://github.com/RaptaG) and [Ultrasonic1209](https://github.com/Ultrasonic1209) for the [Packwiz mod ignoring tutorials](https://fabulously-optimized.gitbook.io/modpack/readme/multimc-auto-update#can-i-ignore-some-of-the-mods)
- Other people creating pull requests for [the main project](https://github.com/Fabulously-Optimized/fabulously-optimized/graphs/contributors) and [the wiki](https://github.com/Fabulously-Optimized/wiki/graphs/contributors)
- [People who have created videos about the modpack](https://github.com/Fabulously-Optimized/fabulously-optimized#reviews)
- Everyone who has suggested ideas and reported bugs!
</details>
<details><summary>Special thanks</summary>
- [jellysquid3](https://github.com/jellysquid3) for creating [Sodium](https://www.curseforge.com/minecraft/mc-mods/sodium), [Lithium](https://www.curseforge.com/minecraft/mc-mods/lithium), [Phosphor](https://www.curseforge.com/minecraft/mc-mods/phosphor) which were my initial inspiration for creating the modpack
- [LambdAurora](https://github.com/LambdAurora) for creating [the list of OptiFine alternatives](https://lambdaurora.dev/optifine_alternatives) which the pack does get some mod ideas from, [LambDynamicLights](https://www.curseforge.com/minecraft/mc-mods/lambdynamiclights) and [LambdaBetterGrass](https://www.curseforge.com/minecraft/mc-mods/lambdabettergrass)
- [comp500](https://github.com/comp500) for creating [Jumploader](https://www.curseforge.com/minecraft/mc-mods/jumploader) - a mod that made the modpack possible in Minecraft 1.16.x, [Indium](https://modrinth.com/mod/indium) - mod that provided the rendering API for Sodium for increased mod compatibility and [packwiz](https://github.com/comp500/packwiz) - a tool that makes the MultiMC auto-update and in the future, vanilla installer happen
- Mod devs that have joined my 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!
</details>
<!-- Files -->
<!-- ( ): should be in the wiki -->
[file-conduct]: <CODE_OF_CONDUCT.md>
[file-mods]: <INCLUDED-MODS.md>
<!-- URLs -->
[url-app-cf]: <https://www.curseforge.com/download/app>
[url-app-github]: <https://github.com/Fabulously-Optimized/fabulously-optimized/releases>
[url-app-modrinth]: <https://modrinth.com/app>
[url-app-multimc]: <https://multimc.org>
[url-app-prism]: <https://prismlauncher.org>
[url-app-vanilla]: <https://www.minecraft.net/en-us/download>
[url-cf]: <https://download.fo/curseforge>
[url-discord]: <https://download.fo/discord>
[url-github]: <https://download.fo/github>
[url-install]: <https://download.fo/install>
[url-mastodon]: <https://download.fo/mastodon>
[url-modrinth]: <https://download.fo/modrinth>
[url-options]: <https://wiki.download.fo/readme/changed-options>
[url-rate]: <https://download.fo/rate>
[url-rp]: <https://wiki.download.fo/readme/changed-options#resource-packs>
[url-rp-crh-cf]: <https://www.curseforge.com/minecraft/texture-packs/chat-reporting-helper>
[url-rp-crh-modrinth]: <https://modrinth.com/resourcepack/chat-reporting-helper>
[url-rp-crh-pmc]: <https://www.planetminecraft.com/texture-pack/chat-reporting-helper>
[url-rp-fbg-cf]: <https://www.curseforge.com/minecraft/texture-packs/fast-better-grass>
[url-rp-fbg-modrinth]: <https://modrinth.com/resourcepack/fast-better-grass>
[url-rp-fbg-pmc]: <https://www.planetminecraft.com/texture-pack/fast-better-grass>
[url-terms]: <https://download.fo/terms>
[url-thanks]: <https://download.fo/thanks>
[url-translate]: <https://download.fo/translate>
[url-tutorial-cf]: <https://wiki.download.fo/readme/install-instructions#curseforge-app>
[url-tutorial-mmcu]: <https://wiki.download.fo/readme/install-instructions#multimc-auto-update>
[url-tutorial-modrinth]: <https://wiki.download.fo/readme/install-instructions#modrinth-app>
[url-tutorial-multimc]: <https://wiki.download.fo/readme/install-instructions#multimc>
[url-tutorial-prism]: <https://wiki.download.fo/readme/install-instructions#prism-launcher>
[url-tutorial-vanilla]: <https://wiki.download.fo/readme/install-instructions#minecraft-launcher-vanilla>
[url-website]: <https://download.fo>
[url-wiki]: <https:/download.fo/wiki>

5
Resource Packs/README.md
View file

@ -1,5 +0,0 @@
Fabulously Optimized includes some resource packs for a better experience. These resource packs only change very specific resources, and they are compatible with other resource packs.
[What do they do?](https://fabulously-optimized.gitbook.io/modpack/readme/changed-options#resource-packs)
[How to translate?](https://fabulously-optimized.gitbook.io/modpack/readme/language-support#mod-menu-helper)