2022-03-01 19:59:37 +01:00
plugins {
id 'eclipse'
2023-04-02 03:45:29 +02:00
id 'idea'
2022-03-01 19:59:37 +01:00
id 'maven-publish'
2023-07-20 18:33:24 +02:00
id 'net.neoforged.gradle' version '[6.0.18,6.2)'
2022-03-01 19:59:37 +01:00
}
2016-10-09 01:26:24 +02:00
2023-04-02 03:45:29 +02:00
version = mod_version
group = mod_group_id
base {
archivesName = mod_id
}
2015-08-02 06:03:47 +02:00
2021-11-26 19:57:41 +01:00
// Mojang ships Java 17 to end users in 1.18+, so your mod should target Java 17.
java . toolchain . languageVersion = JavaLanguageVersion . of ( 17 )
2016-08-21 02:11:08 +02:00
2022-03-01 19:59:37 +01:00
println "Java: ${System.getProperty 'java.version'}, JVM: ${System.getProperty 'java.vm.version'} (${System.getProperty 'java.vendor'}), Arch: ${System.getProperty 'os.arch'}"
2015-08-02 06:03:47 +02:00
minecraft {
2021-07-17 07:08:49 +02:00
// The mappings can be changed at any time and must be in the following format.
2021-03-09 22:37:23 +01:00
// Channel: Version:
2022-03-01 19:59:37 +01:00
// 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
2021-03-09 22:37:23 +01:00
//
2022-03-01 19:59:37 +01:00
// You must be aware of the Mojang license when using the 'official' or 'parchment' mappings.
2023-07-15 23:16:28 +02:00
// See more information here: https://github.com/NeoForged/NeoForm/blob/main/Mojang.md
2021-03-09 22:37:23 +01:00
//
2022-03-01 19:59:37 +01:00
// Parchment is an unofficial project maintained by ParchmentMC, separate from MinecraftForge
2022-12-26 22:19:44 +01:00
// Additional setup is needed to use their mappings: https://parchmentmc.org/docs/getting-started
2022-03-01 19:59:37 +01:00
//
2021-07-17 07:08:49 +02:00
// Use non-default mappings at your own risk. They may not always work.
2019-02-18 20:39:05 +01:00
// Simply re-run your setup task after changing the mappings to update your workspace.
2023-04-02 03:45:29 +02:00
mappings channel: mapping_channel , version: mapping_version
2023-06-27 13:56:58 +02:00
// 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.
2023-04-02 03:45:29 +02:00
// In most cases, it is not necessary to enable.
// 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
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.
// 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.
2023-07-15 23:16:28 +02:00
// See https://docs.neoforged.net/docs/1.20.x/advanced/accesstransformers/ for more information.
2023-04-02 03:45:29 +02:00
// accessTransformer = file('src/main/resources/META-INF/accesstransformer.cfg')
2018-12-12 05:04:23 +01:00
2019-02-18 20:39:05 +01:00
// Default run configurations.
// These can be tweaked, removed, or duplicated as needed.
2019-01-08 09:29:36 +01:00
runs {
2023-06-27 13:57:08 +02:00
// applies to all the run configs below
configureEach {
2019-02-18 20:39:05 +01:00
workingDirectory project . file ( 'run' )
// Recommended logging data for a userdev environment
2021-07-17 07:08:49 +02:00
// The markers can be added/remove as needed separated by commas.
2021-02-16 01:39:02 +01:00
// "SCAN": For mods scan.
// "REGISTRIES": For firing of registry events.
// "REGISTRYDUMP": For getting the contents of all registries.
property 'forge.logging.markers' , 'REGISTRIES'
2019-02-18 20:39:05 +01:00
// Recommended logging level for the console
2021-02-16 01:39:02 +01:00
// You can set various levels here.
// Please read: https://stackoverflow.com/questions/2031163/when-to-use-the-different-log-levels
2019-02-18 20:39:05 +01:00
property 'forge.logging.console.level' , 'debug'
mods {
2023-04-02 03:45:29 +02:00
"${mod_id}" {
2019-02-18 20:39:05 +01:00
source sourceSets . main
}
}
2019-01-08 09:29:36 +01:00
}
2019-02-18 20:39:05 +01:00
2023-06-27 13:57:08 +02:00
client {
// Comma-separated list of namespaces to load gametests from. Empty = all namespaces.
2023-04-02 03:45:29 +02:00
property 'forge.enabledGameTestNamespaces' , mod_id
2023-06-27 13:57:08 +02:00
}
2022-02-25 02:06:32 +01:00
2023-06-27 13:57:08 +02:00
server {
property 'forge.enabledGameTestNamespaces' , mod_id
args '--nogui'
2022-02-25 02:06:32 +01:00
}
// 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 {
2023-04-02 03:45:29 +02:00
property 'forge.enabledGameTestNamespaces' , mod_id
2019-01-08 09:29:36 +01:00
}
2019-06-26 03:03:51 +02:00
data {
2023-06-27 13:57:08 +02:00
// example of overriding the workingDirectory set in configureEach above
workingDirectory project . file ( 'run-data' )
2019-06-26 03:03:51 +02:00
2020-10-08 23:03:41 +02:00
// Specify the modid for data generation, where to output the resulting resource, and where to look for existing resources.
2023-04-02 03:45:29 +02:00
args '--mod' , mod_id , '--all' , '--output' , file ( 'src/generated/resources/' ) , '--existing' , file ( 'src/main/resources/' )
2019-06-26 03:03:51 +02:00
}
2018-12-12 05:04:23 +01:00
}
2015-08-02 06:03:47 +02:00
}
2020-10-08 23:03:41 +02:00
// Include resources generated by data generators.
sourceSets . main . resources { srcDir 'src/generated/resources' }
2021-07-17 07:08:49 +02:00
repositories {
// Put repositories for dependencies here
2023-07-15 23:16:28 +02:00
// NeoGradle automatically adds the Forge maven and Maven Central for you
2021-07-17 07:08:49 +02:00
2023-04-02 03:45:29 +02:00
// 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
2021-07-17 07:08:49 +02:00
// flatDir {
// dir 'libs'
// }
}
2015-08-02 06:03:47 +02:00
dependencies {
2023-04-02 03:45:29 +02:00
// 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.
2023-07-15 23:16:28 +02:00
// The "userdev" classifier will be requested and setup by NeoGradle.
2023-04-02 03:45:29 +02:00
// 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.
2023-07-20 20:57:34 +02:00
minecraft "net.neoforged:forge:${minecraft_version}-${neo_version}"
2023-04-02 03:45:29 +02:00
// 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
// 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"
2021-07-17 07:08:49 +02:00
// implementation fg.deobf("blank:coolmod-${mc_version}:${coolmod_version}")
2015-08-02 06:03:47 +02:00
2023-04-02 03:45:29 +02:00
// For more info:
2015-08-02 06:03:47 +02:00
// http://www.gradle.org/docs/current/userguide/artifact_dependencies_tutorial.html
// http://www.gradle.org/docs/current/userguide/dependency_management.html
}
2023-04-02 03:45:29 +02:00
// 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
2023-07-23 12:26:33 +02:00
tasks . withType ( ProcessResources ) . configureEach {
2023-06-27 13:56:42 +02:00
var replaceProperties = [
2023-07-20 20:57:34 +02:00
minecraft_version : minecraft_version , minecraft_version_range: minecraft_version_range ,
neo_version : neo_version , neo_version_range: neo_version_range ,
2023-06-27 13:56:42 +02:00
loader_version_range: loader_version_range ,
2023-07-20 20:57:34 +02:00
mod_id : mod_id , mod_name: mod_name , mod_license: mod_license , mod_version: mod_version ,
mod_authors : mod_authors , mod_description: mod_description , pack_format_number: pack_format_number ,
2023-06-27 13:56:42 +02:00
]
2023-04-02 03:45:29 +02:00
inputs . properties replaceProperties
2023-06-27 13:56:42 +02:00
filesMatching ( [ 'META-INF/mods.toml' , 'pack.mcmeta' ] ) {
expand replaceProperties + [ project: project ]
2023-04-02 03:45:29 +02:00
}
}
2021-07-17 07:08:49 +02:00
// Example for how to get properties into the manifest for reading at runtime.
2023-06-27 13:56:42 +02:00
tasks . named ( 'jar' , Jar ) . configure {
2019-01-27 17:37:56 +01:00
manifest {
2019-02-18 20:39:05 +01:00
attributes ( [
2023-06-27 13:56:42 +02:00
'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" )
2019-02-18 20:39:05 +01:00
] )
2015-08-02 06:03:47 +02:00
}
2023-06-27 13:56:42 +02:00
// This is the preferred method to reobfuscate your jar file
finalizedBy 'reobfJar'
2019-03-10 00:43:20 +01:00
}
2023-06-27 13:56:42 +02:00
// 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:
// tasks.named('publish').configure {
// dependsOn 'reobfJar'
// }
2020-02-14 21:02:00 +01:00
2023-06-27 13:56:42 +02:00
// Example configuration to allow publishing using the maven-publish plugin
2019-03-10 00:43:20 +01:00
publishing {
publications {
2023-06-27 13:56:42 +02:00
register ( 'mavenJava' , MavenPublication ) {
2020-02-14 21:02:00 +01:00
artifact jar
2019-03-10 00:43:20 +01:00
}
}
repositories {
maven {
2021-07-17 07:08:49 +02:00
url "file://${project.projectDir}/mcmodsrepo"
2019-03-10 00:43:20 +01:00
}
}
2021-02-16 01:39:02 +01:00
}
2022-03-06 15:53:15 +01:00
tasks . withType ( JavaCompile ) . configureEach {
options . encoding = 'UTF-8' // Use the UTF-8 charset for Java compilation
}