Skip to content
ShadowstarIOPublic

About

Conditional setups for Final Fantasy in settings, status, plugins, and more.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

Starflow icon: a gold star joined to two nodes like a constellation, on a night-blue tile

Starflow

Version 0.0.1.0 Dalamud API 15 .NET 10 License: MIT Status: pre-release

Read the stars, set your course. When the realm changes, your setup follows.
Conditional setups for FFXIV: settings, commands, status, Glamourer, Penumbra, plugin collections, and Lifestream.
Built on Dalamud.

Install · How a flow works · Use with care · Commands · Shared flows · Disclaimer · All Shadowstar plugins


Install

  1. In game, open /xlsettings → Experimental.
  2. Under Custom Plugin Repositories, add https://raw.githubusercontent.com/ShadowstarIO/XIV/main/repo.json, tick it, and save.
  3. Open /xlplugins, search for Starflow, and install.

Open it with /starflow or /flow. /fl is the short form.

How a flow works

A flow is four sections, read top to bottom. Cards are the nodes.

Section What it is
When Conditions. All or any. A card can be negated. Empty means the flow stays off.
Do What runs on the way in, in order. A command repeats up to 30 times. Wait is a delay.
Until Optional. Ends the flow while When is still true. It stays off until When goes false.
After What runs on the way out, every time.

Conditions: state, duty, place, zone, region, housing address, party size (with or without chocobo and pet), job, role, level, world, home or visiting, data center, schedule, clock range, weekday, weather, mount, nearby count or name, online status, target, plugin loaded.

Reactions: HP, MP, GP, or CP (yours, your target's, or the party's, as a number or percent), effects on you, your target, or the party, enemies targeting you, damage you just took (from a player or an NPC), party members down, and chat messages by channel, sender, and text.

Actions: commands and macros, chat notices, game settings, online status, search comment, plugin collections, one plugin on or off, Glamourer designs, Penumbra mods with their options, Penumbra collection, webhooks (Discord or any URL), Lifestream travel (home, FC, apartment, inn, a world, or an aetheryte), log out, close game. Commands, notices, comments, and webhooks fill tokens such as {zone} {job} {world} {weather}; Help lists all of them. Text conditions take words split on |, or a /regex/. Help lists every System and UI game option with what it does.

Revert runs after After and puts back what slotted cards replaced: game settings, online status, Glamourer, and Penumbra mods. An After card that writes the same thing wins. Keep leaves it, for the flow or one card. Higher priority wins a slot; the first owner's original is what comes back.

Collections use /xlenablecollection and /xldisablecollection. Dalamud may refuse to toggle a plugin that sits in more than one collection.

Nothing runs on the title screen. Logging out drops the queue; a half-sent macro does not resume. Quiet options hold flows in combat, cutscenes, duties, or zone lines; a flow can ignore them.

Use with care

Starflow is meant for reacting to what goes on around you, not for playing. Flows that react to HP, effects, enmity, damage, or chat hold off on actions and macros (/ac, /action, /macro and the like). Tokens fill a command's arguments, not the command word.

Chat cards let other people trigger your flows. Anyone who can post in the channels you pick can set off whatever that flow does: emotes, speech, looks, travel. Name the senders, keep the channels narrow, and prefer Prompt mode. How you use it is up to you.

The game settings list sticks to options a person would set. Game bookkeeping, such as session and login records, is left out.

Templates and imports

Templates and imports open off. Import AndThen and StatusShift rules from the Import button.

Flows shared by me and other players are in flows. Copy one, paste it into Import, and read it through before turning it on.

Commands

  • /starflow or /flow (short: /fl) — window
  • /fl Name — run Do once (one-shot; skips slotted cards unless the flow is on)
  • /fl stop Name — run After and revert
  • /fl why Name — print each condition
  • /fl dry Name — print the Do stack without sending it
  • /fl now — print which flows are on
  • /fl pause [seconds] / /fl resume
  • /fl prompts — flows and cards waiting for a yes
  • /fl config · /fl help (opens Help)

Disclaimer

Starflow is a configuration and convenience tool. It offers functional automation for settings, interactions, social tools, other plugins' controls, and cosmetics. It is not intended for combat, gaining an edge over other players, or anything that works against fair gameplay. Please play fair and respect the people around you.

Third-party tools are not supported by Square Enix, and using them is at your own risk. You are responsible for how you set up and use your flows, including any that respond to other players. Starflow is provided as is, without warranty of any kind; see LICENSE.

Starflow is not affiliated with or endorsed by Square Enix. FINAL FANTASY XIV is a registered trademark of Square Enix Holdings Co., Ltd.

About

Conditional setups for Final Fantasy in settings, status, plugins, and more.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages