2023年9月3日日曜日

MinecraftForgeについてくる build.gradle の翻訳をしてみた

 マイクラのMOD作ってみたくてmdkダウンロードしたので、中に入ってたbuild.gradleを翻訳してみました。

ノリでバーッとやった完全な意訳なので、間違いなどのご指摘がございましたらお伝えいただけますと非常に助かります🙇


plugins {
    id 'eclipse'
    id 'idea'
    id 'maven-publish'
    id 'net.minecraftforge.gradle' version '[6.0,6.2)'
}

version = mod_version
group = mod_group_id

base {
    archivesName = mod_id
}

// Mojang ships Java 17 to end users in 1.18+, so your mod should target Java 17.
// Mojangはバージョン1.18以上からはJava17でエンドユーザーへソフトを提供していますので、あなたのMDOもJava 17にしましょう。
java.toolchain.languageVersion = JavaLanguageVersion.of(17)

println "Java: ${System.getProperty 'java.version'}, JVM: ${System.getProperty 'java.vm.version'} (${System.getProperty 'java.vendor'}), Arch: ${System.getProperty 'os.arch'}"
minecraft {
    // The mappings can be changed at any time and must be in the following format.
    // Channel:   Version:
    // official   MCVersion             Official field/method names from Mojang mapping files
    // parchment  YYYY.MM.DD-MCVersion  Open community-sourced parameter names and javadocs layered on top of official
    //
    // You must be aware of the Mojang license when using the 'official' or 'parchment' mappings.
    // See more information here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md
    //
    // Parchment is an unofficial project maintained by ParchmentMC, separate from MinecraftForge
    // Additional setup is needed to use their mappings: https://parchmentmc.org/docs/getting-started
    //
    // Use non-default mappings at your own risk. They may not always work.
    // Simply re-run your setup task after changing the mappings to update your workspace.
    // mappingsはいつでも次のフォーマットにしたがって変更する事が出来ます。
    // Channel:   Version: 
    // official   MCVersion            Mojangマッピングファイルにある公式のフィールド/メソッド名
    // parchment  YYYY.MM.DD-MCVersion オープンコミュニティーソースによるパラメータ名とJavaDocが公式の上に乗ります
    // 
    // あなたは「公式」または「parchment」のマッピングを使う際は、Mojangライセンスについて理解している必要があります。
    // 詳細はこちらを参照してください: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md
    // 
    // Parchmentは、ParchmentMCによってメンテナンスされる非公式プロジェクトで、MinecraftForgeとは分かれています。
    // 使用するためには追加のセットアップが必要です: https://parchmentmc.org/docs/getting-started
    // 
    // デフォルトではないマッピングは自己責任で試用してください。それらは必ずしも動作するとは限りません。
    // マッピングを変更した後に、ただ再度セットアップタスクを走らせるだけであなたのワークスペースが更新されます。
    // (※訳注: PerchmentMCについて、博ノ助さんが[こちら](https://zenn.dev/cyber_hacnosuke/articles/7e747d402ea870)で導入手順の記事を書かれています)
    mappings channel: mapping_channel, version: mapping_version

    // When true, this property will have all Eclipse/IntelliJ IDEA run configurations run the "prepareX" task for the given run configuration before launching the game.
    // In most cases, it is not necessary to enable.
    // このプロパティの値をtrueにした場合、ゲーム起動前にコンフィグを走らせるためにEclipse/IntelliJ IDEAの全てのコンフィグレーションや"prepareX"タスクを走らせます。
    // たいていの場合、有効にする必要はないでしょう。
    // enableEclipsePrepareRuns = true
    // enableIdeaPrepareRuns = true

    // This property allows configuring Gradle's ProcessResources task(s) to run on IDE output locations before launching the game.
    // It is REQUIRED to be set to true for this template to function.
    // See https://docs.gradle.org/current/dsl/org.gradle.language.jvm.tasks.ProcessResources.html
    // このプロパティは、Gradleのプロセスリソースタスクをゲーム起動前にIDE出力上でが実行されるように設定します。
    // このテンプレートが機能するために、これは必ずtrueに設定されなければいけません。
    copyIdeResources = true

    // When true, this property will add the folder name of all declared run configurations to generated IDE run configurations.
    // The folder name can be set on a run configuration using the "folderName" property.
    // By default, the folder name of a run configuration is the name of the Gradle project containing it.
    // このプロパティをtrueにした場合、生成されたIDE起動設定に全ての宣言された起動設定のフォルダ名を追加します。
    // フォルダ名は、起動設定で"folderName"プロパティを使って設定することができます。
    // generateRunFolders = true

    // This property enables access transformers for use in development.
    // They will be applied to the Minecraft artifact.
    // The access transformer file can be anywhere in the project.
    // However, it must be at "META-INF/accesstransformer.cfg" in the final mod jar to be loaded by Forge.
    // This default location is a best practice to automatically put the file in the right place in the final jar.
    // See https://docs.minecraftforge.net/en/latest/advanced/accesstransformers/ for more information.
    // このプロパティは開発で使用するアクセストランスフォーマーを有効に設定します。
    // これらは、Minecraftアーティファクトに適用されます。
    // アクセストランスフォーマーファイルはプロジェクトのどこにでも配置することができます。
    // ただし、Forgeに読み込まれる最終的なMODのjarファイルでは、このファイルは"META-INF/accesstransformer.cfg"というパスに無ければなりません。
    // このデフォルトロケーションは、最終的に生成されるjarファイルの正しい場所へファイルを配置するベストプラクティスです。
    // 詳細は https://docs.minecraftforge.net/en/latest/advanced/accesstransformers/ を参照してください。
    // accessTransformer = file('src/main/resources/META-INF/accesstransformer.cfg')

    // Default run configurations.
    // These can be tweaked, removed, or duplicated as needed.
    // デフォルトの起動設定
    // これらは必要であれば調整したり削除したり重複したりできます。
    runs {
        // applies to all the run configs below
        // 以下の全ての起動設定に適用されます。
        configureEach {
            workingDirectory project.file('run')

            // Recommended logging data for a userdev environment
            // The markers can be added/remove as needed separated by commas.
            // "SCAN": For mods scan.
            // "REGISTRIES": For firing of registry events.
            // "REGISTRYDUMP": For getting the contents of all registries.
            // ユーザーデベロップ環境でログをとる事が推奨されるデータ。
            // このマーカーは必要であればカンマ区切りで追加/削除をすることができます。
            // "SCAN": MODのスキャン
            // "REGISTRIES": 登録イベントで発火
            // "REGISTRYDUMP": 全ての登録内容を取得
            property 'forge.logging.markers', 'REGISTRIES'

            // Recommended logging level for the console
            // You can set various levels here.
            // Please read: https://stackoverflow.com/questions/2031163/when-to-use-the-different-log-levels
            // コンソールの推奨ログレベル
            // 好きなレベルを設定することができます。
            // ログレベルについてはこちらを参照してください: https://stackoverflow.com/questions/2031163/when-to-use-the-different-log-levels
            property 'forge.logging.console.level', 'debug'

            mods {
                "${mod_id}" {
                    source sourceSets.main
                }
            }
        }

        client {
            // Comma-separated list of namespaces to load gametests from. Empty = all namespaces.
            // ゲームテストを読み込む元となるカンマ区切りの名前空間のリスト。(空 = 全ての名前空間)
            property 'forge.enabledGameTestNamespaces', mod_id
        }

        server {
            property 'forge.enabledGameTestNamespaces', mod_id
            args '--nogui'
        }

        // This run config launches GameTestServer and runs all registered gametests, then exits.
        // By default, the server will crash when no gametests are provided.
        // The gametest system is also enabled by default for other run configs under the /test command.
        // この起動設定はGameTestServerを立ち上げて、存在する全ての登録されたゲームテストを走らせ、テスト終了後に終了します。
        // デフォルトでは、このサーバーはゲームテストが提供されていないため、クラッシュするはずです。
        // このゲームテストシステムは、/testコマンドを使う事で、その他の起動設定でもデフォルトで有効になります。
        gameTestServer {
            property 'forge.enabledGameTestNamespaces', mod_id
        }

        // (※訳注: ここではコマンドライン周りの設定の話をしています。workingDirectoryで作業フォルダを指定して、argsでコマンドラインオプションを指定しています)
        data {
            // example of overriding the workingDirectory set in configureEach above
            // (93行目の)configureEachで設定されたワーキングディレクトリを上書きする例
            workingDirectory project.file('run-data')

            // Specify the modid for data generation, where to output the resulting resource, and where to look for existing resources.
            // データ生成の modid、結果のリソースを出力する場所、および既存のリソースを探す場所を指定しています。
            args '--mod', mod_id, '--all', '--output', file('src/generated/resources/'), '--existing', file('src/main/resources/')
        }
    }
}

