Skip to content
KeydenKPublic

About

Dalamud plugin: point at anything on your FFXIV map and press one button to go there the quickest way (controller, mouse or keyboard).

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

82 Commits

Folders and files

Repository files navigation

Beeline icon

Beeline

A Dalamud plugin for FINAL FANTASY XIV: one button on the map (controller, mouse or keyboard)
takes you to any aetheryte, quest marker, NPC or spot, the quickest way.


Why?

Getting somewhere usually means opening the teleport list, finding the right aetheryte, taking the aethernet, mounting up and steering the rest of the way. On a controller, every one of those steps is a few more button presses.

With Beeline you open the map, point at where you want to go, and press one button. Beeline picks the quickest way and takes you there. It's made for controllers, and works just as well with a mouse or a keyboard key.

Features

  • One button, everything on the map:
    • On an aethernet shard: you go there the quickest way: straight there, walking to the nearest shard of that city and taking the aethernet, or teleporting and taking the aethernet from there.
    • On a main aetheryte: the game itself teleports you there (as it always does on a click), so Beeline stays out of the way.
    • Anywhere else, in any zone: Beeline compares going there directly, taking the aethernet, and teleporting to the aetheryte (or shard) closest to the spot, and picks the quickest. Then it:
      • summons a mount on the way when that's faster than staying on foot (your favourite mount or a roulette, while you keep moving),
      • flies if you have the zone's aether currents,
      • on foot, uses Sprint when it's ready (you then keep Jog until you change map, mount up or fight), otherwise keeps Peloton up if your job has it,
      • and moves you the rest of the way with vnavmesh.
    • No map flag is placed, so your own flag is never touched.
  • Made for questing. Quest markers are used at their exact position, height included (the map cursor alone is only precise to about 5 yalms):
    • Quest NPCs and objects: you walk right up to them, and they get targeted once you're close enough to talk to them or use them: just press confirm. (Can be turned off.)
    • Quest areas (the circles on the map): you're taken into the area. Areas that make the enemies appear when you step in work too.
    • Quest enemies: you stop at a safe distance (20 yalms by default) so you don't pull them by accident, unless they're far below your level and can't aggro you anyway. Enemies are never targeted.
    • Layered places (cities with several floors): the right floor is picked from the marker's height. For plain spots, the floor at your own height is preferred.
    • Works with active quests, new quests (the quest-giver icons), levequests, guildleves, Triple Triad and special NPCs.
    • Gathering: in a gathering area, you walk up to the nearest gathering point.
  • Also exact, not just quests: FATEs, party members, your flag, housing plots, temporary markers (treasure maps...) and the map's own icons (shops, guilds, inns, exits...).
  • Housing districts: their aethernet shards are used too, from a shard of the same district.
    • Quest journal: open the map from a quest in the journal and press the button right away: the quest's marker is found by its name.
  • Controller, mouse or keyboard, any button or combo:
    • Controller: Cross / A by default. Any button works, and you can add a second button to hold for a combo (for example L2 + Cross).
    • Mouse: Ctrl + left click by default. Left, right or middle click or a side button, with any mix of Ctrl, Shift and Alt.
    • Keyboard: any key you choose (with any mix of Ctrl, Shift and Alt), pressed while the mouse is over the map.
  • You stay in control. A trip stops as soon as you move your character, and in a few other cases (see When does a trip stop?).
  • Lightweight. With the map closed and no trip running it does next to nothing. See Performance.
  • Private. Nothing is sent anywhere, and its log lines never contain your character's name or world.

Requirements

Both are free plugins you can find in the plugin installer. The settings window shows whether they're found. Without Lifestream, Beeline still works inside your current zone (it just can't teleport).

Works great with Giddy Up

Giddy Up is a companion plugin by the same author: it mounts you up after a fight, gathering or a zone change, gets you off the mount when the enemy you target is within your attack range (landing included), and uses Sprint and Peloton when they help. With both installed, Beeline decides when to mount on its trips, Giddy Up handles the rest, and Giddy Up gets you off for a fight once a trip ends (or during it, if "Stop the trip when you target an enemy" is on). Each works fine alone.

To get it, add its repository the same way as Beeline's below, with this link:

https://raw.githubusercontent.com/KeydenK/GiddyUp/main/repo.json

then install Giddy Up from /xlplugins. Beeline's settings show "Giddy Up found" once it's there.

Installation

  1. In game, type /xlsettings and open the Experimental tab.
  2. Under Custom Plugin Repositories, paste this URL in an empty line and click the + button:
    https://raw.githubusercontent.com/KeydenK/Beeline/main/repo.json
    
  3. Click Save and Close.
  4. Type /xlplugins, search for Beeline and click Install.

It works right away with a controller (Cross / A) and a mouse (Ctrl + left click). No setup needed.

Usage

  1. Open the map.
  2. Put the cursor on where you want to go: an aetheryte, a shard, a quest marker, an NPC icon, a quest area or any spot. Any zone works, not just the one you're in.
  3. Press Cross / A on a controller, Ctrl + left click with a mouse, or your keyboard key.

That's it. You can close the map; the trip goes on. To stop it, just move your character.

Type /beeline to open the settings window.

Settings

The window has a short status line at the top (Lifestream and vnavmesh found, and the current trip with a Stop button), then four tabs. Hover the (?) markers for details.

Controls

Setting What it does Default
Controller Any button, or Off. Optionally a second button to hold for a combo (for example L2 + Cross) Cross / A
Mouse Left, right or middle click, back or forward side button, or Off, plus any mix of Ctrl, Shift and Alt. Dragging the map doesn't count Ctrl + left click
Keyboard Any key, or Off, plus any mix of Ctrl, Shift and Alt, pressed while the mouse is over the map. Pick one the game doesn't use, or both will happen Off

The tab warns you when a choice clashes with the map (Square / Circle close it, Triangle changes it, middle click is auto-run).

Travel

