From 6296dcd5544c4dd764276d8c377245155a6da7a8 Mon Sep 17 00:00:00 2001 From: Relationship <139162359+Relationship-OctoWoW@users.noreply.github.com> Date: Wed, 15 Jul 2026 16:46:37 +0100 Subject: [PATCH] Update README.md --- README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) diff --git a/README.md b/README.md index 0059f12..72e57b6 100644 --- a/README.md +++ b/README.md @@ -74,3 +74,93 @@ No extra windows or complicated configuration are required. * ✔ Lightweight with minimal impact on performance. Whether you're flipping valuable items, deciding what to vendor, or simply curious about an item's worth, **Relationships Auction Price** provides quick, reliable Auction House pricing directly where you need it—inside every item tooltip. + +# Chat Commands + +The addon provides the following slash commands: + +| Command | Description | +| --------------------- | ---------------------------------------------------------------------------------------- | +| `/rap scan` | Starts a full Auction House scan using the current filters. | +| `/rap fast` | Starts a faster scan with reduced delay between pages. | +| `/rap continue` | Continues the last interrupted scan from the saved checkpoint. | +| `/rap stop` | Stops the current scan. Partial results are preserved. | +| `/rap clear` | Clears all locally stored price data for the current realm and faction. | +| `/rap stats` | Displays statistics for local and shared price data. | +| `/rap show ` | Shows stored data for a specific item ID. | +| `/rap export` | Exports collected data into `RAP_SHARED_DATA_EXPORT` for creating a new `PriceData.lua`. | +| `/rap exportstring` | Exports data as a legacy string stored in `RelationshipsAuctionPriceDB.export`. | +| `/rap name ` | Applies a name filter to the next scan. | +| `/rap name clear` | Removes the name filter. | +| `/rap class ` | Applies a class filter using the Auction House class index. | +| `/rap class clear` | Removes the class filter. | +| `/rap continue clear` | Deletes the saved scan checkpoint so future scans start from page 1. | + +--- + +# See The Results + +After completing a scan: + +1. Run: + +```text +/reload +``` + +# Exporting Price Data + +After completing a scan: + +1. Run: + +```text +/rap export +``` + +2. **Reload your UI** to save the export: + +```text +/reload +``` + +> **⚠️ Important** +> +> You **must** use `/reload` after running `/rap export`. +> +> The export is only written to your SavedVariables file when the UI reloads (or you log out). Without reloading, no export data will be saved. + +3. Open: + +```text +WTF/Account//SavedVariables/RelationshipsAuctionPrice.lua +``` + +4. Copy the entire: + +```lua +RAP_SHARED_DATA_EXPORT = { + ... +} +``` + +5. Paste it into: + +```text +AddOns/RelationshipsAuctionPrice/PriceData.lua +``` + +6. Rename: + +```lua +RAP_SHARED_DATA_EXPORT +``` + +to + +```lua +RAP_SHARED_DATA +``` + +Your shared pricing database is now ready for distribution. +