commit 916a3fadbe271d0318a8c36bc462d7a259641a30 Author: alterNERDtive Date: Mon Sep 19 16:31:43 2022 +0000 Deployed 1027181 with MkDocs version: 1.3.1 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..aaca71b --- /dev/null +++ b/404.html @@ -0,0 +1,160 @@ + + + + + + + + alterNERDtive VA profiles + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • +
    • +
+
+
+
+
+ + +

404

+ +

Page not found

+ + +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + + +
+ + + + + + + + diff --git a/EliteAttack/index.html b/EliteAttack/index.html new file mode 100644 index 0000000..33ef70e --- /dev/null +++ b/EliteAttack/index.html @@ -0,0 +1,504 @@ + + + + + + + + EliteAttack - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

EliteAttack

+

This is my personal VoiceAttack profile for Elite: Dangerous. It started out +ages ago as a modification of MalicVR’s public +profile, +then looked less and less and less like that and I added and cleaned up a lot of +things while removing the stuff I didn’t use anyway. By now it would have +probably been simpler to start from scratch.

+

Funnily enough it has grown to rely way more on events provided by +EDDI than actual voice commands.

+

Chat Commands

+

These commands will only work with the comms panel active, and you should be in +the edit window ready to send. They will not hit Enter on their own.

+
    +
  • clear [chat;text]: Clears the chat window. Use from outside the comms panel.
    • +
  • [local;squad;system;wing] chat: Puts you into the chosen chat channel.
    • +
  • salute; oh seven: Will put “o7” into the chat.
    • +
+

Engineering/Materials

+
    +
  • how many [<g5 manufactured materials list>] do i have: Tells you how many of + the given g5 manufactured material you currently have on board. I’ve + restricted it to just those to not spam speech recognition with too many + phrases, and because those are the ones I usually want to know while jumping + around the bubble and having an eye on any HGE that might be around.
    • +
  • [launch;open] e d engineer: Opens the ED Engineer tool.
    • +
  • what [mats;materials] do i need?: Runs the EDDI responder that tells you + which materials are below wanted threshold. Needs setting those first. Gets + very spammy if you do it for all of them; personally I only set them for g5 + manufactured, so I can quickly check if it’s worth looking for HGE in a system + I’m in.
    • +
+ +

There are so many navigation-focused commands now, they deserve their own +category. Basically anything that helps you plot anywhere. A lot of those are +powered by awesome EDDI so I don’t have to do the work myself!

+
    +
  • distance [from;to] [Sol;home;the center;Beagle Point;Colonia]: Gives you the + current distance to the given POI.
    • +
  • [find;target] nearest [encoded;manufactured;raw] material trader: Targets + the nearest respective material trader.
    • +
  • [find;target] nearest [fuel;scoopable] star: Targets the nearest scoopable + star.
    • +
  • [find;target] nearest [guardian;human] tech broker: Targets the nearest + respective tech broker.
    • +
  • [find;target] nearest [interstellar factor;mission system;scoopable star]: + Well, you know the drill by now.
    • +
  • [find;target] nearest mission system: Targets the nearest system that has a + mission target.
    • +
  • how many jumps left: Announces the jumps left on a neutron trip (requires + SpanshAttack) or a course plotted via the galaxy map.
    • +
  • plot course;[target;] next [waypoint;way point]: Plots a course to the text + in your clipboard.
    • +
  • target [bug killer;colonia;dav’s hope;explorer’s anchorage;jackson's lighthouse;jameson’s cobra;robigo;shinrarta dezhra;sagittarius a*;shinrarta;sothis]: + Targets the given system on the galaxy map.
    • +
  • [where’s;where is] my landing pad: Will tell you the location of your + assigned landing pad on a starport.
    • +
+

Ship Controls

+

Basically anything that is related to directly doing something with your ship.

+
    +
  • [abort;cancel;stop] jumping: Stops a currently charging FSD jump.
    • +
  • [half;] power to [engines;shields;systems;weapons]: Sets pips to 6/3/3 + (half) or 8/2/2 towards the given capacitor.
    • +
  • [balanced;half;] power to [engines;shields;systems;weapons] [and engines;and shields;and systems;and weapons;]: + Sets pips to 6/6/0 (balanced), 5/5/2 (half) or 8/4/0 towards the given capacitors.
    • +
  • [close;deploy;extend;open;retract;] [cargo scoop;hard points; landing gear] [up;down;]: + Overly complicated command to handle everything related to Cargo Scoop, Hard + Points, Landing Gear. You get the gist, I guess. Works in SRV too.
    • +
  • [disco;discovery scan]: Executes a discovery scan. Expects the Discovery + Scanner in your first fire group, secondary fire. You can change + that.
    • +
  • [dis;]engage silent running: Turns silent running on and off.
    • +
  • [head;spot;] lights [on;off]: Turns your lights on and off. Works in SRV + too, kinda; turning lights off there relies on the state updating fast enough, + which sometimes leads to weird results.
    • +
  • [jump;engage;get me out] [and scan;] [when ready;]: Retracts everything that + might be protruding from your ship, then jumps to the next system. If the FSD + isn’t charging within 1s, it gets you into SC instead (e.g. if your target is + obstructed). If given “and scan” runs a discovery scan. If given “when ready” + waits for mass lock to clear, your FSD to cool down and you to leave scoop + range before jumping.
    • +
  • night vision [on;off]: Toggles your night vision on/off. Works in SRV too.
    • +
  • rapid fire lights: Flashes your lights 5 times in a row.
    • +
  • retract [all;everything]: Retracts, well, everything.
    • +
  • [start;stop] [firing;mining]: Starts/stops holding down primary fire. Mostly + useful when mining. When triggered with “mining”, also deploys the cargo + scoop.
    • +
  • [super;] cruise [when ready;]: Retracts everything, then jumps to SC. If + given “when ready” will wait for mass lock to clear and your FSD to cool down + first.
    • +
+

SRV Controls

+

Things relevant to your SRV, but not your ship.

+
    +
  • [recall;dismiss] ship: Recalls or dismisses ship. Currently does the same + thing regardless of the state of your ship. I wish it would be possible to + restrict it to doing one thing each, but that’s currently not possible sadly.
    • +
  • [toggle;enable;disable] drive assist: Handles all your drive assist needs!
    • +
+

Targeting

+

Well … targeting stuff, I guess. Not really sure why I made that its own +category, but oh well :)

+
    +
  • target the [drive;drives;power plant;frame shift drive;f s d;shield + generator]: Targets the given submodule on your current target, or your next + target if you don’t have one currently. Does not persist between targets.
    • +
  • clear sub [module;system] target: Clears the current submodule target.
    • +
  • target next system: Selects the next system on your route.
    • +
  • target wing man [1;2;3]: Targets your wingmen.
    • +
  • target’s target: Targets your target’s target (only works on wingmen).
    • +
  • wing man [1;2;3] target: Targets your wingmen’s target.
    • +
  • wing man nav lock: Toggles wing man nav lock on the selected wing member.
    • +
+

UI Commands

+

Everything handling stuff that’s not related to controlling your ship, but +manipulating some UI element(s).

+
    +
  • [enter;leave] F S S: Opens/closes FSS.
    • +
  • [main;game] menu: Opens the ESC menu.
    • +
  • [relog;reset] to [open;solo]: Relogs to Open or Solo mode, respectively.
    • +
  • controls options: Opens the controls options menu.
    • +
  • docking request;request dock[ing;]: Sends a docking request.
    • +
  • galaxy map: Opens the galaxy map.
    • +
  • restart from Desktop: Quits the game and restarts from an open launcher by + clicking the play button.
    • +
  • set [default;star;station;settlement;signal sources;anomaly;unknown;system] filter: + Sets a nav panel filter setting. See the command or just try different things + for what is possible. You need to clear filters and hover over the filter + button, then run this.
    • +
  • system map: Opens the system map.
    • +
  • take [high res;] screenshot: Takes a (high res) screenshot.
    • +
  • toggle orbit lines: Toggles the visibility of orbit lines.
    • +
+

Miscellaneous

+

The commands in here do random more or less useful things.

+
    +
  • [are there any;] outdated stations [in this system;]: Runs an on-demand + check for outdated stations in the current system.
    • +
  • [bodies;what’s;what is] left to [map;be mapped;scan]: Tells you which bodies + EDDI thinks are worth mapping in the system that you haven’t mapped yet.
    • +
  • copy current system: Copies the current system name into the clipboard.
    • +
  • open [current;] system on EDSM: Opens your current system on EDSM in your + default browser.
    • +
  • open copied system on EDSM: Opens the system in your clipboard on EDSM in + your default browser.
    • +
  • open coriolis: Opens Coriolis in your default browser.
    • +
  • open e d d b [station;system;faction;] [search;]: Opens EDDB in your default + browser.
    • +
  • open e d s m: Opens EDSM in your default browser.
    • +
  • open inara: Opens Inara in your default browser.
    • +
  • open materials finder: Opens EDTutorials’ materials finder in your default + browser.
    • +
  • open miner’s tool: Opens https://edtools.cc/miner in your default browser.
    • +
  • open spansh: Opens https://spansh.uk in your default browser.
    • +
+

Events

+

This is a list of ingame Events, provided by +EDDI, that the +profile will act on.

+

AFMU Repairs

+

Reports on the module that has been repaired, and if it has been fully or +partially repaired.

+

Body Mapped

+

Announces an estimate for high-value bodies’ payouts and the remaining mapping +candidates in the system as given by EDDI.

+

Body scanned

+

Announces any interesting body traits found when scanning:

+
    +
  • terraformable
    • +
  • Earth-like World, Ammonia World or Water World
    • +
  • landable and >5 g
    • +
  • semimajor axis <1.5 ls (only really interesting for planets, but there’s no + proper way to separate them from moons, sadly)
    • +
  • radius <300 km
    • +
+

Feel free to suggest more!

+

Carrier Cooldown

+

Tells you when your carrier is able to do its next jump.

+

Carrier Jump Engaged

+

This event fires when your carrier jumps but you are not docked at it. It +provides way less information than the Carrier Jumped event, but hey, I don’t +use most of it anyway. Basically just calls Carrier Jumped.

+

Carrier Jump Request

+

Announces the system and body your carrier has just been scheduled to jump to. +Use this to double check ingame information; I’ve had my carrier accept a body +as jump target, but then end up around the star. This might give you a heads +up on that.

+

Also starts a command queue to give you advance warnings on carrier lockdown at +-10, -5 and -2 minutes.

+

Carrier Jumped

+

Announces system and body your carrier has just jumped to.

+

Carrier Pads Locked

+

Announces your carrier’s lockdown procedures.

+

Discovery Scan

+

Announces the number of bodies (and non-body signals) found in the system. Also +compares the number of bodies to the amount reported by EDSM (requires Python +scripts).

+

Docked

+

Automatically refuels, repairs, rearms, then gets your ship into the hangar and +opens station services. Can be individually disabled.

+

Docking Denied

+

Tells you the reason for docking denial.

+

Entered Normal Space

+

Throttles to 0 upon dropping from SC, if the hyperspace dethrottle option is +enabled.

+

Fighter Launched

+

Orders your ship to hold position so it doesn’t chase after you immediately.

+

Jet Cone Boost

+

Sets your ship to full throttle immediately after you have supercharged.

+

Jumped

+
    +
  • Zeroes throttle if the hyperspace dethrottle option is enabled.
    • +
  • Gets the system’s body count from EDSM if that option is enabled.
    • +
  • Gets stations with outdated data (by default: older than 1 year) from Spansh’s + API. Again, if it is enabled.
    • +
  • Starts a discovery scan if that is enabled.
    • +
  • Last but not least tells you about planets worth scanning if you are on the + R2R.
    • +
+

Liftoff

+

Retracts landing gear for you. Seriously, is there any occasion in which you +don’t immediately want to retract it after takeoff?

+

Low Fuel

+

Warns you when you reach 25% fuel. Also reports number of jumps you have left or +the (rough) range you still have on the fumes left in your tank.

+

Material Threshold

+

Warns you when a monitored material falls below its minimum stock level and +tells you when you reach your desired level or fill up.

+

You will have to set minimum and desired amounts in EDDI’s material monitor +options first for all materials you wish to be monitored.

+

Next Jump

+

Gives you a jump count upon plotting a route using the galaxy map.

+

Ship FSD

+

This event actually is several different events in one. Currently the following +are handled:

+
    +
  • Charging: Warns you if you are jumping with less than 25% fuel.
    • +
  • Cooldown complete: Announces FSD cooldown if you are currently in normal + space.
    • +
+

Ship Interdicted

+

Tells you when you have been interdicted by a player. Is also supposed to target +the interdictor automatically, but randomly sometimes just doesn’t work. Yay!

+

SRV Launched

+

Toggles SRV lights off after launching. Might not work if you drop particularly +far after deployment because it works off a timer. Conversely might take a +second to turn your lights off on a short drop and/or in high gravity.

+

Synthesis

+

Reports on the synthesis type and quality.

+

System Scan Complete

+

Lists all bodies EDDI considers worth mapping in the current system.

+

Undocked

+

Retracts landing gear for you. Seriously, is there any occasion in which you +don’t immediately want to retract it after takeoff?

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/RatAttack/index.html b/RatAttack/index.html new file mode 100644 index 0000000..271de00 --- /dev/null +++ b/RatAttack/index.html @@ -0,0 +1,294 @@ + + + + + + + + RatAttack - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

RatAttack

+

This profile facilitates Fuel Ratting. It aims to +eliminate as much of the required manual task and attention switching as +possible via automation and voice commands.

+

If you don’t know what the Fuel Rats are, come hang out and ask :)

+

Going On/Off Duty

+

When you are on duty, RatAttack will automatically announce cases coming in +through IRC. When off duty, it won’t.

+
    +
  • [enable;disable] rat duty: puts you on/off duty.
    • +
  • open [fuel rats;] dispatch board: opens the web dispatch board.
    • +
+

Case Handling

+

If you have your IRC client setup +properly, VoiceAttack +will hold a list with all rat cases that have come in while you had it running. +It will save the case number, CMDR name, system, O₂ status and platform. There +are several commands you can run on this list, giving it a case number:

+

Getting Case Information

+
    +
  • rat case number [0..30] details: Will give you all stored info on a case.
    • +
  • [current;] rat case details: Will give you all stored info on the currently + open case.
    • +
  • distance to current rat case: Will give you the distance from your current + location to the currently opened rat case.
    • +
  • distance to rat case number [0..30]: Will give you the distance from your + current system to a case’s system.
    • +
  • latest rat case details: Will give you the case data for the latest incoming + case.
    • +
  • nearest commander to rat case number [0..30]: Will give you the nearest of + your CMDRs with their distance to a case’s system. Requires some + setup.
    • +
  • nearest commander to [the;] rat case: Will give you the nearest of your + CMDRs with their distance to the current case’s system. Requires some + setup.
    • +
+

Opening a Case

+
    +
  • open rat case number [0..30]: Opens rat case with the given number. If there + is no case data for that case (e.g. because you don’t have your IRC client set + up properly), it will still open it, just not have any data on it.
    • +
  • open [latest;] rat case: Opens the latest rat case that has come in through + IRC. Will only work if you actually have your IRC client setup to send case + announcements to + VoiceAttack.
    • +
+

Opening a case will automatically copy the client’s system to the clipboard for +easy route plotting. This can be disabled.

+

Making Calls

+

There are a bunch of calls you can make for a case, the most common are modelled +through VoiceAttack commands. The descriptive commands (e.g. “system confirmed”) +will be shortened to the usual IRC short hands (e.g. “sysconf”). If you need +something more unusual you can either still manually type it into your IRC +client or use the “General IRC Integration”, see below.

+
    +
  • call [1..20] jumps [and login;and takeoff;left;]: Calls jumps for the + currently open case. You can optionally include that you will still have to + login to the game or have to take off from your current + station/port/outpost/planet.
    • +
  • call jumps [left;]: Calls jumps for the currently open case based on a + neutron trip (requires SpanshAttack) or a plotted ingame route.
    • +
  • call friend [positive;negative] [in pg;in private group;in solo;in main menu;sysconf;system confirmed;]: + Friend request confirmations, with all the + things you might want to / should call with it.
    • +
  • call [beacon;fuel;instance;pos;position;prep;sys;system;wing] [positive;negative]: + All the stuff you usually need for ratting after you have received the friend request.
    • +
  • call wing pending: Calls “wr pending” for when it takes 30s again to + actually show up.
    • +
  • call client in [exclusion zone;main menu;open;open sysconf;pg;private group;solo;super cruise]: + Callouts for all the various things a client could get themselves into.
    • +
  • call [client destroyed;client offline;sysconf;system confirmed]: This is the + command you don’t want to use. Include sysconf in your “friend+” or “in open” + calls, and make sure you will never have to call “client destroyed”, would + you?
    • +
+

By default, VoiceAttack will ask for confirmation before sending calls to the +#fuelrats channel.

+

Closing a Case

+
    +
  • [close;clear] rat case: Closes the currently open rat case.
    • +
+

General IRC Interaction

+

Using EDDI to read the game’s journal, you can send messages to IRC from Elite’s +ingame chat.

+

Be aware that the chat message will still appear in the ingame chat channel +you send it to!

+

I recommend using local chat and limiting the use to instances that will +probably not have other players in it (e.g. instanced in normal space with the +client or in SC in some remote system out in the black on a long range rescue).

+
    +
  • #fuelrats: Use .fr <message> to have VoiceAttack send + #<caseNumber> <message> to #fuelrats – or yell at you when you + are not on a case.
    • +
  • #ratchat: Use .rc <message> to have VoiceAttack send <message> to + #ratchat.
    • +
+

Make sure that your IRC client is setup +properly.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/SpanshAttack/index.html b/SpanshAttack/index.html new file mode 100644 index 0000000..13a3f48 --- /dev/null +++ b/SpanshAttack/index.html @@ -0,0 +1,289 @@ + + + + + + + + SpanshAttack - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

SpanshAttack

+

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

+

Plotting a Route

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

Plotting to a System Unknown to the Neutron Router

+

The router can only plot a route to a system that is in its database (obviously +can also only give you waypoints that are). If your target system is not, there +are several levels of fallback handling to find a system that is.

+
    +
  1. Check Next system coordinates provided by EDDI. If the system is in EDSM, + but has for some reason not been sent over EDDN to other sites including + Spansh, we can get coordinates here.
    2. +
  2. If the system is not in EDSM check EDTS. It can calculate approximate + coordinates for a given procedurally generated system name.
    3. +
  3. If that fails prompt the user for input.
    4. +
  4. Query Spansh’ API for the closest system to these coordinates.
    5. +
  5. Plot a route to the closest system.
    6. +
+

Generally you should almost never be asked to input coordinates manually. If +EDTS provides coordinates with an accuracy that is worse than ±100 ly per axis, +you will be prompted to make sure you are going roughly to the right +coordinates. You will find the system that is used for plotting, its +coordinates and the accuracy in VoiceAttack’s log window.

+

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.copyNextNeutronWaypoint +/ [get;copy] next neutron [waypoint;way point] command to copy the next +neutron waypoint to the clipboard.

+

Skipping a Waypoint

+

Sometimes, especially in very neutron-sparse areas of the galaxy, the plotter +will give you weird jumps. E.g. I recently got neutron → 37 ly → neutron → 440 +ly.

+

In these cases you can use the SpanshAttack.skipNeutronWaypoint / skip +[this;current] neutron waypoint command to move on to the next one in the +list.

+

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 finish refueling 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.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/StreamAttack/index.html b/StreamAttack/index.html new file mode 100644 index 0000000..1ed0f36 --- /dev/null +++ b/StreamAttack/index.html @@ -0,0 +1,248 @@ + + + + + + + + StreamAttack - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

StreamAttack

+

This profile uses the EDDI plugin to write +a bunch of information about your commander, your current location and your ship +to files that can be accessed e.g. by your streaming software to be displayed on +stream.

+

Default folder is %appdata%\StreamAttack\.

+

Commands

+
    +
  • clear jump target: Clears the current jump target.
    • +
  • distance [to;from] jump target: Tells you the current distance to the jump + target.
    • +
  • +

    set jump target: Sets the jump target to the currently targeted system. + Distance will be written to the configured file.

    +
    • +
  • +

    [copy;open] ship build: Copies the current ship build (coriolis) or opens it + in your default browser.

    +
    • +
  • open StreamAttack folder: Opens the configured folder in Explorer.
    • +
+

Output Files

+

Elite

+

Please do note that information in the output files is only updated when a +journal event that contains the information is detected. E.g. the distance to +your jump target is not constantly calculated, but only updated after a jump.

+

Commander

+
    +
  • Elite\cmdr\name: The current commander’s name.
    • +
+

Jump Target

+
    +
  • Elite\jumpTarget\distance: Distance to current jump target in light years.
    • +
  • Elite\jumpTarget\full: Pretty-printed <distance> ly to <name>.
    • +
  • Elite\jumpTarget\name: The current jump target’s system name.
    • +
+

Location

+
    +
  • Elite\location\full: Depending on your status, either the station you are + currently docked at (+ system), the body you are currently near, or the system + you are currently in.
    • +
  • Elite\location\system: The system you are currently in.
    • +
+

Ship

+
    +
  • Elite\ship\build: Your current ship’s loadout (link to coriolis).
    • +
  • Elite\ship\full: “<name>” | <model> | <build>.
    • +
  • Elite\ship\model: Your current ship’s model.
    • +
  • Elite\ship\name: Your current ship’s name.
    • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/VoiceAttack/index.html b/VoiceAttack/index.html new file mode 100644 index 0000000..ec266c0 --- /dev/null +++ b/VoiceAttack/index.html @@ -0,0 +1,168 @@ + + + + + + + + VoiceAttack Tips - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ +
+
+
+
+ +

VoiceAttack Tips

+

This will fill up eventually with tips on how to properly setup VoiceAttack for +decent recognition.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + + +
+ + + + + + + + diff --git a/configuration/EliteAttack/index.html b/configuration/EliteAttack/index.html new file mode 100644 index 0000000..6f5cea3 --- /dev/null +++ b/configuration/EliteAttack/index.html @@ -0,0 +1,234 @@ + + + + + + + + EliteAttack - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

EliteAttack

+

Settings

+

Toggles:

+
    +
  • auto honk all systems: Automatically honk upon entering a system, each jump, + without constraints. Default: false.
    • +
  • auto honk new systems: Automatically honk upon entering a system if it is + your first visit. Default: true.
    • +
  • auto refuel: Automatically refuel after docking at a station. Default: + true.
    • +
  • auto repair: Automatically repair after docking at a station. Default: + true.
    • +
  • auto restock: Automatically restock after docking at a station. Default: + true.
    • +
  • auto move to hangar: Automatically move the ship to the hangar after docking + at a station. Default: true.
    • +
  • auto enter station services: Automatically enter the Station Services menu + after docking at a station. Default: true.
    • +
  • auto retract landing gear: Automatically retract landing gear when lifting + off a planet / undocking from a station. Default: true. (#133)
    • +
  • auto disable s r v lights: Automatically turn SRV lights off when deploying + one. Default: true. (#133)
    • +
  • edsm system status: Pull system data from EDSM and compare it + against your discovery scan. Default: true.
    • +
  • discovery scan on primary fire: Use primary fire for honking instead of + secondary. Default: false.
    • +
  • flight assist off: Permanent Flight Assist off mode. You should really do + that, it’s great. Default: false.
    • +
  • hyper space dethrottle: Throttle down after a jump and when dropping from + SC. Like the SC Assist module does. Default: true.
    • +
  • limpet check: Do a limpet check when undocking, reminding you if you forgot + to buy some. Default: true.
    • +
  • mapping candidates: Announce bodies worth mapping when you have finished + scanning a system. (Terraformables, Water Worlds, Earth-Like Worlds and + Ammonia Worlds that have not been mapped yet.) Default: true.
    • +
  • outdated stations: Announce stations with outdated data in the online + databases. Default: true.
    • +
  • include outdated settlements option: Include Odyssey settlements in the + outdated stations list. Default: true.
    • +
  • repair reports: Report on AFMU repairs. Default: true.
    • +
  • road to riches: Announce bodies worth scanning if you are looking for some + starting cash on the Road to Riches. Default: false.
    • +
  • route jump count: Give a jump count on plotting a route. Default: true.
    • +
  • synthesis reports: Report on synthesis. Default: true.
    • +
+

Other settings:

+
    +
  • outdated station threshold: The threshold for station data to count as + “outdated”, in days. Default: 365.
    • +
  • scanner fire group: The fire group your discovery scanner is assigned to. + Default: 0 (the first one).
    • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/configuration/RatAttack/index.html b/configuration/RatAttack/index.html new file mode 100644 index 0000000..19e723c --- /dev/null +++ b/configuration/RatAttack/index.html @@ -0,0 +1,277 @@ + + + + + + + + RatAttack - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

RatAttack

+

Getting Case Data From IRC

+

You can setup your IRC client to pass incoming RATSIGNALS to VoiceAttack by +calling the RatAttack-cli.exe helper tool with the RATSIGNAL as first argument +and an optional boolean as second argument that triggers a TTS case +announcement. You can find it under your VoiceAttack “Apps” folder, +\alterNERDtive\RatAttack-cli.exe.

+

Note: If you are running VoiceAttack as admin, you need to run your IRC +client as admin, too! Otherwise they cannot communicate. In general you want to +run both with normal privileges.

+

This has two purposes:

+
    +
  1. Announcing a new incoming case (if passing true as second argument).
    2. +
  2. Storing case data and making it available to VoiceAttack, e.g. for copying + the client’s system into the clipboard.
    3. +
+

For my AdiIRC, it looks like this (obviously change the path, please):

+
on *:TEXT:*RATSIGNAL*(??_SIGNAL):#fuelrats:{
+  if ( $away ) {
+    /run -h "X:\path\to\VoiceAttack\Apps\alterNERDtive\RatAttack-cli.exe" " $+ $replace($1-,","") $+ " false
+  }
+  else {
+    /run -h "X:\path\to\VoiceAttack\Apps\alterNERDtive\RatAttack-cli.exe" " $+ $replace($1-,","") $+ " true
+  }
+}
+
+

If I am away it will just add the new case to the list. If I am not away, it +will announce it using TTS.

+

The “replace” part handles the fact that announcements now put the system in +quotes. They have to be escaped as double quotes ("") to create a correct +command invocation.

+

You get the gist; if not and you don’t know how to do the same thing for your +IRC client, either switch to AdiIRC or bribe me to make an example for yours.

+

mIRC is a straight forward copy & paste job from Adi to mIRC (“Tools” → “Script +Editor” → “Remote”). Make sure you do not strip colour codes from incoming +messages!

+

Note for Hexchat users: Hexchat doesn’t seem to have a simple way of doing this. +If you figure it out, I’ll gladly add instructions here.

+

Keep in mind that if you are not on duty (see below) you will not get case +announcements.

+

Announcing Your Nearest CMDR

+

In case you have more than one CMDR registered as a Fuel Rat you can have +VoiceAttack announce the nearest one to a case and the distance. You will have +to go through a couple steps to set that up:

+
    +
  1. Have all CMDRs on EDSM.
    2. +
  2. Have all profiles on EDSM set to public including your flight log (which + includes the current location).
    3. +
  3. Set the CMDR names you want to use (“customize setting set fuel rat + commanders”).
    4. +
  4. Enable the nearest CMDR announcements (“customize setting enable nearest + commander to fuel rat case”).
    5. +
+

You can use this for a single CMDR, too. A less convoluted setup for announcing +the distance to your location in that case is on the list™ but does not have an +ETA yet.

+

Currently there is no way to specify a platform for each CMDR separately.

+

Sending Text to FuelRats IRC

+

The profile will attempt to send calls to “#fuelrats”, and you can send +messages from ingame chat to “#fuelrats” and “#ratchat”.

+

That will send text to windows with “#fuelrats” and “#ratchat” in +their title, respectively. If your IRC client does not do that, you will have to +change the “target” window of the RatAttack.sendToFuelrats and +RatAttack.sendToRatchat commands to reflect the actual window titles on your +system. I will look into making this more elegant to change in the future.

+

Settings

+

Toggles:

+
    +
  • auto close fuel rat case: Automatically close a rat case when sending + “fuel+” via voice command or ingame chat. Default: false.
    • +
  • auto copy rat case system : Automatically copy the client’s system to the + clipboard when you open a rat case. Default: true.
    • +
  • fuel rat call confirmation: Only make calls in #fuelrats after vocal + confirmation to prevent mistakes. Default: true.
    • +
  • fuel rat duty: On duty, receiving case announcements via TTS. Default: true.
    • +
  • nearest commander to fuel rat case: Announce the nearest commander to + incoming rat cases. Default: false.
    • +
  • platform for fuel rat case: Announce the platform for incoming rat cases. + Default: false.
    • +
  • system information for fuel rat case: System information provided by Mecha. + Default: true.
    • +
+

Other Settings:

+
    +
  • fuel rat commanders: All your CMDRs that are ready to take rat cases. Use + ‘;’ as separator, e.g. “Bud Spencer;Terrence Hill”. Default: "".
    • +
  • fuel rat platforms: The platform(s) you want to get case announcements for + (PC, Xbox, Playstation). Use ‘;’ as separator, e.g. “PC;Xbox”. Default: "PC".
    • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/configuration/SpanshAttack/index.html b/configuration/SpanshAttack/index.html new file mode 100644 index 0000000..b4658d5 --- /dev/null +++ b/configuration/SpanshAttack/index.html @@ -0,0 +1,224 @@ + + + + + + + + SpanshAttack - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

SpanshAttack

+

Supplying Your Ship’s Range

+

The ED-NeutronRouter plugin is technically supposed to read the current jump +range from EDDI; sadly EDDI is storing the maximum distance for your ship +instead of the current / full on fuel one. The “default to laden range” option +works reasonably well, but it has a few quirks. It always assumes full cargo, +and it will take your current fuel levels for range calculations, disregrading +the range loss if you fill your tank.

+

For any ships that you regularly use for neutron jumping, e.g. long range Fuel +Rat ships, I recommend telling SpanshAttack about the range they are supposed to +have with full fuel and your preferred amount of cargo/limpets.

+

In order to do that, copy the SpanshAttack.getShipRange command from +SpanshAttack or the example profile to your custom profile and add your ships. +Any ship listed in there will automatically have its jump range used instead of +EDDI’s reported laden range or VoiceAttack prompting you to manually supply it.

+

SpanshAttack-getshiprange.png

+

You can override a saved range for your ship by using the +plot neutron [course;route;trip] with custom range command.

+

Settings

+

Toggles:

+
    +
  • auto jump after scooping: Automatically jump out when fuel scooping is + complete. Default: true.
    • +
  • auto plot: Automatically plot to the next waypoint after supercharging. + Default: true.
    • +
  • clear neutron route on shutdown: Clear an active neutron route when the game + is shut down. Default: true.
    • +
  • copy neutron waypoints to clipboard: Copy each neutron waypoint into the + Windows clipboard. Default: false.
    • +
  • default to laden range: Default to the current ship’s laden range as + reported by EDDI instead of prompting for input. Default: false.
    • +
  • time neutron route: Keep track of how long a neutron route takes you to + complete. Default: false.
    • +
  • waypoint announcements: Announce each waypoint by name. Default: true.
    • +
+

Other Settings:

+
    +
  • announce jumps left: Estimated jumps left to announce when reached. NEEDS to + have leading and trailing “;”. Default: ";1;3;5;10;15;20;30;50;75;100;"
    • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/configuration/StreamAttack/index.html b/configuration/StreamAttack/index.html new file mode 100644 index 0000000..244f1c9 --- /dev/null +++ b/configuration/StreamAttack/index.html @@ -0,0 +1,188 @@ + + + + + + + + StreamAttack - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

StreamAttack

+

Settings

+
    +
  • StreamAttack output directory: The directory the status files are written + to. Default: "%appdata%\StreamAttack\"
    • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/configuration/general/index.html b/configuration/general/index.html new file mode 100644 index 0000000..73dae43 --- /dev/null +++ b/configuration/general/index.html @@ -0,0 +1,256 @@ + + + + + + + + General Configuration - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

General Configuration

+

Settings

+

All profiles will load sane defaults if you haven’t changed anything. The +configuration is stored in a bunch of VoiceAttack variables which in turn are +stored in your custom profile. You could even have different custom profiles +with their own distinct settings.

+

The easiest way to change settings is to say customize settings. That will +bring up a rudimentary settings UI.

+

You change also change the configuration directly via voice commands:

+
    +
  • For toggles (booleans): customize setting [enable;disable] <trigger phrase>
    • +
  • For everything else: customize setting set <trigger phrase>
    • +
+

You can find a list of trigger phrases on this page, or you can say +customize setting list [options;settings] for a list of voice triggers and +what they do. If you don’t remember your settings or just want a nice list, +customize setting report [options;settings] will print that to the +VoiceAttack log. If you want to reset everything back to default state, say +customize setting clear all my settings.

