Generating NeoForge metadata

When you build a mod, the neoforge metadata file is needed to ensure it is loaded properly by the mod loader. Tableau has a module that will generate this file for you, and configure other modules based on this information.

Configuring metadata

Groovy

tableau {
    mod {
        // Mod information
        modId = 'modid' // Use your own modid here.
        group = 'com.example' // Use your own group here.
        minecraftVersion = '1.21.3' // Or any other minecraft version.
        publisher = 'SomePublisher' // Use your own name here.
        url = 'https://github.com/someorg/modid' // Use your own URL here.
    }

    sourceSets {
        main {
            metadata {
                license = "GNU"
                loaderVersion = "1.2.3"

                mods {
                    modid {
                        description = "The amazing example mod" 
                        displayName = "Example Mod" 

                        dependencies {
                            required 'com.ldtteam:domumornamentum:[123,)]'
                        }
                    }
                }
            }
        }
    }
}

Kotlin

tableau {
    mod {
        // Mod information
        modid.set("modid") // Use your own modid here.
        group.set("com.example") // Use your own group here.
        minecraftVersion.set("1.21.3") // Or any other minecraft version.
        publisher.set("SomePublisher") // Use your own name here.
        url.set("https://github.com/someorg/modid") // Use your own URL here.
    }

    sourceSets {
        main {
            metadata {
                license.set("GNU")
                loaderVersion.set("1.2.3")

                mods {
                    modid {
                        description.set("The amazing example mod")
                        displayName.set("Example Mod")

                        dependencies {
                            required 'com.ldtteam:domumornamentum:[123,)]'
                        }
                    }
                }
            }
        }
    }
}

note

You can find a full example of this project configuration in the Shadowing Example on GitHub.