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

docs markdown fixes & author privacy on screenshot

Browse source
This commit is contained in:
Ant 2022-07-11 12:09:34 +01:00 committed by alterNERDtive
parent 9cc9965d7c
commit 3cbfe62ae1
No known key found for this signature in database
GPG key ID: 9656B56456F5FCD7
10 changed files with 30 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/EliteAttack.md
View file

@ -35,7 +35,7 @@ the edit window ready to send. They will _not_ hit Enter on their own.
## Navigation ## Navigation
There are so many navigation-focused commands now, they deserve there own There are so many navigation-focused commands now, they deserve their own
category. Basically anything that helps you plot anywhere. A lot of those are category. Basically anything that helps you plot anywhere. A lot of those are
powered by awesome EDDI so I don’t have to do the work myself! powered by awesome EDDI so I don’t have to do the work myself!
@ -72,10 +72,9 @@ Basically anything that is related to directly doing something with your ship.
* `[close;deploy;extend;open;retract;] [cargo scoop;hard points; landing gear] [up;down;]`: * `[close;deploy;extend;open;retract;] [cargo scoop;hard points; landing gear] [up;down;]`:
Overly complicated command to handle everything related to Cargo Scoop, Hard Overly complicated command to handle everything related to Cargo Scoop, Hard
Points, Landing Gear. You get the gist, I guess. Works in SRV too. Points, Landing Gear. You get the gist, I guess. Works in SRV too.
* `[dis;]engage silent running`: Handles silent running.
* `[disco;discovery scan]`: Executes a discovery scan. Expects the Discovery * `[disco;discovery scan]`: Executes a discovery scan. Expects the Discovery
Scanner in your first fire group, secondary fire. [You can change Scanner in your first fire group, secondary fire. [You can change
that](/configuration/EliteAttack/#settings). that](../configuration/EliteAttack/#settings).
* `[dis;]engage silent running`: Turns silent running on and off. * `[dis;]engage silent running`: Turns silent running on and off.
* `[head;spot;] lights [on;off]`: Turns your lights on and off. Works in SRV * `[head;spot;] lights [on;off]`: Turns your lights on and off. Works in SRV
too, kinda; turning lights off there relies on the state updating fast enough, too, kinda; turning lights off there relies on the state updating fast enough,
@ -96,7 +95,7 @@ Basically anything that is related to directly doing something with your ship.
given “when ready” will wait for mass lock to clear and your FSD to cool down given “when ready” will wait for mass lock to clear and your FSD to cool down
first. first.
## SRV controls ## SRV Controls
Things relevant to your SRV, but not your ship. Things relevant to your SRV, but not your ship.
@ -107,13 +106,12 @@ Things relevant to your SRV, but not your ship.
## Targeting ## Targeting
Well … targeting stuff, I guess. Not really sure why I made that it’s own Well … targeting stuff, I guess. Not really sure why I made that its own
category, but oh well :) category, but oh well :)
* `target the [drive;drives;power plant;frame shift drive;f s d;shield * `target the [drive;drives;power plant;frame shift drive;f s d;shield
generator]`:* generator]`: Targets the given submodule on your current target, or your next
Targets the given submodule on your current target, or your next target if you target if you don’t have one currently. Does not persist between targets.
don’t have one currently. Does not persist between targets.
* `clear sub [module;system] target`: Clears the current submodule target. * `clear sub [module;system] target`: Clears the current submodule target.
* `target next system`: Selects the next system on your route. * `target next system`: Selects the next system on your route.
* `target wing man [1;2;3]`: Targets your wingmen. * `target wing man [1;2;3]`: Targets your wingmen.
@ -272,7 +270,7 @@ the (rough) range you still have on the fumes left in your tank.
### Material Threshold ### Material Threshold
Warns you when a monitored material falls below it’s minimum stock level and Warns you when a monitored material falls below its minimum stock level and
tells you when you reach your desired level or fill up. tells you when you reach your desired level or fill up.
You will have to set minimum and desired amounts in EDDI’s material monitor You will have to set minimum and desired amounts in EDDI’s material monitor
@ -308,7 +306,7 @@ Reports on the synthesis type and quality.
### System Scan Complete ### System Scan Complete
Lists you all bodies EDDI considers worth mapping in the current system. Lists all bodies EDDI considers worth mapping in the current system.
### Undocked ### Undocked

2
docs/RatAttack.md
View file

