Deployed 1027181 with MkDocs version: 1.3.1

This commit is contained in:
alterNERDtive 2022-09-19 16:31:43 +00:00
commit 916a3fadbe
77 changed files with 11311 additions and 0 deletions

0
.nojekyll Normal file
View file

160
404.html Normal file
View file

@ -0,0 +1,160 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" />
<link rel="shortcut icon" href="/VoiceAttack-profiles/img/favicon.ico" />
<title>alterNERDtive VA profiles</title>
<link rel="stylesheet" href="/VoiceAttack-profiles/css/theme.css" />
<link rel="stylesheet" href="/VoiceAttack-profiles/css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script src="/VoiceAttack-profiles/js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="/VoiceAttack-profiles/js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="/VoiceAttack-profiles/." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="/VoiceAttack-profiles//search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/.">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="/VoiceAttack-profiles/troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="/VoiceAttack-profiles/.">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="/VoiceAttack-profiles/." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="404-page-not-found">404</h1>
<p><strong>Page not found</strong></p>
</div>
</div><footer>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
</span>
</div>
<script>var base_url = '/VoiceAttack-profiles/';</script>
<script src="/VoiceAttack-profiles/js/theme_extra.js" defer></script>
<script src="/VoiceAttack-profiles/js/theme.js" defer></script>
<script src="/VoiceAttack-profiles/search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

504
EliteAttack/index.html Normal file
View file

@ -0,0 +1,504 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/EliteAttack/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>EliteAttack - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "EliteAttack";
var mkdocs_page_input_path = "EliteAttack.md";
var mkdocs_page_url = "/VoiceAttack-profiles/EliteAttack/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../general/">General Commands</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">EliteAttack</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#chat-commands">Chat Commands</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#engineeringmaterials">Engineering/Materials</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#navigation">Navigation</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#ship-controls">Ship Controls</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#srv-controls">SRV Controls</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#targeting">Targeting</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#ui-commands">UI Commands</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#miscellaneous">Miscellaneous</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#events">Events</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#afmu-repairs">AFMU Repairs</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#body-mapped">Body Mapped</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#body-scanned">Body scanned</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#carrier-cooldown">Carrier Cooldown</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#carrier-jump-engaged">Carrier Jump Engaged</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#carrier-jump-request">Carrier Jump Request</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#carrier-jumped">Carrier Jumped</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#carrier-pads-locked">Carrier Pads Locked</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#discovery-scan">Discovery Scan</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#docked">Docked</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#docking-denied">Docking Denied</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#entered-normal-space">Entered Normal Space</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#fighter-launched">Fighter Launched</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#jet-cone-boost">Jet Cone Boost</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#jumped">Jumped</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#liftoff">Liftoff</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#low-fuel">Low Fuel</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#material-threshold">Material Threshold</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#next-jump">Next Jump</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#ship-fsd">Ship FSD</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#ship-interdicted">Ship Interdicted</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#srv-launched">SRV Launched</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#synthesis">Synthesis</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#system-scan-complete">System Scan Complete</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#undocked">Undocked</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Use &raquo;</li>
<li>EliteAttack</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/EliteAttack.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../general/" class="btn btn-neutral float-left" title="General Commands"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../RatAttack/" class="btn btn-neutral float-right" title="RatAttack">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="eliteattack">EliteAttack<a class="headerlink" href="#eliteattack" title="Permanent link">&para;</a></h1>
<p>This is my personal VoiceAttack profile for Elite: Dangerous. It started out
ages ago as a modification of <a href="https://forums.frontier.co.uk/threads/malics-voice-attack-profile-for-vr.351050/">MalicVRs public
profile</a>,
then looked less and less and less like that and I added and cleaned up a lot of
things while removing the stuff I didnt use anyway. By now it would have
probably been simpler to start from scratch.</p>
<p>Funnily enough it has grown to rely way more on events provided by
<a href="https://github.com/EDCD/EDDI">EDDI</a> than actual voice commands.</p>
<h2 id="chat-commands">Chat Commands<a class="headerlink" href="#chat-commands" title="Permanent link">&para;</a></h2>
<p>These commands will only work with the comms panel active, and you should be in
the edit window ready to send. They will <em>not</em> hit Enter on their own.</p>
<ul>
<li><code>clear [chat;text]</code>: Clears the chat window. Use from outside the comms panel.</li>
<li><code>[local;squad;system;wing] chat</code>: Puts you into the chosen chat channel.</li>
<li><code>salute; oh seven</code>: Will put “o7” into the chat.</li>
</ul>
<h2 id="engineeringmaterials">Engineering/Materials<a class="headerlink" href="#engineeringmaterials" title="Permanent link">&para;</a></h2>
<ul>
<li><code>how many [&lt;g5 manufactured materials list&gt;] do i have</code>: Tells you how many of
the given g5 manufactured material you currently have on board. Ive
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.</li>
<li><code>[launch;open] e d engineer</code>: Opens the ED Engineer tool.</li>
<li><code>what [mats;materials] do i need?</code>: 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 its worth looking for HGE in a system
Im in.</li>
</ul>
<h2 id="navigation">Navigation<a class="headerlink" href="#navigation" title="Permanent link">&para;</a></h2>
<p>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 dont have to do the work myself!</p>
<ul>
<li><code>distance [from;to] [Sol;home;the center;Beagle Point;Colonia]</code>: Gives you the
current distance to the given POI.</li>
<li><code>[find;target] nearest [encoded;manufactured;raw] material trader</code>: Targets
the nearest respective material trader.</li>
<li><code>[find;target] nearest [fuel;scoopable] star</code>: Targets the nearest scoopable
star.</li>
<li><code>[find;target] nearest [guardian;human] tech broker</code>: Targets the nearest
respective tech broker.</li>
<li><code>[find;target] nearest [interstellar factor;mission system;scoopable star]</code>:
Well, you know the drill by now.</li>
<li><code>[find;target] nearest mission system</code>: Targets the nearest system that has a
mission target.</li>
<li><code>how many jumps left</code>: Announces the jumps left on a neutron trip (requires
SpanshAttack) or a course plotted via the galaxy map.</li>
<li><code>plot course;[target;] next [waypoint;way point]</code>: Plots a course to the text
in your clipboard.</li>
<li><code>target [bug killer;colonia;davs hope;explorers anchorage;jackson's lighthouse;jamesons cobra;robigo;shinrarta dezhra;sagittarius a*;shinrarta;sothis]</code>:
Targets the given system on the galaxy map.</li>
<li><code>[wheres;where is] my landing pad</code>: Will tell you the location of your
assigned landing pad on a starport.</li>
</ul>
<h2 id="ship-controls">Ship Controls<a class="headerlink" href="#ship-controls" title="Permanent link">&para;</a></h2>
<p>Basically anything that is related to directly doing something with your ship.</p>
<ul>
<li><code>[abort;cancel;stop] jumping</code>: Stops a currently charging FSD jump.</li>
<li><code>[half;] power to [engines;shields;systems;weapons]</code>: Sets pips to 6/3/3
(<code>half</code>) or 8/2/2 towards the given capacitor.</li>
<li><code>[balanced;half;] power to [engines;shields;systems;weapons] [and engines;and shields;and systems;and weapons;]</code>:
Sets pips to 6/6/0 (balanced), 5/5/2 (half) or 8/4/0 towards the given capacitors.</li>
<li><code>[close;deploy;extend;open;retract;] [cargo scoop;hard points; landing gear] [up;down;]</code>:
Overly complicated command to handle everything related to Cargo Scoop, Hard
Points, Landing Gear. You get the gist, I guess. Works in SRV too.</li>
<li><code>[disco;discovery scan]</code>: Executes a discovery scan. Expects the Discovery
Scanner in your first fire group, secondary fire. <a href="../configuration/EliteAttack/#settings">You can change
that</a>.</li>
<li><code>[dis;]engage silent running</code>: Turns silent running on and off.</li>
<li><code>[head;spot;] lights [on;off]</code>: 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.</li>
<li><code>[jump;engage;get me out] [and scan;] [when ready;]</code>: Retracts everything that
might be protruding from your ship, then jumps to the next system. If the FSD
isnt 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.</li>
<li><code>night vision [on;off]</code>: Toggles your night vision on/off. Works in SRV too.</li>
<li><code>rapid fire lights</code>: Flashes your lights 5 times in a row.</li>
<li><code>retract [all;everything]</code>: Retracts, well, everything.</li>
<li><code>[start;stop] [firing;mining]</code>: Starts/stops holding down primary fire. Mostly
useful when mining. When triggered with “mining”, also deploys the cargo
scoop.</li>
<li><code>[super;] cruise [when ready;]</code>: Retracts everything, then jumps to SC. If
given “when ready” will wait for mass lock to clear and your FSD to cool down
first.</li>
</ul>
<h2 id="srv-controls">SRV Controls<a class="headerlink" href="#srv-controls" title="Permanent link">&para;</a></h2>
<p>Things relevant to your SRV, but not your ship.</p>
<ul>
<li><code>[recall;dismiss] ship</code>: 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 thats currently not possible sadly.</li>
<li><code>[toggle;enable;disable] drive assist</code>: Handles all your drive assist needs!</li>
</ul>
<h2 id="targeting">Targeting<a class="headerlink" href="#targeting" title="Permanent link">&para;</a></h2>
<p>Well … targeting stuff, I guess. Not really sure why I made that its own
category, but oh well :)</p>
<ul>
<li><code>target the [drive;drives;power plant;frame shift drive;f s d;shield
generator]</code>: Targets the given submodule on your current target, or your next
target if you dont have one currently. Does not persist between targets.</li>
<li><code>clear sub [module;system] target</code>: Clears the current submodule target.</li>
<li><code>target next system</code>: Selects the next system on your route.</li>
<li><code>target wing man [1;2;3]</code>: Targets your wingmen.</li>
<li><code>targets target</code>: Targets your targets target (only works on wingmen).</li>
<li><code>wing man [1;2;3] target</code>: Targets your wingmens target.</li>
<li><code>wing man nav lock</code>: Toggles wing man nav lock on the selected wing member.</li>
</ul>
<h2 id="ui-commands">UI Commands<a class="headerlink" href="#ui-commands" title="Permanent link">&para;</a></h2>
<p>Everything handling stuff thats not related to controlling your ship, but
manipulating some UI element(s).</p>
<ul>
<li><code>[enter;leave] F S S</code>: Opens/closes FSS.</li>
<li><code>[main;game] menu</code>: Opens the ESC menu.</li>
<li><code>[relog;reset] to [open;solo]</code>: Relogs to Open or Solo mode, respectively.</li>
<li><code>controls options</code>: Opens the controls options menu.</li>
<li><code>docking request;request dock[ing;]</code>: Sends a docking request.</li>
<li><code>galaxy map</code>: Opens the galaxy map.</li>
<li><code>restart from Desktop</code>: Quits the game and restarts from an open launcher by
clicking the play button.</li>
<li><code>set [default;star;station;settlement;signal sources;anomaly;unknown;system] filter</code>:
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.</li>
<li><code>system map</code>: Opens the system map.</li>
<li><code>take [high res;] screenshot</code>: Takes a (high res) screenshot.</li>
<li><code>toggle orbit lines</code>: Toggles the visibility of orbit lines.</li>
</ul>
<h2 id="miscellaneous">Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permanent link">&para;</a></h2>
<p>The commands in here do random more or less useful things.</p>
<ul>
<li><code>[are there any;] outdated stations [in this system;]</code>: Runs an on-demand
check for outdated stations in the current system.</li>
<li><code>[bodies;whats;what is] left to [map;be mapped;scan]</code>: Tells you which bodies
EDDI thinks are worth mapping in the system that you havent mapped yet.</li>
<li><code>copy current system</code>: Copies the current system name into the clipboard.</li>
<li><code>open [current;] system on EDSM</code>: Opens your current system on EDSM in your
default browser.</li>
<li><code>open copied system on EDSM</code>: Opens the system in your clipboard on EDSM in
your default browser.</li>
<li><code>open coriolis</code>: Opens Coriolis in your default browser.</li>
<li><code>open e d d b [station;system;faction;] [search;]</code>: Opens EDDB in your default
browser.</li>
<li><code>open e d s m</code>: Opens EDSM in your default browser.</li>
<li><code>open inara</code>: Opens Inara in your default browser.</li>
<li><code>open materials finder</code>: Opens EDTutorials materials finder in your default
browser.</li>
<li><code>open miners tool</code>: Opens https://edtools.cc/miner in your default browser.</li>
<li><code>open spansh</code>: Opens https://spansh.uk in your default browser.</li>
</ul>
<h2 id="events">Events<a class="headerlink" href="#events" title="Permanent link">&para;</a></h2>
<p>This is a list of ingame Events, <a href="https://github.com/EDCD/EDDI/wiki/VoiceAttack-Integration">provided by
EDDI</a>, that the
profile will act on.</p>
<h3 id="afmu-repairs">AFMU Repairs<a class="headerlink" href="#afmu-repairs" title="Permanent link">&para;</a></h3>
<p>Reports on the module that has been repaired, and if it has been fully or
partially repaired.</p>
<h3 id="body-mapped">Body Mapped<a class="headerlink" href="#body-mapped" title="Permanent link">&para;</a></h3>
<p>Announces an estimate for high-value bodies payouts and the remaining mapping
candidates in the system as given by EDDI.</p>
<h3 id="body-scanned">Body scanned<a class="headerlink" href="#body-scanned" title="Permanent link">&para;</a></h3>
<p>Announces any interesting body traits found when scanning:</p>
<ul>
<li>terraformable</li>
<li>Earth-like World, Ammonia World or Water World</li>
<li>landable and &gt;5g</li>
<li>semimajor axis &lt;1.5ls (only really interesting for planets, but theres no
proper way to separate them from moons, sadly)</li>
<li>radius &lt;300km</li>
</ul>
<p>Feel free to suggest more!</p>
<h3 id="carrier-cooldown">Carrier Cooldown<a class="headerlink" href="#carrier-cooldown" title="Permanent link">&para;</a></h3>
<p>Tells you when your carrier is able to do its next jump.</p>
<h3 id="carrier-jump-engaged">Carrier Jump Engaged<a class="headerlink" href="#carrier-jump-engaged" title="Permanent link">&para;</a></h3>
<p>This event fires when your carrier jumps but you are <em>not</em> docked at it. It
provides way less information than the <code>Carrier Jumped</code> event, but hey, I dont
use most of it anyway. Basically just calls <code>Carrier Jumped</code>.</p>
<h3 id="carrier-jump-request">Carrier Jump Request<a class="headerlink" href="#carrier-jump-request" title="Permanent link">&para;</a></h3>
<p>Announces the system and body your carrier has just been scheduled to jump to.
Use this to double check ingame information; Ive had my carrier accept a body
as jump target, but then end up around the star. This <em>might</em> give you a heads
up on that.</p>
<p>Also starts a command queue to give you advance warnings on carrier lockdown at
-10, -5 and -2 minutes.</p>
<h3 id="carrier-jumped">Carrier Jumped<a class="headerlink" href="#carrier-jumped" title="Permanent link">&para;</a></h3>
<p>Announces system and body your carrier has just jumped to.</p>
<h3 id="carrier-pads-locked">Carrier Pads Locked<a class="headerlink" href="#carrier-pads-locked" title="Permanent link">&para;</a></h3>
<p>Announces your carriers lockdown procedures.</p>
<h3 id="discovery-scan">Discovery Scan<a class="headerlink" href="#discovery-scan" title="Permanent link">&para;</a></h3>
<p>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).</p>
<h3 id="docked">Docked<a class="headerlink" href="#docked" title="Permanent link">&para;</a></h3>
<p>Automatically refuels, repairs, rearms, then gets your ship into the hangar and
opens station services. Can be individually disabled.</p>
<h3 id="docking-denied">Docking Denied<a class="headerlink" href="#docking-denied" title="Permanent link">&para;</a></h3>
<p>Tells you the reason for docking denial.</p>
<h3 id="entered-normal-space">Entered Normal Space<a class="headerlink" href="#entered-normal-space" title="Permanent link">&para;</a></h3>
<p>Throttles to 0 upon dropping from SC, if the hyperspace dethrottle option is
enabled.</p>
<h3 id="fighter-launched">Fighter Launched<a class="headerlink" href="#fighter-launched" title="Permanent link">&para;</a></h3>
<p>Orders your ship to hold position so it doesnt chase after you immediately.</p>
<h3 id="jet-cone-boost">Jet Cone Boost<a class="headerlink" href="#jet-cone-boost" title="Permanent link">&para;</a></h3>
<p>Sets your ship to full throttle immediately after you have supercharged.</p>
<h3 id="jumped">Jumped<a class="headerlink" href="#jumped" title="Permanent link">&para;</a></h3>
<ul>
<li>Zeroes throttle if the hyperspace dethrottle option is enabled.</li>
<li>Gets the systems body count from EDSM if that option is enabled.</li>
<li>Gets stations with outdated data (by default: older than 1 year) from Spanshs
API. Again, if it is enabled.</li>
<li>Starts a discovery scan if that is enabled.</li>
<li>Last but not least tells you about planets worth scanning if you are on the
R2R.</li>
</ul>
<h3 id="liftoff">Liftoff<a class="headerlink" href="#liftoff" title="Permanent link">&para;</a></h3>
<p>Retracts landing gear for you. Seriously, is there any occasion in which you
<em>dont</em> immediately want to retract it after takeoff?</p>
<h3 id="low-fuel">Low Fuel<a class="headerlink" href="#low-fuel" title="Permanent link">&para;</a></h3>
<p>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.</p>
<h3 id="material-threshold">Material Threshold<a class="headerlink" href="#material-threshold" title="Permanent link">&para;</a></h3>
<p>Warns you when a monitored material falls below its minimum stock level and
tells you when you reach your desired level or fill up.</p>
<p>You will have to set minimum and desired amounts in EDDIs material monitor
options first for all materials you wish to be monitored.</p>
<h3 id="next-jump">Next Jump<a class="headerlink" href="#next-jump" title="Permanent link">&para;</a></h3>
<p>Gives you a jump count upon plotting a route using the galaxy map.</p>
<h3 id="ship-fsd">Ship FSD<a class="headerlink" href="#ship-fsd" title="Permanent link">&para;</a></h3>
<p>This event actually is several different events in one. Currently the following
are handled:</p>
<ul>
<li>Charging: Warns you if you are jumping with less than 25% fuel.</li>
<li>Cooldown complete: Announces FSD cooldown if you are currently in normal
space.</li>
</ul>
<h3 id="ship-interdicted">Ship Interdicted<a class="headerlink" href="#ship-interdicted" title="Permanent link">&para;</a></h3>
<p>Tells you when you have been interdicted by a player. Is also supposed to target
the interdictor automatically, but randomly sometimes just doesnt work. Yay!</p>
<h3 id="srv-launched">SRV Launched<a class="headerlink" href="#srv-launched" title="Permanent link">&para;</a></h3>
<p>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.</p>
<h3 id="synthesis">Synthesis<a class="headerlink" href="#synthesis" title="Permanent link">&para;</a></h3>
<p>Reports on the synthesis type and quality.</p>
<h3 id="system-scan-complete">System Scan Complete<a class="headerlink" href="#system-scan-complete" title="Permanent link">&para;</a></h3>
<p>Lists all bodies EDDI considers worth mapping in the current system.</p>
<h3 id="undocked">Undocked<a class="headerlink" href="#undocked" title="Permanent link">&para;</a></h3>
<p>Retracts landing gear for you. Seriously, is there any occasion in which you
<em>dont</em> immediately want to retract it after takeoff?</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../general/" class="btn btn-neutral float-left" title="General Commands"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../RatAttack/" class="btn btn-neutral float-right" title="RatAttack">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../general/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../RatAttack/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

