diff --git a/about/contribute/README.md b/about/contribute/README.md new file mode 100644 index 00000000..22a1e162 --- /dev/null +++ b/about/contribute/README.md @@ -0,0 +1,6 @@ +--- +hidden: true +icon: heart +--- + +# Contribute diff --git a/about/contribute/fork.md b/about/contribute/fork.md new file mode 100644 index 00000000..67ec84e2 --- /dev/null +++ b/about/contribute/fork.md @@ -0,0 +1,50 @@ +--- +hidden: true +icon: code-fork +--- + +# Fork + +{% hint style="info" %} +Read more about [FO's license](https://github.com/Fabulously-Optimized/fabulously-optimized/blob/main/LICENSE.md). +{% endhint %} + +YOU are allowed to fork/remix Fabulously Optimized as long as YOU adhere to the license. In particular, YOU may not use the "Fabulously Optimized" or "FO" names nor logo to represent YOUR fork. + +YOU may mention that YOU forked FO. YOU can use the following badges (created by [Devin](https://intergrav.github.io/devins-badges-docs)) for forks: + +{% tabs %} +{% tab title="Preview" %} +[![Built on Fabulously Optimized](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/fabulously-optimized_64h.png)](https://download.fo/) + +[![Built on Fabulously Optimized](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/built-with/fabulously-optimized_46h.png)](https://download.fo) +{% endtab %} + +{% tab title="Markdown" %} +```md +[![Built on Fabulously Optimized](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/fabulously-optimized_64h.png)](https://download.fo/) +``` + +```md +[![Built on Fabulously Optimized](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/built-with/fabulously-optimized_46h.png)](https://download.fo) +``` +{% endtab %} + +{% tab title="HTML" %} +```html + + + Built on Fabulously Optimized + +``` + +```html + + + Built on Fabulously Optimized + +``` +{% endtab %} +{% endtabs %} + +The same terms also apply for [FO's resource packs](../../info/resource-packs/): YOU may not use the names nor logos FO uses to represent YOUR remixes. diff --git a/about/contribute/translate.md b/about/contribute/translate.md new file mode 100644 index 00000000..2306762d --- /dev/null +++ b/about/contribute/translate.md @@ -0,0 +1,129 @@ +--- +hidden: true +icon: language +--- + +# Translate + +In accordance to the [Accessibility principle](../#accessibility), one of FO's objectives is making it accessible to everyone, regardless of their language. This is why we support and welcome translations of FO and of its mods. + +## Mods + +1. Check out the [list of mods in FO](../../info/mods/). The most important mods are: + * [Sodium](translate.md#sodium) + * [Sodium Extra](https://crowdin.com/project/sodium-extra) + * [Mod Menu](https://crowdin.com/project/mod-menu) + * [Fabric API and Installer](https://crowdin.com/project/fabricmc) + * [Iris](https://github.com/IrisShaders/Iris/blob/multiloader-new/common/src/main/resources/assets/iris/lang/en_us.json) + * [MoreCulling](https://github.com/fxmorin/MoreCulling/blob/master/common/src/main/resources/assets/moreculling/lang/en_us.json) + * [Controlify](https://github.com/isXander/Controlify/blob/1.20.x/dev/src/main/resources/assets/controlify/lang/en_us.json) + * [Zoomify](https://github.com/isXander/Zoomify/blob/multiversion/dev/src/main/resources/assets/zoomify/lang/en_us.json) + * [Fabric Capes](https://github.com/CaelTheColher/Capes/blob/architectury/common/src/main/resources/assets/capes/lang/en_us.json) + * [Continuity](https://github.com/PepperCode1/Continuity/blob/1.19.3/dev/src/main/resources/assets/continuity/lang/en_us.json) + * [CIT Resewn](https://github.com/SHsuperCM/CITResewn/blob/main/src/main/resources/assets/citresewn/lang/en_us.json) +2. For each mod you want to translate, open its page +3. Find the link to Source code +4. Read the mod's documentation to understand if translations happen on a translation platform +5. If not, find the path where language files are memorized, generally under the **Code** tab, in `src/main/resources/assets/mod-name/lang/en_us.json` (sometimes under a `common/` folder) +6. Copy that file's content +7. In the `lang` folder, click on the **Add file** button +8. Click on the **Create new file** button. This should fork the repo +9. Name the file following the [language codes format](https://minecraft.wiki/w/Language#Languages). For example `en_ud.json` +10. Paste the content you copied in _step 6_ +11. Start translating the values inside of the quotes, on the right side of the colon. For example: + + ```json + "cool-mod.config.title": "Cool Mod Options", + ``` + + Translate `Cool Mod Options` only! +12. Commit the file +13. Create a pull request +14. You're now done, you just have to wait: + * The author must accept your translations + * The mod must be updated to include your contribution + * FO must be updated to include the new version of the mod + +### Sodium + +Sodium does not support translations natively, but the creators of Sodium Extra and FO have created an independent resource pack to add translations to Sodium. FO includes the [Translations for Sodium resource pack](../../info/resource-packs/#translations-for-sodium). + +To translate Sodium, open its [unofficial page on Crowdin](https://crowdin.com/project/sodium-fabric). Translations are published every Saturday, and FO versions right after will include them. + +Read more about [localization in Sodium natively](https://github.com/CaffeineMC/sodium-fabric/issues/2304). + +## Resource Packs + +{% tabs %} +{% tab title="Translator" %} +1. Join the [FO project on Crowdin](https://download.fo/crowdin) +2. Translate the files you prefer. Files are sorted according to the priority +3. Vote for existing suggestions with the **Plus** and **Minus** buttons +4. Discuss or ask for information in the comments +5. Join the [FO Discord server](https://download.fo/discord) to get a yellow rank for translating a file to 100%. The rank gives access to some secret channels ;) +6. You'll get an email and a Discord notification when there are new phrases to translate +{% endtab %} + +{% tab title="Proofreader" %} +1. To become a proofreader, you must ask on the Discord server after getting the yellow rank +2. Check and approve all strings. Files must be 100% approved to be accepted +3. Test the [Mod Menu Helper resource pack](../../info/resource-packs/#mod-menu-helper) and [Chat Reporting Helper](../../info/resource-packs/#chat-reporting-helper)'s description in-game + +The resource pack must be tested because there are specific length requirements: + +* Translations must be fully visible in a maximized Full HD 1920×1080 window, with the default font, or with the Unicode font if required. You can emulate such a window in-game: + 1. Open **Options...** + 2. Open **Video Settings...** + 3. Set **Fullscreen Resolution** to `1920x1080@60 (24 bit)` (The number after `@` may vary) + 4. Check the **Fullscreen** checkbox + 5. Click on **Apply** + 6. If you're experiencing issues, press ⇧ Shift + P to reset to default settings + 7. Click on **Done** +* The [online translations tester](https://download.fo/size-checker) may help, but does not replace in-game testing +* Feel free to rephrase sentences if you see fit +* In the options row, list as many of them as you can fit +* Do NOT change the strings' format! Keep paragraph signs `§`, the tools `⚒️` and arrows `🔀` emoji, and newlines `\n` intact + +To test the translation in-game: + +1. In Crowdin, open the **Mod Menu Helper** file (not _All strings_!) +2. Click on the **menu** button in the top-left corner +3. Click on the **Download** button. You'll get a `xx_xx.json` file +4. In Minecraft, open **Options...** +5. Open **Resource Packs...** +6. Click on **Open Pack Folder** +7. Open the `Mod Menu Helper.zip` file. If the `zip` file gets extracted, open the extracted folder +8. Navigate to `assets/fo/lang` +9. Drag the file you downloaded in _step 3_ and drop it into the folder you opened in _step 9_ +10. In Minecraft, if the `zip` file got extracted in _step 8_, activate it +11. Click on **Done** +12. Click on **Done** +13. Open a world or a server, and press F3 + T (sometimes Fn + F3 + T) to reload the resource pack +14. In the main menu, click on the **Mods** button to open the Mod Menu +15. Make sure the translations fit the criteria above +16. Click on **Back** +17. Click on **Options...** +18. Click on **Resource Packs...** +19. Make sure the translations fit the criteria above +{% endtab %} +{% endtabs %} + +## Website + +The website is almost entirely translatable, except the wiki, which would get outdated very quickly. + +Do NOT change the strings' format! If the original says `[Hello World!][1]`, you should only translate `Hello World!` + +Translation testing is recommended for proofreaders: + +1. Approve all translations on Crowdin. You may have to wait for some time +2. Find the latest ["New Crowdin updates" pull request on GitHub](https://github.com/Fabulously-Optimized/website/pulls?q=is:pr+is:open+New+Crowdin+updates) +3. Find a comment by the user `vercel` +4. Click on the **Visit Preview** link in that comment +5. Navigate the website and make sure translations are correct + +## Installer + +Most messages on the installer, except for some very detailed errors, are translatable. + +However, translation testing is not very easy, so it's not required. diff --git a/about/fabric.md b/about/fabric.md new file mode 100644 index 00000000..517de8aa --- /dev/null +++ b/about/fabric.md @@ -0,0 +1,25 @@ +--- +hidden: true +icon: scroll-old +--- + +# Fabric + +FO uses Fabric, instead of NeoForge, for the following reasons: + +* **Popular**: there are [at least 10000 Fabric mods on CurseForge](https://www.curseforge.com/minecraft/search?gameVersionTypeId=4) and [over 20000 Fabric mods on Modrinth](https://modrinth.com/mods?g=categories:fabric) + +* **Supported**: most authors of NeoForge mods nowadays support Fabric as well, if not exclusively +* **Compatible**: Fabric mod developers work together to keep their mods compatible with each other +* **Easy installation**: there's a [Fabric installer](https://fabricmc.net/use/installer), which supports many launchers +* **Fast updates**: on the same day as Minecraft, and so do many mods +* **Fast loading**: roughly the same as vanilla Minecraft +* **Small size**: no huge libraries, just the [Fabric Loader](https://fabricmc.net/use) and the [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api) + +{% hint style="success" %} +If you're coming from NeoForge, you can find a community-maintained [list of Fabric mods corresponding to NeoForge mods](https://gist.github.com/TrueCP6/4853f15015b210fd3b1e210e9e485f83). +{% endhint %} diff --git a/about/optifine.md b/about/optifine.md new file mode 100644 index 00000000..ee96d94e --- /dev/null +++ b/about/optifine.md @@ -0,0 +1,92 @@ +--- +hidden: true +icon: reflect-horizontal +--- + +# OptiFine + +In accordance to the [Familiarity principle](./#familiarity), one of FO's objectives is achieving parity with [OptiFine](https://optifine.net/), to ease the transition away from it. + +However, FO has more to offer than just OptiFine features! You can enjoy: + +* Faster updates to newer Minecraft versions. Read more about [FO's versioning](versioning.md) +* Better compatibility with other mods. See the [instructions for adding mods](../how-to/add-mods/) +* Easier installation on more launchers. See the [installation instructions](../how-to/install/) +* Extra features OptiFine does not provide. See the [list of functional mods in FO](../info/mods/#functional) + +This is a list of OptiFine features, and their status in FO. You can also check out the [parity-related issue list](https://github.com/Fabulously-Optimized/fabulously-optimized/issues?q=is:issue%20is:open%20label:parity). + +{% hint style="info" %} +The [mods included in FO](../info/mods/) are inspired by but not limited to the [_Recommended OptiFine alternatives on Fabric_ by LambdAurora](https://optifine.alternatives.lambdaurora.dev/). +{% endhint %} + +## Video Options + +| Option | Provider | Notes | +| --------------------- | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| Animation toggles | [Sodium Extra](https://www.curseforge.com/minecraft/mc-mods/sodium-extra) | | +| Anti-Aliasing | [Iris](https://www.curseforge.com/minecraft/mc-mods/irisshaders) | [Tutorial](../info/mods/shaders.md) | +| Better Grass | [BetterGrassify](https://curseforge.com/minecraft/mc-mods/bettergrassify) | | +| Custom capes | [Capes](https://www.curseforge.com/minecraft/mc-mods/capes) | [Tutorial](../info/mods/capes.md) | +| Detail toggles | [Sodium Extra](https://www.curseforge.com/minecraft/mc-mods/sodium-extra) | | +| Dynamic Lights | [LambDynamicLights](https://www.curseforge.com/minecraft/mc-mods/lambdynamiclights) | | +| HD Screenshots | [Fabrishot](https://www.curseforge.com/minecraft/mc-mods/fabrishot) | | +| Miscellaneous toggles | [Sodium Extra](https://www.curseforge.com/minecraft/mc-mods/sodium-extra) | | +| Particle toggles | [Sodium Extra](https://www.curseforge.com/minecraft/mc-mods/sodium-extra) | | +| Performance | [_multiple mods_](../info/mods/#smooth) | | +| Shaders | [Iris](https://www.curseforge.com/minecraft/mc-mods/irisshaders) | [Tutorial](../info/mods/shaders.md) | +| Smart Leaves | [MoreCulling](https://www.curseforge.com/minecraft/mc-mods/moreculling) | ···[^1] | +| Zoom | [Zoomify](https://www.curseforge.com/minecraft/mc-mods/zoomify) | ···[^2] | +| 32+ Render Distance | ❌[^3] [Farsight](https://www.curseforge.com/minecraft/mc-mods/farsight-fabric) | [Issue #656](https://github.com/Fabulously-Optimized/fabulously-optimized/issues/656) | +| Anisotropic Filtering | ❌[^4] _Not possible_ | [Discussion](https://discord.com/channels/756612889787498627/876567546390777856/978673913770950687) on [Discord](https://discord.gg/7rnTYXu) | + +## Advanced Resource Pack Features + +{% hint style="warning" %} +If you're having issues with a resource pack that uses these features, see the [guide to fix resource pack issues](../info/resource-packs/issues.md). +{% endhint %} + +| Option | Provider | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Animated Textures | [Animatica](https://www.curseforge.com/minecraft/mc-mods/animatica), [MoreMcmeta](https://www.curseforge.com/minecraft/mc-mods/moremcmeta-fabric) | +| Connected Textures | [Continuity](https://www.curseforge.com/minecraft/mc-mods/continuity) | +| Custom Colors | [Polytone](https://www.curseforge.com/minecraft/mc-mods/polytone) | +| Custom Entity Models | [Entity Model Features](https://www.curseforge.com/minecraft/mc-mods/entity-model-features) | +| Custom GUIs | [OptiGUI](https://www.curseforge.com/minecraft/mc-mods/optigui) | +| Custom Loading Screen | [Puzzle](https://www.curseforge.com/minecraft/mc-mods/puzzle) | +| Emissive Blocks | [Continuity](https://www.curseforge.com/minecraft/mc-mods/continuity) | +| Emissive Entities | [Entity Texture Features](https://www.curseforge.com/minecraft/mc-mods/entity-texture-features-fabric) | +| HD Fonts |

