cyber_fenneko/README.md

34 lines
845 B
Markdown
Raw Permalink Normal View History

2023-10-13 18:30:17 +00:00
# Cyber Fenneko
The next evolution in Telegram userbots. (jk, but it's pretty cool anyway)
## What is this?
This is a userbot that runs on Telegram's [MTProto API](https://core.telegram.org/mtproto). It's written in Python, and uses [Telethon](https://telethon.dev) as its main library. It's also modular, so you can add your own modules to it.
## How do I use it?
First, install dependencies. This can be done with [poetry](https://python-poetry.org/), or with pip.
```bash
# With poetry
poetry install
# With pip
pip install -r requirements.txt
```
Then, copy `.env.example` to `.env`, and fill in the values. You can get your API ID and API hash from [my.telegram.org](https://my.telegram.org).
Finally, run the bot.
```bash
# With poetry
poetry run fenneko
# With python
python -m cyber_fenneko
```
More documentation to come...