MibooGram/docs/README_ZH.md

PaiGram

简介

基于 python-telegram-bot 的 PaiGram

环境需求

• Python 3.11+
• MySQL or SQLite
• Redis

使用方法

根据您首选的环境，按照以下设置之一进行操作：

WSL2 Ubuntu 22.04 设置

对于在 Ubuntu 22.04 上使用 WSL2 的贡献者，请按照这里的详细指南进行操作。

标准设置（所有环境）

1. 从 Git 克隆 PaiGram

git clone git@github.com:PaiGramTeam/PaiGram.git --recurse-submodules
cd PaiGram/

2. 项目设置

建议使用虚拟环境。您可以通过 venv 或 virtualenv 进行设置。

创建虚拟环境：

python3 -m venv venv

激活虚拟环境：

对于 Linux:

source venv/bin/activate

对于 Windows 命令提示符:

venv\Scripts\activate.bat

对于 Windows PowerShell:

.\venv\Scripts\Activate.ps1

安装依赖：

pip install pdm
pdm install
playwright install chromium

可选依赖

pdm install -G :all

编辑配置文件：

根据给定示例创建 dotenv 配置（.env）。确保提供必要的数据库连接详细信息和机器人 token 参数。

cp .env.example .env

要进行详细的配置，请参阅Wiki/Env 设置。

3. 使用 Alembic 设置数据库

alembic upgrade head

4. 运行 PaiGram

运行前请确保你依然处于虚拟环境中

python ./run.py

其他部署方法

• Docker: 对于使用 Docker 的部署，请参阅Wiki/使用 Docker 部署。

• Podman: 对于使用 Podman 的部署，请参阅Wiki/使用 Podman 部署。

其他说明

这个项目目前正在扩展，加入更多原神相关娱乐和信息查询功能，敬请期待。

感谢

Nickname	Introduce
原神抽卡全机制总结	本项目抽卡模拟器使用的逻辑
西风驿站 猫冬	本项目攻略图图源
Yunzai-Bot	本项使用的抽卡图片和前端资源来源
Crawler-ghhw	本项目参考的爬虫代码
Enka.Network	角色卡片的数据来源
DGP 胡桃 API	深渊数据来源