294
RatAttack/index.html Normal file
View file

@ -0,0 +1,294 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/RatAttack/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>RatAttack - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "RatAttack";
var mkdocs_page_input_path = "RatAttack.md";
var mkdocs_page_url = "/VoiceAttack-profiles/RatAttack/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">RatAttack</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#going-onoff-duty">Going On/Off Duty</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#case-handling">Case Handling</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#getting-case-information">Getting Case Information</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#opening-a-case">Opening a Case</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#making-calls">Making Calls</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#closing-a-case">Closing a Case</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#general-irc-interaction">General IRC Interaction</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Use &raquo;</li>
<li>RatAttack</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/RatAttack.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../EliteAttack/" class="btn btn-neutral float-left" title="EliteAttack"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../SpanshAttack/" class="btn btn-neutral float-right" title="SpanshAttack">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="ratattack">RatAttack<a class="headerlink" href="#ratattack" title="Permanent link">&para;</a></h1>
<p>This profile facilitates <a href="https://www.fuelrats.com">Fuel Ratting</a>. It aims to
eliminate as much of the required manual task and attention switching as
possible via automation and voice commands.</p>
<p>If you dont know what the Fuel Rats are, come hang out and ask :)</p>
<h2 id="going-onoff-duty">Going On/Off Duty<a class="headerlink" href="#going-onoff-duty" title="Permanent link">&para;</a></h2>
<p>When you are on duty, RatAttack will automatically announce cases coming in
through IRC. When off duty, it wont.</p>
<ul>
<li><code>[enable;disable] rat duty</code>: puts you on/off duty.</li>
<li><code>open [fuel rats;] dispatch board</code>: opens the web dispatch board.</li>
</ul>
<h2 id="case-handling">Case Handling<a class="headerlink" href="#case-handling" title="Permanent link">&para;</a></h2>
<p><a href="../configuration/RatAttack/#getting-case-data-from-irc">If you have your IRC client setup
properly</a>, 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:</p>
<h3 id="getting-case-information">Getting Case Information<a class="headerlink" href="#getting-case-information" title="Permanent link">&para;</a></h3>
<ul>
<li><code>rat case number [0..30] details</code>: Will give you all stored info on a case.</li>
<li><code>[current;] rat case details</code>: Will give you all stored info on the currently
open case.</li>
<li><code>distance to current rat case</code>: Will give you the distance from your current
location to the currently opened rat case.</li>
<li><code>distance to rat case number [0..30]</code>: Will give you the distance from your
current system to a cases system.</li>
<li><code>latest rat case details</code>: Will give you the case data for the latest incoming
case.</li>
<li><code>nearest commander to rat case number [0..30]</code>: Will give you the nearest of
your CMDRs with their distance to a cases system. <a href="../configuration/RatAttack/#announcing-your-nearest-cmdr">Requires some
setup</a>.</li>
<li><code>nearest commander to [the;] rat case</code>: Will give you the nearest of your
CMDRs with their distance to the current cases system. <a href="../configuration/RatAttack/#announcing-your-nearest-cmdr">Requires some
setup</a>.</li>
</ul>
<h3 id="opening-a-case">Opening a Case<a class="headerlink" href="#opening-a-case" title="Permanent link">&para;</a></h3>
<ul>
<li><code>open rat case number [0..30]</code>: Opens rat case with the given number. If there
is no case data for that case (e.g. because you dont have your IRC client set
up properly), it will still open it, just not have any data on it.</li>
<li><code>open [latest;] rat case</code>: Opens the latest rat case that has come in through
IRC. Will only work if you actually have <a href="../configuration/RatAttack/#getting-case-data-from-irc">your IRC client setup to send case
announcements to
VoiceAttack</a>.</li>
</ul>
<p>Opening a case will automatically copy the clients system to the clipboard for
easy route plotting. This can be disabled.</p>
<h3 id="making-calls">Making Calls<a class="headerlink" href="#making-calls" title="Permanent link">&para;</a></h3>
<p>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.</p>
<ul>
<li><code>call [1..20] jumps [and login;and takeoff;left;]</code>: 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.</li>
<li><code>call jumps [left;]</code>: Calls jumps for the currently open case based on a
neutron trip (requires SpanshAttack) or a plotted ingame route.</li>
<li><code>call friend [positive;negative] [in pg;in private group;in solo;in main menu;sysconf;system confirmed;]</code>:
Friend request confirmations, with all the
things you might want to / should call with it.</li>
<li><code>call [beacon;fuel;instance;pos;position;prep;sys;system;wing] [positive;negative]</code>:
All the stuff you usually need for ratting after you have received the friend request.</li>
<li><code>call wing pending</code>: Calls “wr pending” for when it takes 30s again to
actually show up.</li>
<li><code>call client in [exclusion zone;main menu;open;open sysconf;pg;private group;solo;super cruise]</code>:
Callouts for all the various things a client could get themselves into.</li>
<li><code>call [client destroyed;client offline;sysconf;system confirmed]</code>: This is the
command you dont 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?</li>
</ul>
<p>By default, VoiceAttack will ask for confirmation before sending calls to the
<code>#fuelrats</code> channel.</p>
<h3 id="closing-a-case">Closing a Case<a class="headerlink" href="#closing-a-case" title="Permanent link">&para;</a></h3>
<ul>
<li><code>[close;clear] rat case</code>: Closes the currently open rat case.</li>
</ul>
<h2 id="general-irc-interaction">General IRC Interaction<a class="headerlink" href="#general-irc-interaction" title="Permanent link">&para;</a></h2>
<p>Using EDDI to read the games journal, you can send messages to IRC from Elites
ingame chat.</p>
<p><strong>Be aware that the chat message will still appear in the ingame chat channel
you send it to!</strong></p>
<p>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).</p>
<ul>
<li>#fuelrats: Use <code>.fr &lt;message&gt;</code> to have VoiceAttack send
<code>#&lt;caseNumber&gt; &lt;message&gt;</code> to #fuelrats or yell at you when you
are not on a case.</li>
<li>#ratchat: Use <code>.rc &lt;message&gt;</code> to have VoiceAttack send <code>&lt;message&gt;</code> to
#ratchat.</li>
</ul>
<p>Make sure <a href="../configuration/RatAttack/#sending-text-to-fuelrats-irc">that your IRC client is setup
properly</a>.</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../EliteAttack/" class="btn btn-neutral float-left" title="EliteAttack"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../SpanshAttack/" class="btn btn-neutral float-right" title="SpanshAttack">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../EliteAttack/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../SpanshAttack/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

289
SpanshAttack/index.html Normal file
View file

@ -0,0 +1,289 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/SpanshAttack/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>SpanshAttack - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "SpanshAttack";
var mkdocs_page_input_path = "SpanshAttack.md";
var mkdocs_page_url = "/VoiceAttack-profiles/SpanshAttack/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">SpanshAttack</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#plotting-a-route">Plotting a Route</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#plotting-to-a-system-unknown-to-the-neutron-router">Plotting to a System Unknown to the Neutron Router</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#neutron-jumping">Neutron Jumping</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#skipping-a-waypoint">Skipping a Waypoint</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#manual-re-plot">Manual Re-Plot</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#refueling">Refueling</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#clearing-a-route">Clearing a Route</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#other-commands">Other Commands</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#announcing-jumps-left">Announcing Jumps Left</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#announce-elapsed-time-on-the-trip">Announce elapsed time on the trip</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Use &raquo;</li>
<li>SpanshAttack</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/SpanshAttack.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../RatAttack/" class="btn btn-neutral float-left" title="RatAttack"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../StreamAttack/" class="btn btn-neutral float-right" title="StreamAttack">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="spanshattack">SpanshAttack<a class="headerlink" href="#spanshattack" title="Permanent link">&para;</a></h1>
<p>This profile uses the
<a href="https://github.com/sc-pulgan/ED-NeutronRouter">ED-NeutronRouter</a> plugin to
plot neutron jumps using <a href="https://spansh.co.uk/plotter">Spansh</a>. It does
everything you need fully from within the game and VoiceAttack, you wont have
to visit the site at any point.</p>
<h2 id="plotting-a-route">Plotting a Route<a class="headerlink" href="#plotting-a-route" title="Permanent link">&para;</a></h2>
<ol>
<li><em>Target</em> the system you want to be routed to (target, do not plot to it).</li>
<li>Either exit the galaxy map or make sure you are on its first tab (or
auto-plotting will break).</li>
<li>Trigger the <code>SpanshAttack.plotRoute</code> command either by voice
(<code>plot neutron [course;route;trip] [with custom range;]</code>) or by
calling it from another command.</li>
<li>Enter your ships jump range if prompted.</li>
<li>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.</li>
<li>Either target the first waypoint or plot to it.</li>
<li>Start jumping!</li>
</ol>
<h3 id="plotting-to-a-system-unknown-to-the-neutron-router">Plotting to a System Unknown to the Neutron Router<a class="headerlink" href="#plotting-to-a-system-unknown-to-the-neutron-router" title="Permanent link">&para;</a></h3>
<p>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.</p>
<ol>
<li>Check <code>Next system</code> 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.</li>
<li>If the system is not in EDSM check EDTS. It can calculate approximate
coordinates for a given procedurally generated system name.</li>
<li>If that fails prompt the user for input.</li>
<li>Query Spansh API for the closest system to these coordinates.</li>
<li>Plot a route to the closest system.</li>
</ol>
<p>Generally you should almost never be asked to input coordinates manually. If
EDTS provides coordinates with an accuracy that is worse than ±100ly 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 VoiceAttacks log window.</p>
<h2 id="neutron-jumping">Neutron Jumping<a class="headerlink" href="#neutron-jumping" title="Permanent link">&para;</a></h2>
<p>With standard settings, just supercharge off a neutron cone. You should
automatically be taken to the galaxy map with the next waypoint selected.</p>
<p>In case you have disabled auto-plotting to the next waypoint, manually invoke
the <code>SpanshAttack.targetNextNeutronWaypoint</code> command by voice
(<code>[target;] next neutron [waypoint; way point]</code>) or calling it from
another command.</p>
<p>Additionally, you can use the <code>SpanshAttack.copyNextNeutronWaypoint</code>
/ <code>[get;copy] next neutron [waypoint;way point]</code> command to copy the next
neutron waypoint to the clipboard.</p>
<h3 id="skipping-a-waypoint">Skipping a Waypoint<a class="headerlink" href="#skipping-a-waypoint" title="Permanent link">&para;</a></h3>
<p>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.</p>
<p>In these cases you can use the <code>SpanshAttack.skipNeutronWaypoint</code> / <code>skip
[this;current] neutron waypoint</code> command to move on to the next one in the
list.</p>
<h3 id="manual-re-plot">Manual Re-Plot<a class="headerlink" href="#manual-re-plot" title="Permanent link">&para;</a></h3>
<p>Trigger the <code>SpanshAttack.replotRoute</code> command either by voice
(<code>replot neutron [course;route;trip]</code>) or calling it from another command.
This will start a re-plot of the current route with the same target system and
jump range.</p>
<h2 id="refueling">Refueling<a class="headerlink" href="#refueling" title="Permanent link">&para;</a></h2>
<p>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.</p>
<h2 id="clearing-a-route">Clearing a Route<a class="headerlink" href="#clearing-a-route" title="Permanent link">&para;</a></h2>
<p>When you reach your target system the neutron route will automatically be
cleared. If you want to prematurely end your trip, call the
<code>SpanshAttack.clearRoute</code> / <code>clear neutron [course;route;trip]</code> command.</p>
<h2 id="other-commands">Other Commands<a class="headerlink" href="#other-commands" title="Permanent link">&para;</a></h2>
<h3 id="announcing-jumps-left">Announcing Jumps Left<a class="headerlink" href="#announcing-jumps-left" title="Permanent link">&para;</a></h3>
<p>You can have VoiceAttack tell you the amount of jumps left on the current route
by invoking <code>SpanshAttack.announceJumpsLeft</code> or saying
<code>how many [neutron;] jumps [are;] left?</code>.</p>
<p><strong>Note</strong>: Because its pretty much impossible to calculate a 100% accurate value
for the total jumps left, it will just tell you the jump count <em>from the current
neutron waypoint</em>.</p>
<h3 id="announce-elapsed-time-on-the-trip">Announce elapsed time on the trip<a class="headerlink" href="#announce-elapsed-time-on-the-trip" title="Permanent link">&para;</a></h3>
<p>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 youve been jumping with the
<code>SpanshAttack.announceTripTime</code> or
<code>how long have i been [jumping;on this trip;on this neutron trip]?</code> commands. </p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../RatAttack/" class="btn btn-neutral float-left" title="RatAttack"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../StreamAttack/" class="btn btn-neutral float-right" title="StreamAttack">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../RatAttack/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../StreamAttack/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

248
StreamAttack/index.html Normal file
View file

@ -0,0 +1,248 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/StreamAttack/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>StreamAttack - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "StreamAttack";
var mkdocs_page_input_path = "StreamAttack.md";
var mkdocs_page_url = "/VoiceAttack-profiles/StreamAttack/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">StreamAttack</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#commands">Commands</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#output-files">Output Files</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#elite">Elite</a>
<ul>
<li class="toctree-l4"><a class="reference internal" href="#commander">Commander</a>
</li>
<li class="toctree-l4"><a class="reference internal" href="#jump-target">Jump Target</a>
</li>
<li class="toctree-l4"><a class="reference internal" href="#location">Location</a>
</li>
<li class="toctree-l4"><a class="reference internal" href="#ship">Ship</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Use &raquo;</li>
<li>StreamAttack</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/StreamAttack.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../SpanshAttack/" class="btn btn-neutral float-left" title="SpanshAttack"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../troubleshooting/" class="btn btn-neutral float-right" title="Troubleshooting">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="streamattack">StreamAttack<a class="headerlink" href="#streamattack" title="Permanent link">&para;</a></h1>
<p>This profile uses the <a href="https://github.com/EDCD/EDDI">EDDI</a> 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.</p>
<p>Default folder is <code>%appdata%\StreamAttack\</code>.</p>
<h2 id="commands">Commands<a class="headerlink" href="#commands" title="Permanent link">&para;</a></h2>
<ul>
<li><code>clear jump target</code>: Clears the current jump target.</li>
<li><code>distance [to;from] jump target</code>: Tells you the current distance to the jump
target.</li>
<li>
<p><code>set jump target</code>: Sets the jump target to the currently targeted system.
Distance will be written to the configured file.</p>
</li>
<li>
<p><code>[copy;open] ship build</code>: Copies the current ship build (coriolis) or opens it
in your default browser.</p>
</li>
<li><code>open StreamAttack folder</code>: Opens the configured folder in Explorer.</li>
</ul>
<h2 id="output-files">Output Files<a class="headerlink" href="#output-files" title="Permanent link">&para;</a></h2>
<h3 id="elite">Elite<a class="headerlink" href="#elite" title="Permanent link">&para;</a></h3>
<p>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.</p>
<h4 id="commander">Commander<a class="headerlink" href="#commander" title="Permanent link">&para;</a></h4>
<ul>
<li><code>Elite\cmdr\name</code>: The current commanders name.</li>
</ul>
<h4 id="jump-target">Jump Target<a class="headerlink" href="#jump-target" title="Permanent link">&para;</a></h4>
<ul>
<li><code>Elite\jumpTarget\distance</code>: Distance to current jump target in light years.</li>
<li><code>Elite\jumpTarget\full</code>: Pretty-printed <code>&lt;distance&gt; ly to &lt;name&gt;</code>.</li>
<li><code>Elite\jumpTarget\name</code>: The current jump targets system name.</li>
</ul>
<h4 id="location">Location<a class="headerlink" href="#location" title="Permanent link">&para;</a></h4>
<ul>
<li><code>Elite\location\full</code>: 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.</li>
<li><code>Elite\location\system</code>: The system you are currently in.</li>
</ul>
<h4 id="ship">Ship<a class="headerlink" href="#ship" title="Permanent link">&para;</a></h4>
<ul>
<li><code>Elite\ship\build</code>: Your current ships loadout (link to coriolis).</li>
<li><code>Elite\ship\full</code>: <code>&lt;name&gt;” | &lt;model&gt; | &lt;build&gt;</code>.</li>
<li><code>Elite\ship\model</code>: Your current ships model.</li>
<li><code>Elite\ship\name</code>: Your current ships name.</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../SpanshAttack/" class="btn btn-neutral float-left" title="SpanshAttack"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../troubleshooting/" class="btn btn-neutral float-right" title="Troubleshooting">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../SpanshAttack/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../troubleshooting/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

