Overview

Enchantment Descriptions

Table of Contents

Enchantment Descriptions

Enchantment Descriptions is a light weight client-side mod which adds descriptions of enchantments to the tooltips of enchanted books. This mod currently has support for all vanilla enchantments, and modded ones will be added over time.

This project is sponsored by Nodecraft. Use code Darkhax for 30% off your first month of service!

Questions and Answers

Can I use this mod on a server?

Yes, this mod will work on a server. It is a client side mod, so it should not be installed on the server.

Can I use this in my modpack?

Yes, just give credit and link back to this page.

Isn't this already done in WAWLA?

Yes, the feature provided by this mod is directly from my other mod WAWLA. A few people had asked for that feature to be split off into its own mod, as they didn't want the rest of the features. If you install this mod along side WAWLA, WAWLA's version of the feature will deactivate.

Can I help with mod support?

Yes, go into the config and enable explore mode. This will allow your game to output a list of all missing descriptions to the log file. If you know what those descriptions do, or have contact with the mod author, ask them to provide descriptions using the description format.

What is the description format?

The description format is how this mod and others with similar features provide descriptions. It involves adding a localization key to the language file. The format is enchantment.MODNAME.ENCHNAME.desc where MODNAME and ENCHNAME are pulled from the String based ID. For example, minecraft:sharpness has a key of enchantment.minecraft.sharpness.desc.

Planned Features

Add JEI support

More info, such as what type of enchantment. (armor, helmet, weapon, tool, etc)

I maintain a lot of mods (64) so I use a build server to help automate the releases of my mods. Whenever there is a change to the GitHub repo the build server downloads the changes and creates new jar files and uploads them to CurseForge. I do this because I would frequently add bug fixes or features to mods and would forget to publish to CurseForge. The build is set to "alpha" by default because it is a bleeding edge build and I can't always guarantee it will be stable.

I’m playing the Enigmatica 2 modpack (mod list), and it does not have this mod, yet I still see descriptions for enchantments that look exactly like those added by this mod. Do you know what other mod adds enchantment descriptions for vanilla and modded enchantments?

The english file is here. Simply copy the file and change all the values to be what they are in your language. Then rename the file to be your language code. You can upload the file to GitHub and make a Pull Request, or upload it to a site like Pastebin or Hastebin and link it here, along with giving me permissions to include the translation with the mod.

Hi there, quick question. What keybind do I have to set in order for this to work? When I mouseover a book, it says, "Press NONE for enchantment descriptions." I've gone through all my keybinds, and none of them see to have anything to do with enchantment descriptions. Any help is appreciated. :)

I made issues on the Github pages for Open Blocks and Ore Excavation Integration. The only other mod in my pack that had missing enchantment descriptions was Bibliocraft. It looks like you made an issue there in 2017, which is still open.