Giter VIP home page Giter VIP logo

voiceattack-profiles's Introduction

Elite Dangerous VoiceAttack Profiles

These are various profiles for VoiceAttack (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 Rats and Hull Seals work.

Each of the profiles is documented in docs/.

Available Profiles

  • EliteDangerous: My main Elite VA profile. Here be dragons; things may be heavily tailored towards how I play the game and may not apply to how you play it. Included for reference and as a baseline or inspiration to create your own stuff.
  • RatAttack: profile for interactions with the Fuel Rats’ IRC server.
  • SealAttack: profile for interactions with the Hull Seals’ IRC server. (VERY early alpha stage.)
  • SpanshAttack: profile to plot and follow trips along the neutron highway using spansh.
  • StreamAttack: profile for writing various things to files that can then be read by streaming software like OBS.

Requirements

  • VoiceAttack: absolutely required (duh).
  • bindED: required for EliteDangerous and SpanshAttack; makes anything involving hitting E:D key binds portable.
  • EDDI installed as a VoiceAttack plugin: required for EliteDangerous, SpanshAttack and Streamattack, optional for RatAttack and SealAttack. If you are already running EDDI and want to keep the default speech responder active, you will need to re-enable it in your profile after running the <profile>.startup command.
  • ED-NeutronRouter: required for SpanshAttack. Make sure to grab the pre-release 1.02 since 1.01 has a bug with a hardcoded 50 ly jump range.
  • elite-scripts: required for EliteDangerous, SpanshAttack and StreamAttack, recommended for RatAttack and SealAttack (included).

Additionally, you need to have keyboard binds setup at least as secondary bindings in Elite’s controls options. VA cannot “push” joystick buttons for you, it can only do keyboard inputs. Hence its only way to interact with Elite is through keyboard emulation, even if you otherwise play the game with a controller or HOTAS. Or racing wheel. Or Rock Band set. Or bananas.

Installing

Install the plugins listed in Requirements.

Download the profile package (alterNERDtive-voiceattack-profiles.vax) from the release page and import it as a profile into VoiceAttack. This will install all 3 profiles, the referenced sound files and the Python scripts.

Last but not least, if you want to use my setup as-is, you need to go into the profile options for the freshly imported EliteDangerous profile and import RatAttack and SpanshAttack.

You can also download the profiles individually from the profiles/ folder on github.

Updating

If you use the profiles unchanged or just import them and override commands from your main profile, updating should work just like installing: import the profile package and tell VoiceAttack to overwrite commands when prompted.

Major Version Changes

If a profile’s major version number changes (e.g. SpanshAttack 1.x.x to 2.0.0) there will be changes to the profile that do one or any amount of the following:

  • command names / command invocation have changed
  • configuration variable name or format have changed
  • features removed
  • major features added

If you see a major version number change in the release notes, please pay attention to said notes to know what you might have to change to get it to work!

Settings

Each profile has its respective startup command that should be launched upon loading the profile. If you include the profile in your own (see below) you have to manually call them for each included profile when yours is loaded.

Using a Profile

Import the profile into VA, check the startup command for any settings you might want to adjust, activate it, done.

Oh, and you probably might want to check the corresponding README first.

Including a Profile

If you are already using a custom profile (or want to use mine), you can include others by going to the profile options and adding them to the “Include commands form other profiles:” option.

VoiceAttack does not execute configured startup commands for included profiles. Hence, you’ll have to have your own profile have one that in turn runs the included profiles’ startup commands. While you are doing that, you might as well set all settings here, centrally. Main advantage is that you can just upgrade the included profiles to newer versions without losing your settings.

Because of limitations of VoiceAttack itself, only the first matching command found will be executed, including EDDI events. That means you have to check your profile against the imported ones for events they both handle. E.g. if you already have a ((EDDI Message sent)) handler in your profile, you have to run RatAttack.EDDI Message sent and SealAttack.EDDI Message sent from within it.

You also have to do that if you include multiple profiles using the same events (e.g. RatAttack + SealAttack), even if you don’t have the same event in the including profile! If you want to make sure, manually create all EDDI Event handlers used in imported profiles and have them call the corresponding commands. See the Elite Dangerous profile for reference.

Need Help / Want to Contribute?

If you run into any errors, please try running the profile in question on its own / get a fresh version. If that doesn’t fix the error, look at the devel branch and see if it’s fixed there already.

If you have no idea what I was saying in that last parargraph and / or the things mentioned there don’t fix your problem, please file an issue. Thanks! :)

You can also say “Hi” on Discord if that is your thing.

voiceattack-profiles's People

Contributors

alternerdtive avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.