进阶功能

本文档介绍 Amrita 的进阶使用方法，包括插件开发、配置定制和功能扩展。

🔧 插件系统

Amrita 基于 NoneBot2 的插件系统，允许用户扩展机器人功能。

内置插件

Amrita 提供了以下内置插件：

1. chat - 核心聊天功能插件
2. perm - 权限管理系统
3. manager - 机器人管理功能
4. menu - 菜单功能管理
5. webui - Web 用户界面

禁用内置插件

可以通过配置禁用不需要的内置插件：

# 在 .env 文件中配置
DISABLED_BUILTIN_PLUGINS=["webui"]

创建自定义插件

使用 CLI 工具创建插件：

# 使用 nb-cli 创建插件
amrita nb plugin create my_plugin

或者手动创建插件目录结构：

plugins/
└── my_plugin/
    ├── __init__.py
    ├── config.py
    └── main.py

插件示例：

# plugins/my_plugin/__init__.py
from nonebot.plugin import PluginMetadata

from .config import Config

__plugin_meta__ = PluginMetadata(
    name="我的插件",
    description="这是一个示例插件",
    usage="发送 hello 触发",
    config=Config,
)

# plugins/my_plugin/config.py
from pydantic import BaseModel

class Config(BaseModel):
    my_plugin_enabled: bool = True
    my_plugin_api_key: str = ""

# plugins/my_plugin/main.py
from nonebot import on_command
from nonebot.adapters.onebot.v11 import MessageEvent

hello = on_command("hello")

@hello.handle()
async def handle_hello(event: MessageEvent):
    await hello.finish("Hello from my plugin!")

⚙️ 配置系统

项目配置

项目配置在 pyproject.toml 文件中定义：

[project]
name = "mybot"
version = "0.1.0"
description = "我的 Amrita 机器人"
requires-python = ">=3.10, <4.0"
dependencies = [
    "amrita[full]>=0.2.0",
]

环境变量配置

Amrita 支持多种环境配置文件：

• .env - 默认环境配置
• .env.dev - 开发环境配置
• .env.prod - 生产环境配置

Amrita 专用配置

以下配置项是 Amrita 特有的：

# 日志目录
LOG_DIR=logs

# 管理员群组ID（建议填写）
ADMIN_GROUP=123456789

# 禁用的内置插件
DISABLED_BUILTIN_PLUGINS=[]

# 记录到文件的日志等级
AMRITA_LOG_LEVEL=WARNING

# 公开群组（可选）
PUBLIC_GROUP=987654321

# 机器人名称
BOT_NAME=MyBot

# 请求速率限制（秒）
RATE_LIMIT=5

# 禁用内置菜单
DISABLE_BUILTIN_MENU=false

🤖 聊天插件配置

LLM 模型配置

chat 插件支持多种大语言模型，关于 LLM 功能配置请参考文档

🔐 权限系统

请阅读 权限系统 文档。

📊 WebUI 配置

启用/禁用 WebUI

# 启用 WebUI
WEBUI_ENABLE=true

用户认证

WEBUI_USER_NAME=admin
WEBUI_PASSWORD=your_secure_password

🧠 数据库配置

SQLite（默认）

DATABASE_URL=sqlite+aiosqlite:///./data/db.sqlite3

PostgreSQL

# 需要额外安装asyncpg
DATABASE_URL=postgresql+asyncpg://user:password@localhost:5432/amrita

MySQL

# 需要额外安装aiomysql
DATABASE_URL=mysql+aiomysql://user:password@localhost:3306/amrita

🛡️ 安全配置

请求限制

# 会话限速
RATE_LIMIT=5

现在您已经了解了 Amrita 的进阶功能。接下来可以查看 高级功能 了解更多扩展开发内容。