https://github.com/okineadev/neko-chan-bot
A Telegram bot with cute nekos (and not only) 😺
https://github.com/okineadev/neko-chan-bot
aiogram anime art telegram telegram-bot
Last synced: about 1 year ago
JSON representation
A Telegram bot with cute nekos (and not only) 😺
- Host: GitHub
- URL: https://github.com/okineadev/neko-chan-bot
- Owner: okineadev
- License: gpl-3.0
- Created: 2024-02-05T19:49:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-08T19:28:05.000Z (over 2 years ago)
- Last Synced: 2024-04-22T14:48:14.724Z (about 2 years ago)
- Topics: aiogram, anime, art, telegram, telegram-bot
- Language: Shell
- Homepage: https://t.me/MeowMatrixBot
- Size: 23.6 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## ℹ️ About The Project
This bot can send pictures and GIF's with nekos, kitsune .etc
This project uses [**nekosbest**](https://github.com/nekos-best/nekos-best.py) API
## 🧧 Getting Started
### 📦 Prerequisites
- **Git**
- **make** (in Linux)
- **Bash** or **cygwin-like** shell (in Windows)
### 💿 Installation
1. Clone the repo
```sh
git clone https://github.com/okineadev/neko-chan-bot.git
cd neko-chan-bot
```
2. Install all dependencies
```sh
make setup
# Or run this script if you on Windows
# ./setup.sh
```
3. Create a bot in [@BotFather](https://t.me/botfather) and copy the token.
> [!TIP]
> If you don't know how to do it, here are the [**instructions**](https://telegra.ph/How-to-create-a-Telegram-bot-with-BotFather-02-08)
4. Add your bot's token to the `.env` (environment) file
```sh
echo 'BOT_TOKEN=""' >> .env
```
## 🔥 Usage
Write a command to the bot with the category of photo or gif you want to receive
Usage: `/ `
Example: `/neko`
The bot will send you one photo, to get several at the same time, write the number you want to get at the end: `/neko 8`
> [!NOTE]
> The maximum number of photos at a time is 10 pieces.
You can also get a **GIF** by doing the same thing as in the previous step.
> [!NOTE]
> You can only get one GIF at a time
If you want to check out all the commands, here is their list:
View full list
-
neko - Send neko 😺 -
kitsune - Send kitsune 🦊 -
waifu - Send waifu 👩❤️👨 -
husbando - Send husbando 👨❤️👨 -
baka - Send baka GIF 🤦♂️ -
bite - Send bite GIF 👄 -
blush - Send blush GIF ☺️ -
bored - Send bored GIF 😑 -
cry - Send cry GIF 😢 -
cuddle - Send cuddle GIF 🤗 -
dance - Send dance GIF 💃 -
facepalm - Send facepalm GIF 🤦♂️ -
feed - Send feed GIF 🍽️ -
handhold - Send handhold GIF 🤝 -
handshake - Send handshake GIF 🤝 -
happy - Send happy GIF 😄 -
highfive - Send highfive GIF 🙌 -
hug - Send hug GIF 🤗 -
kick - Send kick GIF 👟 -
kiss - Send kiss GIF 💋 -
laugh - Send laugh GIF 😂 -
lurk - Send lurk GIF 🕵️♂️ -
nod - Send nod GIF 👍 -
nom - Send nom GIF 😋 -
nope - Send nope GIF 🙅♂️ -
pat - Send pat GIF 🤚 -
peck - Send peck GIF 💏 -
poke - Send poke GIF 👉 -
pout - Send pout GIF 😡 -
punch - Send punch GIF 👊 -
shoot - Send shoot GIF 🔫 -
shrug - Send shrug GIF 🤷♂️ -
slap - Send slap GIF 👋 -
sleep - Send sleep GIF 😴 -
smile - Send smile GIF 😊 -
smug - Send smug GIF 😏 -
stare - Send stare GIF 👀 -
think - Send think GIF 🤔 -
thumbsup - Send thumbsup GIF 👍 -
tickle - Send tickle GIF 🤣 -
wave - Send wave GIF 👋 -
wink - Send wink GIF 😉 -
yawn - Send yawn GIF 😪 -
yeet - Send yeet GIF 💨
## 📑 Additional materials
### 🏞️ Photoshop designs
- You can use and edit the `.psd` files located in the [**assets/photoshop**](assets/photoshop) folder
- If you want to fix the logo of the repository, the avatar of the bot - you can safely take the file and edit it, after that export the photo and place it in the desired folder (for example [**public**](public))
### 📄 Commands
- A list of all commands is in the file [**commands_list.txt**](assets/commands_list.txt)
- You can send it to BotFather to install a menu with all the commands
## 🤝 Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## 📝 License
Distributed under the GNU GPLv3 . See `LICENSE.txt` for more information.
## ☎️ Contact
Telegram - [**@Okinea**](https://t.me/okinea)
If you have any suggestions or problems, contact me.
## 🍩 Support
You can support me financially, I will be very grateful!
💳 **Bank card:** `4441 1144 0274 7206` (**monobank**)
💎 **TON Wallet:** `UQBaBIBtKJpdwc4jKSGd70LZyQnEf-Nx5edzZlZAAGkHnZ7E`