EliteDangerous/VoiceAttack-profiles
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases 33 Wiki Activity Actions

updated everything to settings via voice commands!

Browse source 
fixes #12, #26
This commit is contained in:
alterNERDtive 2020-07-06 21:24:31 +02:00
parent d237ec9e21
commit 807bbed51c
12 changed files with 113 additions and 98 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
CHANGELOG.md
View file

@ -1,3 +1,48 @@
# devel
This is a HUGE one! :D
You now no longer have to fiddle with configuration options in the various
`startup` commands. Instead you can set everything with voice commands! See the
`docs/` and the new `_configuration` command sections of the individual profiles
for details.
This also means that importing the profiles and updating them has become easier
on you, the user.
## EliteDangerous 6.0
### Added
* Configuration via voice commands!
## RatAttack 4.0
### Added
* Configuration via voice commands!
## SealAttack 0.2
### Added
* Configuration via voice commands! As this profile is … a work in progress, not
everything is implemented yet.
## SpanshAttack 5.0
### Added
* Configuration via voice commands!
## StreamAttack 0.3
### Added
* Configuration via voice commands! Not a lot to configure here though.
-----
# 1.5.1 (2020-07-05)
This is just a minor bug fix release.
@ -8,6 +53,8 @@ This is just a minor bug fix release.
* `EDDI Carrier cooldown` will no longer call your carrier “Not set”.
-----
# 1.5 (2020-07-05)
Changed Changelog format. Should be even clearer now at a glance!
@ -88,6 +135,8 @@ See [KeepAChangelog](https://keepachangelog.com/en/1.0.0/).
* Now setting EDDI to quiet mode even if the profile was loaded before plugin
initialization had been completed.
-----
# v1.4 (2020-06-19)
This is basically just a bug fix release, but I happened to have one new feature

17
README.md
View file

@ -86,9 +86,15 @@ work!**
## Settings ##
Each profile has its respective `startup` command that should be launched upon
loading the profile. If you include the profile in your own (see below) you have
to manually call them for each included profile when yours is loaded.
All profiles will now load sane defaults if you haven’t changed anything. You no
longer need to fiddle with the `startup` commands of each profile, instead you
can use voice commands to change settings! See the `docs/` and the
`_configuration` commands section of each profile.
One caveat applies: settings are stored in the _profile where you run the
configuration commands_. If you change your active, main profile around a lot
you’ll have to set everything up for each of them separately. I suggest instead
having a single “main” profiles and including everything else.
## Using a Profile ##
@ -105,9 +111,8 @@ form other profiles:” option.
VoiceAttack does not execute configured startup commands for included profiles.
Hence, you’ll have to have your own profile have one that in turn runs the
included profiles’ startup commands. While you are doing that, you might as well
set all settings here, centrally. Main advantage is that you can just upgrade
the included profiles to newer versions without losing your settings.
included profiles’ startup commands. Main advantage is that you can just upgrade
the included profiles to newer versions without losing your own stuff.
Because of limitations of VoiceAttack itself, only the first matching command
found will be executed, _including EDDI events_. That means you have to check

25
docs/EliteDangerous.md
View file

@ -32,9 +32,9 @@ the release page, they will be installed automatically.
## Settings ##
Because Elite’s keyboard handling is … weird you’ll have to set the key to use
for pasting text into Elite:Dangerous. If you are using a “standard” QWERT[YZ]
layout, you will have to change it back to `v`. It’s defaulting to `p` because
that’s the key that is in `v`’s place on my keyboard layout, Neo2.
for pasting text into Elite:Dangerous. If you are not using a “standard”
QWERT[YZ] layout, you will have to change it back to the key that is physically
in the place where `v` would be on QWERTY.
For other settings, see the [Configuration Variables](#Configuration-Variables)
section.
@ -48,12 +48,9 @@ Nevertheless, it _should_ work properly if you follow some guide lines:
* Run the startup command. You will need to have a startup command in your
profile (= one that is run on profile loading) and call
`EliteDangerous.startup` by name from that one.
* Set configuration options. In the same startup command of yours, overwrite all
configuration variables you want changed; _after_ the `EliteDangerous.startup`
call. See [below](#Configuration-Variables).
* Make sure all EDDI events that EliteDangerous needs are correctly handled. For
all events used in EliteDangerous that you already have handlers for in your
profile, you’ll have to include a call to `EliteDangerous.<event name>`. E.g.
profile, you’ll have to include a call to `EliteDangerous.<event name>`. E.g.
for “EDDI Jumped”, call `EliteDangerous.EDDI Jumped` by name from your `((EDDI
Jumped))` command.
@ -412,8 +409,8 @@ manipulating some UI element(s).
### Configuration Variables ###
These are set in `EliteDangerous.startup` and can be overridden from your profile
if you have included EliteDangerous.
There are a bunch of configuration variables. You should not overwrite those
manually, instead use the provided commands in the `_configuration` section!
* `EDDI.quietMode` (boolean): whether or not to set EDDI to quite mode. Default:
true.
@ -421,16 +418,16 @@ if you have included EliteDangerous.
is `v`. Default: `p`.
* `EliteDangerous.announceMappingCandidates` (boolean): whether to announce mapping candidates
when they are scanned. Default: true.
* `EliteDangerous.announcemeR2RMappingCandidates` (boolean): whether to announce
planets worth mapping when jumping into a known system. This is useful for
doing some R2R on the side. Default: false.
* `EliteDangerous.autoChangeFuelratsNick` (boolean): whether to change the FuelRats IRC
nickname automatically when changing commanders. Probably largely irrelevant
to you. Default: false.
* `EliteDangerous.enableCarrierAnnouncements` (boolean): whether or not to
process fleet carrier events. Default: true.
* `EliteDangerous.enableR2Rannouncements` (boolean): whether to announce planets worth mapping
when jumping into a known system. This is useful for doing some R2R on the
side. Default: false.
* `EliteDangerous.flightAssistOff` (boolean): whether to automatically toggle FlightAssist off
on liftoff. Default: true.
* `EliteDangerous.flightAssistOff` (boolean): whether to automatically toggle
FlightAssist off on liftoff. Default: true.
* `EliteDangerous.hyperspaceDethrottle` (boolean): same thing as the SC assist setting; if on,
will throttle to 0 automatically after jumping. Default: true.
* `EliteDangerous.jumpTargetFile` (string): the file the distance to the currently set jump

47
docs/RatAttack.md
View file

@ -28,13 +28,8 @@ RatAttack will deactivate the speech responder automatically to not clutter them
with unwanted TTS.
If you are already an EDDI user and want to keep the default speech responder
functionality, you will have to run the `enablespeechresponder` plugin function
of the EDDI plugin from your profile’s startup command _after_ the
`RatAttack.startup` command invocation.
In order to do that, choose “Other” → “Advanced” → “Execute an External Plugin
Function”, choose the EDDI plugin and set the “Plugin Context” to
“enablespeechresponder”.
functionality, you will have to disable the `EDDI.quietMode` setting by running
the `customize settings disable eddi quiet mode` command.
## Settings ##
@ -51,9 +46,6 @@ When including the profile, be sure to
* Run the startup command. You will need to have a startup command in your
profile (= one that is run on profile loading) and call `RatAttack.startup`
from that one.
* Set configuration options. In the same startup command of yours, overwrite all
configuration variables you want changed; _after_ the `RatAttack.startup`
call. See [below](#Configuration-Variables).
* Make sure all EDDI events that RatAttack needs are correctly handled. For all
events used in RatAttack that you already have handlers for in your profile,
you’ll have to include a call to `RatAttack.<event name>`. E.g. for “EDDI
@ -229,39 +221,38 @@ don’t unless it’s a config variable …) from other profiles.
### Configuration Variables ###
These are set in `RatAttack.startup` and can be overridden from your profile if
you have included RatAttack.
There are a bunch of configuration variables. You should not overwrite those
manually, instead use the provided commands in the `_configuration` section!
* `EDDI.quietMode` (boolean): whether or not to set EDDI to quite mode. Default:
true.
* `EDDI.useEddiForVoice` (boolean): whether to use the EDDI plugin to handle
text-to-speech over VoiceAttacks built-in speech function. Default: false.
* `Elite.pasteKey` (string): the key used for pasting into Elite. On QWERTY this
is `v`. Default: `v`.
* `RatAttack.announceNearestCMDR` (boolean): whether or not to automatically
announce your nearest CMDR to a case. Requires the `elite-scripts` Python
scripts. Will probably break in creative ways if you don’t have them and turn
it on anyway. Default: false.
* `RatAttack.announcePlatform` (boolean): whether or not to announce the case’s
platform by default. Useful to set if you are active on more than one
platform. Even with this off, you will still be warned when you open a case
that is _not_ on one of your platforms. Default: false.
* `RatAttack.CMDRs` (string): list of your CMDR names, delimited by spaces. If
your names include spaces, you will have to put them in quotes. Default: “"J
Jora Jameson" NameWithNoSpace”.
* `RatAttack.confirmCalls` (boolean): whether VoiceAttack should ask you before
posting to #fuelrats to make sure there hasn’t been an error in voice
recognition and you accidentally post the wrong thing. Default: true.
* `RatAttack.onDuty` (boolean): whether or not you are currently on rat duty.
Default: true.
* `RatAttack.autoCloseCase` (boolean): whether or not to automatically close an
open rat case on calling “fuel+”. Default: false.
* `RatAttack.onDuty` (boolean): whether or not you are currently on rat duty.
Default: true.
* `RatAttack.platforms` (string): the platforms you want to be informed of
incoming cases for. If you are on console, you can still have VoiceAttack
running on the PC that you are using for IRC and handle calls and stuff using
voice! Delimited by whatever you want. Can include “PC”, “XB”, “PS4”.
Default: “PC”.
* `RatAttack.platformAnnouncements` (boolean): whether or not to announce the
case’s platform by default. Useful to set if you are active on more than one
platform. Even with this off, you will still be warned when you open a case
that is _not_ on one of your platforms. Default: false.
* `RatAttack.useEddiForVoice` (boolean): whether to use the EDDI plugin to
handle text-to-speech over VoiceAttacks built-in speech function. Default:
false.
* `RatAttack.announceNearestCMDR` (boolean): whether or not to automatically
announce your nearest CMDR to a case. Requires the `elite-scripts` Python
scripts. Will probably break in creative ways if you don’t have them and turn
it on anyway. Default: false.
* `RatAttack.CMDRs` (string): list of your CMDR names, delimited by spaces. If
your names include spaces, you will have to put them in quotes. Default: “"J
Jora Jameson" NameWithNoSpace”.
* `python.scriptPath` (string): the path you put the Python scripts in. Default:
“{VA_DIR}\Sounds\scripts”.

21
docs/SealAttack.md
View file

@ -36,13 +36,8 @@ RatAttack will deactivate the speech responder automatically to not clutter them
with unwanted TTS.
If you are already an EDDI user and want to keep the default speech responder
functionality, you will have to run the `enablespeechresponder` plugin function
of the EDDI plugin from your profile’s startup command _after_ the
`RatAttack.startup` command invocation.
In order to do that, choose “Other” → “Advanced” → “Execute an External Plugin
Function”, choose the EDDI plugin and set the “Plugin Context” to
“enablespeechresponder”.
functionality, you will have to disable the `EDDI.quietMode` setting by running
the `customize settings disable eddi quiet mode` command.
## Settings ##
@ -59,9 +54,6 @@ When including the profile, be sure to
* Run the startup command. You will need to have a startup command in your
profile (= one that is run on profile loading) and call `RatAttack.startup`
from that one.
* Set configuration options. In the same startup command of yours, overwrite all
configuration variables you want changed; _after_ the `RatAttack.startup`
call. See [below](#Configuration-Variables).
* Make sure all EDDI events that RatAttack needs are correctly handled. For all
events used in RatAttack that you already have handlers for in your profile,
you’ll have to include a call to `RatAttack.<event name>`. E.g. for “EDDI
@ -221,11 +213,13 @@ don’t unless it’s a config variable …) from other profiles.
### Configuration Variables ###
These are set in `RatAttack.startup` and can be overridden from your profile if
you have included RatAttack.
There are a bunch of configuration variables. You should not overwrite those
manually, instead use the provided commands in the `_configuration` section!
* `EDDI.quietMode` (boolean): whether or not to set EDDI to quite mode. Default:
true.
* `EDDI.useEddiForVoice` (boolean): whether to use the EDDI plugin to handle
text-to-speech over VoiceAttacks built-in speech function. Default: false.
* `Elite.pasteKey` (string): the key used for pasting into Elite. On QWERTY this
is `v`. Default: `v`.
* `RatAttack.confirmCalls` (boolean): whether VoiceAttack should ask you before
@ -244,9 +238,6 @@ you have included RatAttack.
case’s platform by default. Useful to set if you are active on more than one
platform. Even with this off, you will still be warned when you open a case
that is _not_ on one of your platforms. Default: false.
* `RatAttack.useEddiForVoice` (boolean): whether to use the EDDI plugin to
handle text-to-speech over VoiceAttacks built-in speech function. Default:
false.
* `RatAttack.announceNearestCMDR` (boolean): whether or not to automatically
announce your nearest CMDR to a case. Requires the `elite-scripts` Python
scripts. Will probably break in creative ways if you don’t have them and turn

34
docs/SpanshAttack.md
View file

@ -22,21 +22,15 @@ SpanshAttack will deactivate the speech responder automatically to not clutter
them with unwanted TTS.
If you are already an EDDI user and want to keep the default speech responder
functionality, you will have to run the `enablespeechresponder` plugin function
of the EDDI plugin from your profile’s startup command _after_ the
`SpanshAttack.startup` command invocation.
In order to do that, choose “Other” → “Advanced” → “Execute an External Plugin
Function”, choose the EDDI plugin and set the “Plugin Context” to
“enablespeechresponder”.
functionality, you will have to disable the `EDDI.quietMode` setting by running
the `customize settings disable eddi quiet mode` command.
## Settings ##
Because Elite’s keyboard handling is … weird you’ll have to set the key to use
for pasting text into Elite:Dangerous. If you are using a “standard” QWERT[YZ]
layout, you don’t have to do anything; if you are using something different, you
have to set it to the symbol that’s on the physical button that has `v` on
QWERT[YZ]. E.g. for Neo2, set it to `p`.
for pasting text into Elite:Dangerous. If you are not using a “standard”
QWERT[YZ] layout, you will have to change it back to the key that is physically
in the place where `v` would be on QWERTY.
For other settings, see the [Configuration Variables](#Configuration-Variables)
section.
@ -62,17 +56,11 @@ When including the profile, be sure to
* Run the startup command. You will need to have a startup command in your
profile (= one that is run on profile loading) and call `SpanshAttack.startup`
from that one.
* Set configuration options. In the same startup command of yours, overwrite all
configuration variables you want changed; _after_ the `SpanshAttack.startup`
call. See [below](#Configuration-Variables).
* Make sure all EDDI events that SpanshAttack needs are correctly handled. For
all events used in SpanshAttack that you already have handlers for in your
profile, you’ll have to include a call to `SpanshAttack.<event name>`. E.g.
profile, you’ll have to include a call to `SpanshAttack.<event name>`. E.g.
for “EDDI Jumped”, call `SpanshAttack.EDDI Jumped` by name from your `((EDDI
Jumped))` command.
* Initialise the [bindED](https://forum.voiceattack.com/SMF?topic=564.0) plugin
correctly to read your Elite keybinds. Do that in your main profile’s startup
command to only have it run once.
* (Optional) Have a `SpanshAttack.getShipRange` command in your profile to
overwrite the default one with your ship’s ranges. See the default command for
pointers.
@ -188,11 +176,13 @@ don’t unless it’s a config variable …) from other profiles:
### Configuration Variables ###
These are set in `SpanshAttack.startup` and can be overridden from your profile
if you have included SpanshAttack.
There are a bunch of configuration variables. You should not overwrite those
manually, instead use the provided commands in the `_configuration` section!
* `EDDI.quietMode` (boolean): whether or not to set EDDI to quite mode. Default:
true.
* `EDDI.useEddiForVoice` (boolean): whether to use EDDI over VA’s builtin `say`
command. Default: false.
* `Elite.pasteKey` (string): the key used for pasting into Elite. On QWERTY this
is `v`. Default: `v`.
* `SpanshAttack.timeTrip` (boolean): whether to automatically tell you at the
@ -216,9 +206,7 @@ if you have included SpanshAttack.
false.
* `SpanshAttack.copyWaypointToClipboard` (boolean): whether to copy the next
waypoint into the Windows clipboard for use in other programs. Default: false.
* `SpanshAttack.useEddiForVoice` (boolean): whether to use EDDI over VA’s
builtin `say` command. Default: false.
* `python.scriptPath` (string): the path you put the Python scripts in.
* `python.scriptPath` (string): the path you put the Python scripts in.
Default: “{VA_DIR}\Sounds\scripts”.
### Other Variables ###

18
docs/StreamAttack.md
View file

@ -21,13 +21,8 @@ StreamAttack will deactivate the speech responder automatically to not clutter
them with unwanted TTS.
If you are already an EDDI user and want to keep the default speech responder
functionality, you will have to run the `enablespeechresponder` plugin function
of the EDDI plugin from your profile’s startup command _after_ the
`StreamAttack.startup` command invocation.
In order to do that, choose “Other” → “Advanced” → “Execute an External Plugin
Function”, choose the EDDI plugin and set the “Plugin Context” to
“enablespeechresponder”.
functionality, you will have to disable the `EDDI.quietMode` setting by running
the `customize settings disable eddi quiet mode` command.
## Settings ##
@ -40,9 +35,6 @@ When including the profile, be sure to
* Run the startup command. You will need to have a startup command in your
profile (= one that is run on profile loading) and call `StreamAttack.startup`
from that one.
* Set configuration options. In the same startup command of yours, overwrite all
configuration variables you want changed; _after_ the `StreamAttack.startup`
call. See [below](#Configuration-Variables).
* Make sure all EDDI events that StreamAttack needs are correctly handled. For
all events used in StreamAttack that you already have handlers for in your
profile, you’ll have to include a call to `StreamAttack.<event name>`. E.g.
@ -94,11 +86,13 @@ don’t unless it’s a config variable …) from other profiles:
### Configuration Variables ###
These are set in `StreamAttack.startup` and can be overridden from your profile
if you have included StreamAttack.
There are a bunch of configuration variables. You should not overwrite those
manually, instead use the provided commands in the `_configuration` section!
* `EDDI.quietMode` (boolean): whether or not to set EDDI to quite mode. Default:
true.
* `EDDI.useEddiForVoice` (boolean): whether to use EDDI over VA’s builtin `say`
command. Default: false.
* `StreamAttack.outputDir` (string): the directory StreamAttack will save its
information to. Default: `%appdata%\StreamAttack\`.
* `python.ScriptPath` (string): the path you have placed the compiled Python

BIN
profiles/EliteDangerous-Profile.vap
View file

Binary file not shown.

BIN
profiles/RatAttack-Profile.vap
View file

Binary file not shown.

BIN
profiles/SealAttack-Profile.vap
View file

Binary file not shown.

BIN
profiles/SpanshAttack-Profile.vap
View file

Binary file not shown.

BIN
profiles/StreamAttack-Profile.vap
View file

Binary file not shown.