Skip to main content

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

Project description

ErisPulse-HelpModule

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

功能特性

提供 Event 子模块中 command 模块中统一的命令帮助功能

  • 自动收集并显示所有已注册的命令
  • 支持查看特定命令的详细帮助信息
  • 支持命令分组显示
  • 可配置是否显示隐藏命令
  • 提供简洁和详细两种显示样式
  • 支持命令别名显示

使用方法

基本命令

/help           # 显示所有可用命令的简要帮助
/help <命令名>   # 显示指定命令的详细帮助信息

命令别名

/h              # 等同于 /help
/帮助            # 等同于 /help
/命令帮助         # 等同于 /help

配置选项

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

[HelpModule]
show_hidden_commands = false  # 是否显示隐藏命令
style = "simple"              # 显示样式: "simple" 或 "detailed"
group_commands = true         # 是否按组显示命令

配置说明

  • show_hidden_commands: 设置为 true 时,帮助命令会显示被标记为隐藏的命令
  • style:
    • "simple": 简洁显示模式,只显示命令名称和简要描述
    • "detailed": 详细显示模式,显示命令的更多详细信息
  • group_commands: 设置为 false 时,不按组显示命令,所有命令将在同一列表中显示

依赖

  • ErisPulse SDK 2.2.0+

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

erispulse_helpmodule-1.0.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

erispulse_helpmodule-1.0.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file erispulse_helpmodule-1.0.0.tar.gz.

File metadata

  • Download URL: erispulse_helpmodule-1.0.0.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for erispulse_helpmodule-1.0.0.tar.gz
Algorithm Hash digest
SHA256 dd8570c00c045ffc60c1a8a754e05dea4c06614a1d24cdc0aab6bcb6c7f634c2
MD5 3c7ddc949f41027f1f4f4514ac2d5c6b
BLAKE2b-256 0506a640ca3a0dbf063e861c351f371204a0c11e0ff7657f0e46c8aecda7fd43

See more details on using hashes here.

Provenance

The following attestation bundles were made for erispulse_helpmodule-1.0.0.tar.gz:

Publisher: python-publish.yml on wsu2059q/ErisPulse-HelpModule

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file erispulse_helpmodule-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for erispulse_helpmodule-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 213992feb89ed3f0e733c3752e67f115930bbface7afa217e5be49477b6e05c2
MD5 65b444070b057e8997c3bdf6466d0366
BLAKE2b-256 b506a0a5f345c0fb11470ca0ccee401e74afbf4e59379b96279977db624d8dd4

See more details on using hashes here.

Provenance

The following attestation bundles were made for erispulse_helpmodule-1.0.0-py3-none-any.whl:

Publisher: python-publish.yml on wsu2059q/ErisPulse-HelpModule

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page