mirror of
https://github.com/PaiGramTeam/MibooGram.git
synced 2024-11-29 11:03:14 +00:00
135 lines
3.6 KiB
Markdown
135 lines
3.6 KiB
Markdown
<h1 align="center">TGPaimonBot</h1>
|
|
|
|
<div align="center">
|
|
<img src="https://img.shields.io/badge/python-3.8%2B-blue">
|
|
<img src="https://img.shields.io/badge/works%20on-my%20machine-brightgreen">
|
|
<img src="https://img.shields.io/badge/status-%E5%92%95%E5%92%95%E5%92%95-blue">
|
|
<a href="https://black.readthedocs.io/en/stable/index.html"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="code_style" /></a>
|
|
<a href="https://www.codacy.com/gh/luoshuijs/TGPaimonBot/dashboard?utm_source=github.com&utm_medium=referral&utm_content=luoshuijs/TGPaimonBot&utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/810a80be4cbe4b7284ab7634941423c4"/></a>
|
|
</div>
|
|
|
|
|
|
<p>
|
|
<img src="https://user-images.githubusercontent.com/70872201/190447002-119a8819-b111-4a96-a0b3-701c5e256137.png" align="right" width="100px">
|
|
<h2 align="left">简介</h2>
|
|
|
|
基于 [python-telegram-bot](https://github.com/python-telegram-bot/python-telegram-bot) 的 Paimon BOT
|
|
|
|
项目仅供学习交流使用，严禁用于任何商业用途和非法行为
|
|
|
|
|
|
|
|
## 环境需求
|
|
|
|
- Python 3.8+
|
|
- MySQL
|
|
- Redis
|
|
|
|
## 使用方法
|
|
|
|
### 1. 安装 `poetry`
|
|
|
|
```bash
|
|
pip install --upgrade poetry
|
|
```
|
|
|
|
### 2. 安装依赖
|
|
|
|
```bash
|
|
poetry install
|
|
poetry run playwright install chromium
|
|
```
|
|
|
|
#### 可选依赖项
|
|
|
|
```bash
|
|
poetry install --extras pyro
|
|
```
|
|
|
|
### 3. 修改配置
|
|
|
|
创建 `.env` 文件并填写数据库连接和 bot token 等参数。
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
### 4. 初始化数据库
|
|
|
|
```bash
|
|
poetry run alembic upgrade head
|
|
```
|
|
|
|
### 5. 运行
|
|
|
|
```bash
|
|
poetry run python ./run.py
|
|
```
|
|
|
|
## 使用 Docker Compose
|
|
|
|
### 1. 安装 `docker` 和 `docker-compose`
|
|
|
|
```bash
|
|
curl -fsSL https://get.docker.com | bash -s docker
|
|
```
|
|
|
|
```bash
|
|
sudo curl -L "https://github.com/docker/compose/releases/download/v2.16.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
|
|
sudo chmod +x /usr/local/bin/docker-compose
|
|
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
|
|
docker-compose version
|
|
```
|
|
|
|
### 2. 克隆项目
|
|
|
|
```bash
|
|
git clone https://github.com/luoshuijs/TGPaimonBot.git
|
|
cd TGPaimonBot
|
|
```
|
|
|
|
### 3. 修改配置文件
|
|
|
|
```bash
|
|
cp .env.example .env
|
|
cp docker-compose.gen.yml docker-compose.yml
|
|
```
|
|
|
|
```dotenv
|
|
# MySQL
|
|
DB_HOST=mysql
|
|
DB_PORT=3306
|
|
DB_USERNAME=root
|
|
DB_PASSWORD="root"
|
|
DB_DATABASE=paimon
|
|
|
|
# Redis
|
|
REDIS_HOST=redis
|
|
REDIS_PORT=6379
|
|
REDIS_DB=0
|
|
REDIS_PASSWORD=""
|
|
````
|
|
|
|
以及 bot token 等参数。
|
|
|
|
### 4. 运行
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
## 其他说明
|
|
|
|
这个项目目前正在扩展，加入更多原神相关娱乐和信息查询功能，敬请期待。
|
|
|
|
## Thanks
|
|
|
|
| Nickname | Introduce |
|
|
|:-----------------------------------------------------------------------:|------------------|
|
|
| [原神抽卡全机制总结](https://www.bilibili.com/read/cv10468091) | 本项目抽卡模拟器使用的逻辑 |
|
|
| [西风驿站 猫冬](https://bbs.mihoyo.com/ys/accountCenter/postList?id=74019947) | 本项目攻略图图源 |
|
|
| [Yunzai-Bot](https://github.com/Le-niao/Yunzai-Bot) | 本项使用的抽卡图片和前端资源来源 |
|
|
| [Crawler-ghhw](https://github.com/DGP-Studio/Crawler-ghhw) | 本项目参考的爬虫代码 |
|
|
| [Enka.Network](https://enka.network) | 角色卡片的数据来源 |
|
|
| [miao-plugin](https://github.com/yoimiya-kokomi/miao-plugin) | 角色卡片的参考项目 |
|