Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a guide for Custom Enchantments #134

Merged
merged 30 commits into from
Dec 27, 2024
Merged

Conversation

krizh-p
Copy link
Contributor

@krizh-p krizh-p commented Jul 9, 2024

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

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

netlify bot commented Jul 9, 2024

Deploy Preview for nimble-elf-d9d491 ready!

Name Link
🔨 Latest commit e6d5f3d
🔍 Latest deploy log https://app.netlify.com/sites/nimble-elf-d9d491/deploys/676efa604770bb0008c60b96
😎 Deploy Preview https://deploy-preview-134--nimble-elf-d9d491.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@krizh-p krizh-p changed the title finished the guide for custom enchantment effects Add a guide for Custom Enchantments Jul 9, 2024
@IMB11 IMB11 added new-content A new page or set of pages stage:cleanup This should be cleaned up labels Jul 9, 2024
Copy link
Member

@IMB11 IMB11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
@krizh-p
Copy link
Contributor Author

krizh-p commented Jul 9, 2024

Just went through and fixed everything mentioned in the code review

@krizh-p krizh-p requested a review from IMB11 July 9, 2024 21:10
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
applied suggested grammar fixes

Co-authored-by: Miroma <[email protected]>
Copy link
Contributor Author

@krizh-p krizh-p left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

accepted fixes in grammar

@krizh-p krizh-p requested a review from its-miroma July 17, 2024 14:17
Copy link
Member

@its-miroma its-miroma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

@JR1811 JR1811 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@IMB11
Copy link
Member

IMB11 commented Aug 6, 2024

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

@IMB11 IMB11 requested a review from its-miroma August 7, 2024 14:15
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
develop/items/custom-enchantment-effects.md Outdated Show resolved Hide resolved
@its-miroma its-miroma added stage:verification This should be verified and removed stage:cleanup This should be cleaned up labels Oct 14, 2024
@IMB11 IMB11 added stage:verification This should be verified stage:cleanup This should be cleaned up and removed stage:verification This should be verified labels Dec 27, 2024
@its-miroma its-miroma added stage:ready This is ready to be merged stage:cleanup This should be cleaned up and removed stage:cleanup This should be cleaned up labels Dec 27, 2024
@its-miroma its-miroma removed the stage:cleanup This should be cleaned up label Dec 27, 2024
@IMB11 IMB11 merged commit ad06683 into FabricMC:main Dec 27, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-content A new page or set of pages stage:ready This is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants