Parchment

Parchment 是一套由社区维护的映射，包含参数名和 javadoc，用以补充 Mojang 发布的官方名称。使用 Parchment 后，你可以为大多数 Minecraft 方法获得有意义的参数名，而不是那些没有描述性的 p_ 名称。

配置 Parchment

最基本的配置方式是在 gradle.properties 中使用以下属性：

ModDevGradle

# The Minecraft version the Parchment version is for
neoForge.parchment.minecraftVersion=1.20.2
# The version of the Parchment mappings
neoForge.parchment.mappingsVersion=2023.12.10

NeoGradle

# The Minecraft version the Parchment version is for
neogradle.subsystems.parchment.minecraftVersion=1.20.2
# The version of the Parchment mappings
neogradle.subsystems.parchment.mappingsVersion=2023.12.10

该子系统还提供了 Gradle DSL，并支持更多参数，下面的 Gradle 代码片段对此作了说明：

ModDevGradle

neoForge {
    parchment {
        // The Minecraft version for which the Parchment mappings were created.
        // This does not necessarily need to match the Minecraft version your mod targets
        // Defaults to the value of Gradle property neoForge.parchment.minecraftVersion
        minecraftVersion = "1.20.2"
        
        // The version of Parchment mappings to apply.
        // See https://parchmentmc.org/docs/getting-started for a list.
        // Defaults to the value of Gradle property neoForge.parchment.mappingsVersion
        mappingsVersion = "2023.12.10"
        
        // Overrides the full Maven coordinate of the Parchment artifact to use
        // This is computed from the minecraftVersion and mappingsVersion properties by default.
        // If you set this property explicitly, minecraftVersion and mappingsVersion will be ignored.
        // parchmentArtifact = "org.parchmentmc.data:parchment-$minecraftVersion:$mappingsVersion:checked@zip"
        
        // The string that parameters are prefixed with when they conflict with other names inside the method.
        // Defaults to `p_`. You can set this property to an empty string to disable conflict resolution,
        // for example, when you use the checked version of parchment, which already includes prefixes.
        // conflictResolutionPrefix = ''

        // Can be used to explicitly disable this subsystem. By default, it will be enabled automatically as soon
        // as parchmentArtifact or minecraftVersion and mappingsVersion are set.
        // enabled = true
    }
}

NeoGradle

subsystems {
    parchment {
        // The Minecraft version for which the Parchment mappings were created.
        // This does not necessarily need to match the Minecraft version your mod targets
        // Defaults to the value of Gradle property neogradle.subsystems.parchment.minecraftVersion
        minecraftVersion = "1.20.2"
        
        // The version of Parchment mappings to apply.
        // See https://parchmentmc.org/docs/getting-started for a list.
        // Defaults to the value of Gradle property neogradle.subsystems.parchment.mappingsVersion
        mappingsVersion = "2023.12.10"
        
        // Overrides the full Maven coordinate of the Parchment artifact to use
        // This is computed from the minecraftVersion and mappingsVersion properties by default.
        // If you set this property explicitly, minecraftVersion and mappingsVersion will be ignored.
        // The built-in default value can also be overridden using the Gradle property neogradle.subsystems.parchment.parchmentArtifact
        // parchmentArtifact = "org.parchmentmc.data:parchment-$minecraftVersion:$mappingsVersion:checked@zip"
        
        // Overrides the full Maven coordinate of the tool used to apply the Parchment mappings
        // See https://github.com/neoforged/JavaSourceTransformer
        // The built-in default value can also be overridden using the Gradle property neogradle.subsystems.parchment.toolArtifact
        // toolArtifact = "net.neoforged.jst:jst-cli-bundle:1.0.30"
        
        // The string that parameters are prefixed with when they conflict with other names inside the method.
        // Defaults to `p_`. You can set this property to an empty string to disable conflict resolution,
        // for example, when you use the checked version of parchment, which already includes prefixes.
        // conflictPrefix = ''

        // Set this to false if you don't want the https://maven.parchmentmc.org/ repository to be added automatically when
        // applying Parchment mappings is enabled
        // The built-in default value can also be overridden using the Gradle property neogradle.subsystems.parchment.addRepository
        // addRepository = true
        
        // Can be used to explicitly disable this subsystem. By default, it will be enabled automatically as soon
        // as parchmentArtifact or minecraftVersion and mappingsVersion are set.
        // The built-in default value can also be overridden using the Gradle property neogradle.subsystems.parchment.enabled
        // enabled = true
    }
}

提示

你可以在 Parchment 的文档中找到最新的版本。