Stonecraft

https://stonecraft.meza.gg
Admin
Stonecraft is a configuration Gradle plugin that streamlines multi-loader and multi-version...
Tokens:11,263
Snippets:159
Trust Score:2.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example fabric.mod.json with Variable Substitution

Source: https://stonecraft.meza.gg/docs/variable-substitution

This JSON file demonstrates how to use Stonecraft's variable substitution for common mod metadata fields. Ensure these variables are defined in your build.gradle[.kts] file.

```json
{
  "schemaVersion": 1,
  "id": "${id}",
  "version": "${version}",
  "name": "${name}",
  "description": "${description}",
  "authors": [],
  "contact": {},
  "environment": "*",
  "entrypoints": {
    "main": [
      "${group}.${id}.ExampleMod"
    ]
  },
  "depends": {
    "fabricloader": "*",
    "fabric-api": ">= ${fabricVersion}",
    "minecraft": ">= ${minecraftVersion}"
  }
}
```

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

### Setting up clientOptions Block

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/clientoptions

Demonstrates the basic structure for setting up the clientOptions block within your modSettings configuration in build.gradle.kts.

```kotlin
modSettings {
  
    clientOptions {}
  
}
```

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

### Configure Stonecraft Directories

Source: https://stonecraft.meza.gg/docs/configuration

Set the run directory for the root project and the junit report location for submodules. Always use `layout` helper functions for robustness.

```kotlin
modSettings {
  
    runDirectory = rootProject.layout.projectDirectory.dir("run")  

    fabricClientJunitReportLocation = project.layout.buildDirectory.file("fabric-client-junit-report.xml")  

}
```

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

### Gradle Build Script Configuration Order

Source: https://stonecraft.meza.gg/docs/configuration/overriding

Demonstrates the correct order of configuration blocks in a Gradle build script to allow for overriding Stonecraft's default settings. Ensure `modSettings` and other Stonecraft configurations appear before general `repositories` and `dependencies`.

```gradle
plugins {

    id("gg.meza.stonecraft")

}


modSettings {}

repositories {}
dependencies {}

// Architectury related settings
fabricApi {}
loom {}

// Task overrides
tasks.processResources {}

// Mod publishing
publishMods {}


```

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

### Configure Additional Lines in build.gradle.kts

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/clientoptions/additionalLines

Use this snippet to define custom lines for the options.txt file within your build.gradle.kts file. Stonecraft does not validate these values, so ensure they are correct for Minecraft.

```kotlin
modSettings {
  
    clientOptions {
  
        additionalLines = mapOf(
  
            "fullscreen" to "true",
  
            "bobView" to "false",
  
            "pauseOnLostFocus" to "false",
  
            "modelPart_cape:true" to "false"
  
        )
  
    }
  
}

```

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

### Configure settings.gradle.kts for Stonecutter

Source: https://stonecraft.meza.gg/docs/Quickstart

Set up your settings.gradle.kts file to include necessary repositories and plugins for Stonecraft and Stonecutter. This configuration manages Minecraft versions and dependencies.

```gradle
pluginManagement {
  repositories {
      mavenCentral()
      gradlePluginPortal()
      maven("https://maven.kikugie.dev/releases")
      maven("https://maven.kikugie.dev/snapshots")
      maven("https://maven.fabricmc.net/")
      maven("https://maven.architectury.dev")
      maven("https://maven.minecraftforge.net")
      maven("https://maven.neoforged.net/releases/")
  }
}

plugins {
  id("gg.meza.stonecraft") version "1.9.+"

  id("dev.kikugie.stonecutter") version "0.8+"

}


stonecutter {
  centralScript = "build.gradle.kts"
  kotlinController = true
  shared {
      fun mc(version: String, vararg loaders: String) {
          // Make the relevant version directories named "1.20.2-fabric", "1.20.2-forge", etc.
          for (it in loaders) vers("$version-$it", version)

      }

      mc("1.21.3", "fabric", "forge", "neoforge")
      mc("1.21.4", "fabric", "forge", "neoforge")

  }

  create(rootProject)

}


rootProject.name = "YourModName"
```

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