168
VoiceAttack/index.html Normal file
View file

@ -0,0 +1,168 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/VoiceAttack/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>VoiceAttack Tips - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "VoiceAttack Tips";
var mkdocs_page_input_path = "VoiceAttack.md";
var mkdocs_page_url = "/VoiceAttack-profiles/VoiceAttack/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>VoiceAttack Tips</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/VoiceAttack.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="voiceattack-tips">VoiceAttack Tips<a class="headerlink" href="#voiceattack-tips" title="Permanent link">&para;</a></h1>
<p>This will fill up eventually with tips on how to properly setup VoiceAttack for
decent recognition.</p>
</div>
</div><footer>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

View file

@ -0,0 +1,234 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/EliteAttack/" />
<link rel="shortcut icon" href="../../img/favicon.ico" />
<title>EliteAttack - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../../css/theme.css" />
<link rel="stylesheet" href="../../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "EliteAttack";
var mkdocs_page_input_path = "configuration/EliteAttack.md";
var mkdocs_page_url = "/VoiceAttack-profiles/configuration/EliteAttack/";
</script>
<script src="../../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../.." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../general/">General Configuration</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">EliteAttack</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#settings">Settings</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../.." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Configure &raquo;</li>
<li>EliteAttack</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/configuration/EliteAttack.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../general/" class="btn btn-neutral float-left" title="General Configuration"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../RatAttack/" class="btn btn-neutral float-right" title="RatAttack">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="eliteattack">EliteAttack<a class="headerlink" href="#eliteattack" title="Permanent link">&para;</a></h1>
<h2 id="settings">Settings<a class="headerlink" href="#settings" title="Permanent link">&para;</a></h2>
<p>Toggles:</p>
<ul>
<li><code>auto honk all systems</code>: Automatically honk upon entering a system, each jump,
without constraints. Default: false.</li>
<li><code>auto honk new systems</code>: Automatically honk upon entering a system if it is
your first visit. Default: true.</li>
<li><code>auto refuel</code>: Automatically refuel after docking at a station. Default:
true.</li>
<li><code>auto repair</code>: Automatically repair after docking at a station. Default:
true.</li>
<li><code>auto restock</code>: Automatically restock after docking at a station. Default:
true.</li>
<li><code>auto move to hangar</code>: Automatically move the ship to the hangar after docking
at a station. Default: true.</li>
<li><code>auto enter station services</code>: Automatically enter the Station Services menu
after docking at a station. Default: true.</li>
<li><code>auto retract landing gear</code>: Automatically retract landing gear when lifting
off a planet / undocking from a station. Default: true. (#133)</li>
<li><code>auto disable s r v lights</code>: Automatically turn SRV lights off when deploying
one. Default: true. (#133)</li>
<li><code>edsm system status</code>: Pull system data from EDSM and compare it
against your discovery scan. Default: true.</li>
<li><code>discovery scan on primary fire</code>: Use primary fire for honking instead of
secondary. Default: false.</li>
<li><code>flight assist off</code>: Permanent Flight Assist off mode. You should really do
that, its great. Default: false.</li>
<li><code>hyper space dethrottle</code>: Throttle down after a jump and when dropping from
SC. Like the SC Assist module does. Default: true.</li>
<li><code>limpet check</code>: Do a limpet check when undocking, reminding you if you forgot
to buy some. Default: true.</li>
<li><code>mapping candidates</code>: 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.</li>
<li><code>outdated stations</code>: Announce stations with outdated data in the online
databases. Default: true.</li>
<li><code>include outdated settlements</code> option: Include Odyssey settlements in the
outdated stations list. Default: true.</li>
<li><code>repair reports</code>: Report on AFMU repairs. Default: true.</li>
<li><code>road to riches</code>: Announce bodies worth scanning if you are looking for some
starting cash on the Road to Riches. Default: false.</li>
<li><code>route jump count</code>: Give a jump count on plotting a route. Default: true.</li>
<li><code>synthesis reports</code>: Report on synthesis. Default: true.</li>
</ul>
<p>Other settings:</p>
<ul>
<li><code>outdated station threshold</code>: The threshold for station data to count as
“outdated”, in days. Default: 365.</li>
<li><code>scanner fire group</code>: The fire group your discovery scanner is assigned to.
Default: 0 (the first one).</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../general/" class="btn btn-neutral float-left" title="General Configuration"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../RatAttack/" class="btn btn-neutral float-right" title="RatAttack">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../general/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../RatAttack/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '../..';</script>
<script src="../../js/theme_extra.js" defer></script>
<script src="../../js/theme.js" defer></script>
<script src="../../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

View file

@ -0,0 +1,277 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/RatAttack/" />
<link rel="shortcut icon" href="../../img/favicon.ico" />
<title>RatAttack - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../../css/theme.css" />
<link rel="stylesheet" href="../../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "RatAttack";
var mkdocs_page_input_path = "configuration/RatAttack.md";
var mkdocs_page_url = "/VoiceAttack-profiles/configuration/RatAttack/";
</script>
<script src="../../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../.." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">RatAttack</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#getting-case-data-from-irc">Getting Case Data From IRC</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#announcing-your-nearest-cmdr">Announcing Your Nearest CMDR</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#sending-text-to-fuelrats-irc">Sending Text to FuelRats IRC</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#settings">Settings</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../.." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Configure &raquo;</li>
<li>RatAttack</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/configuration/RatAttack.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../EliteAttack/" class="btn btn-neutral float-left" title="EliteAttack"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../SpanshAttack/" class="btn btn-neutral float-right" title="SpanshAttack">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="ratattack">RatAttack<a class="headerlink" href="#ratattack" title="Permanent link">&para;</a></h1>
<h2 id="getting-case-data-from-irc">Getting Case Data From IRC<a class="headerlink" href="#getting-case-data-from-irc" title="Permanent link">&para;</a></h2>
<p>You can setup your IRC client to pass incoming RATSIGNALS to VoiceAttack by
calling the <code>RatAttack-cli.exe</code> 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,
<code>\alterNERDtive\RatAttack-cli.exe</code>.</p>
<p><strong>Note</strong>: 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.</p>
<p>This has two purposes:</p>
<ol>
<li>Announcing a new incoming case (if passing <code>true</code> as second argument).</li>
<li>Storing case data and making it available to VoiceAttack, e.g. for copying
the clients system into the clipboard.</li>
</ol>
<p>For my AdiIRC, it looks like this (obviously change the path, please):</p>
<pre><code class="language-adiirc">on *:TEXT:*RATSIGNAL*(??_SIGNAL):#fuelrats:{
if ( $away ) {
/run -h &quot;X:\path\to\VoiceAttack\Apps\alterNERDtive\RatAttack-cli.exe&quot; &quot; $+ $replace($1-,&quot;,&quot;&quot;) $+ &quot; false
}
else {
/run -h &quot;X:\path\to\VoiceAttack\Apps\alterNERDtive\RatAttack-cli.exe&quot; &quot; $+ $replace($1-,&quot;,&quot;&quot;) $+ &quot; true
}
}
</code></pre>
<p>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.</p>
<p>The “replace” part handles the fact that announcements now put the system in
quotes. They have to be escaped as double quotes (<code>""</code>) to create a correct
command invocation.</p>
<p>You get the gist; if not and you dont know how to do the same thing for your
IRC client, either switch to AdiIRC or bribe me to make an example for yours.</p>
<p>mIRC is a straight forward copy &amp; paste job from Adi to mIRC (“Tools” → “Script
Editor” → “Remote”). Make sure you do not strip colour codes from incoming
messages!</p>
<p>Note for Hexchat users: Hexchat doesnt seem to have a simple way of doing this.
If you figure it out, Ill gladly add instructions here.</p>
<p>Keep in mind that if you are not on duty (see below) you will <em>not</em> get case
announcements.</p>
<h2 id="announcing-your-nearest-cmdr">Announcing Your Nearest CMDR<a class="headerlink" href="#announcing-your-nearest-cmdr" title="Permanent link">&para;</a></h2>
<p>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:</p>
<ol>
<li>Have all CMDRs on EDSM.</li>
<li>Have all profiles on EDSM set to <em>public</em> including your flight log (which
includes the current location).</li>
<li>Set the CMDR names you want to use (“customize setting set fuel rat
commanders”).</li>
<li>Enable the nearest CMDR announcements (“customize setting enable nearest
commander to fuel rat case”).</li>
</ol>
<p>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.</p>
<p>Currently there is no way to specify a platform for each CMDR separately.</p>
<h2 id="sending-text-to-fuelrats-irc">Sending Text to FuelRats IRC<a class="headerlink" href="#sending-text-to-fuelrats-irc" title="Permanent link">&para;</a></h2>
<p>The profile will attempt to send calls to “#fuelrats”, and you can send
messages from ingame chat to “#fuelrats” and “#ratchat”.</p>
<p>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 <code>RatAttack.sendToFuelrats</code> and
<code>RatAttack.sendToRatchat</code> commands to reflect the actual window titles on your
system. I will look into making this more elegant to change in the future.</p>
<h2 id="settings">Settings<a class="headerlink" href="#settings" title="Permanent link">&para;</a></h2>
<p>Toggles:</p>
<ul>
<li><code>auto close fuel rat case</code>: Automatically close a rat case when sending
“fuel+” via voice command or ingame chat. Default: false.</li>
<li><code>auto copy rat case system</code> : Automatically copy the clients system to the
clipboard when you open a rat case. Default: true.</li>
<li><code>fuel rat call confirmation</code>: Only make calls in #fuelrats after vocal
confirmation to prevent mistakes. Default: true.</li>
<li><code>fuel rat duty</code>: On duty, receiving case announcements via TTS. Default: true.</li>
<li><code>nearest commander to fuel rat case</code>: Announce the nearest commander to
incoming rat cases. Default: false.</li>
<li><code>platform for fuel rat case</code>: Announce the platform for incoming rat cases.
Default: false.</li>
<li><code>system information for fuel rat case</code>: System information provided by Mecha.
Default: true.</li>
</ul>
<p>Other Settings:</p>
<ul>
<li><code>fuel rat commanders</code>: All your CMDRs that are ready to take rat cases. Use
; as separator, e.g. “Bud Spencer;Terrence Hill”. Default: "".</li>
<li><code>fuel rat platforms</code>: The platform(s) you want to get case announcements for
(PC, Xbox, Playstation). Use ; as separator, e.g. “PC;Xbox”. Default: "PC".</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../EliteAttack/" class="btn btn-neutral float-left" title="EliteAttack"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../SpanshAttack/" class="btn btn-neutral float-right" title="SpanshAttack">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../EliteAttack/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../SpanshAttack/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '../..';</script>
<script src="../../js/theme_extra.js" defer></script>
<script src="../../js/theme.js" defer></script>
<script src="../../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

View file

@ -0,0 +1,224 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/SpanshAttack/" />
<link rel="shortcut icon" href="../../img/favicon.ico" />
<title>SpanshAttack - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../../css/theme.css" />
<link rel="stylesheet" href="../../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "SpanshAttack";
var mkdocs_page_input_path = "configuration/SpanshAttack.md";
var mkdocs_page_url = "/VoiceAttack-profiles/configuration/SpanshAttack/";
</script>
<script src="../../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../.." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">SpanshAttack</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#supplying-your-ships-range">Supplying Your Ships Range</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#settings">Settings</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../.." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Configure &raquo;</li>
<li>SpanshAttack</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/configuration/SpanshAttack.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../RatAttack/" class="btn btn-neutral float-left" title="RatAttack"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../StreamAttack/" class="btn btn-neutral float-right" title="StreamAttack">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="spanshattack">SpanshAttack<a class="headerlink" href="#spanshattack" title="Permanent link">&para;</a></h1>
<h2 id="supplying-your-ships-range">Supplying Your Ships Range<a class="headerlink" href="#supplying-your-ships-range" title="Permanent link">&para;</a></h2>
<p>The ED-NeutronRouter plugin is technically supposed to read the current jump
range from EDDI; sadly EDDI is storing the <em>maximum</em> 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 <em>current</em> fuel levels for range calculations, disregrading
the range loss if you fill your tank.</p>
<p>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.</p>
<p>In order to do that, copy the <code>SpanshAttack.getShipRange</code> 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
EDDIs reported laden range or VoiceAttack prompting you to manually supply it.</p>
<p><img alt="SpanshAttack-getshiprange.png" src="../../images/SpanshAttack-getshiprange.png" /></p>
<p>You can override a saved range for your ship by using the
<code>plot neutron [course;route;trip] with custom range</code> command.</p>
<h2 id="settings">Settings<a class="headerlink" href="#settings" title="Permanent link">&para;</a></h2>
<p>Toggles:</p>
<ul>
<li><code>auto jump after scooping</code>: Automatically jump out when fuel scooping is
complete. Default: true.</li>
<li><code>auto plot</code>: Automatically plot to the next waypoint after supercharging.
Default: true.</li>
<li><code>clear neutron route on shutdown</code>: Clear an active neutron route when the game
is shut down. Default: true.</li>
<li><code>copy neutron waypoints to clipboard</code>: Copy each neutron waypoint into the
Windows clipboard. Default: false.</li>
<li><code>default to laden range</code>: Default to the current ships laden range as
reported by EDDI instead of prompting for input. Default: false.</li>
<li><code>time neutron route</code>: Keep track of how long a neutron route takes you to
complete. Default: false.</li>
<li><code>waypoint announcements</code>: Announce each waypoint by name. Default: true.</li>
</ul>
<p>Other Settings:</p>
<ul>
<li><code>announce jumps left</code>: Estimated jumps left to announce when reached. NEEDS to
have leading and trailing “;”. Default: ";1;3;5;10;15;20;30;50;75;100;"</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../RatAttack/" class="btn btn-neutral float-left" title="RatAttack"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../StreamAttack/" class="btn btn-neutral float-right" title="StreamAttack">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../RatAttack/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../StreamAttack/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '../..';</script>
<script src="../../js/theme_extra.js" defer></script>
<script src="../../js/theme.js" defer></script>
<script src="../../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

View file

@ -0,0 +1,188 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/StreamAttack/" />
<link rel="shortcut icon" href="../../img/favicon.ico" />
<title>StreamAttack - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../../css/theme.css" />
<link rel="stylesheet" href="../../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "StreamAttack";
var mkdocs_page_input_path = "configuration/StreamAttack.md";
var mkdocs_page_url = "/VoiceAttack-profiles/configuration/StreamAttack/";
</script>
<script src="../../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../.." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">StreamAttack</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#settings">Settings</a>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../.." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Configure &raquo;</li>
<li>StreamAttack</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/configuration/StreamAttack.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../SpanshAttack/" class="btn btn-neutral float-left" title="SpanshAttack"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../../general/" class="btn btn-neutral float-right" title="General Commands">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="streamattack">StreamAttack<a class="headerlink" href="#streamattack" title="Permanent link">&para;</a></h1>
<h2 id="settings">Settings<a class="headerlink" href="#settings" title="Permanent link">&para;</a></h2>
<ul>
<li><code>StreamAttack output directory</code>: The directory the status files are written
to. Default: "%appdata%\StreamAttack\"</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../SpanshAttack/" class="btn btn-neutral float-left" title="SpanshAttack"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../../general/" class="btn btn-neutral float-right" title="General Commands">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../SpanshAttack/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../../general/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '../..';</script>
<script src="../../js/theme_extra.js" defer></script>
<script src="../../js/theme.js" defer></script>
<script src="../../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

View file

@ -0,0 +1,256 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/general/" />
<link rel="shortcut icon" href="../../img/favicon.ico" />
<title>General Configuration - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../../css/theme.css" />
<link rel="stylesheet" href="../../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "General Configuration";
var mkdocs_page_input_path = "configuration/general.md";
var mkdocs_page_url = "/VoiceAttack-profiles/configuration/general/";
</script>
<script src="../../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../.." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">General Configuration</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#settings">Settings</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#general-settings-for-all-profiles">General Settings for All Profiles</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#note-on-non-standard-keyboard-layouts">Note on Non-Standard Keyboard Layouts</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#adding-commands">Adding Commands</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#eddi-events">EDDI Events</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../.." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Configure &raquo;</li>
<li>General Configuration</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/configuration/general.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../../upgrading/" class="btn btn-neutral float-left" title="Upgrading"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../EliteAttack/" class="btn btn-neutral float-right" title="EliteAttack">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="general-configuration">General Configuration<a class="headerlink" href="#general-configuration" title="Permanent link">&para;</a></h1>
<h2 id="settings">Settings<a class="headerlink" href="#settings" title="Permanent link">&para;</a></h2>
<p>All profiles will load sane defaults if you havent 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.</p>
<p>The easiest way to change settings is to say <code>customize settings</code>. That will
bring up a rudimentary settings UI.</p>
<p>You change also change the configuration directly via voice commands:</p>
<ul>
<li>For toggles (booleans): <code>customize setting [enable;disable] &lt;trigger phrase&gt;</code></li>
<li>For everything else: <code>customize setting set &lt;trigger phrase&gt;</code></li>
</ul>
<p>You can find a list of trigger phrases on this page, or you can say
<code>customize setting list [options;settings]</code> for a list of voice triggers and
what they do. If you dont remember your settings or just want a nice list,
<code>customize setting report [options;settings]</code> will print that to the
VoiceAttack log. If you want to reset everything back to default state, say
<code>customize setting clear all my settings</code>.</p>
<p>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.</p>
<p>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.</p>
<h3 id="general-settings-for-all-profiles">General Settings for All Profiles<a class="headerlink" href="#general-settings-for-all-profiles" title="Permanent link">&para;</a></h3>
<p>Toggles:</p>
<ul>
<li><code>auto update check</code>: Automatically check Github for profiles updates when the
profile loads. Default: true.</li>
<li><code>eddi quiet mode</code>: Make EDDI shut up. Disables all built-in speech responders.
Default: true.</li>
</ul>
<p>Other settings:</p>
<ul>
<li><code>elite paste key</code>: The key used to paste in conjunction with CTRL. The
physical key in your layout that would be 'V' on QWERTY. Default: 'v'.</li>
<li><code>log level</code>: The level of detail for logging to the VoiceAttack log. Valid
levels are "ERROR", "WARN", "NOTICE", "INFO" and "DEBUG". Default: "NOTICE".</li>
<li><code>quit to desktop delay</code>: The delay before restarting the game after hitting
“Exit to Desktop”, in seconds. Default: 10.0. (Used by the <code>restart from desktop</code>
command)</li>
</ul>
<h2 id="note-on-non-standard-keyboard-layouts">Note on Non-Standard Keyboard Layouts<a class="headerlink" href="#note-on-non-standard-keyboard-layouts" title="Permanent link">&para;</a></h2>
<p>Because Elites keyboard handling is … weird youll 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 <code>V</code> would be on QWERTY, e.g. <code>P</code> for
<a href="https://neo-layout.org">Neo2</a>.</p>
<p>To set the key, say “customize setting set elite paste key”.</p>
<h2 id="adding-commands">Adding Commands<a class="headerlink" href="#adding-commands" title="Permanent link">&para;</a></h2>
<p>If you want to edit a command or add your own, <em>do not edit the profiles
directly</em>. 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.</p>
<h3 id="eddi-events">EDDI Events<a class="headerlink" href="#eddi-events" title="Permanent link">&para;</a></h3>
<p>Because of limitations of VoiceAttack itself, only the first matching command
found will be executed, <em>including EDDI events</em>. 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 <code>eddi.Event</code> plugin context of the <code>alterNERDtive-base</code> plugin. Otherwise
stuff <em>will</em> break.</p>
<p><img alt="EDDI-event.png" src="../../images/EDDI-event.png" /></p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../../upgrading/" class="btn btn-neutral float-left" title="Upgrading"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../EliteAttack/" class="btn btn-neutral float-right" title="EliteAttack">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../../upgrading/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../EliteAttack/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '../..';</script>
<script src="../../js/theme_extra.js" defer></script>
<script src="../../js/theme.js" defer></script>
<script src="../../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because it is too large Load diff

After

Width:  |  Height:  |  Size: 434 KiB

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
css/fonts/lato-bold.woff Normal file

Binary file not shown.

BIN
css/fonts/lato-bold.woff2 Normal file

Binary file not shown.

Binary file not shown.

Binary file not shown.

BIN
css/fonts/lato-normal.woff Normal file

Binary file not shown.

BIN
css/fonts/lato-normal.woff2 Normal file

Binary file not shown.

13
css/theme.css Normal file

File diff suppressed because one or more lines are too long

191
css/theme_extra.css Normal file
View file

@ -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]
* <repo_name> Next >> // On the first page
* <repo_name> << 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;
}

