Mekanism Documentation

Developers can use the Mekanism API by adding the ModMaven repository to their project. Mekanism v10+ is hosted on ModMaven.

To integrate Mekanism, you must update your build.gradle to include the ModMaven repository and define your dependencies. Use compileOnly for the API to avoid leaking Mekanism internals into your mod's jar, and use runtimeOnly with fg.deobf if you need to run the mod or its modules during local development (e.g., during runClient).

repositories {
    maven { url 'https://modmaven.dev/' }
}

dependencies {
    compileOnly "mekanism:Mekanism:${mekanism_version}:api"
    
    // If you want to test/use Mekanism & its modules during `runClient` invocation, use the following
    runtimeOnly fg.deobf("mekanism:Mekanism:${mekanism_version}")// Mekanism
    runtimeOnly fg.deobf("mekanism:Mekanism:${mekanism_version}:additions")// Mekanism: Additions
    runtimeOnly fg.deobf("mekanism:Mekanism:${mekanism_version}:generators")// Mekanism: Generators
    runtimeOnly fg.deobf("mekanism:Mekanism:${mekanism_version}:tools")// Mekanism: Tools
}

The BinInsertRecipe is a specialized crafting recipe in Mekanism that allows players to insert items into a Bin using a crafting grid.

Recipe Requirements:

• Exactly one Bin: The crafting grid must contain exactly one ItemBlockBin stack. The bin stack must have a count of 1.
• Target Items: The grid must contain one or more stacks of the same item type (matching both item and components).
• Grid Size: The crafting grid must have at least two slots to accommodate both the bin and the item(s).

Behavior:

• When the recipe is triggered, the items are inserted into the Bin's internal inventory.
• If the Bin reaches capacity, the remaining items stay in the crafting grid as getRemainingItems.
• The resulting item is the Bin stack, which is marked with the MekanismDataComponents.FROM_RECIPE component to handle post-crafting logic (such as attempting to pull excess items from the grid into the bin).

The /radiation command allows administrators to add, get, heal, or reduce radiation levels at specific locations or for specific entities.

Subcommands

• add <magnitude> [location] [dimension]: Adds a specified radiation magnitude to a location.
  • magnitude: A double value (minimum Double.MIN_VALUE, maximum 10,000).
  • location (optional): A Vec3 coordinate.
  • dimension (optional): The dimension for the location.
• addEntity [targets] <magnitude>: Adds radiation directly to an entity or a group of entities.
  • targets (optional): One or more entities.
  • magnitude: A double value.
• get [location] [dimension]: Retrieves the radiation level at a specific location.
  • location (optional): A Vec3 coordinate.
  • dimension (optional): The dimension for the location.
• heal [targets]: Resets the radiation level of the user or specified entities to the baseline radiation level.
  • targets (optional): One or more entities.
• reduce [targets] <magnitude>: Reduces the radiation level of the user or specified entities by a given magnitude.
  • targets (optional): One or more entities.
  • magnitude: A double value.
• removeAll: Clears all radiation sources from the world. Requires specific permissions.