ocg-bot 项目教程

晏闻田Solitary

于 2024-09-12 09:00:14 发布

阅读量297

点赞数 5

本文链接：https://blog.csdn.net/gitblog_00240/article/details/142164596

版权

ocg-bot 项目教程

ocg-bot 基于nonebot的游戏王查卡qq机器人（测试版哟~）项目地址: https://gitcode.com/gh_mirrors/oc/ocg-bot

1. 项目的目录结构及介绍

ocg-bot/
├── bot/
│   ├── __init__.py
│   ├── config.py
│   ├── plugins/
│   │   ├── __init__.py
│   │   ├── card_search.py
│   │   ├── deck_builder.py
│   │   └── ...
│   └── utils/
│       ├── __init__.py
│       ├── database.py
│       └── ...
├── data/
│   ├── cards.json
│   ├── rules.json
│   └── ...
├── docs/
│   ├── README.md
│   ├── INSTALL.md
│   └── ...
├── .env
├── .gitignore
├── main.py
├── requirements.txt
└── ...

目录结构介绍

bot/: 包含项目的主要代码文件，包括配置文件、插件和工具类。
- init.py: 初始化文件。
- config.py: 配置文件，用于存储项目的配置信息。
- plugins/: 包含各种插件，如卡牌搜索、套牌构建等。
- utils/: 包含各种工具类，如数据库操作等。
data/: 存储项目所需的数据文件，如卡牌数据、规则数据等。
docs/: 包含项目的文档文件，如README、安装指南等。
.env: 环境变量配置文件。
.gitignore: Git忽略文件配置。
main.py: 项目的启动文件。
requirements.txt: 项目依赖的Python包列表。

2. 项目的启动文件介绍

main.py

from nonebot import get_driver
from nonebot.adapters.onebot.v11 import Adapter as ONEBOT_V11Adapter
from bot import config

# 初始化 NoneBot
driver = get_driver()
driver.register_adapter(ONEBOT_V11Adapter)

# 加载配置
config.load_config()

# 启动 NoneBot
if __name__ == "__main__":
    driver.run()

启动文件介绍

导入依赖: 导入了 nonebot 和 bot 模块的相关依赖。
初始化 NoneBot: 使用 get_driver() 获取驱动器，并注册 ONEBOT_V11Adapter 适配器。
加载配置: 调用 config.load_config() 方法加载项目的配置文件。
启动 NoneBot: 在 __main__ 模块中调用 driver.run() 启动 NoneBot。

3. 项目的配置文件介绍

config.py

import os
from dotenv import load_dotenv

def load_config():
    load_dotenv()
    config = {
        "BOT_NAME": os.getenv("BOT_NAME", "ocg-bot"),
        "DATABASE_URL": os.getenv("DATABASE_URL", "sqlite:///data/cards.db"),
        "API_KEY": os.getenv("API_KEY", ""),
        "LOG_LEVEL": os.getenv("LOG_LEVEL", "INFO")
    }
    return config

配置文件介绍

导入依赖: 导入了 os 和 dotenv 模块。
加载环境变量: 使用 load_dotenv() 方法加载 .env 文件中的环境变量。
配置项: 定义了多个配置项，如 BOT_NAME、DATABASE_URL、API_KEY 和 LOG_LEVEL，并从环境变量中获取默认值。
返回配置: 返回包含所有配置项的字典。