### Conditional Imports and Constructor for NeoForge

Source: https://stonecraft.meza.gg/docs

This snippet illustrates conditional imports and a constructor specifically for NeoForge. It includes imports for NeoForge and a constructor that accepts `IEventBus` and `ModContainer`, while other loaders have their definitions commented out.

```java
/*? if fabric {*/  

/*import net.fabricmc.api.ModInitializer;*/  

/*?}*/  

  

/*? if forge {*/  

/*import net.minecraftforge.fml.common.Mod;  

import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;*/  

/*?}*/  

  

/*? if neoforge {*/  

import net.neoforged.fml.ModContainer;  

import net.neoforged.bus.api.IEventBus;  

import net.neoforged.fml.common.Mod;  

  

/*?}*/  

  

/*? if forgeLike {*/  

@Mod("examplemod")  

public class ExampleMod {  

/*?}*/  

  

/*? if fabric {*/  

/*public class ExampleMod implements ModInitializer {*/  

/*?}*/  

  

    /*? if forge {*/  

    /*public ExampleMod(final FMLJavaModLoadingContext context) {}*/  

    /*?}*/  

  

    /*? if neoforge {*/  

    public ExampleMod(IEventBus modEventBus, ModContainer modContainer) {}  

    /*?}*/  

  

    /*? if fabric {*/  

    /*@Override  

    public void onInitialize() {}*/  

    /*?}*/  

}

```

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

### Configure Modrinth and Curseforge Publishing

Source: https://stonecraft.meza.gg/docs/releasing-mods

Set up the `publishMods` block to configure publishing details for both Modrinth and Curseforge. This includes specifying dependencies like 'fabric-api' and 'cloth-config', and setting client/server requirements.

```gradle
publishMods {
  modrinth {
    if (mod.isFabric) {
      requires("fabric-api")
      optional("modmenu")
    }
    requires("cloth-config")
  }
  curseforge {
    clientRequired = false
    serverRequired = true
    if (mod.isFabric) {
      requires("fabric-api")
      optional("modmenu")
    }
    requires("cloth-config")
  }
}
```

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

### Set up Stonecutter in stonecutter.gradle.kts

Source: https://stonecraft.meza.gg/docs/Quickstart

Configure the stonecutter.gradle.kts file to activate a specific Minecraft version and loader combination for your build. This file applies the necessary plugins.

```gradle
plugins {

    id("dev.kikugie.stonecutter")

    id("gg.meza.stonecraft")

}


stonecutter active "1.21.4-fabric" /* [SC] DO NOT EDIT */
```

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

### Gradle Kotlin DSL for Dynamic Access Widener Path

Source: https://stonecraft.meza.gg/docs/access-widening

Configure the access widener path dynamically in your 'build.gradle.kts' based on the current Minecraft version using Stonecutter's evaluation.

```kotlin
val minecraft = stonecutter.current.version
val accesswidener = when {
    stonecutter.eval(minecraft, ">=1.21") -> "1.21.accesswidener"
    stonecutter.eval(minecraft, ">=1.20") -> "1.20.accesswidener"
    else -> "1.19.accesswidener"
}

loom {
    accessWidenerPath = rootProject.file("src/main/resources/accesswideners/$accesswidener")
}
```

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

### Configure Access Transformer File Path

Source: https://stonecraft.meza.gg/docs/access-widening

Define the access transformer configuration file path based on the Minecraft version. This uses a `when` expression to conditionally select the appropriate `.cfg` file.

```kotlin
val minecraft = stonecutter.current.version

val accesstransformer = when {

    stonecutter.eval(minecraft, ">=1.21") -> "1.21.cfg"

    stonecutter.eval(minecraft, ">=1.20") -> "1.20.cfg"

    else -> "1.20.cfg"

}

minecraft {

    accessTransformers {

        file(rootProject.file("src/main/resources/accesstransformers/$accesstransformer"))

    }

}
```

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

