VoiceAttack-profiles/installing/index.html
2022-09-19 16:31:43 +00:00

389 lines
23 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>