Merge branch 'release-prep/v1.1' into release
This commit is contained in:
commit
e2ad40defa
10 changed files with 407 additions and 40 deletions
81
CHANGELOG.md
81
CHANGELOG.md
|
|
@ -1,6 +1,75 @@
|
|||
# v1.1 (2020-01-30)
|
||||
|
||||
The compiled Python scripts are now distributed as two single .exe files. You
|
||||
can (but don’t have to) delete the subfolders in `Python.scriptDir`.
|
||||
|
||||
## RatAttack v2.0
|
||||
|
||||
* `[current;] rat case details` changed: Now always has to include “rat” in the
|
||||
command to pave the way for SealAttack arriving soon™. **This breaks
|
||||
compatibilty with the old `[current;] case details` command.**
|
||||
|
||||
features:
|
||||
|
||||
* added option to auto-close on fuel+: Defaults to off. Enabled in the
|
||||
EliteDangerous profile.
|
||||
* added option to call jumps “left”
|
||||
* added distance commands `distance to current rat case`/distance to rat case
|
||||
number [0..19]`: Both require a current version of the elite-scripts.
|
||||
* added `call client offline` command
|
||||
|
||||
## SealAttack v0.1
|
||||
|
||||
VERY early alpha. Basically the only thing that works and is “finished” already
|
||||
is pasting ingame chat into Seals IRC. use `.sb <msg>` for \#Seal-Bob and `.rr
|
||||
<msg>` for \#Repair-Requests.
|
||||
|
||||
Use at your own risk.
|
||||
|
||||
## SpanshAttack v2.2
|
||||
|
||||
features:
|
||||
|
||||
* added plot command “with custom range”: Instead of using the saved jump range
|
||||
for your current ship, you can now plot a route with a custom range; e.g. if
|
||||
you have temporarily changed modules around or have more/less cargo than usual
|
||||
for this trip.
|
||||
|
||||
fixes:
|
||||
|
||||
* added info about EDDB to docs: Just a little tidbit about making sure the
|
||||
target system is actually in the DB.
|
||||
|
||||
## EliteDangerous v3.1
|
||||
|
||||
features:
|
||||
|
||||
* added jumpTarget stuff: You can now set/clear a jump target. This will start
|
||||
writing the distance to said target to `>jumpTargetFile` for inclusion e.g. in
|
||||
OBS. If SpanshAttack currently has a target system, jump target will default
|
||||
to that. A manually set target will take precedence.
|
||||
* added `distance [from;to] jump target` command
|
||||
* added some quick links: Coriolis, EDSM main page, EDDB (incl.
|
||||
station/system/faction search page). `open coriolis`, `open e d s m`, `open
|
||||
e d d b [station;system;faction;] [search;]`.
|
||||
|
||||
fixes:
|
||||
|
||||
* refactored for better variable scoping
|
||||
* changed `EDDI Body scanned` constraint: Now checks for being in SC instead of
|
||||
just in FSS; will now include auto-scans of bodies, while still excluding nav
|
||||
beacon scan data.
|
||||
* logic around getting bodycount more sturdy: Now actually notices when the
|
||||
script errors out for some reason. Probably still won’t notice when it’s flat
|
||||
out missing, but hey, that’s PEBKAC for not using the profile package.
|
||||
* fixed race condition in `EDDI ship fsd`: Weirdly that only started being an
|
||||
issue in VA 1.8.
|
||||
* updated for new controls setup: the HOTAS buttons have changed because my
|
||||
setup has changed. Probably not really relevant for you.
|
||||
|
||||
# v1.0 (2019-12-04)
|
||||
|
||||
### single-file profile package ###
|
||||
### single-file profile package
|
||||
|
||||
You can now install a single “profile package” for all the packages and related
|
||||
stuff (excluding required plugins)! That should make the entire setup process
|
||||
|
|
@ -12,14 +81,14 @@ you delete the now obsolote `scripts` folder in your VoiceAttack directory, or
|
|||
wherever you have installed the scripts instead. If you haven’t been using them,
|
||||
just ignore this paragraph.
|
||||
|
||||
### new profile format ###
|
||||
### new profile format
|
||||
|
||||
VoiceAttack 1.8 has the compressed profile as default export format. The
|
||||
profiles will now come in this since I would forget to change the export format
|
||||
every time I export them anyway. This shouldn’t lead to any issues but please do
|
||||
open a bug if it does.
|
||||
|
||||
## RatAttack v1.0 ##
|
||||
## RatAttack v1.0
|
||||
|
||||
* fixed first case announcement after starting VoiceAttack
|
||||
* on opening a case, VoiceAttack will now first copy the target system to the
|
||||
|
|
@ -28,17 +97,17 @@ open a bug if it does.
|
|||
is actually for a platform you want to have cases announced for
|
||||
* added `call wing pending` command
|
||||
|
||||
## SpanshAttack v2.1 ##
|
||||
## SpanshAttack v2.1
|
||||
|
||||
* will now set neutron mode and target system _before_ getting ship range. This
|
||||
avoids race conditions with targeting a system, executing the plot command,
|
||||
then changing the targeted system.
|
||||
|
||||
## EliteDangerous v3.0 ##
|
||||
## EliteDangerous v3.0
|
||||
|
||||
* added `[dis;]engage silent running` command
|
||||
|
||||
## elite-scripts 0.1.1 ##
|
||||
## elite-scripts 0.1.1
|
||||
|
||||
* fixed bug with wonky system names (including e.g. `+` or `[]`)
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Each of the profiles is documented in `docs/`.
|
|||
* [RatAttack](docs/RatAttack.md): profile for interactions with the Fuel Rats’
|
||||
IRC server.
|
||||
* [SealAttack](docs/SealAttack.md): profile for interactions with the Hull
|
||||
Seals’ IRC server. (Not a thing yet.)
|
||||
Seals’ IRC server. (**VERY early alpha stage.**)
|
||||
|
||||
## Requirements ##
|
||||
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ disable the speech responder entirely like I have.)
|
|||
In addition to the bindED and EDDI VoiceAttack plugins, this profiles needs my
|
||||
[Python elite-scripts](https://github.com/alterNERDtive/elite-scripts) to do
|
||||
everything properly. The release page here includes a compiled version for
|
||||
Windows that does not need Python installed. Just download the zip file from the
|
||||
release page and extract into your VoiceAttack directory.
|
||||
Windows that does not need Python installed. If you use the profile package from
|
||||
the release page, they will be installed automatically.
|
||||
|
||||
## Settings ##
|
||||
|
||||
|
|
@ -141,7 +141,7 @@ Sets your ship to full throttle immediately after you have supercharged.
|
|||
|
||||
* zeroes throttle
|
||||
* gets the system’s body count from EDSM (requires Python scripts)
|
||||
* if you hvaen’t visited the systems, starts a discovery scan (see the discovery
|
||||
* if you haven’t visited the systems, starts a discovery scan (see the discovery
|
||||
scan command)
|
||||
|
||||
#### Liftoff ####
|
||||
|
|
@ -158,7 +158,7 @@ Warns you when you reach 25% fuel.
|
|||
Checks any message you send for a chat prefix and sends it to the proper chat
|
||||
window. Probably largely useless to you without modification.
|
||||
|
||||
* `.dt`: Actually doesn’t send anything, but runs the
|
||||
* `.nc`: Actually doesn’t send anything, but runs the
|
||||
`RatAttack.announceNearestCMDR` command with the system given in the rest of
|
||||
the message.
|
||||
* `.dc`: Sends the message to the Discord window.
|
||||
|
|
@ -173,15 +173,16 @@ This event actually is several different events in one. Currently the following
|
|||
are handled:
|
||||
|
||||
* charging: Warns you if your target system’s main star is not scoopable,
|
||||
including an extra warning at low fuel levels. (__Note__: This is currently
|
||||
kind of bugged, not sure if it’s EDDI’s or Elite’s fault.)
|
||||
including an extra warning at low fuel levels. (__Note__: This only works if
|
||||
the target system is in EDSM. So it’s kind of useless for its intended use
|
||||
(exploration) and probably going to be removed at some point.)
|
||||
* cooldown complete: Announces FSD cooldown if you are currently in normal
|
||||
space.
|
||||
|
||||
#### Ship interdiction ####
|
||||
#### Ship interdicted ####
|
||||
|
||||
Tells you when you are interdicted by a player. Is also supposed to target the
|
||||
interdictor automatically, but that randomly sometimes just doesn’t work. Yay!
|
||||
Tells you when you have been interdicted by a player. Is also supposed to target
|
||||
the interdictor automatically, but randomly sometimes just doesn’t work. Yay!
|
||||
|
||||
#### Ship targeted ####
|
||||
|
||||
|
|
@ -216,14 +217,20 @@ _don’t_ immediately want to retract it after takeoff?
|
|||
These commands are all bound to keys on my throttle to make them do different
|
||||
things on tapping and on holding.
|
||||
|
||||
* `boost combo key`: Bound to the same button as the boost key ingame, this will
|
||||
deploy landing gear if held down to perform a half-boost.
|
||||
* `center headlook`: Triggers the keybind to center ViewTracker
|
||||
* `docking request key`: Well, that one just sends a docking request using the
|
||||
proper command. No secondary function.
|
||||
* `FSS key`: Well … that one too just opens/closes FSS. And sets throttle to 0%
|
||||
so you can enter it.
|
||||
* `jump combo key`: Jumps on tap, executes the `jump` command on hold.
|
||||
* `mute mic`: Hits ^M which is the standard hotkey I use for muting my mic (OBS,
|
||||
Discord, …)
|
||||
* `plot combo key`: Targets next system on route on tap, plots to the thing in
|
||||
your clipboard via the galaxy map on hold.
|
||||
* `sc combo key`: Goes into SC on tap, executes the `cruise` command on hold.
|
||||
* `toggle headlook`: Triggers the keybind that turns ViewTracker on/off.
|
||||
|
||||
Main benefit of using the jump/cruise commands instead of the buttons would be
|
||||
automatically retracting everything.
|
||||
|
|
@ -234,6 +241,7 @@ The commands in here do random more or less useful things.
|
|||
|
||||
* `bind keys;reset key binds`: Reloads your key binds through the bindED plugin.
|
||||
You should do that after changing anything in the controls options.
|
||||
* `clear jump target`: Clears the current jump target.
|
||||
* `copy current system`: Copies the current system name into the clipboard.
|
||||
* `distance [from;to] […]`: Tells you the distance from your current position to
|
||||
the other thing you mentioned and is supported in the command. (requires
|
||||
|
|
@ -247,11 +255,17 @@ The commands in here do random more or less useful things.
|
|||
* `neutron jumps left`: Shorter version of the same thing in SpanshAttack.
|
||||
* `open copied system on EDSM`: Opens the system in your clipboard on EDSM in
|
||||
your default browser.
|
||||
* `open coriolis`: Opens Coriolis in your default browser.
|
||||
* `open [current;] system on EDSM`: Opens your current system on EDSM in your
|
||||
default browser.
|
||||
* `open EDDI options; configure EDDI`: Opens the EDDI configuration window.
|
||||
* `open e d d b [station;system;faction;] [search;]`: Opens EDDB in your default
|
||||
browser.
|
||||
* `open e d s m`: Opens EDSM in your default browser.
|
||||
* `open [the;] miner’s tool`: Opens https://edtools.ddns.net/miner in your
|
||||
default browser.
|
||||
* `set jump target`: Sets the jump target to the currently targeted system.
|
||||
Distance will be written to the configured file.
|
||||
* `[start;stop] [EDISON;navigation]`: Hits `CTRL+ALT+E` which just so happens to
|
||||
be the start/stop hotkey I have set in E.D.I.S.O.N.
|
||||
* `[what’s;what is] left to [map;be mapped]`: Tells you which bodies EDDI thinks
|
||||
|
|
@ -298,7 +312,7 @@ Basically anything that is related to directly doing something with your ship.
|
|||
|
||||
Things revelant to your SRV, but not your ship.
|
||||
|
||||
* `[recall;dismiss] ship`; Recalls or dismisses ship. Currently does the same
|
||||
* `[recall;dismiss] ship`: Recalls or dismisses ship. Currently does the same
|
||||
thing regardless of the state of your ship. I wish it would be possible to
|
||||
restrict it to doing one thing each, but that’s currently not possible sadly.
|
||||
* `[toggle;enable;disable] drive assist`: Handles all your drive assist needs!
|
||||
|
|
@ -359,6 +373,8 @@ if you have included EliteDangerous.
|
|||
side. Default: false.
|
||||
* `>flightAssistOff` (boolean): whether to automatically toggle FlightAssist off
|
||||
on liftoff. Default: true.
|
||||
* `>jumpTargetFile` (string): the file the distance to the currently set jump
|
||||
target will be written to.
|
||||
* `>targetSubsystem` (string): the default target subsystem. Unused. Default:
|
||||
“drive”.
|
||||
* `python.ScriptPath` (string): the path you have placed the compiled python
|
||||
|
|
|
|||
|
|
@ -18,8 +18,8 @@ you can install EDDI and my elite scripts for advanced features.
|
|||
* [elite-scripts](https://github.com/alterNERDtive/elite-scripts): Using the
|
||||
Python scripts will give RatAttack a way to be aware of where your CMDRs are
|
||||
and give you the nearest one to a rat case. That’s only really needed if you
|
||||
actually _have_ multiple CMDRs, obviously. Just download the zip file from the
|
||||
release page and extract into your VoiceAttack directory.
|
||||
actually _have_ multiple CMDRs, obviously. If you are using the profile
|
||||
package from the release page, they will be installed automatically.
|
||||
|
||||
### EDDI speech responder ###
|
||||
|
||||
|
|
@ -121,8 +121,14 @@ number, CMDR name, system, O₂ status and platform. There are several commands
|
|||
you can run on this list, giving it a case number:
|
||||
|
||||
* `rat case number [0..19] details`: Will give you all stored info on a case.
|
||||
* `[current;rat] case details`: Will give you all stored info on the currently
|
||||
* `[current;] rat case details`: Will give you all stored info on the currently
|
||||
open case.
|
||||
* `distance to current rat case`: Will give you the distance from your current
|
||||
location to the currently opened rat case. Requires the use of my
|
||||
`elite-scripts` Python scripts.
|
||||
* `distance to rat case number [0..19]`: Will give you the distance from your
|
||||
current system to a case’s system. Requires the use of my `elite-scripts`
|
||||
Python scripts.
|
||||
* `nearest commander to rat case number [0..19]`: Will give you the nearest of
|
||||
your CMDRs with their distance to a case’s system. Requires some setup and the
|
||||
use of my `elite-scripts` Python scripts.
|
||||
|
|
@ -154,9 +160,10 @@ will be shortened to the usual IRC short hands (e.g. “sysconf”). If you need
|
|||
something more unusual you can either still manually type it into your IRC
|
||||
client or use the “General IRC Integration”, see below.
|
||||
|
||||
* `call [1..20] jumps [and login;and takeoff]`: Calls jump for the currently
|
||||
open case. You can optionally include that you will still have to login to the
|
||||
game or have to take off from your current station/port/outpost/planet.
|
||||
* `call [1..20] jumps [and login;and takeoff;left;]`: Calls jump for the
|
||||
currently open case. You can optionally include that you will still have to
|
||||
login to the game or have to take off from your current
|
||||
station/port/outpost/planet.
|
||||
* `call friend [positive;negative] [in pg;in private group;in solo;in main
|
||||
meu;sysconf;system confirmed]`: Friend request confirmations, with all the
|
||||
things you might want to / should call with it.
|
||||
|
|
@ -168,9 +175,10 @@ client or use the “General IRC Integration”, see below.
|
|||
* `call client in [exclusion zone;main menu;open;open sysconf;pg;private
|
||||
group;solo;super cruise]`: Callouts for all the various things a client could
|
||||
get themselves into.
|
||||
* `call [client destroyed;sysconf;system confirmed]`: This is the command you
|
||||
don’t want to use. Include sysconf in your “friend+” or “in open” calls, and
|
||||
make sure you will never have to call “client destroyed”, would you?
|
||||
* `call [client destroyed;client offline;sysconf;system confirmed]`: This is the
|
||||
command you don’t want to use. Include sysconf in your “friend+” or “in open”
|
||||
calls, and make sure you will never have to call “client destroyed”, would
|
||||
you?
|
||||
|
||||
### General IRC Interaction ###
|
||||
|
||||
|
|
@ -215,6 +223,8 @@ you have included RatAttack.
|
|||
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.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
|
||||
|
|
|
|||
|
|
@ -0,0 +1,273 @@
|
|||
# SealAttack #
|
||||
|
||||
This profile facilitates [Hull Sealing](https://www.hullseals.space). It aims to
|
||||
eliminate as much of the required manual task and attention switching as
|
||||
possible via automation and voice commands.
|
||||
|
||||
If you don’t know what the Hull Seals are, come hang out and ask :)
|
||||
|
||||
**HERE BE DRAGONS**
|
||||
|
||||
This is basically just a copy of the RatAttack doc at the moment; the only thing
|
||||
that already works is typing into the Seals IRC from ingame using `.sb <msg>`.
|
||||
Messages will end up in \#Seal-Bob.
|
||||
|
||||
**VERY EARLY ALPHA**
|
||||
|
||||
## Requirements ##
|
||||
|
||||
Only vanilla VoiceAttack is absolutely required to use this profile. Optionally
|
||||
you can install EDDI and my elite scripts for advanced features.
|
||||
|
||||
* [EDDI](https://github.com/EDCD/EDDI) installed as a VoiceAttack plugin: This
|
||||
will give you a better (IMO) way of using TTS. Be sure to set
|
||||
`RatAttack.useEddiForVoice`. It will also enable you to have ingame chat be
|
||||
transferred to IRC; see below.
|
||||
* [elite-scripts](https://github.com/alterNERDtive/elite-scripts): Using the
|
||||
Python scripts will give RatAttack a way to be aware of where your CMDRs are
|
||||
and give you the nearest one to a rat case. That’s only really needed if you
|
||||
actually _have_ multiple CMDRs, obviously. If you are using the profile
|
||||
package from the release page, they will be installed automatically.
|
||||
|
||||
### EDDI speech responder ###
|
||||
|
||||
For the convenience of people that have not been using EDDI in the past,
|
||||
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”.
|
||||
|
||||
## Settings ##
|
||||
|
||||
There are a lot of preferences you can set, including some you really want to
|
||||
concern yourself with before you start using the profile. Some of the more
|
||||
advanced features heavily rely on you giving it the correct things to work with.
|
||||
|
||||
See the [Configuration Variables](#Configuration-Variables) section.
|
||||
|
||||
## Including the Profile ##
|
||||
|
||||
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
|
||||
Message sent”, call `RatAttack.EDDI Message sent` by name from your `((EDDI
|
||||
Message sent))` command.
|
||||
|
||||
## Usage ##
|
||||
|
||||
### Going On/Off Duty ###
|
||||
|
||||
When you are on duty, RatAttack will automatically announce cases coming in
|
||||
through IRC. When off duty, it won’t.
|
||||
|
||||
* `[enable;disable] rat duty`: puts you on/off duty.
|
||||
|
||||
### Handling a Case ###
|
||||
|
||||
#### Getting Case Data From IRC ####
|
||||
|
||||
Currently there is one singular way of getting case info from IRC into
|
||||
VoiceAttack: having your IRC client put the ratsignal into the clipboard, then
|
||||
having it run the `RatAttack.getInfoFromRatsignal` command.
|
||||
|
||||
This has two purposes:
|
||||
|
||||
1. announcing a new incoming case
|
||||
1. storing case data and making it available to VoiceAttack, e.g. for copying
|
||||
the case’s system into the clipboard
|
||||
|
||||
In my case I am running AdiIRC and have the following script setup for handling
|
||||
this:
|
||||
|
||||
```
|
||||
on *:TEXT:RATSIGNAL - CMDR*(??_SIGNAL):#fuelrats:{
|
||||
var %clip = $cb(-1)
|
||||
/clipboard $1-
|
||||
/run -h "D:\tools\VoiceAttack\VoiceAttack.exe" -nofocus -command "RatAttack.getInfoFromRatSignal"
|
||||
/sleep 2 /clipboard %clip
|
||||
}
|
||||
```
|
||||
|
||||
This does the following things:
|
||||
|
||||
1. listen for a line starting with “RATSIGNAL - CMDR” and ending with
|
||||
“(??\_SIGNAL)” (`?` being any character); that will catch an incoming signal
|
||||
with basically no false positives
|
||||
1. temporarily save the current clipboard
|
||||
1. copy the entire line to the clipboard
|
||||
1. run VoiceAttack (should already be open) with the
|
||||
`RatAttack.getInfoFromRatsignal` command that will parse the signal and store
|
||||
case information
|
||||
1. wait for 2s to make sure the command had time to grab the clipboard, then
|
||||
restore the old clipboard
|
||||
|
||||
If you don’t know how to do the same thing for your IRC client or it doesn’t
|
||||
support copying the control characters in the ratsignal that the profile uses to
|
||||
split the information, either switch to AdiIRC or bribe me to include some other
|
||||
way to get case data into VoiceAttack.
|
||||
|
||||
#### Internal Case List ####
|
||||
|
||||
If you have your IRC client setup properly, VoiceAttack will hold a list with
|
||||
all rat cases that have come in while you had it running. It will save the case
|
||||
number, CMDR name, system, O₂ status and platform. There are several commands
|
||||
you can run on this list, giving it a case number:
|
||||
|
||||
* `rat case number [0..19] details`: Will give you all stored info on a case.
|
||||
* `[current;] rat case details`: Will give you all stored info on the currently
|
||||
open case.
|
||||
* `distance to current rat case`: Will give you the distance from your current
|
||||
location to the currently opened rat case. Requires the use of my
|
||||
`elite-scripts` Python scripts.
|
||||
* `distance to rat case number [0..19]`: Will give you the distance from your
|
||||
current system to a case’s system. Requires the use of my `elite-scripts`
|
||||
Python scripts.
|
||||
* `nearest commander to rat case number [0..19]`: Will give you the nearest of
|
||||
your CMDRs with their distance to a case’s system. Requires some setup and the
|
||||
use of my `elite-scripts` Python scripts.
|
||||
* `nearest commander to [the;] rat case`: Will give you the nearest of your
|
||||
CMDRs with their distance to the current case’s system. Requires some setup
|
||||
and the use of my `elite-scripts` Python scripts.
|
||||
|
||||
#### Opening a Case ####
|
||||
|
||||
* `open rat case number [0..19]`: Opens rat case with the given number. If there
|
||||
is no case data for that case (e.g. because you don’t have your IRC client set
|
||||
up properly), it will still open it, just not have any data on it.
|
||||
* `open [latest;] rat case`: Opens the latest rat case that has come in through
|
||||
IRC. Will probably error out in creative ways if you don’t have your IRC
|
||||
client set up properly. Too tired right now to have proper error handling so
|
||||
just open an issue if you run into problems (it’s 7am, I haven’t slept and
|
||||
want to finish this doc to get the release out (yes, you are allowed to laugh
|
||||
at this section)).
|
||||
|
||||
#### Closing a Case ####
|
||||
|
||||
* `[close;clear] rat case`: Closes the currently open rat case.
|
||||
|
||||
### Making Calls ###
|
||||
|
||||
There are a bunch of calls you can make for a case, the most common are modelled
|
||||
through VoiceAttack commands. The descriptive commands (e.g. “system confirmed”)
|
||||
will be shortened to the usual IRC short hands (e.g. “sysconf”). If you need
|
||||
something more unusual you can either still manually type it into your IRC
|
||||
client or use the “General IRC Integration”, see below.
|
||||
|
||||
* `call [1..20] jumps [and login;and takeoff;left;]`: Calls jump for the
|
||||
currently open case. You can optionally include that you will still have to
|
||||
login to the game or have to take off from your current
|
||||
station/port/outpost/planet.
|
||||
* `call friend [positive;negative] [in pg;in private group;in solo;in main
|
||||
meu;sysconf;system confirmed]`: Friend request confirmations, with all the
|
||||
things you might want to / should call with it.
|
||||
* `call [beacon;fuel;instance;pos;position;prep;sys;system;wing]
|
||||
[positive;negative]`: All the stuff you usually need for ratting after you
|
||||
have received the friend request.
|
||||
* `call wing pending`: Calls “wr pending” for when it takes 30s again to
|
||||
actually show up.
|
||||
* `call client in [exclusion zone;main menu;open;open sysconf;pg;private
|
||||
group;solo;super cruise]`: Callouts for all the various things a client could
|
||||
get themselves into.
|
||||
* `call [client destroyed;client offline;sysconf;system confirmed]`: This is the
|
||||
command you don’t want to use. Include sysconf in your “friend+” or “in open”
|
||||
calls, and make sure you will never have to call “client destroyed”, would
|
||||
you?
|
||||
|
||||
### General IRC Interaction ###
|
||||
|
||||
(requires EDDI)
|
||||
|
||||
Using EDDI to read the game’s journal, you can send messages to IRC from Elite’s
|
||||
ingame chat.
|
||||
|
||||
**Be aware that the chat message will still appear in the ingame chat channel
|
||||
you send it to!**
|
||||
|
||||
I recommend using local chat and limiting the use to instances that will
|
||||
probably not have other players in it (e.g. instanced in normal space with the
|
||||
client or in SC in some remote system out in the black on a long range rescue).
|
||||
|
||||
* #fuelrats: Use “.fr \<message\>” to have VoiceAttack send “#\<caseNumber\>
|
||||
\<message\>” to the #fuelrats channel – or yell at you when you are not on
|
||||
a case.
|
||||
* #ratchat: Use “.rc \<message\>” to have VoiceAttack send “\<message\>” to
|
||||
#ratchat.
|
||||
|
||||
These commands send their text to windows with “#fuelrats” and “#ratchat” in
|
||||
their title, respectively. If your IRC client does not do that, you will have to
|
||||
change the “target” window of the `RatAttack.sendToFuelrats` and
|
||||
`RatAttack.sendToRatchat` commands to reflect the actual window titles on your
|
||||
system. I will look into making this more elegant to change in the future.
|
||||
|
||||
## Exposed Variables ##
|
||||
|
||||
The following Variables are _global_ and thus readable (and writeable! Please
|
||||
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.
|
||||
|
||||
* `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
|
||||
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.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”.
|
||||
|
||||
### Other Variables ###
|
||||
|
||||
Current case data:
|
||||
|
||||
* `RatAttack.caseNumber` (int): the number of the case you are currently on.
|
||||
Will be `Not Set` if you are not on a case.
|
||||
* `RatAttack.onCase` (boolean): whether or not you are currently on a case.
|
||||
|
||||
Case list:
|
||||
|
||||
* `RatAttack.caseList.<case#>.cmdr` (string)
|
||||
* `RatAttack.caseList.<case#>.system` (string)
|
||||
* `RatAttack.caseList.<case#>.platform` (string)
|
||||
* `RatAttack.caseList.<case#>.codeRed` (boolean)
|
||||
|
||||
… with `<case#>` being a number between 0 and 19.
|
||||
|
|
@ -11,14 +11,9 @@ visit the site at any point.
|
|||
In addition to VoiceAttack, you will need the following plugins to use this
|
||||
profile:
|
||||
|
||||
* [bindED](https://forum.voiceattack.com/smf/index.php?topic=564.0): required
|
||||
for EliteDangerous and SpanshAttack; makes anything involving hitting E:D key
|
||||
binds portable.
|
||||
* [EDDI](https://github.com/EDCD/EDDI) installed as a VoiceAttack plugin:
|
||||
required for EliteDangerous and SpanshAttack, optional for RatAttack and
|
||||
SealAttack.
|
||||
* [ED-NeutronRouter](https://github.com/sc-pulgan/ED-NeutronRouter): required
|
||||
for SpanshAttack.
|
||||
* [bindED](https://forum.voiceattack.com/smf/index.php?topic=564.0)
|
||||
* [EDDI](https://github.com/EDCD/EDDI) installed as a VoiceAttack plugin
|
||||
* [ED-NeutronRouter](https://github.com/sc-pulgan/ED-NeutronRouter)
|
||||
|
||||
### EDDI speech responder ###
|
||||
|
||||
|
|
@ -50,7 +45,9 @@ The last “setting” in the not-so-strict sense of the word is the
|
|||
`SpanshAttack.getShipRange` command. Any ship listed in there will automatically
|
||||
have its jump range used instead of VA prompting you for it. Since, again, VA
|
||||
will execute the first matching command found, you can create this command in
|
||||
your own profile when you are using SpanshAttack by including it.
|
||||
your own profile when you are using SpanshAttack by including it. You can
|
||||
override a saved range for your ship by using the `plot neutron
|
||||
[course;route;trip] with custom range` command.
|
||||
|
||||
The ED-NeutronRouter plugin is technically supposed to read the current jump
|
||||
range from EDDI; sadly a) it’s
|
||||
|
|
@ -84,15 +81,17 @@ When including the profile, be sure to
|
|||
|
||||
### Plotting a Route ###
|
||||
|
||||
1. Make sure your target system is in EDDB.
|
||||
1. _Target_ the system you want to be routed to (target, do not plot to it).
|
||||
1. Either exit the galaxy map or make sure you are on its first tab (or
|
||||
auto-plotting will break).
|
||||
1. Trigger the `SpanshAttack.plotRoute` command either by voice (`plot neutron
|
||||
[course;route;trip]`) or calling it from another command
|
||||
1. (if ship not listed in `SpanshAttack.getShipRange`) Enter your ship’s jump
|
||||
range when prompted.
|
||||
[course;route;trip] [with custom range;]`) or calling it from another command
|
||||
1. (if ship not listed in `SpanshAttack.getShipRange` or command invoked with
|
||||
`with custom range` option) Enter your ship’s jump range when prompted.
|
||||
1. Wait for the route to be calculated. The command will automatically open the
|
||||
galaxy map and jump to the first waypoint on your route.
|
||||
galaxy map and jump to the first waypoint on your route. If you run into
|
||||
weird behaviour, it’s probably because your target system is not in EDDB.
|
||||
1. Either target the first waypoint or plot to it.
|
||||
1. Start jumping!
|
||||
|
||||
|
|
@ -166,7 +165,7 @@ if you have included SpanshAttack.
|
|||
* `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
|
||||
end of a trip how long it to you to get there. Default: false.
|
||||
end of a trip how long it took you to get there. Default: false.
|
||||
* `SpanshAttack.announceWaypoints` (boolean): whether to announce each waypoint
|
||||
of the neutron route. Default: true.
|
||||
* `SpanshAttack.announceJumpsLeft` (string): `;`-separated list of remaining
|
||||
|
|
|
|||
Binary file not shown.
Binary file not shown.
BIN
profiles/SealAttack-Profile.vap
Executable file
BIN
profiles/SealAttack-Profile.vap
Executable file
Binary file not shown.
Binary file not shown.
Loading…
Reference in a new issue