deph0 / discord-bot-starhunters

Starhelper: Shooting Stars Management System for F2P OSRS

Overview

Starhelper is a Discord bot that offers comprehensive CRUD features to improve the collaborative process of discovering, monitoring, and managing Shooting Stars in Old School RuneScape free-to-play worlds.

Discord Commands

Standard

/active Show list of active stars

/call Call a star. This puts it on /active

/update Update the tier of a star

/poof Mark a star as disappeared

Backups

/backups Show a list of backup stars. Worlds are hidden to everyone except the person who is holding the star and mods

/hold Save a star as backup

/release Release a backup star

Misc

/info See bot metadata

Example Usage

Multi-user calling, and updating and displaying

Holding stars (and its scoped visibility)

That's all you need to get started.

Auto-finding and auto-holding

If you want to go above and beyond, the app also supports automatically feeding the star data from a webhook.

1. Install the Star Info plugin and make sure this checkbox is ticked

2. Install the Chat Notifications plugin on RuneLite and set the highlight words to "Star Found:"

3. Download the Discord Notifier plugin on RuneLite and follow their instructions on creating and setting up the webhook. Name the webhook "Starcaller". It should appear in the channel's Integration menu when you add it, like this:

I recommend setting up the webhook in a private channel that not everyone has access to

4. Now, any time you get a chat notification like this:

The "Starcaller" webhook will trigger, and the bot will parse that data and save it as a Backup.

Contributing

Contributions are welcome. If you'd like to contribute to Starhelper, please submit a pull request. If there's a bug or feature you'd like implement, feel free to open an issue.

License

This project is licensed under the MIT License.