AI Follower Framework (AI-FF) allows you to make ANY NPC an AI.
THE FOCUS OF THIS MOD IS MEANINGFUL INTERACTIONS WITH AI FOLLOWERS!
This mod is designed for the most immersive experience possible with your AI party members.
Though you can still have cool conversations with all other NPC's.
👨👩🐴ANY NPC CAN BE AN AI
You can make ANY NPC an AI by using pressing the "Activate AI" hotkey (MCM to configure it).
Once activated you will be able to interact with them either with your voice or a chat-box.
It will work with ANY NPC: vanilla, modded and even horses!
All vanilla NPC's already have preset character biographies (Credit to Shawn/Kakarrot &TomahawkJackson).
Each NPC can be individually customized with different personalities, voices and AI models to fine tune them to your liking.
If you have multiple AI NPC's activated (there is no upper limit) they will converse with each other in group conversations naturally.
They will argue, plan, pass judgement and even flirt amongst themselves without direct player interaction.
There is an infinite amount of conversations that are possible. This is the ultimate party banter tool!
🎭🧠DYNAMIC PERSONALITIESAND MEMORIES
Dynamic Personalities: Their personality biography can be auto-updated through in-game events, such as sleeping. The character bio will change depending on the previous interactions they had with the player and the world around them.Example:
* Relation with RANGROO: Jenassa respects RANGROO's growing strength and tactical insight, viewing him as a wise partner. Their bond deepens through shared battles, with her encouraging him to embrace his potential while showcasing her own prowess. She playfully challenges him and expresses pride in his progress, urging him for direction while maintaining her competitive spirit. Jenassa appreciates his leadership and enjoys their camaraderie, often engaging in banter while navigating challenges together, reflecting a balance of respect and excitement in their adventures.* Likes: Combat, gold, strength, tactical acumen, excitement; enjoys the thrill of facing foes, especially bandits. Recently, she has shown interest in home decoration, indicating a potential appreciation for the fruits of their labor beyond combat. She relishes the idea of adventure and is eager for the next challenge.
* Fears: Undead foes, confined spaces, being alone in danger; particularly averse to the undead as significant threats. She fears being caught off guard or unprepared in dangerous situations, which can undermine her confidence and sense of security.
* Dislikes: Daydreaming, distractions from combat, bandits; prefers focusing on immediate threats and despises frivolous thoughts during missions. She expresses disdain for anyone who underestimates their enemies or detracts from their goals.
Long-Term Memories: Each AI NPC will have their conversations and interactions they have participated in saved to a "PSQL Long-Term Memory Vector Database". This allows them to recall specific events and conversations hours laterand will affect how they interact with the player.Example:
- I used a crossbow to kill a mudcrab.
- My companion, Herika, made a comment saying "Another one bites the dust, eh Rangy? (My name is RANGROO) That mudcrab met a shell-shocking end!"
- I tell her "Is that my new nickname? Rangy?".
- She says "Well, I could call you Swamp Breath if your prefer" (I am an
Farm-ToolArgonian) - I relent and move on with the adventure.
- For the next few hours of gameplay should we keep referring to me as "Rangy" instead of "RANGROO".
- This was due to the long-term memory system implanting memories of her calling me "Rangy" instead of "RANGROO", so that was my new name ¯\_(ツ)_/¯
🌎INDEPTH WORLD AWARENESS Command List: TTS = Text-to-Speech (AI Voice) Offline Services included in DwemerDistro Offline Services installed separately What we Recommend Easiest Setup: On a budget or low-end PC's: High End PC's for running everything locally:
What the AI Tracks:
👉ACTION COMMANDS
Through natural conversation the AI will trigger in-game actions, whether directly initiated by the player or on their own accord.
📚AI NARRATOR
We have added an AI narrator who will always be present.
Though you can turn them off if you want.They will narrate your adventures, recap what has previously happened and offer help with your current tasks.
You can also skip through dialogue and have the Narrator summarize it!
Like with all other AI NPC's, you can fully customize their personality and voice.If you are alone with no AI NPC's every time you speak the narrator will respond.
Otherwise, start any sentence with "Hey Narrator".
📃EVERYTHING ELSE
Yes!
Why are there 2 files to download?
1)DwemerDistro3is a WSL2 virtual machine that can run on most windows computers.
It acts as the "AI Brain" for the entire mod. It runs in the background while you play Skyrim.
2)AIAgent is installed normally like any other Skyrim Mod.What AI services and programs are supported?
A LOT! Here is a list of what is currently supported and what we recommend:
STT = Speech-to-Text (How you speak to the AI with your voice)
LLM = Large Language Model (AI generation brain)
ITT = Image-to-Text (Soulgaze feature, view the game visually)
Online Services
NEVER SHARE YOUR API KEYS WITH ANYONE! (TTS, STT, LLM, ITT)Highly Recommended! (Yes it is heavily moderated but is very easy for basic setup)
OpenRouter (LLM)Highly Recommended!(Less moderated and has some very cheap AI models)
Azure (TTS, STT)
ElevenLabs (TTS) (Great voice quality but very expensive)
Deepgram (STT, TTS)
XTTSv2 Fast-API (TTS) [4GB VRAM] Highly Recommended!(Allows for easy voice setup for every NPC!)
Mimic3 (TTS) [Very little memory usage!]Highly Recommended!
Llama Llava (ITT) [4GB VRAM]
KoboldCPP
XTTS Mantella(TTS)[4GB VRAM]
Most Users:
STT = Deepgram or OpenAI
TTS = XTTSv2 Fast-API
ITT = OpenAI or None
STT = OpenAI
TTS = OpenAI
ITT = OpenAI
STT = OpenAI or none (can use chat-box to talk)
TTS = Mimic3
ITT = None
STT = LocalWhisper
TTS = XTTSv2 Fast-API or XTTS Mantella
ITT = Llama LlavaFor specific AI models the mod requires "instruct" style models to function.
(Any ChatGPT models or a lot of HuggingFace models with the word "instruct" in the title)
Here is a table of compatible modelsCompatibility?
This mod is compatible with 99.99% other mods. Most of the AI scripting is noninvasive.
Does not require new saves, can be uninstalled whenever.
We highly recommend you useNether's Follower FrameworkOther recommended mods:
Subtitles
To Your Face
How does this even work?
This is an older video but its still covers the fundamentals:
AI-FF User Manual🚨If you have issues with installation and need help, then join our Discord and ask for help in the "i-have-a-problem" channel!
Installing DwemerDistro3
- Download 1)DwemerDistro3 file in the downloads page.
- Unzip it on your computer (somewhere you wont forget!)
- Ensure you have virtualization enabled in your PC BIOS menu(Here is a good guide if you are having issues).
- Ensure you have “Virtual Machine Platform” and “Windows Subsystem for Linux” enabled in “Turn windows features on or off”
- Open the Command Prompt as adminand enter this command: wsl --update (This is to update to WSL2)
- In the DwemerDistro3folder you unzipped run the Install.batfile.
- After it has been installed, open the Toolsfolder and click Update.bat (password is dwemer)
Optional Components:
Under Tools/componentsyou can addadditional components to the DwemerDistro:
- Run CompactDistro.bat to compress the Distro further to save more hard drive space.
- Once you have installed the components you want openRun.bat. (We recommend you make this a shortcut and place on your desktop)
- A web browser interface should open withthe AI-FF server home page.
- In the web interface click Configuration - Configuration Wizard
Configuration Wizard Profile Considerations:
Setup your configuration wizard with your AI/LLM, TTS, STT ITT, etc services of choice.
Make sure you have your API keys handy for any online services you wish to use. They are required for those services to connect and work!
Use the What AI services and programs are supported?in the FAQ section above to help you pick what's best for your setup!Some Suggestions:
- Enable Minime-T5 if you installed it as an optional component from above.
- Enable Long Term Memory. Allows AI NPC's to remember events.
- OpenRouter is a good and easy LLM service to use.
- OpenAI has a good cheap STT service.
- XTTS is fantastic for TTS, highly recommend to install it as an optional component.
- Under Troubleshootingin the web interface, run the connection tests to verify you have setup everything properly.
- STT will use your computer's default configured microphone. Make sure to verify your default microphone settings in Windows!
Skyrim Mod Setup
DOWNLOAD AND INSTALL THESE REQUIRED MODS!
Address Library for SKSE Plugins
ConsoleUtilSSE NG
PapyrusUtil SE - Modders Scripting Utility Functions
powerofthree's Papyrus Extender
SkyUI
UIExtensions
(It will say its an unsecure file as you have downloaded it from a local web server but it is 100% safe!)
In-game Setup
🎉Well done, you have the mod installed! 🎉
Highly recommend to read the AI-FF Manual.
