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

docs: clarified that neutron router plugin is optional

Browse source 
fixes #153
This commit is contained in:
alterNERDtive 2022-09-15 15:13:20 +02:00
parent 022c3ac25c
commit 0d44828422
Signed by: alterNERDtive
GPG key ID: 547787A4FE6533F1
1 changed files with 67 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

133
docs/requirements.md
View file

@ -1,68 +1,69 @@
# Requirements # Requirements
## VoiceAttack ## VoiceAttack
Obviously you will need to install [VoiceAttack](https://voiceattack.com). There Obviously you will need to install [VoiceAttack](https://voiceattack.com). There
is a free trial version available, but that one is limited to a single profile 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 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 full version, available for $10 (official site) or €11.99 (Steam, IIRC $14.99
for our US-based friends). for our US-based friends).
I recommend buying on the site. Why? Because on Steam, Valve gets a 30% cut. 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 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 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 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 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! extra money. Please do keep that in mind in the future!
You also will generally need to opt into the beta version. I am usually at the 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 forefront of bug reports and feature requests, and I do rely on the
fixes/additions in beta versions quite often. fixes/additions in beta versions quite often.
## EDDI ## EDDI
[EDDI](https://github.com/EDCD/EDDI) is a companion application for Elite: [EDDI](https://github.com/EDCD/EDDI) is a companion application for Elite:
Dangerous, providing responses to events that occur in-game using data from the 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 game as well as various third-party tools. In this case, you will need to run it
as a VoiceAttack plugin. as a VoiceAttack plugin.
EDDI also regularly publishes beta versions. Unless a profiles release EDDI also regularly publishes beta versions. Unless a profiles release
explicitly states it you will _not_ have to run EDDI beta. explicitly states it you will _not_ have to run EDDI beta.
Do note that the profiles put EDDI into quiet mode by default, disabling the Do note that the profiles put EDDI into quiet mode by default, disabling the
built-in speech responders. This can be changed built-in speech responders. This can be changed
[via the `EDDI quiet mode` setting](configuration/general.md#general-settings-for-all-profiles). [via the `EDDI quiet mode` setting](configuration/general.md#general-settings-for-all-profiles).
## bindED ## bindED
[bindED](https://alterNERDtive.github.io/bindED) reads your Elite Dangerous [bindED](https://alterNERDtive.github.io/bindED) reads your Elite Dangerous
binding files and makes them available to VoiceAttack as variables. That way 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 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. change any actions that you happen to not have the standard binds for.
This plugin is _included_ in the release package. You do _not_ have to download This plugin is _included_ in the release package. You do _not_ have to download
and install it manually, but you _can_ independently update it if a newer and install it manually, but you _can_ independently update it if a newer
version is available. version is available.
## Elite Scripts ## Elite Scripts
I have written a [collection of Python I have written a [collection of Python
scripts](https://github.com/alterNERDtive/elite-scripts) to interface with scripts](https://github.com/alterNERDtive/elite-scripts) to interface with
various 3ʳᵈ party services like EDSM or Spansh. Those are called by the profiles various 3ʳᵈ party services like EDSM or Spansh. Those are called by the profiles
for various tasks, like checking a system’s body count. for various tasks, like checking a system’s body count.
In the future they will be replaced by VoiceAttack plugin code. In the future they will be replaced by VoiceAttack plugin code.
The scripts are _included_ in the release package. You do _not_ have to download The scripts are _included_ in the release package. You do _not_ have to download
and install them manually, but you _can_ independently update them if a newer and install them manually, but you _can_ independently update them if a newer
version is available. version is available.
## ED-NeutronRouter ## ED-NeutronRouter
(required for SpanshAttack) [ED-NeutronRouter](https://github.com/sc-pulgan/ED-NeutronRouter) interfaces
with [Spansh’s neutron plotter](https://spansh.uk/plotter) and makes the result
[ED-NeutronRouter](https://github.com/sc-pulgan/ED-NeutronRouter) interfaces
with [Spansh’s neutron plotter](https://spansh.uk/plotter) and makes the result
available to VoiceAttack. available to VoiceAttack.
This will also eventually be replaced by my own plugins. This plugin is _only_ required if you intend to use the SpanshAttack profile for
neutron routing. Otherwise you do not have to install it.
This will also eventually be replaced by my own plugins.