Soulling

A tiny soul companion for World of Warcraft that lives off the way you play. Feed it grey junk, show it the world, fight together, and watch it molt, evolve and remember.

Works on Classic Era / Hardcore / Season of Discovery, WoW Forever and Retail.

What it does

• A companion with a life: hunger, joy, moods, faces, weather (rain, snow, umbrella), holiday costumes, tricks and whims.
• Grows with you: molts (new parts), evolutions, dyes and accessories, ascension at companion level 20.
• Soul Book (right-click the companion): overview, journal, achievements and titles, curio and postcard collection, odd records, people you meet, settings and a guide.
• Quietly useful helpers (all optional):
  • XP/hour, time and kills to level, gold/hour
  • low ammo, food, drinks and reagents at vendors; optional auto repair
  • quest log reminders (ready to hand in, full log, grey quests), group quest heads-up
  • new trainer spells after a level up, profession rank caps
  • missing class buffs, demon/pet reminders, dungeon checklist (repair, Healthstones, Soulstone, drinks)
  • upgrades waiting in your bags, containers to open, missing enchants and gems at max level (/soul gear)
  • corpse guide for ghosts, quest-starting items, full bags (drop the cheapest grey), hunter pet happiness, weapon skill
  • rare alerts, rested-XP and break reminders
• Fun facts about the zone you're in and famous quests you pick up (never repeated, account-wide).
• Social, never spammy: other Soulling users appear in People; Soul Clash, Soul Tag, gifts and Soul Parades. Nothing is posted to public chat unless you turn it on.

Getting started

Right-click the companion for the Soul Book, then open Guide. Type /soul for all commands.

Data

Everything is saved locally in SoullingDB (account) and SoullingCharDB (character). Addon messages to other Soulling users only carry your companion's look, level and game moves.

For addon authors

local info = Soulling.GetInfo()          -- name, level, stage, branch, mood, hunger, joy, title
Soulling.RegisterCallback("LEVEL", function(event, level) end)
-- events: LEVEL, EVOLVE, MOLT, RECORD, ACHIEVEMENT, RUN_END, PULL, BOSS_KILL, BOSS_WIPE, ANY
Soulling.Say("Hello from my addon!")     -- rate limited
Soulling.Anim("cheer")
Soulling.OpenBook("records")

WeakAuras custom triggers can listen to SOULLING_<EVENT> (for example SOULLING_LEVEL). A LibDataBroker data source named Soulling is created when LDB is present.