How to Develop RuneLite Plugins: Complete Developer Guide

@PluginDescriptor(
    name = "My First Plugin",
    description = "A simple example plugin",
    tags = {"example", "tutorial"},
    enabledByDefault = false
)
public class MyFirstPlugin extends RuneLitePlugin {

    @Inject
    private Client client;

    @Inject
    private MyFirstPluginConfig config;

    @Subscribe
    public void onGameTick(GameTick event) {
        // This runs every game tick (600ms)
        if (config.showOverlay()) {
            // Update overlay logic here
        }
    }

    @Provides
    MyFirstPluginConfig provideConfig(ConfigManager configManager) {
        return configManager.getConfig(MyFirstPluginConfig.class);
    }
}

@ConfigGroup("myfirstplugin")
public interface MyFirstPluginConfig extends Config {
    @ConfigItem(
        keyName = "showOverlay",
        name = "Show Overlay",
        description = "Display the plugin overlay",
        position = 0
    )
    default boolean showOverlay() {
        return true;
    }

    @ConfigItem(
        keyName = "overlayColor",
        name = "Overlay Color",
        description = "Color for the overlay display",
        position = 1
    )
    default Color overlayColor() {
        return Color.YELLOW;
    }

    @ConfigItem(
        keyName = "refreshRate",
        name = "Refresh Rate",
        description = "How often to update the display (seconds)",
        position = 2
    )
    default int refreshRate() {
        return 1;
    }
}

public class MyOverlay extends OverlayPanel {
    private final MyFirstPlugin plugin;
    private final MyFirstPluginConfig config;
    private final Client client;

    @Inject
    private MyOverlay(MyFirstPlugin plugin, MyFirstPluginConfig config, Client client) {
        this.plugin = plugin;
        this.config = config;
        this.client = client;
    }

    @Override
    public Dimension render(Graphics2D graphics) {
        if (!config.showOverlay() || client.getGameState() != GameState.LOGGED_IN) {
            return null;
        }

        // Panel title
        panelComponent.setPreferredSize(new Dimension(200, 0));
        panelComponent.getChildren().add(TitleComponent.builder()
            .text("My Plugin")
            .color(config.overlayColor())
            .build());

        // Add content
        panelComponent.getChildren().add(LineComponent.builder()
            .left("Status:")
            .right("Active")
            .build());

        return super.render(graphics);
    }
}