+

The “customize setting” prefix is kind of a leftover from times long gone and +does not quite fit anymore. Might change in a future version.

+

Since the settings are saved to your custom profile they will not necessarily be +preserved when you switch profiles. Once you switch back, the correct settings +for the profile are re-loaded.

+

General Settings for All Profiles

+

Toggles:

+
    +
  • auto update check: Automatically check Github for profiles updates when the + profile loads. Default: true.
    • +
  • eddi quiet mode: Make EDDI shut up. Disables all built-in speech responders. + Default: true.
    • +
+

Other settings:

+
    +
  • elite paste key: The key used to paste in conjunction with CTRL. The + physical key in your layout that would be 'V' on QWERTY. Default: 'v'.
    • +
  • log level: The level of detail for logging to the VoiceAttack log. Valid + levels are "ERROR", "WARN", "NOTICE", "INFO" and "DEBUG". Default: "NOTICE".
    • +
  • quit to desktop delay: The delay before restarting the game after hitting + “Exit to Desktop”, in seconds. Default: 10.0. (Used by the restart from desktop + command)
    • +
+

Note on Non-Standard Keyboard Layouts

+

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 not using a keyboard layout +that the game supports by default. You will have to change it to the key that +is physically in the place where V would be on QWERTY, e.g. P for +Neo2.

+

To set the key, say “customize setting set elite paste key”.

+

Adding Commands

+

If you want to edit a command or add your own, do not edit the profiles +directly. Instead create commands in your custom profile, and copy commands you +want to change over to that before editing them. This will make sure no changes +are lost if you update the profiles.

+

EDDI Events

+

Because of limitations of VoiceAttack itself, only the first matching command +found will be executed, including EDDI events. That means that if you create +commands to handle EDDI events, you are going to have to make sure that the +appropriate handlers in my profiles are called, too. That is done by invoking +the eddi.Event plugin context of the alterNERDtive-base plugin. Otherwise +stuff will break.

+

EDDI-event.png

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/css/fonts/Roboto-Slab-Bold.woff b/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/css/fonts/Roboto-Slab-Bold.woff2 b/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/css/fonts/Roboto-Slab-Regular.woff b/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/css/fonts/Roboto-Slab-Regular.woff2 b/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/css/fonts/fontawesome-webfont.eot b/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/css/fonts/fontawesome-webfont.eot differ diff --git a/css/fonts/fontawesome-webfont.svg b/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/css/fonts/fontawesome-webfont.ttf b/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/css/fonts/fontawesome-webfont.ttf differ diff --git a/css/fonts/fontawesome-webfont.woff b/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/css/fonts/fontawesome-webfont.woff differ diff --git a/css/fonts/fontawesome-webfont.woff2 b/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/css/fonts/fontawesome-webfont.woff2 differ diff --git a/css/fonts/lato-bold-italic.woff b/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/css/fonts/lato-bold-italic.woff differ diff --git a/css/fonts/lato-bold-italic.woff2 b/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/css/fonts/lato-bold-italic.woff2 differ diff --git a/css/fonts/lato-bold.woff b/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/css/fonts/lato-bold.woff differ diff --git a/css/fonts/lato-bold.woff2 b/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/css/fonts/lato-bold.woff2 differ diff --git a/css/fonts/lato-normal-italic.woff b/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/css/fonts/lato-normal-italic.woff differ diff --git a/css/fonts/lato-normal-italic.woff2 b/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/css/fonts/lato-normal-italic.woff2 differ diff --git a/css/fonts/lato-normal.woff b/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/css/fonts/lato-normal.woff differ diff --git a/css/fonts/lato-normal.woff2 b/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/css/fonts/lato-normal.woff2 differ diff --git a/css/theme.css b/css/theme.css new file mode 100644 index 0000000..7e03995 --- /dev/null +++ b/css/theme.css @@ -0,0 +1,13 @@ +/* + * This file is copied from the upstream ReadTheDocs Sphinx + * theme. To aid upgradability this file should *not* be edited. + * modifications we need should be included in theme_extra.css. + * + * https://github.com/readthedocs/sphinx_rtd_theme + */ + + /* sphinx_rtd_theme version 1.0.0 | MIT license */ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,.wy-nav-top a,.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.rst-content .wy-breadcrumbs li tt,.wy-breadcrumbs li .rst-content tt,.wy-breadcrumbs li code{padding:5px;border:none;background:none}.rst-content .wy-breadcrumbs li tt.literal,.wy-breadcrumbs li .rst-content tt.literal,.wy-breadcrumbs li code.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.field-list>dt:after,html.writer-html5 .rst-content dl.footnote>dt:after{content:":"}html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.footnote>dt>span.brackets{margin-right:.5rem}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{font-style:italic}html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.footnote>dd p,html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{font-size:inherit;line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} diff --git a/css/theme_extra.css b/css/theme_extra.css new file mode 100644 index 0000000..9f4b063 --- /dev/null +++ b/css/theme_extra.css @@ -0,0 +1,191 @@ +/* + * Wrap inline code samples otherwise they shoot of the side and + * can't be read at all. + * + * https://github.com/mkdocs/mkdocs/issues/313 + * https://github.com/mkdocs/mkdocs/issues/233 + * https://github.com/mkdocs/mkdocs/issues/834 + */ +.rst-content code { + white-space: pre-wrap; + word-wrap: break-word; + padding: 2px 5px; +} + +/** + * Make code blocks display as blocks and give them the appropriate + * font size and padding. + * + * https://github.com/mkdocs/mkdocs/issues/855 + * https://github.com/mkdocs/mkdocs/issues/834 + * https://github.com/mkdocs/mkdocs/issues/233 + */ +.rst-content pre code { + white-space: pre; + word-wrap: normal; + display: block; + padding: 12px; + font-size: 12px; +} + +/** + * Fix code colors + * + * https://github.com/mkdocs/mkdocs/issues/2027 + */ +.rst-content code { + color: #E74C3C; +} + +.rst-content pre code { + color: #000; + background: #f8f8f8; +} + +/* + * Fix link colors when the link text is inline code. + * + * https://github.com/mkdocs/mkdocs/issues/718 + */ +a code { + color: #2980B9; +} +a:hover code { + color: #3091d1; +} +a:visited code { + color: #9B59B6; +} + +/* + * The CSS classes from highlight.js seem to clash with the + * ReadTheDocs theme causing some code to be incorrectly made + * bold and italic. + * + * https://github.com/mkdocs/mkdocs/issues/411 + */ +pre .cs, pre .c { + font-weight: inherit; + font-style: inherit; +} + +/* + * Fix some issues with the theme and non-highlighted code + * samples. Without and highlighting styles attached the + * formatting is broken. + * + * https://github.com/mkdocs/mkdocs/issues/319 + */ +.rst-content .no-highlight { + display: block; + padding: 0.5em; + color: #333; +} + + +/* + * Additions specific to the search functionality provided by MkDocs + */ + +.search-results { + margin-top: 23px; +} + +.search-results article { + border-top: 1px solid #E1E4E5; + padding-top: 24px; +} + +.search-results article:first-child { + border-top: none; +} + +form .search-query { + width: 100%; + border-radius: 50px; + padding: 6px 12px; /* csslint allow: box-model */ + border-color: #D1D4D5; +} + +/* + * Improve inline code blocks within admonitions. + * + * https://github.com/mkdocs/mkdocs/issues/656 + */ + .rst-content .admonition code { + color: #404040; + border: 1px solid #c7c9cb; + border: 1px solid rgba(0, 0, 0, 0.2); + background: #f8fbfd; + background: rgba(255, 255, 255, 0.7); +} + +/* + * Account for wide tables which go off the side. + * Override borders to avoid weirdness on narrow tables. + * + * https://github.com/mkdocs/mkdocs/issues/834 + * https://github.com/mkdocs/mkdocs/pull/1034 + */ +.rst-content .section .docutils { + width: 100%; + overflow: auto; + display: block; + border: none; +} + +td, th { + border: 1px solid #e1e4e5 !important; /* csslint allow: important */ + border-collapse: collapse; +} + +/* + * Without the following amendments, the navigation in the theme will be + * slightly cut off. This is due to the fact that the .wy-nav-side has a + * padding-bottom of 2em, which must not necessarily align with the font-size of + * 90 % on the .rst-current-version container, combined with the padding of 12px + * above and below. These amendments fix this in two steps: First, make sure the + * .rst-current-version container has a fixed height of 40px, achieved using + * line-height, and then applying a padding-bottom of 40px to this container. In + * a second step, the items within that container are re-aligned using flexbox. + * + * https://github.com/mkdocs/mkdocs/issues/2012 + */ + .wy-nav-side { + padding-bottom: 40px; +} + +/* + * The second step of above amendment: Here we make sure the items are aligned + * correctly within the .rst-current-version container. Using flexbox, we + * achieve it in such a way that it will look like the following: + * + * [No repo_name] + * Next >> // On the first page + * << Previous Next >> // On all subsequent pages + * + * [With repo_name] + * Next >> // On the first page + * << Previous Next >> // On all subsequent pages + * + * https://github.com/mkdocs/mkdocs/issues/2012 + */ +.rst-versions .rst-current-version { + padding: 0 12px; + display: flex; + font-size: initial; + justify-content: space-between; + align-items: center; + line-height: 40px; +} + +/* + * Please note that this amendment also involves removing certain inline-styles + * from the file ./mkdocs/themes/readthedocs/versions.html. + * + * https://github.com/mkdocs/mkdocs/issues/2012 + */ +.rst-current-version span { + flex: 1; + text-align: center; +} diff --git a/general/index.html b/general/index.html new file mode 100644 index 0000000..19a882b --- /dev/null +++ b/general/index.html @@ -0,0 +1,227 @@ + + + + + + + + General Commands - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

General Commands

+

Configuration

+

The base profile provides voice commands for changing the profiles’ settings. +See the configuration section.

+

Chat

+
    +
  • paste text: Pastes the contents of your current clipboard. Note that this + command is supposed to be used for pasting into Elite and hence uses the + configured paste key. If you’re using a non-standard layout that means that + you cannot use this command to paste text into other applications.
    • +
+

Updating

+
    +
  • check for profiles update: Checks Github for a new version, and alerts you + if there is one.
    • +
  • download profiles update: Opens the latest release on Github and the + VoiceAttack import folder where you can drop it.
    • +
  • open profiles [docs;documentation;help] [file;site;]: Opens this + documentation, either on the web or the PDF file supplied with the installed + release.
    • +
  • open profiles change log: Opens the CHANGELOG on Github.
    • +
  • open voiceattack [apps;import;sounds] [folder;directory]: Opens the + respective VoiceAttack-related folder.
    • +
+

Miscellaneous

+
    +
  • generate missing key binds report: Generates a report of missing key binds + and places it on your Desktop. Note that this currently uses bindED’s built-in + report which will output any bind that does not have a keyboard key set, + including axis binds and binds that are not actually used by the profiles.
    • +
  • open documentation: Opens the documentation in your default browser.
    • +
  • open EDDI options;configure EDDI: Displays EDDI’s configuration window.
    • +
  • open elite bindings folder: Opens Elite’s bindings folder + (%localappdata%\Frontier Developments\Elite Dangerous\Options\Bindings)
    • +
  • reload elite key binds: Forces a reload of your Elite binds. Should not be + necessary.
    • +
  • shut up EDDI: Immediately interrupts any current and pending speech on + EDDI’s end.
    • +
+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/images/ED-NeutronRouter-folder.png b/images/ED-NeutronRouter-folder.png new file mode 100644 index 0000000..cb2d654 Binary files /dev/null and b/images/ED-NeutronRouter-folder.png differ diff --git a/images/EDDI-event.png b/images/EDDI-event.png new file mode 100644 index 0000000..52b4f7f Binary files /dev/null and b/images/EDDI-event.png differ diff --git a/images/Elite-COVAS.png b/images/Elite-COVAS.png new file mode 100644 index 0000000..7affa7a Binary files /dev/null and b/images/Elite-COVAS.png differ diff --git a/images/Elite-binds-galmap.png b/images/Elite-binds-galmap.png new file mode 100644 index 0000000..35e79ee Binary files /dev/null and b/images/Elite-binds-galmap.png differ diff --git a/images/Elite-binds.png b/images/Elite-binds.png new file mode 100644 index 0000000..020576d Binary files /dev/null and b/images/Elite-binds.png differ diff --git a/images/SpanshAttack-getshiprange.png b/images/SpanshAttack-getshiprange.png new file mode 100644 index 0000000..28b6407 Binary files /dev/null and b/images/SpanshAttack-getshiprange.png differ diff --git a/images/VoiceAttack-apps.png b/images/VoiceAttack-apps.png new file mode 100644 index 0000000..73bffb6 Binary files /dev/null and b/images/VoiceAttack-apps.png differ diff --git a/images/VoiceAttack-download.png b/images/VoiceAttack-download.png new file mode 100644 index 0000000..ee17eef Binary files /dev/null and b/images/VoiceAttack-download.png differ diff --git a/images/VoiceAttack-edit-new-command.png b/images/VoiceAttack-edit-new-command.png new file mode 100644 index 0000000..912a5e1 Binary files /dev/null and b/images/VoiceAttack-edit-new-command.png differ diff --git a/images/VoiceAttack-edit-startup-action.png b/images/VoiceAttack-edit-startup-action.png new file mode 100644 index 0000000..e905cbd Binary files /dev/null and b/images/VoiceAttack-edit-startup-action.png differ diff --git a/images/VoiceAttack-edit-startup-actionlist.png b/images/VoiceAttack-edit-startup-actionlist.png new file mode 100644 index 0000000..0975e03 Binary files /dev/null and b/images/VoiceAttack-edit-startup-actionlist.png differ diff --git a/images/VoiceAttack-edit-startup-execute.png b/images/VoiceAttack-edit-startup-execute.png new file mode 100644 index 0000000..7687149 Binary files /dev/null and b/images/VoiceAttack-edit-startup-execute.png differ diff --git a/images/VoiceAttack-edit-startup.png b/images/VoiceAttack-edit-startup.png new file mode 100644 index 0000000..3507861 Binary files /dev/null and b/images/VoiceAttack-edit-startup.png differ diff --git a/images/VoiceAttack-edit.png b/images/VoiceAttack-edit.png new file mode 100644 index 0000000..5eddff9 Binary files /dev/null and b/images/VoiceAttack-edit.png differ diff --git a/images/VoiceAttack-import-profile-open.png b/images/VoiceAttack-import-profile-open.png new file mode 100644 index 0000000..d6b9912 Binary files /dev/null and b/images/VoiceAttack-import-profile-open.png differ diff --git a/images/VoiceAttack-import-profile.png b/images/VoiceAttack-import-profile.png new file mode 100644 index 0000000..38329aa Binary files /dev/null and b/images/VoiceAttack-import-profile.png differ diff --git a/images/VoiceAttack-new-profile-done.png b/images/VoiceAttack-new-profile-done.png new file mode 100644 index 0000000..5f6dd3b Binary files /dev/null and b/images/VoiceAttack-new-profile-done.png differ diff --git a/images/VoiceAttack-new-profile.png b/images/VoiceAttack-new-profile.png new file mode 100644 index 0000000..9dc7db8 Binary files /dev/null and b/images/VoiceAttack-new-profile.png differ diff --git a/images/VoiceAttack-profile-options-include.png b/images/VoiceAttack-profile-options-include.png new file mode 100644 index 0000000..545cbaf Binary files /dev/null and b/images/VoiceAttack-profile-options-include.png differ diff --git a/images/VoiceAttack-profile-options-includelist.png b/images/VoiceAttack-profile-options-includelist.png new file mode 100644 index 0000000..c83a190 Binary files /dev/null and b/images/VoiceAttack-profile-options-includelist.png differ diff --git a/images/VoiceAttack-profile-options-startup.png b/images/VoiceAttack-profile-options-startup.png new file mode 100644 index 0000000..d56e2c1 Binary files /dev/null and b/images/VoiceAttack-profile-options-startup.png differ diff --git a/images/VoiceAttack-profile-options.png b/images/VoiceAttack-profile-options.png new file mode 100644 index 0000000..5715d59 Binary files /dev/null and b/images/VoiceAttack-profile-options.png differ diff --git a/images/VoiceAttack-settings-plugin-support.png b/images/VoiceAttack-settings-plugin-support.png new file mode 100644 index 0000000..0d3f3d7 Binary files /dev/null and b/images/VoiceAttack-settings-plugin-support.png differ diff --git a/images/VoiceAttack-settings-updates.png b/images/VoiceAttack-settings-updates.png new file mode 100644 index 0000000..59b6f7f Binary files /dev/null and b/images/VoiceAttack-settings-updates.png differ diff --git a/images/VoiceAttack-settings.png b/images/VoiceAttack-settings.png new file mode 100644 index 0000000..87c2522 Binary files /dev/null and b/images/VoiceAttack-settings.png differ diff --git a/images/bindED-layout.png b/images/bindED-layout.png new file mode 100644 index 0000000..5062590 Binary files /dev/null and b/images/bindED-layout.png differ diff --git a/images/troubleshooting-raise-min-confidence.png b/images/troubleshooting-raise-min-confidence.png new file mode 100644 index 0000000..8d430f6 Binary files /dev/null and b/images/troubleshooting-raise-min-confidence.png differ diff --git a/images/troubleshooting-remove-trigger.png b/images/troubleshooting-remove-trigger.png new file mode 100644 index 0000000..2ec3a8a Binary files /dev/null and b/images/troubleshooting-remove-trigger.png differ diff --git a/img/favicon.ico b/img/favicon.ico new file mode 100644 index 0000000..e85006a Binary files /dev/null and b/img/favicon.ico differ diff --git a/index.html b/index.html new file mode 100644 index 0000000..ac1093d --- /dev/null +++ b/index.html @@ -0,0 +1,218 @@ + + + + + + + + alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

Elite Dangerous VoiceAttack Profiles

+

These are various profiles for VoiceAttack (VA) I use +to enhance my Elite experience. They give me important info, facilitate +day-to-day gaming and do some special things for Fuel +Rats and Hull Seals work.

+

NOTE: Further development is on hold and Odyssey compatibility will not be +worked on for the time being. See the corresponding issue on +Github. This +might or might not change after the Horizons/Odyssey merge. Feel free to file +issues for anything that is broken on Odyssey and it will be worked on when it +is worked on.

+

Available Profiles

+
    +
  • EliteAttack: The main Elite VA profile. Anything related to + “just” playing the game.
    • +
  • RatAttack: Manages interactions with the FuelRats IRC server.
    • +
  • SpanshAttack: Plots and follows trips along the neutron + highway using Spansh’s neutron plotter.
    • +
  • StreamAttack: Writes various status things to files that can + then be read by streaming software like OBS.
    • +
+

They all require the alterNERDtive-base profile that, well, provides basic +functionality common to all of the above.

+

Need Help / Want to Contribute?

+

Well, you are in the right place. You can find comprehensive documentation right +here.

+

If you run into any errors, please make sure you are running the latest version +of the profiles and all requirements.

+

If your problem persists, please file an +issue. Thanks! :)

+

You can also say “Hi” on Discord if that is your +thing.

+

GitHub Sponsors +ko-fi

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + + Next » + + +
+ + + + + + + + + + diff --git a/installing/index.html b/installing/index.html new file mode 100644 index 0000000..d4fdc08 --- /dev/null +++ b/installing/index.html @@ -0,0 +1,389 @@ + + + + + + + + Installing - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

Installing

+

Install VoiceAttack

+

Grab the most recent VoiceAttack beta +version off the official site and install +it.

+

If you are using the standalone version you should probably download the +executable installer.

+

VoiceAttack-download.png

+

If you are using the Steam version of VoiceAttack, you will have to download the +zipped folder and replace your installed version with its contents.

+

Here is the first hit on a Google search for finding the installation +folder. It is +for a completely unrelated game, but the steps are the same.

+

You can potentially also install the latest non-beta version; but I often use +features that have only just been added to the beta, so some things might break +for you if you are not using that. There might not be a beta version at the time +you’re reading this, just get the full release then.

+

Enable Plugin Support

+

Make sure you have plugin support enabled:

+
    +
  1. Go to VoiceAttack settings. VoiceAttack-settings.png
    2. +
  2. Check “enable plugin support”. VoiceAttack-settings-plugin-support.png
    3. +
+

While you are there, you might also want to enable the automatic update checks +(Note: those settings do not exist in the Steam version).

+

VoiceAttack-settings-updates.png

+

Install EDDI

+

Install the latest release from +Github (The EDDI-X.Y.Z.exe file under “Assets”). You will need to install it +as a VoiceAttack +plugin.

+

If you do not want to install it into the VoiceAttack installation folder (or +already have it installed somewhere else) you can instead put it elsewhere and +create a symbolic link. Open a command prompt (Windows key + R, enter “cmd”, +hit Enter) and do

+
>cd x:\path\to\VoiceAttack\Apps
+>mklink /J EDDI x:\path\to\EDDI
+
+

If you have installed the non-Steam version of VoiceAttack to the default folder +within “Program Files” you will have to run the command prompt as admin (Windows +key + R, enter “cmd”, hit Control + Shift + Enter).

+

Install ED-NeutronRouter

+

Grab the latest release release from +Github (The +EDNeutronRouter.vX.YZ.zip under “Assets”). You will have to extract the +contents of the release .zip file to your VoiceAttack Apps folder:

+
    +
  1. Go into VoiceAttack settings. VoiceAttack-settings.png
    2. +
  2. Click the folder set as “Apps Folder”. VoiceAttack-apps.png
    3. +
+

Now extract the contents of the downloaded file into there. Make sure that they +are not naked files under “Apps”, but have their own folder +“Apps\ED-NeutronRouter”! The exact folder name does not matter as long as they +are in a subfolder. Otherwise the plugin will not load.

+

ED-NeutronRouter-folder.png

+

Leave the “Apps” folder open in Windows Explorer, you will need it for the next step.

+

Import Profiles Package

+

Acquire the latest +release +from Github (the alterNERDtive-voiceattack-profiles.vax file under “Assets”). +Put it into VoiceAttack’s “Import” folder:

+
    +
  1. Go into VoiceAttack settings. VoiceAttack-settings.png
    2. +
  2. Click the folder set as “Apps Folder”. VoiceAttack-apps.png
    3. +
  3. Create a sub folder named “Import” if it does not exist yet.
    4. +
  4. Drop the downloaded .vax file into the “Import” folder.
    5. +
  5. Restart VoiceAttack.
    6. +
  6. When prompted, import the profile package. VoiceAttack will restart when completed.
    7. +
+

Create a Custom Profile

+

Last but not least you are going to create your own custom VoiceAttack profile +for Elite. It will allow you to add your own commands, override any commands in +the profiles that you want to change and add voice triggers or hotkeys.

+

You can either use an existing profile, create a new one or use the provided +profile example as a basis. Regardless of which way you choose, make sure to +read the Include Profiles section and follow the instructions there!

+

Option 1: Create a New Profile Or Use an Existing One

+
    +
  1. Click the “Profile Actions” button, then “Create New Profile”. + VoiceAttack-new-profile.png
    2. +
  2. Give it a name and add some commands if you want to.
    3. +
  3. Hit “Done” to create the new profile.
    4. +
+

Alternatively you can keep using your existing profile. You will still have to +follow the rest of the instructions in this case.

+

Create a Startup Command

+

First off, hit the “Edit” button in VoiceAttack.

+

VoiceAttack-edit.png

+

If you are using your existing profile (or have just created a fresh one) you +will now have to create the startup command. Hit the “New Command” button.

+

VoiceAttack-edit-new-command.png

+

You can name it anything you want but I recommend calling it “startup” or +similar, and to deactivate the “when I say” checkbox in the command options to +make sure you do not accidentally run it via voice.

+

VoiceAttack-edit-startup.png

+

Add a new action using “Other” → “VoiceAttack Action”→ “Execute Another Command”.

+

VoiceAttack-edit-startup-execute.png

+

Choose “Execute by name (Advanced)” and enter ((alterNERDtive-base.startup)).

+

VoiceAttack-edit-startup-action.png

+

Make sure to leave “Wait until this command completes before continuing” on and +have this action at the top of the action list for the command. That way you can +be sure that my profiles are initialized properly before your personal startup +actions are processed.

+

VoiceAttack-edit-startup-actionlist.png

+

You can add anything else you want your profile to do when it loads below this +action. You do not have to set any configuration options, this can be done way +more elegantly! More on this later on.

+

After adding the startup command you will have to right click VoiceAttack’s +title bar and choose “Reload Active Profile” or restart VoiceAttack to see it +executed for the first time.

+

Option 2: Use the Profile Example

+
    +
  1. Click the “Profile Actions” button, then “Import Profile”. + VoiceAttack-import-profile.png
    2. +
  2. Navigate to your VoiceAttack Apps folder (see above), go into the + “alterNERDtive” subfolder, choose the profile example and hit “Open”. + VoiceAttack-import-profile-open.png
    3. +
+

Once you are done with the setup and configuration process, you can find a bunch +of example commands with comments on how to do things in this profile. Make sure +to also rename it to something more exciting than “Custom Profile Example”!

+

Include Profiles

+

In order to use my profiles with your custom profile, you will need to take two +additional steps:

+
    +
  1. Include the profiles in your custom profile. That will make all commands + available when your custom profile is active.
    2. +
  2. Create a startup command for your custom profile. You can use it to do + anything you want when your profile loads, but it will also have to run the + startup command for my profiles.
    3. +
+

Set Profile Options

+

While editing the profile, hit the “Options” button.

+

VoiceAttack-profile-options.png

+

On the section labeled “Include commands from other profiles”, hit the “…” +button.

+

VoiceAttack-profile-options-include.png

+

Add all my profiles (“alterNERDtive-base”, “EliteAttack”, “RatAttack”, +“SpanshAttack”, “StreamAttack”).

+

VoiceAttack-profile-options-includelist.png

+

Make sure that “alterNERDtive-base” is on top of the list, the order of the +others does not matter. But I like it nice and alphabetical. Technically you can +leave out any profile you are not planning to use. Practically it probably will +not hurt you to just include everything, and it will then be available for you +in the future should you choose to check it out!

+

Now switch to the “Profile Exec” tab. Tick the “Execute a command each time this +profile is loaded” checkbox, and select the “startup” command you have created +earlier.

+

VoiceAttack-profile-options-startup.png

+

Reload the Profile

+

To make sure everything is loaded correctly, you now need to either reload the +profile by right clicking on VoiceAttack’s title bar → “Reset Active Profile” or +by simply restarting VoiceAttack.

+

You should see a bunch of initialization messages pop up in the VoiceAttack log.

+

Set Elite Keyboard Binds

+

You need to have keyboard binds setup at least as secondary bindings in Elite’s +controls options. VoiceAttack cannot “push” joystick buttons for you, it can +only do keyboard inputs. Hence its only way to interact with Elite is through +keyboard emulation, even if you otherwise play the game with a controller or +HOTAS. Or racing wheel. Or Rock Band set. Or bananas.

+

Elite-binds.png

+

For the “Galaxy Map” section, make sure that the bindings do not conflict with +the ones in the “Interface Mode” section. The map bindings take precedence and a +conflict leads to VoiceAttack being unable to target systems for you. In that +case you would see it open the map for you and then wiggle the view for a split +second instead of switching tabs over to the system search.

+

Elite-binds-galmap.png

+

Should you use a keyboard layout that is not en-US QWERTY, some keys might not +work out of the box. You can try telling bindED about your keyboard layout by +setting the bindED.layout# variable (including the #!) to something more +appropriate in your startup command.

+

bindED-layout.png

+

Currently bindED supports the en-US, en-GB and de-Neo2 layouts. You can +find instructions on how to add your own +here.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/js/html5shiv.min.js b/js/html5shiv.min.js new file mode 100644 index 0000000..1a01c94 --- /dev/null +++ b/js/html5shiv.min.js @@ -0,0 +1,4 @@ +/** +* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed +*/ +!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); diff --git a/js/jquery-3.6.0.min.js b/js/jquery-3.6.0.min.js new file mode 100644 index 0000000..c4c6022 --- /dev/null +++ b/js/jquery-3.6.0.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t + + + + + + + Requirements - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

Requirements

+

VoiceAttack

+

Obviously you will need to install VoiceAttack. There +is a free trial version available, but that one is limited to a single profile +and a few commands. This is 5 profiles and … a lot of commands. You will need the +full version, available for $10 (official site) or €11.99 (Steam, IIRC $14.99 +for our US-based friends).

+

I recommend buying on the site. Why? Because on Steam, Valve gets a 30% cut. +Unlike many other developers Gary (the developer of VoiceAttack) remedies that +by having a price on Steam that ends up paying $10 to him. So basically, you are +paying Valve out of your own pocket. Many other developers do not do that, and +by buying from them directly instead of on Steam you are literally giving them +extra money. Please do keep that in mind in the future!

+

You also will generally need to opt into the beta version. I am usually at the +forefront of bug reports and feature requests, and I do rely on the +fixes/additions in beta versions quite often.

+

EDDI

+

EDDI is a companion application for Elite: +Dangerous, providing responses to events that occur in-game using data from the +game as well as various third-party tools. In this case, you will need to run it +as a VoiceAttack plugin.

+

EDDI also regularly publishes beta versions. Unless a profiles release +explicitly states it you will not have to run EDDI beta.

+

Do note that the profiles put EDDI into quiet mode by default, disabling the +built-in speech responders. This can be changed +via the EDDI quiet mode setting.

+

bindED

+

bindED reads your Elite Dangerous +binding files and makes them available to VoiceAttack as variables. That way +commands can be portable and you do not have to manually go through them and +change any actions that you happen to not have the standard binds for.

+

This plugin is included in the release package. You do not have to download +and install it manually, but you can independently update it if a newer +version is available.

+

Elite Scripts

+

I have written a collection of Python +scripts to interface with +various 3ʳᵈ party services like EDSM or Spansh. Those are called by the profiles +for various tasks, like checking a system’s body count.

+

In the future they will be replaced by VoiceAttack plugin code.

+

The scripts are included in the release package. You do not have to download +and install them manually, but you can independently update them if a newer +version is available.

+

ED-NeutronRouter

+

ED-NeutronRouter interfaces +with Spansh’s neutron plotter and makes the result +available to VoiceAttack.

+

This plugin is only required if you intend to use the SpanshAttack profile for +neutron routing. Otherwise you do not have to install it.

+

This will also eventually be replaced by my own plugins.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + + diff --git a/search.html b/search.html new file mode 100644 index 0000000..17028bc --- /dev/null +++ b/search.html @@ -0,0 +1,167 @@ + + + + + + + + alterNERDtive VA profiles + + + + + + + + + + + + +
+ + +
+ +
+
+
    +
  • »
    • +
  • +
    • +
+
+
+
+
+ + +

Search Results

