Add a guide for Custom Enchantments #134

krizh-p · 2024-07-09T19:29:38Z

I wrote a guide for creating Custom Enchantment Effects as 1.21 completetly changes how enchantments must be made.

netlify · 2024-07-09T19:29:52Z

✅ Deploy Preview for nimble-elf-d9d491 ready!

Name	Link
🔨 Latest commit	`1cc3cb2`
🔍 Latest deploy log	https://app.netlify.com/sites/nimble-elf-d9d491/deploys/66b26b37bafb87000815001c
😎 Deploy Preview	https://deploy-preview-134--nimble-elf-d9d491.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

IMB11

Quite a bit to do, but it's a great start - the structure is definitely there, it just needs the following done:

Breaking up larger paragraphs into seperate paragraphs (especially the start and the "Creating The Enchantment" first paragraph.
Delegating the datagen setup information to the relevant Fabric Wiki page
Fix issues with markdown-lint, see either the files tab on this PR to see the issues, or view the github action logs, you can also use the vscode plugin to find all lint issues.
Moving code from code blocks into the reference mod.
Using either an LLM or a tool such as LanguageTool to ensure grammar and readability is good.

Overall, this is a great guide, it really uses all the features of the wiki, and will be really useful for many developers! Good job! 👍

develop/items/custom-enchantment-effects.md

reference/latest/src/main/java/com/example/docs/FabricDocsReference.java

reference/latest/src/main/java/com/example/docs/data/EnchantmentGenerator.java

Co-authored-by: Calum H. <[email protected]>

…c-docs into customEnchantments

krizh-p · 2024-07-09T21:09:28Z

Just went through and fixed everything mentioned in the code review

develop/items/custom-enchantment-effects.md

applied suggested grammar fixes Co-authored-by: Miroma <[email protected]>

krizh-p

accepted fixes in grammar

its-miroma

I am only reviewing the Markdown file, not the Java code; that should be reviewed by someone else.

develop/items/custom-enchantment-effects.md

Co-authored-by: Miroma <[email protected]>

JR1811

Just some small and mostly "clean-code" related stuff.

...nce/latest/src/main/java/com/example/docs/enchantment/effect/LightningEnchantmentEffect.java

reference/latest/src/main/java/com/example/docs/enchantment/ModEnchantmentEffects.java

reference/latest/src/main/java/com/example/docs/data/EnchantmentGenerator.java

develop/items/custom-enchantment-effects.md

…c-docs into pr/krizh-p/134

IMB11 · 2024-08-06T18:28:23Z

I have cleaned up the introduction and final sentences, this is good IMO.

its-miroma · 2024-08-08T00:12:40Z

develop/items/custom-enchantment-effects.md

+
+## Custom Enchantment Effects {#custom-enchantment-effects}
+
+Start by creating an `enchantment` folder, and within it create a folder `effect`. Within the `effect` folder, we'll create the `LightningEnchantmentEffect` record.


Suggested change

Start by creating an `enchantment` folder, and within it create a folder `effect`. Within the `effect` folder, we'll create the `LightningEnchantmentEffect` record.

Start by creating an `enchantment` folder, and within it, create an `effect` folder. Within that, we'll create the `LightningEnchantmentEffect` record.

its-miroma · 2024-08-08T00:13:11Z

develop/items/custom-enchantment-effects.md

+
+Start by creating an `enchantment` folder, and within it create a folder `effect`. Within the `effect` folder, we'll create the `LightningEnchantmentEffect` record.
+
+Next, we can create a constructor and override the `EnchantmentEntityEffect` interface methods. We'll also create `CODEC` variable to encode and decode our effect; you can read more about [Codecs here](../codecs).


Suggested change

Next, we can create a constructor and override the `EnchantmentEntityEffect` interface methods. We'll also create `CODEC` variable to encode and decode our effect; you can read more about [Codecs here](../codecs).

Next, we can create a constructor and override the `EnchantmentEntityEffect` interface methods. We'll also create a `CODEC` variable to encode and decode our effect; you can read more about [Codecs here](../codecs).

its-miroma · 2024-08-08T00:13:59Z

develop/items/custom-enchantment-effects.md

+
+Next, we can create a constructor and override the `EnchantmentEntityEffect` interface methods. We'll also create `CODEC` variable to encode and decode our effect; you can read more about [Codecs here](../codecs).
+
+The bulk of our code will go into the `apply()` event, which is called when the criteria for your enchantment to work is met. We'll later configure this `Effect` to be called when an entity is hit, but for now let's write simple code to strike the target with lightning.


Suggested change

The bulk of our code will go into the `apply()` event, which is called when the criteria for your enchantment to work is met. We'll later configure this `Effect` to be called when an entity is hit, but for now let's write simple code to strike the target with lightning.

The bulk of our code will go into the `apply()` event, which is called when the criteria for your enchantment to work is met. We'll later configure this `Effect` to be called when an entity is hit, but for now, let's write simple code to strike the target with lightning.

its-miroma · 2024-08-08T00:14:16Z

develop/items/custom-enchantment-effects.md

+
+@[code transcludeWith=#entrypoint](@/reference/latest/src/main/java/com/example/docs/enchantment/effect/LightningEnchantmentEffect.java)
+
+Here the `amount` variable indicates a value scaled to the level of the enchantment. We can use this to modify how effective the enchantment is based on level. In the code above, we are using the level of the enchantment to determine how many lightning strikes are spawned.


Suggested change

Here the `amount` variable indicates a value scaled to the level of the enchantment. We can use this to modify how effective the enchantment is based on level. In the code above, we are using the level of the enchantment to determine how many lightning strikes are spawned.

Here, the `amount` variable indicates a value scaled to the level of the enchantment. We can use this to modify how effective the enchantment is based on level. In the code above, we are using the level of the enchantment to determine how many lightning strikes are spawned.

its-miroma · 2024-08-08T00:14:57Z

develop/items/custom-enchantment-effects.md

+
+## Registering the Enchantment Effect {#registering-the-enchantment-effect}
+
+Like every other component of your mod, we'll have to add this `EnchantmentEffect` to Minecraft's registry. To do so, add a class `ModEnchantmentEffects` (or whatever you want to name it) and a helper method to register the enchantment. Be sure to call the `registerModEnchantmentEffects()` in your main class which contains the `onInitialize()` method.


Suggested change

Like every other component of your mod, we'll have to add this `EnchantmentEffect` to Minecraft's registry. To do so, add a class `ModEnchantmentEffects` (or whatever you want to name it) and a helper method to register the enchantment. Be sure to call the `registerModEnchantmentEffects()` in your main class which contains the `onInitialize()` method.

Like every other component of your mod, we'll have to add this `EnchantmentEffect` to Minecraft's registry. To do so, add a class `ModEnchantmentEffects` (or whatever you want to name it) and a helper method to register the enchantment. Be sure to call the `registerModEnchantmentEffects()` in your main class, which contains the `onInitialize()` method.

its-miroma · 2024-08-08T00:17:48Z

develop/items/custom-enchantment-effects.md

+"enchantment.FabricDocsReference.thundering": "Thundering",
+```
+
+You should now have a working custom enchantment effect! You can test it by enchanting a weapon with the enchantment and hitting a mob, an example is given in the following video.


Suggested change

You should now have a working custom enchantment effect! You can test it by enchanting a weapon with the enchantment and hitting a mob, an example is given in the following video.

You should now have a working custom enchantment effect! Test it by enchanting a weapon with the enchantment and hitting a mob. An example is given in the following video:

its-miroma · 2024-08-08T00:26:33Z

develop/items/custom-enchantment-effects.md

+
+# Custom Enchantments {#custom-enchantments}
+
+Starting from version 1.21, custom enchantments in Minecraft use a "data-driven" approach. This makes it easier to add simple enchantments, like increasing attack damage, but more challenging to create complex ones. The process involves breaking down enchantments into _effect components_.


Starting from version 1.21

Does this have to be mentioned here? The plugin already highlights it.

in Minecraft

Again, the entire Fabric project revolves around Minecraft, no need to specify it in every page IMO.

its-miroma · 2024-08-08T00:36:50Z

develop/items/custom-enchantment-effects.md

+An effect component contains the code that defines the special effects of an enchantment. Minecraft supports various default effects, such as item damage, knockback, and experience. 
+
+However, this guide focuses on creating custom enchantment effects that aren't supported by default.
+
+**Before continuing, please check if the default Minecraft effects can work for your needs by visiting [the Minecraft Wiki's Enchantment Effect Components page](https://minecraft.wiki/w/Enchantment_definition#Effect_components)**. The rest of the guide assumes you understand how to configure "simple" data-driven enchantments.


Suggested change

An effect component contains the code that defines the special effects of an enchantment. Minecraft supports various default effects, such as item damage, knockback, and experience.

However, this guide focuses on creating custom enchantment effects that aren't supported by default.

**Before continuing, please check if the default Minecraft effects can work for your needs by visiting [the Minecraft Wiki's Enchantment Effect Components page](https://minecraft.wiki/w/Enchantment_definition#Effect_components)**. The rest of the guide assumes you understand how to configure "simple" data-driven enchantments.

An effect component contains the code that defines the special effects of an enchantment. Minecraft supports various default effects, such as item damage, knockback, and experience.

::: tip

Be sure to check if the default Minecraft effects satisfy your needs by visiting [the Minecraft Wiki's Enchantment Effect Components page](https://minecraft.wiki/w/Enchantment_definition#Effect_components). This guide assumes you understand how to configure "simple" data-driven enchantments and focuses on creating custom enchantment effects that aren't supported by default.

:::

its-miroma · 2024-08-08T00:44:03Z

develop/items/custom-enchantment-effects.md

+
+Starting from version 1.21, custom enchantments in Minecraft use a "data-driven" approach. This makes it easier to add simple enchantments, like increasing attack damage, but more challenging to create complex ones. The process involves breaking down enchantments into _effect components_.
+
+An effect component contains the code that defines the special effects of an enchantment. Minecraft supports various default effects, such as item damage, knockback, and experience. 


Suggested change

An effect component contains the code that defines the special effects of an enchantment. Minecraft supports various default effects, such as item damage, knockback, and experience.

An effect component contains the code that defines the special effects of an enchantment. Minecraft supports various default effects, such as item damage, knockback, and experience.

finished the guide for custom enchantment effects

2b062a2

krizh-p requested a review from a team as a code owner July 9, 2024 19:29

krizh-p changed the title ~~finished the guide for custom enchantment effects~~ Add a guide for Custom Enchantments Jul 9, 2024

Merge branch 'main' into customEnchantments

77ef839

IMB11 added new-content A new page or set of pages stage:cleanup This should be cleaned up labels Jul 9, 2024

addressed markdownlint issues

5c50c74

IMB11 requested changes Jul 9, 2024

View reviewed changes

krizh-p and others added 6 commits July 9, 2024 16:29

Update develop/items/custom-enchantment-effects.md

5ee87ca

Co-authored-by: Calum H. <[email protected]>

Update develop/items/custom-enchantment-effects.md

718d2d8

Co-authored-by: Calum H. <[email protected]>

Update develop/items/custom-enchantment-effects.md

ada2148

Co-authored-by: Calum H. <[email protected]>

small fixes

2c63d0d

Merge branch 'customEnchantments' of https://github.com/krizh-p/fabri…

6be0c87

…c-docs into customEnchantments

fixed everything mentioned in the review

fc94b8e

krizh-p requested a review from IMB11 July 9, 2024 21:10

changed the entrypoint for the enchantment effects

afb8c57

its-miroma requested changes Jul 11, 2024

View reviewed changes

its-miroma requested changes Jul 12, 2024

View reviewed changes

develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved

Apply suggestions from code review

cf940fa

applied suggested grammar fixes Co-authored-by: Miroma <[email protected]>

krizh-p commented Jul 12, 2024

View reviewed changes

krizh-p added 2 commits July 12, 2024 12:40

Merge branch 'main' into customEnchantments

069653c

Merge branch 'main' into customEnchantments

ac72015

krizh-p requested a review from its-miroma July 17, 2024 14:17

Merge branch 'main' into customEnchantments

4e9dc98

its-miroma requested changes Jul 18, 2024

View reviewed changes

IMB11 and others added 2 commits July 19, 2024 19:40

Apply suggestions from code review

390a8d9

Co-authored-by: Miroma <[email protected]>

resolve conflicts -- Merge branch 'main' into customEnchantments

fd47ad1

JR1811 reviewed Jul 20, 2024

View reviewed changes

krizh-p and others added 4 commits July 21, 2024 13:19

cropped thunder.webm and replaced println() with LOGGER

0416f8c

Merge branch 'main' into customEnchantments

e15d66c

grammar/wording fixes

6bd1c96

Merge branch 'customEnchantments' of https://github.com/krizh-p/fabri…

1cc3cb2

…c-docs into pr/krizh-p/134

IMB11 requested a review from its-miroma August 7, 2024 14:15

its-miroma requested changes Aug 8, 2024

View reviewed changes

its-miroma added stage:verification This should be verified and removed stage:cleanup This should be cleaned up labels Oct 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a guide for Custom Enchantments #134

Add a guide for Custom Enchantments #134

krizh-p commented Jul 9, 2024

netlify bot commented Jul 9, 2024 •

edited

Loading

IMB11 left a comment

krizh-p commented Jul 9, 2024

krizh-p left a comment

its-miroma left a comment

JR1811 left a comment

IMB11 commented Aug 6, 2024

its-miroma Aug 8, 2024

its-miroma Aug 8, 2024

its-miroma Aug 8, 2024

its-miroma Aug 8, 2024

its-miroma Aug 8, 2024

its-miroma Aug 8, 2024

its-miroma Aug 8, 2024

its-miroma Aug 8, 2024

its-miroma Aug 8, 2024


		## Custom Enchantment Effects {#custom-enchantment-effects}

		Start by creating an `enchantment` folder, and within it create a folder `effect`. Within the `effect` folder, we'll create the `LightningEnchantmentEffect` record.


		Start by creating an `enchantment` folder, and within it create a folder `effect`. Within the `effect` folder, we'll create the `LightningEnchantmentEffect` record.

		Next, we can create a constructor and override the `EnchantmentEntityEffect` interface methods. We'll also create `CODEC` variable to encode and decode our effect; you can read more about [Codecs here](../codecs).


		Next, we can create a constructor and override the `EnchantmentEntityEffect` interface methods. We'll also create `CODEC` variable to encode and decode our effect; you can read more about [Codecs here](../codecs).

		The bulk of our code will go into the `apply()` event, which is called when the criteria for your enchantment to work is met. We'll later configure this `Effect` to be called when an entity is hit, but for now let's write simple code to strike the target with lightning.


		@[code transcludeWith=#entrypoint](@/reference/latest/src/main/java/com/example/docs/enchantment/effect/LightningEnchantmentEffect.java)

		Here the `amount` variable indicates a value scaled to the level of the enchantment. We can use this to modify how effective the enchantment is based on level. In the code above, we are using the level of the enchantment to determine how many lightning strikes are spawned.

	Here the `amount` variable indicates a value scaled to the level of the enchantment. We can use this to modify how effective the enchantment is based on level. In the code above, we are using the level of the enchantment to determine how many lightning strikes are spawned.
	Here, the `amount` variable indicates a value scaled to the level of the enchantment. We can use this to modify how effective the enchantment is based on level. In the code above, we are using the level of the enchantment to determine how many lightning strikes are spawned.


		## Registering the Enchantment Effect {#registering-the-enchantment-effect}

		Like every other component of your mod, we'll have to add this `EnchantmentEffect` to Minecraft's registry. To do so, add a class `ModEnchantmentEffects` (or whatever you want to name it) and a helper method to register the enchantment. Be sure to call the `registerModEnchantmentEffects()` in your main class which contains the `onInitialize()` method.

	You should now have a working custom enchantment effect! You can test it by enchanting a weapon with the enchantment and hitting a mob, an example is given in the following video.
	You should now have a working custom enchantment effect! Test it by enchanting a weapon with the enchantment and hitting a mob. An example is given in the following video:


		# Custom Enchantments {#custom-enchantments}

		Starting from version 1.21, custom enchantments in Minecraft use a "data-driven" approach. This makes it easier to add simple enchantments, like increasing attack damage, but more challenging to create complex ones. The process involves breaking down enchantments into _effect components_.


		Starting from version 1.21, custom enchantments in Minecraft use a "data-driven" approach. This makes it easier to add simple enchantments, like increasing attack damage, but more challenging to create complex ones. The process involves breaking down enchantments into _effect components_.

		An effect component contains the code that defines the special effects of an enchantment. Minecraft supports various default effects, such as item damage, knockback, and experience.

Add a guide for Custom Enchantments #134

Are you sure you want to change the base?

Add a guide for Custom Enchantments #134

Conversation

krizh-p commented Jul 9, 2024

netlify bot commented Jul 9, 2024 • edited Loading

✅ Deploy Preview for nimble-elf-d9d491 ready!

IMB11 left a comment

Choose a reason for hiding this comment

krizh-p commented Jul 9, 2024

krizh-p left a comment

Choose a reason for hiding this comment

its-miroma left a comment

Choose a reason for hiding this comment

JR1811 left a comment

Choose a reason for hiding this comment

IMB11 commented Aug 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Jul 9, 2024 •

edited

Loading