### Set musicVolume in Client Options

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/clientoptions/musicVolume

Configure the music volume within the client options block. This setting accepts a float value between 0.0 and 1.0.

```kotlin
modSettings {

    clientOptions {

        musicVolume = 1.0

    }

}

```

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

### Add Stonecraft Plugin to build.gradle.kts

Source: https://stonecraft.meza.gg/docs/Quickstart

Include the Stonecraft plugin in your build.gradle.kts file. Ensure it's added before the Architectury plugin if both are used.

```gradle
plugins {

   id("gg.meza.stonecraft")

}
```

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

### Configure Stonecutter for Snapshot Minecraft Version

Source: https://stonecraft.meza.gg/docs/configuration/overriding

In your `settings.gradle.kts` file, use the `mc()` function to specify the target Minecraft version, even if it hasn't been officially released. This prepares Stonecraft to use the snapshot properties file.

```gradle
  ...  
  mc("1.21.6", "fabric")  // 1.21.6 doesn't technically exist yet, but you can prepare for it  
  ...  

```

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

### NeoForge Access Transformer File Structure

Source: https://stonecraft.meza.gg/docs/access-widening

Organize your access transformer configuration files within the 'resources/accesstransformers/' directory, with separate files for each Minecraft version.

```plaintext
src.main.resources  

└── accesstransformers/  
    └── 1.20.cfg  
    └── 1.21.cfg  
```

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

### Override GameTest Server Run Directory (Simple String)

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/testRunDirectory

Use this method to directly set the run directory for the GameTest server when Loom requires a String instead of a Directory provider. Note the relative path.

```gradle
loom {
  runs {
    getByName("gameTestServer") {
      runDir = "../../run-test" // <- Loom needs a String, not a Directory provider :(
    }
  }
}

```

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

### Declare Compatible Plugin Versions for Snapshots

Source: https://stonecraft.meza.gg/docs/stonecutter-compatibility

Specify the Stonecraft and Stonecutter plugin versions to use when opting into the experimental snapshot channel. Ensure these versions are compatible as outlined in the documentation.

```gradle
plugins {
  id("gg.meza.stonecraft") version "1.9.+"
  id("dev.kikugie.stonecutter") version "0.8+"
}
```

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

### Add Snapshots Repository for Gradle Plugins

Source: https://stonecraft.meza.gg/docs/stonecutter-compatibility

Configure your Gradle build to resolve plugins from the snapshots repository. This is necessary when opting into snapshot builds for early access to unreleased changes.

```gradle
pluginManagement {
  repositories {
    maven("https://maven.meza.gg/snapshots")

    // keep your existing repos here
  }
}
```

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

### Conditional Imports and Class Definition for Mod Loaders

Source: https://stonecraft.meza.gg/docs

This snippet demonstrates conditional imports and class definitions based on the active mod loader (Fabric, Forge, NeoForge). It shows how to include specific imports and define the main mod class differently for each loader.

```java
/*? if fabric {*/  

import net.fabricmc.api.ModInitializer;  

/*?}*/  

  

/*? if forge {*/  

/*import net.minecraftforge.fml.common.Mod;  

import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;  

*/  

/*?}*/  

  

/*? if neoforge {*/  

/*import net.neoforged.fml.ModContainer;  

import net.neoforged.bus.api.IEventBus;  

import net.neoforged.fml.common.Mod;  

*/  

/*?}*/  

  

/*? if forgeLike {*/  

/*@Mod("examplemod")  

public class ExampleMod {*/  

/*?}*/  

  

/*? if fabric {*/  

public class ExampleMod implements ModInitializer {  

/*? }*/  

  

    /*? if forge {*/  

    /*public ExampleMod(final FMLJavaModLoadingContext context) {}*/  

    /*?}*/  

  

    /*? if neoforge {*/  

    /*public ExampleMod(IEventBus modEventBus, ModContainer modContainer) {}*/  

    /*?}*/  

  

    /*? if fabric {*/  

    @Override  

    public void onInitialize() {}  

    /*?}*/  

}

```

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

