[v1.7.0+] Bugnibus Bugfix Pack

[Zizzo]

As you probably don't recall, the original raison d'être for ZOmnibus was that early beta versions of the game had what appeared to be a memory leak if you used too many addons. That doesn't seem to be a problem anymore, but we do still have the crashing bug with large numbers of addons installed, so I feel the effort is still justified. It occurs to me, though, that I've also accumulated quite a few "bugfix" addons, any or all of which a given player might want to have installed or enabled, and I'm wondering whether a similar "omnibus" addon for them might be merited.

Currently I have 20 addons that I'm categorizing internally as "bugfix"
addons:

• Golem Can Pass
• Of Trolls and Dead Maggots
• Sidekick Level Catch-up
• Keep Transmo Tab
• Explicit Default Cosmetics
• Particle Cleanup
• Command Multiple Staffs
• Negative Effect Timeout Cleanup
• Two-Handed Dual-Wielding Counts
• Staff of Bones Fix
• Strafe Fix
• Water Purification
• Chat/Quest Tweaks
• Virtual Image Reload
• Activatable Object Cleanup
• Inventory Show All Tabs By Default
• Don't Use the Unusable
• Buffs Display Wrap
• Addon Versions in Character Sheet
• UI Hardening

Of those:

• Chat/Quest Tweaks, Don't Use the Unusable and Addon Versions in Character Sheet could be considered matters of taste; possibly also Command Multiple Staffs.
• Two Handed Dual-Wielding Counts would probably be considered cheating by some.
• Ideally, I'd like this omnibus addon to be "retroactively" addable for bug fixing purposes, like Negative Effect Timeout Cleanup; I think I'd also want this addon to be more "dynamic", with new bugfix addons merged in as I create them (unlike ZOmnibus, where we only add new component addons at backward-incompatible game version releases). For that we'd need all our component addons to also be retroactively addable, and I don't think Sidekick Level Catch-up or Of Trolls and Dead Maggots qualify for that.
• Strafe Fix and Staff of Bones Fix require Embers and Cults, respectively, but I think they're implemented such that they could be included unchanged in a combined addon without requiring either of those DLC.

My questions, then, I guess, are:

• Is this even worth it?
• If I make it, which addons should I include in it?
• What would I call it? "ZOmnibug" would just be confusing, I think, and I'm not entirely sold on "Bugnibus".

[Shad3]

Having an omnibus for these would be very appreciated. For those that aren't strictly bugfix (the tweaks) it'd be good for them to be disabled by default, or maybe put it in separate collection?

As for the name... maybe "ZOmnibugfix" for clarity.

[Zizzo]

We Apologize for the Delay;™ on the strength of the above positive vote, I'll go ahead and release what I've got. The name "Bugnibus" did kind of grow on me eventually. The addons I ended up including are listed on the addon page.

[Zizzo]

Frequently Asked Questions:

Can I use Bugnibus if I'm already using any of the addons it contains?

It's fine to have both Bugnibus and its component addons installed, as long as you don't enable them for the same character. Existing characters should continue to work as before; for new characters, the character creation dialog will warn you if you try to create a character with both Bugnibus and any of its component addons enabled.

I have a bug that one of these addons is supposed to fix. Can I use Bugnibus to fix it?

For some of the addons in Bugnibus (notably Negative Effect Timeout Cleanup, Staff of Bones Fix and Virtual Image Reload), we have provided instructions to "retroactively" add them to an existing savefile to fix their respective bugs. Bugnibus can be added retroactively by a similar procedure, but it's slightly more complex because of the possibility of addon collision:

• First, find where your ToME savefiles live:
  • On Linux, this is the directory $HOME/.t-engine/4.0/tome/save/.
  • On Windows, this is the directory %userprofile%\T-Engine\4.0\tome\save. [h/t Moasseman]
  • On Mac, in the Finder, select "Go to" ⇒ Library ⇒ Application Support ⇒ T-engine ⇒ 4.0 ⇒ tome ⇒ save. [h/t Lakeere]
• In this directory, there should be a folder named for your character, and in that folder there should be a file named "desc.lua". Open that file with your favorite text editor.
• The file will have a line of the form "addons = { … }", listing the ID tags for all addons that are enabled for this character. First make sure this line does not already contain any of the following IDs for the component addons of Bugnibus:
  • "golem_pass" (Golem Can Pass)
  • "transmo_tab" (Keep Transmo Tab)
  • "bald_fix" (Explicit Default Cosmetics)
  • "particle_cleanup" (Particle Cleanup)
  • "neg_eff_fix" (Negative Effect Timeout Cleanup)
  • "bonestaff_fix" (Staff of Bones Fix)
  • "strafe_fix" (Strafe Fix)
  • "valley_water" (Water Purification)
  • "virtimg" (Virtual Image Reload)
  • "obj_act_cleanup" (Activatable Object Cleanup)
  • "inven_tab_def" (Inventory Show All Tabs By Default)
  • "buff_wrap" (Buffs Display Wrap)
  • "ui_hardening" (UI Hardening)
  If any of these IDs are present, we recommend trying to add the specific addon that addresses your problem instead of Bugnibus. If not, you can add the tag "bugnibus" to this line; the necessary syntax snould be clear.
• Save this change and re-run ToME. In the Load Game dialog, check that the "bugnibus" tag you just added is present and green in your character's addons list (if it's red, either you misspelled the tag or you haven't actually installed the addon).
• Load the game and test whether this fixes your bug. (If not, there may be another bug somewhere; this thread would be an excellent place to report that.)

[Zizzo]

And first upgrade to Bugnibus, release 1.0.1, with an improvement to Particle Cleanup

[Zizzo]

On a tangentially related note, is anyone using this addon via Steam? I just checked its
Steam page, and it says, "The item is either marked as hidden or you do not have permission to view it.". When I'm logged into Steam, it lets me upload new versions, but won't let me edit the addon description; it says, "There was a problem trying to save the title and description. Access was denied."