Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Pinibot/osrs-streaks

Repository files navigation

Streaks Plugin

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
  • Hunting
    • Chinchompas (plus other box trap creatures)
    • Salamanders
    • Maniacial monkies
    • Imps
    • Kebbits (plus other deadfall creatures)
    • Birds

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

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


Features

Pickpocketing Streaks

  • Tracks consecutive successful pickpockets for each NPC.
  • Streak ends when:
    • You fail a pickpocket
    • You log out or hop
    • You are inactive for 30 seconds
  • Saves best streaks per NPC.

Farming Streaks

Supports:

  • Herb patches
  • Hops patches
  • Giant Seaweed
  • Allotments
  • Bushes
  • Cacti

Streak increases based on items gained during XP ticks for automatic harvesting actions like herbs and allotments. For bushes and cacti, the streak will be increased each time a harvest action is made.

Streak ends when:

  • The patch is depleted
  • You log out or hop
  • You are inactive for 30 seconds

Best streaks are saved per crop type.

Hunter Streaks

Supports:

  • Chinchompas (plus other box trap creatures)
  • Salamanders
  • Maniacial monkies
  • Imps
  • Kebbits (plus other deadfall creatures)
  • Birds

Streak increases when the creature is caught by the trap, not when the trap is collected.

Streak ends when:

  • The trap fails
  • You log out or hop
  • You are inactive for 30 seconds

Best Streak Screenshots

By default, when a new best streak is achieved the plugin will take a screenshot of the game area and save it in the folder .runelite/streaks/

This can be disabled in the configuration if desired.


Inactivity Timeout (30 seconds)

Every valid action resets a 30-second timer.
If no action occurs for 30 seconds, the streak ends automatically.


Overlays

Streak Tracker Overlay

521955072-00b18bcf-95d8-4986-8530-b66ffac38f3a

Shows:

  • Skill + target name
  • Current streak
  • Timer until streak expires

The width adjusts dynamically to avoid text wrapping.

Celebration Overlay

520521042-c44abb23-292b-41d0-baf3-440b3b9c4b7a

When a new personal best is achieved:

  • A “NEW BEST!” popup appears
  • A radial burst of confetti animates behind it
  • The popup fades away over ~5 seconds

Side Panel

521953767-d12295f6-dbd4-41c0-9017-3fd8117395df

The plugin panel includes:

  • Current activity + streak
  • Collapsible Thieving section
  • Collapsible Farming section
  • Per-entry delete buttons
  • Reset All button to clear all saved streaks

Panels update and resize dynamically.


Configuration Storage

All streak data is saved using RuneLite’s config system:

  • bestTheivingStreaks – best streaks per NPC
  • bestFarmingStreaks – best streaks per crop
  • bestHunterStreaks - best streaks per creature

The data persists across client restarts.


Contributing

Pull requests, feature ideas, and suggestions are welcome.
Open an issue to propose changes or report bugs.


License

BSD 2-Clause "Simplified" License

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

Generated from runelite/example-plugin