227
general/index.html Normal file
View file

@ -0,0 +1,227 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/general/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>General Commands - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "General Commands";
var mkdocs_page_input_path = "general.md";
var mkdocs_page_url = "/VoiceAttack-profiles/general/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">General Commands</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#configuration">Configuration</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#chat">Chat</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#updating">Updating</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#miscellaneous">Miscellaneous</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Use &raquo;</li>
<li>General Commands</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/general.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../configuration/StreamAttack/" class="btn btn-neutral float-left" title="StreamAttack"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../EliteAttack/" class="btn btn-neutral float-right" title="EliteAttack">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="general-commands">General Commands<a class="headerlink" href="#general-commands" title="Permanent link">&para;</a></h1>
<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h2>
<p>The base profile provides voice commands for changing the profiles settings.
See <a href="../configuration/general#settings">the configuration section</a>.</p>
<h2 id="chat">Chat<a class="headerlink" href="#chat" title="Permanent link">&para;</a></h2>
<ul>
<li><code>paste text</code>: Pastes the contents of your current clipboard. Note that this
command is supposed to be used for pasting <em>into Elite</em> and hence uses the
configured paste key. If youre using a non-standard layout that means that
you <em>cannot</em> use this command to paste text into other applications.</li>
</ul>
<h2 id="updating">Updating<a class="headerlink" href="#updating" title="Permanent link">&para;</a></h2>
<ul>
<li><code>check for profiles update</code>: Checks Github for a new version, and alerts you
if there is one.</li>
<li><code>download profiles update</code>: Opens the latest release on Github and the
VoiceAttack import folder where you can drop it.</li>
<li><code>open profiles [docs;documentation;help] [file;site;]</code>: Opens this
documentation, either on the web or the PDF file supplied with the installed
release.</li>
<li><code>open profiles change log</code>: Opens the CHANGELOG on Github.</li>
<li><code>open voiceattack [apps;import;sounds] [folder;directory]</code>: Opens the
respective VoiceAttack-related folder.</li>
</ul>
<h2 id="miscellaneous">Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permanent link">&para;</a></h2>
<ul>
<li><code>generate missing key binds report</code>: Generates a report of missing key binds
and places it on your Desktop. Note that this currently uses bindEDs built-in
report which will output <em>any</em> bind that does not have a keyboard key set,
including axis binds and binds that are not actually used by the profiles.</li>
<li><code>open documentation</code>: Opens the documentation in your default browser.</li>
<li><code>open EDDI options;configure EDDI</code>: Displays EDDIs configuration window.</li>
<li><code>open elite bindings folder</code>: Opens Elites bindings folder
(<code>%localappdata%\Frontier Developments\Elite Dangerous\Options\Bindings</code>)</li>
<li><code>reload elite key binds</code>: Forces a reload of your Elite binds. Should not be
necessary.</li>
<li><code>shut up EDDI</code>: Immediately interrupts any current and pending speech on
EDDIs end.</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../configuration/StreamAttack/" class="btn btn-neutral float-left" title="StreamAttack"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../EliteAttack/" class="btn btn-neutral float-right" title="EliteAttack">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../configuration/StreamAttack/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../EliteAttack/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

