Skip to content

Add Required Materials - #15145

Open
SchauweM wants to merge 4 commits into
runelite:masterfrom
SchauweM:add-required-materials
Open

Add Required Materials#15145
SchauweM wants to merge 4 commits into
runelite:masterfrom
SchauweM:add-required-materials

Conversation

@SchauweM

Copy link
Copy Markdown

Adds Required Materials, which tracks the materials and skill levels you still need for Sailing and Construction builds, and can regroup your bank around them.

Repository: https://github.com/SchauweM/runelite-required-materials

  • Clicking a build in-game starts tracking it. That works from the Sailing and Construction skill guides (both the old and new layouts), the Boat Customisation interface via Build or Check Materials, and the Furniture Creation menu.
  • The side panel lists what you're tracking in a collapsible section per skill, showing each material as have/need against your bank and inventory, plus the skill levels the build requires, coloured green once you meet them. Bank contents are remembered between sessions, so the counts are there before you next visit a bank.
  • A toggle button in the bank rebuilds the item grid so tracked materials come first, grouped per build with a have / need label and a tick or cross. It reuses the bank's own item slots rather than drawing an overlay, so withdrawing behaves normally, and toggling it off restores the bank exactly as it was.

Requirements are read from the OSRS Wiki rather than scraped from the game's interfaces. When you click a build, the plugin fetches that item's wiki page through RuneLite's injected OkHttpClient and parses its {{Recipe}} template for the materials and level requirements. Only the page name is sent, results are cached per page for the session, and no user or account data leaves the client. A handful of Construction activities have no {{Recipe}} on the wiki; for those it falls back to the material list the game already prints to chat, and the levels shown in the skill guide.

The plugin only reads game state and displays information. It does not automate anything, does not act on the player's behalf, and does not alter what the client sends to Jagex.

@runelite-github-app

runelite-github-app Bot commented Aug 18, 2026

Copy link
Copy Markdown

@runelite-github-app

runelite-github-app Bot commented Aug 18, 2026

Copy link
Copy Markdown

This plugin requires a review from a Plugin Hub maintainer. The reviewer will request any additional changes if needed.


Internal use only: Reviewer details Maintainer details

@SchauweM

This comment was marked as spam.

@riktenx riktenx added the manual review PR can't be merged by the reviewbot, requires review by a plugin hub maintainer label Aug 19, 2026
@SchauweM

This comment was marked as spam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

manual review PR can't be merged by the reviewbot, requires review by a plugin hub maintainer plugin added

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants