Metadata-Version: 2.4
Name: ErisPulse-HelpModule
Version: 2.1.0
Summary: ErisPulse 帮助命令模块，提供自动化的命令帮助系统，支持查看所有可用命令及其用法说明
Author-email: wsu2059q <wsu2059@qq.com>
License-Expression: MIT
Project-URL: homepage, https://github.com/wsu2059q/ErisPulse-HelpModule
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# ErisPulse-HelpModule
ErisPulse 帮助命令模块，提供自动化的命令帮助系统，支持查看所有可用命令及其用法说明

## 功能特性
提供 Event 子模块中 command 模块中统一的命令帮助功能
- 自动收集并显示所有已注册的命令
- 支持通过序号查看特定命令的详细帮助信息
- 支持命令分组显示
- 可配置是否显示隐藏命令
- 支持命令别名显示

## 使用方法

### 基本命令

```
/help           # 显示所有可用命令的列表
/help <序号>     # 显示指定序号命令的详细帮助信息
```

### 命令别名

```
/h              # 等同于 /help
/帮助            # 等同于 /help
```

## 配置选项

模块支持以下配置选项，可以在 config.toml 中进行自定义：

```toml
[HelpModule]
show_hidden_commands = false  # 是否显示隐藏命令
group_commands = true         # 是否按组显示命令
```

### 配置说明

- `show_hidden_commands`: 设置为 `true` 时，帮助命令会显示被标记为隐藏的命令
- `group_commands`: 设置为 `false` 时，不按组显示命令，所有命令将在同一列表中显示

## 依赖

- ErisPulse SDK 2.2.0+
