YapYapLanguageAPI

Lightweight BepInEx plugin for YAPYAP that allows adding custom Vosk speech recognition languages and command grammars at runtime.

Features

• Extensible language support via Vosk Speech Recognition Toolkit
• Simple configuration through languages.json
• Seamless integration into the in-game voice language dropdown
• Flexible file structure for models and localisation

Installation

1. Install BepInEx for YAPYAP
   https://github.com/BepInEx/BepInEx

2. Download the latest release of YapYapLanguageAPI.dll from the GitHub releases page

3. Place YapYapLanguageAPI.dll in: YAPYAP/BepInEx/plugins/

4. Launch the game once to generate: languages.json
   Models/
   Localisation/

Directory Structure

After first launch:

BepInEx/plugins/ |-- YapYapLanguageAPI.dll |-- languages.json |-- Models/ |-- Localisation/

Models/ Place your Vosk model folders here.

Localisation/ Place your command grammar text files here.

languages.json Registers languages with the game.

Adding a New Language

Each language requires:

• A Vosk model folder
• A localisation file
• A languages.json entry

Example: Dutch

Vosk Model

Download or build a Dutch Vosk model and place it here:

BepInEx/plugins/Models/vosk-model-small-nl-0.22/

Localisation File

Create:

BepInEx/plugins/Localisation/dutch.txt

Format per line:

KEY :: word1 word2 word3

Example:

SPELL_ARC_ASTRAL_EYES :: ASTRALE-OGEN
SPELL_ARC_BLINK :: FLITS
SPELL_ARC_GRAB_ANA :: GRIJP-ANA
SPELL_ARC_LUX_ANA :: LICHT-ANA
SPELL_ARC_SWAP :: WISSEL

languages.json Example

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

Field Definitions

id
Unique lowercase identifier.

displayName
Name shown in the in-game settings menu.

systemLanguage
Unity SystemLanguage enum value.

modelFolder
Relative path to the Vosk model folder.

localisationFile
Relative path to the localisation text file.

fallback
Language id to fall back to if loading fails.

License

MIT License
See LICENSE.