Installation tutorial

Installing the game

• Install git for your OS: https://git-scm.com/downloads
• Go to the Github project: https://github.com/Rubiksman78/RenAI-Chat
• Go to Releases and download:
  • RenAIChat-version-pc.zip if you are on Linux or Windows
  • RenAIChat-version-mac.zip if you are on MacOS
  • RenAIChat-version.zip from the Drive link
• Unzip RenAIChat-version-pc/mac.zip wherever you want

Setup the main script

• Unzip RenAIChat-version.zip at the location you want
• Download the Tortoise TTS models on this drive if you want to use it and put the two folders inside the zip in your folder C:/Users/YourName/.cache/
• Double click run.bat to launch the main.py and begin to play
• For customization things (voice,character json description,images), check the README

Explanation of the inputs:

• Game Path: the absolute path of where you put RenAI Chat, for example (C:/.../RenAIChat-1.0-pc). Only for windows, for other OS prefer to launch it yourself.
• Launch Yourself: No if you want RenAI Chat to open automatically, Yes if you prefer to launch it yourself after the message Waiting for connection... appears in terminal (don't need game_path in the latter)
• Use TTS: use speech generation with the chatbot
• TTS model: model used for voice cloning (YourTTS or Tortoise-TTS)
• Chat model: which model size you want to use for chatbot (see this page for more details about what size is appropriate for you), read next section to add models correctly
• Use Speech Recognition: enable recognition of your own voice to do speech to text when chatting
• Voice Sample(Tortoise): reference samples for Tortoise
• Voice Sample (YourTTS): reference voice for YourTTS
• Submit and play (no need to launch RenAI Chat yourself if you didn't use Launch Yourself)!

Update new versions

To update to versions, you'll just have to:

• Double click update.bat if there is a new version announced, you won't need to download the zip again thanks to this
• Download the latest RenAIChat-version-pc/mac.zip in `Releases.

Common notes

Your antivirus might block the execution of the bat files but it is a common issue. All the code is available here for transparency.