297
edits
Changes
From Forge Community Wiki
User:SciWhiz12/sandbox/structure (view source)
Revision as of 16:12, 15 December 2020
, 16:12, 15 December 2020start testing the tree list
The structure of your mod is important in keeping your mod organized, for both your benefit and the benefit of anyone who wishses to make a feature for your mod. A disorganized mod structure may cause headaches when someone is trying to update it to a higher version, especially if they cannot modify the package structure, due to i.e. licensing.
{{Colored box|title=Tip|background-title-color=#633193|content=Note that this page is only a recommendation for your mod structure; you may structure your mod in any way you see fit.}}
== Packaging ==
Pick a unique package name for your mod. If you own a URL associated with your project, you can use it as your top level package. For example if you own "example.com", you may use <code>com.example</code> as your top level package.
The next level package is usually your mod's ID: if your mod ID is <code>examplemod</code>, your mod's package will be <code>com.example.examplemod</code>.
{{Colored box|title=Important|content=Do not use a domain for your top level package if you do not own that domain. It is perfectly acceptable to have your top level package be named with anything, such as your name/nickname, or the name of the mod (<code>me.exampledude.examplemod</code>).}}
=== Using Subpackages ===
Rather than clutter up a single class and package with everything, it is recommended you break your mod into subpackages.
A common strategy is to make a subpackage for grouping classes that have a common purpose. For example, your blocks classes can be under <code>blocks</code>, your entities classes can be under <code>entities</code>, your helper utilities can be under <code>helpers</code>, etc.
It is recommended to add a <code>client</code> subpackage under your main package, to isolate your [[Sides|client-only code]] from the rest, such as your GUIs and renderers.
By keeping your code in clean subpackages, you can grow your mod much more organically.
== Class Naming Schemes ==
A common class naming scheme allows easier deciphering of the purpose of the class, and makes it easier for someone developing for your mod to find specific classes.
The usual style is to use suffixes for your classes, for example:
* An <code>Item</code> called <code>PowerRing</code> would be in the <code>items</code> package, with a class name of <code>PowerRingItem</code>.
* A <code>Block</code> called <code>NotDirt</code> would be in a <code>blocks</code> package, with a class name of <code>NotDirtBlock</code>.
* A <code>TileEntity</code> for a block called <code>SuperChewer</code> would be in a <code>tile</code> or <code>tileentity</code> package, with a class name of <code>SuperChewerTile</code>.
== The Mod File ==
The main mod class - the class that is annotated with <code>@Mod</code> - is usually put into the main package of your mod, and not placed into a subpackage. This allows an easier time to access this, as your main mod class is the entrypoint of your mod.
The <code>@Mod</code> annotation indicates to the mod loader that this class is the entry point of your mod. Each <code>@Mod</code> annotation and their value should be paired with a mod id entry in your <code>mods.toml</code> file.
== The <code>mods.toml</code> file ==
The <code>mods.toml</code> file is read by the mod loader to determine what mods are packaged into your JAR file, and what information to display to the user in the Mods listing screen (accessible by pressing the "Mods" button on the main menu of the game).
The <code>mods.toml</code> file is formatted in [https://toml.io/en/ Tom's Obvious Minimal Language], or TOML for short. The example <code>mods.toml</code> file in the MDK provides comments explaining the contents of the file. It should be stored under the <code>META-INF</code> folder in your resources directory (<code>src/main/resources/META-INF/mods.toml</code>).
<div class="mw-collapsible mw-collapsed" style="border: solid 2px; padding: 2px 5px; margin-top: 3px">
<div style="font-weight:bold;line-height:1.6;">Example <code>mods.toml</code> file</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="TOML">
modLoader="javafml"
# Forge for 1.16.3 is version 34
loaderVersion="[34,)"
license="All rights reserved"
issueTrackerURL="github.com/MinecraftForge/MinecraftForge/issues"
showAsResourcePack=false
[[mods]]
modId="examplemod"
version="1.0.0.0"
displayName="Example Mod"
updateJSONURL="minecraftforge.net/versions.json"
displayURL="minecraftforge.net"
logoFile="logo.png"
credits="I'd like to thank my mother and father."
authors="Author"
description='''
Lets you craft dirt into diamonds. This is a traditional mod that has existed for eons. It is ancient. The holy Notch created it. Jeb rainbowfied it. Dinnerbone made it upside down. Etc.
'''
[[dependencies.examplemod]]
modId="forge"
mandatory=true
versionRange="[34,)"
ordering="NONE"
side="BOTH"
[[dependencies.examplemod]]
modId="minecraft"
mandatory=true
versionRange="[1.16.3]"
ordering="NONE"
side="BOTH"
</syntaxhighlight>
</div>
</div>
The default Gradle configuration replaces <code>${file.jarVersion}</code> with the project version, but only within <code>mods.toml</code>, so you should use those instead of directly writing them out. Here is a table of attributes that may be given to a mod, where <code>mandatory</code> means there is no default and the absence of the property causes an error.
The <code>mods.toml</code> is split into three parts: the non-mod-specific properties, which are linked to the mod file; the mod properties, with a section for each mod; and dependency configurations, with a section for each mod's dependencies.
{{Tree list}}
* Root of the file
** <code>modLoader</code>: '''(mandatory)''' The language loader for the mod. Used to specify an alternative language for the mod, such as Kotlin, if one exists. ''The Forge-provided Java loader is <code>javafml</code>.''
** <code>loaderVersion</code>: '''(mandatory)''' The acceptable version range of the language loader, expressed as a [https://maven.apache.org/enforcer/enforcer-rules/versionRanges.html Maven version spec]. ''For the Forge-provided Java loader, the version is the major version of the Forge version.''
** <code>license</code>: '''(mandatory)''' The license for the mod(s) in this JAR. This string may be any valid string, but it is suggested to set the value to be the name of your license, and/or a link to that license.
** <code>showAsResourcePack</code>: (default: <code>false</code>) Whether to display this mod's resources as a separate option in the resource pack menu. If disabled, the mod's resources will be rolled into the "Mod resources" pack.
** <code>properties</code>: (default: <code>{}</code> ) A table of custom substitution properties. This is used by <code>StringSubstitutor</code> to replace values, using <code>${file.*}</code>.
** <code>issueTrackerURL</code> (default: nothing) A URL for an issues tracker. <span class="note_alert"> This should never be a blank string, as that will cause an error. </span>
** <code><nowiki>[[mods]]</nowiki></code>: An entry defining a new mod.
*** <code>modId</code>: '''(mandatory)''' The mod's identifier (modid). This must match the following regex: <code><nowiki>^[a-z][a-z0-9_-]{1,63}$</nowiki></code> (starts with a lowercase letter; other characters must be a lowercase letter, number, underscore or hyphen; must be 2-64 characters long).
*** <code>namespace</code>: (default: value of <code>modId</code>) : An overriding namespace for the resource pack. <span class="note_info"> Currently, there is no use for this property </span>
{{Tree list/end}}
=== Mod Properties ===
A mod entry is defined by a new section starting with a <code><nowiki>[[mods]]</nowiki></code> header (In TOML, the <code><nowiki>[[mods]]</nowiki></code> defines an [https://toml.io/en/v1.0.0-rc.2#array-of-tables array of tables]). All properties from that line until the next header will become the properties for that mod.
{| class="wikitable"
! Property !! Type !! Defaults
! Description
! Example
|-
| <code>version</code> || string || <code>"1"</code>
| The version of the mod jar, used when the mod is a dependency of another mod, expressed as numbers seperated by dots (<code>.</code>), ideally conforming to [[Semantic_Versioning|Semantic Versioning]]. The default value in the MDK for this is <code>${file.jarVersion}</code>, which is replaced at runtime with the <code>Implementation-Version</code> found in the jar's manifest file.
| <code>"0.2.4-beta1"</code>
|-
| <code>displayName</code> || string || value of <code>modId</code>
| The display name of the mod, for use in the Mods listing screen
| <code>"Example Mod"</code>
|-
| <code>description</code> || string || <code>"MISSING DESCRIPTION"</code>
| The description of the mod, for use in the Mods listing screen. It's recommended to use a multiline string (surrounded by <code>'''<code>)
| <code>"Adds things and stuff. "</code>
|-
| <code>logoFile</code> || string || ''nothing''
| The path of the logo file image, for use in the Mods listing screen. The image must be in the root of the jar file, not in any subfolder thereof (e.g. the file is directly in <code>src/main/resources</code>)
| <code>"myAwesomeLogo.png"</code>
|-
| <code>logoBlur</code> || boolean || <code>true</code>
| Whether to do some blurring on the mod's logo in the Mods listing screen. Has no effect if <code>logoFile</code> is not set.
| <code>false</code>
|-
| <code>updateJSONURL</code> || string || ''nothing''
| The update JSON URL, used by the [Update_Checker update checker]. <inline alert> This should never be a blank string, as that will cause an error. </inline>
| <code>http://myurl.me/path/to/update.json</code>
|-
| <code>modproperties</code> || table || <code>{}</code>
| A table of custom mod properties; this is not used for Forge, but is mainly for use by mods.
| <code>{ "useThing" = true }</code>
|-
| <code>credits</code> || string || ''nothing''
| Credits and acknowledgements for the mod, for use in the Mods listing screen. Can be any string.
| <code>"This person and that guy"</code>
|-
| <code>authors</code> || string || ''nothing''
| Authors for the mod, for use in the Mods listing screen. Can be any string.
| <code>"ExampleDude"</code>
|-
| <code>displayURL</code> || string || ''nothing''
| A URL, displayed on the Mods listing screen. Can be any string.
| <code>http://example.com/</code>
|}
=== Dependency Configurations ===
Mods can define dependencies for their mods, which are checked by Forge before loading mods. This is used for e.g. ensuring your mod loads after another, or hard-crashing if a mod with a specified version does not exist.
These dependency configurations, like the mod properties, are defined by a new section starting with <code>[[dependencies.<modid>]]</code>, with <code><modid></code> being the mod id that has this dependency. All properties from that line until the next header will become the properties of that dependency configuration.
{| class="wikitable"
! Property !! Type !! Defaults
! Description
! Example
|-
| <code>modId</code> || string || '''mandatory'''
| The mod id of the dependency.
| <code>examplelibrary</code>
|-
| <code>mandatory</code> || boolean || '''mandatory'''
| Whether to crash if this dependency is not met.
| <code>true</code>
|-
| <code>versionRange</code> || string || <code>""</code>
| The acceptable version range of the dependency, expressed as a [https://maven.apache.org/enforcer/enforcer-rules/versionRanges.html Maven version spec]. An empty string is an unbounded version range, which matches any version.
| <code>"[1.0,2.0)"</code>
|-
| <code>ordering</code> || string || <code>"NONE"</code>
| Defines if the mod must load before or after this dependency. The valid values are <code>BEFORE</code> (must load before), <code>AFTER</code> (must load after), and <code>NONE</code> (does not care about order).
| <code>"AFTER"</code>
|-
| <code>side</code> || string || <code>"BOTH"</code>
| Defines if this dependency needs only to be met on a specfic [[Sides|physical side]]. The valid values are <code>CLIENT</code> (present on the client), <code>SERVER</code> (present on the dedicated server), and <code>BOTH</code> (present on both sides).
| <code>"CLIENT"</code>
|}
{{Colored box|title=Important|content=When specifying dependency ordering between two or more mods, beware of cyclic order!: ex. if mod A must load before mod B, and mod B must load before mod A, the game will crash because of the circular cycle.}}
[[Category:Getting Started]]