+ +
+ + +
+ +
+ Searching... +
+ + +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + + +
+ + + + + + + + diff --git a/search/lunr.js b/search/lunr.js new file mode 100644 index 0000000..6aa370f --- /dev/null +++ b/search/lunr.js @@ -0,0 +1,3475 @@ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */ + +;(function(){ + +/** + * A convenience function for configuring and constructing + * a new lunr Index. + * + * A lunr.Builder instance is created and the pipeline setup + * with a trimmer, stop word filter and stemmer. + * + * This builder object is yielded to the configuration function + * that is passed as a parameter, allowing the list of fields + * and other builder parameters to be customised. + * + * All documents _must_ be added within the passed config function. + * + * @example + * var idx = lunr(function () { + * this.field('title') + * this.field('body') + * this.ref('id') + * + * documents.forEach(function (doc) { + * this.add(doc) + * }, this) + * }) + * + * @see {@link lunr.Builder} + * @see {@link lunr.Pipeline} + * @see {@link lunr.trimmer} + * @see {@link lunr.stopWordFilter} + * @see {@link lunr.stemmer} + * @namespace {function} lunr + */ +var lunr = function (config) { + var builder = new lunr.Builder + + builder.pipeline.add( + lunr.trimmer, + lunr.stopWordFilter, + lunr.stemmer + ) + + builder.searchPipeline.add( + lunr.stemmer + ) + + config.call(builder, builder) + return builder.build() +} + +lunr.version = "2.3.9" +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A namespace containing utils for the rest of the lunr library + * @namespace lunr.utils + */ +lunr.utils = {} + +/** + * Print a warning message to the console. + * + * @param {String} message The message to be printed. + * @memberOf lunr.utils + * @function + */ +lunr.utils.warn = (function (global) { + /* eslint-disable no-console */ + return function (message) { + if (global.console && console.warn) { + console.warn(message) + } + } + /* eslint-enable no-console */ +})(this) + +/** + * Convert an object to a string. + * + * In the case of `null` and `undefined` the function returns + * the empty string, in all other cases the result of calling + * `toString` on the passed object is returned. + * + * @param {Any} obj The object to convert to a string. + * @return {String} string representation of the passed object. + * @memberOf lunr.utils + */ +lunr.utils.asString = function (obj) { + if (obj === void 0 || obj === null) { + return "" + } else { + return obj.toString() + } +} + +/** + * Clones an object. + * + * Will create a copy of an existing object such that any mutations + * on the copy cannot affect the original. + * + * Only shallow objects are supported, passing a nested object to this + * function will cause a TypeError. + * + * Objects with primitives, and arrays of primitives are supported. + * + * @param {Object} obj The object to clone. + * @return {Object} a clone of the passed object. + * @throws {TypeError} when a nested object is passed. + * @memberOf Utils + */ +lunr.utils.clone = function (obj) { + if (obj === null || obj === undefined) { + return obj + } + + var clone = Object.create(null), + keys = Object.keys(obj) + + for (var i = 0; i < keys.length; i++) { + var key = keys[i], + val = obj[key] + + if (Array.isArray(val)) { + clone[key] = val.slice() + continue + } + + if (typeof val === 'string' || + typeof val === 'number' || + typeof val === 'boolean') { + clone[key] = val + continue + } + + throw new TypeError("clone is not deep and does not support nested objects") + } + + return clone +} +lunr.FieldRef = function (docRef, fieldName, stringValue) { + this.docRef = docRef + this.fieldName = fieldName + this._stringValue = stringValue +} + +lunr.FieldRef.joiner = "/" + +lunr.FieldRef.fromString = function (s) { + var n = s.indexOf(lunr.FieldRef.joiner) + + if (n === -1) { + throw "malformed field ref string" + } + + var fieldRef = s.slice(0, n), + docRef = s.slice(n + 1) + + return new lunr.FieldRef (docRef, fieldRef, s) +} + +lunr.FieldRef.prototype.toString = function () { + if (this._stringValue == undefined) { + this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef + } + + return this._stringValue +} +/*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A lunr set. + * + * @constructor + */ +lunr.Set = function (elements) { + this.elements = Object.create(null) + + if (elements) { + this.length = elements.length + + for (var i = 0; i < this.length; i++) { + this.elements[elements[i]] = true + } + } else { + this.length = 0 + } +} + +/** + * A complete set that contains all elements. + * + * @static + * @readonly + * @type {lunr.Set} + */ +lunr.Set.complete = { + intersect: function (other) { + return other + }, + + union: function () { + return this + }, + + contains: function () { + return true + } +} + +/** + * An empty set that contains no elements. + * + * @static + * @readonly + * @type {lunr.Set} + */ +lunr.Set.empty = { + intersect: function () { + return this + }, + + union: function (other) { + return other + }, + + contains: function () { + return false + } +} + +/** + * Returns true if this set contains the specified object. + * + * @param {object} object - Object whose presence in this set is to be tested. + * @returns {boolean} - True if this set contains the specified object. + */ +lunr.Set.prototype.contains = function (object) { + return !!this.elements[object] +} + +/** + * Returns a new set containing only the elements that are present in both + * this set and the specified set. + * + * @param {lunr.Set} other - set to intersect with this set. + * @returns {lunr.Set} a new set that is the intersection of this and the specified set. + */ + +lunr.Set.prototype.intersect = function (other) { + var a, b, elements, intersection = [] + + if (other === lunr.Set.complete) { + return this + } + + if (other === lunr.Set.empty) { + return other + } + + if (this.length < other.length) { + a = this + b = other + } else { + a = other + b = this + } + + elements = Object.keys(a.elements) + + for (var i = 0; i < elements.length; i++) { + var element = elements[i] + if (element in b.elements) { + intersection.push(element) + } + } + + return new lunr.Set (intersection) +} + +/** + * Returns a new set combining the elements of this and the specified set. + * + * @param {lunr.Set} other - set to union with this set. + * @return {lunr.Set} a new set that is the union of this and the specified set. + */ + +lunr.Set.prototype.union = function (other) { + if (other === lunr.Set.complete) { + return lunr.Set.complete + } + + if (other === lunr.Set.empty) { + return this + } + + return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements))) +} +/** + * A function to calculate the inverse document frequency for + * a posting. This is shared between the builder and the index + * + * @private + * @param {object} posting - The posting for a given term + * @param {number} documentCount - The total number of documents. + */ +lunr.idf = function (posting, documentCount) { + var documentsWithTerm = 0 + + for (var fieldName in posting) { + if (fieldName == '_index') continue // Ignore the term index, its not a field + documentsWithTerm += Object.keys(posting[fieldName]).length + } + + var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5) + + return Math.log(1 + Math.abs(x)) +} + +/** + * A token wraps a string representation of a token + * as it is passed through the text processing pipeline. + * + * @constructor + * @param {string} [str=''] - The string token being wrapped. + * @param {object} [metadata={}] - Metadata associated with this token. + */ +lunr.Token = function (str, metadata) { + this.str = str || "" + this.metadata = metadata || {} +} + +/** + * Returns the token string that is being wrapped by this object. + * + * @returns {string} + */ +lunr.Token.prototype.toString = function () { + return this.str +} + +/** + * A token update function is used when updating or optionally + * when cloning a token. + * + * @callback lunr.Token~updateFunction + * @param {string} str - The string representation of the token. + * @param {Object} metadata - All metadata associated with this token. + */ + +/** + * Applies the given function to the wrapped string token. + * + * @example + * token.update(function (str, metadata) { + * return str.toUpperCase() + * }) + * + * @param {lunr.Token~updateFunction} fn - A function to apply to the token string. + * @returns {lunr.Token} + */ +lunr.Token.prototype.update = function (fn) { + this.str = fn(this.str, this.metadata) + return this +} + +/** + * Creates a clone of this token. Optionally a function can be + * applied to the cloned token. + * + * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token. + * @returns {lunr.Token} + */ +lunr.Token.prototype.clone = function (fn) { + fn = fn || function (s) { return s } + return new lunr.Token (fn(this.str, this.metadata), this.metadata) +} +/*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A function for splitting a string into tokens ready to be inserted into + * the search index. Uses `lunr.tokenizer.separator` to split strings, change + * the value of this property to change how strings are split into tokens. + * + * This tokenizer will convert its parameter to a string by calling `toString` and + * then will split this string on the character in `lunr.tokenizer.separator`. + * Arrays will have their elements converted to strings and wrapped in a lunr.Token. + * + * Optional metadata can be passed to the tokenizer, this metadata will be cloned and + * added as metadata to every token that is created from the object to be tokenized. + * + * @static + * @param {?(string|object|object[])} obj - The object to convert into tokens + * @param {?object} metadata - Optional metadata to associate with every token + * @returns {lunr.Token[]} + * @see {@link lunr.Pipeline} + */ +lunr.tokenizer = function (obj, metadata) { + if (obj == null || obj == undefined) { + return [] + } + + if (Array.isArray(obj)) { + return obj.map(function (t) { + return new lunr.Token( + lunr.utils.asString(t).toLowerCase(), + lunr.utils.clone(metadata) + ) + }) + } + + var str = obj.toString().toLowerCase(), + len = str.length, + tokens = [] + + for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) { + var char = str.charAt(sliceEnd), + sliceLength = sliceEnd - sliceStart + + if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) { + + if (sliceLength > 0) { + var tokenMetadata = lunr.utils.clone(metadata) || {} + tokenMetadata["position"] = [sliceStart, sliceLength] + tokenMetadata["index"] = tokens.length + + tokens.push( + new lunr.Token ( + str.slice(sliceStart, sliceEnd), + tokenMetadata + ) + ) + } + + sliceStart = sliceEnd + 1 + } + + } + + return tokens +} + +/** + * The separator used to split a string into tokens. Override this property to change the behaviour of + * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens. + * + * @static + * @see lunr.tokenizer + */ +lunr.tokenizer.separator = /[\s\-]+/ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.Pipelines maintain an ordered list of functions to be applied to all + * tokens in documents entering the search index and queries being ran against + * the index. + * + * An instance of lunr.Index created with the lunr shortcut will contain a + * pipeline with a stop word filter and an English language stemmer. Extra + * functions can be added before or after either of these functions or these + * default functions can be removed. + * + * When run the pipeline will call each function in turn, passing a token, the + * index of that token in the original list of all tokens and finally a list of + * all the original tokens. + * + * The output of functions in the pipeline will be passed to the next function + * in the pipeline. To exclude a token from entering the index the function + * should return undefined, the rest of the pipeline will not be called with + * this token. + * + * For serialisation of pipelines to work, all functions used in an instance of + * a pipeline should be registered with lunr.Pipeline. Registered functions can + * then be loaded. If trying to load a serialised pipeline that uses functions + * that are not registered an error will be thrown. + * + * If not planning on serialising the pipeline then registering pipeline functions + * is not necessary. + * + * @constructor + */ +lunr.Pipeline = function () { + this._stack = [] +} + +lunr.Pipeline.registeredFunctions = Object.create(null) + +/** + * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token + * string as well as all known metadata. A pipeline function can mutate the token string + * or mutate (or add) metadata for a given token. + * + * A pipeline function can indicate that the passed token should be discarded by returning + * null, undefined or an empty string. This token will not be passed to any downstream pipeline + * functions and will not be added to the index. + * + * Multiple tokens can be returned by returning an array of tokens. Each token will be passed + * to any downstream pipeline functions and all will returned tokens will be added to the index. + * + * Any number of pipeline functions may be chained together using a lunr.Pipeline. + * + * @interface lunr.PipelineFunction + * @param {lunr.Token} token - A token from the document being processed. + * @param {number} i - The index of this token in the complete list of tokens for this document/field. + * @param {lunr.Token[]} tokens - All tokens for this document/field. + * @returns {(?lunr.Token|lunr.Token[])} + */ + +/** + * Register a function with the pipeline. + * + * Functions that are used in the pipeline should be registered if the pipeline + * needs to be serialised, or a serialised pipeline needs to be loaded. + * + * Registering a function does not add it to a pipeline, functions must still be + * added to instances of the pipeline for them to be used when running a pipeline. + * + * @param {lunr.PipelineFunction} fn - The function to check for. + * @param {String} label - The label to register this function with + */ +lunr.Pipeline.registerFunction = function (fn, label) { + if (label in this.registeredFunctions) { + lunr.utils.warn('Overwriting existing registered function: ' + label) + } + + fn.label = label + lunr.Pipeline.registeredFunctions[fn.label] = fn +} + +/** + * Warns if the function is not registered as a Pipeline function. + * + * @param {lunr.PipelineFunction} fn - The function to check for. + * @private + */ +lunr.Pipeline.warnIfFunctionNotRegistered = function (fn) { + var isRegistered = fn.label && (fn.label in this.registeredFunctions) + + if (!isRegistered) { + lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\n', fn) + } +} + +/** + * Loads a previously serialised pipeline. + * + * All functions to be loaded must already be registered with lunr.Pipeline. + * If any function from the serialised data has not been registered then an + * error will be thrown. + * + * @param {Object} serialised - The serialised pipeline to load. + * @returns {lunr.Pipeline} + */ +lunr.Pipeline.load = function (serialised) { + var pipeline = new lunr.Pipeline + + serialised.forEach(function (fnName) { + var fn = lunr.Pipeline.registeredFunctions[fnName] + + if (fn) { + pipeline.add(fn) + } else { + throw new Error('Cannot load unregistered function: ' + fnName) + } + }) + + return pipeline +} + +/** + * Adds new functions to the end of the pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline. + */ +lunr.Pipeline.prototype.add = function () { + var fns = Array.prototype.slice.call(arguments) + + fns.forEach(function (fn) { + lunr.Pipeline.warnIfFunctionNotRegistered(fn) + this._stack.push(fn) + }, this) +} + +/** + * Adds a single function after a function that already exists in the + * pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline. + * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline. + */ +lunr.Pipeline.prototype.after = function (existingFn, newFn) { + lunr.Pipeline.warnIfFunctionNotRegistered(newFn) + + var pos = this._stack.indexOf(existingFn) + if (pos == -1) { + throw new Error('Cannot find existingFn') + } + + pos = pos + 1 + this._stack.splice(pos, 0, newFn) +} + +/** + * Adds a single function before a function that already exists in the + * pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline. + * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline. + */ +lunr.Pipeline.prototype.before = function (existingFn, newFn) { + lunr.Pipeline.warnIfFunctionNotRegistered(newFn) + + var pos = this._stack.indexOf(existingFn) + if (pos == -1) { + throw new Error('Cannot find existingFn') + } + + this._stack.splice(pos, 0, newFn) +} + +/** + * Removes a function from the pipeline. + * + * @param {lunr.PipelineFunction} fn The function to remove from the pipeline. + */ +lunr.Pipeline.prototype.remove = function (fn) { + var pos = this._stack.indexOf(fn) + if (pos == -1) { + return + } + + this._stack.splice(pos, 1) +} + +/** + * Runs the current list of functions that make up the pipeline against the + * passed tokens. + * + * @param {Array} tokens The tokens to run through the pipeline. + * @returns {Array} + */ +lunr.Pipeline.prototype.run = function (tokens) { + var stackLength = this._stack.length + + for (var i = 0; i < stackLength; i++) { + var fn = this._stack[i] + var memo = [] + + for (var j = 0; j < tokens.length; j++) { + var result = fn(tokens[j], j, tokens) + + if (result === null || result === void 0 || result === '') continue + + if (Array.isArray(result)) { + for (var k = 0; k < result.length; k++) { + memo.push(result[k]) + } + } else { + memo.push(result) + } + } + + tokens = memo + } + + return tokens +} + +/** + * Convenience method for passing a string through a pipeline and getting + * strings out. This method takes care of wrapping the passed string in a + * token and mapping the resulting tokens back to strings. + * + * @param {string} str - The string to pass through the pipeline. + * @param {?object} metadata - Optional metadata to associate with the token + * passed to the pipeline. + * @returns {string[]} + */ +lunr.Pipeline.prototype.runString = function (str, metadata) { + var token = new lunr.Token (str, metadata) + + return this.run([token]).map(function (t) { + return t.toString() + }) +} + +/** + * Resets the pipeline by removing any existing processors. + * + */ +lunr.Pipeline.prototype.reset = function () { + this._stack = [] +} + +/** + * Returns a representation of the pipeline ready for serialisation. + * + * Logs a warning if the function has not been registered. + * + * @returns {Array} + */ +lunr.Pipeline.prototype.toJSON = function () { + return this._stack.map(function (fn) { + lunr.Pipeline.warnIfFunctionNotRegistered(fn) + + return fn.label + }) +} +/*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A vector is used to construct the vector space of documents and queries. These + * vectors support operations to determine the similarity between two documents or + * a document and a query. + * + * Normally no parameters are required for initializing a vector, but in the case of + * loading a previously dumped vector the raw elements can be provided to the constructor. + * + * For performance reasons vectors are implemented with a flat array, where an elements + * index is immediately followed by its value. E.g. [index, value, index, value]. This + * allows the underlying array to be as sparse as possible and still offer decent + * performance when being used for vector calculations. + * + * @constructor + * @param {Number[]} [elements] - The flat list of element index and element value pairs. + */ +lunr.Vector = function (elements) { + this._magnitude = 0 + this.elements = elements || [] +} + + +/** + * Calculates the position within the vector to insert a given index. + * + * This is used internally by insert and upsert. If there are duplicate indexes then + * the position is returned as if the value for that index were to be updated, but it + * is the callers responsibility to check whether there is a duplicate at that index + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @returns {Number} + */ +lunr.Vector.prototype.positionForIndex = function (index) { + // For an empty vector the tuple can be inserted at the beginning + if (this.elements.length == 0) { + return 0 + } + + var start = 0, + end = this.elements.length / 2, + sliceLength = end - start, + pivotPoint = Math.floor(sliceLength / 2), + pivotIndex = this.elements[pivotPoint * 2] + + while (sliceLength > 1) { + if (pivotIndex < index) { + start = pivotPoint + } + + if (pivotIndex > index) { + end = pivotPoint + } + + if (pivotIndex == index) { + break + } + + sliceLength = end - start + pivotPoint = start + Math.floor(sliceLength / 2) + pivotIndex = this.elements[pivotPoint * 2] + } + + if (pivotIndex == index) { + return pivotPoint * 2 + } + + if (pivotIndex > index) { + return pivotPoint * 2 + } + + if (pivotIndex < index) { + return (pivotPoint + 1) * 2 + } +} + +/** + * Inserts an element at an index within the vector. + * + * Does not allow duplicates, will throw an error if there is already an entry + * for this index. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + */ +lunr.Vector.prototype.insert = function (insertIdx, val) { + this.upsert(insertIdx, val, function () { + throw "duplicate index" + }) +} + +/** + * Inserts or updates an existing index within the vector. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + * @param {function} fn - A function that is called for updates, the existing value and the + * requested value are passed as arguments + */ +lunr.Vector.prototype.upsert = function (insertIdx, val, fn) { + this._magnitude = 0 + var position = this.positionForIndex(insertIdx) + + if (this.elements[position] == insertIdx) { + this.elements[position + 1] = fn(this.elements[position + 1], val) + } else { + this.elements.splice(position, 0, insertIdx, val) + } +} + +/** + * Calculates the magnitude of this vector. + * + * @returns {Number} + */ +lunr.Vector.prototype.magnitude = function () { + if (this._magnitude) return this._magnitude + + var sumOfSquares = 0, + elementsLength = this.elements.length + + for (var i = 1; i < elementsLength; i += 2) { + var val = this.elements[i] + sumOfSquares += val * val + } + + return this._magnitude = Math.sqrt(sumOfSquares) +} + +/** + * Calculates the dot product of this vector and another vector. + * + * @param {lunr.Vector} otherVector - The vector to compute the dot product with. + * @returns {Number} + */ +lunr.Vector.prototype.dot = function (otherVector) { + var dotProduct = 0, + a = this.elements, b = otherVector.elements, + aLen = a.length, bLen = b.length, + aVal = 0, bVal = 0, + i = 0, j = 0 + + while (i < aLen && j < bLen) { + aVal = a[i], bVal = b[j] + if (aVal < bVal) { + i += 2 + } else if (aVal > bVal) { + j += 2 + } else if (aVal == bVal) { + dotProduct += a[i + 1] * b[j + 1] + i += 2 + j += 2 + } + } + + return dotProduct +} + +/** + * Calculates the similarity between this vector and another vector. + * + * @param {lunr.Vector} otherVector - The other vector to calculate the + * similarity with. + * @returns {Number} + */ +lunr.Vector.prototype.similarity = function (otherVector) { + return this.dot(otherVector) / this.magnitude() || 0 +} + +/** + * Converts the vector to an array of the elements within the vector. + * + * @returns {Number[]} + */ +lunr.Vector.prototype.toArray = function () { + var output = new Array (this.elements.length / 2) + + for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) { + output[j] = this.elements[i] + } + + return output +} + +/** + * A JSON serializable representation of the vector. + * + * @returns {Number[]} + */ +lunr.Vector.prototype.toJSON = function () { + return this.elements +} +/* eslint-disable */ +/*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + */ + +/** + * lunr.stemmer is an english language stemmer, this is a JavaScript + * implementation of the PorterStemmer taken from http://tartarus.org/~martin + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token - The string to stem + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + * @function + */ +lunr.stemmer = (function(){ + var step2list = { + "ational" : "ate", + "tional" : "tion", + "enci" : "ence", + "anci" : "ance", + "izer" : "ize", + "bli" : "ble", + "alli" : "al", + "entli" : "ent", + "eli" : "e", + "ousli" : "ous", + "ization" : "ize", + "ation" : "ate", + "ator" : "ate", + "alism" : "al", + "iveness" : "ive", + "fulness" : "ful", + "ousness" : "ous", + "aliti" : "al", + "iviti" : "ive", + "biliti" : "ble", + "logi" : "log" + }, + + step3list = { + "icate" : "ic", + "ative" : "", + "alize" : "al", + "iciti" : "ic", + "ical" : "ic", + "ful" : "", + "ness" : "" + }, + + c = "[^aeiou]", // consonant + v = "[aeiouy]", // vowel + C = c + "[^aeiouy]*", // consonant sequence + V = v + "[aeiou]*", // vowel sequence + + mgr0 = "^(" + C + ")?" + V + C, // [C]VC... is m>0 + meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$", // [C]VC[V] is m=1 + mgr1 = "^(" + C + ")?" + V + C + V + C, // [C]VCVC... is m>1 + s_v = "^(" + C + ")?" + v; // vowel in stem + + var re_mgr0 = new RegExp(mgr0); + var re_mgr1 = new RegExp(mgr1); + var re_meq1 = new RegExp(meq1); + var re_s_v = new RegExp(s_v); + + var re_1a = /^(.+?)(ss|i)es$/; + var re2_1a = /^(.+?)([^s])s$/; + var re_1b = /^(.+?)eed$/; + var re2_1b = /^(.+?)(ed|ing)$/; + var re_1b_2 = /.$/; + var re2_1b_2 = /(at|bl|iz)$/; + var re3_1b_2 = new RegExp("([^aeiouylsz])\\1$"); + var re4_1b_2 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + + var re_1c = /^(.+?[^aeiou])y$/; + var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + + var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + + var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + var re2_4 = /^(.+?)(s|t)(ion)$/; + + var re_5 = /^(.+?)e$/; + var re_5_1 = /ll$/; + var re3_5 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + + var porterStemmer = function porterStemmer(w) { + var stem, + suffix, + firstch, + re, + re2, + re3, + re4; + + if (w.length < 3) { return w; } + + firstch = w.substr(0,1); + if (firstch == "y") { + w = firstch.toUpperCase() + w.substr(1); + } + + // Step 1a + re = re_1a + re2 = re2_1a; + + if (re.test(w)) { w = w.replace(re,"$1$2"); } + else if (re2.test(w)) { w = w.replace(re2,"$1$2"); } + + // Step 1b + re = re_1b; + re2 = re2_1b; + if (re.test(w)) { + var fp = re.exec(w); + re = re_mgr0; + if (re.test(fp[1])) { + re = re_1b_2; + w = w.replace(re,""); + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = re_s_v; + if (re2.test(stem)) { + w = stem; + re2 = re2_1b_2; + re3 = re3_1b_2; + re4 = re4_1b_2; + if (re2.test(w)) { w = w + "e"; } + else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,""); } + else if (re4.test(w)) { w = w + "e"; } + } + } + + // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say) + re = re_1c; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + w = stem + "i"; + } + + // Step 2 + re = re_2; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = re_mgr0; + if (re.test(stem)) { + w = stem + step2list[suffix]; + } + } + + // Step 3 + re = re_3; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = re_mgr0; + if (re.test(stem)) { + w = stem + step3list[suffix]; + } + } + + // Step 4 + re = re_4; + re2 = re2_4; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = re_mgr1; + if (re.test(stem)) { + w = stem; + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = re_mgr1; + if (re2.test(stem)) { + w = stem; + } + } + + // Step 5 + re = re_5; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = re_mgr1; + re2 = re_meq1; + re3 = re3_5; + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) { + w = stem; + } + } + + re = re_5_1; + re2 = re_mgr1; + if (re.test(w) && re2.test(w)) { + re = re_1b_2; + w = w.replace(re,""); + } + + // and turn initial Y back to y + + if (firstch == "y") { + w = firstch.toLowerCase() + w.substr(1); + } + + return w; + }; + + return function (token) { + return token.update(porterStemmer); + } +})(); + +lunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer') +/*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.generateStopWordFilter builds a stopWordFilter function from the provided + * list of stop words. + * + * The built in lunr.stopWordFilter is built using this generator and can be used + * to generate custom stopWordFilters for applications or non English languages. + * + * @function + * @param {Array} token The token to pass through the filter + * @returns {lunr.PipelineFunction} + * @see lunr.Pipeline + * @see lunr.stopWordFilter + */ +lunr.generateStopWordFilter = function (stopWords) { + var words = stopWords.reduce(function (memo, stopWord) { + memo[stopWord] = stopWord + return memo + }, {}) + + return function (token) { + if (token && words[token.toString()] !== token.toString()) return token + } +} + +/** + * lunr.stopWordFilter is an English language stop word list filter, any words + * contained in the list will not be passed through the filter. + * + * This is intended to be used in the Pipeline. If the token does not pass the + * filter then undefined will be returned. + * + * @function + * @implements {lunr.PipelineFunction} + * @params {lunr.Token} token - A token to check for being a stop word. + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + */ +lunr.stopWordFilter = lunr.generateStopWordFilter([ + 'a', + 'able', + 'about', + 'across', + 'after', + 'all', + 'almost', + 'also', + 'am', + 'among', + 'an', + 'and', + 'any', + 'are', + 'as', + 'at', + 'be', + 'because', + 'been', + 'but', + 'by', + 'can', + 'cannot', + 'could', + 'dear', + 'did', + 'do', + 'does', + 'either', + 'else', + 'ever', + 'every', + 'for', + 'from', + 'get', + 'got', + 'had', + 'has', + 'have', + 'he', + 'her', + 'hers', + 'him', + 'his', + 'how', + 'however', + 'i', + 'if', + 'in', + 'into', + 'is', + 'it', + 'its', + 'just', + 'least', + 'let', + 'like', + 'likely', + 'may', + 'me', + 'might', + 'most', + 'must', + 'my', + 'neither', + 'no', + 'nor', + 'not', + 'of', + 'off', + 'often', + 'on', + 'only', + 'or', + 'other', + 'our', + 'own', + 'rather', + 'said', + 'say', + 'says', + 'she', + 'should', + 'since', + 'so', + 'some', + 'than', + 'that', + 'the', + 'their', + 'them', + 'then', + 'there', + 'these', + 'they', + 'this', + 'tis', + 'to', + 'too', + 'twas', + 'us', + 'wants', + 'was', + 'we', + 'were', + 'what', + 'when', + 'where', + 'which', + 'while', + 'who', + 'whom', + 'why', + 'will', + 'with', + 'would', + 'yet', + 'you', + 'your' +]) + +lunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter') +/*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.trimmer is a pipeline function for trimming non word + * characters from the beginning and end of tokens before they + * enter the index. + * + * This implementation may not work correctly for non latin + * characters and should either be removed or adapted for use + * with languages with non-latin characters. + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token The token to pass through the filter + * @returns {lunr.Token} + * @see lunr.Pipeline + */ +lunr.trimmer = function (token) { + return token.update(function (s) { + return s.replace(/^\W+/, '').replace(/\W+$/, '') + }) +} + +lunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer') +/*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * A token set is used to store the unique list of all tokens + * within an index. Token sets are also used to represent an + * incoming query to the index, this query token set and index + * token set are then intersected to find which tokens to look + * up in the inverted index. + * + * A token set can hold multiple tokens, as in the case of the + * index token set, or it can hold a single token as in the + * case of a simple query token set. + * + * Additionally token sets are used to perform wildcard matching. + * Leading, contained and trailing wildcards are supported, and + * from this edit distance matching can also be provided. + * + * Token sets are implemented as a minimal finite state automata, + * where both common prefixes and suffixes are shared between tokens. + * This helps to reduce the space used for storing the token set. + * + * @constructor + */ +lunr.TokenSet = function () { + this.final = false + this.edges = {} + this.id = lunr.TokenSet._nextId + lunr.TokenSet._nextId += 1 +} + +/** + * Keeps track of the next, auto increment, identifier to assign + * to a new tokenSet. + * + * TokenSets require a unique identifier to be correctly minimised. + * + * @private + */ +lunr.TokenSet._nextId = 1 + +/** + * Creates a TokenSet instance from the given sorted array of words. + * + * @param {String[]} arr - A sorted array of strings to create the set from. + * @returns {lunr.TokenSet} + * @throws Will throw an error if the input array is not sorted. + */ +lunr.TokenSet.fromArray = function (arr) { + var builder = new lunr.TokenSet.Builder + + for (var i = 0, len = arr.length; i < len; i++) { + builder.insert(arr[i]) + } + + builder.finish() + return builder.root +} + +/** + * Creates a token set from a query clause. + * + * @private + * @param {Object} clause - A single clause from lunr.Query. + * @param {string} clause.term - The query clause term. + * @param {number} [clause.editDistance] - The optional edit distance for the term. + * @returns {lunr.TokenSet} + */ +lunr.TokenSet.fromClause = function (clause) { + if ('editDistance' in clause) { + return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance) + } else { + return lunr.TokenSet.fromString(clause.term) + } +} + +/** + * Creates a token set representing a single string with a specified + * edit distance. + * + * Insertions, deletions, substitutions and transpositions are each + * treated as an edit distance of 1. + * + * Increasing the allowed edit distance will have a dramatic impact + * on the performance of both creating and intersecting these TokenSets. + * It is advised to keep the edit distance less than 3. + * + * @param {string} str - The string to create the token set from. + * @param {number} editDistance - The allowed edit distance to match. + * @returns {lunr.Vector} + */ +lunr.TokenSet.fromFuzzyString = function (str, editDistance) { + var root = new lunr.TokenSet + + var stack = [{ + node: root, + editsRemaining: editDistance, + str: str + }] + + while (stack.length) { + var frame = stack.pop() + + // no edit + if (frame.str.length > 0) { + var char = frame.str.charAt(0), + noEditNode + + if (char in frame.node.edges) { + noEditNode = frame.node.edges[char] + } else { + noEditNode = new lunr.TokenSet + frame.node.edges[char] = noEditNode + } + + if (frame.str.length == 1) { + noEditNode.final = true + } + + stack.push({ + node: noEditNode, + editsRemaining: frame.editsRemaining, + str: frame.str.slice(1) + }) + } + + if (frame.editsRemaining == 0) { + continue + } + + // insertion + if ("*" in frame.node.edges) { + var insertionNode = frame.node.edges["*"] + } else { + var insertionNode = new lunr.TokenSet + frame.node.edges["*"] = insertionNode + } + + if (frame.str.length == 0) { + insertionNode.final = true + } + + stack.push({ + node: insertionNode, + editsRemaining: frame.editsRemaining - 1, + str: frame.str + }) + + // deletion + // can only do a deletion if we have enough edits remaining + // and if there are characters left to delete in the string + if (frame.str.length > 1) { + stack.push({ + node: frame.node, + editsRemaining: frame.editsRemaining - 1, + str: frame.str.slice(1) + }) + } + + // deletion + // just removing the last character from the str + if (frame.str.length == 1) { + frame.node.final = true + } + + // substitution + // can only do a substitution if we have enough edits remaining + // and if there are characters left to substitute + if (frame.str.length >= 1) { + if ("*" in frame.node.edges) { + var substitutionNode = frame.node.edges["*"] + } else { + var substitutionNode = new lunr.TokenSet + frame.node.edges["*"] = substitutionNode + } + + if (frame.str.length == 1) { + substitutionNode.final = true + } + + stack.push({ + node: substitutionNode, + editsRemaining: frame.editsRemaining - 1, + str: frame.str.slice(1) + }) + } + + // transposition + // can only do a transposition if there are edits remaining + // and there are enough characters to transpose + if (frame.str.length > 1) { + var charA = frame.str.charAt(0), + charB = frame.str.charAt(1), + transposeNode + + if (charB in frame.node.edges) { + transposeNode = frame.node.edges[charB] + } else { + transposeNode = new lunr.TokenSet + frame.node.edges[charB] = transposeNode + } + + if (frame.str.length == 1) { + transposeNode.final = true + } + + stack.push({ + node: transposeNode, + editsRemaining: frame.editsRemaining - 1, + str: charA + frame.str.slice(2) + }) + } + } + + return root +} + +/** + * Creates a TokenSet from a string. + * + * The string may contain one or more wildcard characters (*) + * that will allow wildcard matching when intersecting with + * another TokenSet. + * + * @param {string} str - The string to create a TokenSet from. + * @returns {lunr.TokenSet} + */ +lunr.TokenSet.fromString = function (str) { + var node = new lunr.TokenSet, + root = node + + /* + * Iterates through all characters within the passed string + * appending a node for each character. + * + * When a wildcard character is found then a self + * referencing edge is introduced to continually match + * any number of any characters. + */ + for (var i = 0, len = str.length; i < len; i++) { + var char = str[i], + final = (i == len - 1) + + if (char == "*") { + node.edges[char] = node + node.final = final + + } else { + var next = new lunr.TokenSet + next.final = final + + node.edges[char] = next + node = next + } + } + + return root +} + +/** + * Converts this TokenSet into an array of strings + * contained within the TokenSet. + * + * This is not intended to be used on a TokenSet that + * contains wildcards, in these cases the results are + * undefined and are likely to cause an infinite loop. + * + * @returns {string[]} + */ +lunr.TokenSet.prototype.toArray = function () { + var words = [] + + var stack = [{ + prefix: "", + node: this + }] + + while (stack.length) { + var frame = stack.pop(), + edges = Object.keys(frame.node.edges), + len = edges.length + + if (frame.node.final) { + /* In Safari, at this point the prefix is sometimes corrupted, see: + * https://github.com/olivernn/lunr.js/issues/279 Calling any + * String.prototype method forces Safari to "cast" this string to what + * it's supposed to be, fixing the bug. */ + frame.prefix.charAt(0) + words.push(frame.prefix) + } + + for (var i = 0; i < len; i++) { + var edge = edges[i] + + stack.push({ + prefix: frame.prefix.concat(edge), + node: frame.node.edges[edge] + }) + } + } + + return words +} + +/** + * Generates a string representation of a TokenSet. + * + * This is intended to allow TokenSets to be used as keys + * in objects, largely to aid the construction and minimisation + * of a TokenSet. As such it is not designed to be a human + * friendly representation of the TokenSet. + * + * @returns {string} + */ +lunr.TokenSet.prototype.toString = function () { + // NOTE: Using Object.keys here as this.edges is very likely + // to enter 'hash-mode' with many keys being added + // + // avoiding a for-in loop here as it leads to the function + // being de-optimised (at least in V8). From some simple + // benchmarks the performance is comparable, but allowing + // V8 to optimize may mean easy performance wins in the future. + + if (this._str) { + return this._str + } + + var str = this.final ? '1' : '0', + labels = Object.keys(this.edges).sort(), + len = labels.length + + for (var i = 0; i < len; i++) { + var label = labels[i], + node = this.edges[label] + + str = str + label + node.id + } + + return str +} + +/** + * Returns a new TokenSet that is the intersection of + * this TokenSet and the passed TokenSet. + * + * This intersection will take into account any wildcards + * contained within the TokenSet. + * + * @param {lunr.TokenSet} b - An other TokenSet to intersect with. + * @returns {lunr.TokenSet} + */ +lunr.TokenSet.prototype.intersect = function (b) { + var output = new lunr.TokenSet, + frame = undefined + + var stack = [{ + qNode: b, + output: output, + node: this + }] + + while (stack.length) { + frame = stack.pop() + + // NOTE: As with the #toString method, we are using + // Object.keys and a for loop instead of a for-in loop + // as both of these objects enter 'hash' mode, causing + // the function to be de-optimised in V8 + var qEdges = Object.keys(frame.qNode.edges), + qLen = qEdges.length, + nEdges = Object.keys(frame.node.edges), + nLen = nEdges.length + + for (var q = 0; q < qLen; q++) { + var qEdge = qEdges[q] + + for (var n = 0; n < nLen; n++) { + var nEdge = nEdges[n] + + if (nEdge == qEdge || qEdge == '*') { + var node = frame.node.edges[nEdge], + qNode = frame.qNode.edges[qEdge], + final = node.final && qNode.final, + next = undefined + + if (nEdge in frame.output.edges) { + // an edge already exists for this character + // no need to create a new node, just set the finality + // bit unless this node is already final + next = frame.output.edges[nEdge] + next.final = next.final || final + + } else { + // no edge exists yet, must create one + // set the finality bit and insert it + // into the output + next = new lunr.TokenSet + next.final = final + frame.output.edges[nEdge] = next + } + + stack.push({ + qNode: qNode, + output: next, + node: node + }) + } + } + } + } + + return output +} +lunr.TokenSet.Builder = function () { + this.previousWord = "" + this.root = new lunr.TokenSet + this.uncheckedNodes = [] + this.minimizedNodes = {} +} + +lunr.TokenSet.Builder.prototype.insert = function (word) { + var node, + commonPrefix = 0 + + if (word < this.previousWord) { + throw new Error ("Out of order word insertion") + } + + for (var i = 0; i < word.length && i < this.previousWord.length; i++) { + if (word[i] != this.previousWord[i]) break + commonPrefix++ + } + + this.minimize(commonPrefix) + + if (this.uncheckedNodes.length == 0) { + node = this.root + } else { + node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child + } + + for (var i = commonPrefix; i < word.length; i++) { + var nextNode = new lunr.TokenSet, + char = word[i] + + node.edges[char] = nextNode + + this.uncheckedNodes.push({ + parent: node, + char: char, + child: nextNode + }) + + node = nextNode + } + + node.final = true + this.previousWord = word +} + +lunr.TokenSet.Builder.prototype.finish = function () { + this.minimize(0) +} + +lunr.TokenSet.Builder.prototype.minimize = function (downTo) { + for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) { + var node = this.uncheckedNodes[i], + childKey = node.child.toString() + + if (childKey in this.minimizedNodes) { + node.parent.edges[node.char] = this.minimizedNodes[childKey] + } else { + // Cache the key for this node since + // we know it can't change anymore + node.child._str = childKey + + this.minimizedNodes[childKey] = node.child + } + + this.uncheckedNodes.pop() + } +} +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * An index contains the built index of all documents and provides a query interface + * to the index. + * + * Usually instances of lunr.Index will not be created using this constructor, instead + * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be + * used to load previously built and serialized indexes. + * + * @constructor + * @param {Object} attrs - The attributes of the built search index. + * @param {Object} attrs.invertedIndex - An index of term/field to document reference. + * @param {Object} attrs.fieldVectors - Field vectors + * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens. + * @param {string[]} attrs.fields - The names of indexed document fields. + * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms. + */ +lunr.Index = function (attrs) { + this.invertedIndex = attrs.invertedIndex + this.fieldVectors = attrs.fieldVectors + this.tokenSet = attrs.tokenSet + this.fields = attrs.fields + this.pipeline = attrs.pipeline +} + +/** + * A result contains details of a document matching a search query. + * @typedef {Object} lunr.Index~Result + * @property {string} ref - The reference of the document this result represents. + * @property {number} score - A number between 0 and 1 representing how similar this document is to the query. + * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match. + */ + +/** + * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple + * query language which itself is parsed into an instance of lunr.Query. + * + * For programmatically building queries it is advised to directly use lunr.Query, the query language + * is best used for human entered text rather than program generated text. + * + * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported + * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello' + * or 'world', though those that contain both will rank higher in the results. + * + * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can + * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding + * wildcards will increase the number of documents that will be found but can also have a negative + * impact on query performance, especially with wildcards at the beginning of a term. + * + * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term + * hello in the title field will match this query. Using a field not present in the index will lead + * to an error being thrown. + * + * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term + * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported + * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2. + * Avoid large values for edit distance to improve query performance. + * + * Each term also supports a presence modifier. By default a term's presence in document is optional, however + * this can be changed to either required or prohibited. For a term's presence to be required in a document the + * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and + * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not + * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'. + * + * To escape special characters the backslash character '\' can be used, this allows searches to include + * characters that would normally be considered modifiers, e.g. `foo\~2` will search for a term "foo~2" instead + * of attempting to apply a boost of 2 to the search term "foo". + * + * @typedef {string} lunr.Index~QueryString + * @example Simple single term query + * hello + * @example Multiple term query + * hello world + * @example term scoped to a field + * title:hello + * @example term with a boost of 10 + * hello^10 + * @example term with an edit distance of 2 + * hello~2 + * @example terms with presence modifiers + * -foo +bar baz + */ + +/** + * Performs a search against the index using lunr query syntax. + * + * Results will be returned sorted by their score, the most relevant results + * will be returned first. For details on how the score is calculated, please see + * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}. + * + * For more programmatic querying use lunr.Index#query. + * + * @param {lunr.Index~QueryString} queryString - A string containing a lunr query. + * @throws {lunr.QueryParseError} If the passed query string cannot be parsed. + * @returns {lunr.Index~Result[]} + */ +lunr.Index.prototype.search = function (queryString) { + return this.query(function (query) { + var parser = new lunr.QueryParser(queryString, query) + parser.parse() + }) +} + +/** + * A query builder callback provides a query object to be used to express + * the query to perform on the index. + * + * @callback lunr.Index~queryBuilder + * @param {lunr.Query} query - The query object to build up. + * @this lunr.Query + */ + +/** + * Performs a query against the index using the yielded lunr.Query object. + * + * If performing programmatic queries against the index, this method is preferred + * over lunr.Index#search so as to avoid the additional query parsing overhead. + * + * A query object is yielded to the supplied function which should be used to + * express the query to be run against the index. + * + * Note that although this function takes a callback parameter it is _not_ an + * asynchronous operation, the callback is just yielded a query object to be + * customized. + * + * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query. + * @returns {lunr.Index~Result[]} + */ +lunr.Index.prototype.query = function (fn) { + // for each query clause + // * process terms + // * expand terms from token set + // * find matching documents and metadata + // * get document vectors + // * score documents + + var query = new lunr.Query(this.fields), + matchingFields = Object.create(null), + queryVectors = Object.create(null), + termFieldCache = Object.create(null), + requiredMatches = Object.create(null), + prohibitedMatches = Object.create(null) + + /* + * To support field level boosts a query vector is created per + * field. An empty vector is eagerly created to support negated + * queries. + */ + for (var i = 0; i < this.fields.length; i++) { + queryVectors[this.fields[i]] = new lunr.Vector + } + + fn.call(query, query) + + for (var i = 0; i < query.clauses.length; i++) { + /* + * Unless the pipeline has been disabled for this term, which is + * the case for terms with wildcards, we need to pass the clause + * term through the search pipeline. A pipeline returns an array + * of processed terms. Pipeline functions may expand the passed + * term, which means we may end up performing multiple index lookups + * for a single query term. + */ + var clause = query.clauses[i], + terms = null, + clauseMatches = lunr.Set.empty + + if (clause.usePipeline) { + terms = this.pipeline.runString(clause.term, { + fields: clause.fields + }) + } else { + terms = [clause.term] + } + + for (var m = 0; m < terms.length; m++) { + var term = terms[m] + + /* + * Each term returned from the pipeline needs to use the same query + * clause object, e.g. the same boost and or edit distance. The + * simplest way to do this is to re-use the clause object but mutate + * its term property. + */ + clause.term = term + + /* + * From the term in the clause we create a token set which will then + * be used to intersect the indexes token set to get a list of terms + * to lookup in the inverted index + */ + var termTokenSet = lunr.TokenSet.fromClause(clause), + expandedTerms = this.tokenSet.intersect(termTokenSet).toArray() + + /* + * If a term marked as required does not exist in the tokenSet it is + * impossible for the search to return any matches. We set all the field + * scoped required matches set to empty and stop examining any further + * clauses. + */ + if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) { + for (var k = 0; k < clause.fields.length; k++) { + var field = clause.fields[k] + requiredMatches[field] = lunr.Set.empty + } + + break + } + + for (var j = 0; j < expandedTerms.length; j++) { + /* + * For each term get the posting and termIndex, this is required for + * building the query vector. + */ + var expandedTerm = expandedTerms[j], + posting = this.invertedIndex[expandedTerm], + termIndex = posting._index + + for (var k = 0; k < clause.fields.length; k++) { + /* + * For each field that this query term is scoped by (by default + * all fields are in scope) we need to get all the document refs + * that have this term in that field. + * + * The posting is the entry in the invertedIndex for the matching + * term from above. + */ + var field = clause.fields[k], + fieldPosting = posting[field], + matchingDocumentRefs = Object.keys(fieldPosting), + termField = expandedTerm + "/" + field, + matchingDocumentsSet = new lunr.Set(matchingDocumentRefs) + + /* + * if the presence of this term is required ensure that the matching + * documents are added to the set of required matches for this clause. + * + */ + if (clause.presence == lunr.Query.presence.REQUIRED) { + clauseMatches = clauseMatches.union(matchingDocumentsSet) + + if (requiredMatches[field] === undefined) { + requiredMatches[field] = lunr.Set.complete + } + } + + /* + * if the presence of this term is prohibited ensure that the matching + * documents are added to the set of prohibited matches for this field, + * creating that set if it does not yet exist. + */ + if (clause.presence == lunr.Query.presence.PROHIBITED) { + if (prohibitedMatches[field] === undefined) { + prohibitedMatches[field] = lunr.Set.empty + } + + prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet) + + /* + * Prohibited matches should not be part of the query vector used for + * similarity scoring and no metadata should be extracted so we continue + * to the next field + */ + continue + } + + /* + * The query field vector is populated using the termIndex found for + * the term and a unit value with the appropriate boost applied. + * Using upsert because there could already be an entry in the vector + * for the term we are working with. In that case we just add the scores + * together. + */ + queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b }) + + /** + * If we've already seen this term, field combo then we've already collected + * the matching documents and metadata, no need to go through all that again + */ + if (termFieldCache[termField]) { + continue + } + + for (var l = 0; l < matchingDocumentRefs.length; l++) { + /* + * All metadata for this term/field/document triple + * are then extracted and collected into an instance + * of lunr.MatchData ready to be returned in the query + * results + */ + var matchingDocumentRef = matchingDocumentRefs[l], + matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field), + metadata = fieldPosting[matchingDocumentRef], + fieldMatch + + if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) { + matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata) + } else { + fieldMatch.add(expandedTerm, field, metadata) + } + + } + + termFieldCache[termField] = true + } + } + } + + /** + * If the presence was required we need to update the requiredMatches field sets. + * We do this after all fields for the term have collected their matches because + * the clause terms presence is required in _any_ of the fields not _all_ of the + * fields. + */ + if (clause.presence === lunr.Query.presence.REQUIRED) { + for (var k = 0; k < clause.fields.length; k++) { + var field = clause.fields[k] + requiredMatches[field] = requiredMatches[field].intersect(clauseMatches) + } + } + } + + /** + * Need to combine the field scoped required and prohibited + * matching documents into a global set of required and prohibited + * matches + */ + var allRequiredMatches = lunr.Set.complete, + allProhibitedMatches = lunr.Set.empty + + for (var i = 0; i < this.fields.length; i++) { + var field = this.fields[i] + + if (requiredMatches[field]) { + allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field]) + } + + if (prohibitedMatches[field]) { + allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field]) + } + } + + var matchingFieldRefs = Object.keys(matchingFields), + results = [], + matches = Object.create(null) + + /* + * If the query is negated (contains only prohibited terms) + * we need to get _all_ fieldRefs currently existing in the + * index. This is only done when we know that the query is + * entirely prohibited terms to avoid any cost of getting all + * fieldRefs unnecessarily. + * + * Additionally, blank MatchData must be created to correctly + * populate the results. + */ + if (query.isNegated()) { + matchingFieldRefs = Object.keys(this.fieldVectors) + + for (var i = 0; i < matchingFieldRefs.length; i++) { + var matchingFieldRef = matchingFieldRefs[i] + var fieldRef = lunr.FieldRef.fromString(matchingFieldRef) + matchingFields[matchingFieldRef] = new lunr.MatchData + } + } + + for (var i = 0; i < matchingFieldRefs.length; i++) { + /* + * Currently we have document fields that match the query, but we + * need to return documents. The matchData and scores are combined + * from multiple fields belonging to the same document. + * + * Scores are calculated by field, using the query vectors created + * above, and combined into a final document score using addition. + */ + var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]), + docRef = fieldRef.docRef + + if (!allRequiredMatches.contains(docRef)) { + continue + } + + if (allProhibitedMatches.contains(docRef)) { + continue + } + + var fieldVector = this.fieldVectors[fieldRef], + score = queryVectors[fieldRef.fieldName].similarity(fieldVector), + docMatch + + if ((docMatch = matches[docRef]) !== undefined) { + docMatch.score += score + docMatch.matchData.combine(matchingFields[fieldRef]) + } else { + var match = { + ref: docRef, + score: score, + matchData: matchingFields[fieldRef] + } + matches[docRef] = match + results.push(match) + } + } + + /* + * Sort the results objects by score, highest first. + */ + return results.sort(function (a, b) { + return b.score - a.score + }) +} + +/** + * Prepares the index for JSON serialization. + * + * The schema for this JSON blob will be described in a + * separate JSON schema file. + * + * @returns {Object} + */ +lunr.Index.prototype.toJSON = function () { + var invertedIndex = Object.keys(this.invertedIndex) + .sort() + .map(function (term) { + return [term, this.invertedIndex[term]] + }, this) + + var fieldVectors = Object.keys(this.fieldVectors) + .map(function (ref) { + return [ref, this.fieldVectors[ref].toJSON()] + }, this) + + return { + version: lunr.version, + fields: this.fields, + fieldVectors: fieldVectors, + invertedIndex: invertedIndex, + pipeline: this.pipeline.toJSON() + } +} + +/** + * Loads a previously serialized lunr.Index + * + * @param {Object} serializedIndex - A previously serialized lunr.Index + * @returns {lunr.Index} + */ +lunr.Index.load = function (serializedIndex) { + var attrs = {}, + fieldVectors = {}, + serializedVectors = serializedIndex.fieldVectors, + invertedIndex = Object.create(null), + serializedInvertedIndex = serializedIndex.invertedIndex, + tokenSetBuilder = new lunr.TokenSet.Builder, + pipeline = lunr.Pipeline.load(serializedIndex.pipeline) + + if (serializedIndex.version != lunr.version) { + lunr.utils.warn("Version mismatch when loading serialised index. Current version of lunr '" + lunr.version + "' does not match serialized index '" + serializedIndex.version + "'") + } + + for (var i = 0; i < serializedVectors.length; i++) { + var tuple = serializedVectors[i], + ref = tuple[0], + elements = tuple[1] + + fieldVectors[ref] = new lunr.Vector(elements) + } + + for (var i = 0; i < serializedInvertedIndex.length; i++) { + var tuple = serializedInvertedIndex[i], + term = tuple[0], + posting = tuple[1] + + tokenSetBuilder.insert(term) + invertedIndex[term] = posting + } + + tokenSetBuilder.finish() + + attrs.fields = serializedIndex.fields + + attrs.fieldVectors = fieldVectors + attrs.invertedIndex = invertedIndex + attrs.tokenSet = tokenSetBuilder.root + attrs.pipeline = pipeline + + return new lunr.Index(attrs) +} +/*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ + +/** + * lunr.Builder performs indexing on a set of documents and + * returns instances of lunr.Index ready for querying. + * + * All configuration of the index is done via the builder, the + * fields to index, the document reference, the text processing + * pipeline and document scoring parameters are all set on the + * builder before indexing. + * + * @constructor + * @property {string} _ref - Internal reference to the document reference field. + * @property {string[]} _fields - Internal reference to the document fields to index. + * @property {object} invertedIndex - The inverted index maps terms to document fields. + * @property {object} documentTermFrequencies - Keeps track of document term frequencies. + * @property {object} documentLengths - Keeps track of the length of documents added to the index. + * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing. + * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing. + * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index. + * @property {number} documentCount - Keeps track of the total number of documents indexed. + * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75. + * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2. + * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space. + * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index. + */ +lunr.Builder = function () { + this._ref = "id" + this._fields = Object.create(null) + this._documents = Object.create(null) + this.invertedIndex = Object.create(null) + this.fieldTermFrequencies = {} + this.fieldLengths = {} + this.tokenizer = lunr.tokenizer + this.pipeline = new lunr.Pipeline + this.searchPipeline = new lunr.Pipeline + this.documentCount = 0 + this._b = 0.75 + this._k1 = 1.2 + this.termIndex = 0 + this.metadataWhitelist = [] +} + +/** + * Sets the document field used as the document reference. Every document must have this field. + * The type of this field in the document should be a string, if it is not a string it will be + * coerced into a string by calling toString. + * + * The default ref is 'id'. + * + * The ref should _not_ be changed during indexing, it should be set before any documents are + * added to the index. Changing it during indexing can lead to inconsistent results. + * + * @param {string} ref - The name of the reference field in the document. + */ +lunr.Builder.prototype.ref = function (ref) { + this._ref = ref +} + +/** + * A function that is used to extract a field from a document. + * + * Lunr expects a field to be at the top level of a document, if however the field + * is deeply nested within a document an extractor function can be used to extract + * the right field for indexing. + * + * @callback fieldExtractor + * @param {object} doc - The document being added to the index. + * @returns {?(string|object|object[])} obj - The object that will be indexed for this field. + * @example Extracting a nested field + * function (doc) { return doc.nested.field } + */ + +/** + * Adds a field to the list of document fields that will be indexed. Every document being + * indexed should have this field. Null values for this field in indexed documents will + * not cause errors but will limit the chance of that document being retrieved by searches. + * + * All fields should be added before adding documents to the index. Adding fields after + * a document has been indexed will have no effect on already indexed documents. + * + * Fields can be boosted at build time. This allows terms within that field to have more + * importance when ranking search results. Use a field boost to specify that matches within + * one field are more important than other fields. + * + * @param {string} fieldName - The name of a field to index in all documents. + * @param {object} attributes - Optional attributes associated with this field. + * @param {number} [attributes.boost=1] - Boost applied to all terms within this field. + * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document. + * @throws {RangeError} fieldName cannot contain unsupported characters '/' + */ +lunr.Builder.prototype.field = function (fieldName, attributes) { + if (/\//.test(fieldName)) { + throw new RangeError ("Field '" + fieldName + "' contains illegal character '/'") + } + + this._fields[fieldName] = attributes || {} +} + +/** + * A parameter to tune the amount of field length normalisation that is applied when + * calculating relevance scores. A value of 0 will completely disable any normalisation + * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b + * will be clamped to the range 0 - 1. + * + * @param {number} number - The value to set for this tuning parameter. + */ +lunr.Builder.prototype.b = function (number) { + if (number < 0) { + this._b = 0 + } else if (number > 1) { + this._b = 1 + } else { + this._b = number + } +} + +/** + * A parameter that controls the speed at which a rise in term frequency results in term + * frequency saturation. The default value is 1.2. Setting this to a higher value will give + * slower saturation levels, a lower value will result in quicker saturation. + * + * @param {number} number - The value to set for this tuning parameter. + */ +lunr.Builder.prototype.k1 = function (number) { + this._k1 = number +} + +/** + * Adds a document to the index. + * + * Before adding fields to the index the index should have been fully setup, with the document + * ref and all fields to index already having been specified. + * + * The document must have a field name as specified by the ref (by default this is 'id') and + * it should have all fields defined for indexing, though null or undefined values will not + * cause errors. + * + * Entire documents can be boosted at build time. Applying a boost to a document indicates that + * this document should rank higher in search results than other documents. + * + * @param {object} doc - The document to add to the index. + * @param {object} attributes - Optional attributes associated with this document. + * @param {number} [attributes.boost=1] - Boost applied to all terms within this document. + */ +lunr.Builder.prototype.add = function (doc, attributes) { + var docRef = doc[this._ref], + fields = Object.keys(this._fields) + + this._documents[docRef] = attributes || {} + this.documentCount += 1 + + for (var i = 0; i < fields.length; i++) { + var fieldName = fields[i], + extractor = this._fields[fieldName].extractor, + field = extractor ? extractor(doc) : doc[fieldName], + tokens = this.tokenizer(field, { + fields: [fieldName] + }), + terms = this.pipeline.run(tokens), + fieldRef = new lunr.FieldRef (docRef, fieldName), + fieldTerms = Object.create(null) + + this.fieldTermFrequencies[fieldRef] = fieldTerms + this.fieldLengths[fieldRef] = 0 + + // store the length of this field for this document + this.fieldLengths[fieldRef] += terms.length + + // calculate term frequencies for this field + for (var j = 0; j < terms.length; j++) { + var term = terms[j] + + if (fieldTerms[term] == undefined) { + fieldTerms[term] = 0 + } + + fieldTerms[term] += 1 + + // add to inverted index + // create an initial posting if one doesn't exist + if (this.invertedIndex[term] == undefined) { + var posting = Object.create(null) + posting["_index"] = this.termIndex + this.termIndex += 1 + + for (var k = 0; k < fields.length; k++) { + posting[fields[k]] = Object.create(null) + } + + this.invertedIndex[term] = posting + } + + // add an entry for this term/fieldName/docRef to the invertedIndex + if (this.invertedIndex[term][fieldName][docRef] == undefined) { + this.invertedIndex[term][fieldName][docRef] = Object.create(null) + } + + // store all whitelisted metadata about this token in the + // inverted index + for (var l = 0; l < this.metadataWhitelist.length; l++) { + var metadataKey = this.metadataWhitelist[l], + metadata = term.metadata[metadataKey] + + if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) { + this.invertedIndex[term][fieldName][docRef][metadataKey] = [] + } + + this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata) + } + } + + } +} + +/** + * Calculates the average document length for this index + * + * @private + */ +lunr.Builder.prototype.calculateAverageFieldLengths = function () { + + var fieldRefs = Object.keys(this.fieldLengths), + numberOfFields = fieldRefs.length, + accumulator = {}, + documentsWithField = {} + + for (var i = 0; i < numberOfFields; i++) { + var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]), + field = fieldRef.fieldName + + documentsWithField[field] || (documentsWithField[field] = 0) + documentsWithField[field] += 1 + + accumulator[field] || (accumulator[field] = 0) + accumulator[field] += this.fieldLengths[fieldRef] + } + + var fields = Object.keys(this._fields) + + for (var i = 0; i < fields.length; i++) { + var fieldName = fields[i] + accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName] + } + + this.averageFieldLength = accumulator +} + +/** + * Builds a vector space model of every document using lunr.Vector + * + * @private + */ +lunr.Builder.prototype.createFieldVectors = function () { + var fieldVectors = {}, + fieldRefs = Object.keys(this.fieldTermFrequencies), + fieldRefsLength = fieldRefs.length, + termIdfCache = Object.create(null) + + for (var i = 0; i < fieldRefsLength; i++) { + var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]), + fieldName = fieldRef.fieldName, + fieldLength = this.fieldLengths[fieldRef], + fieldVector = new lunr.Vector, + termFrequencies = this.fieldTermFrequencies[fieldRef], + terms = Object.keys(termFrequencies), + termsLength = terms.length + + + var fieldBoost = this._fields[fieldName].boost || 1, + docBoost = this._documents[fieldRef.docRef].boost || 1 + + for (var j = 0; j < termsLength; j++) { + var term = terms[j], + tf = termFrequencies[term], + termIndex = this.invertedIndex[term]._index, + idf, score, scoreWithPrecision + + if (termIdfCache[term] === undefined) { + idf = lunr.idf(this.invertedIndex[term], this.documentCount) + termIdfCache[term] = idf + } else { + idf = termIdfCache[term] + } + + score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf) + score *= fieldBoost + score *= docBoost + scoreWithPrecision = Math.round(score * 1000) / 1000 + // Converts 1.23456789 to 1.234. + // Reducing the precision so that the vectors take up less + // space when serialised. Doing it now so that they behave + // the same before and after serialisation. Also, this is + // the fastest approach to reducing a number's precision in + // JavaScript. + + fieldVector.insert(termIndex, scoreWithPrecision) + } + + fieldVectors[fieldRef] = fieldVector + } + + this.fieldVectors = fieldVectors +} + +/** + * Creates a token set of all tokens in the index using lunr.TokenSet + * + * @private + */ +lunr.Builder.prototype.createTokenSet = function () { + this.tokenSet = lunr.TokenSet.fromArray( + Object.keys(this.invertedIndex).sort() + ) +} + +/** + * Builds the index, creating an instance of lunr.Index. + * + * This completes the indexing process and should only be called + * once all documents have been added to the index. + * + * @returns {lunr.Index} + */ +lunr.Builder.prototype.build = function () { + this.calculateAverageFieldLengths() + this.createFieldVectors() + this.createTokenSet() + + return new lunr.Index({ + invertedIndex: this.invertedIndex, + fieldVectors: this.fieldVectors, + tokenSet: this.tokenSet, + fields: Object.keys(this._fields), + pipeline: this.searchPipeline + }) +} + +/** + * Applies a plugin to the index builder. + * + * A plugin is a function that is called with the index builder as its context. + * Plugins can be used to customise or extend the behaviour of the index + * in some way. A plugin is just a function, that encapsulated the custom + * behaviour that should be applied when building the index. + * + * The plugin function will be called with the index builder as its argument, additional + * arguments can also be passed when calling use. The function will be called + * with the index builder as its context. + * + * @param {Function} plugin The plugin to apply. + */ +lunr.Builder.prototype.use = function (fn) { + var args = Array.prototype.slice.call(arguments, 1) + args.unshift(this) + fn.apply(this, args) +} +/** + * Contains and collects metadata about a matching document. + * A single instance of lunr.MatchData is returned as part of every + * lunr.Index~Result. + * + * @constructor + * @param {string} term - The term this match data is associated with + * @param {string} field - The field in which the term was found + * @param {object} metadata - The metadata recorded about this term in this field + * @property {object} metadata - A cloned collection of metadata associated with this document. + * @see {@link lunr.Index~Result} + */ +lunr.MatchData = function (term, field, metadata) { + var clonedMetadata = Object.create(null), + metadataKeys = Object.keys(metadata || {}) + + // Cloning the metadata to prevent the original + // being mutated during match data combination. + // Metadata is kept in an array within the inverted + // index so cloning the data can be done with + // Array#slice + for (var i = 0; i < metadataKeys.length; i++) { + var key = metadataKeys[i] + clonedMetadata[key] = metadata[key].slice() + } + + this.metadata = Object.create(null) + + if (term !== undefined) { + this.metadata[term] = Object.create(null) + this.metadata[term][field] = clonedMetadata + } +} + +/** + * An instance of lunr.MatchData will be created for every term that matches a + * document. However only one instance is required in a lunr.Index~Result. This + * method combines metadata from another instance of lunr.MatchData with this + * objects metadata. + * + * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one. + * @see {@link lunr.Index~Result} + */ +lunr.MatchData.prototype.combine = function (otherMatchData) { + var terms = Object.keys(otherMatchData.metadata) + + for (var i = 0; i < terms.length; i++) { + var term = terms[i], + fields = Object.keys(otherMatchData.metadata[term]) + + if (this.metadata[term] == undefined) { + this.metadata[term] = Object.create(null) + } + + for (var j = 0; j < fields.length; j++) { + var field = fields[j], + keys = Object.keys(otherMatchData.metadata[term][field]) + + if (this.metadata[term][field] == undefined) { + this.metadata[term][field] = Object.create(null) + } + + for (var k = 0; k < keys.length; k++) { + var key = keys[k] + + if (this.metadata[term][field][key] == undefined) { + this.metadata[term][field][key] = otherMatchData.metadata[term][field][key] + } else { + this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key]) + } + + } + } + } +} + +/** + * Add metadata for a term/field pair to this instance of match data. + * + * @param {string} term - The term this match data is associated with + * @param {string} field - The field in which the term was found + * @param {object} metadata - The metadata recorded about this term in this field + */ +lunr.MatchData.prototype.add = function (term, field, metadata) { + if (!(term in this.metadata)) { + this.metadata[term] = Object.create(null) + this.metadata[term][field] = metadata + return + } + + if (!(field in this.metadata[term])) { + this.metadata[term][field] = metadata + return + } + + var metadataKeys = Object.keys(metadata) + + for (var i = 0; i < metadataKeys.length; i++) { + var key = metadataKeys[i] + + if (key in this.metadata[term][field]) { + this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key]) + } else { + this.metadata[term][field][key] = metadata[key] + } + } +} +/** + * A lunr.Query provides a programmatic way of defining queries to be performed + * against a {@link lunr.Index}. + * + * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method + * so the query object is pre-initialized with the right index fields. + * + * @constructor + * @property {lunr.Query~Clause[]} clauses - An array of query clauses. + * @property {string[]} allFields - An array of all available fields in a lunr.Index. + */ +lunr.Query = function (allFields) { + this.clauses = [] + this.allFields = allFields +} + +/** + * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause. + * + * This allows wildcards to be added to the beginning and end of a term without having to manually do any string + * concatenation. + * + * The wildcard constants can be bitwise combined to select both leading and trailing wildcards. + * + * @constant + * @default + * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour + * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists + * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists + * @see lunr.Query~Clause + * @see lunr.Query#clause + * @see lunr.Query#term + * @example query term with trailing wildcard + * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING }) + * @example query term with leading and trailing wildcard + * query.term('foo', { + * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING + * }) + */ + +lunr.Query.wildcard = new String ("*") +lunr.Query.wildcard.NONE = 0 +lunr.Query.wildcard.LEADING = 1 +lunr.Query.wildcard.TRAILING = 2 + +/** + * Constants for indicating what kind of presence a term must have in matching documents. + * + * @constant + * @enum {number} + * @see lunr.Query~Clause + * @see lunr.Query#clause + * @see lunr.Query#term + * @example query term with required presence + * query.term('foo', { presence: lunr.Query.presence.REQUIRED }) + */ +lunr.Query.presence = { + /** + * Term's presence in a document is optional, this is the default value. + */ + OPTIONAL: 1, + + /** + * Term's presence in a document is required, documents that do not contain + * this term will not be returned. + */ + REQUIRED: 2, + + /** + * Term's presence in a document is prohibited, documents that do contain + * this term will not be returned. + */ + PROHIBITED: 3 +} + +/** + * A single clause in a {@link lunr.Query} contains a term and details on how to + * match that term against a {@link lunr.Index}. + * + * @typedef {Object} lunr.Query~Clause + * @property {string[]} fields - The fields in an index this clause should be matched against. + * @property {number} [boost=1] - Any boost that should be applied when matching this clause. + * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be. + * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline. + * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended. + * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents. + */ + +/** + * Adds a {@link lunr.Query~Clause} to this query. + * + * Unless the clause contains the fields to be matched all fields will be matched. In addition + * a default boost of 1 is applied to the clause. + * + * @param {lunr.Query~Clause} clause - The clause to add to this query. + * @see lunr.Query~Clause + * @returns {lunr.Query} + */ +lunr.Query.prototype.clause = function (clause) { + if (!('fields' in clause)) { + clause.fields = this.allFields + } + + if (!('boost' in clause)) { + clause.boost = 1 + } + + if (!('usePipeline' in clause)) { + clause.usePipeline = true + } + + if (!('wildcard' in clause)) { + clause.wildcard = lunr.Query.wildcard.NONE + } + + if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) { + clause.term = "*" + clause.term + } + + if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) { + clause.term = "" + clause.term + "*" + } + + if (!('presence' in clause)) { + clause.presence = lunr.Query.presence.OPTIONAL + } + + this.clauses.push(clause) + + return this +} + +/** + * A negated query is one in which every clause has a presence of + * prohibited. These queries require some special processing to return + * the expected results. + * + * @returns boolean + */ +lunr.Query.prototype.isNegated = function () { + for (var i = 0; i < this.clauses.length; i++) { + if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) { + return false + } + } + + return true +} + +/** + * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause} + * to the list of clauses that make up this query. + * + * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion + * to a token or token-like string should be done before calling this method. + * + * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an + * array, each term in the array will share the same options. + * + * @param {object|object[]} term - The term(s) to add to the query. + * @param {object} [options] - Any additional properties to add to the query clause. + * @returns {lunr.Query} + * @see lunr.Query#clause + * @see lunr.Query~Clause + * @example adding a single term to a query + * query.term("foo") + * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard + * query.term("foo", { + * fields: ["title"], + * boost: 10, + * wildcard: lunr.Query.wildcard.TRAILING + * }) + * @example using lunr.tokenizer to convert a string to tokens before using them as terms + * query.term(lunr.tokenizer("foo bar")) + */ +lunr.Query.prototype.term = function (term, options) { + if (Array.isArray(term)) { + term.forEach(function (t) { this.term(t, lunr.utils.clone(options)) }, this) + return this + } + + var clause = options || {} + clause.term = term.toString() + + this.clause(clause) + + return this +} +lunr.QueryParseError = function (message, start, end) { + this.name = "QueryParseError" + this.message = message + this.start = start + this.end = end +} + +lunr.QueryParseError.prototype = new Error +lunr.QueryLexer = function (str) { + this.lexemes = [] + this.str = str + this.length = str.length + this.pos = 0 + this.start = 0 + this.escapeCharPositions = [] +} + +lunr.QueryLexer.prototype.run = function () { + var state = lunr.QueryLexer.lexText + + while (state) { + state = state(this) + } +} + +lunr.QueryLexer.prototype.sliceString = function () { + var subSlices = [], + sliceStart = this.start, + sliceEnd = this.pos + + for (var i = 0; i < this.escapeCharPositions.length; i++) { + sliceEnd = this.escapeCharPositions[i] + subSlices.push(this.str.slice(sliceStart, sliceEnd)) + sliceStart = sliceEnd + 1 + } + + subSlices.push(this.str.slice(sliceStart, this.pos)) + this.escapeCharPositions.length = 0 + + return subSlices.join('') +} + +lunr.QueryLexer.prototype.emit = function (type) { + this.lexemes.push({ + type: type, + str: this.sliceString(), + start: this.start, + end: this.pos + }) + + this.start = this.pos +} + +lunr.QueryLexer.prototype.escapeCharacter = function () { + this.escapeCharPositions.push(this.pos - 1) + this.pos += 1 +} + +lunr.QueryLexer.prototype.next = function () { + if (this.pos >= this.length) { + return lunr.QueryLexer.EOS + } + + var char = this.str.charAt(this.pos) + this.pos += 1 + return char +} + +lunr.QueryLexer.prototype.width = function () { + return this.pos - this.start +} + +lunr.QueryLexer.prototype.ignore = function () { + if (this.start == this.pos) { + this.pos += 1 + } + + this.start = this.pos +} + +lunr.QueryLexer.prototype.backup = function () { + this.pos -= 1 +} + +lunr.QueryLexer.prototype.acceptDigitRun = function () { + var char, charCode + + do { + char = this.next() + charCode = char.charCodeAt(0) + } while (charCode > 47 && charCode < 58) + + if (char != lunr.QueryLexer.EOS) { + this.backup() + } +} + +lunr.QueryLexer.prototype.more = function () { + return this.pos < this.length +} + +lunr.QueryLexer.EOS = 'EOS' +lunr.QueryLexer.FIELD = 'FIELD' +lunr.QueryLexer.TERM = 'TERM' +lunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE' +lunr.QueryLexer.BOOST = 'BOOST' +lunr.QueryLexer.PRESENCE = 'PRESENCE' + +lunr.QueryLexer.lexField = function (lexer) { + lexer.backup() + lexer.emit(lunr.QueryLexer.FIELD) + lexer.ignore() + return lunr.QueryLexer.lexText +} + +lunr.QueryLexer.lexTerm = function (lexer) { + if (lexer.width() > 1) { + lexer.backup() + lexer.emit(lunr.QueryLexer.TERM) + } + + lexer.ignore() + + if (lexer.more()) { + return lunr.QueryLexer.lexText + } +} + +lunr.QueryLexer.lexEditDistance = function (lexer) { + lexer.ignore() + lexer.acceptDigitRun() + lexer.emit(lunr.QueryLexer.EDIT_DISTANCE) + return lunr.QueryLexer.lexText +} + +lunr.QueryLexer.lexBoost = function (lexer) { + lexer.ignore() + lexer.acceptDigitRun() + lexer.emit(lunr.QueryLexer.BOOST) + return lunr.QueryLexer.lexText +} + +lunr.QueryLexer.lexEOS = function (lexer) { + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } +} + +// This matches the separator used when tokenising fields +// within a document. These should match otherwise it is +// not possible to search for some tokens within a document. +// +// It is possible for the user to change the separator on the +// tokenizer so it _might_ clash with any other of the special +// characters already used within the search string, e.g. :. +// +// This means that it is possible to change the separator in +// such a way that makes some words unsearchable using a search +// string. +lunr.QueryLexer.termSeparator = lunr.tokenizer.separator + +lunr.QueryLexer.lexText = function (lexer) { + while (true) { + var char = lexer.next() + + if (char == lunr.QueryLexer.EOS) { + return lunr.QueryLexer.lexEOS + } + + // Escape character is '\' + if (char.charCodeAt(0) == 92) { + lexer.escapeCharacter() + continue + } + + if (char == ":") { + return lunr.QueryLexer.lexField + } + + if (char == "~") { + lexer.backup() + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } + return lunr.QueryLexer.lexEditDistance + } + + if (char == "^") { + lexer.backup() + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM) + } + return lunr.QueryLexer.lexBoost + } + + // "+" indicates term presence is required + // checking for length to ensure that only + // leading "+" are considered + if (char == "+" && lexer.width() === 1) { + lexer.emit(lunr.QueryLexer.PRESENCE) + return lunr.QueryLexer.lexText + } + + // "-" indicates term presence is prohibited + // checking for length to ensure that only + // leading "-" are considered + if (char == "-" && lexer.width() === 1) { + lexer.emit(lunr.QueryLexer.PRESENCE) + return lunr.QueryLexer.lexText + } + + if (char.match(lunr.QueryLexer.termSeparator)) { + return lunr.QueryLexer.lexTerm + } + } +} + +lunr.QueryParser = function (str, query) { + this.lexer = new lunr.QueryLexer (str) + this.query = query + this.currentClause = {} + this.lexemeIdx = 0 +} + +lunr.QueryParser.prototype.parse = function () { + this.lexer.run() + this.lexemes = this.lexer.lexemes + + var state = lunr.QueryParser.parseClause + + while (state) { + state = state(this) + } + + return this.query +} + +lunr.QueryParser.prototype.peekLexeme = function () { + return this.lexemes[this.lexemeIdx] +} + +lunr.QueryParser.prototype.consumeLexeme = function () { + var lexeme = this.peekLexeme() + this.lexemeIdx += 1 + return lexeme +} + +lunr.QueryParser.prototype.nextClause = function () { + var completedClause = this.currentClause + this.query.clause(completedClause) + this.currentClause = {} +} + +lunr.QueryParser.parseClause = function (parser) { + var lexeme = parser.peekLexeme() + + if (lexeme == undefined) { + return + } + + switch (lexeme.type) { + case lunr.QueryLexer.PRESENCE: + return lunr.QueryParser.parsePresence + case lunr.QueryLexer.FIELD: + return lunr.QueryParser.parseField + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expected either a field or a term, found " + lexeme.type + + if (lexeme.str.length >= 1) { + errorMessage += " with value '" + lexeme.str + "'" + } + + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } +} + +lunr.QueryParser.parsePresence = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + switch (lexeme.str) { + case "-": + parser.currentClause.presence = lunr.Query.presence.PROHIBITED + break + case "+": + parser.currentClause.presence = lunr.Query.presence.REQUIRED + break + default: + var errorMessage = "unrecognised presence operator'" + lexeme.str + "'" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + var errorMessage = "expecting term or field, found nothing" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.FIELD: + return lunr.QueryParser.parseField + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expecting term or field, found '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseField = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + if (parser.query.allFields.indexOf(lexeme.str) == -1) { + var possibleFields = parser.query.allFields.map(function (f) { return "'" + f + "'" }).join(', '), + errorMessage = "unrecognised field '" + lexeme.str + "', possible fields: " + possibleFields + + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.fields = [lexeme.str] + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + var errorMessage = "expecting term, found nothing" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expecting term, found '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseTerm = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + parser.currentClause.term = lexeme.str.toLowerCase() + + if (lexeme.str.indexOf("*") != -1) { + parser.currentClause.usePipeline = false + } + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseEditDistance = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + var editDistance = parseInt(lexeme.str, 10) + + if (isNaN(editDistance)) { + var errorMessage = "edit distance must be numeric" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.editDistance = editDistance + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + +lunr.QueryParser.parseBoost = function (parser) { + var lexeme = parser.consumeLexeme() + + if (lexeme == undefined) { + return + } + + var boost = parseInt(lexeme.str, 10) + + if (isNaN(boost)) { + var errorMessage = "boost must be numeric" + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.boost = boost + + var nextLexeme = parser.peekLexeme() + + if (nextLexeme == undefined) { + parser.nextClause() + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause() + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause() + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause() + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'" + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } +} + + /** + * export the module via AMD, CommonJS or as a browser global + * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js + */ + ;(function (root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(factory) + } else if (typeof exports === 'object') { + /** + * Node. Does not work with strict CommonJS, but + * only CommonJS-like enviroments that support module.exports, + * like Node. + */ + module.exports = factory() + } else { + // Browser globals (root is window) + root.lunr = factory() + } + }(this, function () { + /** + * Just return a value to define the module export. + * This example returns an object, but the module + * can return a function as the exported value. + */ + return lunr + })) +})(); diff --git a/search/main.js b/search/main.js new file mode 100644 index 0000000..a5e469d --- /dev/null +++ b/search/main.js @@ -0,0 +1,109 @@ +function getSearchTermFromLocation() { + var sPageURL = window.location.search.substring(1); + var sURLVariables = sPageURL.split('&'); + for (var i = 0; i < sURLVariables.length; i++) { + var sParameterName = sURLVariables[i].split('='); + if (sParameterName[0] == 'q') { + return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20')); + } + } +} + +function joinUrl (base, path) { + if (path.substring(0, 1) === "/") { + // path starts with `/`. Thus it is absolute. + return path; + } + if (base.substring(base.length-1) === "/") { + // base ends with `/` + return base + path; + } + return base + "/" + path; +} + +function escapeHtml (value) { + return value.replace(/&/g, '&') + .replace(/"/g, '"') + .replace(//g, '>'); +} + +function formatResult (location, title, summary) { + return ''; +} + +function displayResults (results) { + var search_results = document.getElementById("mkdocs-search-results"); + while (search_results.firstChild) { + search_results.removeChild(search_results.firstChild); + } + if (results.length > 0){ + for (var i=0; i < results.length; i++){ + var result = results[i]; + var html = formatResult(result.location, result.title, result.summary); + search_results.insertAdjacentHTML('beforeend', html); + } + } else { + var noResultsText = search_results.getAttribute('data-no-results-text'); + if (!noResultsText) { + noResultsText = "No results found"; + } + search_results.insertAdjacentHTML('beforeend', '

' + noResultsText + '

'); + } +} + +function doSearch () { + var query = document.getElementById('mkdocs-search-query').value; + if (query.length > min_search_length) { + if (!window.Worker) { + displayResults(search(query)); + } else { + searchWorker.postMessage({query: query}); + } + } else { + // Clear results for short queries + displayResults([]); + } +} + +function initSearch () { + var search_input = document.getElementById('mkdocs-search-query'); + if (search_input) { + search_input.addEventListener("keyup", doSearch); + } + var term = getSearchTermFromLocation(); + if (term) { + search_input.value = term; + doSearch(); + } +} + +function onWorkerMessage (e) { + if (e.data.allowSearch) { + initSearch(); + } else if (e.data.results) { + var results = e.data.results; + displayResults(results); + } else if (e.data.config) { + min_search_length = e.data.config.min_search_length-1; + } +} + +if (!window.Worker) { + console.log('Web Worker API not supported'); + // load index in main thread + $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { + console.log('Loaded worker'); + init(); + window.postMessage = function (msg) { + onWorkerMessage({data: msg}); + }; + }).fail(function (jqxhr, settings, exception) { + console.error('Could not load worker.js'); + }); +} else { + // Wrap search in a web worker + var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); + searchWorker.postMessage({init: true}); + searchWorker.onmessage = onWorkerMessage; +} diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 0000000..b31b3bc --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Elite Dangerous VoiceAttack Profiles \u00b6 These are various profiles for VoiceAttack (VA) I use to enhance my Elite experience. They give me important info, facilitate day-to-day gaming and do some special things for Fuel Rats and Hull Seals work. NOTE : Further development is on hold and Odyssey compatibility will not be worked on for the time being. See the corresponding issue on Github . This might or might not change after the Horizons/Odyssey merge. Feel free to file issues for anything that is broken on Odyssey and it will be worked on when it is worked on. Available Profiles \u00b6 EliteAttack : The main Elite VA profile. Anything related to \u201cjust\u201d playing the game. RatAttack : Manages interactions with the FuelRats IRC server. SpanshAttack : Plots and follows trips along the neutron highway using Spansh\u2019s neutron plotter . StreamAttack : Writes various status things to files that can then be read by streaming software like OBS. They all require the alterNERDtive-base profile that, well, provides basic functionality common to all of the above. Need Help / Want to Contribute? \u00b6 Well, you are in the right place. You can find comprehensive documentation right here. If you run into any errors, please make sure you are running the latest version of the profiles and all requirements . If your problem persists, please file an issue . Thanks! :) You can also say \u201cHi\u201d on Discord if that is your thing.","title":"Home"},{"location":"#elite-dangerous-voiceattack-profiles","text":"These are various profiles for VoiceAttack (VA) I use to enhance my Elite experience. They give me important info, facilitate day-to-day gaming and do some special things for Fuel Rats and Hull Seals work. NOTE : Further development is on hold and Odyssey compatibility will not be worked on for the time being. See the corresponding issue on Github . This might or might not change after the Horizons/Odyssey merge. Feel free to file issues for anything that is broken on Odyssey and it will be worked on when it is worked on.","title":"Elite Dangerous VoiceAttack Profiles"},{"location":"#available-profiles","text":"EliteAttack : The main Elite VA profile. Anything related to \u201cjust\u201d playing the game. RatAttack : Manages interactions with the FuelRats IRC server. SpanshAttack : Plots and follows trips along the neutron highway using Spansh\u2019s neutron plotter . StreamAttack : Writes various status things to files that can then be read by streaming software like OBS. They all require the alterNERDtive-base profile that, well, provides basic functionality common to all of the above.","title":"Available Profiles"},{"location":"#need-help-want-to-contribute","text":"Well, you are in the right place. You can find comprehensive documentation right here. If you run into any errors, please make sure you are running the latest version of the profiles and all requirements . If your problem persists, please file an issue . Thanks! :) You can also say \u201cHi\u201d on Discord if that is your thing.","title":"Need Help / Want to Contribute?"},{"location":"EliteAttack/","text":"EliteAttack \u00b6 This is my personal VoiceAttack profile for Elite: Dangerous. It started out ages ago as a modification of MalicVR\u2019s public profile , then looked less and less and less like that and I added and cleaned up a lot of things while removing the stuff I didn\u2019t use anyway. By now it would have probably been simpler to start from scratch. Funnily enough it has grown to rely way more on events provided by EDDI than actual voice commands. Chat Commands \u00b6 These commands will only work with the comms panel active, and you should be in the edit window ready to send. They will not hit Enter on their own. clear [chat;text] : Clears the chat window. Use from outside the comms panel. [local;squad;system;wing] chat : Puts you into the chosen chat channel. salute; oh seven : Will put \u201co7\u201d into the chat. Engineering/Materials \u00b6 how many [] do i have : Tells you how many of the given g5 manufactured material you currently have on board. I\u2019ve restricted it to just those to not spam speech recognition with too many phrases, and because those are the ones I usually want to know while jumping around the bubble and having an eye on any HGE that might be around. [launch;open] e d engineer : Opens the ED Engineer tool. what [mats;materials] do i need? : Runs the EDDI responder that tells you which materials are below wanted threshold. Needs setting those first. Gets very spammy if you do it for all of them; personally I only set them for g5 manufactured, so I can quickly check if it\u2019s worth looking for HGE in a system I\u2019m in. Navigation \u00b6 There are so many navigation-focused commands now, they deserve their own category. Basically anything that helps you plot anywhere. A lot of those are powered by awesome EDDI so I don\u2019t have to do the work myself! distance [from;to] [Sol;home;the center;Beagle Point;Colonia] : Gives you the current distance to the given POI. [find;target] nearest [encoded;manufactured;raw] material trader : Targets the nearest respective material trader. [find;target] nearest [fuel;scoopable] star : Targets the nearest scoopable star. [find;target] nearest [guardian;human] tech broker : Targets the nearest respective tech broker. [find;target] nearest [interstellar factor;mission system;scoopable star] : Well, you know the drill by now. [find;target] nearest mission system : Targets the nearest system that has a mission target. how many jumps left : Announces the jumps left on a neutron trip (requires SpanshAttack) or a course plotted via the galaxy map. plot course;[target;] next [waypoint;way point] : Plots a course to the text in your clipboard. target [bug killer;colonia;dav\u2019s hope;explorer\u2019s anchorage;jackson's lighthouse;jameson\u2019s cobra;robigo;shinrarta dezhra;sagittarius a*;shinrarta;sothis] : Targets the given system on the galaxy map. [where\u2019s;where is] my landing pad : Will tell you the location of your assigned landing pad on a starport. Ship Controls \u00b6 Basically anything that is related to directly doing something with your ship. [abort;cancel;stop] jumping : Stops a currently charging FSD jump. [half;] power to [engines;shields;systems;weapons] : Sets pips to 6/3/3 ( half ) or 8/2/2 towards the given capacitor. [balanced;half;] power to [engines;shields;systems;weapons] [and engines;and shields;and systems;and weapons;] : Sets pips to 6/6/0 (balanced), 5/5/2 (half) or 8/4/0 towards the given capacitors. [close;deploy;extend;open;retract;] [cargo scoop;hard points; landing gear] [up;down;] : Overly complicated command to handle everything related to Cargo Scoop, Hard Points, Landing Gear. You get the gist, I guess. Works in SRV too. [disco;discovery scan] : Executes a discovery scan. Expects the Discovery Scanner in your first fire group, secondary fire. You can change that . [dis;]engage silent running : Turns silent running on and off. [head;spot;] lights [on;off] : Turns your lights on and off. Works in SRV too, kinda; turning lights off there relies on the state updating fast enough, which sometimes leads to weird results. [jump;engage;get me out] [and scan;] [when ready;] : Retracts everything that might be protruding from your ship, then jumps to the next system. If the FSD isn\u2019t charging within 1s, it gets you into SC instead (e.g. if your target is obstructed). If given \u201cand scan\u201d runs a discovery scan. If given \u201cwhen ready\u201d waits for mass lock to clear, your FSD to cool down and you to leave scoop range before jumping. night vision [on;off] : Toggles your night vision on/off. Works in SRV too. rapid fire lights : Flashes your lights 5 times in a row. retract [all;everything] : Retracts, well, everything. [start;stop] [firing;mining] : Starts/stops holding down primary fire. Mostly useful when mining. When triggered with \u201cmining\u201d, also deploys the cargo scoop. [super;] cruise [when ready;] : Retracts everything, then jumps to SC. If given \u201cwhen ready\u201d will wait for mass lock to clear and your FSD to cool down first. SRV Controls \u00b6 Things relevant to your SRV, but not your ship. [recall;dismiss] ship : Recalls or dismisses ship. Currently does the same thing regardless of the state of your ship. I wish it would be possible to restrict it to doing one thing each, but that\u2019s currently not possible sadly. [toggle;enable;disable] drive assist : Handles all your drive assist needs! Targeting \u00b6 Well \u2026 targeting stuff, I guess. Not really sure why I made that its own category, but oh well :) target the [drive;drives;power plant;frame shift drive;f s d;shield generator] : Targets the given submodule on your current target, or your next target if you don\u2019t have one currently. Does not persist between targets. clear sub [module;system] target : Clears the current submodule target. target next system : Selects the next system on your route. target wing man [1;2;3] : Targets your wingmen. target\u2019s target : Targets your target\u2019s target (only works on wingmen). wing man [1;2;3] target : Targets your wingmen\u2019s target. wing man nav lock : Toggles wing man nav lock on the selected wing member. UI Commands \u00b6 Everything handling stuff that\u2019s not related to controlling your ship, but manipulating some UI element(s). [enter;leave] F S S : Opens/closes FSS. [main;game] menu : Opens the ESC menu. [relog;reset] to [open;solo] : Relogs to Open or Solo mode, respectively. controls options : Opens the controls options menu. docking request;request dock[ing;] : Sends a docking request. galaxy map : Opens the galaxy map. restart from Desktop : Quits the game and restarts from an open launcher by clicking the play button. set [default;star;station;settlement;signal sources;anomaly;unknown;system] filter : Sets a nav panel filter setting. See the command or just try different things for what is possible. You need to clear filters and hover over the filter button, then run this. system map : Opens the system map. take [high res;] screenshot : Takes a (high res) screenshot. toggle orbit lines : Toggles the visibility of orbit lines. Miscellaneous \u00b6 The commands in here do random more or less useful things. [are there any;] outdated stations [in this system;] : Runs an on-demand check for outdated stations in the current system. [bodies;what\u2019s;what is] left to [map;be mapped;scan] : Tells you which bodies EDDI thinks are worth mapping in the system that you haven\u2019t mapped yet. copy current system : Copies the current system name into the clipboard. open [current;] system on EDSM : Opens your current system on EDSM in your default browser. open copied system on EDSM : Opens the system in your clipboard on EDSM in your default browser. open coriolis : Opens Coriolis in your default browser. open e d d b [station;system;faction;] [search;] : Opens EDDB in your default browser. open e d s m : Opens EDSM in your default browser. open inara : Opens Inara in your default browser. open materials finder : Opens EDTutorials\u2019 materials finder in your default browser. open miner\u2019s tool : Opens https://edtools.cc/miner in your default browser. open spansh : Opens https://spansh.uk in your default browser. Events \u00b6 This is a list of ingame Events, provided by EDDI , that the profile will act on. AFMU Repairs \u00b6 Reports on the module that has been repaired, and if it has been fully or partially repaired. Body Mapped \u00b6 Announces an estimate for high-value bodies\u2019 payouts and the remaining mapping candidates in the system as given by EDDI. Body scanned \u00b6 Announces any interesting body traits found when scanning: terraformable Earth-like World, Ammonia World or Water World landable and >5\u202fg semimajor axis <1.5\u202fls (only really interesting for planets, but there\u2019s no proper way to separate them from moons, sadly) radius <300\u202fkm Feel free to suggest more! Carrier Cooldown \u00b6 Tells you when your carrier is able to do its next jump. Carrier Jump Engaged \u00b6 This event fires when your carrier jumps but you are not docked at it. It provides way less information than the Carrier Jumped event, but hey, I don\u2019t use most of it anyway. Basically just calls Carrier Jumped . Carrier Jump Request \u00b6 Announces the system and body your carrier has just been scheduled to jump to. Use this to double check ingame information; I\u2019ve had my carrier accept a body as jump target, but then end up around the star. This might give you a heads up on that. Also starts a command queue to give you advance warnings on carrier lockdown at -10, -5 and -2 minutes. Carrier Jumped \u00b6 Announces system and body your carrier has just jumped to. Carrier Pads Locked \u00b6 Announces your carrier\u2019s lockdown procedures. Discovery Scan \u00b6 Announces the number of bodies (and non-body signals) found in the system. Also compares the number of bodies to the amount reported by EDSM (requires Python scripts). Docked \u00b6 Automatically refuels, repairs, rearms, then gets your ship into the hangar and opens station services. Can be individually disabled. Docking Denied \u00b6 Tells you the reason for docking denial. Entered Normal Space \u00b6 Throttles to 0 upon dropping from SC, if the hyperspace dethrottle option is enabled. Fighter Launched \u00b6 Orders your ship to hold position so it doesn\u2019t chase after you immediately. Jet Cone Boost \u00b6 Sets your ship to full throttle immediately after you have supercharged. Jumped \u00b6 Zeroes throttle if the hyperspace dethrottle option is enabled. Gets the system\u2019s body count from EDSM if that option is enabled. Gets stations with outdated data (by default: older than 1 year) from Spansh\u2019s API. Again, if it is enabled. Starts a discovery scan if that is enabled. Last but not least tells you about planets worth scanning if you are on the R2R. Liftoff \u00b6 Retracts landing gear for you. Seriously, is there any occasion in which you don\u2019t immediately want to retract it after takeoff? Low Fuel \u00b6 Warns you when you reach 25% fuel. Also reports number of jumps you have left or the (rough) range you still have on the fumes left in your tank. Material Threshold \u00b6 Warns you when a monitored material falls below its minimum stock level and tells you when you reach your desired level or fill up. You will have to set minimum and desired amounts in EDDI\u2019s material monitor options first for all materials you wish to be monitored. Next Jump \u00b6 Gives you a jump count upon plotting a route using the galaxy map. Ship FSD \u00b6 This event actually is several different events in one. Currently the following are handled: Charging: Warns you if you are jumping with less than 25% fuel. Cooldown complete: Announces FSD cooldown if you are currently in normal space. Ship Interdicted \u00b6 Tells you when you have been interdicted by a player. Is also supposed to target the interdictor automatically, but randomly sometimes just doesn\u2019t work. Yay! SRV Launched \u00b6 Toggles SRV lights off after launching. Might not work if you drop particularly far after deployment because it works off a timer. Conversely might take a second to turn your lights off on a short drop and/or in high gravity. Synthesis \u00b6 Reports on the synthesis type and quality. System Scan Complete \u00b6 Lists all bodies EDDI considers worth mapping in the current system. Undocked \u00b6 Retracts landing gear for you. Seriously, is there any occasion in which you don\u2019t immediately want to retract it after takeoff?","title":"EliteAttack"},{"location":"EliteAttack/#eliteattack","text":"This is my personal VoiceAttack profile for Elite: Dangerous. It started out ages ago as a modification of MalicVR\u2019s public profile , then looked less and less and less like that and I added and cleaned up a lot of things while removing the stuff I didn\u2019t use anyway. By now it would have probably been simpler to start from scratch. Funnily enough it has grown to rely way more on events provided by EDDI than actual voice commands.","title":"EliteAttack"},{"location":"EliteAttack/#chat-commands","text":"These commands will only work with the comms panel active, and you should be in the edit window ready to send. They will not hit Enter on their own. clear [chat;text] : Clears the chat window. Use from outside the comms panel. [local;squad;system;wing] chat : Puts you into the chosen chat channel. salute; oh seven : Will put \u201co7\u201d into the chat.","title":"Chat Commands"},{"location":"EliteAttack/#engineeringmaterials","text":"how many [] do i have : Tells you how many of the given g5 manufactured material you currently have on board. I\u2019ve restricted it to just those to not spam speech recognition with too many phrases, and because those are the ones I usually want to know while jumping around the bubble and having an eye on any HGE that might be around. [launch;open] e d engineer : Opens the ED Engineer tool. what [mats;materials] do i need? : Runs the EDDI responder that tells you which materials are below wanted threshold. Needs setting those first. Gets very spammy if you do it for all of them; personally I only set them for g5 manufactured, so I can quickly check if it\u2019s worth looking for HGE in a system I\u2019m in.","title":"Engineering/Materials"},{"location":"EliteAttack/#navigation","text":"There are so many navigation-focused commands now, they deserve their own category. Basically anything that helps you plot anywhere. A lot of those are powered by awesome EDDI so I don\u2019t have to do the work myself! distance [from;to] [Sol;home;the center;Beagle Point;Colonia] : Gives you the current distance to the given POI. [find;target] nearest [encoded;manufactured;raw] material trader : Targets the nearest respective material trader. [find;target] nearest [fuel;scoopable] star : Targets the nearest scoopable star. [find;target] nearest [guardian;human] tech broker : Targets the nearest respective tech broker. [find;target] nearest [interstellar factor;mission system;scoopable star] : Well, you know the drill by now. [find;target] nearest mission system : Targets the nearest system that has a mission target. how many jumps left : Announces the jumps left on a neutron trip (requires SpanshAttack) or a course plotted via the galaxy map. plot course;[target;] next [waypoint;way point] : Plots a course to the text in your clipboard. target [bug killer;colonia;dav\u2019s hope;explorer\u2019s anchorage;jackson's lighthouse;jameson\u2019s cobra;robigo;shinrarta dezhra;sagittarius a*;shinrarta;sothis] : Targets the given system on the galaxy map. [where\u2019s;where is] my landing pad : Will tell you the location of your assigned landing pad on a starport.","title":"Navigation"},{"location":"EliteAttack/#ship-controls","text":"Basically anything that is related to directly doing something with your ship. [abort;cancel;stop] jumping : Stops a currently charging FSD jump. [half;] power to [engines;shields;systems;weapons] : Sets pips to 6/3/3 ( half ) or 8/2/2 towards the given capacitor. [balanced;half;] power to [engines;shields;systems;weapons] [and engines;and shields;and systems;and weapons;] : Sets pips to 6/6/0 (balanced), 5/5/2 (half) or 8/4/0 towards the given capacitors. [close;deploy;extend;open;retract;] [cargo scoop;hard points; landing gear] [up;down;] : Overly complicated command to handle everything related to Cargo Scoop, Hard Points, Landing Gear. You get the gist, I guess. Works in SRV too. [disco;discovery scan] : Executes a discovery scan. Expects the Discovery Scanner in your first fire group, secondary fire. You can change that . [dis;]engage silent running : Turns silent running on and off. [head;spot;] lights [on;off] : Turns your lights on and off. Works in SRV too, kinda; turning lights off there relies on the state updating fast enough, which sometimes leads to weird results. [jump;engage;get me out] [and scan;] [when ready;] : Retracts everything that might be protruding from your ship, then jumps to the next system. If the FSD isn\u2019t charging within 1s, it gets you into SC instead (e.g. if your target is obstructed). If given \u201cand scan\u201d runs a discovery scan. If given \u201cwhen ready\u201d waits for mass lock to clear, your FSD to cool down and you to leave scoop range before jumping. night vision [on;off] : Toggles your night vision on/off. Works in SRV too. rapid fire lights : Flashes your lights 5 times in a row. retract [all;everything] : Retracts, well, everything. [start;stop] [firing;mining] : Starts/stops holding down primary fire. Mostly useful when mining. When triggered with \u201cmining\u201d, also deploys the cargo scoop. [super;] cruise [when ready;] : Retracts everything, then jumps to SC. If given \u201cwhen ready\u201d will wait for mass lock to clear and your FSD to cool down first.","title":"Ship Controls"},{"location":"EliteAttack/#srv-controls","text":"Things relevant to your SRV, but not your ship. [recall;dismiss] ship : Recalls or dismisses ship. Currently does the same thing regardless of the state of your ship. I wish it would be possible to restrict it to doing one thing each, but that\u2019s currently not possible sadly. [toggle;enable;disable] drive assist : Handles all your drive assist needs!","title":"SRV Controls"},{"location":"EliteAttack/#targeting","text":"Well \u2026 targeting stuff, I guess. Not really sure why I made that its own category, but oh well :) target the [drive;drives;power plant;frame shift drive;f s d;shield generator] : Targets the given submodule on your current target, or your next target if you don\u2019t have one currently. Does not persist between targets. clear sub [module;system] target : Clears the current submodule target. target next system : Selects the next system on your route. target wing man [1;2;3] : Targets your wingmen. target\u2019s target : Targets your target\u2019s target (only works on wingmen). wing man [1;2;3] target : Targets your wingmen\u2019s target. wing man nav lock : Toggles wing man nav lock on the selected wing member.","title":"Targeting"},{"location":"EliteAttack/#ui-commands","text":"Everything handling stuff that\u2019s not related to controlling your ship, but manipulating some UI element(s). [enter;leave] F S S : Opens/closes FSS. [main;game] menu : Opens the ESC menu. [relog;reset] to [open;solo] : Relogs to Open or Solo mode, respectively. controls options : Opens the controls options menu. docking request;request dock[ing;] : Sends a docking request. galaxy map : Opens the galaxy map. restart from Desktop : Quits the game and restarts from an open launcher by clicking the play button. set [default;star;station;settlement;signal sources;anomaly;unknown;system] filter : Sets a nav panel filter setting. See the command or just try different things for what is possible. You need to clear filters and hover over the filter button, then run this. system map : Opens the system map. take [high res;] screenshot : Takes a (high res) screenshot. toggle orbit lines : Toggles the visibility of orbit lines.","title":"UI Commands"},{"location":"EliteAttack/#miscellaneous","text":"The commands in here do random more or less useful things. [are there any;] outdated stations [in this system;] : Runs an on-demand check for outdated stations in the current system. [bodies;what\u2019s;what is] left to [map;be mapped;scan] : Tells you which bodies EDDI thinks are worth mapping in the system that you haven\u2019t mapped yet. copy current system : Copies the current system name into the clipboard. open [current;] system on EDSM : Opens your current system on EDSM in your default browser. open copied system on EDSM : Opens the system in your clipboard on EDSM in your default browser. open coriolis : Opens Coriolis in your default browser. open e d d b [station;system;faction;] [search;] : Opens EDDB in your default browser. open e d s m : Opens EDSM in your default browser. open inara : Opens Inara in your default browser. open materials finder : Opens EDTutorials\u2019 materials finder in your default browser. open miner\u2019s tool : Opens https://edtools.cc/miner in your default browser. open spansh : Opens https://spansh.uk in your default browser.","title":"Miscellaneous"},{"location":"EliteAttack/#events","text":"This is a list of ingame Events, provided by EDDI , that the profile will act on.","title":"Events"},{"location":"EliteAttack/#afmu-repairs","text":"Reports on the module that has been repaired, and if it has been fully or partially repaired.","title":"AFMU Repairs"},{"location":"EliteAttack/#body-mapped","text":"Announces an estimate for high-value bodies\u2019 payouts and the remaining mapping candidates in the system as given by EDDI.","title":"Body Mapped"},{"location":"EliteAttack/#body-scanned","text":"Announces any interesting body traits found when scanning: terraformable Earth-like World, Ammonia World or Water World landable and >5\u202fg semimajor axis <1.5\u202fls (only really interesting for planets, but there\u2019s no proper way to separate them from moons, sadly) radius <300\u202fkm Feel free to suggest more!","title":"Body scanned"},{"location":"EliteAttack/#carrier-cooldown","text":"Tells you when your carrier is able to do its next jump.","title":"Carrier Cooldown"},{"location":"EliteAttack/#carrier-jump-engaged","text":"This event fires when your carrier jumps but you are not docked at it. It provides way less information than the Carrier Jumped event, but hey, I don\u2019t use most of it anyway. Basically just calls Carrier Jumped .","title":"Carrier Jump Engaged"},{"location":"EliteAttack/#carrier-jump-request","text":"Announces the system and body your carrier has just been scheduled to jump to. Use this to double check ingame information; I\u2019ve had my carrier accept a body as jump target, but then end up around the star. This might give you a heads up on that. Also starts a command queue to give you advance warnings on carrier lockdown at -10, -5 and -2 minutes.","title":"Carrier Jump Request"},{"location":"EliteAttack/#carrier-jumped","text":"Announces system and body your carrier has just jumped to.","title":"Carrier Jumped"},{"location":"EliteAttack/#carrier-pads-locked","text":"Announces your carrier\u2019s lockdown procedures.","title":"Carrier Pads Locked"},{"location":"EliteAttack/#discovery-scan","text":"Announces the number of bodies (and non-body signals) found in the system. Also compares the number of bodies to the amount reported by EDSM (requires Python scripts).","title":"Discovery Scan"},{"location":"EliteAttack/#docked","text":"Automatically refuels, repairs, rearms, then gets your ship into the hangar and opens station services. Can be individually disabled.","title":"Docked"},{"location":"EliteAttack/#docking-denied","text":"Tells you the reason for docking denial.","title":"Docking Denied"},{"location":"EliteAttack/#entered-normal-space","text":"Throttles to 0 upon dropping from SC, if the hyperspace dethrottle option is enabled.","title":"Entered Normal Space"},{"location":"EliteAttack/#fighter-launched","text":"Orders your ship to hold position so it doesn\u2019t chase after you immediately.","title":"Fighter Launched"},{"location":"EliteAttack/#jet-cone-boost","text":"Sets your ship to full throttle immediately after you have supercharged.","title":"Jet Cone Boost"},{"location":"EliteAttack/#jumped","text":"Zeroes throttle if the hyperspace dethrottle option is enabled. Gets the system\u2019s body count from EDSM if that option is enabled. Gets stations with outdated data (by default: older than 1 year) from Spansh\u2019s API. Again, if it is enabled. Starts a discovery scan if that is enabled. Last but not least tells you about planets worth scanning if you are on the R2R.","title":"Jumped"},{"location":"EliteAttack/#liftoff","text":"Retracts landing gear for you. Seriously, is there any occasion in which you don\u2019t immediately want to retract it after takeoff?","title":"Liftoff"},{"location":"EliteAttack/#low-fuel","text":"Warns you when you reach 25% fuel. Also reports number of jumps you have left or the (rough) range you still have on the fumes left in your tank.","title":"Low Fuel"},{"location":"EliteAttack/#material-threshold","text":"Warns you when a monitored material falls below its minimum stock level and tells you when you reach your desired level or fill up. You will have to set minimum and desired amounts in EDDI\u2019s material monitor options first for all materials you wish to be monitored.","title":"Material Threshold"},{"location":"EliteAttack/#next-jump","text":"Gives you a jump count upon plotting a route using the galaxy map.","title":"Next Jump"},{"location":"EliteAttack/#ship-fsd","text":"This event actually is several different events in one. Currently the following are handled: Charging: Warns you if you are jumping with less than 25% fuel. Cooldown complete: Announces FSD cooldown if you are currently in normal space.","title":"Ship FSD"},{"location":"EliteAttack/#ship-interdicted","text":"Tells you when you have been interdicted by a player. Is also supposed to target the interdictor automatically, but randomly sometimes just doesn\u2019t work. Yay!","title":"Ship Interdicted"},{"location":"EliteAttack/#srv-launched","text":"Toggles SRV lights off after launching. Might not work if you drop particularly far after deployment because it works off a timer. Conversely might take a second to turn your lights off on a short drop and/or in high gravity.","title":"SRV Launched"},{"location":"EliteAttack/#synthesis","text":"Reports on the synthesis type and quality.","title":"Synthesis"},{"location":"EliteAttack/#system-scan-complete","text":"Lists all bodies EDDI considers worth mapping in the current system.","title":"System Scan Complete"},{"location":"EliteAttack/#undocked","text":"Retracts landing gear for you. Seriously, is there any occasion in which you don\u2019t immediately want to retract it after takeoff?","title":"Undocked"},{"location":"RatAttack/","text":"RatAttack \u00b6 This profile facilitates Fuel Ratting . It aims to eliminate as much of the required manual task and attention switching as possible via automation and voice commands. If you don\u2019t know what the Fuel Rats are, come hang out and ask :) Going On/Off Duty \u00b6 When you are on duty, RatAttack will automatically announce cases coming in through IRC. When off duty, it won\u2019t. [enable;disable] rat duty : puts you on/off duty. open [fuel rats;] dispatch board : opens the web dispatch board. Case Handling \u00b6 If you have your IRC client setup properly , VoiceAttack will hold a list with all rat cases that have come in while you had it running. It will save the case number, CMDR name, system, O\u2082 status and platform. There are several commands you can run on this list, giving it a case number: Getting Case Information \u00b6 rat case number [0..30] details : Will give you all stored info on a case. [current;] rat case details : Will give you all stored info on the currently open case. distance to current rat case : Will give you the distance from your current location to the currently opened rat case. distance to rat case number [0..30] : Will give you the distance from your current system to a case\u2019s system. latest rat case details : Will give you the case data for the latest incoming case. nearest commander to rat case number [0..30] : Will give you the nearest of your CMDRs with their distance to a case\u2019s system. Requires some setup . nearest commander to [the;] rat case : Will give you the nearest of your CMDRs with their distance to the current case\u2019s system. Requires some setup . Opening a Case \u00b6 open rat case number [0..30] : Opens rat case with the given number. If there is no case data for that case (e.g. because you don\u2019t have your IRC client set up properly), it will still open it, just not have any data on it. open [latest;] rat case : Opens the latest rat case that has come in through IRC. Will only work if you actually have your IRC client setup to send case announcements to VoiceAttack . Opening a case will automatically copy the client\u2019s system to the clipboard for easy route plotting. This can be disabled. Making Calls \u00b6 There are a bunch of calls you can make for a case, the most common are modelled through VoiceAttack commands. The descriptive commands (e.g. \u201csystem confirmed\u201d) will be shortened to the usual IRC short hands (e.g. \u201csysconf\u201d). If you need something more unusual you can either still manually type it into your IRC client or use the \u201cGeneral IRC Integration\u201d, see below. call [1..20] jumps [and login;and takeoff;left;] : Calls jumps for the currently open case. You can optionally include that you will still have to login to the game or have to take off from your current station/port/outpost/planet. call jumps [left;] : Calls jumps for the currently open case based on a neutron trip (requires SpanshAttack) or a plotted ingame route. call friend [positive;negative] [in pg;in private group;in solo;in main menu;sysconf;system confirmed;] : Friend request confirmations, with all the things you might want to / should call with it. call [beacon;fuel;instance;pos;position;prep;sys;system;wing] [positive;negative] : All the stuff you usually need for ratting after you have received the friend request. call wing pending : Calls \u201cwr pending\u201d for when it takes 30s again to actually show up. call client in [exclusion zone;main menu;open;open sysconf;pg;private group;solo;super cruise] : Callouts for all the various things a client could get themselves into. call [client destroyed;client offline;sysconf;system confirmed] : This is the command you don\u2019t want to use. Include sysconf in your \u201cfriend+\u201d or \u201cin open\u201d calls, and make sure you will never have to call \u201cclient destroyed\u201d, would you? By default, VoiceAttack will ask for confirmation before sending calls to the #fuelrats channel. Closing a Case \u00b6 [close;clear] rat case : Closes the currently open rat case. General IRC Interaction \u00b6 Using EDDI to read the game\u2019s journal, you can send messages to IRC from Elite\u2019s ingame chat. Be aware that the chat message will still appear in the ingame chat channel you send it to! I recommend using local chat and limiting the use to instances that will probably not have other players in it (e.g. instanced in normal space with the client or in SC in some remote system out in the black on a long range rescue). #fuelrats: Use .fr to have VoiceAttack send # to #fuelrats \u2013 or yell at you when you are not on a case. #ratchat: Use .rc to have VoiceAttack send to #ratchat. Make sure that your IRC client is setup properly .","title":"RatAttack"},{"location":"RatAttack/#ratattack","text":"This profile facilitates Fuel Ratting . It aims to eliminate as much of the required manual task and attention switching as possible via automation and voice commands. If you don\u2019t know what the Fuel Rats are, come hang out and ask :)","title":"RatAttack"},{"location":"RatAttack/#going-onoff-duty","text":"When you are on duty, RatAttack will automatically announce cases coming in through IRC. When off duty, it won\u2019t. [enable;disable] rat duty : puts you on/off duty. open [fuel rats;] dispatch board : opens the web dispatch board.","title":"Going On/Off Duty"},{"location":"RatAttack/#case-handling","text":"If you have your IRC client setup properly , VoiceAttack will hold a list with all rat cases that have come in while you had it running. It will save the case number, CMDR name, system, O\u2082 status and platform. There are several commands you can run on this list, giving it a case number:","title":"Case Handling"},{"location":"RatAttack/#getting-case-information","text":"rat case number [0..30] details : Will give you all stored info on a case. [current;] rat case details : Will give you all stored info on the currently open case. distance to current rat case : Will give you the distance from your current location to the currently opened rat case. distance to rat case number [0..30] : Will give you the distance from your current system to a case\u2019s system. latest rat case details : Will give you the case data for the latest incoming case. nearest commander to rat case number [0..30] : Will give you the nearest of your CMDRs with their distance to a case\u2019s system. Requires some setup . nearest commander to [the;] rat case : Will give you the nearest of your CMDRs with their distance to the current case\u2019s system. Requires some setup .","title":"Getting Case Information"},{"location":"RatAttack/#opening-a-case","text":"open rat case number [0..30] : Opens rat case with the given number. If there is no case data for that case (e.g. because you don\u2019t have your IRC client set up properly), it will still open it, just not have any data on it. open [latest;] rat case : Opens the latest rat case that has come in through IRC. Will only work if you actually have your IRC client setup to send case announcements to VoiceAttack . Opening a case will automatically copy the client\u2019s system to the clipboard for easy route plotting. This can be disabled.","title":"Opening a Case"},{"location":"RatAttack/#making-calls","text":"There are a bunch of calls you can make for a case, the most common are modelled through VoiceAttack commands. The descriptive commands (e.g. \u201csystem confirmed\u201d) will be shortened to the usual IRC short hands (e.g. \u201csysconf\u201d). If you need something more unusual you can either still manually type it into your IRC client or use the \u201cGeneral IRC Integration\u201d, see below. call [1..20] jumps [and login;and takeoff;left;] : Calls jumps for the currently open case. You can optionally include that you will still have to login to the game or have to take off from your current station/port/outpost/planet. call jumps [left;] : Calls jumps for the currently open case based on a neutron trip (requires SpanshAttack) or a plotted ingame route. call friend [positive;negative] [in pg;in private group;in solo;in main menu;sysconf;system confirmed;] : Friend request confirmations, with all the things you might want to / should call with it. call [beacon;fuel;instance;pos;position;prep;sys;system;wing] [positive;negative] : All the stuff you usually need for ratting after you have received the friend request. call wing pending : Calls \u201cwr pending\u201d for when it takes 30s again to actually show up. call client in [exclusion zone;main menu;open;open sysconf;pg;private group;solo;super cruise] : Callouts for all the various things a client could get themselves into. call [client destroyed;client offline;sysconf;system confirmed] : This is the command you don\u2019t want to use. Include sysconf in your \u201cfriend+\u201d or \u201cin open\u201d calls, and make sure you will never have to call \u201cclient destroyed\u201d, would you? By default, VoiceAttack will ask for confirmation before sending calls to the #fuelrats channel.","title":"Making Calls"},{"location":"RatAttack/#closing-a-case","text":"[close;clear] rat case : Closes the currently open rat case.","title":"Closing a Case"},{"location":"RatAttack/#general-irc-interaction","text":"Using EDDI to read the game\u2019s journal, you can send messages to IRC from Elite\u2019s ingame chat. Be aware that the chat message will still appear in the ingame chat channel you send it to! I recommend using local chat and limiting the use to instances that will probably not have other players in it (e.g. instanced in normal space with the client or in SC in some remote system out in the black on a long range rescue). #fuelrats: Use .fr to have VoiceAttack send # to #fuelrats \u2013 or yell at you when you are not on a case. #ratchat: Use .rc to have VoiceAttack send to #ratchat. Make sure that your IRC client is setup properly .","title":"General IRC Interaction"},{"location":"SpanshAttack/","text":"SpanshAttack \u00b6 This profile uses the ED-NeutronRouter plugin to plot neutron jumps using Spansh . It does everything you need fully from within the game and VoiceAttack, you won\u2019t have to visit the site at any point. Plotting a Route \u00b6 Target the system you want to be routed to (target, do not plot to it). Either exit the galaxy map or make sure you are on its first tab (or auto-plotting will break). Trigger the SpanshAttack.plotRoute command either by voice ( plot neutron [course;route;trip] [with custom range;] ) or by calling it from another command. Enter your ship\u2019s jump range if prompted. Wait for the route to be calculated. The command will automatically open the galaxy map and search it for the first waypoint on your route. Either target the first waypoint or plot to it. Start jumping! Plotting to a System Unknown to the Neutron Router \u00b6 The router can only plot a route to a system that is in its database (obviously can also only give you waypoints that are). If your target system is not, there are several levels of fallback handling to find a system that is. Check Next system coordinates provided by EDDI. If the system is in EDSM, but has for some reason not been sent over EDDN to other sites including Spansh, we can get coordinates here. If the system is not in EDSM check EDTS. It can calculate approximate coordinates for a given procedurally generated system name. If that fails prompt the user for input. Query Spansh\u2019 API for the closest system to these coordinates. Plot a route to the closest system. Generally you should almost never be asked to input coordinates manually. If EDTS provides coordinates with an accuracy that is worse than \u00b1100\u202fly per axis, you will be prompted to make sure you are going roughly to the right coordinates. You will find the system that is used for plotting, its coordinates and the accuracy in VoiceAttack\u2019s log window. Neutron Jumping \u00b6 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.copyNextNeutronWaypoint / [get;copy] next neutron [waypoint;way point] command to copy the next neutron waypoint to the clipboard. Skipping a Waypoint \u00b6 Sometimes, especially in very neutron-sparse areas of the galaxy, the plotter will give you weird jumps. E.g. I recently got neutron \u2192 37 ly \u2192 neutron \u2192 440 ly. In these cases you can use the SpanshAttack.skipNeutronWaypoint / skip [this;current] neutron waypoint command to move on to the next one in the list. Manual Re-Plot \u00b6 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 \u00b6 Whenever you finish refueling 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 \u00b6 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 \u00b6 Announcing Jumps Left \u00b6 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\u2019s 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 \u00b6 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\u2019ve been jumping with the SpanshAttack.announceTripTime or how long have i been [jumping;on this trip;on this neutron trip]? commands.","title":"SpanshAttack"},{"location":"SpanshAttack/#spanshattack","text":"This profile uses the ED-NeutronRouter plugin to plot neutron jumps using Spansh . It does everything you need fully from within the game and VoiceAttack, you won\u2019t have to visit the site at any point.","title":"SpanshAttack"},{"location":"SpanshAttack/#plotting-a-route","text":"Target the system you want to be routed to (target, do not plot to it). Either exit the galaxy map or make sure you are on its first tab (or auto-plotting will break). Trigger the SpanshAttack.plotRoute command either by voice ( plot neutron [course;route;trip] [with custom range;] ) or by calling it from another command. Enter your ship\u2019s jump range if prompted. Wait for the route to be calculated. The command will automatically open the galaxy map and search it for the first waypoint on your route. Either target the first waypoint or plot to it. Start jumping!","title":"Plotting a Route"},{"location":"SpanshAttack/#plotting-to-a-system-unknown-to-the-neutron-router","text":"The router can only plot a route to a system that is in its database (obviously can also only give you waypoints that are). If your target system is not, there are several levels of fallback handling to find a system that is. Check Next system coordinates provided by EDDI. If the system is in EDSM, but has for some reason not been sent over EDDN to other sites including Spansh, we can get coordinates here. If the system is not in EDSM check EDTS. It can calculate approximate coordinates for a given procedurally generated system name. If that fails prompt the user for input. Query Spansh\u2019 API for the closest system to these coordinates. Plot a route to the closest system. Generally you should almost never be asked to input coordinates manually. If EDTS provides coordinates with an accuracy that is worse than \u00b1100\u202fly per axis, you will be prompted to make sure you are going roughly to the right coordinates. You will find the system that is used for plotting, its coordinates and the accuracy in VoiceAttack\u2019s log window.","title":"Plotting to a System Unknown to the Neutron Router"},{"location":"SpanshAttack/#neutron-jumping","text":"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.copyNextNeutronWaypoint / [get;copy] next neutron [waypoint;way point] command to copy the next neutron waypoint to the clipboard.","title":"Neutron Jumping"},{"location":"SpanshAttack/#skipping-a-waypoint","text":"Sometimes, especially in very neutron-sparse areas of the galaxy, the plotter will give you weird jumps. E.g. I recently got neutron \u2192 37 ly \u2192 neutron \u2192 440 ly. In these cases you can use the SpanshAttack.skipNeutronWaypoint / skip [this;current] neutron waypoint command to move on to the next one in the list.","title":"Skipping a Waypoint"},{"location":"SpanshAttack/#manual-re-plot","text":"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.","title":"Manual Re-Plot"},{"location":"SpanshAttack/#refueling","text":"Whenever you finish refueling 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.","title":"Refueling"},{"location":"SpanshAttack/#clearing-a-route","text":"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.","title":"Clearing a Route"},{"location":"SpanshAttack/#other-commands","text":"","title":"Other Commands"},{"location":"SpanshAttack/#announcing-jumps-left","text":"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\u2019s 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 .","title":"Announcing Jumps Left"},{"location":"SpanshAttack/#announce-elapsed-time-on-the-trip","text":"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\u2019ve been jumping with the SpanshAttack.announceTripTime or how long have i been [jumping;on this trip;on this neutron trip]? commands.","title":"Announce elapsed time on the trip"},{"location":"StreamAttack/","text":"StreamAttack \u00b6 This profile uses the EDDI plugin to write a bunch of information about your commander, your current location and your ship to files that can be accessed e.g. by your streaming software to be displayed on stream. Default folder is %appdata%\\StreamAttack\\ . Commands \u00b6 clear jump target : Clears the current jump target. distance [to;from] jump target : Tells you the current distance to the jump target. set jump target : Sets the jump target to the currently targeted system. Distance will be written to the configured file. [copy;open] ship build : Copies the current ship build (coriolis) or opens it in your default browser. open StreamAttack folder : Opens the configured folder in Explorer. Output Files \u00b6 Elite \u00b6 Please do note that information in the output files is only updated when a journal event that contains the information is detected. E.g. the distance to your jump target is not constantly calculated, but only updated after a jump. Commander \u00b6 Elite\\cmdr\\name : The current commander\u2019s name. Jump Target \u00b6 Elite\\jumpTarget\\distance : Distance to current jump target in light years. Elite\\jumpTarget\\full : Pretty-printed ly to . Elite\\jumpTarget\\name : The current jump target\u2019s system name. Location \u00b6 Elite\\location\\full : Depending on your status, either the station you are currently docked at (+ system), the body you are currently near, or the system you are currently in. Elite\\location\\system : The system you are currently in. Ship \u00b6 Elite\\ship\\build : Your current ship\u2019s loadout (link to coriolis). Elite\\ship\\full : \u201c\u201d | | . Elite\\ship\\model : Your current ship\u2019s model. Elite\\ship\\name : Your current ship\u2019s name.","title":"StreamAttack"},{"location":"StreamAttack/#streamattack","text":"This profile uses the EDDI plugin to write a bunch of information about your commander, your current location and your ship to files that can be accessed e.g. by your streaming software to be displayed on stream. Default folder is %appdata%\\StreamAttack\\ .","title":"StreamAttack"},{"location":"StreamAttack/#commands","text":"clear jump target : Clears the current jump target. distance [to;from] jump target : Tells you the current distance to the jump target. set jump target : Sets the jump target to the currently targeted system. Distance will be written to the configured file. [copy;open] ship build : Copies the current ship build (coriolis) or opens it in your default browser. open StreamAttack folder : Opens the configured folder in Explorer.","title":"Commands"},{"location":"StreamAttack/#output-files","text":"","title":"Output Files"},{"location":"StreamAttack/#elite","text":"Please do note that information in the output files is only updated when a journal event that contains the information is detected. E.g. the distance to your jump target is not constantly calculated, but only updated after a jump.","title":"Elite"},{"location":"StreamAttack/#commander","text":"Elite\\cmdr\\name : The current commander\u2019s name.","title":"Commander"},{"location":"StreamAttack/#jump-target","text":"Elite\\jumpTarget\\distance : Distance to current jump target in light years. Elite\\jumpTarget\\full : Pretty-printed ly to . Elite\\jumpTarget\\name : The current jump target\u2019s system name.","title":"Jump Target"},{"location":"StreamAttack/#location","text":"Elite\\location\\full : Depending on your status, either the station you are currently docked at (+ system), the body you are currently near, or the system you are currently in. Elite\\location\\system : The system you are currently in.","title":"Location"},{"location":"StreamAttack/#ship","text":"Elite\\ship\\build : Your current ship\u2019s loadout (link to coriolis). Elite\\ship\\full : \u201c\u201d | | . Elite\\ship\\model : Your current ship\u2019s model. Elite\\ship\\name : Your current ship\u2019s name.","title":"Ship"},{"location":"VoiceAttack/","text":"VoiceAttack Tips \u00b6 This will fill up eventually with tips on how to properly setup VoiceAttack for decent recognition.","title":"VoiceAttack Tips"},{"location":"VoiceAttack/#voiceattack-tips","text":"This will fill up eventually with tips on how to properly setup VoiceAttack for decent recognition.","title":"VoiceAttack Tips"},{"location":"general/","text":"General Commands \u00b6 Configuration \u00b6 The base profile provides voice commands for changing the profiles\u2019 settings. See the configuration section . Chat \u00b6 paste text : Pastes the contents of your current clipboard. Note that this command is supposed to be used for pasting into Elite and hence uses the configured paste key. If you\u2019re using a non-standard layout that means that you cannot use this command to paste text into other applications. Updating \u00b6 check for profiles update : Checks Github for a new version, and alerts you if there is one. download profiles update : Opens the latest release on Github and the VoiceAttack import folder where you can drop it. open profiles [docs;documentation;help] [file;site;] : Opens this documentation, either on the web or the PDF file supplied with the installed release. open profiles change log : Opens the CHANGELOG on Github. open voiceattack [apps;import;sounds] [folder;directory] : Opens the respective VoiceAttack-related folder. Miscellaneous \u00b6 generate missing key binds report : Generates a report of missing key binds and places it on your Desktop. Note that this currently uses bindED\u2019s built-in report which will output any bind that does not have a keyboard key set, including axis binds and binds that are not actually used by the profiles. open documentation : Opens the documentation in your default browser. open EDDI options;configure EDDI : Displays EDDI\u2019s configuration window. open elite bindings folder : Opens Elite\u2019s bindings folder ( %localappdata%\\Frontier Developments\\Elite Dangerous\\Options\\Bindings ) reload elite key binds : Forces a reload of your Elite binds. Should not be necessary. shut up EDDI : Immediately interrupts any current and pending speech on EDDI\u2019s end.","title":"General Commands"},{"location":"general/#general-commands","text":"","title":"General Commands"},{"location":"general/#configuration","text":"The base profile provides voice commands for changing the profiles\u2019 settings. See the configuration section .","title":"Configuration"},{"location":"general/#chat","text":"paste text : Pastes the contents of your current clipboard. Note that this command is supposed to be used for pasting into Elite and hence uses the configured paste key. If you\u2019re using a non-standard layout that means that you cannot use this command to paste text into other applications.","title":"Chat"},{"location":"general/#updating","text":"check for profiles update : Checks Github for a new version, and alerts you if there is one. download profiles update : Opens the latest release on Github and the VoiceAttack import folder where you can drop it. open profiles [docs;documentation;help] [file;site;] : Opens this documentation, either on the web or the PDF file supplied with the installed release. open profiles change log : Opens the CHANGELOG on Github. open voiceattack [apps;import;sounds] [folder;directory] : Opens the respective VoiceAttack-related folder.","title":"Updating"},{"location":"general/#miscellaneous","text":"generate missing key binds report : Generates a report of missing key binds and places it on your Desktop. Note that this currently uses bindED\u2019s built-in report which will output any bind that does not have a keyboard key set, including axis binds and binds that are not actually used by the profiles. open documentation : Opens the documentation in your default browser. open EDDI options;configure EDDI : Displays EDDI\u2019s configuration window. open elite bindings folder : Opens Elite\u2019s bindings folder ( %localappdata%\\Frontier Developments\\Elite Dangerous\\Options\\Bindings ) reload elite key binds : Forces a reload of your Elite binds. Should not be necessary. shut up EDDI : Immediately interrupts any current and pending speech on EDDI\u2019s end.","title":"Miscellaneous"},{"location":"installing/","text":"Installing \u00b6 Install VoiceAttack \u00b6 Grab the most recent VoiceAttack beta version off the official site and install it. If you are using the standalone version you should probably download the executable installer. If you are using the Steam version of VoiceAttack, you will have to download the zipped folder and replace your installed version with its contents. Here is the first hit on a Google search for finding the installation folder . It is for a completely unrelated game, but the steps are the same. You can potentially also install the latest non-beta version; but I often use features that have only just been added to the beta, so some things might break for you if you are not using that. There might not be a beta version at the time you\u2019re reading this, just get the full release then. Enable Plugin Support \u00b6 Make sure you have plugin support enabled: Go to VoiceAttack settings. Check \u201cenable plugin support\u201d. While you are there, you might also want to enable the automatic update checks (Note: those settings do not exist in the Steam version). Install EDDI \u00b6 Install the latest release from Github (The EDDI-X.Y.Z.exe file under \u201cAssets\u201d). You will need to install it as a VoiceAttack plugin . If you do not want to install it into the VoiceAttack installation folder (or already have it installed somewhere else) you can instead put it elsewhere and create a symbolic link. Open a command prompt (Windows key + R , enter \u201ccmd\u201d, hit Enter ) and do >cd x:\\path\\to\\VoiceAttack\\Apps >mklink /J EDDI x:\\path\\to\\EDDI If you have installed the non-Steam version of VoiceAttack to the default folder within \u201cProgram Files\u201d you will have to run the command prompt as admin (Windows key + R , enter \u201ccmd\u201d, hit Control + Shift + Enter ). Install ED-NeutronRouter \u00b6 Grab the latest release release from Github (The EDNeutronRouter.vX.YZ.zip under \u201cAssets\u201d). You will have to extract the contents of the release .zip file to your VoiceAttack Apps folder: Go into VoiceAttack settings. Click the folder set as \u201cApps Folder\u201d. Now extract the contents of the downloaded file into there. Make sure that they are not naked files under \u201cApps\u201d, but have their own folder \u201cApps\\ED-NeutronRouter\u201d! The exact folder name does not matter as long as they are in a subfolder. Otherwise the plugin will not load. Leave the \u201cApps\u201d folder open in Windows Explorer, you will need it for the next step. Import Profiles Package \u00b6 Acquire the latest release from Github (the alterNERDtive-voiceattack-profiles.vax file under \u201cAssets\u201d). Put it into VoiceAttack\u2019s \u201cImport\u201d folder: Go into VoiceAttack settings. Click the folder set as \u201cApps Folder\u201d. Create a sub folder named \u201cImport\u201d if it does not exist yet. Drop the downloaded .vax file into the \u201cImport\u201d folder. Restart VoiceAttack. When prompted, import the profile package. VoiceAttack will restart when completed. Create a Custom Profile \u00b6 Last but not least you are going to create your own custom VoiceAttack profile for Elite. It will allow you to add your own commands, override any commands in the profiles that you want to change and add voice triggers or hotkeys. You can either use an existing profile, create a new one or use the provided profile example as a basis. Regardless of which way you choose, make sure to read the Include Profiles section and follow the instructions there! Option 1: Create a New Profile Or Use an Existing One \u00b6 Click the \u201cProfile Actions\u201d button, then \u201cCreate New Profile\u201d. Give it a name and add some commands if you want to. Hit \u201cDone\u201d to create the new profile. Alternatively you can keep using your existing profile. You will still have to follow the rest of the instructions in this case. Create a Startup Command \u00b6 First off, hit the \u201cEdit\u201d button in VoiceAttack. If you are using your existing profile (or have just created a fresh one) you will now have to create the startup command. Hit the \u201cNew Command\u201d button. You can name it anything you want but I recommend calling it \u201cstartup\u201d or similar, and to deactivate the \u201cwhen I say\u201d checkbox in the command options to make sure you do not accidentally run it via voice. Add a new action using \u201cOther\u201d \u2192 \u201cVoiceAttack Action\u201d\u2192 \u201cExecute Another Command\u201d. Choose \u201cExecute by name (Advanced)\u201d and enter ((alterNERDtive-base.startup)) . Make sure to leave \u201cWait until this command completes before continuing\u201d on and have this action at the top of the action list for the command. That way you can be sure that my profiles are initialized properly before your personal startup actions are processed. You can add anything else you want your profile to do when it loads below this action. You do not have to set any configuration options, this can be done way more elegantly! More on this later on . After adding the startup command you will have to right click VoiceAttack\u2019s title bar and choose \u201cReload Active Profile\u201d or restart VoiceAttack to see it executed for the first time. Option 2: Use the Profile Example \u00b6 Click the \u201cProfile Actions\u201d button, then \u201cImport Profile\u201d. Navigate to your VoiceAttack Apps folder (see above), go into the \u201calterNERDtive\u201d subfolder, choose the profile example and hit \u201cOpen\u201d. Once you are done with the setup and configuration process, you can find a bunch of example commands with comments on how to do things in this profile. Make sure to also rename it to something more exciting than \u201cCustom Profile Example\u201d! Include Profiles \u00b6 In order to use my profiles with your custom profile, you will need to take two additional steps: Include the profiles in your custom profile. That will make all commands available when your custom profile is active. Create a startup command for your custom profile. You can use it to do anything you want when your profile loads, but it will also have to run the startup command for my profiles. Set Profile Options \u00b6 While editing the profile, hit the \u201cOptions\u201d button. On the section labeled \u201cInclude commands from other profiles\u201d, hit the \u201c\u2026\u201d button. Add all my profiles (\u201calterNERDtive-base\u201d, \u201cEliteAttack\u201d, \u201cRatAttack\u201d, \u201cSpanshAttack\u201d, \u201cStreamAttack\u201d). Make sure that \u201calterNERDtive-base\u201d is on top of the list, the order of the others does not matter. But I like it nice and alphabetical. Technically you can leave out any profile you are not planning to use. Practically it probably will not hurt you to just include everything, and it will then be available for you in the future should you choose to check it out! Now switch to the \u201cProfile Exec\u201d tab. Tick the \u201cExecute a command each time this profile is loaded\u201d checkbox, and select the \u201cstartup\u201d command you have created earlier. Reload the Profile \u00b6 To make sure everything is loaded correctly, you now need to either reload the profile by right clicking on VoiceAttack\u2019s title bar \u2192 \u201cReset Active Profile\u201d or by simply restarting VoiceAttack. You should see a bunch of initialization messages pop up in the VoiceAttack log. Set Elite Keyboard Binds \u00b6 You need to have keyboard binds setup at least as secondary bindings in Elite\u2019s controls options. VoiceAttack cannot \u201cpush\u201d joystick buttons for you, it can only do keyboard inputs. Hence its only way to interact with Elite is through keyboard emulation, even if you otherwise play the game with a controller or HOTAS. Or racing wheel. Or Rock Band set. Or bananas. For the \u201cGalaxy Map\u201d section, make sure that the bindings do not conflict with the ones in the \u201cInterface Mode\u201d section. The map bindings take precedence and a conflict leads to VoiceAttack being unable to target systems for you. In that case you would see it open the map for you and then wiggle the view for a split second instead of switching tabs over to the system search. Should you use a keyboard layout that is not en-US QWERTY, some keys might not work out of the box. You can try telling bindED about your keyboard layout by setting the bindED.layout# variable (including the # !) to something more appropriate in your startup command. Currently bindED supports the en-US , en-GB and de-Neo2 layouts. You can find instructions on how to add your own here .","title":"Installing"},{"location":"installing/#installing","text":"","title":"Installing"},{"location":"installing/#install-voiceattack","text":"Grab the most recent VoiceAttack beta version off the official site and install it. If you are using the standalone version you should probably download the executable installer. If you are using the Steam version of VoiceAttack, you will have to download the zipped folder and replace your installed version with its contents. Here is the first hit on a Google search for finding the installation folder . It is for a completely unrelated game, but the steps are the same. You can potentially also install the latest non-beta version; but I often use features that have only just been added to the beta, so some things might break for you if you are not using that. There might not be a beta version at the time you\u2019re reading this, just get the full release then.","title":"Install VoiceAttack"},{"location":"installing/#enable-plugin-support","text":"Make sure you have plugin support enabled: Go to VoiceAttack settings. Check \u201cenable plugin support\u201d. While you are there, you might also want to enable the automatic update checks (Note: those settings do not exist in the Steam version).","title":"Enable Plugin Support"},{"location":"installing/#install-eddi","text":"Install the latest release from Github (The EDDI-X.Y.Z.exe file under \u201cAssets\u201d). You will need to install it as a VoiceAttack plugin . If you do not want to install it into the VoiceAttack installation folder (or already have it installed somewhere else) you can instead put it elsewhere and create a symbolic link. Open a command prompt (Windows key + R , enter \u201ccmd\u201d, hit Enter ) and do >cd x:\\path\\to\\VoiceAttack\\Apps >mklink /J EDDI x:\\path\\to\\EDDI If you have installed the non-Steam version of VoiceAttack to the default folder within \u201cProgram Files\u201d you will have to run the command prompt as admin (Windows key + R , enter \u201ccmd\u201d, hit Control + Shift + Enter ).","title":"Install EDDI"},{"location":"installing/#install-ed-neutronrouter","text":"Grab the latest release release from Github (The EDNeutronRouter.vX.YZ.zip under \u201cAssets\u201d). You will have to extract the contents of the release .zip file to your VoiceAttack Apps folder: Go into VoiceAttack settings. Click the folder set as \u201cApps Folder\u201d. Now extract the contents of the downloaded file into there. Make sure that they are not naked files under \u201cApps\u201d, but have their own folder \u201cApps\\ED-NeutronRouter\u201d! The exact folder name does not matter as long as they are in a subfolder. Otherwise the plugin will not load. Leave the \u201cApps\u201d folder open in Windows Explorer, you will need it for the next step.","title":"Install ED-NeutronRouter"},{"location":"installing/#import-profiles-package","text":"Acquire the latest release from Github (the alterNERDtive-voiceattack-profiles.vax file under \u201cAssets\u201d). Put it into VoiceAttack\u2019s \u201cImport\u201d folder: Go into VoiceAttack settings. Click the folder set as \u201cApps Folder\u201d. Create a sub folder named \u201cImport\u201d if it does not exist yet. Drop the downloaded .vax file into the \u201cImport\u201d folder. Restart VoiceAttack. When prompted, import the profile package. VoiceAttack will restart when completed.","title":"Import Profiles Package"},{"location":"installing/#create-a-custom-profile","text":"Last but not least you are going to create your own custom VoiceAttack profile for Elite. It will allow you to add your own commands, override any commands in the profiles that you want to change and add voice triggers or hotkeys. You can either use an existing profile, create a new one or use the provided profile example as a basis. Regardless of which way you choose, make sure to read the Include Profiles section and follow the instructions there!","title":"Create a Custom Profile"},{"location":"installing/#option-1-create-a-new-profile-or-use-an-existing-one","text":"Click the \u201cProfile Actions\u201d button, then \u201cCreate New Profile\u201d. Give it a name and add some commands if you want to. Hit \u201cDone\u201d to create the new profile. Alternatively you can keep using your existing profile. You will still have to follow the rest of the instructions in this case.","title":"Option 1: Create a New Profile Or Use an Existing One"},{"location":"installing/#create-a-startup-command","text":"First off, hit the \u201cEdit\u201d button in VoiceAttack. If you are using your existing profile (or have just created a fresh one) you will now have to create the startup command. Hit the \u201cNew Command\u201d button. You can name it anything you want but I recommend calling it \u201cstartup\u201d or similar, and to deactivate the \u201cwhen I say\u201d checkbox in the command options to make sure you do not accidentally run it via voice. Add a new action using \u201cOther\u201d \u2192 \u201cVoiceAttack Action\u201d\u2192 \u201cExecute Another Command\u201d. Choose \u201cExecute by name (Advanced)\u201d and enter ((alterNERDtive-base.startup)) . Make sure to leave \u201cWait until this command completes before continuing\u201d on and have this action at the top of the action list for the command. That way you can be sure that my profiles are initialized properly before your personal startup actions are processed. You can add anything else you want your profile to do when it loads below this action. You do not have to set any configuration options, this can be done way more elegantly! More on this later on . After adding the startup command you will have to right click VoiceAttack\u2019s title bar and choose \u201cReload Active Profile\u201d or restart VoiceAttack to see it executed for the first time.","title":"Create a Startup Command"},{"location":"installing/#option-2-use-the-profile-example","text":"Click the \u201cProfile Actions\u201d button, then \u201cImport Profile\u201d. Navigate to your VoiceAttack Apps folder (see above), go into the \u201calterNERDtive\u201d subfolder, choose the profile example and hit \u201cOpen\u201d. Once you are done with the setup and configuration process, you can find a bunch of example commands with comments on how to do things in this profile. Make sure to also rename it to something more exciting than \u201cCustom Profile Example\u201d!","title":"Option 2: Use the Profile Example"},{"location":"installing/#include-profiles","text":"In order to use my profiles with your custom profile, you will need to take two additional steps: Include the profiles in your custom profile. That will make all commands available when your custom profile is active. Create a startup command for your custom profile. You can use it to do anything you want when your profile loads, but it will also have to run the startup command for my profiles.","title":"Include Profiles"},{"location":"installing/#set-profile-options","text":"While editing the profile, hit the \u201cOptions\u201d button. On the section labeled \u201cInclude commands from other profiles\u201d, hit the \u201c\u2026\u201d button. Add all my profiles (\u201calterNERDtive-base\u201d, \u201cEliteAttack\u201d, \u201cRatAttack\u201d, \u201cSpanshAttack\u201d, \u201cStreamAttack\u201d). Make sure that \u201calterNERDtive-base\u201d is on top of the list, the order of the others does not matter. But I like it nice and alphabetical. Technically you can leave out any profile you are not planning to use. Practically it probably will not hurt you to just include everything, and it will then be available for you in the future should you choose to check it out! Now switch to the \u201cProfile Exec\u201d tab. Tick the \u201cExecute a command each time this profile is loaded\u201d checkbox, and select the \u201cstartup\u201d command you have created earlier.","title":"Set Profile Options"},{"location":"installing/#reload-the-profile","text":"To make sure everything is loaded correctly, you now need to either reload the profile by right clicking on VoiceAttack\u2019s title bar \u2192 \u201cReset Active Profile\u201d or by simply restarting VoiceAttack. You should see a bunch of initialization messages pop up in the VoiceAttack log.","title":"Reload the Profile"},{"location":"installing/#set-elite-keyboard-binds","text":"You need to have keyboard binds setup at least as secondary bindings in Elite\u2019s controls options. VoiceAttack cannot \u201cpush\u201d joystick buttons for you, it can only do keyboard inputs. Hence its only way to interact with Elite is through keyboard emulation, even if you otherwise play the game with a controller or HOTAS. Or racing wheel. Or Rock Band set. Or bananas. For the \u201cGalaxy Map\u201d section, make sure that the bindings do not conflict with the ones in the \u201cInterface Mode\u201d section. The map bindings take precedence and a conflict leads to VoiceAttack being unable to target systems for you. In that case you would see it open the map for you and then wiggle the view for a split second instead of switching tabs over to the system search. Should you use a keyboard layout that is not en-US QWERTY, some keys might not work out of the box. You can try telling bindED about your keyboard layout by setting the bindED.layout# variable (including the # !) to something more appropriate in your startup command. Currently bindED supports the en-US , en-GB and de-Neo2 layouts. You can find instructions on how to add your own here .","title":"Set Elite Keyboard Binds"},{"location":"requirements/","text":"Requirements \u00b6 VoiceAttack \u00b6 Obviously you will need to install VoiceAttack . There is a free trial version available, but that one is limited to a single profile and a few commands. This is 5 profiles and \u2026 a lot of commands. You will need the full version, available for $10 (official site) or \u20ac11.99 (Steam, IIRC $14.99 for our US-based friends). I recommend buying on the site. Why? Because on Steam, Valve gets a 30% cut. Unlike many other developers Gary (the developer of VoiceAttack) remedies that by having a price on Steam that ends up paying $10 to him. So basically, you are paying Valve out of your own pocket. Many other developers do not do that, and by buying from them directly instead of on Steam you are literally giving them extra money. Please do keep that in mind in the future! You also will generally need to opt into the beta version. I am usually at the forefront of bug reports and feature requests, and I do rely on the fixes/additions in beta versions quite often. EDDI \u00b6 EDDI is a companion application for Elite: Dangerous, providing responses to events that occur in-game using data from the game as well as various third-party tools. In this case, you will need to run it as a VoiceAttack plugin. EDDI also regularly publishes beta versions. Unless a profiles release explicitly states it you will not have to run EDDI beta. Do note that the profiles put EDDI into quiet mode by default, disabling the built-in speech responders. This can be changed via the EDDI quiet mode setting . bindED \u00b6 bindED reads your Elite Dangerous binding files and makes them available to VoiceAttack as variables. That way commands can be portable and you do not have to manually go through them and change any actions that you happen to not have the standard binds for. This plugin is included in the release package. You do not have to download and install it manually, but you can independently update it if a newer version is available. Elite Scripts \u00b6 I have written a collection of Python scripts to interface with various 3\u02b3\u1d48 party services like EDSM or Spansh. Those are called by the profiles for various tasks, like checking a system\u2019s body count. In the future they will be replaced by VoiceAttack plugin code. The scripts are included in the release package. You do not have to download and install them manually, but you can independently update them if a newer version is available. ED-NeutronRouter \u00b6 ED-NeutronRouter interfaces with Spansh\u2019s neutron plotter and makes the result available to VoiceAttack. This plugin is only required if you intend to use the SpanshAttack profile for neutron routing. Otherwise you do not have to install it. This will also eventually be replaced by my own plugins.","title":"Requirements"},{"location":"requirements/#requirements","text":"","title":"Requirements"},{"location":"requirements/#voiceattack","text":"Obviously you will need to install VoiceAttack . There is a free trial version available, but that one is limited to a single profile and a few commands. This is 5 profiles and \u2026 a lot of commands. You will need the full version, available for $10 (official site) or \u20ac11.99 (Steam, IIRC $14.99 for our US-based friends). I recommend buying on the site. Why? Because on Steam, Valve gets a 30% cut. Unlike many other developers Gary (the developer of VoiceAttack) remedies that by having a price on Steam that ends up paying $10 to him. So basically, you are paying Valve out of your own pocket. Many other developers do not do that, and by buying from them directly instead of on Steam you are literally giving them extra money. Please do keep that in mind in the future! You also will generally need to opt into the beta version. I am usually at the forefront of bug reports and feature requests, and I do rely on the fixes/additions in beta versions quite often.","title":"VoiceAttack"},{"location":"requirements/#eddi","text":"EDDI is a companion application for Elite: Dangerous, providing responses to events that occur in-game using data from the game as well as various third-party tools. In this case, you will need to run it as a VoiceAttack plugin. EDDI also regularly publishes beta versions. Unless a profiles release explicitly states it you will not have to run EDDI beta. Do note that the profiles put EDDI into quiet mode by default, disabling the built-in speech responders. This can be changed via the EDDI quiet mode setting .","title":"EDDI"},{"location":"requirements/#binded","text":"bindED reads your Elite Dangerous binding files and makes them available to VoiceAttack as variables. That way commands can be portable and you do not have to manually go through them and change any actions that you happen to not have the standard binds for. This plugin is included in the release package. You do not have to download and install it manually, but you can independently update it if a newer version is available.","title":"bindED"},{"location":"requirements/#elite-scripts","text":"I have written a collection of Python scripts to interface with various 3\u02b3\u1d48 party services like EDSM or Spansh. Those are called by the profiles for various tasks, like checking a system\u2019s body count. In the future they will be replaced by VoiceAttack plugin code. The scripts are included in the release package. You do not have to download and install them manually, but you can independently update them if a newer version is available.","title":"Elite Scripts"},{"location":"requirements/#ed-neutronrouter","text":"ED-NeutronRouter interfaces with Spansh\u2019s neutron plotter and makes the result available to VoiceAttack. This plugin is only required if you intend to use the SpanshAttack profile for neutron routing. Otherwise you do not have to install it. This will also eventually be replaced by my own plugins.","title":"ED-NeutronRouter"},{"location":"troubleshooting/","text":"Troubleshooting \u00b6 This will fill up gradually with Troubleshooting tips as people run into common ones. VoiceAttack does not understand me / mishears me / fires random commands \u00b6 There is a thread on the VoiceAttack forums on how to set up your microphone and the speech recognition engine to work best. If your microphone is bad and you still get erroneous recognitions when you are not speaking it is probably going to recognize the same command every time. You can remedy that by blocking the voice trigger. One-syllable triggers are especially prone to misrecognition. Create a new command in your custom profile. Set the \u201cwhen I say\u201d field to the trigger that gets misrecognized. Adding the \u201cOther\u201d \u2192 \u201cVoiceAttack Action\u201d \u2192 \u201cIgnore an Unrecognized Word or Phrase\u201d action will also hide it from the VoiceAttack log when it is (wrongly) recognized. You might or might not want that. Example for the \u201ccruise\u201d voice trigger of the Supercruise command: Alternatively you can raise the minimum confidence level and call the underlying command to make misfires less likely: There are a few examples in the Custom Profile Example . VoiceAttack recognizes a command, but doesn\u2019t do anything in game \u00b6 Make sure you have a keyboard bind for whatever the command is supposed to do as outlined in Installing#Set Elite Keyboard Binds . VoiceAttack talks over the COVAS voice \u00b6 There is no way to know for sure when the ingame COVAS is talking to you, so there is no way to always prevent the two from speaking over each other. You can however either disable TTS responses for events that you know will clash (or file a feature request if one is not optional yet). Alternatively, if you prefer the info given by VoiceAttack over the ingame COVAS, you can deactivate its response to these events in the ingame Audo settings: While you\u2019re in there you might as well get rid of the spoken FSD countdown that is off by one second \u2026 This doesn\u2019t work (well) with my HCS pack \u00b6 My profiles are designed from the ground up to work with whatever else you are doing with VoiceAttack; that is the reason for importing them into your own custom profile instead of selecting e.g. EliteAttack as your active profile. HCS on the contrary explicitly expects you do exclusively use HCS with VoiceAttack. There is the rudimentary way of including simple profiles into theirs, but the mechanism falls flat in many places. For example you cannot tell HCS to run an included profile\u2019s startup command. So, in order to mostly make stuff work, you need to treat the HCS profile as your \u201ccustom\u201d profile as per this documentation. Include alterNERDtive-base and all profiles you want to use into the active HCS profile. Include a custom profile that has a startup command with a voice trigger of your choosing, e.g. \u201cload included profiles\u201d. Set up said startup command as you would normally. Every time you start VA or change profiles, you will have to manually say \u201cload included profiles\u201d. That will make most things work. Conflicts may arise if HCS happens to have voice triggers that are the same as mine, in which case their command will take priority. Note on TTS : EDDI\u2019s TTS (used by my profiles) and HCS\u2019 TTS / recorded voice lines act 100% independently. That means they will frequently \u201cspeak over each other\u201d. There is no way to alleviate this. EDDI does have a mechanism to detect if it is currently speaking \u2013 it sets a corresponding VoiceAttack variable. HCS neither does anything similar nor checks if EDDI is speaking to prevent conflicts. Refer to them if you want that changed. This does not work with Geforce Now \u00b6 Nope. Just won\u2019t. Geforce Now obviously has Elite\u2019s files, journals and keybinds stored on some random PC in the cloud. Your local VoiceAttack has no way of accessing those. If you can get VoiceAttack to run on Geforce Now in parallel to Elite, I don\u2019t see why it wouldn\u2019t work.","title":"Troubleshooting"},{"location":"troubleshooting/#troubleshooting","text":"This will fill up gradually with Troubleshooting tips as people run into common ones.","title":"Troubleshooting"},{"location":"troubleshooting/#voiceattack-does-not-understand-me-mishears-me-fires-random-commands","text":"There is a thread on the VoiceAttack forums on how to set up your microphone and the speech recognition engine to work best. If your microphone is bad and you still get erroneous recognitions when you are not speaking it is probably going to recognize the same command every time. You can remedy that by blocking the voice trigger. One-syllable triggers are especially prone to misrecognition. Create a new command in your custom profile. Set the \u201cwhen I say\u201d field to the trigger that gets misrecognized. Adding the \u201cOther\u201d \u2192 \u201cVoiceAttack Action\u201d \u2192 \u201cIgnore an Unrecognized Word or Phrase\u201d action will also hide it from the VoiceAttack log when it is (wrongly) recognized. You might or might not want that. Example for the \u201ccruise\u201d voice trigger of the Supercruise command: Alternatively you can raise the minimum confidence level and call the underlying command to make misfires less likely: There are a few examples in the Custom Profile Example .","title":"VoiceAttack does not understand me / mishears me / fires random commands"},{"location":"troubleshooting/#voiceattack-recognizes-a-command-but-doesnt-do-anything-in-game","text":"Make sure you have a keyboard bind for whatever the command is supposed to do as outlined in Installing#Set Elite Keyboard Binds .","title":"VoiceAttack recognizes a command, but doesn\u2019t do anything in game"},{"location":"troubleshooting/#voiceattack-talks-over-the-covas-voice","text":"There is no way to know for sure when the ingame COVAS is talking to you, so there is no way to always prevent the two from speaking over each other. You can however either disable TTS responses for events that you know will clash (or file a feature request if one is not optional yet). Alternatively, if you prefer the info given by VoiceAttack over the ingame COVAS, you can deactivate its response to these events in the ingame Audo settings: While you\u2019re in there you might as well get rid of the spoken FSD countdown that is off by one second \u2026","title":"VoiceAttack talks over the COVAS voice"},{"location":"troubleshooting/#this-doesnt-work-well-with-my-hcs-pack","text":"My profiles are designed from the ground up to work with whatever else you are doing with VoiceAttack; that is the reason for importing them into your own custom profile instead of selecting e.g. EliteAttack as your active profile. HCS on the contrary explicitly expects you do exclusively use HCS with VoiceAttack. There is the rudimentary way of including simple profiles into theirs, but the mechanism falls flat in many places. For example you cannot tell HCS to run an included profile\u2019s startup command. So, in order to mostly make stuff work, you need to treat the HCS profile as your \u201ccustom\u201d profile as per this documentation. Include alterNERDtive-base and all profiles you want to use into the active HCS profile. Include a custom profile that has a startup command with a voice trigger of your choosing, e.g. \u201cload included profiles\u201d. Set up said startup command as you would normally. Every time you start VA or change profiles, you will have to manually say \u201cload included profiles\u201d. That will make most things work. Conflicts may arise if HCS happens to have voice triggers that are the same as mine, in which case their command will take priority. Note on TTS : EDDI\u2019s TTS (used by my profiles) and HCS\u2019 TTS / recorded voice lines act 100% independently. That means they will frequently \u201cspeak over each other\u201d. There is no way to alleviate this. EDDI does have a mechanism to detect if it is currently speaking \u2013 it sets a corresponding VoiceAttack variable. HCS neither does anything similar nor checks if EDDI is speaking to prevent conflicts. Refer to them if you want that changed.","title":"This doesn\u2019t work (well) with my HCS pack"},{"location":"troubleshooting/#this-does-not-work-with-geforce-now","text":"Nope. Just won\u2019t. Geforce Now obviously has Elite\u2019s files, journals and keybinds stored on some random PC in the cloud. Your local VoiceAttack has no way of accessing those. If you can get VoiceAttack to run on Geforce Now in parallel to Elite, I don\u2019t see why it wouldn\u2019t work.","title":"This does not work with Geforce Now"},{"location":"upgrading/","text":"Upgrading \u00b6 To upgrade to the latest version, follow these simple steps: Say \u201cdownload profiles update\u201d. Put the alterNERDtive-voiceattack-profiles.vax file from Github into VoiceAttack\u2019s \u201cImport\u201d folder. Restart VoiceAttack. In general, migration from old versions will be handled automatically. If there is something you have to do manually you will find the necessary steps below. You can find the full Changelog on Github. 3.x.x to 4.x.x \u00b6 If you have been using a custom profile as outlined in Installing#Create a Custom Profile your settings will be migrated to the new variables automatically. If you have not and you have used my \u201cEliteDangerous\u201d profile as the main profile \u2026 well, you will unfortunately have to take note of your settings, and recreate them after creating a custom profile and including everything. Please do not fiddle with the configuration variables from your startup command (or any other, really). It should not break anything, but it might. And it is entirely unnecessary since configuration will be saved to and loaded from the profile anyway. EDDI Events \u00b6 The process for adding your own handlers for EDDI events has changed. You no longer have to check which of my profiles handle them and add the commands for those manually; instead you need to run the eddi.event context of the alterNERDtive-base plugin . bindED \u00b6 If you have done anything non-standard with bindED before, it might break. The profiles now include my fork of bindED which has a lot more features, but does no longer support a bunch of plugin invocations that have become obsolete. Please file an issue with bindED on Github if your use case does not work anymore. EliteDangerous \u00b6 The \u201cEliteDangerous\u201d profile is no longer the main profile. Instead you will have to create a custom profile, and the new \u201cbase\u201d profile that the others require to be included in your custom profile is \u201calterNERDtive-base\u201d. That way you can use e.g. RatAttack without having to also use the general Elite profile. To be consistent with the other profiles it has been renamed to \u201cEliteAttack\u201d. If you are upgrading from an older version the name will not change for you in the profiles list. I recommend renaming your \u201cEliteDangerous\u201d profile to \u201cEliteAttack\u201d to prevent confusion in the future, but it is not strictly necessary to do so. RatAttack \u00b6 Getting Case Data From IRC \u00b6 Handing a RATSIGNAL from IRC to VoiceAttack via text file is now deprecated and the feature will be removed in a future version. Instead you should use the new RatAttack-cli.exe helper tool that uses IPC to talk to the VoiceAttack plugin. For that you have to change the way your IRC client handles incoming case announcements. Instead of writing the announcement to the text file and calling VoiceAttack to run a command, it will have to call the helper tool with a) the announcement and b) an optional true/false switch to determine if the case should be announced via TTS or just added to the case list. For my AdiIRC, it looks like this (obviously change the path, please): on *:TEXT:*RATSIGNAL*(??_SIGNAL):#fuelrats:{ if ( $away ) { /run -h \"X:\\path\\to\\VoiceAttack\\Apps\\alterNERDtive\\RatAttack-cli.exe\" \" $+ $replace($1-,\",\"\") $+ \" false } else { /run -h \"X:\\path\\to\\VoiceAttack\\Apps\\alterNERDtive\\RatAttack-cli.exe\" \" $+ $replace($1-,\",\"\") $+ \" true } } If I am away it will just add the new case to the list. If I am not away, it will announce it using TTS. The $replace part handles the fact that case announcements now put the system in quotes. They have to be escaped as double quotes ( \"\" ) to create a correct command line invocation. Nearest CMDR Announcements \u00b6 If you have RatAttack set up to announce your nearest commander to a case, you\u2019ll have to change the setting to the new format, separated by ; instead of whitespace. Say \u201ccustomize setting set fuel rat commanders\u201d to update it.","title":"Upgrading"},{"location":"upgrading/#upgrading","text":"To upgrade to the latest version, follow these simple steps: Say \u201cdownload profiles update\u201d. Put the alterNERDtive-voiceattack-profiles.vax file from Github into VoiceAttack\u2019s \u201cImport\u201d folder. Restart VoiceAttack. In general, migration from old versions will be handled automatically. If there is something you have to do manually you will find the necessary steps below. You can find the full Changelog on Github.","title":"Upgrading"},{"location":"upgrading/#3xx-to-4xx","text":"If you have been using a custom profile as outlined in Installing#Create a Custom Profile your settings will be migrated to the new variables automatically. If you have not and you have used my \u201cEliteDangerous\u201d profile as the main profile \u2026 well, you will unfortunately have to take note of your settings, and recreate them after creating a custom profile and including everything. Please do not fiddle with the configuration variables from your startup command (or any other, really). It should not break anything, but it might. And it is entirely unnecessary since configuration will be saved to and loaded from the profile anyway.","title":"3.x.x to 4.x.x"},{"location":"upgrading/#eddi-events","text":"The process for adding your own handlers for EDDI events has changed. You no longer have to check which of my profiles handle them and add the commands for those manually; instead you need to run the eddi.event context of the alterNERDtive-base plugin .","title":"EDDI Events"},{"location":"upgrading/#binded","text":"If you have done anything non-standard with bindED before, it might break. The profiles now include my fork of bindED which has a lot more features, but does no longer support a bunch of plugin invocations that have become obsolete. Please file an issue with bindED on Github if your use case does not work anymore.","title":"bindED"},{"location":"upgrading/#elitedangerous","text":"The \u201cEliteDangerous\u201d profile is no longer the main profile. Instead you will have to create a custom profile, and the new \u201cbase\u201d profile that the others require to be included in your custom profile is \u201calterNERDtive-base\u201d. That way you can use e.g. RatAttack without having to also use the general Elite profile. To be consistent with the other profiles it has been renamed to \u201cEliteAttack\u201d. If you are upgrading from an older version the name will not change for you in the profiles list. I recommend renaming your \u201cEliteDangerous\u201d profile to \u201cEliteAttack\u201d to prevent confusion in the future, but it is not strictly necessary to do so.","title":"EliteDangerous"},{"location":"upgrading/#ratattack","text":"","title":"RatAttack"},{"location":"upgrading/#getting-case-data-from-irc","text":"Handing a RATSIGNAL from IRC to VoiceAttack via text file is now deprecated and the feature will be removed in a future version. Instead you should use the new RatAttack-cli.exe helper tool that uses IPC to talk to the VoiceAttack plugin. For that you have to change the way your IRC client handles incoming case announcements. Instead of writing the announcement to the text file and calling VoiceAttack to run a command, it will have to call the helper tool with a) the announcement and b) an optional true/false switch to determine if the case should be announced via TTS or just added to the case list. For my AdiIRC, it looks like this (obviously change the path, please): on *:TEXT:*RATSIGNAL*(??_SIGNAL):#fuelrats:{ if ( $away ) { /run -h \"X:\\path\\to\\VoiceAttack\\Apps\\alterNERDtive\\RatAttack-cli.exe\" \" $+ $replace($1-,\",\"\") $+ \" false } else { /run -h \"X:\\path\\to\\VoiceAttack\\Apps\\alterNERDtive\\RatAttack-cli.exe\" \" $+ $replace($1-,\",\"\") $+ \" true } } If I am away it will just add the new case to the list. If I am not away, it will announce it using TTS. The $replace part handles the fact that case announcements now put the system in quotes. They have to be escaped as double quotes ( \"\" ) to create a correct command line invocation.","title":"Getting Case Data From IRC"},{"location":"upgrading/#nearest-cmdr-announcements","text":"If you have RatAttack set up to announce your nearest commander to a case, you\u2019ll have to change the setting to the new format, separated by ; instead of whitespace. Say \u201ccustomize setting set fuel rat commanders\u201d to update it.","title":"Nearest CMDR Announcements"},{"location":"configuration/EliteAttack/","text":"EliteAttack \u00b6 Settings \u00b6 Toggles: auto honk all systems : Automatically honk upon entering a system, each jump, without constraints. Default: false. auto honk new systems : Automatically honk upon entering a system if it is your first visit. Default: true. auto refuel : Automatically refuel after docking at a station. Default: true. auto repair : Automatically repair after docking at a station. Default: true. auto restock : Automatically restock after docking at a station. Default: true. auto move to hangar : Automatically move the ship to the hangar after docking at a station. Default: true. auto enter station services : Automatically enter the Station Services menu after docking at a station. Default: true. auto retract landing gear : Automatically retract landing gear when lifting off a planet / undocking from a station. Default: true. (#133) auto disable s r v lights : Automatically turn SRV lights off when deploying one. Default: true. (#133) edsm system status : Pull system data from EDSM and compare it against your discovery scan. Default: true. discovery scan on primary fire : Use primary fire for honking instead of secondary. Default: false. flight assist off : Permanent Flight Assist off mode. You should really do that, it\u2019s great. Default: false. hyper space dethrottle : Throttle down after a jump and when dropping from SC. Like the SC Assist module does. Default: true. limpet check : Do a limpet check when undocking, reminding you if you forgot to buy some. Default: true. mapping candidates : Announce bodies worth mapping when you have finished scanning a system. (Terraformables, Water Worlds, Earth-Like Worlds and Ammonia Worlds that have not been mapped yet.) Default: true. outdated stations : Announce stations with outdated data in the online databases. Default: true. include outdated settlements option: Include Odyssey settlements in the outdated stations list. Default: true. repair reports : Report on AFMU repairs. Default: true. road to riches : Announce bodies worth scanning if you are looking for some starting cash on the Road to Riches. Default: false. route jump count : Give a jump count on plotting a route. Default: true. synthesis reports : Report on synthesis. Default: true. Other settings: outdated station threshold : The threshold for station data to count as \u201coutdated\u201d, in days. Default: 365. scanner fire group : The fire group your discovery scanner is assigned to. Default: 0 (the first one).","title":"EliteAttack"},{"location":"configuration/EliteAttack/#eliteattack","text":"","title":"EliteAttack"},{"location":"configuration/EliteAttack/#settings","text":"Toggles: auto honk all systems : Automatically honk upon entering a system, each jump, without constraints. Default: false. auto honk new systems : Automatically honk upon entering a system if it is your first visit. Default: true. auto refuel : Automatically refuel after docking at a station. Default: true. auto repair : Automatically repair after docking at a station. Default: true. auto restock : Automatically restock after docking at a station. Default: true. auto move to hangar : Automatically move the ship to the hangar after docking at a station. Default: true. auto enter station services : Automatically enter the Station Services menu after docking at a station. Default: true. auto retract landing gear : Automatically retract landing gear when lifting off a planet / undocking from a station. Default: true. (#133) auto disable s r v lights : Automatically turn SRV lights off when deploying one. Default: true. (#133) edsm system status : Pull system data from EDSM and compare it against your discovery scan. Default: true. discovery scan on primary fire : Use primary fire for honking instead of secondary. Default: false. flight assist off : Permanent Flight Assist off mode. You should really do that, it\u2019s great. Default: false. hyper space dethrottle : Throttle down after a jump and when dropping from SC. Like the SC Assist module does. Default: true. limpet check : Do a limpet check when undocking, reminding you if you forgot to buy some. Default: true. mapping candidates : Announce bodies worth mapping when you have finished scanning a system. (Terraformables, Water Worlds, Earth-Like Worlds and Ammonia Worlds that have not been mapped yet.) Default: true. outdated stations : Announce stations with outdated data in the online databases. Default: true. include outdated settlements option: Include Odyssey settlements in the outdated stations list. Default: true. repair reports : Report on AFMU repairs. Default: true. road to riches : Announce bodies worth scanning if you are looking for some starting cash on the Road to Riches. Default: false. route jump count : Give a jump count on plotting a route. Default: true. synthesis reports : Report on synthesis. Default: true. Other settings: outdated station threshold : The threshold for station data to count as \u201coutdated\u201d, in days. Default: 365. scanner fire group : The fire group your discovery scanner is assigned to. Default: 0 (the first one).","title":"Settings"},{"location":"configuration/RatAttack/","text":"RatAttack \u00b6 Getting Case Data From IRC \u00b6 You can setup your IRC client to pass incoming RATSIGNALS to VoiceAttack by calling the RatAttack-cli.exe helper tool with the RATSIGNAL as first argument and an optional boolean as second argument that triggers a TTS case announcement. You can find it under your VoiceAttack \u201cApps\u201d folder, \\alterNERDtive\\RatAttack-cli.exe . Note : If you are running VoiceAttack as admin, you need to run your IRC client as admin, too! Otherwise they cannot communicate. In general you want to run both with normal privileges. This has two purposes: Announcing a new incoming case (if passing true as second argument). Storing case data and making it available to VoiceAttack, e.g. for copying the client\u2019s system into the clipboard. For my AdiIRC, it looks like this (obviously change the path, please): on *:TEXT:*RATSIGNAL*(??_SIGNAL):#fuelrats:{ if ( $away ) { /run -h \"X:\\path\\to\\VoiceAttack\\Apps\\alterNERDtive\\RatAttack-cli.exe\" \" $+ $replace($1-,\",\"\") $+ \" false } else { /run -h \"X:\\path\\to\\VoiceAttack\\Apps\\alterNERDtive\\RatAttack-cli.exe\" \" $+ $replace($1-,\",\"\") $+ \" true } } If I am away it will just add the new case to the list. If I am not away, it will announce it using TTS. The \u201creplace\u201d part handles the fact that announcements now put the system in quotes. They have to be escaped as double quotes ( \"\" ) to create a correct command invocation. You get the gist; if not and you don\u2019t know how to do the same thing for your IRC client, either switch to AdiIRC or bribe me to make an example for yours. mIRC is a straight forward copy & paste job from Adi to mIRC (\u201cTools\u201d \u2192 \u201cScript Editor\u201d \u2192 \u201cRemote\u201d). Make sure you do not strip colour codes from incoming messages! Note for Hexchat users: Hexchat doesn\u2019t seem to have a simple way of doing this. If you figure it out, I\u2019ll gladly add instructions here. Keep in mind that if you are not on duty (see below) you will not get case announcements. Announcing Your Nearest CMDR \u00b6 In case you have more than one CMDR registered as a Fuel Rat you can have VoiceAttack announce the nearest one to a case and the distance. You will have to go through a couple steps to set that up: Have all CMDRs on EDSM. Have all profiles on EDSM set to public including your flight log (which includes the current location). Set the CMDR names you want to use (\u201ccustomize setting set fuel rat commanders\u201d). Enable the nearest CMDR announcements (\u201ccustomize setting enable nearest commander to fuel rat case\u201d). You can use this for a single CMDR, too. A less convoluted setup for announcing the distance to your location in that case is on the list\u2122 but does not have an ETA yet. Currently there is no way to specify a platform for each CMDR separately. Sending Text to FuelRats IRC \u00b6 The profile will attempt to send calls to \u201c#fuelrats\u201d, and you can send messages from ingame chat to \u201c#fuelrats\u201d and \u201c#ratchat\u201d. That will send text to windows with \u201c#fuelrats\u201d and \u201c#ratchat\u201d in their title, respectively. If your IRC client does not do that, you will have to change the \u201ctarget\u201d window of the RatAttack.sendToFuelrats and RatAttack.sendToRatchat commands to reflect the actual window titles on your system. I will look into making this more elegant to change in the future. Settings \u00b6 Toggles: auto close fuel rat case : Automatically close a rat case when sending \u201cfuel+\u201d via voice command or ingame chat. Default: false. auto copy rat case system : Automatically copy the client\u2019s system to the clipboard when you open a rat case. Default: true. fuel rat call confirmation : Only make calls in #fuelrats after vocal confirmation to prevent mistakes. Default: true. fuel rat duty : On duty, receiving case announcements via TTS. Default: true. nearest commander to fuel rat case : Announce the nearest commander to incoming rat cases. Default: false. platform for fuel rat case : Announce the platform for incoming rat cases. Default: false. system information for fuel rat case : System information provided by Mecha. Default: true. Other Settings: fuel rat commanders : All your CMDRs that are ready to take rat cases. Use \u2018;\u2019 as separator, e.g. \u201cBud Spencer;Terrence Hill\u201d. Default: \"\". fuel rat platforms : The platform(s) you want to get case announcements for (PC, Xbox, Playstation). Use \u2018;\u2019 as separator, e.g. \u201cPC;Xbox\u201d. Default: \"PC\".","title":"RatAttack"},{"location":"configuration/RatAttack/#ratattack","text":"","title":"RatAttack"},{"location":"configuration/RatAttack/#getting-case-data-from-irc","text":"You can setup your IRC client to pass incoming RATSIGNALS to VoiceAttack by calling the RatAttack-cli.exe helper tool with the RATSIGNAL as first argument and an optional boolean as second argument that triggers a TTS case announcement. You can find it under your VoiceAttack \u201cApps\u201d folder, \\alterNERDtive\\RatAttack-cli.exe . Note : If you are running VoiceAttack as admin, you need to run your IRC client as admin, too! Otherwise they cannot communicate. In general you want to run both with normal privileges. This has two purposes: Announcing a new incoming case (if passing true as second argument). Storing case data and making it available to VoiceAttack, e.g. for copying the client\u2019s system into the clipboard. For my AdiIRC, it looks like this (obviously change the path, please): on *:TEXT:*RATSIGNAL*(??_SIGNAL):#fuelrats:{ if ( $away ) { /run -h \"X:\\path\\to\\VoiceAttack\\Apps\\alterNERDtive\\RatAttack-cli.exe\" \" $+ $replace($1-,\",\"\") $+ \" false } else { /run -h \"X:\\path\\to\\VoiceAttack\\Apps\\alterNERDtive\\RatAttack-cli.exe\" \" $+ $replace($1-,\",\"\") $+ \" true } } If I am away it will just add the new case to the list. If I am not away, it will announce it using TTS. The \u201creplace\u201d part handles the fact that announcements now put the system in quotes. They have to be escaped as double quotes ( \"\" ) to create a correct command invocation. You get the gist; if not and you don\u2019t know how to do the same thing for your IRC client, either switch to AdiIRC or bribe me to make an example for yours. mIRC is a straight forward copy & paste job from Adi to mIRC (\u201cTools\u201d \u2192 \u201cScript Editor\u201d \u2192 \u201cRemote\u201d). Make sure you do not strip colour codes from incoming messages! Note for Hexchat users: Hexchat doesn\u2019t seem to have a simple way of doing this. If you figure it out, I\u2019ll gladly add instructions here. Keep in mind that if you are not on duty (see below) you will not get case announcements.","title":"Getting Case Data From IRC"},{"location":"configuration/RatAttack/#announcing-your-nearest-cmdr","text":"In case you have more than one CMDR registered as a Fuel Rat you can have VoiceAttack announce the nearest one to a case and the distance. You will have to go through a couple steps to set that up: Have all CMDRs on EDSM. Have all profiles on EDSM set to public including your flight log (which includes the current location). Set the CMDR names you want to use (\u201ccustomize setting set fuel rat commanders\u201d). Enable the nearest CMDR announcements (\u201ccustomize setting enable nearest commander to fuel rat case\u201d). You can use this for a single CMDR, too. A less convoluted setup for announcing the distance to your location in that case is on the list\u2122 but does not have an ETA yet. Currently there is no way to specify a platform for each CMDR separately.","title":"Announcing Your Nearest CMDR"},{"location":"configuration/RatAttack/#sending-text-to-fuelrats-irc","text":"The profile will attempt to send calls to \u201c#fuelrats\u201d, and you can send messages from ingame chat to \u201c#fuelrats\u201d and \u201c#ratchat\u201d. That will send text to windows with \u201c#fuelrats\u201d and \u201c#ratchat\u201d in their title, respectively. If your IRC client does not do that, you will have to change the \u201ctarget\u201d window of the RatAttack.sendToFuelrats and RatAttack.sendToRatchat commands to reflect the actual window titles on your system. I will look into making this more elegant to change in the future.","title":"Sending Text to FuelRats IRC"},{"location":"configuration/RatAttack/#settings","text":"Toggles: auto close fuel rat case : Automatically close a rat case when sending \u201cfuel+\u201d via voice command or ingame chat. Default: false. auto copy rat case system : Automatically copy the client\u2019s system to the clipboard when you open a rat case. Default: true. fuel rat call confirmation : Only make calls in #fuelrats after vocal confirmation to prevent mistakes. Default: true. fuel rat duty : On duty, receiving case announcements via TTS. Default: true. nearest commander to fuel rat case : Announce the nearest commander to incoming rat cases. Default: false. platform for fuel rat case : Announce the platform for incoming rat cases. Default: false. system information for fuel rat case : System information provided by Mecha. Default: true. Other Settings: fuel rat commanders : All your CMDRs that are ready to take rat cases. Use \u2018;\u2019 as separator, e.g. \u201cBud Spencer;Terrence Hill\u201d. Default: \"\". fuel rat platforms : The platform(s) you want to get case announcements for (PC, Xbox, Playstation). Use \u2018;\u2019 as separator, e.g. \u201cPC;Xbox\u201d. Default: \"PC\".","title":"Settings"},{"location":"configuration/SpanshAttack/","text":"SpanshAttack \u00b6 Supplying Your Ship\u2019s Range \u00b6 The ED-NeutronRouter plugin is technically supposed to read the current jump range from EDDI; sadly EDDI is storing the maximum distance for your ship instead of the current / full on fuel one. The \u201cdefault to laden range\u201d option works reasonably well, but it has a few quirks. It always assumes full cargo, and it will take your current fuel levels for range calculations, disregrading the range loss if you fill your tank. For any ships that you regularly use for neutron jumping, e.g. long range Fuel Rat ships, I recommend telling SpanshAttack about the range they are supposed to have with full fuel and your preferred amount of cargo/limpets. In order to do that, copy the SpanshAttack.getShipRange command from SpanshAttack or the example profile to your custom profile and add your ships. Any ship listed in there will automatically have its jump range used instead of EDDI\u2019s reported laden range or VoiceAttack prompting you to manually supply it. You can override a saved range for your ship by using the plot neutron [course;route;trip] with custom range command. Settings \u00b6 Toggles: auto jump after scooping : Automatically jump out when fuel scooping is complete. Default: true. auto plot : Automatically plot to the next waypoint after supercharging. Default: true. clear neutron route on shutdown : Clear an active neutron route when the game is shut down. Default: true. copy neutron waypoints to clipboard : Copy each neutron waypoint into the Windows clipboard. Default: false. default to laden range : Default to the current ship\u2019s laden range as reported by EDDI instead of prompting for input. Default: false. time neutron route : Keep track of how long a neutron route takes you to complete. Default: false. waypoint announcements : Announce each waypoint by name. Default: true. Other Settings: announce jumps left : Estimated jumps left to announce when reached. NEEDS to have leading and trailing \u201c;\u201d. Default: \";1;3;5;10;15;20;30;50;75;100;\"","title":"SpanshAttack"},{"location":"configuration/SpanshAttack/#spanshattack","text":"","title":"SpanshAttack"},{"location":"configuration/SpanshAttack/#supplying-your-ships-range","text":"The ED-NeutronRouter plugin is technically supposed to read the current jump range from EDDI; sadly EDDI is storing the maximum distance for your ship instead of the current / full on fuel one. The \u201cdefault to laden range\u201d option works reasonably well, but it has a few quirks. It always assumes full cargo, and it will take your current fuel levels for range calculations, disregrading the range loss if you fill your tank. For any ships that you regularly use for neutron jumping, e.g. long range Fuel Rat ships, I recommend telling SpanshAttack about the range they are supposed to have with full fuel and your preferred amount of cargo/limpets. In order to do that, copy the SpanshAttack.getShipRange command from SpanshAttack or the example profile to your custom profile and add your ships. Any ship listed in there will automatically have its jump range used instead of EDDI\u2019s reported laden range or VoiceAttack prompting you to manually supply it. You can override a saved range for your ship by using the plot neutron [course;route;trip] with custom range command.","title":"Supplying Your Ship\u2019s Range"},{"location":"configuration/SpanshAttack/#settings","text":"Toggles: auto jump after scooping : Automatically jump out when fuel scooping is complete. Default: true. auto plot : Automatically plot to the next waypoint after supercharging. Default: true. clear neutron route on shutdown : Clear an active neutron route when the game is shut down. Default: true. copy neutron waypoints to clipboard : Copy each neutron waypoint into the Windows clipboard. Default: false. default to laden range : Default to the current ship\u2019s laden range as reported by EDDI instead of prompting for input. Default: false. time neutron route : Keep track of how long a neutron route takes you to complete. Default: false. waypoint announcements : Announce each waypoint by name. Default: true. Other Settings: announce jumps left : Estimated jumps left to announce when reached. NEEDS to have leading and trailing \u201c;\u201d. Default: \";1;3;5;10;15;20;30;50;75;100;\"","title":"Settings"},{"location":"configuration/StreamAttack/","text":"StreamAttack \u00b6 Settings \u00b6 StreamAttack output directory : The directory the status files are written to. Default: \"%appdata%\\StreamAttack\\\"","title":"StreamAttack"},{"location":"configuration/StreamAttack/#streamattack","text":"","title":"StreamAttack"},{"location":"configuration/StreamAttack/#settings","text":"StreamAttack output directory : The directory the status files are written to. Default: \"%appdata%\\StreamAttack\\\"","title":"Settings"},{"location":"configuration/general/","text":"General Configuration \u00b6 Settings \u00b6 All profiles will load sane defaults if you haven\u2019t changed anything. The configuration is stored in a bunch of VoiceAttack variables which in turn are stored in your custom profile. You could even have different custom profiles with their own distinct settings. The easiest way to change settings is to say customize settings . That will bring up a rudimentary settings UI. You change also change the configuration directly via voice commands: For toggles (booleans): customize setting [enable;disable] For everything else: customize setting set You can find a list of trigger phrases on this page, or you can say customize setting list [options;settings] for a list of voice triggers and what they do. If you don\u2019t remember your settings or just want a nice list, customize setting report [options;settings] will print that to the VoiceAttack log. If you want to reset everything back to default state, say customize setting clear all my settings . The \u201ccustomize setting\u201d prefix is kind of a leftover from times long gone and does not quite fit anymore. Might change in a future version. Since the settings are saved to your custom profile they will not necessarily be preserved when you switch profiles. Once you switch back, the correct settings for the profile are re-loaded. General Settings for All Profiles \u00b6 Toggles: auto update check : Automatically check Github for profiles updates when the profile loads. Default: true. eddi quiet mode : Make EDDI shut up. Disables all built-in speech responders. Default: true. Other settings: elite paste key : The key used to paste in conjunction with CTRL. The physical key in your layout that would be 'V' on QWERTY. Default: 'v'. log level : The level of detail for logging to the VoiceAttack log. Valid levels are \"ERROR\", \"WARN\", \"NOTICE\", \"INFO\" and \"DEBUG\". Default: \"NOTICE\". quit to desktop delay : The delay before restarting the game after hitting \u201cExit to Desktop\u201d, in seconds. Default: 10.0. (Used by the restart from desktop command) Note on Non-Standard Keyboard Layouts \u00b6 Because Elite\u2019s keyboard handling is \u2026 weird you\u2019ll have to set the key to use for pasting text into Elite Dangerous if you are not using a keyboard layout that the game supports by default. You will have to change it to the key that is physically in the place where V would be on QWERTY, e.g. P for Neo2 . To set the key, say \u201ccustomize setting set elite paste key\u201d. Adding Commands \u00b6 If you want to edit a command or add your own, do not edit the profiles directly . Instead create commands in your custom profile, and copy commands you want to change over to that before editing them. This will make sure no changes are lost if you update the profiles. EDDI Events \u00b6 Because of limitations of VoiceAttack itself, only the first matching command found will be executed, including EDDI events . That means that if you create commands to handle EDDI events, you are going to have to make sure that the appropriate handlers in my profiles are called, too. That is done by invoking the eddi.Event plugin context of the alterNERDtive-base plugin. Otherwise stuff will break.","title":"General Configuration"},{"location":"configuration/general/#general-configuration","text":"","title":"General Configuration"},{"location":"configuration/general/#settings","text":"All profiles will load sane defaults if you haven\u2019t changed anything. The configuration is stored in a bunch of VoiceAttack variables which in turn are stored in your custom profile. You could even have different custom profiles with their own distinct settings. The easiest way to change settings is to say customize settings . That will bring up a rudimentary settings UI. You change also change the configuration directly via voice commands: For toggles (booleans): customize setting [enable;disable] For everything else: customize setting set You can find a list of trigger phrases on this page, or you can say customize setting list [options;settings] for a list of voice triggers and what they do. If you don\u2019t remember your settings or just want a nice list, customize setting report [options;settings] will print that to the VoiceAttack log. If you want to reset everything back to default state, say customize setting clear all my settings . The \u201ccustomize setting\u201d prefix is kind of a leftover from times long gone and does not quite fit anymore. Might change in a future version. Since the settings are saved to your custom profile they will not necessarily be preserved when you switch profiles. Once you switch back, the correct settings for the profile are re-loaded.","title":"Settings"},{"location":"configuration/general/#general-settings-for-all-profiles","text":"Toggles: auto update check : Automatically check Github for profiles updates when the profile loads. Default: true. eddi quiet mode : Make EDDI shut up. Disables all built-in speech responders. Default: true. Other settings: elite paste key : The key used to paste in conjunction with CTRL. The physical key in your layout that would be 'V' on QWERTY. Default: 'v'. log level : The level of detail for logging to the VoiceAttack log. Valid levels are \"ERROR\", \"WARN\", \"NOTICE\", \"INFO\" and \"DEBUG\". Default: \"NOTICE\". quit to desktop delay : The delay before restarting the game after hitting \u201cExit to Desktop\u201d, in seconds. Default: 10.0. (Used by the restart from desktop command)","title":"General Settings for All Profiles"},{"location":"configuration/general/#note-on-non-standard-keyboard-layouts","text":"Because Elite\u2019s keyboard handling is \u2026 weird you\u2019ll have to set the key to use for pasting text into Elite Dangerous if you are not using a keyboard layout that the game supports by default. You will have to change it to the key that is physically in the place where V would be on QWERTY, e.g. P for Neo2 . To set the key, say \u201ccustomize setting set elite paste key\u201d.","title":"Note on Non-Standard Keyboard Layouts"},{"location":"configuration/general/#adding-commands","text":"If you want to edit a command or add your own, do not edit the profiles directly . Instead create commands in your custom profile, and copy commands you want to change over to that before editing them. This will make sure no changes are lost if you update the profiles.","title":"Adding Commands"},{"location":"configuration/general/#eddi-events","text":"Because of limitations of VoiceAttack itself, only the first matching command found will be executed, including EDDI events . That means that if you create commands to handle EDDI events, you are going to have to make sure that the appropriate handlers in my profiles are called, too. That is done by invoking the eddi.Event plugin context of the alterNERDtive-base plugin. Otherwise stuff will break.","title":"EDDI Events"}]} \ No newline at end of file diff --git a/search/worker.js b/search/worker.js new file mode 100644 index 0000000..8628dbc --- /dev/null +++ b/search/worker.js @@ -0,0 +1,133 @@ +var base_path = 'function' === typeof importScripts ? '.' : '/search/'; +var allowSearch = false; +var index; +var documents = {}; +var lang = ['en']; +var data; + +function getScript(script, callback) { + console.log('Loading script: ' + script); + $.getScript(base_path + script).done(function () { + callback(); + }).fail(function (jqxhr, settings, exception) { + console.log('Error: ' + exception); + }); +} + +function getScriptsInOrder(scripts, callback) { + if (scripts.length === 0) { + callback(); + return; + } + getScript(scripts[0], function() { + getScriptsInOrder(scripts.slice(1), callback); + }); +} + +function loadScripts(urls, callback) { + if( 'function' === typeof importScripts ) { + importScripts.apply(null, urls); + callback(); + } else { + getScriptsInOrder(urls, callback); + } +} + +function onJSONLoaded () { + data = JSON.parse(this.responseText); + var scriptsToLoad = ['lunr.js']; + if (data.config && data.config.lang && data.config.lang.length) { + lang = data.config.lang; + } + if (lang.length > 1 || lang[0] !== "en") { + scriptsToLoad.push('lunr.stemmer.support.js'); + if (lang.length > 1) { + scriptsToLoad.push('lunr.multi.js'); + } + if (lang.includes("ja") || lang.includes("jp")) { + scriptsToLoad.push('tinyseg.js'); + } + for (var i=0; i < lang.length; i++) { + if (lang[i] != 'en') { + scriptsToLoad.push(['lunr', lang[i], 'js'].join('.')); + } + } + } + loadScripts(scriptsToLoad, onScriptsLoaded); +} + +function onScriptsLoaded () { + console.log('All search scripts loaded, building Lunr index...'); + if (data.config && data.config.separator && data.config.separator.length) { + lunr.tokenizer.separator = new RegExp(data.config.separator); + } + + if (data.index) { + index = lunr.Index.load(data.index); + data.docs.forEach(function (doc) { + documents[doc.location] = doc; + }); + console.log('Lunr pre-built index loaded, search ready'); + } else { + index = lunr(function () { + if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) { + this.use(lunr[lang[0]]); + } else if (lang.length > 1) { + this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility + } + this.field('title'); + this.field('text'); + this.ref('location'); + + for (var i=0; i < data.docs.length; i++) { + var doc = data.docs[i]; + this.add(doc); + documents[doc.location] = doc; + } + }); + console.log('Lunr index built, search ready'); + } + allowSearch = true; + postMessage({config: data.config}); + postMessage({allowSearch: allowSearch}); +} + +function init () { + var oReq = new XMLHttpRequest(); + oReq.addEventListener("load", onJSONLoaded); + var index_path = base_path + '/search_index.json'; + if( 'function' === typeof importScripts ){ + index_path = 'search_index.json'; + } + oReq.open("GET", index_path); + oReq.send(); +} + +function search (query) { + if (!allowSearch) { + console.error('Assets for search still loading'); + return; + } + + var resultDocuments = []; + var results = index.search(query); + for (var i=0; i < results.length; i++){ + var result = results[i]; + doc = documents[result.ref]; + doc.summary = doc.text.substring(0, 200); + resultDocuments.push(doc); + } + return resultDocuments; +} + +if( 'function' === typeof importScripts ) { + onmessage = function (e) { + if (e.data.init) { + init(); + } else if (e.data.query) { + postMessage({ results: search(e.data.query) }); + } else { + console.error("Worker - Unrecognized message: " + e); + } + }; +} diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 0000000..7781971 --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,83 @@ + + + + https://alterNERDtive.github.io/VoiceAttack-profiles/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/EliteAttack/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/RatAttack/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/SpanshAttack/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/StreamAttack/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/VoiceAttack/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/general/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/installing/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/requirements/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/troubleshooting/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/upgrading/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/EliteAttack/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/RatAttack/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/SpanshAttack/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/StreamAttack/ + 2022-09-19 + daily + + + https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/general/ + 2022-09-19 + daily + + \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz new file mode 100644 index 0000000..9206aa6 Binary files /dev/null and b/sitemap.xml.gz differ diff --git a/troubleshooting/index.html b/troubleshooting/index.html new file mode 100644 index 0000000..62d1d32 --- /dev/null +++ b/troubleshooting/index.html @@ -0,0 +1,261 @@ + + + + + + + + Troubleshooting - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

Troubleshooting

+

This will fill up gradually with Troubleshooting tips as people run into common +ones.

+

VoiceAttack does not understand me / mishears me / fires random commands

+

There is a thread on the VoiceAttack +forums +on how to set up your microphone and the speech recognition engine to work best.

+

If your microphone is bad and you still get erroneous recognitions when you are +not speaking it is probably going to recognize the same command every time. You +can remedy that by blocking the voice trigger. One-syllable triggers are +especially prone to misrecognition.

+
    +
  1. Create a new command in your custom profile.
    2. +
  2. Set the “when I say” field to the trigger that gets misrecognized.
    3. +
+

Adding the “Other” → “VoiceAttack Action” → “Ignore an Unrecognized Word or +Phrase” action will also hide it from the VoiceAttack log when it is (wrongly) +recognized. You might or might not want that.

+

Example for the “cruise” voice trigger of the Supercruise command:

+

troubleshooting-remove-trigger.png

+

Alternatively you can raise the minimum confidence level and call the underlying +command to make misfires less likely:

+

troubleshooting-raise-min-confidence.png

+

There are a few examples in the Custom Profile +Example.

+

VoiceAttack recognizes a command, but doesn’t do anything in game

+

Make sure you have a keyboard bind for whatever the command is supposed to do as +outlined in Installing#Set Elite Keyboard Binds.

+

VoiceAttack talks over the COVAS voice

+

There is no way to know for sure when the ingame COVAS is talking to you, so +there is no way to always prevent the two from speaking over each other.

+

You can however either disable TTS responses for events that you know will clash +(or file a feature +request if one +is not optional yet). Alternatively, if you prefer the info given by VoiceAttack +over the ingame COVAS, you can deactivate its response to these events in the +ingame Audo settings:

+

Elite-COVAS.png

+

While you’re in there you might as well get rid of the spoken FSD countdown that +is off by one second …

+

This doesn’t work (well) with my HCS pack

+

My profiles are designed from the ground up to work with whatever else you are +doing with VoiceAttack; that is the reason for importing them into your own +custom profile instead of selecting e.g. EliteAttack as your active profile.

+

HCS on the contrary explicitly expects you do exclusively use HCS with +VoiceAttack. There is the rudimentary way of including simple profiles into +theirs, but the mechanism falls flat in many places. For example you cannot tell +HCS to run an included profile’s startup command.

+

So, in order to mostly make stuff work, you need to treat the HCS profile as +your “custom” profile as per this documentation.

+
    +
  1. Include alterNERDtive-base and all profiles you want to use into the active + HCS profile.
    2. +
  2. Include a custom profile that has a startup command with a voice trigger of + your choosing, e.g. “load included profiles”.
    3. +
  3. Set up said startup command as you would normally.
    4. +
  4. Every time you start VA or change profiles, you will have to manually say + “load included profiles”.
    5. +
