YapYapLanguageAPI

BepInEx plugin for YAPYAP that adds custom Vosk speech recognition languages and command grammars.

Installation

1. Install BepInEx for YAPYAP.
2. Put YapYapLanguageAPI.dll in BepInEx/plugins/.
3. Install or create your language addon of choice

Or use your preferred mod manager

Adding a Language

Two things are enough:

1. Vosk model — Put the model folder in Models/ (e.g. Models/vosk-model-small-nl-0.22/).
2. Localisation file — Put a text file in Localisation/ (e.g. Localisation/dutch.txt).

Then add an entry for that language in languages.json (see below).

example

if you need a boilerplate project you can look at this github page for an example of how to implement you own language Copy that setup and adapt filenames and content for your language.

Localisation format

One line per command:

KEY :: word1-word2-word3

Example (Dutch):

SPELL_ARC_BLINK :: FLITS
SPELL_ARC_SWAP :: WISSEL

languages.json

Example entry:

{
  "languages": [
    {
      "id": "dutch",
      "displayName": "Nederlands (Community)",
      "systemLanguage": "Dutch",
      "modelFolder": "Models/vosk-model-small-nl-0.22",
      "localisationFile": "Localisation/dutch.txt",
      "fallback": "english"
    }
  ]
}

• id — lowercase identifier
• displayName — name in the in-game language menu
• systemLanguage — Unity SystemLanguage value
• modelFolder — path to the model folder under plugins/
• localisationFile — path to the .txt under plugins/
• fallback — language id used if loading fails

License

MIT — see LICENSE.