VoiceAttack-profiles/docs/SpanshAttack.md

SpanshAttack

This profile uses the ED-NeutronRouter plugin to plot neutron jumps using spansh. It fully does everything you need from within the game and VoiceAttack, you won’t have to visit the site at any point.

Requirements

In addition to VoiceAttack, you will need the following plugins to use this profile:

• bindED: required for EliteDangerous and SpanshAttack; makes anything involving hitting E:D key binds portable.
• EDDI installed as a VoiceAttack plugin: required for EliteDangerous and SpanshAttack, optional for RatAttack and SealAttack.
• ED-NeutronRouter: required for SpanshAttack.

EDDI speech responder

For the convenience of people that have not been using EDDI in the past, SpanshAttack will deactivate the speech responder automatically to not clutter them with unwanted TTS.

If you are already an EDDI user and want to keep the default speech responder functionality, you will have to run the enablespeechresponder plugin function of the EDDI plugin from your profile’s startup command after the SpanshAttack.startup command invocation.

In order to do that, choose “Other” → “Advanced” → “Execute an External Plugin Function”, choose the EDDI plugin and set the “Plugin Context” to “enablespeechresponder”.

Settings

Because Elite’s keyboard handling is … weird you’ll have to set the key to use for pasting text into Elite:Dangerous. If you are using a “standard” QWERT[YZ] layout, you don’t have to do anything; if you are using something different, you have to set it to the symbol that’s on the physical button that has v on QWERT[YZ]. E.g. for Neo2, set it to p.

For other settings, see the Configuration Variables section.

The last “setting” in the not-so-strict sense of the word is the SpanshAttack.getShipRange command. Any ship listed in there will automatically have its jump range used instead of VA prompting you for it. Since, again, VA will execute the first matching command found, you can create this command in your own profile when you are using SpanshAttack by including it.

The ED-NeutronRouter plugin is technically supposed to read the current jump range from EDDI; sadly a) it’s bugged right now, and b) EDDI is storing the maximum distance for your ship instead of the current / full on fuel one.

Including the Profile

When including the profile, be sure to

• Run the startup command. You will need to have a startup command in your profile (= one that is run on profile loading) and call SpanshAttack.startup from that one.
• Set configuration options. In the same startup command of yours, overwrite all configuration variables you want changed; after the SpanshAttack.startup call. See below.
• Make sure all EDDI events that SpanshAttack needs are correctly handled. For all events used in SpanshAttack that you already have handlers for in your profile, you’ll have to include a call to SpanshAttack.<event name>. E.g.
  for “EDDI Jumped”, call SpanshAttack.EDDI Jumped by name from your ((EDDI Jumped)) command.
• Initialise the bindED plugin correctly to read your Elite keybinds. Do that in your main profile’s startup command to only have it run once.
• (Optional) Have a SpanshAttack.getShipRange command in your profile to overwrite the default one with your ship’s ranges. See the default command for pointers.

Usage

Plotting a Route

1. Target the system you want to be routed to (target, do not plot to it).
2. Either exit the galaxy map or make sure you are on its first tab (or auto-plotting will break).
3. Trigger the SpanshAttack.plotRoute command either by voice (plot neutron [course;route;trip]) or calling it from another command
4. (if ship not listed in SpanshAttack.getShipRange) Enter your ship’s jump range when prompted.
5. Wait for the route to be calculated. The command will automatically open the galaxy map and jump to the first waypoint on your route.
6. Either target the first waypoint or plot to it.
7. Start jumping!

Neutron Jumping

With standard settings, just supercharge off a neutron cone. You should automatically be taken to the galaxy map with the next waypoint selected.

In case you have disabled auto-plotting to the next waypoint, manually invoke the SpanshAttack.targetNextNeutronWaypoint command by voice ([target;] next neutron [waypoint; way point] or calling it from another command.

Additionally, you can use the SpanshAttack.getNextNeutronWaypoint / [get;copy] next neutron [waypoint;way point] command to copy the next neutron waypoint to the clipboard.

Manual Re-Plot

Trigger the SpanshAttack.replotRoute command either by voice (replot neutron [course;route;trip]) or calling it from another command. This will start a re-plot of the current route with the same target system and jump range.

Refueling

Whenever you refuel off a scoopable star, the profile will automatically throttle back up to 100% speed. Unless you have disabled it in your configuration, you will also automatically target the next system on your route and jump to it once you leave fuel scoop range.

Clearing a Route

When you reach your target system, the neutron route will automatically be cleared. If you want to prematurely end your trip, call the SpanshAttack.clearRoute / clear neutron [course;route;trip] command.

Other Commands

Announcing Jumps Left

You can have VoiceAttack tell you the amount of jumps left on the current route by invoking SpanshAttack.announceJumpsLeft or saying how many [neutron;] jumps [are;] left?.

Note: Because it’s pretty much impossible to calculate a 100% accurate value for the total jumps left, it will just tell you the jump count from the current neutron waypoint.

Announce elapsed time on the trip

SpanshAttack keeps track of your start time, even if you have the option to time your trip turned off. This way you can get the time you’ve been jumping with the SpanshAttack.announceTripTime or how long have i been [jumping;on this trip;on this neutron trip]? commands.

Helper Functions

The profile contains a lot of helper functions that get called by the aforementioned commands. Have a look around, maybe learn something about VoiceAttack :)

Exposed Variables

The following Variables are global and thus readable (and writeable! Please don’t unless it’s a config variable …) from other profiles:

Configuration Variables

These are set in SpanshAttack.startup and can be overridden from your profile if you have included SpanshAttack.

• Elite.pasteKey (string): the key used for pasting into Elite. On QWERTY this is v. Default: v.
• SpanshAttack.timeTrip (boolean): whether to automatically tell you at the end of a trip how long it to you to get there. Default: false.
• SpanshAttack.announceWaypoints (boolean): whether to announce each waypoint of the neutron route. Default: true.
• SpanshAttack.announceJumpsLeft (string): ;-separated list of remaining jumps to announce when said amounts are reached. Right now only works if they are exactly reached when supercharging off a neutron. Note the extra ; at the beginning and end of the string. Default: ;1;3;5;10;15;20;30;50;75;100;
• SpanshAttack.autoJumpAfterScooping (boolean): whether to automatically jump after fuel scooping (and moving out of scoop range). Default: true.
• SpanshAttack.autoPlot (boolean): whether to automatically plot to the next waypoint on supercharging. Default: true.
• SpanshAttack.clearOnShutdown (boolean): whether or not to automatically clear an active neutron route on Elite client shutdown. Default: true.
• SpanshAttack.copyWaypointToClipboard (boolean): whether to copy the next waypoint into the Windows clipboard for use in other programs. Default: false.
• SpanshAttack.useEddiForVoice (boolean): whether to use EDDI over VA’s builtin say command. Default: false.

Other Variables

These variables can be used to get information about the current neutron route.
Please do not set them manually and / or from outside the SpanshAttack profile.

• SpanshAttack.targetSystem (string): the target system for the current neutron route
• SpanshAttack.nextNeutronWaypoint (string): the next waypoint on the current neutron route
• SpanshAttack.neutronJumpMode (boolean): neutron jump mode active/inactive
• SpanshAttack.jumpRange (decimal): the current ship’s jump range