BIN
images/EDDI-event.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

BIN
images/Elite-COVAS.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 184 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 152 KiB

BIN
images/Elite-binds.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

BIN
images/VoiceAttack-apps.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
images/VoiceAttack-edit.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

BIN
images/bindED-layout.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

BIN
img/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

218
index.html Normal file
View file

@ -0,0 +1,218 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="description" content="alterNERDtive VoiceAttack profiles for Elite: Dangerous" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/" />
<link rel="shortcut icon" href="img/favicon.ico" />
<title>alterNERDtive VA profiles</title>
<link rel="stylesheet" href="css/theme.css" />
<link rel="stylesheet" href="css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Home";
var mkdocs_page_input_path = "index.md";
var mkdocs_page_url = "/VoiceAttack-profiles/";
</script>
<script src="js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href=".">Home</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#available-profiles">Available Profiles</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#need-help-want-to-contribute">Need Help / Want to Contribute?</a>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Home</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/index.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="requirements/" class="btn btn-neutral float-right" title="Requirements">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="elite-dangerous-voiceattack-profiles">Elite Dangerous VoiceAttack Profiles<a class="headerlink" href="#elite-dangerous-voiceattack-profiles" title="Permanent link">&para;</a></h1>
<p>These are various profiles for <a href="https://voiceattack.com">VoiceAttack</a> (VA) I use
to enhance my Elite experience. They give me important info, facilitate
day-to-day gaming and do some special things for <a href="https://fuelrats.com">Fuel
Rats</a> and <a href="https://hullseals.space">Hull Seals</a> work.</p>
<p><strong>NOTE</strong>: Further development is on hold and Odyssey compatibility will not be
worked on for the time being. See <a href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/113">the corresponding issue on
Github</a>. 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.</p>
<h2 id="available-profiles">Available Profiles<a class="headerlink" href="#available-profiles" title="Permanent link">&para;</a></h2>
<ul>
<li><a href="EliteAttack">EliteAttack</a>: The main Elite VA profile. Anything related to
“just” playing the game.</li>
<li><a href="RatAttack">RatAttack</a>: Manages interactions with the FuelRats IRC server.</li>
<li><a href="SpanshAttack">SpanshAttack</a>: Plots and follows trips along the neutron
highway using <a href="https://spansh.co.uk/plotter">Spanshs neutron plotter</a>.</li>
<li><a href="StreamAttack">StreamAttack</a>: Writes various status things to files that can
then be read by streaming software like OBS.</li>
</ul>
<p>They all require the <code>alterNERDtive-base</code> profile that, well, provides basic
functionality common to all of the above.</p>
<h2 id="need-help-want-to-contribute">Need Help / Want to Contribute?<a class="headerlink" href="#need-help-want-to-contribute" title="Permanent link">&para;</a></h2>
<p>Well, you are in the right place. You can find comprehensive documentation right
here.</p>
<p>If you run into any errors, please make sure you are running the latest version
of the profiles and all <a href="requirements/">requirements</a>.</p>
<p>If your problem persists, please <a href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues">file an
issue</a>. Thanks! :)</p>
<p>You can also <a href="https://discord.gg/kXtXm54">say “Hi” on Discord</a> if that is your
thing.</p>
<p><a href="https://github.com/sponsors/alterNERDtive"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/alterNERDtive?style=for-the-badge" /></a>
<a href="https://ko-fi.com/S6S1DLYBS"><img alt="ko-fi" src="https://ko-fi.com/img/githubbutton_sm.svg" /></a></p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="requirements/" class="btn btn-neutral float-right" title="Requirements">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="requirements/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '.';</script>
<script src="js/theme_extra.js" defer></script>
<script src="js/theme.js" defer></script>
<script src="search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>
<!--
MkDocs version : 1.3.1
Build Date UTC : 2022-09-19 16:31:43.270035+00:00
-->

389
installing/index.html Normal file
View file