+

That will make most things work. Conflicts may arise if HCS happens to have +voice triggers that are the same as mine, in which case their command will take +priority.

+

Note on TTS: EDDI’s TTS (used by my profiles) and HCS’ TTS / recorded voice +lines act 100% independently. That means they will frequently “speak over each +other”. There is no way to alleviate this.

+

EDDI does have a mechanism to detect if it is currently speaking – it sets a +corresponding VoiceAttack variable. HCS neither does anything similar nor checks +if EDDI is speaking to prevent conflicts. Refer to them if you want that +changed.

+

This does not work with Geforce Now

+

Nope. Just won’t. Geforce Now obviously has Elite’s files, journals and keybinds +stored on some random PC in the cloud. Your local VoiceAttack has no way of +accessing those.

+

If you can get VoiceAttack to run on Geforce Now in parallel to Elite, I don’t +see why it wouldn’t work.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + +
+ + + + + + + + diff --git a/upgrading/index.html b/upgrading/index.html new file mode 100644 index 0000000..e96ba08 --- /dev/null +++ b/upgrading/index.html @@ -0,0 +1,275 @@ + + + + + + + + Upgrading - alterNERDtive VA profiles + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+
+
+ +

Upgrading

+

To upgrade to the latest version, follow these simple steps:

+
    +
  1. Say “download profiles update”.
    2. +
  2. Put the alterNERDtive-voiceattack-profiles.vax file from Github into + VoiceAttack’s “Import” folder.
    3. +
  3. Restart VoiceAttack.
    4. +
