The official VS Addon template, for VS 2.4.0 and onward!
This template's default namespace/mod ID is "vs_template"- you'll likely want to change this!
Note: Mod ids can only have lowercase letters and underscores! Other characters will make your mod invalid!
You can do so by altering the following files:
- Change the base package name in
settings.gradle.kts - Change the mod_name and mod_id variables in
gradle.properties - Change the MOD_ID in
VSTemplateModForge.kt
You should also rename anything prefixed with "VSTemplate" to your mod's name! Keep in mind files are case-sensitive, for example:
VSTemplateMod.kt->MySpecialMod.kt✔️vs_templatae.mixins.json->myspecialmod.mixins.json✔️VSTemplateMod.kt->mySpecialMod.kt❌ (ok technically this is legal, but it's ugly)vs_template.mixins.json->MySpecialMod.mixins.json❌
If you are using IntelliJ, it is recommended to refactor in your IDE rather than changing the file name in file explorer, as it will automatically edit the references to the old name to match your new one.
IntelliJ tip: ctrl+shift+r for a project-wide find and replace
In this mod's gradle.properties file, you will find a few properties that define the versions of
each dependency this project has, including VS2 and its core. You can change these properties to update
dependency versions easily across the entire project, without having to edit buildscripts!
Most dependencies have some easy way to discover the latest/recommended version to depend on.
Valkyrien Skies itself is similar! The vs_core_version property should be equal to the identically named property in the Valkyrien Skies Github Repo,
and the vs2_version is the mod version, followed by the first 10 characters of the latest commit hash.
You can find the most recent retrievable version of VS easily by going to the Packages tab for Fabric or Forge!
Before running the mod after each change made, it is recommended to run the ./gradlew clean task in your command line, followed by clicking the sync button in the top right.
This ensures the files built are up to date with your code changes.
Alternatively to gradle clean, you can also manually delete your build folders. This is helpful if that task fails, for whatever reason.
To run the mod, run the mod development/runClient gradle task.
To get an exported jar, run the build/build gradle task, then find your jar at <root>/build/libs
src/main/java: This is where Java code goes. This is primarily used for Mixins, as Mixins cannot be written in Kotlin. You may also choose to relocate your primary mod files here, and not use Kotlin at all if you wish.src/main/kotlin: This is where Kotlin code goes. VS is primarily written in Kotlin, so it tends to be easier to work with VS when also writing in Kotlin.src/main/resources: This is where resources go, such as Forge'smods.toml, block models, item textures, etc
You can access the VS Core Api statically through ValkyrienSkies.api (with parenthesis for a method call in Java). The API's javadocs contain tons of extra information on how to use each part of it, so give them a read!
Additionally, there are a few features in VS2 itself- such as BlockEntityPhysicsListener- that you may want to use.
This template was built for Valkyrien Skies 2.4.0+. Changes in API from 2.3 will make it almost certainly not function with releases of the mod prior to 2.4, so make sure you intend to develop for that version!