Skip to content

adrocic/slayer-helper

Repository files navigation

Slayer Helper Plugin

An efficient and user-friendly RuneLite plugin to assist you with your Slayer tasks in Old School RuneScape. The Slayer Helper provides quick access to essential information about Slayer monsters, including relevant wiki links, strategies, and more—all within your game client.

image

Features

Monster Search Functionality: Easily search for any Slayer monster by name using the intuitive search bar.
Quick Wiki Access: Get immediate access to detailed information from the OSRS Wiki for each monster.
Strategy Guides: View recommended strategies, weaknesses, and tips for defeating specific monsters.
In-Game Convenience: No need to alt-tab out of the game; all information is available directly in your RuneLite client.

Installation

To install the Slayer Helper plugin:

Open RuneLite: Launch your RuneLite client.
Access the Plugin Hub:
    Click on the Configuration icon
    in the sidebar.
    Scroll down and click on Plugin Hub at the bottom of the plugins list.
Find Slayer Helper:
    In the search bar, type "Slayer Helper".
    Locate the plugin in the results.
Install the Plugin:
    Click the Install button next to the Slayer Helper plugin.
Enable the Plugin:
    Ensure the plugin is enabled by checking the toggle switch.

Usage

Open the Slayer Helper Panel:
    Click on the Slayer Helper icon in the RuneLite sidebar.
Search for a Monster:
    Use the search bar at the top of the panel to type the name of the Slayer monster you're interested in.
    As you type, a list of matching monsters will appear.
View Monster Information:
    Click on a monster from the list to view detailed information.
    Information includes combat stats, weaknesses, Slayer level requirements, and more.
Access Wiki Links:
    Click on the Wiki link to open the monster's page on the OSRS Wiki for comprehensive details.

Screenshots

Monster Search Interface

image

Detailed Monster Information

image

Contributing

We welcome contributions from the community! To contribute:

Fork the Repository:
    Click the Fork button at the top of the repository page.
Create a New Branch:
    Use a descriptive name for your branch (e.g., feature/improved-search or bugfix/issue-42).
Make Your Changes:
    Implement your feature or fix the bug.
    Ensure your code follows the project's coding standards. Which don't really exist currently.
Submit a Pull Request:
    Open a pull request with a clear description of your changes.
    Reference any related issues in the description.

Issues and Feedback

If you encounter any issues or have suggestions for improvements:

Report Issues: Open an issue on the GitHub Issues page.
Provide Feedback: We'd love to hear your thoughts! Feel free to share feedback or feature requests.

License

This project is licensed under the MIT License. Acknowledgements

OSRS Wiki: Thanks to the Old School RuneScape Wiki for providing detailed information on monsters and Slayer tasks.
RuneLite Community: Appreciation to the RuneLite community for their continuous support and contributions.
Contributors: A big thank you to all contributors who have helped enhance this plugin.

About

Helps with slayer. Shows monster locations, stats, items to bring/wear etc.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages