Adding streaks plugin to track certain streak-based activities

[Pinibot]

A RuneLite plugin that tracks streak-based activities in Old School RuneScape, including:

• Pickpocketing
• Farming harvest
  • Herb patches
  • Hops patches
  • Giant seaweed
  • Allotments
  • Bushes
  • Cacti

Inspired by my time at vyres trying to get blood shards for my GIM, I was trying to find a plugin like this to make the grind less tedious and to give me more micro-goals.

The plugin records how many successful actions you perform in a row, and saves the best streaks for each target.

The overlay records what the current target and streak are, along with the best streak for this target, and the time remaining until the streak is considered over. The timer is required for activities that don't have a fail condition, such as picking berries from a bush.

When a new best streak is achieved, a popup overlay appears at the top of the screen with an explosion of confetti to celebrate. Congratulations!

The overlays can be toggled on or off in the plugin config

[runelite-github-app]

New plugin streaks: https://github.com/Pinibot/osrs-streaks/tree/ad8a0cd0d6552079a549704de3c93656a012febd

[runelite-github-app]

Internal use only: Reviewer details Maintainer details

[Pinibot]

Question for reviewers - would it be acceptable in a later release to allow this plugin to take and save screenshots in the same folder as the screenshot plugin? I don't think any of the other plugins I use store screenshots locally, so I assume it's off limits except for the official screenshot plugin?

[riktenx]

You're doing it completely flatly on config change, so I'm not going to block the review on this, but you really shouldn't get in the habit of conditionally adding overlays. At some point you are going to mess that logic up and an overlay is going to get added multiple times or left behind on shutdown etc. Just add/remove on startup/shutdown and return early in render()s based on your config.

re: your question: you can take screenshots but you really shouldn't be saving them in the same folder that the core plugin uses. If you end up doing that I'd just make your own folder under .runelite as many other plugins do.