+

In general, migration from old versions will be handled automatically. If there +is something you have to do manually you will find the necessary steps below.

+

You can find the full +Changelog +on Github.

+

3.x.x to 4.x.x

+

If you have been using a custom profile as outlined in Installing#Create a +Custom Profile your settings will be migrated to the new variables +automatically.

+

If you have not and you have used my “EliteDangerous” profile as the main +profile … well, you will unfortunately have to take note of your settings, and +recreate them after creating a custom profile and including everything.

+

Please do not fiddle with the configuration variables from your startup command +(or any other, really). It should not break anything, but it might. And it is +entirely unnecessary since configuration will be saved to and loaded from the +profile anyway.

+

EDDI Events

+

The process for adding your own handlers for EDDI events has changed. You no +longer have to check which of my profiles handle them and add the commands for +those manually; instead you need to run the eddi.event context of the +alterNERDtive-base plugin.

+

bindED

+

If you have done anything non-standard with bindED before, it might break. The +profiles now include my fork of bindED which has a lot more features, but +does no longer support a bunch of plugin invocations that have become obsolete.

+

Please file an issue with +bindED on Github if +your use case does not work anymore.

+

EliteDangerous

+

The “EliteDangerous” profile is no longer the main profile. Instead you will +have to create a custom profile, and the new “base” profile that the others +require to be included in your custom profile is “alterNERDtive-base”. That way +you can use e.g. RatAttack without having to also use the general Elite profile.

