VoiceAttack-profiles/docs/installing.md
2021-01-30 12:52:47 +01:00

8.5 KiB
Raw Blame History

Installing

Install VoiceAttack

Grab the most recent VoiceAttack beta version off the official site and install it. Right now 32bit vs. 64bit does not make any difference, but there is no reason not to choose 64bit unless you are running a 32bit version of Windows (is that even still a thing?).

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

!VoiceAttack-download.png

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

You can potentially also install the latest non-beta version; but I often use features that have only just been added to the beta, so some things might break for you if you are not using that.

Make sure you have plugin support enabled:

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

While you are there, you might also want to enable the automatic update checks.

!VoiceAttack-settings-updates.png

Install EDDI

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

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

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

If you have installed the non-Steam version of VoiceAttack to the default folder within “ProgramFiles” you will have to run the CMD prompt as admin (Windows key

  • R, enter “cmd”, hit Control + Shift + Enter).

Install ED-NeutronRouter

Make sure to grab the pre-release 1.02 since 1.01 has a bug with a hardcoded 50ly jump range (the EDNeutronRouter.vX.YZ.zip under “Assets”).

You will have to extract the contents of the release .zip file to your VoiceAttack Apps folder:

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

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

!ED-NeutronRouter-folder.png

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

Import Profiles Package

Acquire the latest release from Github (the alterNERDtive-voiceattack-profiles.vax file under “Assets”).

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

Create a Custom Profile

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

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

Create a New Profile

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

Use the Profile Example

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

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

Include Profiles

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

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

Create a Startup Command

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

!VoiceAttack-edit.png

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

!VoiceAttack-edit-new-command.png

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

!VoiceAttack-edit-startup.png

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

!VoiceAttack-edit-startup-execute.png

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

!VoiceAttack-edit-startup-action.png

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

!VoiceAttack-edit-startup-actionlist.png

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

Set Profile Options

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

!VoiceAttack-profile-options.png

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

!VoiceAttack-profile-options-include.png

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

!VoiceAttack-profile-options-includelist.png

Technically you can leave out anything you are not planning on using. Practically it probably will not hurt you to just include everything, and it will then available for you in the future if you choose to check it out! 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 …

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

!VoiceAttack-profile-options-startup.png

Set Elite Keyboard Binds

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

!Elite-binds.png

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

!bindED-layout.png

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