Forge Community Wiki - User contributions [en-gb]

Entity Events

2021-04-11T15:56:32Z

Ravenbuilder934: remove trailing ")

== Damage Events ==
The series of events for an attack goes in this order:

# '''LivingAttackEvent''' - Use this if you want to catch any time an entity hits another, regardless of damage or whether it will be successful or not
# '''LivingHurtEvent''' - Use this if you want to handle an attack that is likely to hit, but before any potions, armour, or enchantments take effect
# '''LivingDamageEvent''' - Use this if you want to take action as an entity is definitely being damaged, with the final damage amount being available.
# '''LivingDeathEvent''' - Use this event if you want to handle an entity's death for any reason, with the exception of drops.
# '''Global Loot Modifiers''' - Use these if you want to handle any drops from a dying entity.

Making Items

2021-02-13T07:08:58Z

Ravenbuilder934: Couple grammar fixes

{{Under construction}}

Along with blocks, items are a key component of most mods. While blocks make up the world around you, items are what let you change it.

== Creating an Item ==
=== Basic Items ===
Basic items that need no special functionality (think sticks or sugar) don’t need custom classes. You can create an item by instantiating the <code><nowiki>Item</nowiki></code> class with an <code><nowiki>Item$Properties</nowiki></code> object. This <code><nowiki>Item$Properties</nowiki></code> object can be made by calling the constructor and can be customised by calling its methods. For instance:
{| class="wikitable sortable" border=1
!Method !!Description
|-
| <code><nowiki>group</nowiki></code> || Sets which <code><nowiki>ItemGroup</nowiki></code> (previously called creative tab) this item is under. Must be called if this item is meant to be shown on the creative menu. Vanilla groups can be found in the class <code><nowiki>ItemGroup</nowiki></code>.
|-
| <code><nowiki>maxDamage</nowiki></code> || Sets the maximum damage value for this item. If it is greater than ''0'', the properties ''damaged'' and ''damage'' are added to keep track of the current ''ItemStack'' damage.
|-
| <code><nowiki>maxStackSize</nowiki></code> || Sets the maximum stack size. You cannot have an item that is both damagable and stackable.
|-
| <code><nowiki>setNoRepair</nowiki></code> || Makes this item impossible to repair, even if it is damageable.
|-
| <code><nowiki>containerItem</nowiki></code> || Sets this item’s container item. For example, milk buckets give you back an empty bucket when they are crafted.
|-
| <code><nowiki>addToolType</nowiki></code> || Gives the item the ability of a <code><nowiki>ToolType</nowiki></code> (<code><nowiki>SHOVEL</nowiki></code>, <code><nowiki>AXE</nowiki></code>) at the specified harvest level (''0'' for Wood/Gold, ''1'' for Stone, ''2'' for Iron, ''3'' for Gold).
|-
|}

The above methods are chainable, meaning they <code><nowiki>return this</nowiki></code> to facilitate calling them in series.

=== Advanced Items ===
Setting the properties of an item as above only works for simple items. If you want more complicated items, you should subclass ''Item'' and override its methods.

== Registering an Item ==
Items must be [[Registration|registered]] to function.

Datageneration/I18n

2021-02-13T07:06:18Z

Ravenbuilder934: Fix typo

Lang Files can be generated by creating an extension of the file <code>LanguageProvider</code> class. From there you can add the translations in the <code>addTranslations</code> method, which you must override.

To add a translation, call the <code>LanguageProvider#add</code> method. This method takes the [[Internationalization|translation key]] and a string that is the displayname for the key.

Datageneration/I18n

2021-02-13T06:56:52Z

Ravenbuilder934: Minor grammar fixes

Lang Files can be generated by creating an extension of the File <code>LangurageProvider</code> class. From there you can add the translations in the <code>addTranslations</code> method, which you must override.

To add a translation, call the <code>LanguageProvider#add</code> method. This method takes the [[Internationalization|translation key]] and a String which is the displayname for the key.

Datapacks

2021-02-08T00:59:56Z

Ravenbuilder934: improve datapacks page

== Datapacks ==

In 1.13, Mojang added datapacks to the base game. They allow for the modification of the files placed under resources/data. This includes advancements, loot tables, structures, recipes, tags, and more in the future. Forge, and your mod, are also datapacks. Any user can therefore modify all the recipes, loot tables, and other data of a mod just like with resource packs.

