# GirlfriendGPT - Your personal AI companion

This is a starter project to help you build your personalized AI companion with a unique personality, voice, and even SELFIES!

## Deprication warning. 

This repository is no longer actively maintained. 

## Demo
Click the image below for a demo:

[![Demo Video](http://img.youtube.com/vi/LiN3D1QZGQw/0.jpg)](http://www.youtube.com/watch?v=LiN3D1QZGQw "Video Title")

## Features

* Custom Voice: Utilize EleventLabs to create a unique voice for your AI model.
* Connected to Telegram: Directly send and receive messages from your AI companion via Telegram.
* Personality: Customize the AI's personality according to your preferences.
* Selfies: AI is capable of generating SELFIES when asked.

## Getting started 

To run your companion locally:

```
pip install -r requirements.txt
ship serve local
```

To deploy your companion & connect it to Telegram:

```
pip install steamship
ship serve remote
```

You will need to fetch a Telegram key to connect your companion to Telegram. [This guide](/docs/register-telegram-bot.md) will show you how.


## Roadmap
* Memories: Soon, the AI will have the capability to remember past interactions, improving conversational context and depth.
* Photorealistic selfies

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

<details>
  <summary>👀 Add a personality!</summary>
  <br>
Do you have a unique personality in mind for our AI model, GirlfriendGPT? Great! Here's a step-by-step guide on how to add it.

## Step 1: Define Your Personality
First, you'll need to define your personality. This is done by creating a new Python file in the src/personalities directory.

For example, if your personality is named "jane", you would create a file called `jane.json`. Inside this file, you would define the characteristics and behaviors that embody "jane". This could include her speaking style, responses to certain inputs, or any other defining features you envision.

## Step 2: Test and Submit

Before you submit your new personality, please test it to ensure everything works as expected. If all is well, submit a Pull Request with your changes, and be sure to include the title "{name} - {description}" where {name} is your personality's name, and {description} is a brief explanation of the personality.

Good luck, and we can't wait to meet your new GirlfriendGPT personality!
</details>





## License
This project is licensed under the MIT License.