2022-07-09 00:42:57 +02:00
|
|
|
|
# YAVAPF – Yet Another VoiceAttack Plugin Framework
|
|
|
|
|
|
|
|
|
|
|
|
This is a framework for implementing VoiceAttack plugins. Simply put I had two
|
|
|
|
|
|
issues with the plugins I have been working on over the last couple years:
|
|
|
|
|
|
|
|
|
|
|
|
1. The plugin API is … functional, but not great. I want to provide one that is
|
|
|
|
|
|
more pleasant to work with.
|
|
|
|
|
|
2. I have noticed that I keep re-implementing certain things for each and every
|
|
|
|
|
|
plugin that I write. For example, every single one of them wants to log to
|
|
|
|
|
|
VoiceAttack’s event log. A shared framework means writing the code once.
|
|
|
|
|
|
|
|
|
|
|
|
The goal is to get you up & running with as little code and as little knowledge of
|
|
|
|
|
|
the inner workings of VoiceAttack as possible.
|
|
|
|
|
|
|
|
|
|
|
|
## Documentation & Installation Guide
|
|
|
|
|
|
|
|
|
|
|
|
You can find [comprehensive documentation on Github
|
|
|
|
|
|
Pages](https://alterNERDtive.github.io/YAVAPF).
|
|
|
|
|
|
|
|
|
|
|
|
Or at least you will once this is in a presentable state and I have actually
|
|
|
|
|
|
written the documentation :)
|
|
|
|
|
|
|
|
|
|
|
|
There is also an [example plugin on
|
|
|
|
|
|
Github](https://github.com/alterNERDtive/YAVAPF/tree/release/ExamplePlugin).
|
|
|
|
|
|
|
|
|
|
|
|
## Need Help / Want to Contribute?
|
|
|
|
|
|
|
|
|
|
|
|
Have a look at [the troubleshooting
|
|
|
|
|
|
guide](https://alterNERDtive.github.io/YAVAPF/troubleshooting). If your problem
|
|
|
|
|
|
persists, please [file an
|
|
|
|
|
|
issue](https://github.com/alterNERDtive/YAVAPF/issues/new). Thanks! :)
|
|
|
|
|
|
|
|
|
|
|
|
You can also [say “Hi” on Discord](https://discord.gg/3pWdJwfJc5) if that is
|
|
|
|
|
|
your thing.
|
2022-07-05 00:19:04 +02:00
|
|
|
|
|
|
|
|
|
|
[](https://github.com/sponsors/alterNERDtive)
|
|
|
|
|
|
[](https://ko-fi.com/S6S1DLYBS)
|