Therefore, there is little sense in having configurable recipes or mob drops. Any user can modify them to any value (even from other mods).

== Dev Environment ==
In your project, you have a folder “resources” that has to contain a folder “data”. This folder will be your datapack. Your mod can have multiple data domains, since you can add or modify already existing datapacks, like vanilla’s, Forge’s, or another mod’s.

Additional reading on resources can be found [[Resources|here]].

== Overriding Files ==
To modify a datapack (be it the end-user or in dev), you need to know the mod ID and the registry name of the item/mob/advancement that you want to override. These can be found after launching the mod (F3+H), but providing it for users in a simpler way can be helpful (using GitHub will allow users to navigate the datapack you provide with the mod). You can then follow the steps found [https://minecraft.gamepedia.com/Data_Pack here] to create any datapack.

Using Resources

2021-02-08T00:56:58Z

Ravenbuilder934: Ravenbuilder934 moved page Using Resources to Resources: Remove "using" from the title

#REDIRECT [[Resources]]

Resources

2021-02-08T00:56:58Z

Ravenbuilder934: Ravenbuilder934 moved page Using Resources to Resources: Remove "using" from the title

A resource is extra data used by the game, and is stored in a data file, instead of being in the code. Minecraft has two primary resource systems active: one on the client used for visuals such as models, textures, and localization called <code><nowiki>assets</nowiki></code>, the other used for gameplay such as recipes and loot tables called <code><nowiki>data</nowiki></code>. Resource packs control the former, while data packs control the latter.

When multiple resource packs or data packs are enabled, they are merged. Generally, files from packs at the top of the stack override those below; however, for certain files, such as localization files and tags, data is actually merged contentwise. Mods actually define resource and data packs too, in their <code><nowiki>resources</nowiki></code> directories, but they are seen as subsets of the “Default” pack. Mod resource packs cannot be disabled, but they can be overridden by other resource packs. Mod datapacks can be disabled with the vanilla <code><nowiki>/datapack</nowiki></code> command.

All resources should have '''snake case''' paths and filenames (lowercase, using “_” for word boundaries).

== ResourceLocation ==

Minecraft identifies resources using <code><nowiki>ResourceLocation</nowiki></code>s. A <code><nowiki>ResourceLocation</nowiki></code> contains two parts: a namespace and a path. It generally points to the resource at <code><nowiki><assets|data>/<namespace>/<ctx>/<path></nowiki></code>, where <code><nowiki>ctx</nowiki></code> is a context-specific path fragment that depends on how the ResourceLocation is being used. When a <code><nowiki>ResourceLocation</nowiki></code> is written from/read as a string, it is seen as <code><nowiki><namespace>:<path></nowiki></code>. If the namespace and the colon are left out, then when the string is read into an ResourceLocation the namespace will almost always default to <code><nowiki>minecraft</nowiki></code>. A mod should put its resources into a namespace with the same name as its modid (E.g. a mod with id <code><nowiki>examplemod</nowiki></code> should place its resources in <code><nowiki><assets|data>/examplemod</nowiki></code>, and <code><nowiki>ResourceLocation</nowiki></code>s pointing to those files would look like <code><nowiki>examplemod:<path></nowiki></code>). This is not a requirement, and in some cases it can be desirable to use a different (or even more than one) namespace. <code><nowiki>ResourceLocation</nowiki></code>s are used outside the resource system, too, as they happen to be a great way to uniquely identify objects (e.g. [[Registration|registries]]).

== Important Directories ==

Minecraft expects certain parts of your project to be in certain locations, such as textures and JSONs.

All locations and items covered in this page are relative to your <code><nowiki>./src/main/resources/</nowiki></code> directory.

== General Files ==

=== mods.toml ===

The <code><nowiki>mods.toml</nowiki></code> file is in the <code><nowiki>./META-INF/</nowiki></code> directory. This holds the basic information relating to your mod.

=== pack.mcmeta ===

The <code><nowiki>pack.mcmeta</nowiki></code> file is in the current directory. This allows Minecraft to notice the assets provided by your mod.

== Assets ==

The <code><nowiki>./assets</nowiki></code> folder holds all client related files for a specific user. These files are only specific to the computer they're on.

=== Blockstates ===

Blockstate definition files are in the JSON format and are in the <code><nowiki>./assets/<modid>/blockstates/</nowiki></code> folder.

=== Localizations ===

Localizations are plain-text files with the file extension <code><nowiki>.json</nowiki></code> and the name being their [https://docs.microsoft.com/en-us/previous-versions/commerce-server/ee825488(v=cs.20)?redirectedfrom=MSDN language code] in lowercase such as <code><nowiki>en_us</nowiki></code>.

They are located in the <code><nowiki>./assets/<modid>/lang/</nowiki></code> folder.

=== Models ===

Model files are in JSON format and are located in <code><nowiki>./assets/<modid>/models/block/</nowiki></code> or <code><nowiki>./assets/<modid>/models/item/</nowiki></code> depending on whether they are for a block or an item, respectively.

=== Textures ===

Textures are in the PNG format and are located in <code><nowiki>./assets/<modid>/textures/block/</nowiki></code> or <code><nowiki>./assets/<modid>/textures/item/</nowiki></code> depending on whether they are for a block or an item, respectively. For other entries, they will be placed in their specified location within <code><nowiki>./assets/<modid>/textures/</nowiki></code>.

== Data ==

The <code><nowiki>./data</nowiki></code> folder holds all server related files for a specific game file. These files are synced across the network from the hosting server location.

=== Advancements ===

Advancements are in JSON format and are located in <code><nowiki>./data/<modid>/advancements/<group>/</nowiki></code> where <code><nowiki>group</nowiki></code> is the tab the advancement is part of.

=== Loot Tables ===

Loot tables are in JSON format and are located in <code><nowiki>./data/<modid>/loot_tables/<group>/</nowiki></code> where <code><nowiki>group</nowiki></code> is the general object where the loot table drops from (e.g. a block's loot table is in <code><nowiki>blocks</nowiki></code>).

=== Recipes ===

Recipes are in JSON format and are located in <code><nowiki>./data/<modid>/recipes/</nowiki></code>.

=== Tags ===

Tags are in JSON format and are located in <code><nowiki>./data/<modid>/tags/<group>/</nowiki></code> where <code><nowiki>group</nowiki></code> is the registry object to create the tags for (e.g. an entity tag would be in <code><nowiki>entity_types</nowiki></code>).

FCWMeta:About

2021-02-08T00:51:56Z

Ravenbuilder934: Create (stubby) about page

== Forge Community Wiki ==

The Forge Community Wiki is a wiki about the Minecraft modding API Forge. It was created as an alternative to the [https://mcforge.readthedocs.io/ official docs]. It is actively maintained by many contributors and has its own [https://discord.gg/Nn42eAh Discord server].

Datapacks

2021-02-08T00:42:19Z

Ravenbuilder934: create datapacks page (copy from readthedocs site, will improve)

== Datapacks ==

In 1.13, Mojang added datapacks to the base game. They allow for the modification of the files placed under resources/data. This includes advancements, loot_tables, structures, recipes, tags, and more in the future. Forge, and your mod, are also datapacks. Any user can therefore modify all the recipes, loot tables, and other data of a mod just like with resource packs.

Therefore, there is little sense in having configurable recipes or mob drops. Any user can modify them to any value (even from other mods).

== Dev Environment ==
In your project, you have a folder “resources” that has to contain a folder “data”. This folder will be your datapack. Your mod can have multiple data domains, since you can add or modify already existing datapacks, like vanilla’s, forge’s, or another mod’s.

Additional reading: Resource Locations

== Overriding Files ==
To modify a datapack (be it the end-user or in dev), you need to know the mod id and the registry name of the item/mob/advancement that you want to override. These can be found after launching the mod (F3+h), but providing it for users in a simpler way can be helpful (using Github will allow users to navigate the datapack you provide with the mod). You can then follow the steps found here to create any datapack.

Recipes

2021-02-08T00:41:18Z

Ravenbuilder934: Improve recipes page

With the update to Minecraft 1.12, Mojang introduced a new data-driven recipe system based on JSON files. Since then, it has been adopted by Forge as well and was expanded in Minecraft 1.13 into [[datapacks]].

== Loading Recipes ==
Forge will load all recipes found within the <code><nowiki>./resources/data/<modid>/recipes/</nowiki></code> folder of your mod. You can call these files whatever you want, though the vanilla convention is to name them after the output item. For multiple recipes from different sources (smelting, crafting, etc) one vanilla convention is to use <code><nowiki>item_name_from_smelting.json</nowiki></code>. This name is also used as the registration key but does not affect the operation of the recipe.

== The Recipe File ==
A basic recipe file might look like the following example:
<syntaxhighlight lang="json">
{
"type": "minecraft:crafting_shaped",
"pattern":
[
"XXX",
"XAX",
"XXX"
],
"key":
{
"X":
{
"tag": "forge:gems/diamond"
},
"A":
{
"item": "mymod:myfirstitem"
}
},
"result":
{
"item": "mymod:myseconditem",
"count": 9
}
}
</syntaxhighlight>
{{Colored box|title=Tip|content=When you first obtain an ingredient to a vanilla recipe, it will automatically unlock the recipe in the recipe book. To achieve the same effect, you have to use the <code><nowiki>Advancement</nowiki></code> system and create a new <code><nowiki>Advancement</nowiki></code> for each of your ingredients.
<br><br>
The advancement has to exist. This doesn’t mean it has to be visible in the advancement tree.}}

=== Groups ===
Optionally, you can add a group to your recipes to be displayed within the recipe helper interface. All recipes with the same group String will be shown in the same group. For example, this can be used to have all door recipes shown in the recipe helper interface as a single entry, even though there are different types of doors.

=== Type ===
The type of the recipe. You can think of this as the definition of which crafting layout is to be used. <code><nowiki>minecraft:crafting_shaped</nowiki></code> and <code><nowiki>minecraft:crafting_shapeless</nowiki></code> are the two options.

== Types of Crafting Recipes ==
In this section, we will take a closer look at the differences between defining a shaped and a shapeless crafting recipe.

=== Shaped Crafting ===
Shaped recipes require the <code><nowiki>pattern</nowiki></code> and <code><nowiki>key</nowiki></code> keywords.
The '''Pattern''' keyword defines the slot an item must appear in using placeholder characters. You can choose whatever character you want to be a placeholder for an item.
'''Keys''' define what items the placeholders stand for. A key is defined by a placeholder character and the item or tag it stands for (in the correct format).

=== Shapeless Crafting ===
A shapeless recipe doesn’t use the <code><nowiki>pattern</nowiki></code> or <code><nowiki>key</nowiki></code> keywords.

To define a shapeless recipe, you have to use the <code><nowiki>ingredients</nowiki></code> list. It defines which items have to be used for the crafting process. There are many more of these types that can be used here, and you can even register your own. It is even possible to define multiple instances of the same item which means multiple of these items have to be in place for the crafting recipe to take place.

{{Colored box|title=Tip|content=While there is no limit on how many ingredients your recipe requires, the vanilla crafting table only allows 9 items for each crafting recipe.}}
Below is an example of an ingredient list:
<syntaxhighlight lang="json">
"ingredients": [
{
"tag": "forge:gems/diamond"
},
{
"item": "minecraft:nether_star"
}
],
</syntaxhighlight>

== Recipe Elements ==

=== Patterns ===
A pattern will be defined with the <code><nowiki>pattern</nowiki></code> list. Each string represents one row in the crafting grid and each placeholder character within the string represents a column. As shown in the example above, a space means that no item needs to be inserted at that position.

=== Keys ===
A key set is used in combination with a pattern set. It contains keys whose name is the same as the placeholder character in the pattern list which it represents. One key may be defined to represent multiple items, as is the case for the wooden button. This means that the player can use one of the defined items for the crafting recipe, for example, different types of wood.
<syntaxhighlight lang="json">
"key": {
"#": [
{
"item": "minecraft:oak_planks"
},
{
"item": "minecraft:spruce_planks"
}
]
}
</syntaxhighlight>

=== Results ===

Every <code><nowiki>recipe</nowiki></code> must have a result tag to define the output item.

When crafting something, you can get more than one item. This is achieved by defining the <code><nowiki>count</nowiki></code> value. If this is left out, meaning it doesn’t exist within the result block, it defaults to 1. Negative values are not allowed here as an itemstack cannot be smaller than 0. There is no option to use the <code><nowiki>count</nowiki></code> number anywhere else than the result.

User:Ravenbuilder934

2021-02-07T23:46:51Z

Ravenbuilder934: line spacing...

heya nerds

minecolonies and quote 90

User:Ravenbuilder934

2021-02-07T23:46:10Z

Ravenbuilder934: Created page with "heya nerds minecolonies and quote 90"

heya nerds
minecolonies and quote 90