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

docs: clarified when StreamAttack updates information

Browse source 
fixes #155
This commit is contained in:
alterNERDtive 2022-09-15 15:17:39 +02:00
parent d78cf17b6b
commit d97499778c
Signed by: alterNERDtive
GPG key ID: 547787A4FE6533F1
1 changed files with 50 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

96
docs/StreamAttack.md
View file

@ -1,48 +1,52 @@
# StreamAttack
This profile uses the [EDDI](https://github.com/EDCD/EDDI) plugin to write
a bunch of information about your commander, your current location and your ship
to files that can be accessed e.g. by your streaming software to be displayed on
stream.
Default folder is `%appdata%\StreamAttack\`.
## Commands
* `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
in your default browser.
* `open StreamAttack folder`: Opens the configured folder in Explorer.
## Output Files
# StreamAttack
This profile uses the [EDDI](https://github.com/EDCD/EDDI) plugin to write
a bunch of information about your commander, your current location and your ship
to files that can be accessed e.g. by your streaming software to be displayed on
stream.
Default folder is `%appdata%\StreamAttack\`.
## Commands
* `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
in your default browser.
* `open StreamAttack folder`: Opens the configured folder in Explorer.
## Output Files
### Elite
#### Commander
* `Elite\cmdr\name`: The current commander’s 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 target’s system name.
#### Location
* `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.
#### Ship
* `Elite\ship\build`: Your current ship’s loadout (link to coriolis).
* `Elite\ship\full`: `“<name>” | <model> | <build>`.
* `Elite\ship\model`: Your current ship’s model.
* `Elite\ship\name`: Your current ship’s name.
Please do note that information in the output files is only updated when a
journal event that contains the information is detected. E.g. the distance to
your jump target is not constantly calculated, but only updated after a jump.
#### Commander
* `Elite\cmdr\name`: The current commander’s 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 target’s system name.
#### Location
* `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.
#### Ship
* `Elite\ship\build`: Your current ship’s loadout (link to coriolis).
* `Elite\ship\full`: `“<name>” | <model> | <build>`.
* `Elite\ship\model`: Your current ship’s model.
* `Elite\ship\name`: Your current ship’s name.