Welcome to Meowgram, a Telegram client designed to seamlessly integrate with Cheshire Cat Ai.

Before you begin, make sure you have the following:

• Python >= 3.10
• A running instance of Cheshire Cat (version >= 1.8.0)
• Telegram API Hash
• A Telegram bot TOKEN, which you can get by creating a bot through BotFather

1. Log in to your Telegram account using the developer phone number.
2. Navigate to API Development Tools.
3. In the Create New Application window, fill in the App title and Short name.
4. Click Create Application. Your API Hash is secret—do not share it.

Follow these steps to get Meowgram up and running:

1. Clone the repository:

   git clone https://github.com/Pingdred/Meowgram.git

2. Navigate to the project directory:

   cd Meowgram

3. Install dependencies:

   pip install -r requirements.txt

4. Create a .env file and set the following parameters:

   API_ID = "API_ID"
   API_HASH = "API_HASH"
   BOT_TOKEN = "YOUR-BOT-TOKEN"
   
   CHESHIRE_CAT_URL = "localhost"
   CHESHIRE_CAT_PORT = 1865

   You can use the provided .env.example file as a template.

Important:
Ensure that your Cheshire Cat instance is running by following the quick start guide.

5. Run Meowgram:

   python src/main.py

Meowgram Connect is a plugin that enhances your chat experience with additional customization options, such as buttons for forms.

You can find Meowgram Connect in the plugin registry and install it directly from the Cheshire Cat Admin interface under the Plugins tab.

Meowgram supports the media features introduced in Cheshire Cat 1.8.0. Each plugin that utilizes these features is compatible with Meowgram to manage images and audio.

To send voice notes via Meowgram, you need a Speech-to-Text (STT) plugin. Currently, the following plugins are supported:

• Whispering Cat This plugin enables speech-to-text functionality, allowing you to dictate messages seamlessly.

To receive voice notes, you need a Text-to-Speech (TTS) plugin. The following plugin is currently supported:

• TTS powered by OpenAI This plugin converts text into speech, allowing you to listen to received voice notes. To see the audio as a voice message, set opus as the Speech Format in the plugin settings.

If you've developed your own plugin and would like to see it listed here, feel free to open an issue to propose the addition.