Skip to content

Commit a554e73

Browse files
authored
Initial commit
0 parents  commit a554e73

File tree

16 files changed

+1000
-0
lines changed

16 files changed

+1000
-0
lines changed

.gitattributes

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Disable autocrlf on generated files, they always generate with LF
2+
# Add any extra files or paths here to make git stop saying they
3+
# are changed when only line endings change.
4+
src/generated/**/.cache/cache text eol=lf
5+
src/generated/**/*.json text eol=lf

.github/workflows/build.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Build
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout repository
10+
uses: actions/checkout@v4
11+
with:
12+
fetch-depth: 0
13+
fetch-tags: true
14+
15+
- name: Setup JDK 21
16+
uses: actions/setup-java@v4
17+
with:
18+
java-version: '21'
19+
distribution: 'temurin'
20+
21+
- name: Setup Gradle
22+
uses: gradle/actions/setup-gradle@v4
23+
24+
- name: Build with Gradle
25+
run: ./gradlew build

.gitignore

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# eclipse
2+
bin
3+
*.launch
4+
.settings
5+
.metadata
6+
.classpath
7+
.project
8+
9+
# idea
10+
out
11+
*.ipr
12+
*.iws
13+
*.iml
14+
.idea
15+
16+
# gradle
17+
build
18+
.gradle
19+
20+
# other
21+
eclipse
22+
run
23+
runs
24+
run-data
25+
26+
repo

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
2+
Installation information
3+
=======
4+
5+
This template repository can be directly cloned to get you started with a new
6+
mod. Simply create a new repository cloned from this one, by following the
7+
instructions provided by [GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
8+
9+
Once you have your clone, simply open the repository in the IDE of your choice. The usual recommendation for an IDE is either IntelliJ IDEA or Eclipse.
10+
11+
If at any point you are missing libraries in your IDE, or you've run into problems you can
12+
run `gradlew --refresh-dependencies` to refresh the local cache. `gradlew clean` to reset everything
13+
{this does not affect your code} and then start the process again.
14+
15+
Mapping Names:
16+
============
17+
By default, the MDK is configured to use the official mapping names from Mojang for methods and fields
18+
in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this
19+
license. For the latest license text, refer to the mapping file itself, or the reference copy here:
20+
https://github.com/NeoForged/NeoForm/blob/main/Mojang.md
21+
22+
Additional Resources:
23+
==========
24+
Community Documentation: https://docs.neoforged.net/
25+
NeoForged Discord: https://discord.neoforged.net/

TEMPLATE_LICENSE.txt

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
MIT License
2+
3+
Copyright (c) 2023 NeoForged project
4+
5+
This license applies to the template files as supplied by github.com/NeoForged/MDK
6+
7+
8+
Permission is hereby granted, free of charge, to any person obtaining a copy
9+
of this software and associated documentation files (the "Software"), to deal
10+
in the Software without restriction, including without limitation the rights
11+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12+
copies of the Software, and to permit persons to whom the Software is
13+
furnished to do so, subject to the following conditions:
14+
15+
The above copyright notice and this permission notice shall be included in all
16+
copies or substantial portions of the Software.
17+
18+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24+
SOFTWARE.

build.gradle

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
plugins {
2+
id 'idea'
3+
id 'java-library'
4+
id 'maven-publish'
5+
id 'net.neoforged.moddev' version '2.0.78'
6+
}
7+
8+
tasks.named('wrapper', Wrapper).configure {
9+
// Define wrapper values here so as to not have to always do so when updating gradlew.properties.
10+
// Switching this to Wrapper.DistributionType.ALL will download the full gradle sources that comes with
11+
// documentation attached on cursor hover of gradle classes and methods. However, this comes with increased
12+
// file size for Gradle. If you do switch this to ALL, run the Gradle wrapper task twice afterwards.
13+
// (Verify by checking gradle/wrapper/gradle-wrapper.properties to see if distributionUrl now points to `-all`)
14+
distributionType = Wrapper.DistributionType.BIN
15+
}
16+
17+
version = mod_version
18+
group = mod_group_id
19+
20+
repositories {
21+
mavenLocal()
22+
}
23+
24+
base {
25+
archivesName = mod_id
26+
}
27+
28+
// Mojang ships Java 21 to end users starting in 1.20.5, so mods should target Java 21.
29+
java.toolchain.languageVersion = JavaLanguageVersion.of(21)
30+
31+
neoForge {
32+
// Specify the version of NeoForge to use.
33+
version = project.neo_version
34+
35+
parchment {
36+
mappingsVersion = project.parchment_mappings_version
37+
minecraftVersion = project.parchment_minecraft_version
38+
}
39+
40+
// This line is optional. Access Transformers are automatically detected
41+
// accessTransformers = project.files('src/main/resources/META-INF/accesstransformer.cfg')
42+
43+
// Default run configurations.
44+
// These can be tweaked, removed, or duplicated as needed.
45+
runs {
46+
client {
47+
client()
48+
49+
// Comma-separated list of namespaces to load gametests from. Empty = all namespaces.
50+
systemProperty 'neoforge.enabledGameTestNamespaces', project.mod_id
51+
}
52+
53+
server {
54+
server()
55+
programArgument '--nogui'
56+
systemProperty 'neoforge.enabledGameTestNamespaces', project.mod_id
57+
}
58+
59+
// This run config launches GameTestServer and runs all registered gametests, then exits.
60+
// By default, the server will crash when no gametests are provided.
61+
// The gametest system is also enabled by default for other run configs under the /test command.
62+
gameTestServer {
63+
type = "gameTestServer"
64+
systemProperty 'neoforge.enabledGameTestNamespaces', project.mod_id
65+
}
66+
67+
data {
68+
data()
69+
70+
// example of overriding the workingDirectory set in configureEach above, uncomment if you want to use it
71+
// gameDirectory = project.file('run-data')
72+
73+
// Specify the modid for data generation, where to output the resulting resource, and where to look for existing resources.
74+
programArguments.addAll '--mod', project.mod_id, '--all', '--output', file('src/generated/resources/').getAbsolutePath(), '--existing', file('src/main/resources/').getAbsolutePath()
75+
}
76+
77+
// applies to all the run configs above
78+
configureEach {
79+
// Recommended logging data for a userdev environment
80+
// The markers can be added/remove as needed separated by commas.
81+
// "SCAN": For mods scan.
82+
// "REGISTRIES": For firing of registry events.
83+
// "REGISTRYDUMP": For getting the contents of all registries.
84+
systemProperty 'forge.logging.markers', 'REGISTRIES'
85+
86+
// Recommended logging level for the console
87+
// You can set various levels here.
88+
// Please read: https://stackoverflow.com/questions/2031163/when-to-use-the-different-log-levels
89+
logLevel = org.slf4j.event.Level.DEBUG
90+
}
91+
}
92+
93+
mods {
94+
// define mod <-> source bindings
95+
// these are used to tell the game which sources are for which mod
96+
// mostly optional in a single mod project
97+
// but multi mod projects should define one per mod
98+
"${mod_id}" {
99+
sourceSet(sourceSets.main)
100+
}
101+
}
102+
}
103+
104+
// Include resources generated by data generators.
105+
sourceSets.main.resources { srcDir 'src/generated/resources' }
106+
107+
// Sets up a dependency configuration called 'localRuntime'.
108+
// This configuration should be used instead of 'runtimeOnly' to declare
109+
// a dependency that will be present for runtime testing but that is
110+
// "optional", meaning it will not be pulled by dependents of this mod.
111+
configurations {
112+
runtimeClasspath.extendsFrom localRuntime
113+
}
114+
115+
dependencies {
116+
// Example optional mod dependency with JEI
117+
// The JEI API is declared for compile time use, while the full JEI artifact is used at runtime
118+
// compileOnly "mezz.jei:jei-${mc_version}-common-api:${jei_version}"
119+
// compileOnly "mezz.jei:jei-${mc_version}-neoforge-api:${jei_version}"
120+
// We add the full version to localRuntime, not runtimeOnly, so that we do not publish a dependency on it
121+
// localRuntime "mezz.jei:jei-${mc_version}-neoforge:${jei_version}"
122+
123+
// Example mod dependency using a mod jar from ./libs with a flat dir repository
124+
// This maps to ./libs/coolmod-${mc_version}-${coolmod_version}.jar
125+
// The group id is ignored when searching -- in this case, it is "blank"
126+
// implementation "blank:coolmod-${mc_version}:${coolmod_version}"
127+
128+
// Example mod dependency using a file as dependency
129+
// implementation files("libs/coolmod-${mc_version}-${coolmod_version}.jar")
130+
131+
// Example project dependency using a sister or child project:
132+
// implementation project(":myproject")
133+
134+
// For more info:
135+
// http://www.gradle.org/docs/current/userguide/artifact_dependencies_tutorial.html
136+
// http://www.gradle.org/docs/current/userguide/dependency_management.html
137+
}
138+
139+
// This block of code expands all declared replace properties in the specified resource targets.
140+
// A missing property will result in an error. Properties are expanded using ${} Groovy notation.
141+
var generateModMetadata = tasks.register("generateModMetadata", ProcessResources) {
142+
var replaceProperties = [
143+
minecraft_version : minecraft_version,
144+
minecraft_version_range: minecraft_version_range,
145+
neo_version : neo_version,
146+
neo_version_range : neo_version_range,
147+
loader_version_range : loader_version_range,
148+
mod_id : mod_id,
149+
mod_name : mod_name,
150+
mod_license : mod_license,
151+
mod_version : mod_version,
152+
mod_authors : mod_authors,
153+
mod_description : mod_description
154+
]
155+
inputs.properties replaceProperties
156+
expand replaceProperties
157+
from "src/main/templates"
158+
into "build/generated/sources/modMetadata"
159+
}
160+
// Include the output of "generateModMetadata" as an input directory for the build
161+
// this works with both building through Gradle and the IDE.
162+
sourceSets.main.resources.srcDir generateModMetadata
163+
// To avoid having to run "generateModMetadata" manually, make it run on every project reload
164+
neoForge.ideSyncTask generateModMetadata
165+
166+
// Example configuration to allow publishing using the maven-publish plugin
167+
publishing {
168+
publications {
169+
register('mavenJava', MavenPublication) {
170+
from components.java
171+
}
172+
}
173+
repositories {
174+
maven {
175+
url "file://${project.projectDir}/repo"
176+
}
177+
}
178+
}
179+
180+
tasks.withType(JavaCompile).configureEach {
181+
options.encoding = 'UTF-8' // Use the UTF-8 charset for Java compilation
182+
}
183+
184+
// IDEA no longer automatically downloads sources/javadoc jars for dependencies, so we need to explicitly enable the behavior.
185+
idea {
186+
module {
187+
downloadSources = true
188+
downloadJavadoc = true
189+
}
190+
}

gradle.properties

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Sets default memory used for gradle commands. Can be overridden by user or command line properties.
2+
org.gradle.jvmargs=-Xmx1G
3+
org.gradle.daemon=true
4+
org.gradle.parallel=true
5+
org.gradle.caching=true
6+
org.gradle.configuration-cache=true
7+
8+
#read more on this at https://github.com/neoforged/ModDevGradle?tab=readme-ov-file#better-minecraft-parameter-names--javadoc-parchment
9+
# you can also find the latest versions at: https://parchmentmc.org/docs/getting-started
10+
parchment_minecraft_version=1.21.1
11+
parchment_mappings_version=2024.11.17
12+
# Environment Properties
13+
# You can find the latest versions here: https://projects.neoforged.net/neoforged/neoforge
14+
# The Minecraft version must agree with the Neo version to get a valid artifact
15+
minecraft_version=1.21.1
16+
# The Minecraft version range can use any release version of Minecraft as bounds.
17+
# Snapshots, pre-releases, and release candidates are not guaranteed to sort properly
18+
# as they do not follow standard versioning conventions.
19+
minecraft_version_range=[1.21.1, 1.22)
20+
# The Neo version must agree with the Minecraft version to get a valid artifact
21+
neo_version=21.1.133
22+
# The Neo version range can use any version of Neo as bounds
23+
neo_version_range=[21.1.0,)
24+
# The loader version range can only use the major version of FML as bounds
25+
loader_version_range=[4,)
26+
27+
## Mod Properties
28+
29+
# The unique mod identifier for the mod. Must be lowercase in English locale. Must fit the regex [a-z][a-z0-9_]{1,63}
30+
# Must match the String constant located in the main mod class annotated with @Mod.
31+
mod_id=examplemod
32+
# The human-readable display name for the mod.
33+
mod_name=Example Mod
34+
# The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default.
35+
mod_license=All Rights Reserved
36+
# The mod version. See https://semver.org/
37+
mod_version=1.0.0
38+
# The group ID for the mod. It is only important when publishing as an artifact to a Maven repository.
39+
# This should match the base package used for the mod sources.
40+
# See https://maven.apache.org/guides/mini/guide-naming-conventions.html
41+
mod_group_id=com.example.examplemod
42+
# The authors of the mod. This is a simple text string that is used for display purposes in the mod list.
43+
mod_authors=YourNameHere, OtherNameHere
44+
# The description of the mod. This is a simple multiline text string that is used for display purposes in the mod list.
45+
mod_description=Example mod description.\nNewline characters can be used and will be replaced properly.

gradle/wrapper/gradle-wrapper.jar

42.6 KB
Binary file not shown.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip
4+
networkTimeout=10000
5+
validateDistributionUrl=true
6+
zipStoreBase=GRADLE_USER_HOME
7+
zipStorePath=wrapper/dists

0 commit comments

Comments
 (0)