Mantella for FO4 and FO4 VR - NPCs Redefined (2024)

  • Description
  • Files2
  • Images10
  • Videos6
  • Posts207
  • Logs
  • Stats

Current section

  • Viewing:

About this mod

Mantella has arrived to Fallout4 desktop & VR! Mantella allows you to have actual conversations with NPCs using your voice or text input by using Whisper for speech-to-text, LLMs (ChatGPT, Llama, etc) for text generation, and xVASynth & XTTS for text-to-speech. NPCs have memories of your past conversations and are aware of in-game events.

Requirements
Permissions and credits
Changelogs

See the trailer:

See Mantella in action:

Installation
The most up-to-date instructions to download the mod can be found here:art-from-the-machine.github.io/Mantella

How to start conversations
  • You will obtain automatically the gun and holotape after loading as long as you're past the first Vault.
  • You can edit the config.ini file to change the value of 'microphone_enabled = ' : '1' will make Mantella Software use the microphone, '0' will make Mantella use text input instead (desktop only, default key is "H")
  • Shoot a NPC with the Mantella gun to initiate a Mantella conversation using AI. Alternatively you can use the alternate activation option (should be present on all actors by default) or the hotkey (desktop only, default key is "H").
  • End the conversation by saying or typing goodbye depending on if the microphone is enabled.
  • You can shoot additional NPCs to have multiple NPCs in the conversation at once.
  • You can craft the gun and holotape at the chem station if you lose them or did not get them for some reason.

How to use the game event key

  • During a conversation, press the "Y" key to add to type a text event in the game (e.g. "Piper heard a gunshot"). It's best to use a third person perspective to mesh with the game events that are automatically sent to the NPCs. You can do this multiple times in a row.
  • When you actually reply to the NPC, either by speaking in the mic or by typing a reply (default "H" key), all the game events will be sent along the reply to the AI. Note : the game event log will get cleared at the start of a new conversation and can only store up to 5 events at a time. After 5 events newer events will override the the older ones.


Recommended mod(s)

  • The default in-game dialogue will interrupt Mantella's dialogue, you can use a mod like No NPC Greetings to prevent NPCs from interrupting your conversations.
