Kuebiko

<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->

<a name="readme-top"></a>

<!-- *** Thanks for checking out the Best-README-Template. If you have a suggestion *** that would make this better, please fork the repo and create a pull request *** or simply open an issue with the tag "enhancement". *** Don't forget to give the project a star! *** Thanks again! Now go create something AMAZING! :D --> <!-- PROJECT SHIELDS --> <!-- *** I'm using markdown "reference style" links for readability. *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). *** See the bottom of this document for the declaration of the reference variables *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. *** https://www.markdownguide.org/basic-syntax/#reference-style-links -->

<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/adi-panda/Kuebiko"> <img src="https://i.imgur.com/kgXfiBi.png" alt="Logo" width="200" height="200"> </a> <h3 align="center">Kuebiko</h3> WARNING: This doc is out of date, while it still applies to the legacy mode, I recommend using the Streamer.bot and Speaker.bot Mode instead. If needed a Tutorial will be added, however until then, there will be dragons. You will need to create a custom system prompt, it is recommended to read up on prompt engineering and trying out a lot. <p align="center"> A Twitch Chat Bot that reads twitch chat and creates a text to speech response using google could api and openai's GPT-3 text completion model. <br /> <a href="https://github.com/adi-panda/Kuebiko"><strong>Explore the docs »</strong></a> <br /> <br /> <a href="https://github.com/adi-panda/Kuebiko/">View Demo</a> · <a href="https://github.com/adi-panda/Kuebiko/issues">Report Bug</a> · <a href="https://github.com/adi-panda/Kuebiko/issues">Request Feature</a> </p> </div> <!-- TABLE OF CONTENTS --> <details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgments">Acknowledgments</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->

YouTube Videl Tutorial !OUTDATED!

This is a project to setup your very own VTuber AI similar to "Neuro-Sama".

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Built With

• Python

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- GETTING STARTED -->

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• VLC MUST BE DOWNLOADED ON YOUR COMPUTER

In order to install the prerequisites you will need to do:

• Install poetry

• poetry install
  

Installation

1. Get a OpenAI API Key at OpenAPIKey

2. Get a Twitch API Token at TwitchToken

3. Create a Google Cloud Project with TTS Service enabled and download JSON credentials file. GoogleCloud

4. Clone the repo

   git clone https://github.com/adi-panda/Kuebiko/
   

5. Add the Google Cloud JSON file into the project folder.

6. Rename .env.example to .env and enter API Keys:

   TWITCH_CHANNEL="You're Twitch Token"
   TWITCH_TOKEN="Your TWITCH Channel Name"
   OPENAI_API_KEY="Your OpenAI API Key"
   GOOGLE_JSON_PATH="Your Google Cloud JSON Path"
   BOT_NAME="Neuro-Sama"
   ELEVENLABS_APIKEY="Your ElevenLabs API Key"
   ELEVENLABS_VOICEID="Your ElevenLabs Voice Id"
   WEBSOCKET_URL="Your WebSocket Url"
   

7. Download VTube Studio and use VBAudio Cable to route audio coming from the program.

8. Add the following script into OBS CaptionsScript

9. Create a new text source for captions, and set it to read from a file, select the subtitle.txt file from the project folder.

10. In the script options put the name of you're text source.

11. Set the script in transform options to scale to inner bounds, and adjust the size of the captions.

12. Enjoy! For more details watch the attatched video.

13. IN ORDER TO CHANGE THE VOICE OF YOU'RE VTUBER you will need to change the following parameters in main.py Here is a list of supported voices

      voice = texttospeech.VoiceSelectionParams(
          language_code="en-GB",
          name= "en-GB-Wavenet-B",
          ssml_gender=texttospeech.SsmlVoiceGender.MALE,
      )
    

14. Run

    poetry run python main.py
    

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- USAGE EXAMPLES -->

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- ROADMAP -->

Roadmap

• [ ] Local LLama Support to remove the need for OpenAI and the associated restrictions

See the open issues for a full list of proposed features (and known issues).

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- CONTRIBUTING -->

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- LICENSE -->

License

Distributed under the MIT License.

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- CONTACT -->

Contact

@adi_panda - hello(aṭ)adipanda.me
@caesarlp - realcaesarlp(aṭ)gmail.com

Project Link: You are here

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- ACKNOWLEDGMENTS -->

Acknowledgments

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

Instructions

Repl