Infinitay / essence-pouch-tracker

A RuneLite plugin that tracks both the amount of essence stored in your essence pouches and the amount of essence until decay.
https://runelite.net/plugin-hub/show/essence-pouch-tracking
BSD 2-Clause "Simplified" License
0 stars 1 forks source link

Notify first-time users how to initialize plugin #23

Closed Infinitay closed 3 weeks ago

Infinitay commented 1 month ago

It would be helpful to notify users on their first install/run of the plugin on how to proceed with using it properly. Basically, just telling them to check their pouches and to (attempt to) repair them in the chat.

Potential Implementation:

Infinitay commented 4 weeks ago

For now I included basic instructions in the README. Although, TBF after the pouch checking additions and support, I think it's obvious how to initialize/use the plugin. After all, the vanilla Essence Pouch plugin made by Adam doesn't give instructions either.

Currently considering

Infinitay commented 3 weeks ago

After #32 I'm considering the following changes:

  1. Add a chat message on first install to tell users to first check and repair their pouches
  2. Don't update the stored essence count until they check their pouch Completed as of #37
    • Show stored count as "?", don't update the count, leave unknownStored as false, re-update when checked
    • Show stored count as "?", update the count, leave unknownStored as false, re-update when checked