Setting What it does Default
Use aethernet shards to get closer Routes may go through the aethernet shard closest to the spot On
Paid teleports on your current map (shards stay free) Lets Beeline teleport (costs gil) to another aetheryte of the map you're already on when that's faster. Turn it off to save gil: on your current map it then only walks, rides, flies or takes the aethernet shards, which are free and always used On
Summon a mount when it's faster Summoned while you keep moving, whenever riding or flying gets you there sooner than staying on foot (worked out from your learned speeds). Off if you'd rather mount yourself On
Mount Mount Roulette, or any mount you've unlocked (searchable list) Mount Roulette
Fly when the zone allows it Flies when you have all the zone's aether currents On
Sprint or Peloton on foot Sprint when it's ready (Jog follows and lasts until you change map, mount up or fight), otherwise Peloton if your job has it. With Giddy Up, each one Giddy Up uses is left to it On
Stop the trip when you target an enemy Targeting something you can attack stops the trip so you can fight (with Giddy Up: once it's within your attack range). Being attacked never stops a trip Off
Show the time left in the server info bar "Beeline 0:24" at the top right during a trip, from your learned speeds Off

Questing

Setting What it does Default
Target the quest NPC or object when you arrive Only friendly NPCs and objects, only within talking range. Enemies are never targeted On
Safe distance from quest enemies Stop this far from enemies you have to fight 20 yalms
No safe distance from enemies far below your level Walk right up to enemies this many levels below you (they can't aggro you) On, 10 levels

Advanced

Setting What it does Default
Route timing What Beeline learned from your trips: how long your teleports and aethernet hops take (loading screens included), how long getting on a mount takes, how fast you go running, with Peloton, Sprint and Jog, riding and flying, how long Sprint lasts, and how much longer real paths are than a straight line. With a button to reset it Learned automatically
Write each button press and trip step to the Dalamud log For troubleshooting Off

Commands

Command What it does
/beeline Open the settings
/beeline stop Stop the current trip

When does a trip stop?

  • You arrive. (Next to the quest NPC or object, at the safe distance from quest enemies, or at the spot.)
  • You move your character with the left stick, the movement keys (W, A, S, D, Q, E and the arrow keys), or both mouse buttons held. Typing in chat or clicking in a plugin window doesn't count.
  • You press the button again on something else: the new trip replaces the old one (not while a teleport is under way: Lifestream is busy then).
  • You type /beeline stop, or click Stop in the settings window.
  • You change zone after arriving (a duty pops, you teleport yourself...), or you log out.
  • You target an enemy, if "Stop the trip when you target an enemy" is on (with Giddy Up: once it's within your attack range).
  • Something goes wrong, with a chat message: the teleport is refused (in combat, not enough gil...), there's no walkable ground near the spot, the teleport takes longer than 60 seconds, or vnavmesh isn't ready after 2 minutes.

Safeguards

So that Beeline never goes somewhere you didn't ask for:

  • The press that opened the map (from the quest journal, for example) doesn't count if it's still held when the map appears; it only counts once released. Any new press counts right away.
  • Holding the button only counts once.
  • With a controller, the press only counts when the map has the focus, not when another window (like the journal) is in front of it.
  • With a mouse or keyboard, the mouse must be over the map, and not over a plugin window.
  • If the cursor hasn't moved since the map opened, its position is still the old one (the game only updates it when the cursor moves). Instead of guessing, Beeline asks you to move the cursor a little. Quest markers named under the cursor work anyway.

FAQ

Which buttons should I avoid? The map already uses some of them. With a controller, Square / X and Circle / B close the map and Triangle / Y switches between the city and region maps. With a mouse, middle click is auto-run, a plain left click on an aetheryte opens the game's teleport window, and right click opens the map's menu. The defaults (Cross / A, and Ctrl + left click) avoid all of that. If you'd like another button the map uses, add a combo (a held controller button, or Ctrl / Shift / Alt) and the settings window warns you when a choice would clash.

Why Ctrl + left click? A plain left click is already used by the map (an aetheryte opens the game's teleport window) and by Lifestream (a click on a shard takes the aethernet). Lifestream deliberately ignores Ctrl clicks, so Ctrl + left click is free. Dragging the map with the button held never counts as a click.

Does it cost gil? Teleports cost the usual gil, like teleporting yourself. The aethernet is free.

Why don't I see "Cannot execute at this time." when taking off? While a trip takes off, vnavmesh presses Jump until you're in the air and the game refuses most of those presses; another plugin's action during the mount summon can also get "Unable to use. You are currently using another item.". Beeline hides just these two messages, only during a trip and only for a few seconds around the mount summon, the take-off and touch-downs. Everything else still shows.

It teleported even though I could have walked. Beeline estimates the time of each route and picks the shortest one. A teleport takes a while (the cast plus the loading screen), but if the aetheryte is much closer to the spot than you are, it still wins. The estimates come from your own trips: Beeline times your teleports and aethernet hops (a fast PC loads quicker) and measures how fast you actually get somewhere on foot, riding and flying, so its choices get better as you use it. You can see these numbers in Advanced → Route timing.

Why didn't it mount? It only mounts when riding or flying gets you there sooner than staying on foot (for a short distance, or when you're already jogging fast, walking wins), where mounts are allowed (not in most cities), and not in combat. The mount is summoned while you're already moving; once you're mounted in a zone where you can fly, Beeline takes off and flies the rest of the way.

I use another plugin that mounts me automatically. Will they fight? They can. Beeline mounts you itself and takes off right away; it doesn't slow down to suit other plugins. Other plugins' auto-mount, auto-dismount or cancel-mount-cast features can react to the take-off and knock you off your mount. If you're dismounted before taking off, turn those features off: Beeline mounts you itself. Beeline tells you in chat when it happens, and if a trip ever gets stuck, it mounts you again or goes on the ground instead of hanging.

Why didn't it fly? Flying needs all the aether currents of the zone, and the "Fly when the zone allows it" option. Otherwise you ride on the ground.

Why didn't it target the NPC? It only targets when the option is on, when the NPC or object is friendly, and when you're close enough to talk to it or use it. Some quest objects can't be targeted until a quest step is done.

Why did it stop so far from the enemies? That's the safe distance, so you don't pull them by accident (20 yalms by default, adjustable). Enemies 10 or more levels below you can't aggro you, so Beeline walks right up to them instead.

I got "move the map cursor a little". The game only updates the cursor position once you move it, so right after the map opens it's still the old one. Nudge the cursor and press again. Quest markers named under the cursor work without moving it.

I got "no attuned aetheryte in that zone". Beeline only uses aetherytes you've attuned to. Attune to one in that zone, or go there yourself once.

Does it work in my own zone without Lifestream? Yes. Without Lifestream, Beeline can still take you anywhere in the zone you're in. It just can't teleport or use the aethernet.

Can I use it with Questionable, AutoDuty or other plugins that move my character? Don't run both at the same time: they would fight over vnavmesh.

It stopped short / went to the wrong place. Turn on Advanced → Write each button press and trip step to the Dalamud log, try again, and include the [Beeline] lines from dalamud.log when you open an issue. Those lines contain map coordinates, zone numbers, quest and NPC names, never your character's name or world.

Is this allowed? Like every third-party tool, Dalamud plugins are against the game's terms of service, and Beeline moves your character for you (through vnavmesh). Use it at your own risk, and stay at your keyboard or controller while it runs.

Limitations

  • Spots without a marker are only as precise as the map cursor (about 5 yalms). Quest markers are exact.
  • Plain spots in layered places (streets with walkways or roofs above) go to the floor at your own height when there is one there, otherwise to the highest one. Quest markers always pick the right floor.
  • Airship landings aren't used for routes (the game data has no position for them).
  • Housing district shards are only used when you're already standing at a shard of that district.
  • Quest areas whose enemies are already there before you arrive count as roaming enemies: you stop at the safe distance.
  • Rebound movement keys: only the default keys (W, A, S, D, Q, E, arrows) and the left stick cancel a trip.
  • "Far below your level" is set to 10 levels by default; the game's exact rule for when enemies stop aggroing you may differ. You can change it.

Performance

Beeline is built to cost nothing when you're not using it:

  • Map closed and no trip running: nothing, apart from a tiny "is the map open?" look 10 times a second until you first open the map in a session (a safety net in case the game's map events stop arriving after a patch; it turns itself off as soon as they arrive).
  • Map open: one quick check per frame for your button or click.
  • During a trip: a check for your own movement every frame (so stopping is instant), and the trip steps 10 times a second, until you arrive.
  • At load: the aetheryte list is built once, in the background.

How it works (for the curious)

Aetheryte and shard positions come from the game's own map data, the same source Lifestream uses. Quest markers come from the game's marker list, which holds each marker's exact 3D position, its area radius, and the NPC, object or enemy it points at.

The route is picked by estimating how many seconds each one takes: the teleport and aethernet hops, then riding or flying (the mount is summoned on the way) or running the rest of the way. These times are learned from your own trips (how long your teleports and aethernet hops take, and how fast you really progress toward a spot, detours included), starting from sensible defaults. Teleports go through Lifestream: first the teleport, then, once you've arrived, the aethernet hop if the route needs one.

After arriving, Beeline asks vnavmesh for the walkable ground at the spot (at the marker's height when there is one) and sends you there, or right next to the quest NPC or object once it's loaded. Targeting only happens within the game's talking distance. "Enemy" means anything the game would let you attack.

Building

Requires the .NET 10 SDK and a local Dalamud install (or set DALAMUD_HOME).

dotnet build -c Release

License

MIT © KeydenK

Thanks to NightmareXIV for Lifestream and awgil for vnavmesh, and their APIs, which made this plugin possible.

About

Dalamud plugin: point at anything on your FFXIV map and press one button to go there the quickest way (controller, mouse or keyboard).

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages