docs: proof reading, round 1

This commit is contained in:
alterNERDtive 2021-01-25 17:56:21 +01:00
parent a355af016d
commit 58b4860a58
17 changed files with 91 additions and 95 deletions

View file

@ -120,11 +120,16 @@ profile will keep the old name. Feel free to manually rename it.
### Added
* `SpanshAttack` plugin. Does miscellaneous things for now, will at some point
replace the dependency on the EDNeutronRouter plugin.
replace the dependency on the ED-NeutronRouter plugin.
* Will now log the jumps calculated for a trip to the VoiceAttack log.
### StreamAttack 2.0
### Added
* `distance [to;from] jump target` command: Tells you the current distance to
the jump target.
### Changed
* Jump target will now be set to SpanshAttacks plot target if the actual target

View file

@ -39,8 +39,8 @@ There are so many navigation-focused commands now, they deserve there 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!
* `distance [from;to] [Sol;home;the center;Beagle Point;Colonia]`: Gives you
your current distance to the given POI.
* `distance [from;to] [Sol;home;the center;Beagle Point;Colonia]`: Gives you the
current distance to the given POI.
* `[find;target] nearest [encoded;manufactured;raw] material trader`: Targets
the nearest respective material trader.
* `[find;target] nearest [fuel;scoopable] star`: Targets the nearest scoopable

View file

@ -32,10 +32,10 @@ you can run on this list, giving it a case number:
current system to a cases system.
* `nearest commander to rat case number [0..30]`: Will give you the nearest of
your CMDRs with their distance to a cases system. [Requires some
setup](/configuration/RatAttack/#announcing-your-nearest-cmdr).
setup](../configuration/RatAttack/#announcing-your-nearest-cmdr).
* `nearest commander to [the;] rat case`: Will give you the nearest of your
CMDRs with their distance to the current cases system. [Requires some
setup](/configuration/RatAttack/#announcing-your-nearest-cmdr).
setup](../configuration/RatAttack/#announcing-your-nearest-cmdr).
### Opening a Case
@ -45,7 +45,7 @@ you can run on this list, giving it a case number:
* `open [latest;] rat case`: Opens the latest rat case that has come in through
IRC. Will only work if you actually have [your IRC client setup to send case
announcements to
VoiceAttack](/configuration/RatAttack/#getting-case-data-from-irc).
VoiceAttack](../configuration/RatAttack/#getting-case-data-from-irc).
### Making Calls ###
@ -96,4 +96,4 @@ client or in SC in some remote system out in the black on a long range rescue).
\#ratchat.
Make sure [that your IRC client is setup
properly](/configuration/RatAttack/#sending-text-to-fuelrats-irc).
properly](../configuration/RatAttack/#sending-text-to-fuelrats-irc).

View file

@ -9,8 +9,10 @@ Default folder is `%appdata%\StreamAttack\`.
## Commands
* `clear jump target`: clears the current jump target.
* `set jump target`: sets the jump target to the currently targeted system.
* `clear jump target`: Clears the current jump target.
* `distance [to;from] jump target`: Tells you the current distance to the jump
target.
* `set jump target`: Sets the jump target to the currently targeted system.
Distance will be written to the configured file.
* `[copy;open] ship build`: copies the current ship build (coriolis) or opens it
@ -23,24 +25,24 @@ Default folder is `%appdata%\StreamAttack\`.
#### Commander
* `Elite\cmdr\name`: the current commanders name.
* `Elite\cmdr\name`: The current commanders name.
#### Jump Target
* `Elite\jumpTarget\distance`: distance to current jump target in light years.
* `Elite\jumpTarget\full`: pretty-printed `<distance> ly to <name>`.
* `Elite\jumpTarget\name`: the current jump targets system name.
* `Elite\jumpTarget\distance`: Distance to current jump target in light years.
* `Elite\jumpTarget\full`: Pretty-printed `<distance> ly to <name>`.
* `Elite\jumpTarget\name`: The current jump targets system name.
#### Location
* `Elite\location\full`: depending on your status, either the station you are
* `Elite\location\full`: 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.
* `Elite\location\system`: the system you are currently in.
* `Elite\location\system`: The system you are currently in.
#### Ship
* `Elite\ship\build`: your current ships loadout (link to coriolis).
* `Elite\ship\build`: Your current ships loadout (link to coriolis).
* `Elite\ship\full`: `“<name>” | <model> | <build>`.
* `Elite\ship\model`: your current ships model.
* `Elite\ship\name`: your current ships name.
* `Elite\ship\model`: Your current ships model.
* `Elite\ship\name`: Your current ships name.

View file

@ -4,9 +4,9 @@
Toggles:
* `auto honk all systems`: Automatically honk upon entering a system, each jump
* `auto honk all systems`: Automatically honk upon entering a system, each jump,
without constraints. Default: false.
* `auto honk new systems`: Automatically honk upon entering as system if it is
* `auto honk new systems`: Automatically honk upon entering a system if it is
your first visit. Default: true.
* `auto restock`: Automatically restock after docking at a station. You will
always refuel, repair and enter the Station Services menu. Default: true.
@ -18,7 +18,7 @@ Toggles:
that, its great. Default: false.
* `hyper space dethrottle`: Throttle down after a jump and when dropping from
SC. Like the SC Assist module does. Default: true.
* `mapping candidates`: Announce bodies worth mapping when youve finished
* `mapping candidates`: 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.
* `outdated stations`: Announce stations with outdated data in the online
@ -29,6 +29,6 @@ Toggles:
Other settings:
* `outdated station threshold`: The threshold for station data to count as
“outdated”, an days. Default: 365.
“outdated”, in days. Default: 365.
* `scanner fire group`: The fire group your discovery scanner is assigned to.
Default: 0 (the first one).

View file

@ -2,16 +2,17 @@
## Getting Case Data From IRC
You can setup your IRC client to pass incoming RATSIGNALS to VoiceAttack by calling the
`RatAttack-cli.exe` helper tool with the RATSIGNAL as first argument and an
optional boolean that triggers a TTS case announcement. You can find it under
your VoiceAttack “Apps” folder, `\alterNERDtive\RatAttack-cli.exe`.
You can setup your IRC client to pass incoming RATSIGNALS to VoiceAttack by
calling the `RatAttack-cli.exe` 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,
`\alterNERDtive\RatAttack-cli.exe`.
This has two purposes:
1. Announcing a new incoming case (if passing `true` as second argument).
1. Storing case data and making it available to VoiceAttack, e.g. for copying
the cases system into the clipboard.
the clients system into the clipboard.
For my AdiIRC, it looks like this (obviously change the path, please):
@ -40,7 +41,7 @@ Note: If you are not on duty (see below) you will _not_ get case announcements.
## Announcing Your Nearest CMDR
In case you have more than one CMDR registered as a Fuel Rat, you can have
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:
@ -77,8 +78,7 @@ Toggles:
“fuel+” via voice command or ingame chat. Default: false.
* `fuel rat call confirmation`: Only make calls in #fuelrats after vocal
confirmation to prevent mistakes. Default: true.
* `fuel rat duty`: Set FuelRats duty to active when the profile is loaded.
Default: true.
* `fuel rat duty`: On duty, receiving case announcements via TTS. Default: true.
* `nearest commander to fuel rat case`: Announce the nearest commander to
incoming rat cases. Default: false.
* `platform for fuel rat case`: Announce the platform for incoming rat cases.

View file

@ -3,14 +3,11 @@
## Supplying Your Ships Range
The ED-NeutronRouter plugin is technically supposed to read the current jump
range from EDDI; sadly a) its
[bugged](https://github.com/sc-pulgan/ED-NeutronRouter/issues/3) right now, and
b) EDDI is storing the _maximum_ 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 _current_ fuel
levels for range calculations, disregrading the range loss if you fill your tank.
range from EDDI; sadly EDDI is storing the _maximum_ 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 _current_ fuel levels for range calculations, disregrading
the range loss if you fill your tank.
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

View file

@ -3,13 +3,13 @@
## Settings
All profiles will load sane defaults if you havent changed anything. The
configuration is stored in a bunch of VoiceAttack variables stored in your
custom profile. You could even have different custom profiles with their own
distinct settings.
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.
You change the configuration via voice commands:
* For booleans (toggles): `customize setting [enable;disable] <trigger phrase>`
* For toggles (booleans): `customize setting [enable;disable] <trigger phrase>`
* For everything else: `customize setting set <trigger phrase>`
You can find a list of trigger phrases here, or you can say
@ -19,22 +19,21 @@ what they do. If you dont remember your settings or just want a nice list,
VoiceAttack log. If you want to reset everything back to default state, say
`customize setting clear all my settings`.
The “customize setting” preset is kind of a leftover from times long gone and
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.
Basically all the settings are available using the `customize settings` prefix,
then saying `[enable;disable] <setting>` for on/off switches and `set <setting>`
for text variables.
One caveat applies: settings will only be saved in the profile you have
selected, but be preserved if you switch around.
Since the settings are saved to your custom profile they will not be preserved
when you switch profiles. Once you switch back, the correct settings for the
profile are re-loaded.
### General Settings for All Profiles
Toggles:
* `auto update check`: Automatically check Github for profiles updates.
* `auto update check`: Automatically check Github for profiles updates when the
profile loads. Default: true.
* `eddi quiet mode`: Make EDDI shut up. Disables all built-in speech responders.
Default: true.
Other settings:
@ -42,17 +41,16 @@ Other settings:
physical key in your layout that would be 'V' on QWERTY. Default: 'v'.
* `log level`: The level of detail for logging to the VoiceAttack log. Valid
levels are "ERROR", "WARN", "NOTICE", "INFO" and "DEBUG". Default: "NOTICE".
Default: "NOTICE".
* `quit to desktop delay`: The delay before restarting the game after hitting
“Exit to Desktop”. Default: 10.0seconds. (Used by the `restart from desktop`
“Exit to Desktop”, in seconds. Default: 10.0. (Used by the `restart from desktop`
command)
## Note on Non-Standard Keyboard Layouts
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 “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.
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 “standard”QWERT[YZ]
layout. You will have to change it to the key that is physically in the place
where `V` would be on QWERTY, e.g. `P` for [Neo2](https://neo-layout.org).
To set the key, say “customize setting set elite paste key”.

View file

@ -3,7 +3,7 @@
## Configuration
The base profile provides voice commands for changing the profiles’ settings.
See [the configuration section](/configuration/general#settings).
See [the configuration section](../configuration/general#settings).
## Chat

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

View file

@ -1,10 +1,5 @@
# Elite Dangerous VoiceAttack Profiles
**This documentation is a _work in progress_ for the upcoming 4.0 release.
Please refer to [the Github
repository](https://github.com/alterNERDtive/VoiceAttack-profiles) and the
documentation there for version 3.x.**
These are various profiles for [VoiceAttack](https://voiceattack.com) (VA) I use
to enhance my Elite experience. They give me important info, facilitate
day-to-day gaming and do some special things for [Fuel

View file

@ -40,7 +40,7 @@ VoiceAttack
plugin](https://github.com/EDCD/EDDI/wiki/VoiceAttack-Integration#using-eddi-with-voiceattack).
If you do not want to install it into the VoiceAttack installation folder (or
already have it installed somewhere else) you can also just make a symbolic
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
```cmd
@ -94,12 +94,10 @@ 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.
profile example as a basis. Regardless of which way you choose, make sure to
read the [[#Import Profiles]] section and follow the instructions there!
Regardless of which way you choose, make sure to read the [[#Import Profiles]]
section and follow the instructions there!
### Create a New Custom Profile
### Create a New Profile
1. Click the “Profile Actions” button, then “Create New Profile”.
![[VoiceAttack-new-profile.png]]
@ -118,7 +116,7 @@ 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”!
### Import Profiles
### Include Profiles
In order to use my profiles with your custom profiles, you will need to take two
additional steps:
@ -150,7 +148,7 @@ Add a new action using “Other” → “VoiceAttack Action”→ “Execute An
![[VoiceAttack-edit-startup-execute.png]]
Choose “Execute by name (Advanced)” and enter “alterNERDtive-base.startup”.
Choose “Execute by name (Advanced)” and enter “((alterNERDtive-base.startup))”.
![[VoiceAttack-edit-startup-action.png]]
@ -163,7 +161,7 @@ actions are processed.
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](general.md).
more elegantly! More on this [later on](general.md#settings).
#### Set Profile Options
@ -171,20 +169,20 @@ While editing the profile, hit the “Options” button.
![[VoiceAttack-profile-options.png]]
On the section labeled“Include commands from other profiles”, hit the “…”
On the section labeled “Include commands from other profiles”, hit the “…”
button.
![[VoiceAttack-profile-options-include.png]]
Add all my profiles (“EliteDangerous”, “RatAttack”, “SpanshAttack”,
“StreamAttack”).
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 nott hurt you to just include everything, and it
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
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

View file

@ -23,10 +23,11 @@ fixes/additions in beta versions quite often.
[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
game as well as various third-party tools.
game as well as various third-party tools. In this case, you will need to run it
as a VoiceAttack plugin.
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.
## bindED
@ -39,7 +40,7 @@ This plugin is _included_ in the release package.
## Elite Scripts
I have wrote a [collection of Python
I have written a [collection of Python
scripts](https://github.com/alterNERDtive/elite-scripts) 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.

View file

@ -1,6 +1,6 @@
# Upgrading
To upgrade to the latest version, follow these steps:
To upgrade to the latest version, follow these simple steps:
1. Say “download profiles update”.
1. Put the `alterNERDtive-voiceattack-profiles.vax` file from Github into the
@ -16,9 +16,9 @@ If you have been using a custom profile as outlined in [[Installing#Create a
Custom Profile]] your settings will be migrated to the new variables
automatically.
If you have not … well, you will unfortunately have to take note of your
settings, and recreate them after creating a custom profile and including
everything.
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.
Please do not fiddle with the configuration variables from your startup command
(or any other, really). It _should_ not break anything, but it might. And it is
@ -42,21 +42,21 @@ _have_ to create a custom profile, and the new “base” profile that the other
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.
It has also been renamed to “EliteAttack” to be consistent with the others. 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
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.
### RatAttack
Handing a RATSIGNAL from IRC to VoiceAttack via text file is now deprecated and
support for that will be removed in a future version.
the feature will be removed in a future version.
Instead you should use the new `RatAttack-cli.exe` 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 walling VoiceAttack to run a command, it will have to call
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.
@ -79,4 +79,4 @@ will announce it using TTS.
The “replace” part handles the fact that announcements now put the system in
quotes. They have to be escaped as double quotes (`""`) to create a correct
command invocation.
command line invocation.

View file

@ -22,11 +22,11 @@ namespace alterNERDtive.util
new OptDict<string, Option>{
{ new Option<decimal>("delays.keyPressDuration", (decimal)0.01, voiceTrigger: "key press duration", description: "The time keys will be held down for.") },
{ new Option<decimal>("delays.quitToDesktop", (decimal)10.0, voiceTrigger: "quit to desktop delay",
description: "The delay before restarting the game after hitting “Exit to Desktop”.\nDefault: 10.0seconds. (Used by the `restart from desktop` command)") },
description: "The delay before restarting the game after hitting “Exit to Desktop”, in seconds.\nDefault: 10.0. (Used by the `restart from desktop` command)") },
{ new Option<bool>("eddi.quietMode", true, voiceTrigger: "eddi quiet mode", description: "Make EDDI shut up. Disables all built-in speech responders.") },
{ new Option<string>("elite.pasteKey", "v", voiceTrigger: "elite paste key",
description: "The key used to paste in conjunction with CTRL. The physical key in your layout that would be 'V' on QWERTY.") },
{ new Option<bool>("enableAutoUpdateCheck", true, voiceTrigger: "auto update check", description: "Automatically check Github for profiles updates.") },
{ new Option<bool>("enableAutoUpdateCheck", true, voiceTrigger: "auto update check", description: "Automatically check Github for profiles updates when the profile loads.") },
{ new Option<string>("log.logLevel", "NOTICE", voiceTrigger: "log level", validValues: new List<string>{ "ERROR", "WARN", "NOTICE", "INFO", "DEBUG" },
description: @"The level of detail for logging to the VoiceAttack log.\nValid levels are ""ERROR"", ""WARN"", ""NOTICE"", ""INFO"" and ""DEBUG"".\nDefault: ""NOTICE"".") },
}
@ -37,12 +37,12 @@ namespace alterNERDtive.util
{ new Option<bool>("announceEdsmSystemStatus", true, voiceTrigger: "edsm system status",
description: "Pull system data from EDSM and compare it against your discovery scan.") },
{ new Option<bool>("announceMappingCandidates", true, voiceTrigger: "mapping candidates",
description: "Announce bodies worth mapping when youve finished scanning a system.\n(Terraformables, Water Worlds, Earth-Like Worlds and Ammonia Worlds that have not been mapped yet.)") },
description: "Announce bodies worth mapping when you have finished scanning a system.\n(Terraformables, Water Worlds, Earth-Like Worlds and Ammonia Worlds that have not been mapped yet.)") },
{ new Option<bool>("announceOutdatedStationData", true, voiceTrigger: "outdated stations", description: "Announce stations with outdated data in the online databases.") },
{ new Option<bool>("announceR2RMappingCandidates", false, voiceTrigger: "road to riches",
description: "Announce bodies worth scanning if you are looking for some starting cash on the Road to Riches.") },
{ new Option<bool>("autoHonkAllSystems", false, voiceTrigger: "auto honk all systems", description: "Automatically honk upon entering a system, each jump without constraints.") },
{ new Option<bool>("autoHonkNewSystems", true, voiceTrigger: "auto honk new systems", description: "Automatically honk upon entering as system if it is your first visit.") },
{ new Option<bool>("autoHonkAllSystems", false, voiceTrigger: "auto honk all systems", description: "Automatically honk upon entering a system, each jump, without constraints.") },
{ new Option<bool>("autoHonkNewSystems", true, voiceTrigger: "auto honk new systems", description: "Automatically honk upon entering a system if it is your first visit.") },
{ new Option<bool>("autoRestock", true, voiceTrigger: "auto restock", description:
"Automatically restock after docking at a station.\nYou will always refuel, repair and enter the Station Services menu.") },
{ new Option<bool>("flightAssistOff", false, voiceTrigger: "flight assist off", description: "Permanent Flight Assist off mode. You should really do that, its great.") },
@ -63,7 +63,7 @@ namespace alterNERDtive.util
{ new Option<string>("CMDRs", "", voiceTrigger: "fuel rat commanders",
description: "All your CMDRs that are ready to take rat cases.\nUse ; as separator, e.g. “Bud Spencer;Terrence Hill”.") },
{ new Option<bool>("confirmCalls", true, voiceTrigger: "fuel rat call confirmation", description: "Only make calls in #fuelrats after vocal confirmation to prevent mistakes.") },
{ new Option<bool>("onDuty", true, voiceTrigger: "fuel rat duty", description: "Set FuelRats duty to active when the profile is loaded.") },
{ new Option<bool>("onDuty", true, voiceTrigger: "fuel rat duty", description: "On duty, receiving case announcements via TTS.") },
{ new Option<string>("platforms", "PC", voiceTrigger: "fuel rat platforms", validValues: new List<string>{ "PC", "Xbox", "Playstation" },
description: "The platform(s) you want to get case announcements for (PC, Xbox, Playstation).\nUse ; as separator, e.g. “PC;Xbox”.") },
}