@ -0,0 +1,389 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/installing/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Installing - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Installing";
var mkdocs_page_input_path = "installing.md";
var mkdocs_page_url = "/VoiceAttack-profiles/installing/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../requirements/">Requirements</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Installing</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#install-voiceattack">Install VoiceAttack</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#enable-plugin-support">Enable Plugin Support</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#install-eddi">Install EDDI</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#install-ed-neutronrouter">Install ED-NeutronRouter</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#import-profiles-package">Import Profiles Package</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#create-a-custom-profile">Create a Custom Profile</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#option-1-create-a-new-profile-or-use-an-existing-one">Option 1: Create a New Profile Or Use an Existing One</a>
<ul>
<li class="toctree-l4"><a class="reference internal" href="#create-a-startup-command">Create a Startup Command</a>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#option-2-use-the-profile-example">Option 2: Use the Profile Example</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#include-profiles">Include Profiles</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#set-profile-options">Set Profile Options</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#reload-the-profile">Reload the Profile</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#set-elite-keyboard-binds">Set Elite Keyboard Binds</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Install &raquo;</li>
<li>Installing</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/installing.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../requirements/" class="btn btn-neutral float-left" title="Requirements"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../upgrading/" class="btn btn-neutral float-right" title="Upgrading">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="installing">Installing<a class="headerlink" href="#installing" title="Permanent link">&para;</a></h1>
<h2 id="install-voiceattack">Install VoiceAttack<a class="headerlink" href="#install-voiceattack" title="Permanent link">&para;</a></h2>
<p>Grab the <a href="https://voiceattack.com/#download-1">most recent VoiceAttack beta
version</a> off the official site and install
it.</p>
<p>If you are using the standalone version you should probably download the
executable installer.</p>
<p><img alt="VoiceAttack-download.png" src="../images/VoiceAttack-download.png" /></p>
<p>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.</p>
<p><a href="https://steamcommunity.com/sharedfiles/filedetails/?id=760447682">Here is the first hit on a Google search for finding the installation
folder</a>. It is
for a completely unrelated game, but the steps are the same.</p>
<p>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
youre reading this, just get the full release then.</p>
<h3 id="enable-plugin-support">Enable Plugin Support<a class="headerlink" href="#enable-plugin-support" title="Permanent link">&para;</a></h3>
<p>Make sure you have plugin support enabled:</p>
<ol>
<li>Go to VoiceAttack settings. <img alt="VoiceAttack-settings.png" src="../images/VoiceAttack-settings.png" /></li>
<li>Check “enable plugin support”. <img alt="VoiceAttack-settings-plugin-support.png" src="../images/VoiceAttack-settings-plugin-support.png" /></li>
</ol>
<p>While you are there, you might also want to enable the automatic update checks
(Note: those settings do not exist in the Steam version).</p>
<p><img alt="VoiceAttack-settings-updates.png" src="../images/VoiceAttack-settings-updates.png" /></p>
<h2 id="install-eddi">Install EDDI<a class="headerlink" href="#install-eddi" title="Permanent link">&para;</a></h2>
<p>Install <a href="https://github.com/EDCD/EDDI/releases/latest">the latest release</a> from
Github (The <code>EDDI-X.Y.Z.exe</code> file under “Assets”). You will need to <a href="https://github.com/EDCD/EDDI/wiki/VoiceAttack-Integration#using-eddi-with-voiceattack">install it
as a VoiceAttack
plugin</a>.</p>
<p>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 + <code>R</code>, enter “cmd”,
hit <code>Enter</code>) and do</p>
<pre><code class="language-cmd">&gt;cd x:\path\to\VoiceAttack\Apps
&gt;mklink /J EDDI x:\path\to\EDDI
</code></pre>
<p>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 + <code>R</code>, enter “cmd”, hit <code>Control</code> + <code>Shift</code> + <code>Enter</code>).</p>
<h2 id="install-ed-neutronrouter">Install ED-NeutronRouter<a class="headerlink" href="#install-ed-neutronrouter" title="Permanent link">&para;</a></h2>
<p>Grab <a href="https://github.com/sc-pulgan/ED-NeutronRouter/releases/latest">the latest release release from
Github</a> (The
<code>EDNeutronRouter.vX.YZ.zip</code> under “Assets”). You will have to extract the
contents of the release .zip file to your VoiceAttack Apps folder:</p>
<ol>
<li>Go into VoiceAttack settings. <img alt="VoiceAttack-settings.png" src="../images/VoiceAttack-settings.png" /></li>
<li>Click the folder set as “Apps Folder”. <img alt="VoiceAttack-apps.png" src="../images/VoiceAttack-apps.png" /></li>
</ol>
<p>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
<em>are</em> in a subfolder. Otherwise the plugin will not load.</p>
<p><img alt="ED-NeutronRouter-folder.png" src="../images/ED-NeutronRouter-folder.png" /></p>
<p>Leave the “Apps” folder open in Windows Explorer, you will need it for the next step.</p>
<h2 id="import-profiles-package">Import Profiles Package<a class="headerlink" href="#import-profiles-package" title="Permanent link">&para;</a></h2>
<p>Acquire <a href="https://github.com/alterNERDtive/VoiceAttack-profiles/releases/latest">the latest
release</a>
from Github (the <code>alterNERDtive-voiceattack-profiles.vax</code> file under “Assets”).
Put it into VoiceAttacks “Import” folder:</p>
<ol>
<li>Go into VoiceAttack settings. <img alt="VoiceAttack-settings.png" src="../images/VoiceAttack-settings.png" /></li>
<li>Click the folder set as “Apps Folder”. <img alt="VoiceAttack-apps.png" src="../images/VoiceAttack-apps.png" /></li>
<li>Create a sub folder named “Import” if it does not exist yet.</li>
<li>Drop the downloaded .vax file into the “Import” folder.</li>
<li>Restart VoiceAttack.</li>
<li>When prompted, import the profile package. VoiceAttack will restart when completed.</li>
</ol>
<h2 id="create-a-custom-profile">Create a Custom Profile<a class="headerlink" href="#create-a-custom-profile" title="Permanent link">&para;</a></h2>
<p>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.</p>
<p>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 <a href="#include-profiles">Include Profiles</a> section and follow the instructions there!</p>
<h3 id="option-1-create-a-new-profile-or-use-an-existing-one">Option 1: Create a New Profile Or Use an Existing One<a class="headerlink" href="#option-1-create-a-new-profile-or-use-an-existing-one" title="Permanent link">&para;</a></h3>
<ol>
<li>Click the “Profile Actions” button, then “Create New Profile”.
<img alt="VoiceAttack-new-profile.png" src="../images/VoiceAttack-new-profile.png" /></li>
<li>Give it a name and add some commands if you want to.</li>
<li>Hit “Done” to create the new profile.</li>
</ol>
<p>Alternatively you can keep using your existing profile. You will still have to
follow the rest of the instructions in this case.</p>
<h4 id="create-a-startup-command">Create a Startup Command<a class="headerlink" href="#create-a-startup-command" title="Permanent link">&para;</a></h4>
<p>First off, hit the “Edit” button in VoiceAttack.</p>
<p><img alt="VoiceAttack-edit.png" src="../images/VoiceAttack-edit.png" /></p>
<p>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.</p>
<p><img alt="VoiceAttack-edit-new-command.png" src="../images/VoiceAttack-edit-new-command.png" /></p>
<p>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.</p>
<p><img alt="VoiceAttack-edit-startup.png" src="../images/VoiceAttack-edit-startup.png" /></p>
<p>Add a new action using “Other” → “VoiceAttack Action”→ “Execute Another Command”.</p>
<p><img alt="VoiceAttack-edit-startup-execute.png" src="../images/VoiceAttack-edit-startup-execute.png" /></p>
<p>Choose “Execute by name (Advanced)” and enter <code>((alterNERDtive-base.startup))</code>.</p>
<p><img alt="VoiceAttack-edit-startup-action.png" src="../images/VoiceAttack-edit-startup-action.png" /></p>
<p>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.</p>
<p><img alt="VoiceAttack-edit-startup-actionlist.png" src="../images/VoiceAttack-edit-startup-actionlist.png" /></p>
<p>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 <a href="../configuration/general/#settings">later on</a>.</p>
<p>After adding the startup command you will have to right click VoiceAttacks
title bar and choose “Reload Active Profile” or restart VoiceAttack to see it
executed for the first time.</p>
<h3 id="option-2-use-the-profile-example">Option 2: Use the Profile Example<a class="headerlink" href="#option-2-use-the-profile-example" title="Permanent link">&para;</a></h3>
<ol>
<li>Click the “Profile Actions” button, then “Import Profile”.
<img alt="VoiceAttack-import-profile.png" src="../images/VoiceAttack-import-profile.png" /></li>
<li>Navigate to your VoiceAttack Apps folder (see above), go into the
“alterNERDtive” subfolder, choose the profile example and hit “Open”.
<img alt="VoiceAttack-import-profile-open.png" src="../images/VoiceAttack-import-profile-open.png" /></li>
</ol>
<p>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”!</p>
<h2 id="include-profiles">Include Profiles<a class="headerlink" href="#include-profiles" title="Permanent link">&para;</a></h2>
<p>In order to use my profiles with your custom profile, you will need to take two
additional steps:</p>
<ol>
<li>Include the profiles in your custom profile. That will make all commands
available when your custom profile is active.</li>
<li>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.</li>
</ol>
<h4 id="set-profile-options">Set Profile Options<a class="headerlink" href="#set-profile-options" title="Permanent link">&para;</a></h4>
<p>While editing the profile, hit the “Options” button.</p>
<p><img alt="VoiceAttack-profile-options.png" src="../images/VoiceAttack-profile-options.png" /></p>
<p>On the section labeled “Include commands from other profiles”, hit the “…”
button.</p>
<p><img alt="VoiceAttack-profile-options-include.png" src="../images/VoiceAttack-profile-options-include.png" /></p>
<p>Add all my profiles (“alterNERDtive-base”, “EliteAttack”, “RatAttack”,
“SpanshAttack”, “StreamAttack”).</p>
<p><img alt="VoiceAttack-profile-options-includelist.png" src="../images/VoiceAttack-profile-options-includelist.png" /></p>
<p>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!</p>
<p>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.</p>
<p><img alt="VoiceAttack-profile-options-startup.png" src="../images/VoiceAttack-profile-options-startup.png" /></p>
<h2 id="reload-the-profile">Reload the Profile<a class="headerlink" href="#reload-the-profile" title="Permanent link">&para;</a></h2>
<p>To make sure everything is loaded correctly, you now need to either reload the
profile by right clicking on VoiceAttacks title bar → “Reset Active Profile” or
by simply restarting VoiceAttack.</p>
<p>You should see a bunch of initialization messages pop up in the VoiceAttack log.</p>
<h2 id="set-elite-keyboard-binds">Set Elite Keyboard Binds<a class="headerlink" href="#set-elite-keyboard-binds" title="Permanent link">&para;</a></h2>
<p>You need to have keyboard binds setup at least as secondary bindings in Elites
controls options. VoiceAttack <em>cannot</em> “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.</p>
<p><img alt="Elite-binds.png" src="../images/Elite-binds.png" /></p>
<p>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.</p>
<p><img alt="Elite-binds-galmap.png" src="../images/Elite-binds-galmap.png" /></p>
<p>Should you use a keyboard layout that is <em>not</em> en-US QWERTY, some keys might not
work out of the box. You can try telling bindED about your keyboard layout by
setting the <code>bindED.layout#</code> variable (including the <code>#</code>!) to something more
appropriate in your startup command.</p>
<p><img alt="bindED-layout.png" src="../images/bindED-layout.png" /></p>
<p>Currently bindED supports the <code>en-US</code>, <code>en-GB</code> and <code>de-Neo2</code> layouts. <a href="https://alternerdtive.github.io/bindED/troubleshooting/#adding-a-keyboard-layout">You can
find instructions on how to add your own
here</a>.</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../requirements/" class="btn btn-neutral float-left" title="Requirements"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../upgrading/" class="btn btn-neutral float-right" title="Upgrading">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../requirements/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../upgrading/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

4
js/html5shiv.min.js vendored Normal file
View file

@ -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<style>"+b+"</style>",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="<xyz></xyz>",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);

2
js/jquery-3.6.0.min.js vendored Normal file

File diff suppressed because one or more lines are too long

2
js/theme.js Normal file

File diff suppressed because one or more lines are too long

8
js/theme_extra.js Normal file
View file

@ -0,0 +1,8 @@
/*
* Assign 'docutils' class to tables so styling and
* JavaScript behavior is applied.
*
* https://github.com/mkdocs/mkdocs/issues/2028
*/
$('div.rst-content table').addClass('docutils');

240
requirements/index.html Normal file
View file

@ -0,0 +1,240 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/requirements/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Requirements - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Requirements";
var mkdocs_page_input_path = "requirements.md";
var mkdocs_page_url = "/VoiceAttack-profiles/requirements/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Requirements</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#voiceattack">VoiceAttack</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#eddi">EDDI</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#binded">bindED</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#elite-scripts">Elite Scripts</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#ed-neutronrouter">ED-NeutronRouter</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Install &raquo;</li>
<li>Requirements</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/requirements.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href=".." class="btn btn-neutral float-left" title="Home"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../installing/" class="btn btn-neutral float-right" title="Installing">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permanent link">&para;</a></h1>
<h2 id="voiceattack">VoiceAttack<a class="headerlink" href="#voiceattack" title="Permanent link">&para;</a></h2>
<p>Obviously you will need to install <a href="https://voiceattack.com">VoiceAttack</a>. 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).</p>
<p>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!</p>
<p>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.</p>
<h2 id="eddi">EDDI<a class="headerlink" href="#eddi" title="Permanent link">&para;</a></h2>
<p><a href="https://github.com/EDCD/EDDI">EDDI</a> 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.</p>
<p>EDDI also regularly publishes beta versions. Unless a profiles release
explicitly states it you will <em>not</em> have to run EDDI beta.</p>
<p>Do note that the profiles put EDDI into quiet mode by default, disabling the
built-in speech responders. This can be changed
<a href="../configuration/general/#general-settings-for-all-profiles">via the <code>EDDI quiet mode</code> setting</a>.</p>
<h2 id="binded">bindED<a class="headerlink" href="#binded" title="Permanent link">&para;</a></h2>
<p><a href="https://alterNERDtive.github.io/bindED">bindED</a> 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.</p>
<p>This plugin is <em>included</em> in the release package. You do <em>not</em> have to download
and install it manually, but you <em>can</em> independently update it if a newer
version is available.</p>
<h2 id="elite-scripts">Elite Scripts<a class="headerlink" href="#elite-scripts" title="Permanent link">&para;</a></h2>
<p>I have written a <a href="https://github.com/alterNERDtive/elite-scripts">collection of Python
scripts</a> to interface with
various 3ʳᵈ party services like EDSM or Spansh. Those are called by the profiles
for various tasks, like checking a systems body count.</p>
<p>In the future they will be replaced by VoiceAttack plugin code.</p>
<p>The scripts are <em>included</em> in the release package. You do <em>not</em> have to download
and install them manually, but you <em>can</em> independently update them if a newer
version is available.</p>
<h2 id="ed-neutronrouter">ED-NeutronRouter<a class="headerlink" href="#ed-neutronrouter" title="Permanent link">&para;</a></h2>
<p><a href="https://github.com/sc-pulgan/ED-NeutronRouter">ED-NeutronRouter</a> interfaces
with <a href="https://spansh.uk/plotter">Spanshs neutron plotter</a> and makes the result
available to VoiceAttack.</p>
<p>This plugin is <em>only</em> required if you intend to use the SpanshAttack profile for
neutron routing. Otherwise you do not have to install it.</p>
<p>This will also eventually be replaced by my own plugins.</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href=".." class="btn btn-neutral float-left" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../installing/" class="btn btn-neutral float-right" title="Installing">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href=".." style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../installing/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

167
search.html Normal file
View file

@ -0,0 +1,167 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" />
<link rel="shortcut icon" href="./img/favicon.ico" />
<title>alterNERDtive VA profiles</title>
<link rel="stylesheet" href="./css/theme.css" />
<link rel="stylesheet" href="./css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script src="./js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="./js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="./." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="./.">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="./requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="./installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="./upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="./configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="./configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="./configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="./configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="./configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="./general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="./EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="./RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="./SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="./StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="./troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="./.">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="./." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="search">Search Results</h1>
<form id="content_search" action="search.html">
<span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span>
<input name="q" id="mkdocs-search-query" type="text" class="search_input search-query ui-autocomplete-input" placeholder="Search the Docs" autocomplete="off" autofocus title="Type search term here">
</form>
<div id="mkdocs-search-results" class="search-results" data-no-results-text="No results found">
Searching...
</div>
</div>
</div><footer>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
</span>
</div>
<script>var base_url = '.';</script>
<script src="./js/theme_extra.js" defer></script>
<script src="./js/theme.js" defer></script>
<script src="./search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

