Create README.md

2026-07-10 12:33:32 +01:00
parent 0094949c91
commit 63873682e9
1 changed files with 140 additions and 0 deletions
@@ -0,0 +1,140 @@
+# Relationships PVP
+
+Relationships PVP is an all-in-one PvP companion addon for Vanilla OctoWoW.
+
+It combines battleground statistics, arena tracking, and quick queue management into one clean and easy-to-use window, allowing you to spend less time navigating Blizzard's PvP interface and more time fighting.
+
+---
+
+## Features
+
+### 📊 Detailed PvP Statistics
+
+Track your performance across every battleground and arena bracket.
+
+Statistics include:
+
+* Games Played
+* Wins & Losses
+* Win Percentage
+* Killing Blows
+* Honorable Kills
+* Deaths
+* Kill/Death Ratio
+* Honor Earned
+* Battleground Marks Earned
+
+Statistics are tracked separately for:
+
+* Alterac Valley
+* Warsong Gulch
+* Arathi Basin
+* 2v2 Arena
+* 3v3 Arena
+* 5v5 Arena
+* Arena Skirmishes
+
+A total summary is also displayed for all PvP activities combined.
+
+---
+
+### 🏆 Personal Records
+
+Relationships PVP keeps track of your personal achievements, including:
+
+* Highest Win Streak
+* Most Killing Blows in a Single Match
+* Total Honor Earned
+
+These records update automatically as you play.
+
+---
+
+### ⚔ Quick Queue System
+
+Queue for PvP without opening Blizzard's PvP windows.
+
+Queue directly for:
+
+* Alterac Valley
+* Warsong Gulch
+* Arathi Basin
+* Rated 2v2
+* Rated 3v3
+* Rated 5v5
+* Arena Skirmishes
+
+Additional queue tools include:
+
+* Queue All Battlegrounds
+* Queue as Group
+* Leave/Cancel All Queues
+* Live Queue Status Display
+
+---
+
+### 🖥 Clean Interface
+
+The addon provides a simple, movable interface with:
+
+* Battleground statistics panel
+* Queue status panel
+* One-click queue buttons
+* Refresh button
+* Toggleable minimap button
+
+Window and minimap icon positions are automatically remembered between sessions.
+
+---
+
+## Slash Commands
+
+| Command       | Description                               |
+| ------------- | ----------------------------------------- |
+| `/rpvp`       | Open or close the addon                   |
+| `/rpvp av`    | Queue Alterac Valley                      |
+| `/rpvp wsg`   | Queue Warsong Gulch                       |
+| `/rpvp ab`    | Queue Arathi Basin                        |
+| `/rpvp all`   | Queue all Battlegrounds                   |
+| `/rpvp 2v2`   | Queue Rated 2v2                           |
+| `/rpvp 3v3`   | Queue Rated 3v3                           |
+| `/rpvp 5v5`   | Queue Rated 5v5                           |
+| `/rpvp sk`    | Queue Arena Skirmish                      |
+| `/rpvp leave` | Leave all queues                          |
+| `/rpvp icon`  | Toggle the minimap icon                   |
+| `/rpvp reset` | Reset window and minimap button positions |
+| `/rpvp clear` | Clear all recorded PvP statistics         |
+
+---
+
+## Supported Servers
+
+Designed for:
+
+* Vanilla World of Warcraft (1.12)
+* TurtleWoW
+* OctoWoW
+* Other compatible Vanilla-based servers
+
+Arena support automatically adapts to supported server APIs where available.
+
+---
+
+## Saved Data
+
+Relationships PVP stores statistics per character, allowing each character to maintain their own PvP history and records.
+
+---
+
+## Why Use Relationships PVP?
+
+Whether you're farming battlegrounds, pushing arena ratings, or simply tracking your PvP progress, Relationships PVP provides a convenient way to:
+
+* Monitor your performance
+* Track long-term statistics
+* Queue for PvP quickly
+* View all your PvP information in one place
+
+No unnecessary clutter—just everything you need for Vanilla PvP.
+
+Enjoy the battles, and good luck on the battlefield!