Tutorials
Step-by-step guides to build your first plugin. Follow along with interactive code editors and learn by doing.
Build Your First Plugin
Learn to create a complete RuneLite plugin from scratch. This step-by-step tutorial will guide you through project setup, writing code, and testing your plugin.
Creating Custom Overlays
Learn how to draw custom UI boxes and text directly onto the game screen using RuneLite's Overlay system.
Working with Events
Master RuneLite's event system. Learn how to 'listen' to game actions like XP drops and game ticks using the example-plugin framework.
Adding Configuration to Your Plugin
Learn how to add user-configurable settings to your plugin. This covers editing ExampleConfig.java and using the @Provides method to enable the settings menu.
Using PanelComponent for Text Rendering
Learn how to use PanelComponent and LineComponent for clean, professional text overlays with proper styling and alignment.
Event-Driven NPC Tracking
Learn to track NPCs efficiently using NpcSpawned and NpcDespawned events instead of looping every frame.
Tracking Inventory Changes
Learn to detect exactly when items are added or removed from your inventory using ItemContainerChanged events.
Handling Mouse Input with MouseManager
Learn to properly handle mouse events in RuneLite plugins using MouseManager and MouseListener interface.
Creating Named Overlay Classes
Learn the best practice of creating named Overlay classes instead of anonymous inner classes for better code organization.
Using ClientThread for Game Thread Operations
Learn when and how to use ClientThread to ensure operations run on the game thread safely.
Advanced MenuManager Patterns
Learn advanced patterns for modifying menu entries using MenuManager's priority system and MenuEntrySwapper.
Proper Game State Handling
Learn to handle game state changes properly, including login detection and state management.
Calculating Health from Health Ratio
Learn to properly calculate actual health values from Actor.getHealthRatio() using the correct formula.
Tracking Ground Items with Events
Learn to efficiently track ground items using ItemSpawned and ItemDespawned events instead of iterating tiles.
Creating Accurate Potion Timers
Learn to create accurate potion timers using game ticks instead of System.currentTimeMillis().
Tracking Multiple Skills Separately
Learn to track level changes for each skill individually using a Map instead of a single variable.
Understanding Overlay Layers and Positions
Learn about OverlayLayer and OverlayPosition enums and when to use each option.
Converting World to Screen Coordinates
Learn to properly convert WorldPoint to screen coordinates using Perspective and LocalPoint.
Using RuneLite's Notification System
Learn to send notifications to users using NotificationManager for level ups, achievements, and alerts.
Price Drop Notifier
Build a plugin that tracks item prices and notifies you when prices drop below a configured threshold. Perfect for sniping deals on the Grand Exchange!
Skill Goal Tracker
Create a plugin that tracks your progress toward skill level goals and displays remaining XP needed.
Random Quote Generator
Build a fun plugin that displays random motivational quotes or funny messages. Great for keeping spirits high during long grinds!
Pet Name Generator
Create a fun plugin that generates random funny pet names. Perfect for naming your in-game pets or just for entertainment!
Colorful Chat Messages
Make your chat messages colorful and fun! Learn to use ChatMessageBuilder to create formatted, colored messages.
Combat Session Timer
Track how long you've been in combat and display statistics like kills, damage dealt, and session duration.
Resource Gathering Tracker
Track resources gathered (logs, ores, fish) and display gathering rates, items per hour, and total counts.
Achievement Unlocker Simulator
A fun plugin that simulates achievement unlocks with sound effects and notifications. Great for celebrating milestones!
Bank Organization Helper
Analyze your bank and suggest organization improvements. Shows item categories and suggests tab organization.
Random Event Helper
Transform the base Example Plugin into a random tip generator. This covers GameTicks, Notifiers, and properly formatted Chat messages.
XP Milestone Celebrator
Celebrate XP milestones (100K, 500K, 1M, etc.) with special notifications and chat messages. Makes grinding more rewarding!