Shout Runner

Shout Runner is a Dalamud plugin for Final Fantasy XIV that lets you build and run ordered macro sets of chat commands, teleports, world travels and regex chat-waits — with per-step delays, persistent progress and a quick-action button bar.

It is designed for repetitive jobs that span many worlds (gil sales, recruitment shouts, market crawls): set up one macro set, hit Run, and let the plugin walk every aetheryte / data center / world for you.

✨ Features

• Macro Sets: Each set is an ordered list of steps. Switch between any number of named sets in one click.
• Step Kinds:
  • Command — send any chat command.
  • Teleport — pick an attuned aetheryte from the dropdown.
  • World — Lifestream /li travel to a single world.
  • Wait — pause until a regex matches a chat line (with optional timeout).
  • Combine — chain several Wait rows with AND / OR semantics.
  • Variable — send a numbered variable as chat text. Variables can reference other variables with {N}.
  • Through Worlds — single step at position 0 that cycles through every world of a chosen physical region (Europe / Oceania / North America / Japan), running all following steps once per world. Persistent progress; configurable per-world selection (S button); skip-current button (>); reset (C button).
• Default Rotation Generator: Pick a region; the plugin auto-detects which capital aetherytes you have attuned (Gridania, Ul'dah, Kugane, Limsa) and assembles the rotation, skipping cities you cannot reach yet.
• Run Controls: Run / Pause / Stop. Live highlight of the active step, afterglow on the previous one, and progress text (step X/Y — running).
• Action Log: Tab Log records every action with timestamps. ✓ marks successful completions; rows without a check mark indicate aborted or in-flight actions. One-click Copy for sharing or post-mortem.
• Gil Tracking: Tab Gil lets you add regex patterns that capture "gil spent" lines from chat. The first capture group is parsed as the amount (commas / dots stripped). The total is shown bottom-left of every tab and can be reset.
• Button Bar: Optional floating button bar with one button per set; while a macro is running, every button collapses into a single red STOP button.
• Chat Sniffer: ? tab opens a window that captures every chat-bound message (system messages too) so you can craft Wait regexes against real text.
• Import / Export: Each macro set serialises to a gzip + Base64 share code (SR1:...) for clipboard transfer.

🚀 Usage

1. Type /sr in the in-game chat to open the editor.
2. Create a new set, click + Through Worlds (region picker appears), then add Teleport / Variable / Command rows below — or click Generate default rotation... to auto-build a Through Worlds rotation for your attuned cities.
3. Press Run. The macro will travel to each unvisited world in the region and run every step under it. Progress (x / y) is displayed next to the region picker and persists across sessions until you reset it.

Through Worlds Buttons

Button	Meaning
(x / y)	Visited / total worlds in the current selection
C	Clear visited progress (with confirmation)
S	Open world-selection popup (checkbox per world, per-DC All / None, global All / None / Default)
>	Abort the current Lifestream travel (/li stop) and try the next world. Disabled when no macro is running

Slash Commands

• /sr — open the editor.
• /sr stop — abort a running macro.
• /sr run <set name> — start a macro set by name.

📦 Installation

1. Open Dalamud Settings in-game (/xlsettings).
2. Go to the Experimental tab.
3. Add the following Custom Plugin Repository URL:

   https://raw.githubusercontent.com/NeoGriever/ShoutRunner/main/pluginmaster.json
   

4. Save, then search for Shout Runner in the Plugin Installer.

🔌 Optional dependency: Lifestream

World and Through Worlds steps require the Lifestream plugin to be installed and enabled. Without it, those steps fail with a clear error message.

🔧 Technical Info

• Dalamud API Level: 15
• Applicable Version: any

📄 License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).