HN 系列 Wiki

主题

HNAttribute v3.2.0 ​

  • 发布日期: 2026-05-15
  • 当前版本: 3.2.0
  • 版本定位: 文档全面优化,提升新手友好度和配置清晰度

📚 文档优化 ​

基础教学文档全面重写 ​

我们对所有基础教学文档进行了全面优化,让它们更友好、更详细、更易懂。

优化内容 ​

1. 语气更友好

  • 去掉了生硬的命令式语气
  • 增加了"不用担心"、"我们一步一步来"等安抚性语言
  • 用"你可以"代替"应该"、"必须"等强制性词汇
  • 使用对话式语言,让文档读起来像朋友在教你

2. 字段说明更详细

  • 每个配置字段都增加了详细的解释
  • 增加了"为什么要这样做"的说明
  • 增加了"什么时候用"的场景说明
  • 增加了字段的单位说明(比如 tick、秒)

3. 增加了大量实例

  • 每个概念都配有具体的例子
  • 增加了"举个例子"段落,用实际场景说明
  • 增加了完整的配置示例和效果说明
  • 增加了对比示例,让你看到不同配置的区别

优化的文档列表 ​

  • 属性系统概述 (02a.属性系统概述.md)

    • 详细解释了属性修饰符的四个核心信息
    • 用换装备的例子说明 source 的价值
    • 详细解释了属性映射和链式派生的用途和场景

  • Buff 系统与修饰符 (02c.Buff系统与修饰符.md)

    • 详细说明了 Buff 和周期效果的区别
    • 增加了重施策略的详细说明和使用场景
    • 增加了基础信息字段的详细解释

  • 周期效果(DOT-HOT) (02d.周期效果(DOT-HOT).md)

    • 详细对比了 direct 和 instance 模式
    • 增加了完整的配置示例
    • 详细说明了重施策略的四种模式及使用场景
    • 增加了 effect 层、instance 层、hooks 层的字段详解

  • 伤害类型与战斗管线 (02b.伤害类型与战斗管线.md)

    • 详细解释了设计理念和原因
    • 增加了 stage 三种类型的详细说明
    • 增加了场景(scenario)的用途说明
    • 详细解释了终止语义的作用

  • 如何配置 Buff 效果 (03b.如何配置Buff效果.md)

    • 增加了"不用担心"的友好开场
    • 详细解释了 Buff 的本质
    • 增加了常见问题的详细排查步骤
    • 增加了重施策略的详细场景说明

术语与表达统一 ​

这次同步统一了整套文档的表达方式:

  • 聚焦当前可直接使用的配置与功能说明
  • 删除容易分散注意力的对比型段落
  • 精简不再需要的补充说明
  • 统一使用当前文档中的术语和概念

🎯 核心改进 ​

1. 配置字段说明标准化 ​

所有配置字段现在都遵循统一的说明格式:

yaml
字段名: 值
  # 说明: 这个字段是做什么的
  # 单位: tick/秒/百分比等
  # 默认值: 如果不填会是什么
  # 示例: 具体的使用例子

2. 错误排查流程优化 ​

每个功能模块都增加了详细的排查流程:

  1. 问题现象: 你遇到了什么问题
  2. 可能原因: 可能是什么导致的
  3. 排查步骤: 按顺序执行这些命令
  4. 解决方法: 如何修复这个问题

3. 使用场景说明 ​

每个功能都增加了"什么时候用"的说明:

  • 适合什么场景: 这个功能适合做什么
  • 不适合什么场景: 这个功能不适合做什么
  • 替代方案: 如果不适合,应该用什么

💡 新手友好度提升 ​

1. 概念解释更清晰 ​

  • 用"人话"解释技术概念
  • 增加了"你可以把它理解成"的类比
  • 增加了"为什么需要这个"的说明

2. 示例更丰富 ​

  • 每个功能都有完整的配置示例
  • 每个示例都有详细的注释
  • 每个示例都有预期效果说明

3. 常见问题更详细 ​

  • 增加了"可能的原因"分析
  • 增加了"如何排查"的步骤
  • 增加了"解决方法"的说明

📖 文档结构优化 ​

1. 章节组织更合理 ​

  • 基础概念放在前面
  • 配置方法放在中间
  • 高级用法放在后面
  • 常见问题放在最后

2. 导航更清晰 ​

  • 每个文档都有清晰的目录
  • 相关文档之间有明确的链接
  • 增加了"下一步该看哪页"的指引

3. 术语使用统一 ​

  • 统一使用"属性"而不是"attribute"
  • 统一使用"来源"而不是"source"
  • 统一使用"修饰符"而不是"modifier"
  • 在需要时才使用英文术语,并附上中文解释

🔧 配置示例优化 ​

1. 注释更详细 ​

所有配置示例都增加了详细的注释:

yaml
新手力量:  # Buff 的唯一标识符 (key)
  display: "&c新手力量"  # 显示名称,支持颜色代码 (&c = 红色)
  default-time: 120  # 默认持续时间 (tick), 120 tick = 6 秒
  reapply-mode: REFRESH  # 重施策略: REFRESH(刷新时间), IGNORE(忽略新的), REPLACE(替换旧的)
  attributes:  # 属性修饰列表
    attack_damage:  # 要修改的属性 ID (攻击力)
      operation: ADD  # 操作类型: ADD(加法), MULTIPLY_BASE(基础乘法), MULTIPLY_TOTAL(总值乘法)
      formula: "10 + level * 5"  # 公式: level 是 Buff 等级 (1级=15, 2级=20, 3级=25)

2. 示例更实用 ​

  • 增加了常见场景的完整配置
  • 增加了不同难度的示例(简单/中等/复杂)
  • 增加了错误示例和正确示例的对比

📝 更新的文档列表 ​

基础教学 ​

  • 属性系统概述
  • Buff 系统与修饰符
  • 周期效果(DOT-HOT)
  • 伤害类型与战斗管线

配置指南 ​

  • 如何配置 Buff 效果
  • 属性面板与 GUI 配置

更新日志 ​

  • 重写了所有更新日志,使用统一的格式
  • 移除了过时的信息
  • 增加了版本间的对比说明

🎉 用户反馈 ​

基于用户反馈,我们特别优化了以下内容:

  1. 字段含义不清: 现在每个字段都有详细的说明
  2. 不知道什么时候用: 现在每个功能都有使用场景说明
  3. 配置不知道怎么写: 现在每个功能都有完整的配置示例
  4. 出错不知道怎么查: 现在每个功能都有详细的排查流程

🔗 相关文档 ​

💬 反馈与建议 ​

如果你在使用过程中发现:

  • 文档还有不清楚的地方
  • 配置示例不够详细
  • 需要更多的使用场景说明

欢迎随时反馈,我们会持续优化文档质量。

本次更新专注于提升文档质量和用户体验,让每个人都能轻松上手 HNAttribute。

HN 系列插件文档

Copyright © 2024