### Override GameTest Server Run Directory (Future-Proof Path)

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/testRunDirectory

This approach provides a more robust way to define the run directory path for the GameTest server, calculating it relative to the project directory. It ensures compatibility even if project structures change.

```gradle
loom {
  runs {
    getByName("gameTestServer") {
      val testDir = project.layout.projectDirectory.asFile.toPath().relativize(
        rootProject.layout.projectDirectory.dir("run-test").asFile.toPath()
      ).toString()

      runDir = testDir
    }
  }
}

```

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

### NeoForge TOML Access Transformer Template

Source: https://stonecraft.meza.gg/docs/access-widening

Define the access transformer file path in 'neoforge.mods.toml' using a string template that will be dynamically replaced.

```toml
[[accessTransformers]]
file="accesstransformers/${at_file}"
```

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

### Declare Additional Compatible Minecraft Versions

Source: https://stonecraft.meza.gg/docs/releasing-mods

Add extra Minecraft versions to `gradle.properties` using the `additional_versions` key to declare broader compatibility for your mod on publishing platforms.

```properties
additional_versions=1.21.3, 1.21.2
```

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

### Set Release Type for a Specific Mod

Source: https://stonecraft.meza.gg/docs/releasing-mods

Use the `is_snapshot` property in the `versions/dependencies/[miencraft_version].properties` file to control the release type for a specific mod. Setting it to `true` forces a beta release.

```properties
is_snapshot=true  

```

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

### Configure Stonecraft modSettings in Gradle

Source: https://stonecraft.meza.gg/docs/configuration/modsettings

Use this snippet to configure Stonecraft's modSettings in your build.gradle.kts file. It allows customization of client options, resource generation paths, JUnit report locations, and run directories.

```kotlin
plugins {

    id("gg.meza.stonecraft")

}


modSettings {

    clientOptions {

        additionalLines = mapOf<String, String>()

        darkBackground = false

        fov = 70

        guiScale = 3

        musicVolume = 1.0

        narrator = false

    }

  

    generatedResources = project.layout.projectDirectory.dir("src/main/generated")

  

    fabricClientJunitReportLocation = project.layout.buildDirectory.file("junit.xml")

    fabricServerJunitReportLocation = project.layout.buildDirectory.file("junit.xml")

  

    runDirectory = rootProject.layout.projectDirectory.dir("run")

    testClientRunDirectory = rootProject.layout.projectDirectory.dir("run")

    testServerRunDirectory = rootProject.layout.projectDirectory.dir("run")

  

    variableReplacements = mapOf<String, Any>()

}

```

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

### Gradle Kotlin DSL for Access Widener Variable Replacement

Source: https://stonecraft.meza.gg/docs/access-widening

Set up the 'aw_file' variable replacement in 'modSettings' to link your 'fabric.mod.json' template with the dynamically selected access widener file.

```kotlin
modSettings {
    clientOptions {
        ...
    }

    variableReplacements.set(mapOf("aw_file" to accesswidener))

}
```

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

### Enable Narrator in Stonecraft Client Options

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/clientoptions/narrator

Set the narrator option to true within the clientOptions block in your build.gradle.kts file to enable the Minecraft narrator.

```kotlin
modSettings {
  clientOptions {
    narrator = true
  }
}
```

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

### Snapshot Minecraft Version Properties

Source: https://stonecraft.meza.gg/docs/configuration/overriding

Prepare your mod for future Minecraft releases by creating a properties file in `versions/dependencies`. This file specifies the snapshot version to be used during the build process.

```properties
minecraft_version=1.21.6-rc1  # <- This is the real snapshot version that the build will use
yarn_mappings=1.21.6-rc1+build.1
loader_version=0.16.14

# Fabric API
fabric_version=0.127.0+1.21.6

```

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

