z-waif

Fully local & open source AI Waifu. VTube Studio, Discord, Minecraft, custom made RAG (long term memory), alarm, and plenty more! Has a WebUI and hotkey shortcuts. All software is free (or extremely cheap)!

Requires Windows 10/11 and a CUDA (NVidia) GPU with atleast 11GB+ of video memory. 16GB is recommended. Uses Oobabooga, RVC, and Whisper to run AI systems locally. Works as a front end to tie many programs together into one cohesive whole.

The goal of the project is less about giving an "all in one package", and moreso to give you the tools and knowledge for you to create your own AI Waifu!

Features

• 🎙️ Quality Conversation       ( /・0・)

  • Speak back and forth, using Whisper text to speech.
  • Configure your own waifu's voice with thousands of possible models.
  • Imperial-tons of quality of life tweaks.

• 🍄 Vtuber Integration         ღゝ◡╹ )ノ♡

  • Uses VTube Studio, and any compatible models!
  • Ability to send emotes to the model, based on their actions.
  • Idle / Speaking animation.

• 💾 Enhanced Memory           (ー_ーゞ

  • Add Lorebook entries, for your waifu to remember a wide array of info as needed.
  • Enable the custom RAG, giving your them knowledge of older conversations.
    • Import old logs and conversations, keeping your same AI waifu from another software!

• 🎮 Modularity               ⌌⌈ ╹므╹⌉⌏

  • Enable various built in modules;
    • Discord, for messaging.
    • Vision, to enable multimodal, and allow them to see!
    • Alarm, so your waifu can wake you up in the morning.
    • Minecraft, allowing your waifu to control the game using Baritone, Wurst, and other command based mods.
  • All the options and modularity from any external software used. Oobabogoa, RVC Voice, ect.
  • Open-source, meaning you can edit it as you please.

YouTube Showcase

Install & Links

Here is some documentation that you can look at. It will show you how to install, how to use the program, and what options you have. Please also take a look at the Youtube videos for the install.

If you need help / assistance, please submit a GitHub issue, or feel free to email me for this project at [email protected]

Diaspora

The Original:

TumblerWarren/Virtual_Avatar_ChatBot, this is the original project that this code is spun-off of. Full credit to that project - it provided the skeleton for the many advancements now in place. It has more of a focus on non-local AI, if that is what you need.

Branches & Versions:

Drakkadakka/z-waif-experimental-, offers a few upgrades; namely Twitch chat & streaming support, as well as a few other enhancements.

Recent Changelog

v1.7

• Hangout Mode

  • Like a very advanced autochat.
  • Your waifu decides how to reply to messages, based on hardcoded presets.
    • They may wait, see if any more input comes, and then reply
    • They may reply right away
    • They may use the camera
    • In the future they could also think on their own and decide how to reply
  • You can configure their reply personality to change how they reply, or how engaged they are.
  • Certain words phrases "think about" or "ponder" will cause them to think more.
    • Words are configurable under "Configurables/Hangout"
  • Certain words phrases "look at this" or "camera" will cause them to use the vision, if enabled.
    • Words are configurable under "Configurables/Hangout"
  • By default, you can interrupt them by saying "Wait, " and then their name.
    • Can eat up resources, as this also uses whisper. Toggleable in the Configurables.

• The chat logs now have an automatic backup, named "LiveLogBackup.bak".

  • Simply rename the file to "LiveLog.json" to restore.
  • Backs it up upon every time the program is started.
  • Includes a failsafe measure to not back the files up if the history gets cleared.
  • Of course, backing up logs in additional methods (to a flash drive, or other PC) is always advised.

• The RAG database now has a progress bar when first calculating it.

• Further enhanced the Autochat volume listener to better handle different sensitivities.

• Fixed an issue where streamed camera chats would appear in the log twice.

To-Do

📶 Enhancements

• Make the RAG/Long Term Memory be multiprocessed for better performance
• Make the LLM input and TTS output streaming, to lower the "processing time"
• Figure out how to load LLAMA 3.2 Vision, for better multimodal, and no needed loader

🤖 Improvements

• Give internal dialoguing for chain of thought / reasoning
• Emotional / Tone understanding
• Automatic gaming & real world interaction
• Use an integrated voice generation system, with the ability to modify the tone
• Long term experience-based summarizations of ideas and history (pull form experience)

🦄 Imperium

• Create more Youtube tutorials and other related content
• Look more into optimal LLMs and configs
• Set up better Git and contribution methods
• Create a way for users to auto-update the program without having to hack files together
• Evangelize AI Waifus to the world!

State of Development

The project could be considered in an "early access state". Some parts may be mildly buggy, janky, or obtuse. The project as a whole, however, is stable and reasonably effective.

The goal of the project is pretty simple; make AI waifus. The extents of this project are intended to stay within the bounds of helping people create a singular, locally hosted AI waifu, who's partnership can benefit both you and them. In short, symbiosis.