CHANGELOG.md 3.3 KB

更新日志

[1.0.0] - 2024-01-15

新增功能

  • ✨ 完整的新手引导系统核心架构
  • ✨ 状态驱动的引导流程管理
  • ✨ 数据持久化存储系统
  • ✨ 可视化引导UI控制器
  • ✨ Spine动画支持(手指指向、高亮效果)
  • ✨ 多种引导步骤类型:
    • 点击引导 (ClickGuideStep)
    • 拖拽引导 (DragGuideStep)
    • 对话引导 (DialogGuideStep)
    • 条件等待引导 (WaitConditionGuideStep)
    • 合并提示引导 (MergeTipGuideStep)
  • ✨ 事件驱动的步骤管理
  • ✨ 智能条件检测系统
  • ✨ 可扩展的自定义步骤支持
  • ✨ 完整的配置文件系统
  • ✨ 调试模式和开发工具
  • ✨ 基础和高级使用示例
  • ✨ 详细的API文档和集成指南

核心组件

  • 🔧 GuideManager - 引导系统管理器
  • 🔧 GuideDataManager - 数据存储管理器
  • 🔧 GuideUIController - UI控制器
  • 🔧 GuideStep - 引导步骤基类
  • 🔧 GuideSteps - 具体引导步骤实现

资源文件

  • 🎨 GuideUI.prefab - 引导UI预制体
  • 🎨 tut_hand.atlas.txt - 手指动画图集
  • 🎨 tut_hand.json - 手指动画骨骼数据
  • 🎨 guide_mask.png - 引导遮罩图片
  • ⚙️ guide_config.json - 引导配置文件

文档

  • 📚 README.md - 插件概述和快速开始
  • 📚 API_Reference.md - 详细API参考文档
  • 📚 Integration_Guide.md - 集成指南和最佳实践
  • 📚 BasicExample.ts - 基础使用示例
  • 📚 AdvancedExample.ts - 高级功能示例

特性

  • 🚀 非侵入式设计,易于集成
  • 🚀 支持复杂的分支引导流程
  • 🚀 智能的条件检测和步骤触发
  • 🚀 完整的数据持久化支持
  • 🚀 丰富的视觉引导效果
  • 🚀 可配置的引导行为
  • 🚀 强大的调试和测试工具
  • 🚀 TypeScript支持,类型安全
  • 🚀 事件驱动架构,松耦合设计
  • 🚀 支持自定义引导步骤扩展

兼容性

  • ✅ Cocos Creator 2.4.0+
  • ✅ TypeScript 支持
  • ✅ 跨平台兼容(Web、移动端)
  • ✅ 支持多种屏幕分辨率

性能优化

  • ⚡ 懒加载资源管理
  • ⚡ 内存优化的UI控制
  • ⚡ 高效的事件系统
  • ⚡ 最小化运行时开销

未来计划

[1.1.0] - 计划中

  • 🔮 多语言支持系统
  • 🔮 更多内置引导步骤类型
  • 🔮 可视化引导编辑器
  • 🔮 引导录制和回放功能
  • 🔮 A/B测试支持
  • 🔮 引导数据分析工具

[1.2.0] - 计划中

  • 🔮 云端引导配置同步
  • 🔮 动态引导内容更新
  • 🔮 AI驱动的个性化引导
  • 🔮 更丰富的动画效果
  • 🔮 语音引导支持

贡献指南

欢迎提交Issue和Pull Request来帮助改进这个插件!

如何贡献

  1. Fork 这个项目
  2. 创建你的功能分支 (git checkout -b feature/AmazingFeature)
  3. 提交你的更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 打开一个 Pull Request

报告问题

如果你发现了bug或有功能建议,请在GitHub Issues中报告。


许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。


致谢

感谢所有为这个项目做出贡献的开发者和测试者!

特别感谢:

  • Cocos Creator 团队提供的优秀游戏引擎
  • Spine 团队提供的动画系统
  • 所有提供反馈和建议的社区成员