### Set GUI Scale in build.gradle.kts

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/clientoptions/guiScale

Use this snippet to set the GUI scale within your build.gradle.kts file. The default value is 3.

```kotlin
modSettings {
  
    clientOptions {
      
        guiScale = 3
      
    }
  
}

```

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

### Enable Dark Background

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/clientoptions/darkBackground

Set `darkBackground` to `true` to use Mojang's dark background. This option is controlled via the accessibility settings.

```kotlin
modSettings {
  clientOptions {
    darkBackground = true
  }
}
```

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

### Fabric Access Widener File Structure

Source: https://stonecraft.meza.gg/docs/access-widening

Organize your access widener files within the 'resources/accesswideners/' directory, with separate files for each Minecraft version.

```plaintext
src.main.resources  

└── accesswideners/  
    └── 1.19.accesswidener  
    └── 1.20.accesswidener  
    └── 1.21.accesswidener  
```

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

### Update Stonecraft and Stonecutter Versions in settings.gradle.kts

Source: https://stonecraft.meza.gg/docs/Migration/Stonecraft-18

Ensure your `settings.gradle.kts` file references the correct versions for Stonecraft and Stonecutter plugins. Use version ranges like `1.8.+` and `0.7.+` for flexibility.

```kotlin
plugins {
  
    id("gg.meza.stonecraft") version "1.8.+"  

    id("dev.kikugie.stonecutter") version "0.7.+"  

}


```

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

### Configure Generated Resources Directory

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/generatedResources

Set the generatedResources property to specify the output directory for data generation. This is typically done within the modSettings block in your build.gradle.kts file.

```kotlin
modSettings {
  
    generatedResources = project.layout.projectDirectory.dir("src/main/generated")  

}  


```

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

### Conditional Imports and Mod Annotation for Forge/NeoForge

Source: https://stonecraft.meza.gg/docs

This snippet shows conditional imports and the `@Mod` annotation for Forge and NeoForge. It includes specific imports for Forge and the `@Mod` annotation for Forge-like loaders, with conditional class definitions for Fabric.

```java
/*? if fabric {*/  

/*import net.fabricmc.api.ModInitializer;*/  

/*?}*/  

  

/*? if forge {*/  

import net.minecraftforge.fml.common.Mod;  

import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;  

  

/*?}*/  

  

/*? if neoforge {*/  

/*import net.neoforged.fml.ModContainer;  

import net.neoforged.bus.api.IEventBus;  

import net.neoforged.fml.common.Mod;*/  

/*?}*/  

  

/*? if forgeLike {*/  

@Mod("examplemod")  

public class ExampleMod {  

/*?}*/  

  

/*? if fabric {*/  

/*public class ExampleMod implements ModInitializer {*/  

/*?}*/  

  

    /*? if forge {*/  

    public ExampleMod(final FMLJavaModLoadingContext context) {}  

    /*?}*/  

  

    /*? if neoforge {*/  

    /*public ExampleMod(IEventBus modEventBus, ModContainer modContainer) {}*/  

    /*?}*/  

  

    /*? if fabric {*/  

    /*@Override  

    public void onInitialize() {}*/  

    /*?}*/  

}

```

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

### Calculate FOV from Stored Value

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/clientoptions/fov

This Kotlin code snippet demonstrates the calculation to convert the stored FOV value from `options.txt` back into degrees. This is used when retrieving the FOV setting.

```kotlin
fov = ((storedValue + 1) * 40 + 30).toInt()
```

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

### Set Access Transformer Variable

Source: https://stonecraft.meza.gg/docs/access-widening

Set the determined access transformer file name as a variable named `at_file` within `modSettings`. This variable can then be used in your `neoforge.mods.toml` file.

```kotlin
modSettings {

    clientOptions {

        ...

    }

    variableReplacements.set(mapOf("at_file", accesstransformer))

}
```

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

### Override runDirectory in build.gradle.kts

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/runDirectory

