Friend Finder
Custom World Map Player & Party Icons
Author: Oscar Navarrete
Version: 5.0 Prime

------------------------------------------------------------------------------
About
------------------------------------------------------------------------------
Friend Finder is an accessibility-focused addon for World of Warcraft. It
replaces the small default party-marker pin with high-contrast, customizable
icons on the world map, zone map, and minimap - making your own and your
group's positions easier to spot, especially for players with visual
impairments or low-vision needs.

The addon is non-invasive and Blizzard-compliant. It adds visual overlays
without modifying Blizzard's map logic, coordinate system, or minimap engine.
All map behavior remains 100% Blizzard-native.

Friend Finder is free to install and use under Blizzard's AddOn Development
Policy.

------------------------------------------------------------------------------
Features
------------------------------------------------------------------------------
- Customizable player and party/raid icons on the world map, zone map,
  and minimap.
- Multiple render modes (profile portraits, weapon icons, custom icons,
  faction crests, and class-colored dots).
- Optional borders, glows, and faction theming.
- Map Interaction & directional navigation: a customizable facing-arrow trail
  shows the way to your destination on both the minimap and the world map.
  Tune the path style (dots, arrows, or faction crests), arrow count, spacing,
  trail size, and color - configured independently for the minimap and world
  map, with a live, true-to-game preview as you adjust.
- Live preview in the settings panel as you adjust values.
- Profile system: create, switch, copy, and reset multiple icon presets.
- Per-zone overrides for size and visibility (where supported).
- Minimap and world map quick-access buttons.
- Slash command access: /wmpi (open settings), /wmpi help (commands list).

------------------------------------------------------------------------------
Limitations
------------------------------------------------------------------------------
Friend Finder customizes player and party/raid icons in open-world content (questing,
leveling, exploration).

Due to Blizzard API restrictions, party/raid icons cannot be modified inside:

  - Dungeons
  - Raids
  - Delves
  - Battlegrounds and Arenas
  - Some scenarios and instanced micro-zones

Your own icon may still appear in some of those areas, but group icons will
use the default Blizzard behavior.

------------------------------------------------------------------------------
Installation
------------------------------------------------------------------------------
1. Place the folder "Friend Finder" into:
     World of Warcraft/_retail_/Interface/AddOns/

2. Restart the game, or type /reload if you're already logged in.

3. Open the settings either via:
     - The Esc menu -> AddOns -> Friend Finder, or
     - The /wmpi slash command.

------------------------------------------------------------------------------
Configuration
------------------------------------------------------------------------------
The settings panel is grouped into sections:

  Modes
    Choose the icon style for your character and party (profile portraits,
    weapon icons, custom icons, or faction crests).

  Customizations
    Adjust borders, glow effects, and faction theming. Configure the Map
    Interaction facing-arrow trail (Mini Map Arrow and World Map Arrow) -
    path style, count, spacing, trail size, and color, each tuned separately
    per surface with a live preview.

  Support
    About panel (purpose, donation links, copyright).
    Contact panel (support channels, limitations, copy-friendly debug info).

A live preview shows your current settings as you change them. Sizes can be
adjusted with the Icon Size slider on each map type.

------------------------------------------------------------------------------
Profiles
------------------------------------------------------------------------------
Friend Finder supports multiple profiles per account. Use the profile menu in the
settings panel to:

  - Create a new profile.
  - Switch the active profile.
  - Reset the active profile to defaults.
  - Export or import a profile (planned).

Profiles persist across sessions via Blizzard's SavedVariables system.

------------------------------------------------------------------------------
Support
------------------------------------------------------------------------------
For bug reports, feature requests, or accessibility feedback, please use one
of the support channels listed in the in-game Support -> Contact panel. When
contacting support, copy and paste the debug-info block from that panel into
your message - it includes the addon version, WoW build, profile name, and
current size settings.

------------------------------------------------------------------------------
Donations
------------------------------------------------------------------------------
Friend Finder is and will remain free. If the addon helps you and you'd like to
support continued development, donation links are listed in the in-game
Support -> About panel. Donations are entirely optional.

------------------------------------------------------------------------------
License
------------------------------------------------------------------------------
All Rights Reserved. See LICENSE.txt for full terms.

This addon makes use of Blizzard Entertainment assets. World of Warcraft (R)
and Blizzard Entertainment (R) are trademarks or registered trademarks of
Blizzard Entertainment, Inc. This addon is not produced, endorsed, supported,
or affiliated with Blizzard Entertainment.

------------------------------------------------------------------------------
Credits
------------------------------------------------------------------------------
Author: Oscar Navarrete
App icon artwork: Pix (@HauntingHare) - https://vgen.co/hauntinghare
  Created on commission; all rights transferred to the author
  (Copyright (c) 2026 Oscar Navarrete). See LICENSE.txt, Section 4.
Game assets and APIs: Blizzard Entertainment