+

To be consistent with the other profiles it has been renamed to “EliteAttack”. +If you are upgrading from an older version the name will not change for you in +the profiles list. I recommend renaming your “EliteDangerous” profile to +“EliteAttack” to prevent confusion in the future, but it is not strictly +necessary to do so.

+

RatAttack

+

Getting Case Data From IRC

+

Handing a RATSIGNAL from IRC to VoiceAttack via text file is now deprecated and +the feature will be removed in a future version.

+

Instead you should use the new RatAttack-cli.exe helper tool that uses IPC to +talk to the VoiceAttack plugin. For that you have to change the way your IRC +client handles incoming case announcements. Instead of writing the announcement +to the text file and calling VoiceAttack to run a command, it will have to call +the helper tool with a) the announcement and b) an optional true/false switch to +determine if the case should be announced via TTS or just added to the case +list.

+

For my AdiIRC, it looks like this (obviously change the path, please):

+
on *:TEXT:*RATSIGNAL*(??_SIGNAL):#fuelrats:{
+  if ( $away ) {
+    /run -h "X:\path\to\VoiceAttack\Apps\alterNERDtive\RatAttack-cli.exe" " $+ $replace($1-,","") $+ " false
+  }
+  else {
+    /run -h "X:\path\to\VoiceAttack\Apps\alterNERDtive\RatAttack-cli.exe" " $+ $replace($1-,","") $+ " true
+  }
+}
+
+

If I am away it will just add the new case to the list. If I am not away, it +will announce it using TTS.

+

The $replace part handles the fact that case announcements now put the system +in quotes. They have to be escaped as double quotes ("") to create a correct +command line invocation.

+

Nearest CMDR Announcements

+

If you have RatAttack set up to announce your nearest commander to a case, +you’ll have to change the setting to the new format, separated by ; instead of +whitespace.

+

Say “customize setting set fuel rat commanders” to update it.

+ +
+
+ +
+
+ +
+ +
+ +
+ + + + GitHub + + + + « Previous + + + Next » + + +
+ + + + + + + +