Skip to content

Compatibility

embeddedt edited this page Sep 11, 2023 · 17 revisions

In order to avoid confusion and frustration over Embeddium's mod compatibility policy, this document aims to provide objective categorization of interactions between Embeddium and other mods, and outline the exact support policy for each.

Mod Tiers

Mods that interact with Embeddium can be separated into several tiers. The overwhelming majority of mods are Tier 1, and should work fine. Only those with fancier/more exotic rendering fall into the latter two tiers.

  • Tier 1 - regular content mod without mixins into vanilla chunk rendering or Rubidium's renderer. For the most part, these mods are expected to work out of the box, and if there are issues, it is usually Embeddium's fault, and should be reported to Embeddium.
  • Tier 2 - mod which patches the vanilla chunk renderer. These mods usually work for the most part, but some rendering may be broken when used with Embeddium. Fixing this usually requires modifications to the mod to add Embeddium-specific rendering logic as well. This is not possible for Embeddium to fix easily, as much of the performance gain comes from not directly using the vanilla chunk renderer.
  • Tier 3 - mod which directly interacts with Rubidium internals, by mixins or otherwise. This should be avoided at all costs, as these mods are very likely to break with future Embeddium updates. Most Rubidium addons fall into this category. On 1.19.2 and older, the original addon will generally work; on newer versions, you should look for Embeddium versions of the same mods (for example, Embeddium Extra and TexTrue's Embeddium Options).

Known incompatibilities

(NB: Minecraft versions are listed without the 1. prefix for brevity.)

  • [18.2/19.2] Effective - Tier 2 mod; relies on mixin into vanilla chunk rendering to know when to display particles. Fixes have already been provided to the mod, but it has not received an update since October 2022.
  • [20.1] Flywheel - some Create rendering may not function, workaround available. This will be fixed by an upcoming Flywheel update. The issue is simply that it hasn't yet updated to work with Sodium 0.5.2.
  • [20.1] Physics Mod - Tier 3 mod; interacts with Sodium code directly.
Clone this wiki locally