// Include resources generated by data generators.
// データジェネレータによって生成されたリソースを含める。
sourceSets.main.resources { srcDir 'src/generated/resources' }

repositories {
    // Put repositories for dependencies here
    // ForgeGradle automatically adds the Forge maven and Maven Central for you
    // 依存パッケージのリポジトリをここに記述します
    // ForgeGradleは自動的にForge mavenとMavenCentralを追加してくれます。

    // If you have mod jar dependencies in ./libs, you can declare them as a repository like so.
    // See https://docs.gradle.org/current/userguide/declaring_repositories.html#sub:flat_dir_resolver
    // もし、あなたが依存するMod jarを ./libs の中に持っていたら、リポジトリのような形でそれらを記述することができます。
    // こちらを参照してください: https://docs.gradle.org/current/userguide/declaring_repositories.html#sub:flat_dir_resolver
    // flatDir {
    //     dir 'libs'
    // }
}

dependencies {
    // Specify the version of Minecraft to use.
    // Any artifact can be supplied so long as it has a "userdev" classifier artifact and is a compatible patcher artifact.
    // The "userdev" classifier will be requested and setup by ForgeGradle.
    // If the group id is "net.minecraft" and the artifact id is one of ["client", "server", "joined"],
    // then special handling is done to allow a setup of a vanilla dependency without the use of an external repository.
    // Minecraftのバージョンを指定します
    // "userdev" 分類子(かつパッチャー互換)のアーティファクトである限り、任意のアーティファクトを提供することができます。
    // "userdev" 分類しはForgeGradleによってリクエストとセットアップが行われます。
    // もし、グループIDが "net.minecraft"で、アーティファクトIDが"client", "server", "joined"のいずれかだった場合、
    // 外部リポジトリを使わないvanillaの依存関係をセットアップするための特別なハンドリングが行われます。
    minecraft "net.minecraftforge:forge:${minecraft_version}-${forge_version}"

    // Example mod dependency with JEI - using fg.deobf() ensures the dependency is remapped to your development mappings
    // The JEI API is declared for compile time use, while the full JEI artifact is used at runtime
    // JEI(Just Enough Items)を使ったMODの依存関係の例 - fg.deobf() を使用する事で、依存関係が開発環境のマッピングにリマップされる事が保障されます。
    // JEI APIをコンパイル時に使うように宣言しつつ、ランタイムではフルJEIアーティファクトが使用されるように記述されています。
    // compileOnly fg.deobf("mezz.jei:jei-${mc_version}-common-api:${jei_version}")
    // compileOnly fg.deobf("mezz.jei:jei-${mc_version}-forge-api:${jei_version}")
    // runtimeOnly fg.deobf("mezz.jei:jei-${mc_version}-forge:${jei_version}")

    // Example mod dependency using a mod jar from ./libs with a flat dir repository
    // This maps to ./libs/coolmod-${mc_version}-${coolmod_version}.jar
    // The group id is ignored when searching -- in this case, it is "blank"
    // フラットなディレクトリリポジトリで ./libs の MOD jarファイルを使用したMOD依存関係の例
    // ./libs/coolmod-${mc_version}-${coolmod_version}.jar にマップしています
    // グループIDは検索時には無視されます。 -- この場合、それはブランク(空文字)になります。
    // implementation fg.deobf("blank:coolmod-${mc_version}:${coolmod_version}")

    // For more info:
    // http://www.gradle.org/docs/current/userguide/artifact_dependencies_tutorial.html
    // http://www.gradle.org/docs/current/userguide/dependency_management.html
    // さらに知りたい場合はこちらを参照してください:
    // http://www.gradle.org/docs/current/userguide/artifact_dependencies_tutorial.html
    // http://www.gradle.org/docs/current/userguide/dependency_management.html
}

