Skip to content

Tool Property Page for the Wiki#3827

Merged
jurrejelle merged 65 commits intoGregTechCEu:1.20.1from
Phoenixvine32908:pv/material_docs_update
Aug 30, 2025
Merged

Tool Property Page for the Wiki#3827
jurrejelle merged 65 commits intoGregTechCEu:1.20.1from
Phoenixvine32908:pv/material_docs_update

Conversation

@Phoenixvine32908
Copy link
Copy Markdown
Contributor

What

Adds a ToolProperties page to the kubejs docs to explain how you can make tools from existing/custom gt materials.

Implementation Details

Probably needs some formatting look overs.

Outcome

Help kubejs devs understand how to make tools for materials/add new tools to existing materials.

Potential Compatibility Issues

Should be none as this helps make tool creation clearer.

Phoenixvine32908 and others added 30 commits August 23, 2025 10:21
Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
@Phoenixvine32908 Phoenixvine32908 requested a review from a team as a code owner August 28, 2025 23:54
@Phoenixvine32908 Phoenixvine32908 changed the title Pv/material docs update Tool Property Page for the Wiki Aug 29, 2025
@DilithiumThoride DilithiumThoride added Documentation Improvements or additions to documentation ignore changelog PR should not be added to the changelog. Release: Patch - 0.0.X Smaller changes that either are bug fixes or very minor tweaks. labels Aug 29, 2025
@@ -25,7 +25,17 @@ You can change the properties of the material by adding any combination of the f
- `.secondaryColor(int colorCode)` gives the material a secondary color. If this is not being called, the secondary value will default to white(0xffffff).
- `.flags(flag1, flag2, ...)` can be used to select certain properties of the material, like generating gears, or disabling decomposition.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We need a list of valid Flags

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Those flags are in the flags page, the whole mat creation page needs reworked but that's a separate pr, only removed the tool part in it right now.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Linked the page that shows examples.

@@ -25,7 +25,17 @@ You can change the properties of the material by adding any combination of the f
- `.secondaryColor(int colorCode)` gives the material a secondary color. If this is not being called, the secondary value will default to white(0xffffff).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What makes SecondaryColor different from Primary, where does that color get used?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

100% should be explained in the material creation page pr, will make a note.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added a placeholder explanation for now.

5. Durability is how much base durability it has.
- Here are some examples of base gt rotors
1. Titanium Rotor: .rotorStats(130, 115, 3.0, 1600)
2. Tungsten Rotor .rotorStats(130, 115, 3.0, 2560)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Tungsten feels like a poor choice because 3 of its 4 stats are the same as Titanium. How about HSS-S?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

HSS-S does sound good, but gonna fix that in the material creation page pr probably.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

nevermind, simple thing I can fix now

title: Tool Creation
---

You can make tools out of materials you create by calling toolStats inside your material's code.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Switch the writing tone in this file from 2nd person ("You can make...") to no-person ("Tools can be made...")

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Will do

- Takes a decimal number eg.(5.6).
2. attackDamage is the amount of damage per hit you deal to mobs/players.
- Also takes a decimal number.
3. durability is how long it takes of use to breaks.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"Durability is the number of times the tool can be used before it breaks"

  • Takes a positive whole number up to 2.147 billion (e.g 700)
  • This applies to both crafting use and in-world use
  • Crafting generally consumes 2 points of durability per use

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks, that does help clarify.

- `ignoreCraftingTools()`
- Disable crafting tools being made from this Material.
- `addEnchantmentForTools(enchantment, level)`
- Enchantment is the default enchantment applied on tool creation.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • Applies an Enchantment to every tool made from this material
    [Add an example to show the code for it]

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I can add that onto the example that shows unbreakable tools, if that works.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added to extra tool flags example.

Copy link
Copy Markdown
Contributor Author

@Phoenixvine32908 Phoenixvine32908 left a comment

Choose a reason for hiding this comment

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

Fixed up some stuff and asked for clarification

@@ -25,7 +25,17 @@ You can change the properties of the material by adding any combination of the f
- `.secondaryColor(int colorCode)` gives the material a secondary color. If this is not being called, the secondary value will default to white(0xffffff).
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added a placeholder explanation for now.

@@ -25,7 +25,17 @@ You can change the properties of the material by adding any combination of the f
- `.secondaryColor(int colorCode)` gives the material a secondary color. If this is not being called, the secondary value will default to white(0xffffff).
- `.flags(flag1, flag2, ...)` can be used to select certain properties of the material, like generating gears, or disabling decomposition.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Linked the page that shows examples.

- `ignoreCraftingTools()`
- Disable crafting tools being made from this Material.
- `addEnchantmentForTools(enchantment, level)`
- Enchantment is the default enchantment applied on tool creation.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added to extra tool flags example.

Copy link
Copy Markdown
Contributor Author

@Phoenixvine32908 Phoenixvine32908 left a comment

Choose a reason for hiding this comment

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

Updated to jurre's advice.

@jurrejelle jurrejelle merged commit 029fa24 into GregTechCEu:1.20.1 Aug 30, 2025
4 checks passed
LeoDreamer2004 pushed a commit to LeoDreamer2004/GregTech-Modern that referenced this pull request Dec 20, 2025
Co-authored-by: Jurre Groenendijk <jurre@jilles.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1.20.1 Documentation Improvements or additions to documentation ignore changelog PR should not be added to the changelog. Release: Patch - 0.0.X Smaller changes that either are bug fixes or very minor tweaks.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants