Add Plank Sack Tracker

[Talkarcabbage]

This plugin displays a highly customizable overlay and tooltip for the plank sack, including for the new sailing planks. This was originally in the works for mahogany homes and such, but having it up and working around the time sailing comes out has become my main hope, with the sailing technical update having changed how some things were implemented to make it easier (and added the new planks).

It should support the new sailing planks out of the box (which do appear to be planned to be able to put in the sack, based on what I've seen).

Text and quantity color, arrangement style, and tooltip colors can be adjusted, along with a few tweaks.

Let me know if I need to make any adjustments or fixes, or if there's any suggestions!

A few example screenshots of the overlay:

And tooltip:

[runelite-github-app]

New plugin plank-sack-tracker: https://github.com/Talkarcabbage/planksacktracker/tree/50fa93e9d9617c5bfeb8b2c427f3198f16cc490c

[runelite-github-app]

Internal use only: Reviewer details Maintainer details

[riktenx]

This seems like a pretty good improvement over https://runelite.net/plugin-hub/show/plank-sack - would you be interested in attempting to contribute to that plugin (or perhaps taking it over if the original maintainer is unavailable)? Since that plugin is pretty popular (>100k) installs, if you enhanced it a ton of players would immediately benefit, especially with sailing coming up.

If you are not interested in doing that though we can still review this as-is.

[Talkarcabbage]

The existing plank sack plugin by Enriath has become broken because of the sailing update changing the way planks are stored, the way the contents are printed in chat, and the new planks being added.

On the contribution front, I don't think there will be much reusable code on the plank sack plugin on the plank count detection side after those internal changes. The overlay portion on my code here is also all its own thing, so I'm concerned that contributing to the existing plugin repository would basically mean replacing the original code completely, which doesn't really feel right, and it wouldn't feel reasonable to expect someone else to help maintain the new code they haven't written.

On the takeover front, I'm neutral either way but I don't want to step on anybody's toes on the matter, since the existing plugin is still somebody else's hard work and effort. I do understand the hope for reduced fragmentation and a working setup for the people that already have the existing plugin installed. It's worth noting that the existing plank sack plugin is part of a repository that hosts all of Enriath's other plugins.

I don't think there's been much activity from Enriath on the plank sack or other plugins over the past year, but I'm not really sure how to reach out to her on the matter.

I ultimately don't mind between leaving it as a separate plugin or otherwise, as long as everyone involved is okay with the result.

[Talkarcabbage]

In case it's useful to know for anyone doing reviews and such, sailing planks do appear to work as expected.

Let me know if you need anything from me or need me to do or decide on anything. Thanks!

[Enriath]

@Talkarcabbage honestly, if Sailing changed how the sack works that much, that sounds like a good reason to put the old plugin to rest. My plugin had to deal with so much less information on the contents of the sack, so a rebuild is a good idea, should be much more efficient and reliable than inventory deltas.

Assuming the RL crew are alright with it, feel free to take over the plank-sack plugin name from me; it looks like the only feature that you're missing that I had was the infobox.

[riktenx]

Assuming the maintainers are ok with it, I think actually claiming the manifest file and original name would be good because then all 100k+ users would get the fixed version without having to go redownload it.

[Talkarcabbage]

I'm okay with that. In that case would I update the PR to change the affected file to the existing plank-sack file instead, and replace the contents?

And, yeah @Enriath I also saw the nightmare of the inventory delta stuff you had to work with. I had mostly-working-testing code for dealing with the majority of cases right before the sailing tech update. It was a lot of work trying to figure out all the weird ui widget cases and race condition type stuff. The new sack content data is a breeze to read but makes all the old inventory tracking redundant.

I am okay with adding an infobox option too if it's a desired feature from the original.