// This block of code expands all declared replace properties in the specified resource targets.
// A missing property will result in an error. Properties are expanded using ${} Groovy notation.
// When "copyIdeResources" is enabled, this will also run before the game launches in IDE environments.
// See https://docs.gradle.org/current/dsl/org.gradle.language.jvm.tasks.ProcessResources.html
// このコードブロックは、指定されたリソースターゲットに記述されている全ての置換プロパティを展開します。
// プロパティが見つからない場合、エラーが発生します。プロパティは ${} を使うGroovyの記法で展開されます。
// "copyIdeResources"が有効になっている場合、これはIDE環境でゲームが起動する前にも実行されます。
// こちらを参照してください: https://docs.gradle.org/current/dsl/org.gradle.language.jvm.tasks.ProcessResources.html
tasks.named('processResources', ProcessResources).configure {
    var replaceProperties = [
            minecraft_version: minecraft_version, minecraft_version_range: minecraft_version_range,
            forge_version: forge_version, forge_version_range: forge_version_range,
            loader_version_range: loader_version_range,
            mod_id: mod_id, mod_name: mod_name, mod_license: mod_license, mod_version: mod_version,
            mod_authors: mod_authors, mod_description: mod_description,
    ]
    inputs.properties replaceProperties

    filesMatching(['META-INF/mods.toml', 'pack.mcmeta']) {
        expand replaceProperties + [project: project]
    }
}

