ErisPulse-HelpNext

Renders the ErisPulse /help command as a card image via ErisPulse-Takumi, with day/night theme and multilingual support. Requires ErisPulse 2.8.0+.

English | 简体中文

English

2.8.0+ recommends this module. The classic ErisPulse-HelpModule is still maintained for backward compatibility. Both register /help, so enable only one.

Features

• Day/night theme by local time (19–7 dark), or pin light / dark
• Multilingual: zh-CN / zh-TW / en / ja / ru (declarative I18nClass)
• Session-aware listing: commands from modules disabled by scope in the current session are hidden
• Falls back to Html → Markdown → Text when images aren't supported
• Declarative config (ConfigClass), descriptions also translated

Install

epsdk install HelpNext

Commands

/help                        List all available commands (card image)
/help <index>                Show detail of the command at <index>
/help --format <fmt>         Force output format: image | html | markdown | text

Aliases: /h, /帮助

Config

First load writes defaults; edit the HelpNext section:

[HelpNext]
show_hidden_commands = false   # show commands marked hidden
group_commands = true          # group commands by category
theme = "auto"                 # auto | light | dark
style = "default"              # default | moe
utc_offset = 8                 # UTC offset for day/night switching
show_logo = true               # show ErisPulse icon in header
header_title = ""              # custom header title (empty = default)
header_subtitle = ""           # custom header subtitle (empty = default)

• show_hidden_commands: when true, shows commands marked as hidden
• group_commands: when false, lists all commands in a single group
• theme: auto (by time), or fixed light / dark
• style: color style — default or moe
• utc_offset: UTC offset used for day/night detection
• show_logo: show the ErisPulse icon in the header
• header_title / header_subtitle: customize the header text (empty = defaults)

Styles

• default — clean & professional (fallback)
• moe — cute style, with a random mascot banner on top of help-list cards (hidden automatically when the API is unreachable)

Each style ships with light & dark palettes. Styles are standalone files in HelpNext/themes/: the moe theme is fully removable — delete themes/moe.py and unknown style names simply fall back to default.

A style may define a Theme behavior class with async on_attach(sdk) / async on_detach() / decorate(ctx, sdk) to inject HTML/CSS per render — see themes/moe.py for a complete example.

Render Decorators (for plugin authors)

Card rendering is also open to external decoration plugins. Register a decorator to receive the render context {kind, body, css, theme, config} before each card image is rendered, and mutate body (HTML) / css (stylesheet) in place (applied after the theme's own behavior):

from HelpNext import Main

def my_decorator(ctx):
    ctx["css"] += "\n.card { border-radius: 24px; }"   # restyle
    # ctx["body"] = ...                                 # inject decorations

Main.register_decorator(my_decorator, priority=10)
# Main.unregister_decorator(my_decorator) / Main.clear_decorators()

kind is "help_list" / "command_detail" / "error"; theme contains the resolved color tokens (mode, page, card, ink, ...).

Dependencies

• ErisPulse SDK 2.8.0+
• ErisPulse-Takumi (declared as a dependency, auto-installed)

简体中文

2.8.0+ 推荐使用本模块；经典版 ErisPulse-HelpModule 继续维护，用于向后兼容。两者都注册 /help，请按需启用其一。

功能特性

• 按本地时间自动切换昼夜主题（19–7 点深色），也可固定为浅色 / 深色
• 多语言：zh-CN / zh-TW / en / ja / ru（声明式 I18nClass）
• 会话感知列表：被作用域禁用的模块，其命令不在当前会话的帮助中列出
• 平台不支持图片时按 Html → Markdown → 文本 回退
• 声明式配置（ConfigClass），配置描述同样支持多语言

安装

epsdk install HelpNext

命令

/help                        列出所有可用命令（卡片图片）
/help <序号>                  查看指定序号命令的详情
/help --format <格式>         指定输出格式：image | html | markdown | text

别名：/h、/帮助

配置选项

首次加载会写入默认配置，可在 ErisPulse 配置的 HelpNext 节修改：

[HelpNext]
show_hidden_commands = false   # 是否显示隐藏命令
group_commands = true          # 是否按分组显示
theme = "auto"                 # auto | light | dark
style = "default"              # default | moe
utc_offset = 8                 # 昼夜切换用的时区偏移
show_logo = true               # 头部是否显示 ErisPulse 图标
header_title = ""              # 自定义头部标题（留空使用默认）
header_subtitle = ""           # 自定义头部副标题（留空使用默认）

• show_hidden_commands：设为 true 时显示标记为隐藏的命令
• group_commands：设为 false 时不分组，所有命令在同一列表
• theme：图片主题，auto 跟随时间，或固定 light / dark
• style：配色风格——default 或 moe
• utc_offset：昼夜判定使用的 UTC 时区偏移
• show_logo：头部是否显示 ErisPulse 图标
• header_title / header_subtitle：自定义头部标题 / 副标题（留空使用默认）

配色风格

• default —— 简洁专业（兜底风格）
• moe —— 可爱风，帮助列表顶部展示随机萌图横幅（API 不可用时自动隐藏）

每套风格均含浅色 / 深色两组色板。风格是 HelpNext/themes/ 下的独立文件： moe 主题可整体剔除——删除 themes/moe.py 即可，未知的风格名会自动 回退到 default。

风格可定义 Theme 行为类（async on_attach(sdk) / async on_detach() / decorate(ctx, sdk)）在渲染时注入 HTML / CSS，完整示例见 themes/moe.py。

渲染装饰插件（供插件作者）

卡片图渲染同样开放给外部装饰插件。注册装饰器即可在每次渲染前拿到上下文 {kind, body, css, theme, config}，就地修改 body（HTML）/ css（样式表） （在主题自身行为之后执行）：

from HelpNext import Main

def my_decorator(ctx):
    ctx["css"] += "\n.card { border-radius: 24px; }"   # 换样式
    # ctx["body"] = ...                                 # 注入装饰内容

Main.register_decorator(my_decorator, priority=10)
# Main.unregister_decorator(my_decorator) / Main.clear_decorators()

kind 为 "help_list" / "command_detail" / "error"；theme 为解析后的 色板令牌（mode、page、card、ink 等）。

依赖

• ErisPulse SDK 2.8.0+
• ErisPulse-Takumi（已声明为依赖，自动安装）