src/main/kotlin/platform/forge/creator/Fg3Template.kt diff

← → deleted src/main/kotlin/platform/forge/creator/Fg3Template.kt

Ignore whitespaces Open in IDE

⁠ joseph burton: Minecraft new project wizard (#1933 )

* Forge creator almost working

* Store authors and website for next time the user uses the creator

* Don't allow for dialog submission before a latent step is finished

* Fabric mod creator

* Add modid.mixins.json to Forge project creator

* Start with Architectury creator

* Fix long-running tasks that need to run after one another

* Apply website in Forge creator

* Set the correct gradle version in the Forge project creator

* Architectury should be finished but it's not working, not sure why

* Add support for custom build systems via extension points

* Sponge project creator, first maven implementation

* Remove unsupported platforms from the readme

* Add missing platforms to readme

* Replace some silly code with less silly code

* Add Spigot and Paper creators

* Add Velocity creator

* Add BungeeCord and Waterfall creator

* Delete unused code

* ktlint format

* Apply the correct JDK version depending on the platform and version

* Fix license years after merge

* Improvements and fixes to JDK selector UI

* Fix architectury template

* Fix issues with Sponge creator

* Fix IncorrectOperationException in AbstractLatentStep

* Add option to create a git repo (which also creates a gitignore)

* UI improvements

* Add a message encouraging users to report outdated templates

* Add note to project wizard outdated form warning not to request new platforms

* Paper before Spigot

* Remove dependency on TemplateMakerFabric

* Reorganize creators into multiple files and repackage some things

* Improve documentation

* Improve ergonomics for build system properties, main class name, repository, issue tracker

* Limit Sponge API version to 8 and above in dropdown box

* Prevent class name from messing up when the project name contains dots

Copy Copy

/*
* Minecraft Dev for IntelliJ
*
* https://minecraftdev.org
*
* Copyright (c) 2023 minecraft-dev
*
* MIT License
*/

package com.demonwav.mcdev.platform.forge.creator

import com.demonwav.mcdev.creator.buildsystem.BuildSystem
import com.demonwav.mcdev.platform.BaseTemplate
import com.demonwav.mcdev.platform.forge.util.ForgeConstants
import com.demonwav.mcdev.platform.forge.util.ForgePackAdditionalData
import com.demonwav.mcdev.platform.forge.util.ForgePackDescriptor
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_1_17_MAIN_CLASS_TEMPLATE
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_1_18_MAIN_CLASS_TEMPLATE
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_1_19_3_MAIN_CLASS_TEMPLATE
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_1_19_MAIN_CLASS_TEMPLATE
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_BUILD_GRADLE_TEMPLATE
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_GRADLE_PROPERTIES_TEMPLATE
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_MAIN_CLASS_TEMPLATE
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_SETTINGS_GRADLE_TEMPLATE
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_SUBMODULE_BUILD_GRADLE_TEMPLATE
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FORGE_MIXINS_JSON_TEMPLATE
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.MODS_TOML_TEMPLATE
import com.demonwav.mcdev.util.MinecraftTemplates.Companion.PACK_MCMETA_TEMPLATE
import com.demonwav.mcdev.util.MinecraftVersions
import com.demonwav.mcdev.util.SemanticVersion
import com.demonwav.mcdev.util.toPackageName
import com.intellij.openapi.project.Project

object Fg3Template : BaseTemplate() {

fun applyMainClass(
project: Project,
buildSystem: BuildSystem,
config: ForgeProjectConfig,
packageName: String,
className: String
): String {
val props = mapOf(
"PACKAGE_NAME" to packageName,
"CLASS_NAME" to className,
"ARTIFACT_ID" to buildSystem.artifactId,
"MOD_NAME" to config.pluginName,
"MOD_VERSION" to buildSystem.version
)

return project.applyTemplate(FG3_MAIN_CLASS_TEMPLATE, props)
}

fun apply1_17MainClass(
project: Project,
buildSystem: BuildSystem,
config: ForgeProjectConfig,
packageName: String,
className: String
): String {
val props = mapOf(
"PACKAGE_NAME" to packageName,
"CLASS_NAME" to className,
"ARTIFACT_ID" to buildSystem.artifactId,
"MOD_NAME" to config.pluginName,
"MOD_VERSION" to buildSystem.version
)

return project.applyTemplate(FG3_1_17_MAIN_CLASS_TEMPLATE, props)
}

fun apply1_18MainClass(
project: Project,
buildSystem: BuildSystem,
config: ForgeProjectConfig,
packageName: String,
className: String
): String {
val props = mapOf(
"PACKAGE_NAME" to packageName,
"CLASS_NAME" to className,
"ARTIFACT_ID" to buildSystem.artifactId,
"MOD_NAME" to config.pluginName,
"MOD_VERSION" to buildSystem.version
)

return project.applyTemplate(FG3_1_18_MAIN_CLASS_TEMPLATE, props)
}

fun apply1_19MainClass(
project: Project,
buildSystem: BuildSystem,
config: ForgeProjectConfig,
packageName: String,
className: String
): String {
val props = mapOf(
"PACKAGE_NAME" to packageName,
"CLASS_NAME" to className,
"ARTIFACT_ID" to buildSystem.artifactId,
"MOD_NAME" to config.pluginName,
"MOD_VERSION" to buildSystem.version
)

return project.applyTemplate(FG3_1_19_MAIN_CLASS_TEMPLATE, props)
}

fun apply1_19_3MainClass(
project: Project,
buildSystem: BuildSystem,
config: ForgeProjectConfig,
packageName: String,
className: String
): String {
val props = mapOf(
"PACKAGE_NAME" to packageName,
"CLASS_NAME" to className,
"ARTIFACT_ID" to buildSystem.artifactId,
"MOD_NAME" to config.pluginName,
"MOD_VERSION" to buildSystem.version
)

return project.applyTemplate(FG3_1_19_3_MAIN_CLASS_TEMPLATE, props)
}

fun applyBuildGradle(
project: Project,
buildSystem: BuildSystem,
config: ForgeProjectConfig,
modName: String,
hasData: Boolean
): String {
val (channel, version) = config.mcpVersion.mcpVersion.split('_', limit = 2)
val props = mutableMapOf<String, Any>(
"MOD_NAME" to modName,
"MCP_CHANNEL" to channel,
"MCP_VERSION" to version,
"MCP_MC_VERSION" to config.mcpVersion.mcVersion.toString(),
"FORGE_VERSION" to config.forgeVersionText,
"GROUP_ID" to buildSystem.groupId,
"ARTIFACT_ID" to buildSystem.artifactId,
"MOD_VERSION" to buildSystem.version,
"JAVA_VERSION" to config.javaVersion.feature
)
if (hasData) {
props["HAS_DATA"] = "true"
}
if (config.hasAuthors()) {
props["AUTHOR_LIST"] = config.authors.joinToString(", ")
}
if (config.mixins) {
props["MIXINS"] = "true"
}
if (config.forgeVersion >= SemanticVersion.release(39, 0, 88)) {
props["GAME_TEST_FRAMEWORK"] = "true"
}

return project.applyTemplate(FG3_BUILD_GRADLE_TEMPLATE, props)
}

fun applyGradleProp(project: Project): String {
return project.applyTemplate(FG3_GRADLE_PROPERTIES_TEMPLATE)
}

fun applySettingsGradle(project: Project, artifactId: String): String {
val props = mapOf(
"ARTIFACT_ID" to artifactId
)

return project.applyTemplate(FG3_SETTINGS_GRADLE_TEMPLATE, props)
}

fun applySubBuildGradle(
project: Project,
buildSystem: BuildSystem,
config: ForgeProjectConfig,
modName: String,
hasData: Boolean
): String {
val (channel, version) = config.mcpVersion.mcpVersion.split('_', limit = 2)
val props = mutableMapOf<String, Any>(
"MOD_NAME" to modName,
"MCP_CHANNEL" to channel,
"MCP_VERSION" to version,
"MCP_MC_VERSION" to config.mcpVersion.mcVersion.toString(),
"FORGE_VERSION" to config.forgeVersionText,
"ARTIFACT_ID" to buildSystem.artifactId,
"JAVA_VERSION" to if (config.mcVersion < MinecraftVersions.MC1_17) 8 else 16,
"COMMON_PROJECT_NAME" to buildSystem.commonModuleName
)
if (hasData) {
props["HAS_DATA"] = "true"
}
if (config.hasAuthors()) {
props["AUTHOR_LIST"] = config.authors.joinToString(", ")
}
if (config.mixins) {
props["MIXINS"] = "true"
}

return project.applyTemplate(FG3_SUBMODULE_BUILD_GRADLE_TEMPLATE, props)
}

fun applyModsToml(project: Project, buildSystem: BuildSystem, config: ForgeProjectConfig): String {
val hasDisplayTestInManifest = config.forgeVersion >= ForgeConstants.DISPLAY_TEST_MANIFEST_VERSION
val nextMcVersion = when (val part = config.mcVersion.parts.getOrNull(1)) {
// Mimics the code used to get the next Minecraft version in Forge's MDK
// https://github.com/MinecraftForge/MinecraftForge/blob/0ff8a596fc1ef33d4070be89dd5cb4851f93f731/build.gradle#L884
is SemanticVersion.Companion.VersionPart.ReleasePart -> (part.version + 1).toString()
null -> "?"
else -> part.versionString
}
val props = mutableMapOf(
"ARTIFACT_ID" to buildSystem.artifactId,
"MOD_NAME" to config.pluginName,
"DISPLAY_TEST" to hasDisplayTestInManifest,
"FORGE_SPEC_VERSION" to config.forgeVersion.parts[0].versionString,
"MC_VERSION" to config.mcVersion.toString(),
"MC_NEXT_VERSION" to "1.$nextMcVersion",
"LICENSE" to config.license.toString()
)
props["DESCRIPTION"] = config.description ?: ""
config.updateUrl?.let { url ->
if (url.isNotBlank()) {
props["UPDATE_URL"] = url
}
}
config.website?.let { url ->
if (url.isNotBlank()) {
props["WEBSITE"] = url
}
}
if (config.hasAuthors()) {
props["AUTHOR_LIST"] = config.authors.joinToString(", ")
}

return project.applyTemplate(MODS_TOML_TEMPLATE, props)
}

fun applyPackMcmeta(
project: Project,
artifactId: String,
pack: ForgePackDescriptor,
additionalData: ForgePackAdditionalData?
): String {
val props = mapOf(
"ARTIFACT_ID" to artifactId,
"PACK_FORMAT" to pack.format.toString(),
"PACK_COMMENT" to pack.comment,
"FORGE_DATA" to additionalData,
)

return project.applyTemplate(PACK_MCMETA_TEMPLATE, props)
}

fun applyMixinConfigTemplate(
project: Project,
buildSystem: BuildSystem
): String {
val groupId = buildSystem.groupId.toPackageName()
val artifactId = buildSystem.artifactId.toPackageName()
val packageName = "$groupId.$artifactId.mixin"
val props = mapOf(
"PACKAGE_NAME" to packageName,
"ARTIFACT_ID" to artifactId
)
return project.applyTemplate(FORGE_MIXINS_JSON_TEMPLATE, props)
}
}

/* * Minecraft Dev for IntelliJ * * https://minecraftdev.org * * Copyright (c) 2023 minecraft-dev * * MIT License */ package com.demonwav.mcdev.platform.forge.creator import com.demonwav.mcdev.creator.buildsystem.BuildSystem import com.demonwav.mcdev.platform.BaseTemplate import com.demonwav.mcdev.platform.forge.util.ForgeConstants import com.demonwav.mcdev.platform.forge.util.ForgePackAdditionalData import com.demonwav.mcdev.platform.forge.util.ForgePackDescriptor import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_1_17_MAIN_CLASS_TEMPLATE import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_1_18_MAIN_CLASS_TEMPLATE import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_1_19_3_MAIN_CLASS_TEMPLATE import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_1_19_MAIN_CLASS_TEMPLATE import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_BUILD_GRADLE_TEMPLATE import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_GRADLE_PROPERTIES_TEMPLATE import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_MAIN_CLASS_TEMPLATE import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_SETTINGS_GRADLE_TEMPLATE import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FG3_SUBMODULE_BUILD_GRADLE_TEMPLATE import com.demonwav.mcdev.util.MinecraftTemplates.Companion.FORGE_MIXINS_JSON_TEMPLATE import com.demonwav.mcdev.util.MinecraftTemplates.Companion.MODS_TOML_TEMPLATE import com.demonwav.mcdev.util.MinecraftTemplates.Companion.PACK_MCMETA_TEMPLATE import com.demonwav.mcdev.util.MinecraftVersions import com.demonwav.mcdev.util.SemanticVersion import com.demonwav.mcdev.util.toPackageName import com.intellij.openapi.project.Project object Fg3Template : BaseTemplate() { fun applyMainClass( project: Project, buildSystem: BuildSystem, config: ForgeProjectConfig, packageName: String, className: String ): String { val props = mapOf( "PACKAGE_NAME" to packageName, "CLASS_NAME" to className, "ARTIFACT_ID" to buildSystem.artifactId, "MOD_NAME" to config.pluginName, "MOD_VERSION" to buildSystem.version ) return project.applyTemplate(FG3_MAIN_CLASS_TEMPLATE, props) } fun apply1_17MainClass( project: Project, buildSystem: BuildSystem, config: ForgeProjectConfig, packageName: String, className: String ): String { val props = mapOf( "PACKAGE_NAME" to packageName, "CLASS_NAME" to className, "ARTIFACT_ID" to buildSystem.artifactId, "MOD_NAME" to config.pluginName, "MOD_VERSION" to buildSystem.version ) return project.applyTemplate(FG3_1_17_MAIN_CLASS_TEMPLATE, props) } fun apply1_18MainClass( project: Project, buildSystem: BuildSystem, config: ForgeProjectConfig, packageName: String, className: String ): String { val props = mapOf( "PACKAGE_NAME" to packageName, "CLASS_NAME" to className, "ARTIFACT_ID" to buildSystem.artifactId, "MOD_NAME" to config.pluginName, "MOD_VERSION" to buildSystem.version ) return project.applyTemplate(FG3_1_18_MAIN_CLASS_TEMPLATE, props) } fun apply1_19MainClass( project: Project, buildSystem: BuildSystem, config: ForgeProjectConfig, packageName: String, className: String ): String { val props = mapOf( "PACKAGE_NAME" to packageName, "CLASS_NAME" to className, "ARTIFACT_ID" to buildSystem.artifactId, "MOD_NAME" to config.pluginName, "MOD_VERSION" to buildSystem.version ) return project.applyTemplate(FG3_1_19_MAIN_CLASS_TEMPLATE, props) } fun apply1_19_3MainClass( project: Project, buildSystem: BuildSystem, config: ForgeProjectConfig, packageName: String, className: String ): String { val props = mapOf( "PACKAGE_NAME" to packageName, "CLASS_NAME" to className, "ARTIFACT_ID" to buildSystem.artifactId, "MOD_NAME" to config.pluginName, "MOD_VERSION" to buildSystem.version ) return project.applyTemplate(FG3_1_19_3_MAIN_CLASS_TEMPLATE, props) } fun applyBuildGradle( project: Project, buildSystem: BuildSystem, config: ForgeProjectConfig, modName: String, hasData: Boolean ): String { val (channel, version) = config.mcpVersion.mcpVersion.split('_', limit = 2) val props = mutableMapOf<String, Any>( "MOD_NAME" to modName, "MCP_CHANNEL" to channel, "MCP_VERSION" to version, "MCP_MC_VERSION" to config.mcpVersion.mcVersion.toString(), "FORGE_VERSION" to config.forgeVersionText, "GROUP_ID" to buildSystem.groupId, "ARTIFACT_ID" to buildSystem.artifactId, "MOD_VERSION" to buildSystem.version, "JAVA_VERSION" to config.javaVersion.feature ) if (hasData) { props["HAS_DATA"] = "true" } if (config.hasAuthors()) { props["AUTHOR_LIST"] = config.authors.joinToString(", ") } if (config.mixins) { props["MIXINS"] = "true" } if (config.forgeVersion >= SemanticVersion.release(39, 0, 88)) { props["GAME_TEST_FRAMEWORK"] = "true" } return project.applyTemplate(FG3_BUILD_GRADLE_TEMPLATE, props) } fun applyGradleProp(project: Project): String { return project.applyTemplate(FG3_GRADLE_PROPERTIES_TEMPLATE) } fun applySettingsGradle(project: Project, artifactId: String): String { val props = mapOf( "ARTIFACT_ID" to artifactId ) return project.applyTemplate(FG3_SETTINGS_GRADLE_TEMPLATE, props) } fun applySubBuildGradle( project: Project, buildSystem: BuildSystem, config: ForgeProjectConfig, modName: String, hasData: Boolean ): String { val (channel, version) = config.mcpVersion.mcpVersion.split('_', limit = 2) val props = mutableMapOf<String, Any>( "MOD_NAME" to modName, "MCP_CHANNEL" to channel, "MCP_VERSION" to version, "MCP_MC_VERSION" to config.mcpVersion.mcVersion.toString(), "FORGE_VERSION" to config.forgeVersionText, "ARTIFACT_ID" to buildSystem.artifactId, "JAVA_VERSION" to if (config.mcVersion < MinecraftVersions.MC1_17) 8 else 16, "COMMON_PROJECT_NAME" to buildSystem.commonModuleName ) if (hasData) { props["HAS_DATA"] = "true" } if (config.hasAuthors()) { props["AUTHOR_LIST"] = config.authors.joinToString(", ") } if (config.mixins) { props["MIXINS"] = "true" } return project.applyTemplate(FG3_SUBMODULE_BUILD_GRADLE_TEMPLATE, props) } fun applyModsToml(project: Project, buildSystem: BuildSystem, config: ForgeProjectConfig): String { val hasDisplayTestInManifest = config.forgeVersion >= ForgeConstants.DISPLAY_TEST_MANIFEST_VERSION val nextMcVersion = when (val part = config.mcVersion.parts.getOrNull(1)) { // Mimics the code used to get the next Minecraft version in Forge's MDK // https://github.com/MinecraftForge/MinecraftForge/blob/0ff8a596fc1ef33d4070be89dd5cb4851f93f731/build.gradle#L884 is SemanticVersion.Companion.VersionPart.ReleasePart -> (part.version + 1).toString() null -> "?" else -> part.versionString } val props = mutableMapOf( "ARTIFACT_ID" to buildSystem.artifactId, "MOD_NAME" to config.pluginName, "DISPLAY_TEST" to hasDisplayTestInManifest, "FORGE_SPEC_VERSION" to config.forgeVersion.parts[0].versionString, "MC_VERSION" to config.mcVersion.toString(), "MC_NEXT_VERSION" to "1.$nextMcVersion", "LICENSE" to config.license.toString() ) props["DESCRIPTION"] = config.description ?: "" config.updateUrl?.let { url -> if (url.isNotBlank()) { props["UPDATE_URL"] = url } } config.website?.let { url -> if (url.isNotBlank()) { props["WEBSITE"] = url } } if (config.hasAuthors()) { props["AUTHOR_LIST"] = config.authors.joinToString(", ") } return project.applyTemplate(MODS_TOML_TEMPLATE, props) } fun applyPackMcmeta( project: Project, artifactId: String, pack: ForgePackDescriptor, additionalData: ForgePackAdditionalData? ): String { val props = mapOf( "ARTIFACT_ID" to artifactId, "PACK_FORMAT" to pack.format.toString(), "PACK_COMMENT" to pack.comment, "FORGE_DATA" to additionalData, ) return project.applyTemplate(PACK_MCMETA_TEMPLATE, props) } fun applyMixinConfigTemplate( project: Project, buildSystem: BuildSystem ): String { val groupId = buildSystem.groupId.toPackageName() val artifactId = buildSystem.artifactId.toPackageName() val packageName = "$groupId.$artifactId.mixin" val props = mapOf( "PACKAGE_NAME" to packageName, "ARTIFACT_ID" to artifactId ) return project.applyTemplate(FORGE_MIXINS_JSON_TEMPLATE, props) } }

Add build comment

Mute test

Server communication failure

Run Custom Build

TODO

Responsibility

Edit tags

Loading...

Are you sure?