Although this mod is a great piece of gameplay documentation, it suffers compatibility issues with many mods due to its way of displaying the tooltips.
This mod directly modifies the description and stores the original into _tt_original_description. However, not many mods are aware of the extra field and treat the manipulated field the same as they would do with pure descriptions. This leads to issues such as the weird display of item names in third-party mods.
In welly-integrated games like MineClone2, using this mod would not be a problem. However, think twice and check your mod collection before installing this mod into your pool of mods.
Yeah, it would be best if a game provides this mod on its own, unless it already rolls out its own tooltip system for some reason.
But just dropping this mod into a random mod collection is not guaranteed to work because the other mods might not expect such changes. That’s just the nature of modding. I explicitly warned in the description this mod is best suited to be included into game by the way. So I think your complaint about compatibility is a bit unfair. This mod was never meant to be able to be dropped in everywhere. That was never the promise.
Version 1.1.0 provides a few new helper functions to hopefully ease some compatibility pains, but it still requires collaboration of other mods. Again, this is by design.
Thank you for your explanation. Given that guaranteed compatibility is a no-goal, I think this review is better turned into a thread. I have submitted a request to the admins.
My take: if smooth interoperability is desired there must be exactly one description manipulation system in a world and that system must be supported by all description manipulating mods. tt is one such system that is already provided by some games like the mcl2 variants, hades, and voxelgarden, and therefore a good choice for mods to (optionally) support.
I have been experimenting with the (AFAICT unmaintained) toolranks mod and it actually is rather easy to add tt support in addition to its homegrown description manipulation (which subtly breaks the item's short description, which is why I was looking at it). It would probably be easy to also add other description manipulation systems (if they have the necessary features; for toolranks that is the ability to dynamically change the description of an itemstack).
The actual change (in addition to registering the snippet) to toolranks is basically this:
@@ -139,7 +167,11 @@ function toolranks.new_afteruse(itemstack, user, node, digparams) end
itemmeta:set_string("lastlevel", level)
- itemmeta:set_string("description", toolranks.create_description(itemdesc, dugnodes))+ if use_tt then+ itemstack = tt.update_itemstack_description(itemstack)+ else+ itemmeta:set_string("description", toolranks.create_description(itemdesc, dugnodes))+ end itemstack:add_wear(wear)
return itemstack
end
That doesn't seem too much of a maintenance burden, and something like that is necessary anyway in order to support mcl2 variants (although the tt in mcl2 is currently slightly different from upstream...I'm working on that, but don't hold your breath:-) (Also note that toolranks wouldn't work in mcl2 because of interaction with the effect mechanism.)
Although this mod is a great piece of gameplay documentation, it suffers compatibility issues with many mods due to its way of displaying the tooltips.
This mod directly modifies the description and stores the original into _tt_original_description. However, not many mods are aware of the extra field and treat the manipulated field the same as they would do with pure descriptions. This leads to issues such as the weird display of item names in third-party mods.
In welly-integrated games like MineClone2, using this mod would not be a problem. However, think twice and check your mod collection before installing this mod into your pool of mods.
Yeah, it would be best if a game provides this mod on its own, unless it already rolls out its own tooltip system for some reason.
But just dropping this mod into a random mod collection is not guaranteed to work because the other mods might not expect such changes. That’s just the nature of modding. I explicitly warned in the description this mod is best suited to be included into game by the way. So I think your complaint about compatibility is a bit unfair. This mod was never meant to be able to be dropped in everywhere. That was never the promise.
Version 1.1.0 provides a few new helper functions to hopefully ease some compatibility pains, but it still requires collaboration of other mods. Again, this is by design.
Thank you for your explanation. Given that guaranteed compatibility is a no-goal, I think this review is better turned into a thread. I have submitted a request to the admins.
converted review into a thread
My take: if smooth interoperability is desired there must be exactly one description manipulation system in a world and that system must be supported by all description manipulating mods. tt is one such system that is already provided by some games like the mcl2 variants, hades, and voxelgarden, and therefore a good choice for mods to (optionally) support.
I have been experimenting with the (AFAICT unmaintained) toolranks mod and it actually is rather easy to add tt support in addition to its homegrown description manipulation (which subtly breaks the item's short description, which is why I was looking at it). It would probably be easy to also add other description manipulation systems (if they have the necessary features; for toolranks that is the ability to dynamically change the description of an itemstack).
The actual change (in addition to registering the snippet) to toolranks is basically this:
That doesn't seem too much of a maintenance burden, and something like that is necessary anyway in order to support mcl2 variants (although the tt in mcl2 is currently slightly different from upstream...I'm working on that, but don't hold your breath:-) (Also note that toolranks wouldn't work in mcl2 because of interaction with the effect mechanism.)