Nonebot-Plugin-NovelAI 使用教程

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

nonebot-plugin-novelai/
├── .github/
│   └── workflows/
│       └── ci.yml
├── .gitignore
├── LICENSE
├── README.md
├── bot.py
├── config.py
├── requirements.txt
└── src/
    ├── __init__.py
    ├── novelai.py
    └── utils.py

• .github/workflows/ci.yml: GitHub Actions 的配置文件，用于自动化测试和部署。
• .gitignore: Git 忽略文件列表，指定哪些文件和目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证。
• README.md: 项目说明文档，通常包含项目介绍、安装和使用说明。
• bot.py: 项目的启动文件，用于启动 Nonebot 机器人。
• config.py: 项目的配置文件，包含各种配置选项。
• requirements.txt: 项目依赖的 Python 包列表。
• src/: 源代码目录，包含项目的核心代码。
  • init.py: 模块初始化文件。
  • novelai.py: NovelAI 插件的主要功能实现。
  • utils.py: 工具函数和辅助功能。

2. 项目的启动文件介绍

bot.py 是项目的启动文件，主要负责初始化 Nonebot 机器人并加载插件。以下是 bot.py 的主要内容：

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

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

# 加载插件
nonebot.load_plugin('nonebot_plugin_novelai')

if __name__ == "__main__":
    nonebot.run()

• get_driver(): 获取 Nonebot 的驱动器实例。
• register_adapter(ONEBOT_V11Adapter): 注册 OneBot V11 适配器。
• load_plugin('nonebot_plugin_novelai'): 加载 NovelAI 插件。
• nonebot.run(): 启动 Nonebot 机器人。

3. 项目的配置文件介绍

config.py 是项目的配置文件，包含各种配置选项。以下是 config.py 的主要内容：

from pydantic import BaseSettings

class Config(BaseSettings):
    # 插件配置项
    novelai_api_key: str = "your_api_key_here"
    novelai_api_url: str = "https://api.novelai.net"

    class Config:
        extra = "ignore"

• BaseSettings: Pydantic 库的基类，用于定义配置项。
• novelai_api_key: NovelAI API 的密钥。
• novelai_api_url: NovelAI API 的 URL。
• extra = "ignore": 忽略未知的配置项。

通过修改 config.py 中的配置项，可以调整插件的行为和参数。