Key Features

  • Interact with every NPC, including modded NPCs
  • 600+ NPCs have been given their own unique background descriptions
  • Support for local, OpenAI, and OpenRouter language models
  • XTTS support for voice generation in addition to XVASynth
  • Partial compatibilitywith multiple languages. Meaning : all 3.0 XVASynth voice models are compatible with multiple languages but older models aren't.
  • NPCs remember past conversations with you
  • NPCs are aware of in-game info such as their location, the current time, picking up and equipping items, sleeping, taking regular or radiation damage, entering power armors, being given commands or settlement assignments.
  • NPCs can start conversations with each other (Radiant Dialogue)
  • Can have a conversation with two NPCs at once (don't recommend going above that for now)
  • Fully playable in desktop or VR (make sure to download the appropriate mod)
  • (experimental) NPCs can be convinced to follow your commands, or may attack you if you offend them


FAQ

Can I use Mantella with text input?
Absolutely. You have to disable to disable the microphone in the config.ini (see installation docs, link above) then press "H" in-game to respond to NPCs (desktop only).

Can I use Mantella with VR or desktop?
Yes it's compatible with both. Make sure to download the right mod.

How much does it cost to run Mantella?
At a minimum, nothing. If your hardware is strong enough to support running local language models you can run completely offline for free. If you would prefer to outsource this processing externally, you can also use OpenAI or OpenRouter:

OpenAI: The OpenAI API (note: not ChatGPT Plus!) is billed on a monthly basis (with the first $5 free) on a pay-per-use basis. So far the most I have spent in a single month of (part-time) development is $3.40. Some early adopters have reported up to $7 a month for heavy usage.

OpenRouter: The OpenRouter API is billed by using pre-paid credits (with the first $1 free). There are a number of language model to choose from, and there are often models available for free. See here for more details:https://openrouter.ai/docs#models

Are there high PC hardware requirements to run this?
External service minimum specs:
If your are using external LLM services like ChatGPT or Openrouter then the only requirements are running XVASynth and Whisper (if using Speech-to-text for microphone). XVASynth and Whisper can be run easily on most modern CPUs. My video showcases uses a AMD Ryzen 7 3700x with the external LLMs and I get between 2-4 seconds for response times.

Local minimum specs:
A local LLM will need a minimum 6 gb of free RAM & VRAM to run a basic role-playing capable LLM.

Local minimum specs:
XTTS Specs: Using XTTS will add another requirement of 2-4 gbs of RAM and VRAM.

What are the storage requirements for this mod?
XVASynth without models needs about 4 gb. XVASynth requires ~15GB of space when all xVASynth voice models are
installed (and 10 gb for temporary files that can be deleted after installing the voices). MantellaSoftware itself is 200 mbs but will need 1-5 gb of temporary files.

Does this work with local language models?
Yes.

Compatibility

  • WARS - Weapon Addition and Replacement Suite has been reported as a compatibility issue.
  • Fallout Mantella is compatible with Windows 10 / 11 (tested for both)
  • Quick Trade & What's Your Name will conflict with Mantella for the alternate activation option. You can use the holotape followed by [-> Main Settings -> Remove conversation activation option] to resolve the conflict.


Supported Languages

  • Arabic (Partial support)
  • Danish (Partial support)
  • Dutch (Partial support)
  • English (Full support)
  • Finnish (Partial support)
  • French (Partial support)
  • German (Partial support)
  • Greek (Partial support)
  • Hausa (Partial support)
  • Hungarian (Partial support)
  • Italian (Partial support)
  • Korean (Partial support)
  • Polish (Partial support)
  • Portuguese (Partial support)
  • Romanian (Partial support)
  • Russian (Partial support)
  • Spanish (Partial support)
  • Swahili (Partial support)
  • Swedish (Partial support)
  • Turkish (Partial support)
  • Ukrainian (Partial support)
  • Vietnamese (Partial support)
  • Yoruba (Partial support)

Credits


TommInfinite for SUP F4SE & SUP F4SE VR
Neanka for textinputmenu
kinggath for parts of the ListenerScript

Developers

  • Art from the Machine (thank you Art for Mantella itself and all of your support while making this Fallout 4 mod)


Issues

  • Lip sync might be end before the NPC is finished speaking.
  • resummarize_prompt in the config.ini file needs to be changed to mention "the Commonwealth" instead of "Skyrim"

Uninstallation
  • End all Mantella conversations in-game
  • Remove the Mantella spell using Vortex / Mod Organizer 2
  • Delete the MantellaSoftware folder (if you would like to save your data,
    please keep your MantellaSoftware/data/conversations folder somewhere
    safe)
  • Delete the _mantella_xxxx.txt text files from your Fallout 4 installation folder

Community
If you would like to stay up to date on the project or would like share your experiences (and issues!) please find the link to the Discord here:https://discord.gg/Q4BJAdtGUE
Swing by my youtube channel for Mantella video showcases.

Mantella for FO4 and FO4 VR - NPCs Redefined (2024)
Top Articles
Latest Posts
Recommended Articles
Article information

Author: Nathanial Hackett

Last Updated:

Views: 5929

Rating: 4.1 / 5 (72 voted)

Reviews: 95% of readers found this page helpful

Author information

Name: Nathanial Hackett

Birthday: 1997-10-09

Address: Apt. 935 264 Abshire Canyon, South Nerissachester, NM 01800

Phone: +9752624861224

Job: Forward Technology Assistant

Hobby: Listening to music, Shopping, Vacation, Baton twirling, Flower arranging, Blacksmithing, Do it yourself

Introduction: My name is Nathanial Hackett, I am a lovely, curious, smiling, lively, thoughtful, courageous, lively person who loves writing and wants to share my knowledge and understanding with you.