Every Compat

Tired of incomplete wood sets? Well you came to the right place!

This Mod serves as an addon to many popular mods and is meant to fill in the gaps by adding all the blocks that such mods add in all wood types currently installed.

Every block type added is available in ALL wood types.

With this mod you won't need extra compatibility addons and instead only rely on a single universal one! It's all automatic!

Check out CurseForge or Modrinth for more details

API to support your mod with Every Compat (Wood Good)

KEY POINTS to keep in mind:

1. If your mod is multi-platform with blocks' class being in COMMON, then you can put the module in COMMON to support your mod
2. If blocks' class is in FORGE and FABRIC, then you'll need to create 2 modules in both FABRIC & FORGE's folder

ATTENTION: if your mod is already supported heavily consider reaching out to incorporate some EC integration code in your mod itself for future proofing/stability

---

DEVELOPMENT:

REQUIRED DEPENDENCIES:

• Moonlight Lib - Has WoodType, LeavesType, and dynamic asset/data generation
• Every Compat - Has SimpleEntrySet, SimpleModule

Importing Dependencies --------------------------------------------------------------------------------------------

To import EveryCompat & Moonlight in your dev environment, There are 3 mavens that you can use from (RECOMMENDATION: SomethingCatchy.com)

MAVENS FOR EVERY COMPAT:

LOADER: method(URL)

• SomethingCatchy.net:

  • FABRIC: method("net.mehvahdjukaar:everycomp-fabric:${everycomp_version}:fabric") { transitive = false }
  • COMMON: method("net.mehvahdjukaar:everycomp:${everycomp_version}") { transitive = false }
  • NEOFORGE: method("net.mehvahdjukaar:everycomp-neoforge:${everycomp_version}:neoforge") { transitive = false }

• CURSEFORGE:

  • method("every-compat-628539:${ec_version}")

• MODRINTH:

  • FABRIC: method("maven.modrinth:every-compat:${everycomp_version}-fabric")
  • NEOFORGE: method(maven.modrinth:every-compat:${everycomp_version}-neoforge)

MAVENS FOR MOONLIGHT LIB:

• SomethingCatchy.net:

  • FABRIC: method("net.mehvahdjukaar:moonlight-fabric:${moonlight_version}:fabric") { transitive = false }
  • COMMON: method("net.mehvahdjukaar:moonlight:${moonlight_version}") { transitive = false }
  • NEOFORGE: method("net.mehvahdjukaar:moonlight-neoforge:${moonlight_version}:neoforge") { transitive = false }

• CURSEFORGE:

  • method("curse.maven:selene-499980:${ml_version}")

• MODRINTH:

  • FABRIC: method("maven.modrinth:moonlight:${moonlight_version}-fabric")
  • NEOFORGE: method("maven.modrinth:moonlight:${moonlight_version}-neoforge")

EXAMPLE: build.gradle

repositories {
    maven { url = "https://registry.somethingcatchy.net/repository/maven-releases/" } // EveryCompat, Moonlight

// Assuming that you already have these in your build.gradle if you don't want to use above
    maven { url = "https://api.modrinth.com/maven" }
    maven { url = "https://www.cursemaven.com" }
}

dependencies {

// NOTE: USING method(URL) above

// If using Architectury-Loom
    modApi(URL)
      // Example
    modApi("net.mehvahdjukaar:everycomp-neoforge:${everycomp_version}:neoforge") { transitive = false }`

// If using ForgeGradle
    compileOnly fg.deobf(URL)
      // Example
    compileOnly fg.deobf("net.mehvahdjukaar:everycomp-neoforge:${everycomp_version}:neoforge")
    

NOTES:

SomethingCatchy Version & Modrinth Version:

where ${everycomp_version} is version and you can find via URL below to get the latest version:

MOONLIGHT: https://registry.somethingcatchy.net/#browse/search/generic=keyword%3Dmoonlight EVERYCOMPAT: https://registry.somethingcatchy.net/#browse/search/generic=keyword%3Deverycomp

example:

• SomethingCatchy - modCompileOnly("net.mehvahdjukaar:everycomp:1.21-2.11.26") { transitive = false }
• modrinth - modCompileOnly(maven.modrinth:every-compat:1.21-2.11.26-neoforge)

Curseforge Version:

Where ${ec_version} is the version number you can see in CurseForge after clicking on a particular file version. For example 6974680 is for 1.21.1-2.11.3-fabric You can also click on "Curse Maven Snippet" in the files section of a particular file to get this same import line this way. Remember to use modCompileOnly

example: modCompileOnly("every-compat-628539:6974680")

CREATE YOUR MODULE and CLASS --------------------------------------------------------------------------------------

Once you have done that, to interact with EveryCompat, all will happen through the Every Compat API class.

common/src/main/java/net/mehvahdjukaar/every_compat/api/EveryCompatAPI.java

it has 3 usages:

1. Using EveryCompatAPI.registerModule(new WoodGoodModule(mod_Id)) to add the module to EveryCompat to support your mod
2. Using EveryCompatAPI.addOtherCompatMod(String, List<String>, List<String>) to add a compat Mod that your mod is already supported with Wood Mods
3. Add an undetected WoodType or LeavesType from your mod, an example is provided in EveryCompatAPI

Take a look at how the module is supporting blocks or items from a mod (detail level is general):

common/src/main/java/net/mehvahdjukaar/every_compat/api/example/WoodGoodModule.java

To register a custom module and non-detected wood type in your mod: common/src/main/java/net/mehvahdjukaar/every_compat/api/example/WoodGoodAddon.java

If you want a high detail level example of how is this applied, then you can check below:

1. GuitaWoodworks-Init - Initization
2. GuitaWoodworks-EveryCompatModule - Checking if EveryCompat is installed
3. ModCompat - Using EveryCompatAPI.registerModule(...)
4. WoodGoodModule

Making a Module

Modules are plugins that you can register to EC. They contain many extension points, but the simplest way to use them is via EntrySet. Particularly the base implementation SimpleEntrySet. To add support for a wooden furniture block, simply call this.addEntry(entrySet) where entrySet is a SimpleEntrySet made by its own descriptive builder SimpleEntrySet.builder(). Use the builder to provide details like textures, recipes, and tags, even if your mod already declares those things elsewhere. EC will then use that information to target the base block you specified, clone it for each missing wood type and add all its needed assets and things. That's it, really it's simpler than you might expect.

For more extension points, check out all the EntrySet builder methods. Or for more advanced stuff, use the overrides in the module, or subclass entryset if needed. EC has plenty of examples in its own modules implemetation for other mods, so check those out too if in doubt.

NOTIFICATION

If you added an module in your mod, then you can go to Every Compat's github to create a new issue using "Built-In Module Notification" to let DEV know. This way Your mod will be added to the table listing supported mods via Curseforge or Modrinth.