# 🌟 Soul of Waifu

<div>
  
  ## Make your dream a reality and talk with your waifu!
  
  <img align="left" src="https://github.com/jofizcd/Soul-of-Waifu/blob/main/banner.jpg" alt="Banner" style="width:479px;"/>
  
</div>

<p align="justify">
👉 Soul of Waifu allows you to create your own AI Waifu and communicate with it using your voice. The program features the following Text-To-Speech technologies: CharacterAI, SileroTTS and ElevenLabs. Give the project a star if you liked it and if there are any problems or have any ideas to add to the program, I look forward to seeing you on my Discord server. Enjoy using it!
</p>

-----------------------------------------------------
<p align="justify">
👉 Soul of Waifu позволяет создать свою ИИ-Вайфу и общаться с ней с помощью голоса, взаимодействуя через современный GUI. В программе представлены следующие технологии Text-To-Speech: CharacterAI, SileroTTS и ElevenLabs. Ставь проекту звезду, если понравилось и если возникли какие-либо проблемы или есть какие-либо идеи, которые могли бы дополнить программу, то жду вас в своем Discord-сервере. Приятного пользования!
</p>
  
## 🧠 | Features / Функции

<div align="center"><img src="https://github.com/jofizcd/Soul-of-Waifu/blob/main/preview.jpg" style="width: 450px;"/></div>

<p align="justify">
  
 - Soul of Waifu allows you to communicate with your character from the Character AI website using Speech-To-Speech technology, but there is a text-based option in the program as well.
 - There are three Text-To-Speech variants available in the program: From Character AI website, voicing from SileroTTS and ElevenLabs.
 - It is possible to connect your live2d model and communicate with your character's avatar.
 - Modern GUI allows you to use the program much easier and more comfortable.
</p>

-----------------------------------------------------
<p align="justify">
  
- Soul of Waifu позволяет общаться с персонажем с сайта Character AI с помощью технологии Speech-To-Speech, но и текстовый вариант в программе присутствует.
- В программе доступно три варианта озвучки Text-To-Speech: с сайта Character AI, от SileroTTS и ElevenLabs.
- Есть возможность подключить свою live2d модель и общаться уже с аватаром вашего персонажа.
- Современный GUI позволяет пользоваться программой намного проще и комфортнее.
</p>

## 👨🏻‍💻 | How to run / Как запустить
<p align="justify">
  
1) Go to "Releases" and under the latest version of the program click on "Soul-Of-Waifu.zip" to start downloading the program;
2) Unzip the folder from the archive to any convenient place for you;
3) Make sure you have Python 3.10+ version installed;
4) In the folder, run the installer file. Choose depending on your operating system. On Windows systems the file is "installer.bat" and on Linux "installer.sh". Subsequently, run the program through the file named "start".
5) In the settings tab you will need to insert the API Token from the Character AI website. To do this, select "Get API-Token from Character AI" in the top menu and enter your email in the input field, after which an email will be sent to your mail. Copy the link from there and paste it into the input field in the program. Next, you will see your API Token, which you can save and paste into the special token entry field in the settings.

📌 Requirements:
- Python 3.10+
- Run the installer to load all the necessary libraries for the program to work;
- Character AI API key;
- ElevenLabs API key.

❗️ Optional:
- You can go [here](https://github.com/pkhungurn/talking-head-anime-3-demo) and make a character model so you can talk to her later;
- You can [download](https://olmewe.itch.io/veadotube-mini) a program to make a vtuber model for your AI character.
</p>

-----------------------------------------------------
<p align="justify">

  1) Зайти в "Releases" и под последней версией программы нажать на "Soul-Of-Waifu.zip", чтобы начать загрузку программы;
  2) Распаковать папку с архива в любое удобное для вас место;
  3) Убедитесь, что у вас установлен Python 3.10+ версии;
  4) В папке запустить файл installer. Выбирайте в зависимости от вашей операционной системы. На системах Windows файл "installer.bat", а на Linux "installer.sh". В последующем запускайте программу через файл с названием "start".
  5) Во вкладке настроек вам нужно будет вставить API-Токен от сайта Character AI. Для этого в верхнем меню выберите "Получить API-токен с Character AI" и вводите в поле для ввода вашу электронную почту, после чего на почту придет письмо. Скопируйте ссылку оттуда и вставьте в поле ввода в программе. Далее, вы увидите ваш API-Токен, который вы можете сохранить и вставить в специальное поле для ввода токена в настройках.

📌 Требования:
- Python 3.10+
- Запустить файл установщика, чтобы установить все необходимые библиотеки для стабильной работы программы;
- API-токен Character AI;
- API-ключ ElevenLabs;

❗️ Дополнительно:
- Ты можешь перейти [сюда](https://github.com/pkhungurn/talking-head-anime-3-demo) создать картинку персонажа для общения;
- Ты можешь [скачать](https://olmewe.itch.io/veadotube-mini) программу, чтобы создать анимированную модель для персонажа из созданной ранее картинки.
</p>

## 👀 | Help with program / Помощь с программой
<p align="justify">If you liked Soul of Waifu and want to support the author of the project, please give this repository a star. I will be very grateful to you. Also, if you have any problems with the program or have ideas and suggestions that you can try to implement in Soul of Waifu, I am waiting for you in my Discord-server, where there are as many fans of artificial intelligence as you! Link: https://discord.gg/waytojofistar</p>

---------------------------------------------------
<p align="justify">Если вам понравилась программа Soul of Waifu и вы хотите поддержать автора проекта, то прошу вас поставить звезду данному репозиторию. Я буду вам очень признателен. Также, если у вас возникли какие-либо проблемы в работе программы или же у вас есть идеи и предложения, которые можно попробовать реализовать в Soul of Waifu, то я жду вас в своём Discord-сервере, на котором находятся такие же любители искусственного интеллекта как и вы! Ссылка: https://discord.gg/waytojofistar</p>