Minecraft 1.13

Find HD Fonts by FO's author

| +| Natural Textures |

Minecraft 1.8

See discussion on Discord

| +| Random Entities | [Entity Texture Features](https://www.curseforge.com/minecraft/mc-mods/entity-texture-features-fabric) | +| Removal of gaps in items | [Model Gap Fix](https://www.curseforge.com/minecraft/mc-mods/model-gap-fix) | +| Custom Items | 🚧[^5] | +| Custom Sky | 🚧[^6] | + +[^1]: Not identical to OptiFine, as people did not prefer the look. If you want it to be identical: + + 1. Disable MoreCulling + 2. Add the [Cull Leaves](https://www.curseforge.com/minecraft/mc-mods/cull-leaves) mod + 3. Enable Cull Leaves' bundled resource pack + 4. Open **Options** + 5. Open **Video Settings...** + 6. Open **Performance** + 7. Disable **Use Block Face Culling** + +[^2]: Not identical to OptiFine, as people preferred a smoother zoom. If you want it to be identical: + + 1. Click on the **Mods** button + 2. Find and click on **Zoomify** + 3. Click on the **Configure** icon in the top-left + 4. Click on the **Misc** tab + 5. Select the **OptiFine** preset + +[^3]: No longer supported + +[^4]: Not supported + +[^5]: [CIT Resewn](https://www.curseforge.com/minecraft/mc-mods/cit-resewn) until FO 7.0.0\ + Partially available from Minecraft 1.21.5. See [issue #524 on CIT Resewn](https://github.com/SHsuperCM/CITResewn/issues/524) + +[^6]: [FabricSkyboxes](https://www.curseforge.com/minecraft/mc-mods/fabricskyboxes), [FabricSkyBoxes Interop](https://www.curseforge.com/minecraft/mc-mods/fabricskyboxes-interop) until FO 7.0.0\ + Partially available with [shaders](../info/mods/shaders.md) diff --git a/about/servers.md b/about/servers.md new file mode 100644 index 00000000..ac31011c --- /dev/null +++ b/about/servers.md @@ -0,0 +1,132 @@ +--- +hidden: true +icon: server +--- + +# Servers + +FO does not require any special setup server-side: any server compatible with vanilla should be supported. However, we've compiled a list of recommendations for server-side setup. + +{% hint style="warning" %} +All content on this page is just a suggestion, and FO does not offer support for server setup. If you need help with it, please ask in the respective mod or platform support site. +{% endhint %} + +## Share Your World + +Did you know FO allows you to play with anyone on your singleplayer worlds, even on different networks? If that's all you'd need a server for, there's no need for it: + +1. Open your singleplayer world +2. Press Esc +3. Click on **Open to Internet**. You should see an address in chat +4. Send the address from chat to your friend. Your friend will need to use your same version of Minecraft. + +## Optimize Server Software + +{% hint style="danger" %} +Avoid using Realms! Read more in the [Player Reporting article](../info/mods/player-reporting.md). +{% endhint %} + +For the best performance, use one of the following server software options: + +* [Paper](https://papermc.io/) +* [Pufferfish](https://github.com/pufferfish-gg/Pufferfish) +* [Purpur](https://github.com/PurpurMC/Purpur) + +Those are optimized forks of Spigot, and support all Spigot plugins. + +If you want to use Fabric instead: + +1. [Install Fabric on a server](https://fabricmc.net/use/?page=server). +2. Add [server-side optimization mods](https://modrinth.com/mods?o=20\&f=categories:%27optimization%27\&g=categories:%27fabric%27\&nf=categories:cursed\&v=1.21.1\&e=server). + +If you need a host, consider [BisectHosting (affiliate link)](https://download.fo/host) for a 25% discount for the first month, while supporting FO financially. Thank you! + +## Write Rules for Your Server + +Please be careful when writing rules for your server, to avoid putting unnecessary restrictions on users: + +| ❌ DON'T | ✅ DO | Rationale | +| -------------------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Only OptiFine allowed | Performance and visual-enhancing mods are allowed | There are multiple mods tackling and solving the same issues, you shouldn't limit players to one specific mod | +| Only mini-map mod "X" is allowed | Mini-map mods with player radar disabled are allowed |

Allowing one mod by name ties users to its updates, excluding all alternatives.

Also, mods may change their default configuration or add features your rules disallow at any time, so you should specify which features are acceptable

| +| Max 25 mods allowed | _nothing_ | Arbitrary mod counts do not benefit anything at all, since some may be huge and do many things, while others are very small | +| Only Forge mods are allowed | _nothing_ | Restricting certain mod loaders does more harm than good to your player base and to the Minecraft ecosystem as a whole | + +{% hint style="success" %} +A generally good rule of thumb is: restrict behaviors, not mods. +{% endhint %} + +## Configure Player Reporting + +{% hint style="info" %} +Read more on the ["Protecting Server Players" page in the No Chat Reports wiki](https://github.com/Aizistral-Studios/No-Chat-Reports/wiki/Protecting-server-players). +{% endhint %} + +Minecraft 1.19.1 introduced chat reporting, which many servers disable. As a server admin, you can do the following: + +* If you're on **1.18.2 or earlier**, there's no need to do anything, as Player Reporting didn't exist yet + * FO users will see this icon: ![Chat Reporting is optional](https://i.ibb.co/hstcjW7/neutral.png) + * Vanilla users will see a gray bar next to the messages, and their messages will not be reportable +* If you're on **1.19 or newer**: + * Set `enforce-secure-profile` to `false` in `server.properties`, to allow users to not sign messages + * FO users will see this icon: ![Chat Reporting is optional](https://i.ibb.co/hstcjW7/neutral.png) + * Vanilla users will see a warning toast in the top-right corner, but their messages will still be reportable + * Some hosts use different configuration files: + * Velocity: set `force-key-authentication` to `false` in `velocity.toml` + * BungeeCord: set `enforce_secure_profile` to `false` in `config.yml` + * Install a plugin to completely disable Player Reporting: + * Vanilla: no known workarounds exist. Please consider using a mod loader + * Paper/Purpur/Pufferfish: install the [FreedomChat plugin](https://modrinth.com/mod/freedomchat) + * Set `rewrite-chat` and `send-prevents-chat-reports-to-client` to `true` in FreedomChat's configuration + * FO users will see this icon: ![Chat Reporting is disabled](https://i.ibb.co/QDFzXCT/secure.png) + * Vanilla users will see a gray bar next to the messages, and their messages will not be reportable + * Fabric/NeoForge: install the [No Chat Reports mod](https://modrinth.com/mod/no-chat-reports) + * FO users will see this icon: ![Chat Reporting is disabled](https://i.ibb.co/QDFzXCT/secure.png) + * Vanilla users will see a gray bar next to the messages, and their messages will not be reportable + * Quilt: no known workarounds exist. Please consider using another mod loader + * LAN worlds: host with FO or install the [No Chat Reports mod](https://modrinth.com/mod/no-chat-reports) on the clients + * FO users will see this icon: ![Chat Reporting is disabled](https://i.ibb.co/QDFzXCT/secure.png) + * Vanilla users will see a gray bar next to the messages, and their messages will not be reportable + * LAN-like worlds ([e4mc](https://e4mc.link/), [World Host](https://modrinth.com/mod/world-host), [Essential](https://essential.gg/)...): host with FO or install the [No Chat Reports mod](https://modrinth.com/mod/no-chat-reports) on the clients + * FO users will see this icon: ![Chat Reporting is optional](https://i.ibb.co/hstcjW7/neutral.png) + * Vanilla users will see a warning toast in the top-right corner, but their messages will still be reportable + * Realms: almost impossible to circumvent + * Mojang monitors ALL chats in Realms! Read more in the [Player Reporting article](../info/mods/player-reporting.md) + * FO users will see this icon: ![Chat Reporting is mandatory on Realms](https://i.ibb.co/gTxw84X/realms.png) + * Vanilla users will not be warned at all, but their messages will be reportable + * You could: + * Use alternative methods to chat. Read more in the [Player Reporting article](../info/mods/player-reporting.md) + * Use the [No More Chat Reports datapack](https://www.planetminecraft.com/data-pack/no-more-chat-reports-datapack), and use the book only to chat + * Consider relying on [BisectHosting (affiliate link)](https://download.fo/host) for a 25% discount for the first month, while supporting FO financially and avoiding surveillance altogether. Thank you! + +## Allow Client Version Flexibility + +{% hint style="warning" %} +Before following this section, you should [configure Player Reporting](servers.md#configure-player-reporting). +{% endhint %} + +Some servers rely on plugins for support of multiple client versions. These plugins transform network packets, so they can, for example, allow users of FO who temporarily play on outdated versions to still join such servers. + +* To allow users to join with a client version _newer_ than the server's, use **ViaVersion** + * This by default allows versions between your server's and the latest release +* To allow users to join with a client version _older_ than the server's, use **ViaBackwards** + * This by default allows versions between `1.8` and your server's + * Newer blocks and entities will show as older types with equivalent properties +* If you're running Fabric on your server, consider using **ViaFabric** + +If your server is hub-based, prefer installing the plugins on each backend server rather than the proxy. + +## Allow Minecraft: Bedrock Edition Players to Join + +With [GeyserMC](https://geysermc.org/), you can allow Minecraft: Bedrock Edition players to join your Java server. Note that there can be incompatibilities and glitches, particularly with anti-cheat plugins, as the two editions are very different technically. + +## Add Server-Side Content Mods + +You can add new content like blocks and items to the server, without requiring users to install mods! Check out [Patbox's _Mods using Polymer_ list](https://github.com/Patbox/polymer/blob/dev/1.21/MODS.md), built for [Polymer](https://modrinth.com/mod/polymer). + +Alternatively, check out [PolyMc](https://theepicblock.github.io/PolyMc) (not to be confused with the [PolyMC launcher](unsupported.md#polymc)). Note that PolyMc may not be compatible with ViaVersion and ViaBackwards. + +## Other Recommendations + +* Recruit voluntary moderators for your server +* Use anti-cheat plugins diff --git a/about/unsupported.md b/about/unsupported.md new file mode 100644 index 00000000..5830e0d6 --- /dev/null +++ b/about/unsupported.md @@ -0,0 +1,149 @@ +--- +hidden: true +icon: ban +--- + +# Unsupported + +FO is a Fabric pack for Minecraft: Java Edition. Because of this, it does not support the following platforms: + +## Bedrock Edition + +FO is a pack for Minecraft: Java Edition, so it does not support Bedrock at all. + +However, one of [FO's principles](./#familiarity) is focusing on parity with Bedrock Edition if possible. + +## Other Modpacks + +FO does not officially support nor recommend being installed with other modpacks, because conflicts would most likely arise. + +You may want to [add custom mods](../how-to/add-mods/) instead. + +{% hint style="info" %} +If you still want to do it on your responsibility, you may install the other modpack first, then copy FO's files on it. See the [manual tab in the vanilla installation instructions](../how-to/install/vanilla.md). + +Note that you will not be able to get help from FO, and probably not from the other modpack either. +{% endhint %} + +## Other Loaders + +FO is based on [Fabric](fabric.md), and does not support other mod loaders. + +### NeoForge + +FO does not support [NeoForge](https://neoforged.net/). + +FO does not plan on ever supporting NeoForge, because it is slower, it takes longer to update, and it does not support Fabric's optimizations. + +If you're coming from NeoForge, you can [add the corresponding mods to FO](../how-to/add-mods/), which you can find in a community-maintained [list of Fabric mods corresponding to NeoForge mods](https://gist.github.com/TrueCP6/4853f15015b210fd3b1e210e9e485f83). There is also work being done to support NeoForge mods on Fabric, via [PatchWork](https://patchworkmc.net/). + +### Quilt + +FO does not support [Quilt](https://quiltmc.org/). + +It is unlikely that FO will ever support Quilt. However, if many mods decide to migrate to Quilt, FO may support it in the future. + +FO is tracking the sustainability and popularity of Quilt in [issue #257](https://github.com/Fabulously-Optimized/fabulously-optimized/issues/257). + +## Game Clients + +FO is not compatible with "game clients", including "PvP clients". + +You may want to [add custom mods](../how-to/add-mods/) instead. + +FO itself is not a client for the following reasons: + +* We would have to maintain more code, which is beyond FO's objective +* We would need explicit permission from all mod authors +* The authors would likely receive no benefits from the client +* We would get less flexibility in what we can do with FO +* We would need a way to keep it sustainable, such as ads or similar + +## Other Launchers + +FO officially supports the [installation on five launchers](../how-to/install/). That does not mean the installation on other launchers is impossible, but FO will not be able to help you in such case. + +### ATLauncher + +ATLauncher is not supported because of its confusing and complex interface. However, if that changes, FO may support ATLauncher. + +### GDLauncher Carbon + +FO may support [GDLauncher Carbon](https://gdlauncher.com/en/blog/curseforge-partnership-announcement) in the future. + +### GDLauncher Legacy + +GDLauncher Legacy is not supported because it is outdated and it has other technical issues. + +Follow these instructions to migrate to [Prism Launcher](https://prismlauncher.org/): + +1. Open **GDLauncher Legacy** +2. Right-click on the previously-used instance +3. Click on the **Open Folder** button +4. Follow the [FO installation instructions for Prism Launcher](../how-to/install/prism-launcher.md) +5. In Prism Launcher, click on the **Folder** button on the left +6. Move the following files from the folder you opened in _step 3_ to the folder you opened in _step 5_: + * `saves`: Your local worlds + * `resourcepacks`: Your resource packs, if any. If you're asked to replace files, do not! + * `shaders`: Your shaders, if any + * `screenshots`: Your screenshots, if any + * `server.dat`: Your multiplayer servers, if any + * `options.txt`: Your custom options and keybinds, if any. If you want the [recommended FO settings](../info/options/), do not copy it +7. Check if the instance in Prism Launcher works +8. Uninstall GDLauncher Legacy + +### PolyMC + +{% hint style="danger" %} +PolyMC is compromised! You should switch away immediately! + +Follow these instructions to migrate to [Prism Launcher](https://prismlauncher.org/), a safe fork of PolyMC. +{% endhint %} + +1. Uninstall PolyMC +2. Install [Prism Launcher](https://prismlauncher.org/) +3. Open **Prism Launcher**. You should get a prompt +4. Pay attention to what the prompt says. If it says: + * > It looks like you used PolyMC before. Do you want to migrate your data to the new location of Prism Launcher? + * Click on the **Yes** button to migrate automatically + * > Old data from PolyMC was found, but you already have existing data for Prism Launcher. Sadly you will need to migrate yourself. Do you want to be reminded of the pending data migration next time you start Prism Launcher? + 1. Click on the **No** button to close the prompt + 2. Open PolyMC's `instances` directory: + * Windows: `%APPDATA%/PolyMC/instances` + * macOS: `~/Library/Application Support/PolyMC/instances` + * Linux: `~/.local/share/PolyMC/instances` + * Portable: `PolyMC/instances` + 3. Copy all files and folders from that folder + 4. In Prism Launcher, click on the **Folders** button + 5. Click on the **View Instance Folder** button + 6. Paste the files you copied in _step 3_ in the folder you opened in _step 5_ + 7. Close and reopen Prism Launcher. You should find all of your instances there + 8. Sign into your accounts and complete Prism Launcher's configuration +5. Follow the [FO installation instructions for Prism Launcher](../how-to/install/prism-launcher.md) + +### Cracked launchers + +FO does not support any launcher that lets you run the game without having purchased it. Choose and use one of the [five launchers supported by FO](../how-to/install/). + +{% hint style="success" %} +There is a way to obtain Minecraft for cheaper: you can use a [gift code from a trusted reseller (affiliate link)](https://download.fo/minecraft). Thank you! +{% endhint %} + +#### Pojav Launcher + +Pojav Launcher is not supported because of the following drawbacks: + +* It is a [cracked launcher](./#cracked-launchers) because it allows piracy +* Long and complicated installation process +* High energy usage and battery drain +* Poor performance, as it doesn't support Sodium +* Incompatible with [FO's settings](../info/options/) +* No longer available on the Google Play Store + +FO isn't considering supporting Pojav Launcher in the future. + +#### TLauncher + +{% hint style="danger" %} +TLauncher is malware! You should [reset your entire OS](https://howtogeek.com/202590/stop-trying-to-clean-your-infected-computer-just-nuke-it-and-reinstall-windows)! +{% endhint %}