3475
search/lunr.js Normal file

File diff suppressed because it is too large Load diff

109
search/main.js Normal file
View file

@ -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, '&amp;')
.replace(/"/g, '&quot;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;');
}
function formatResult (location, title, summary) {
return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ escapeHtml(title) + '</a></h3><p>' + escapeHtml(summary) +'</p></article>';
}
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', '<p>' + noResultsText + '</p>');
}
}
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;
}

1
search/search_index.json Normal file

File diff suppressed because one or more lines are too long

133
search/worker.js Normal file
View file

@ -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);
}
};
}

83
sitemap.xml Normal file
View file

@ -0,0 +1,83 @@
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/EliteAttack/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/RatAttack/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/SpanshAttack/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/StreamAttack/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/VoiceAttack/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/general/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/installing/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/requirements/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/troubleshooting/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/upgrading/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/EliteAttack/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/RatAttack/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/SpanshAttack/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/StreamAttack/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://alterNERDtive.github.io/VoiceAttack-profiles/configuration/general/</loc>
<lastmod>2022-09-19</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
sitemap.xml.gz Normal file

Binary file not shown.

261
troubleshooting/index.html Normal file
View file

@ -0,0 +1,261 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/troubleshooting/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Troubleshooting - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Troubleshooting";
var mkdocs_page_input_path = "troubleshooting.md";
var mkdocs_page_url = "/VoiceAttack-profiles/troubleshooting/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="./">Troubleshooting</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#voiceattack-does-not-understand-me-mishears-me-fires-random-commands">VoiceAttack does not understand me / mishears me / fires random commands</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#voiceattack-recognizes-a-command-but-doesnt-do-anything-in-game">VoiceAttack recognizes a command, but doesnt do anything in game</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#voiceattack-talks-over-the-covas-voice">VoiceAttack talks over the COVAS voice</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#this-doesnt-work-well-with-my-hcs-pack">This doesnt work (well) with my HCS pack</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#this-does-not-work-with-geforce-now">This does not work with Geforce Now</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Issues &raquo;</li>
<li>Troubleshooting</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/troubleshooting.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../StreamAttack/" class="btn btn-neutral float-left" title="StreamAttack"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">&para;</a></h1>
<p>This will fill up gradually with Troubleshooting tips as people run into common
ones.</p>
<h2 id="voiceattack-does-not-understand-me-mishears-me-fires-random-commands">VoiceAttack does not understand me / mishears me / fires random commands<a class="headerlink" href="#voiceattack-does-not-understand-me-mishears-me-fires-random-commands" title="Permanent link">&para;</a></h2>
<p>There is <a href="https://forum.voiceattack.com/smf/index.php?topic=2667.msg12197#msg12197">a thread on the VoiceAttack
forums</a>
on how to set up your microphone and the speech recognition engine to work best.</p>
<p>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.</p>
<ol>
<li>Create a new command in your custom profile.</li>
<li>Set the “when I say” field to the trigger that gets misrecognized.</li>
</ol>
<p>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.</p>
<p>Example for the “cruise” voice trigger of the Supercruise command:</p>
<p><img alt="troubleshooting-remove-trigger.png" src="../images/troubleshooting-remove-trigger.png" /></p>
<p>Alternatively you can raise the minimum confidence level and call the underlying
command to make misfires less likely:</p>
<p><img alt="troubleshooting-raise-min-confidence.png" src="../images/troubleshooting-raise-min-confidence.png" /></p>
<p>There are a few examples in the <a href="../installing#use-the-profile-example">Custom Profile
Example</a>.</p>
<h2 id="voiceattack-recognizes-a-command-but-doesnt-do-anything-in-game">VoiceAttack recognizes a command, but doesnt do anything in game<a class="headerlink" href="#voiceattack-recognizes-a-command-but-doesnt-do-anything-in-game" title="Permanent link">&para;</a></h2>
<p>Make sure you have a keyboard bind for whatever the command is supposed to do as
outlined in <a href="../installing/#set-elite-keyboard-binds">Installing#Set Elite Keyboard Binds</a>.</p>
<h2 id="voiceattack-talks-over-the-covas-voice">VoiceAttack talks over the COVAS voice<a class="headerlink" href="#voiceattack-talks-over-the-covas-voice" title="Permanent link">&para;</a></h2>
<p>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.</p>
<p>You can however either disable TTS responses for events that you know will clash
(or <a href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">file a feature
request</a> 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:</p>
<p><img alt="Elite-COVAS.png" src="../images/Elite-COVAS.png" /></p>
<p>While youre in there you might as well get rid of the spoken FSD countdown that
is off by one second …</p>
<h2 id="this-doesnt-work-well-with-my-hcs-pack">This doesnt work (well) with my HCS pack<a class="headerlink" href="#this-doesnt-work-well-with-my-hcs-pack" title="Permanent link">&para;</a></h2>
<p>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. <code>EliteAttack</code> as your active profile.</p>
<p>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 profiles startup command.</p>
<p>So, in order to mostly make stuff work, you need to treat the HCS profile as
your “custom” profile as per this documentation.</p>
<ol>
<li>Include <code>alterNERDtive-base</code> and all profiles you want to use into the active
HCS profile.</li>
<li>Include a custom profile that has a startup command with a voice trigger of
your choosing, e.g. “load included profiles”.</li>
<li>Set up said startup command as you would normally.</li>
<li>Every time you start VA or change profiles, you will have to manually say
“load included profiles”.</li>
</ol>
<p>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.</p>
<p><strong>Note on TTS</strong>: EDDIs 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.</p>
<p>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.</p>
<h2 id="this-does-not-work-with-geforce-now">This does not work with Geforce Now<a class="headerlink" href="#this-does-not-work-with-geforce-now" title="Permanent link">&para;</a></h2>
<p>Nope. Just wont. Geforce Now obviously has Elites files, journals and keybinds
stored on some random PC in the cloud. Your local VoiceAttack has no way of
accessing those.</p>
<p>If you can get VoiceAttack to run <em>on Geforce Now</em> in parallel to Elite, I dont
see why it wouldnt work.</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../StreamAttack/" class="btn btn-neutral float-left" title="StreamAttack"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../StreamAttack/" style="color: #fcfcfc">&laquo; Previous</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>

275
upgrading/index.html Normal file
View file

@ -0,0 +1,275 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/upgrading/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Upgrading - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Upgrading";
var mkdocs_page_input_path = "upgrading.md";
var mkdocs_page_url = "/VoiceAttack-profiles/upgrading/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> alterNERDtive VA profiles
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Upgrading</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#3xx-to-4xx">3.x.x to 4.x.x</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#eddi-events">EDDI Events</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#binded">bindED</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#elitedangerous">EliteDangerous</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#ratattack">RatAttack</a>
<ul>
<li class="toctree-l4"><a class="reference internal" href="#getting-case-data-from-irc">Getting Case Data From IRC</a>
</li>
<li class="toctree-l4"><a class="reference internal" href="#nearest-cmdr-announcements">Nearest CMDR Announcements</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">alterNERDtive VA profiles</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Install &raquo;</li>
<li>Upgrading</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/upgrading.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../installing/" class="btn btn-neutral float-left" title="Installing"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../configuration/general/" class="btn btn-neutral float-right" title="General Configuration">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="upgrading">Upgrading<a class="headerlink" href="#upgrading" title="Permanent link">&para;</a></h1>
<p>To upgrade to the latest version, follow these simple steps:</p>
<ol>
<li>Say “download profiles update”.</li>
<li>Put the <code>alterNERDtive-voiceattack-profiles.vax</code> file from Github into
VoiceAttacks “Import” folder.</li>
<li>Restart VoiceAttack.</li>
</ol>
<p>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.</p>
<p>You can find the full
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">Changelog</a>
on Github.</p>
<h2 id="3xx-to-4xx">3.x.x to 4.x.x<a class="headerlink" href="#3xx-to-4xx" title="Permanent link">&para;</a></h2>
<p>If you have been using a custom profile as outlined in <a href="../installing/#create-a-custom-profile">Installing#Create a
Custom Profile</a> your settings will be migrated to the new variables
automatically.</p>
<p>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.</p>
<p>Please do not fiddle with the configuration variables from your startup command
(or any other, really). It <em>should</em> not break anything, but it might. And it is
entirely unnecessary since configuration will be saved to and loaded from the
profile anyway.</p>
<h3 id="eddi-events">EDDI Events<a class="headerlink" href="#eddi-events" title="Permanent link">&para;</a></h3>
<p>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 <a href="../configuration/general#eddi-events">run the <code>eddi.event</code> context of the
<code>alterNERDtive-base</code> plugin</a>.</p>
<h3 id="binded">bindED<a class="headerlink" href="#binded" title="Permanent link">&para;</a></h3>
<p>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.</p>
<p>Please <a href="https://github.com/alterNERDtive/bindED/issues/new/choose">file an issue with
bindED</a> on Github if
your use case does not work anymore.</p>
<h3 id="elitedangerous">EliteDangerous<a class="headerlink" href="#elitedangerous" title="Permanent link">&para;</a></h3>
<p>The “EliteDangerous” profile is no longer the main profile. Instead you will
<em>have</em> 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.</p>
<p>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.</p>
<h3 id="ratattack">RatAttack<a class="headerlink" href="#ratattack" title="Permanent link">&para;</a></h3>
<h4 id="getting-case-data-from-irc">Getting Case Data From IRC<a class="headerlink" href="#getting-case-data-from-irc" title="Permanent link">&para;</a></h4>
<p>Handing a RATSIGNAL from IRC to VoiceAttack via text file is now deprecated and
the feature will be removed in a future version.</p>
<p>Instead you should use the new <code>RatAttack-cli.exe</code> 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.</p>
<p>For my AdiIRC, it looks like this (obviously change the path, please):</p>
<pre><code class="language-adiirc">on *:TEXT:*RATSIGNAL*(??_SIGNAL):#fuelrats:{
if ( $away ) {
/run -h &quot;X:\path\to\VoiceAttack\Apps\alterNERDtive\RatAttack-cli.exe&quot; &quot; $+ $replace($1-,&quot;,&quot;&quot;) $+ &quot; false
}
else {
/run -h &quot;X:\path\to\VoiceAttack\Apps\alterNERDtive\RatAttack-cli.exe&quot; &quot; $+ $replace($1-,&quot;,&quot;&quot;) $+ &quot; true
}
}
</code></pre>
<p>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.</p>
<p>The <code>$replace</code> part handles the fact that case announcements now put the system
in quotes. They have to be escaped as double quotes (<code>""</code>) to create a correct
command line invocation.</p>
<h4 id="nearest-cmdr-announcements">Nearest CMDR Announcements<a class="headerlink" href="#nearest-cmdr-announcements" title="Permanent link">&para;</a></h4>
<p>If you have RatAttack set up to announce your nearest commander to a case,
youll have to change the setting to the new format, separated by <code>;</code> instead of
whitespace.</p>
<p>Say “customize setting set fuel rat commanders” to update it.</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../installing/" class="btn btn-neutral float-left" title="Installing"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../configuration/general/" class="btn btn-neutral float-right" title="General Configuration">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../installing/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../configuration/general/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>