@ -66,7 +66,7 @@ client or use the “General IRC Integration”, see below.
login to the game or have to take off from your current login to the game or have to take off from your current
station/port/outpost/planet. station/port/outpost/planet.
* `call jumps [left;]`: Calls jumps for the currently open case based on a * `call jumps [left;]`: Calls jumps for the currently open case based on a
neutron trip (requires Spanshattack) or a plotted ingame route. neutron trip (requires SpanshAttack) or a plotted ingame route.
* `call friend [positive;negative] [in pg;in private group;in solo;in main menu;sysconf;system confirmed;]`: * `call friend [positive;negative] [in pg;in private group;in solo;in main menu;sysconf;system confirmed;]`:
Friend request confirmations, with all the Friend request confirmations, with all the
things you might want to / should call with it. things you might want to / should call with it.

8
docs/SpanshAttack.md
View file

@ -1,10 +1,8 @@
# SpanshAttack # SpanshAttack
This profile uses the This profile uses the [ED-NeutronRouter](https://github.com/sc-pulgan/ED-NeutronRouter) plugin to plot
[ED-NeutronRouter](https://github.com/sc-pulgan/ED-NeutronRouter) plugin to plot neutron jumps using [Spansh](https://spansh.co.uk/plotter). It does everything you need fully from within
neutron jumps using [spansh](https://spansh.co.uk/plotter). It fully does the game and VoiceAttack, you won’t have to visit the site at any point.
everything you need from within the game and VoiceAttack, you won’t have to
visit the site at any point.
## Plotting a Route ## Plotting a Route

2
docs/configuration/EliteAttack.md
View file

@ -14,7 +14,7 @@ Toggles:
true. true.
* `auto restock`: Automatically restock after docking at a station. Default: * `auto restock`: Automatically restock after docking at a station. Default:
true. true.
* `auto move to hangar`: Automatically move the ship to the hanger after docking * `auto move to hangar`: Automatically move the ship to the hangar after docking
at a station. Default: true. at a station. Default: true.
* `auto enter station services`: Automatically enter the Station Services menu * `auto enter station services`: Automatically enter the Station Services menu
after docking at a station. Default: true. after docking at a station. Default: true.

2
docs/configuration/SpanshAttack.md
View file

@ -13,7 +13,7 @@ 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 Rat ships, I recommend telling SpanshAttack about the range they are supposed to
have with full fuel and your preferred amount of cargo/limpets. have with full fuel and your preferred amount of cargo/limpets.
In oder to do that, copy the `SpanshAttack.getShipRange` command from In order to do that, copy the `SpanshAttack.getShipRange` command from
SpanshAttack or the example profile to your custom profile and add your ships. SpanshAttack or the example profile to your custom profile and add your ships.
Any ship listed in there will automatically have its jump range used instead of Any ship listed in there will automatically have its jump range used instead of
EDDI’s reported laden range or VoiceAttack prompting you to manually supply it. EDDI’s reported laden range or VoiceAttack prompting you to manually supply it.

4
docs/configuration/general.md
View file

@ -7,8 +7,8 @@ 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 stored in your custom profile. You could even have different custom profiles
with their own distinct settings. with their own distinct settings.
The easiest way to change setings is to say `customize settings`. That will The easiest way to change settings is to say `customize settings`. That will
bring up a rudminteary settings UI. bring up a rudimentary settings UI.
You change also change the configuration directly via voice commands: You change also change the configuration directly via voice commands:

4
docs/general.md
View file

@ -2,7 +2,7 @@
## Configuration ## Configuration
The base profile provides voice commands for changing the profiles settings. 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 ## Chat
@ -10,7 +10,7 @@ See [the configuration section](../configuration/general#settings).
* `paste text`: Pastes the contents of your current clipboard. Note that this * `paste text`: Pastes the contents of your current clipboard. Note that this
command is supposed to be used for pasting _into Elite_ and hence uses the command is supposed to be used for pasting _into Elite_ and hence uses the
configured paste key. If you’re using a non-standard layout that means that configured paste key. If you’re using a non-standard layout that means that
you can _not_ use this command to paste text into other applications. you _cannot_ use this command to paste text into other applications.
## Updating ## Updating

BIN
docs/images/ED-NeutronRouter-folder.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

8
docs/index.md
View file

@ -8,9 +8,9 @@ Rats](https://fuelrats.com) and [Hull Seals](https://hullseals.space) work.
**NOTE**: Further development is on hold and Odyssey compatibility will not be **NOTE**: Further development is on hold and Odyssey compatibility will not be
worked on for the time being. See [the corresponding issue on worked on for the time being. See [the corresponding issue on
Github](https://github.com/alterNERDtive/VoiceAttack-profiles/issues/113). This Github](https://github.com/alterNERDtive/VoiceAttack-profiles/issues/113). This
might or might not change after the Horizons/Odyssey merge when console release might or might not change after the Horizons/Odyssey merge. Feel free to file
is upon us. Feel free to file issues for anything that is broken on Odyssey and issues for anything that is broken on Odyssey and it will be worked on when it
it will be worked on when it is worked on. is worked on.
## Available Profiles ## Available Profiles
@ -31,7 +31,7 @@ Well, you are in the right place. You can find comprehensive documentation right
here. here.
If you run into any errors, please make sure you are running the latest version If you run into any errors, please make sure you are running the latest version
of the profiles and all requirements. of the profiles and all [requirements](requirements).
If your problem persists, please [file an If your problem persists, please [file an
issue](https://github.com/alterNERDtive/VoiceAttack-profiles/issues). Thanks! :) issue](https://github.com/alterNERDtive/VoiceAttack-profiles/issues). Thanks! :)

18
docs/installing.md
View file

@ -7,9 +7,7 @@ version](https://voiceattack.com/#download-1) off the official site and install
it. it.
If you are using the standalone version you should probably download the If you are using the standalone version you should probably download the
executable installer. If you are using the Steam version of VoiceAttack, you executable installer.
will have to download the zipped folder and replace your installed version with
its contents.
![[VoiceAttack-download.png]] ![[VoiceAttack-download.png]]
@ -55,12 +53,12 @@ hit `Enter`) and do
``` ```
If you have installed the non-Steam version of VoiceAttack to the default folder If you have installed the non-Steam version of VoiceAttack to the default folder
within “ProgramFiles” you will have to run the command prompt as admin (Windows within “Program Files” you will have to run the command prompt as admin (Windows
key + `R`, enter “cmd”, hit `Control` + `Shift` + `Enter`). key + `R`, enter “cmd”, hit `Control` + `Shift` + `Enter`).
## Install ED-NeutronRouter ## Install ED-NeutronRouter
[Grab the latest release release from Grab [the latest release release from
Github](https://github.com/sc-pulgan/ED-NeutronRouter/releases/latest) (The Github](https://github.com/sc-pulgan/ED-NeutronRouter/releases/latest) (The
`EDNeutronRouter.vX.YZ.zip` under “Assets”). You will have to extract the `EDNeutronRouter.vX.YZ.zip` under “Assets”). You will have to extract the
contents of the release .zip file to your VoiceAttack Apps folder: contents of the release .zip file to your VoiceAttack Apps folder:
@ -99,7 +97,7 @@ 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 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 profile example as a basis. Regardless of which way you choose, make sure to
read the [[#Include Profiles]] section and follow the instructions there! read the [Include Profiles](#include-profiles) section and follow the instructions there!
### Option 1: Create a New Profile Or Use an Existing One ### Option 1: Create a New Profile Or Use an Existing One
@ -123,7 +121,7 @@ will now have to create the startup command. Hit the “New Command” button.
![[VoiceAttack-edit-new-command.png]] ![[VoiceAttack-edit-new-command.png]]
You can name it anything you want but I recommend calling it “startup” or 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 similar, and to deactivate the “when I say” checkbox in the command options to
make sure you do not accidentally run it via voice. make sure you do not accidentally run it via voice.
![[VoiceAttack-edit-startup.png]] ![[VoiceAttack-edit-startup.png]]
@ -148,7 +146,7 @@ action. You do not have to set any configuration options, this can be done way
more elegantly! More on this [later on](general.md#settings). more elegantly! More on this [later on](general.md#settings).
After adding the startup command you will have to right click VoiceAttack’s After adding the startup command you will have to right click VoiceAttack’s
title bar and choose “Reload Active Profile” or restart VoiceAttack to it title bar and choose “Reload Active Profile” or restart VoiceAttack to see it
executed for the first time. executed for the first time.
### Option 2: Use the Profile Example ### Option 2: Use the Profile Example
@ -185,8 +183,8 @@ button.
![[VoiceAttack-profile-options-include.png]] ![[VoiceAttack-profile-options-include.png]]
Add all my profiles (“alterNERDtive-base”, “EliteDangerous”, “RatAttack”, Add all my profiles (“alterNERDtive-base”, “EliteAttack”, “RatAttack”,
“SpanshAttack”,“StreamAttack”). “SpanshAttack”, “StreamAttack”).
![[VoiceAttack-profile-options-includelist.png]] ![[VoiceAttack-profile-options-includelist.png]]