Override the runDirectory setting when Loom requires a String value. This path is relative to the subproject's location. Remember to also override testClientRunDirectory and testServerRunDirectory when changing this setting.

```kotlin
loom {
  runConfigs.all {
    runDir = "../../run" // <- Loom requires a String, and it's relative from the subproject path
  }
}

```

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

### Fabric Mod JSON Access Widener Template

Source: https://stonecraft.meza.gg/docs/access-widening

Specify the access widener file path in 'fabric.mod.json' using a string template that Stonecutter will replace.

```json
{
  ...
  "accessWidener": "accesswideners/${aw_file}",
}
```

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

### Disable Dark Background

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/clientoptions/darkBackground

Set `darkBackground` to `false` to use the original red background. This is the default behavior.

```kotlin
modSettings {
  clientOptions {
    darkBackground = false
  }
}
```

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

### Configure Client FOV Setting

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/clientoptions/fov

This Kotlin DSL snippet shows how to set the client-side Field of View (FOV) option within the `modSettings` configuration. The `fov` is set to 70 degrees.

```kotlin
modSettings {

    clientOptions {

        fov = 70

    }

}
```

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

### Override Fabric GameTest JUnit Report Location

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/fabricJunitReportLocation

Use this snippet to set a custom JUnit report file location for both server and client GameTest runners when using Fabric. Ensure the 'fabric-api.gametest.report-file' VM argument is correctly formatted.

```kotlin
import gg.meza.stonecraft.mod

loom {
    runs {
        if (mod.isFabric) {
            getByName("gameTestServer") {
                vmArg("-Dfabric-api.gametest.report-file=${rootProject.file("build/junit.xml")}")
            }

            getByName("gameTestClient") {
                vmArg("-Dfabric-api.gametest.report-file=${rootProject.file("build/junit.xml")}")
            }
        }
    }
}
```

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

### Manually Set Release Type to BETA

Source: https://stonecraft.meza.gg/docs/releasing-mods

Manually set the release type within the `publishMods` block using the `ReleaseType.BETA` enum. This overrides any environment variable settings for the release type.

```gradle
publishMods {
    type=ReleaseType.BETA
    modrinth {
        if (mod.isFabric) {
            requires("fabric-api")
            optional("modmenu")
        }
        requires("cloth-config")
    }
  
    curseforge {
        clientRequired = false
        serverRequired = true
        if (mod.isFabric) {
            requires("fabric-api")
            optional("modmenu")
        }
        requires("cloth-config")
    }
}
```

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

### Set Release Type in GitHub Actions

Source: https://stonecraft.meza.gg/docs/releasing-mods

Configure the `RELEASE_TYPE` environment variable in GitHub Actions based on the branch name. This automatically sets the release type to 'release', 'beta', 'alpha', or 'snapshot'.

```yaml
env:
  RELEASE_TYPE: ${{ endsWith(github.ref_name, 'main') && 'release' || (endsWith(github.ref_name, 'beta') && 'beta' || (endsWith(github.ref_name, 'alpha') && 'alpha') || 'snapshot') }}
```

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

### Override ProcessResources Task in Gradle

Source: https://stonecraft.meza.gg/docs/configuration/modsettings/variableReplacements

This snippet shows how to access and modify the `processResources` task in a Gradle build script. Use this to customize variable replacement behavior or other resource processing steps.

```gradle
tasks.processResources {

    // Do whatever you like within the processResources task

}

```

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

### Replace vers() with version() in settings.gradle.kts

Source: https://stonecraft.meza.gg/docs/Migration/Stonecraft-18

Stonecutter 0.7 deprecated the `vers()` function. Replace all instances of `vers(...)` with `version(...)` in your `settings.gradle.kts` file. The parameters remain the same.

```kotlin
fun mc(version: String, vararg loaders: String) {
  
    for (it in loaders) vers("$version-$it", version)  

}


```

```kotlin
fun mc(version: String, vararg loaders: String) {
  
    for (it in loaders) version("$version-$it", version)  

}


```
Tokens:
Raw