/fam¶

Script-provided

Registered by familiarswild. Start it with /lua run familiarswild.

Syntax¶

/fam detect
/fam suggest [type]
/fam type [name|clear]
/fam nav [n]
/fam catch [count]
/fam go [n]
/fam hail
/fam set <key> <val>
/fam cfg | save | reload
/fam stop | status

Description¶

A resident automator for the Familiars Wild quest. It reads the active quest to work out which creature classification you need, navmesh-walks you to a known catch spot, and runs a catch loop that engages a creature without killing it and uses your quest cage on it.

Beta

This is an early automator. Expect to drive it a step at a time (detect → suggest/nav → catch) rather than fully hands-off.

Subcommands¶

Command	What
`detect`	Read the active quest and work out the required creature type.
`suggest [type]`	Print the quicklist catch spots for a type (defaults to the detected one; `>` marks spots in your current zone).
`type [name\\|clear]`	Show, force, or clear the required type — overrides `detect`.
`nav [n]`	Navmesh-walk to suggested spot `n` (default: the current-zone one).
`catch [count]`	Run the catch loop where you're standing: engage a creature and use a cage on it, up to `count` times.
`go [n]`	`nav` to spot `n`, then `catch`.
`hail`	Target the nearest configured quest NPC and hail it.
`set <key> <val>`	Change a config field (persists per character).
`cfg`	Show the configuration and its file path.
`save` / `reload`	Write / re-read this character's config.
`stop`	Stop the current nav/catch job.
`status`	Show state.

How it maps to the quest¶

The quest objective names a required creature classification (bear, bird, canine, …). /fam detect reads that off the active quest.
You travel to a zone that has that creature type — use /fam suggest for known spots. Travel between zones yourself.
/fam nav walks you to the spot; /fam catch engages a creature without killing it and uses your cage.

The catch ability¶

Capturing needs the creature engaged/hating you, but alive, so the catch loop casts a low-damage or taunt ability rather than your normal rotation, and turns auto-attack off for the duration. Which ability that is depends on your class, so set it once:

/fam set ability <name>

/fam detect prints a per-class hint for what to use.

Configuration¶

Per-character settings live at config/familiarswild/<character>/settings.lua. Change fields live with /fam set <key> <value> (auto-saves) or hand-edit the file and /fam reload. The catch-spot quicklists live in lua/lib/familiars_wild_data.lua — if /fam suggest has no spots for a type, that's where to add rows.

Prime the objective first

If /fam detect can't read the objective text, click the quest in your Journal (or show the Quest Helper) to prime it, then run /fam detect again.