116 lines
4.5 KiB
Markdown
116 lines
4.5 KiB
Markdown
---
|
|
name: runescape-wiki
|
|
description: >
|
|
Query the RuneScape Wiki (RS3 and OSRS) for item details, quest requirements,
|
|
skill training guides, and Grand Exchange prices. Use this skill whenever the
|
|
user asks anything about RuneScape, Old School RuneScape, OSRS, RS3, or mentions
|
|
game-specific concepts like quests, skills, items, monsters, the Grand Exchange,
|
|
ironman mode, HCIM, or any RuneScape game mechanics. Also trigger when the user
|
|
mentions specific in-game items, quest names, skill names, or boss names that are
|
|
clearly RuneScape-related. This skill provides a Go CLI tool (rsw) that pulls
|
|
live data from the wiki — always prefer it over answering from memory, since wiki
|
|
data is authoritative and up-to-date.
|
|
---
|
|
|
|
# RuneScape Wiki CLI Plugin
|
|
|
|
This skill provides `rsw`, a Go CLI that queries the RuneScape Wiki APIs to get
|
|
authoritative, up-to-date game data. It supports both **OSRS** and **RS3**.
|
|
|
|
## Setup (first use)
|
|
|
|
The CLI needs to be compiled once. On first use, run:
|
|
|
|
```bash
|
|
cd <skill-dir>/scripts/rsw && go build -o rsw . && chmod +x rsw
|
|
```
|
|
|
|
After that, the binary is at `<skill-dir>/scripts/rsw/rsw`.
|
|
|
|
If Go is not installed, tell the user they need Go 1.22+ (`go.dev/dl`).
|
|
|
|
## Commands
|
|
|
|
The first argument is always the game: `osrs` or `rs3`.
|
|
|
|
### rsw <game> search <query>
|
|
Full-text search across wiki pages. Returns ranked titles with snippets.
|
|
Use this to find the right page name before fetching details.
|
|
|
|
### rsw <game> page <title> [--section <name>]
|
|
Fetch a wiki page as cleaned markdown. Use `--section` to get just one section
|
|
(e.g., "Drops", "Strategy", "Requirements"). Use `--raw` for raw wikitext.
|
|
|
|
### rsw <game> item <name> [--ironman]
|
|
The workhorse for "where do I find X" questions. Returns:
|
|
- Item stats (examine, weight, alch values, quest association)
|
|
- Equipment bonuses (if applicable)
|
|
- GE price (buy/sell, volume) — or vendor/alch values with `--ironman`
|
|
- Drop sources (monster, quantity, rarity)
|
|
- Acquisition methods from the wiki page
|
|
|
|
### rsw <game> quest <name> [--ironman]
|
|
Quest details: skill requirements, quest prerequisites, items needed, enemies
|
|
to defeat, and rewards. With `--ironman`, adds notes about self-sufficient
|
|
item acquisition and HCIM combat safety.
|
|
|
|
### rsw <game> skill <name> [--level <range>] [--ironman]
|
|
Training guide for a skill. Use `--level 50-70` to filter to a specific range.
|
|
With `--ironman`, notes which methods work without GE access.
|
|
|
|
### rsw <game> price <name> [--ironman]
|
|
Real-time GE price: instant buy/sell, recent volume, trend data.
|
|
With `--ironman`, shows alch values and store prices instead.
|
|
|
|
## Global Flags
|
|
|
|
- `--ironman` / `-i` — Shifts output to self-sufficient play: hides GE prices,
|
|
shows vendor/alch values, emphasizes drop sources and shop locations.
|
|
- `--raw` — Output raw wikitext (for page command).
|
|
|
|
## How to Answer Questions
|
|
|
|
When a user asks a RuneScape question, think about which command(s) to combine:
|
|
|
|
**"Where can I find a dragon scimitar?"**
|
|
→ `rsw osrs item "dragon scimitar"` — shows drop sources and acquisition
|
|
→ If it's a quest reward, follow up with `rsw osrs quest "Monkey Madness I"`
|
|
|
|
**"What are the requirements for Desert Treasure?"**
|
|
→ `rsw osrs quest "Desert Treasure"`
|
|
|
|
**"How do I train Prayer from 43 to 70 as an ironman?"**
|
|
→ `rsw osrs skill prayer --level 43-70 --ironman`
|
|
→ May also want `rsw osrs item "dragon bones" --ironman` for acquisition info
|
|
|
|
**"What's the current price of an abyssal whip?"**
|
|
→ `rsw osrs price "abyssal whip"`
|
|
|
|
**"What's a good money maker at 80 combat?"**
|
|
→ `rsw osrs search "money making"` → then `rsw osrs page "Money making guide"`
|
|
|
|
### Inferring the game
|
|
|
|
Most players clearly play one game or the other. Look for context clues:
|
|
- OSRS-specific: quest names unique to OSRS
|
|
- RS3-specific: "invention", "archaeology", "divination", "EoC", "revolution"
|
|
- If ambiguous, ask which game they play
|
|
|
|
### Combining outputs
|
|
|
|
Don't just dump raw CLI output. Read it, synthesize an answer, and cite specifics.
|
|
If the user asks "how do I get a fire cape", run the search, pull the relevant
|
|
page sections, and give them a coherent strategy — not a wall of wikitext.
|
|
|
|
## API Details (reference)
|
|
|
|
The CLI hits two API surfaces:
|
|
|
|
1. **MediaWiki API** (`{game}.runescape.wiki/api.php`) — search, parse, query.
|
|
Includes `User-Agent: rsw-cli/1.0` per wiki guidelines.
|
|
|
|
2. **Real-time Prices API** (`prices.runescape.wiki/api/v1/{game}/`) — latest
|
|
prices, mapping (item ID→name), 5m averages, 1h averages.
|
|
|
|
Item mapping is cached locally at `~/.rsw/cache/mapping.json` (24h TTL).
|