Skip to content

Commit 6970c74

Browse files
author
starpig1129
committed
support update
1 parent d0f3c34 commit 6970c74

File tree

11 files changed

+56
-8567
lines changed

11 files changed

+56
-8567
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@ settings.json
44
data
55
models
66
lavalink
7-
logs
7+
logs
8+
chromedriverlinux64
9+
./cogs/TKUCourseCrawler.py

.replit

Lines changed: 0 additions & 89 deletions
This file was deleted.

README.md

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,32 @@
1-
<a href="https://discord.gg/BvP64mqKzR">
1+
# PigPig: Advanced Multi-modal LLM Discord Bot
2+
3+
<p align="center">
4+
<a href="https://discord.gg/BvP64mqKzR">
25
<img src="https://img.shields.io/discord/1212823415204085770?color=7289DA&label=Support&logo=discord&style=for-the-badge" alt="Discord">
3-
</a>
6+
</a>
7+
</p>
48

5-
# PigPig (Discord Bot Base on LLM and Vocard bot)
6-
## A discord bot based on multi-modal LLM that interacts with discord through natural language
7-
> PigPig is a simple custom Disocrd LLM Bot built with Python & [discord.py](https://discordpy.readthedocs.io/en/stable/) <br>
8-
Demo: [Discord Bot Demo](https://discord.com/oauth2/authorize?client_id=1208661941539704852&permissions=8&scope=bot),
9+
PigPig is a powerful Discord bot based on multi-modal Large Language Models (LLM), designed to interact with users through natural language. It combines advanced AI capabilities with practical features, offering a rich experience for Discord communities.
910

11+
[Invite PigPig to your server](https://discord.com/oauth2/authorize?client_id=1208661941539704852&permissions=8&scope=bot)
1012

11-
## Screenshot
13+
## 🌟 Key Features
14+
15+
- 🧠 **AI-Powered Conversations**: Utilizes LLMs and LangChain for natural language understanding and generation.
16+
- 🎵 **Advanced Music Player**: Stream music from various sources with playlist management and lyrics search.
17+
- 🖼️ **Multi-modal Capabilities**: Visual question answering and image generation.
18+
- 🍽️ **Practical Features**: Set reminders, get recommendations, and perform calculations.
19+
- 👤 **User Information Management**: Create and maintain user profiles.
20+
- 📊 **Channel Data RAG**: Use channel history for context-aware responses.
21+
22+
## 🖥️ System Requirements
23+
24+
- [Python 3.10+](https://www.python.org/downloads/)
25+
- [Lavalink Server (4.0.0+)](https://github.com/freyacodes/Lavalink)
26+
- [Modules in requirements](https://github.com/ChocoMeow/Vocard/blob/main/requirements.txt)
27+
- NVIDIA GPU with at least 12GB VRAM (required for optimal AI performance)
28+
29+
## 📸 Feature Showcase
1230
### Discord Bot
1331

1432
![alt text](readmeimg/image-4.png)
@@ -20,12 +38,8 @@ Demo: [Discord Bot Demo](https://discord.com/oauth2/authorize?client_id=12086619
2038
![alt text](readmeimg/image-2.png)
2139

2240
![alt text](readmeimg/image-3.png)
23-
## Requirements
24-
* [Python 3.10+](https://www.python.org/downloads/)
25-
* [Modules in requirements](https://github.com/ChocoMeow/Vocard/blob/main/requirements.txt)
26-
* [Lavalink Server (Requires 4.0.0+)](https://github.com/freyacodes/Lavalink)
2741

28-
## Quick Start
42+
## 🚀 Quick Start
2943
```sh
3044
git clone https://github.com/starpig1129/PigPig-discord-LLM-bot.git #Clone the repository
3145
cd PigPig-discord-LLM-bot #Go to the directory
@@ -34,7 +48,7 @@ python -m pip install -r requirements.txt #Install required packages
3448
After installing all packages, you must configure the bot before to start! [How To Configure](https://github.com/ChocoMeow/Vocard#configuration)<br />
3549
Start your bot with `python main.py`
3650

37-
## Configuration
51+
## ⚙️ Configuration
3852
1. **Rename `.env Example` to `.env` and fill all the values**
3953
```sh
4054
TOKEN = XXXXXXXXXXXXXXXXXXXXXXXX.XXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXX
@@ -193,7 +207,7 @@ OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
193207
* For `aliases` you can set custom aliases in the command. Example: `"command_name": [alias1, alias2, ...]`
194208
* For `default_controller` you can set custom embeds and buttons in controller, [Example Here](https://github.com/ChocoMeow/Vocard/blob/main/PLACEHOLDERS.md#controller-embeds)
195209

196-
## How to update? (For Windows and Linux)
210+
## 🔄 How to update? (For Windows and Linux)
197211
***Note: Make sure there are no personal files in the directory! Otherwise it will be deleted.***
198212
```sh
199213
# Check the current version

0 commit comments

Comments
 (0)