From e59763f52c4029821cec854d2ec62d7e26afd0c9 Mon Sep 17 00:00:00 2001 From: its-miroma <136986257+its-miroma@users.noreply.github.com> Date: Wed, 20 Mar 2024 18:53:17 +0100 Subject: [PATCH] Apply review by @Madis0 - Refactor `url-thanks` to `url-contribute` - Refactor "Options changed" to "Changed Options" - Remove manual word wrap - Remove mention of GitHub Releases - Use reference links in the "Credits" section - Fix `url-wiki` --- README.md | 92 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 53 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index fb0325906..7f9e0858e 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ # Fabulously Optimized [![Official Website][img-website]][url-website] -[![Support and Contribute][img-thanks]][url-thanks] +[![Support and Contribute][img-contribute]][url-contribute] [![Read the Wiki][img-wiki]][url-wiki] [![Mod list][img-mods]][file-mods] -[![Options changed][img-options]][url-options] +[![Changed Options][img-options]][url-options] [![Resource Packs][img-rp]][url-rp] [![Help us Translate][img-translate]][url-translate] @@ -17,8 +17,7 @@ [![GitHub][img-github]][url-github] [![Mastodon][img-mastodon]][url-mastodon] -A simple Minecraft modpack focusing on performance -and graphics enhancements. +A simple Minecraft modpack focusing on performance and graphics enhancements. @@ -28,14 +27,9 @@ and graphics enhancements. [![CurseForge][img-cf]][url-cf] [![Modrinth][img-modrinth]][url-modrinth] -> By downloading Fabulously Optimized, you have -> acknowledged the [disclaimers][url-terms]. +> By downloading Fabulously Optimized, you have acknowledged the [disclaimers][url-terms]. -We recommend and support five launchers, but you can also -download the modpack from [GitHub Releases][url-app-github]. - -All five launchers can be used offline, and they run on -🪟 Windows, 🐧 Linux and 🍏 macOS. +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: @@ -50,17 +44,13 @@ See this table for a comparison between the launchers: > [!NOTE] > -> **[1]**: Updates to the modpack within the same Minecraft version -> are automatic. The modpack cannot be updated automatically -> across Minecraft versions. +> **[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. +> **[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][url-rp], -but they can also be downloaded separately. +FO includes some resource packs [for a better experience][url-rp], but they can also be downloaded separately. | Resource Pack | CurseForge | Modrinth | Planet Minecraft | | ------------------------- | --------------------------- | ------------------------------- | ---------------------------------- | @@ -71,20 +61,20 @@ but they can also be downloaded separately. ## Credits -- [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) +- [TheYTG123][url-credits-TheYTG123] on CurseForge who helped with Jumploader to release the 1.16.3 version a little faster +- [triphora][url-credits-triphora] who suggested and helped with the Modrinth format and formerly moderated FO Discord server +- [RozeFound][url-credits-RozeFound] for helping with Python scripts and providing lots of constructive feedback for the pack +- [TheMadHau5][url-credits-TheMadHau5], [redbrain][url-credits-redbrain], [Kichura][url-credits-Kichura] for the [fancy mod table][file-mods] +- [RaptaG][url-credits-RaptaG] and [Ultrasonic1209][url-credits-Ultrasonic1209] for the [Packwiz mod ignoring tutorials][url-tutorial-mmcu-ignoremods] +- Other people creating pull requests for [the main project][url-github-main-graph], [wiki][url-github-wiki-graph] and [other organization projects][url-github-org] +- [People who have created videos about the modpack][url-reviews] - Everyone who has suggested ideas and reported bugs! Special thanks to: -- [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 happen +- [jellysquid3][url-credits-jellysquid3] for creating [Sodium][url-credits-jellysquid3-sodium], [Lithium][url-credits-jellysquid3-lithium], [Phosphor][url-credits-jellysquid3-phosphor] which were my initial inspiration for creating the modpack +- [LambdAurora][url-credits-LambdAurora] for creating [the list of OptiFine alternatives][url-credits-LambdAurora-alternatives] which the pack does get some mod ideas from, [LambDynamicLights][url-credits-LambdAurora-LambDynamicLights] and [LambdaBetterGrass][url-credits-LambdAurora-LambdaBetterGrass] +- [comp500][url-credits-comp500] for creating [Jumploader][url-credits-comp500-Jumploader] - a mod that made the modpack possible in Minecraft 1.16.x, [Indium][url-credits-comp500-Indium] - mod that provided the rendering API for Sodium for increased mod compatibility and [packwiz][url-credits-comp500-packwiz] - a tool that makes the MultiMC auto-update 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! @@ -100,44 +90,68 @@ Special thanks to: [img-mastodon]: [img-modrinth]: [img-mods]: -[img-options]: +[img-options]: [img-rp]: -[img-thanks]: +[img-contribute]: [img-translate]: [img-website]: [img-wiki]: -[url-app-cf]: -[url-app-github]: +[url-app-cf]: [url-app-mmcu]: [url-app-modrinth]: [url-app-multimc]: [url-app-prism]: -[url-app-vanilla]: +[url-app-vanilla]: [url-cf]: +[url-credits-comp500]: +[url-credits-comp500-Jumploader]: +[url-credits-comp500-Indium]: +[url-credits-comp500-packwiz]: +[url-credits-jellysquid3]: +[url-credits-jellysquid3-lithium]: +[url-credits-jellysquid3-phosphor]: +[url-credits-jellysquid3-sodium]: +[url-credits-Kichura]: +[url-credits-LambdAurora]: +[url-credits-LambdAurora-alternatives]: +[url-credits-LambdAurora-LambdaBetterGrass]: +[url-credits-LambdAurora-LambDynamicLights]: +[url-credits-RaptaG]: +[url-credits-redbrain]: +[url-credits-RozeFound]: +[url-credits-TheMadHau5]: +[url-credits-TheYTG123]: +[url-credits-triphora]: +[url-credits-Ultrasonic1209]: [url-discord]: [url-github]: +[url-github-main-graph]: +[url-github-wiki-graph]: +[url-github-org]: [url-install]: [url-mastodon]: [url-modrinth]: [url-options]: [url-rate]: +[url-reviews]: [url-rp]: -[url-rp-crh-cf]: +[url-rp-crh-cf]: [url-rp-crh-modrinth]: -[url-rp-crh-pmc]: -[url-rp-fbg-cf]: +[url-rp-crh-pmc]: +[url-rp-fbg-cf]: [url-rp-fbg-modrinth]: -[url-rp-fbg-pmc]: +[url-rp-fbg-pmc]: [url-terms]: -[url-thanks]: +[url-contribute]: [url-translate]: [url-tutorial-cf]: [url-tutorial-mmcu]: +[url-tutorial-mmcu-ignoremods]: [url-tutorial-modrinth]: [url-tutorial-multimc]: [url-tutorial-prism]: [url-tutorial-vanilla]: [url-website]: -[url-wiki]: +[url-wiki]: