art-from-the-machine / Mantella

Mantella is a Skyrim and Fallout 4 mod which allows you to naturally speak to NPCs using Whisper (speech-to-text), LLMs (text generation), and Piper / xVASynth / XTTS (text-to-speech).
https://art-from-the-machine.github.io/Mantella/
GNU Affero General Public License v3.0
191 stars 50 forks source link
fallout llms python skyrim voice-recognition whisper xttsv2

Mantella Mantella Nexus Mods link

Mantella logo

Bring Skyrim and Fallout 4 NPCs to life with AI

Mantella is a Skyrim and Fallout 4 mod which allows you to naturally speak to NPCs using Whisper (speech-to-text), LLMs (text generation), and xVASynth / XTTS (text-to-speech).

Click below or here to see the full trailer:

<img src="./img/mantella_trailer.gif" alt="Mantella trailer link" width="auto" height="220"/>

Installation

See art-from-the-machine.github.io/Mantella

Issues Q&A

See art-from-the-machine.github.io/Mantella/pages/issues_qna.html

Skyrim

See art-from-the-machine.github.io/Mantella/pages/installation.html#skyrim

Contribute

The source code for Mantella is included in this repo. Please note that this development version of Mantella is prone to error and is not recommended for general use. See here for the latest stable release.

Here are the quick steps to get set up:

  1. Clone the repo to your machine
  2. Create a virtual environment via py -3.11 -m venv MantellaEnv in your console (Mantella requires Python 3.11)
  3. Start the environment in your console (.\MantellaEnv\Scripts\Activate)
  4. Install the required packages via pip install -r requirements.txt
  5. Create a file called GPT_SECRET_KEY.txt and paste your secret key in this file
  6. Set up your paths / any other required settings in the config.ini
  7. Run Mantella via main.py in the parent directory

If you have any trouble in getting the repo set up, please reach out on Discord!

Related repos:

Updates made on one repo are often intertwined with the other, so it is best to ensure you have the latest versions of each when developing.

The source files for the Mantella docs are stored in the gh-pages branch.

Attributions

Mantella uses material from the "Skyrim: Characters" articles on the Elder Scrolls wiki at Fandom and is licensed under the Creative Commons Attribution-Share Alike License.