AI powered visual novel. Uses LangChain with Groq API's llama3-8b for LLM text generation, Huggingface's diffusers library with the Dark Sushi Mix checkpoint for image generation, Pinecone RAG for character memory, and SQLite database for saves. Music was made with Suno. Runs locally, that is, your computer hosts the Flask server and the game runs as a web application in your browser.
Disclaimer: I'm not responsible for any of the AI generated content or the actions of any users.
- GPU for smooth gameplay
- Python (tested with version 3.12)
- Groq API key (free tier available)
- Pinecone API key (free tier available)
- Flask secret key: random string, or you can generate one in terminal with python -c 'import secrets; print(secrets.token_hex())'
Open a terminal in the folder you want to install it in and enter the following commands:
git clone https://github.com/lilyjge/Ruth.git
cd Ruth
python -m venv venv
.\venv\Scripts\activate
pip install -r requirements.txt
Make a file named .env in the Ruth folder to put your keys. It should look like this:
GROQ=...
PINECONE=...
FLASK=...
Alternatively, you can enter the keys in the terminal after running the program. You will only have to enter them once as they will be saved in a local database in the game directory.
Next, run app.py with the following:
python app.py
Wait for it to load and it should open a tab in your default browser with the game.
Remember to quit the program from the terminal when you want to close it.
Click the settings button on the webpage.
Observe the terminal output when app.py is ran. If the GPU is being used, "cuda" should be printed. If CPU is printed instead, run the following:
pip uninstall torch
Then go here to install the appropriate version of PyTorch for your system. You only need torch, not torchvision nor torchaudio.
For an AMD GPU on Windows, you can follow this example and modify a few lines in sd.py.
Be patient with it and don't click any buttons multiple times in a row. If a bug happens, reload the page or the program. Be warned the saving is not available until the introduction is done and when the ending begins.