Modstitch

https://isxander.github.io/modstitch-docs/
Admin
Modstitch is a Gradle plugin that unifies official tooling for Fabric and (Neo)Forge using...
Tokens:1,160
Snippets:17
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Clone Modstitch Template Project

Source: https://isxander.github.io/modstitch-docs/guide/getting-started/setup

Use this command to clone the official Modstitch template project from GitHub to start your development.

```shell
git clone https://github.com/modunion/modstitch-stonecutter-template
```

--------------------------------

### Configure Project Targets in settings.gradle.kts

Source: https://isxander.github.io/modstitch-docs/guide/getting-started/setup

Define the Minecraft versions and loader targets for your project within the stonecutter block in settings.gradle.kts. This example configures targets for 1.21.4 and 1.20.1.

```kotlin
stonecutter {
    kotlinController = true
    centralScript = "build.gradle.kts"

    create(rootProject) {
        fun mc(mcVersion: String, name: String = mcVersion, loaders: Iterable<String>) = 
            loaders.forEach { vers("$name-$it", mcVersion) }

        // Configure your targets here!
        mc("1.21.4", loaders = listOf("fabric", "neoforge")) 
        mc("1.20.1", loaders = listOf("forge"))

        // This is the default target.
        // https://stonecutter.kikugie.dev/stonecutter/guide/setup#settings-settings-gradle-kts
        vcsVersion = "1.21.4-fabric"
    }
}
```

--------------------------------

### Configure Mod Metadata in build.gradle.kts

Source: https://isxander.github.io/modstitch-docs/guide/getting-started/setup

Set essential mod identification details like ID, name, version, group, and author within the metadata block of your build.gradle.kts file.

```kotlin
// the metadata files found in the templates folder.
metadata {
    modId = "examplemod"
    modName = "Example Mod"
    modVersion = "1.0.0"
    modGroup = "com.example"
    modAuthor = "John Doe, Patrina Doe, Jill Doe"

    fun <K, V> MapProperty<K, V>.populate(block: MapProperty<K, V>.() -> Unit) {

```

--------------------------------

### Add Custom Replacement Properties

Source: https://isxander.github.io/modstitch-docs/guide/getting-started/setup

Populate the replacementProperties block in build.gradle.kts to include additional metadata or configuration values not directly supported by Modstitch.

```kotlin
replacementProperties.populate {
    // You can put any other replacement properties/metadata here that
    // modstitch doesn't initially support. Some examples below.
    put("mod_issue_tracker", "https://github.com/modunion/modstitch/issues") 
    put("pack_format", when (property("deps.minecraft")) {
        "1.20.1" -> 15

```
Tokens:
Raw