// Example for how to get properties into the manifest for reading at runtime.
// プロパティを実行時に取得するためにマニフェストファイルに書き込む
tasks.named('jar', Jar).configure {
    manifest {
        attributes([
                'Specification-Title'     : mod_id,
                'Specification-Vendor'    : mod_authors,
                'Specification-Version'   : '1', // We are version 1 of ourselves
                'Implementation-Title'    : project.name,
                'Implementation-Version'  : project.jar.archiveVersion,
                'Implementation-Vendor'   : mod_authors,
                'Implementation-Timestamp': new Date().format("yyyy-MM-dd'T'HH:mm:ssZ")
        ])
    }

    // This is the preferred method to reobfuscate your jar file
    // jarファイルを難読化するために推奨
    // (※訳注: [こちら](https://qiita.com/MirrgieRiana/items/a006a0fbe21e30a2f7a2)に、MirrgieRianaさんによる、このプロパティに関する解説記事があります)
    finalizedBy 'reobfJar'
}

// However if you are in a multi-project build, dev time needs unobfed jar files, so you can delay the obfuscation until publishing by doing:
// もし、複数プロジェクトをビルドする場合、開発用の難読化されていないjarファイルが必要となるため、次のようにして難読化をパブリッシュするまで順延させる事が出来ます。
// tasks.named('publish').configure {
//     dependsOn 'reobfJar'
// }

// Example configuration to allow publishing using the maven-publish plugin
// maven-publishプラグインでパブリッシュできるようにする設定の例
publishing {
    publications {
        register('mavenJava', MavenPublication) {
            artifact jar
        }
    }
    repositories {
        maven {
            url "file://${project.projectDir}/mcmodsrepo"
        }
    }
}

tasks.withType(JavaCompile).configureEach {
    options.encoding = 'UTF-8' // Use the UTF-8 charset for Java compilation  UTF-8キャラセットをコンパイルで使う
}

changelogのバージョン表記は『47.1.0 1.20.1』でした。

0 件のコメント:

コメントを投稿

MinecraftForgeについてくる ExampleMod.java の翻訳をしてみた

  Forge の mdk に入ってる gradle.properties を翻訳してみました。 ノリでバーッとやった完全な意訳なので、間違いなどのご指摘がございましたらお伝えいただけますと非常に助かります🙇