botboy434 / att-voodoo

A community-made magic mod for A Township Tale, a VR MMORPG game.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Voodoo Logo

Voodoo โ€” Magic mod for A Township Tale

CodeQL contributor covenant v2.0 adopted


๐Ÿ”ฎ What is Voodoo?

Voodoo is a community-made magic mod for A Township Tale, a VR MMORPG game.

Voodoo consists of a Voodoo Client application (the repository you're looking at right now), Voodoo Server, and a hidden Voodoo Spellbook.

Voodoo Client is a speech recognition application for A Township Tale that lets you invoke magic spells with your voice on game servers that support Voodoo.

Voodoo Server is our bot that listens to all the Voodoo Clients out there and sends console commands to the servers they are playing on.

Voodoo Spellbook is a hidden repository that Voodoo Server uses to compare a list of spells to what players are invoking. Because the Spellbook is hidden, players need to discover the right combination of incantations and material components for each spell on their own!

โš ๏ธ Known issues

  • Voodoo sometimes doesn't connect to a server even when that server has just invited Voodoo Mod. This happens because sometimes the Alta API does not inform the bot of new invites, or otherwise prevents the bot from connecting to the newly added server. When this happens you must wait ~24 hours until Voodoo Mod restarts automatically. When restarting, Voodoo Mod re-accepts all server invites and your server should start working.
  • Voodoo can say "Not near a Spellcrafting Conduit" even when you're standing next to a green crystal cluster. When this happens it means the ATT server's select find <player> command has broken and the server needs to be restarted. Joel is aware of this bug.
  • Acid Bolt rarely connects with players or enemies. This doesn't appear to be a bug with Voodoo, as the mod doesn't change any wyrm spit properties.
  • After acquiring a session in Voodoo, the app can sometimes jump back to the Ready! screen and get stuck here. We're currently still investigating what is causing this.
    Work-around: restart Voodoo.

๐Ÿš€ Installation & usage

Frequently Asked Questions

Why is Voodoo not authenticating? It's stuck.

Make sure your system time is correct. Voodoo validates tokens retrieved from Alta and it compares the token's expiration date with your system time.

I can't awaken Voodoo. Why is it not picking up my voice?

Voodoo currently relies on Windows speech recognition which uses Windows language packs. Make sure you have English (United States) configured as one of your Windows languages. To configure your Windows languages:

  1. Go to Windows Settings.
  2. Click the Time & Language tile.
  3. Click the Language tab.
  4. In the Preferred Languages section, add English (United States).
  5. Restart Voodoo.

If Voodoo is still not picking up your voice, you must make sure that your Default Input Device is set to the microphone you're using before you start Voodoo:

How to set your default input device

Why has Voodoo misheard what I said?

Speech recognition is tricky. Your accent might play a role as well (I'm not a native English speaker myself and it doesn't always correctly recognise what I said). The good news is, Windows speech recognition can be trained. Search online for ideas on how to train your speech recognition to more accurately understand the way you speak English.

๐ŸŽฉ Special thanks

Poi

Poi's work unraveling the mysteries of A Township Tale's save strings was instrumental in building Voodoo. Poi didn't directly work on Voodoo, but Voodoo would not exist without his help. Thank you for sharing your secrets!

CJ (Siege)

CJ's mountain of experience with speech recognition helped shape the way you interact with Voodoo. His knowledge has informed the best way to deal with voice commands and how to handle or work around false positives.

Maintainers

Contributing

For bug fixes, documentation changes, and small features:

  1. Fork this repository.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create a new Pull Request.

For larger new features: Do everything as above, but first also make contact with the project maintainers to be sure your change fits with the project direction and you won't be wasting effort going in the wrong direction.

About

A community-made magic mod for A Township Tale, a VR MMORPG game.

License:MIT License


Languages

Language:TypeScript 70.6%Language:CSS 21.8%Language:C# 4.3%Language:JavaScript 3.0%Language:HTML 0.3%