tanqiu/assets/NewbieGuidePlugin-v1.0.0/NewbieGuidePlugin-v1.0.0

Cocos Creator 新手引导系统插件

概述

这是一个基于 Cocos Creator 的通用新手引导系统插件，提供了完整的引导功能实现，包括状态管理、视觉引导、数据持久化等核心功能。

功能特性

• ✅ 状态驱动：基于状态机的引导流程控制
• ✅ 数据持久化：自动保存引导进度，支持断点续引
• ✅ 视觉引导：支持 Spine 动画的手势指引
• ✅ 智能检测：自动检测游戏状态并触发相应引导
• ✅ 易于扩展：模块化设计，支持自定义引导步骤
• ✅ 无侵入性：与现有游戏逻辑松耦合

文件结构

NewbieGuidePlugin/
├── README.md                    # 主要说明文档
├── scripts/                     # 核心脚本文件
│   ├── GuideManager.ts         # 引导管理器
│   ├── GuideStep.ts            # 引导步骤基类
│   ├── GuideDataManager.ts     # 数据管理器
│   └── GuideUIController.ts    # UI控制器
├── resources/                   # 资源文件
│   ├── spine/                  # Spine动画资源
│   │   ├── tut_hand.skel       # 手势骨骼文件
│   │   ├── tut_hand.atlas.txt  # 图集文件
│   │   └── tut_hand.png        # 纹理文件
│   └── prefabs/                # 预制体文件
│       └── GuideHand.prefab    # 引导手势预制体
├── examples/                    # 使用示例
│   ├── SimpleGuideExample.ts   # 简单引导示例
│   └── AdvancedGuideExample.ts # 高级引导示例
└── docs/                       # 详细文档
    ├── API.md                  # API文档
    ├── Integration.md          # 集成指南
    └── Customization.md        # 自定义指南

快速开始

1. 安装插件

将 NewbieGuidePlugin 文件夹复制到你的 Cocos Creator 项目的 assets 目录下。

2. 基础集成

import { GuideManager } from "./NewbieGuidePlugin/scripts/GuideManager";

// 在你的主场景脚本中初始化引导管理器
export default class GameScene extends cc.Component {
    onLoad() {
        // 初始化引导系统
        GuideManager.getInstance().init();
        
        // 开始引导
        GuideManager.getInstance().startGuide();
    }
}

3. 自定义引导步骤

import { GuideStep } from "./NewbieGuidePlugin/scripts/GuideStep";

export class CustomGuideStep extends GuideStep {
    stepId = "custom_step_1";
    
    canTrigger(): boolean {
        // 定义触发条件
        return true;
    }
    
    execute(): void {
        // 执行引导逻辑
        this.showGuideUI();
    }
    
    onComplete(): void {
        // 完成后的处理
        this.hideGuideUI();
        super.onComplete();
    }
}

核心概念

引导状态管理

引导系统使用 guideIndex 来跟踪当前的引导进度：

• 0：第一步引导（通常是点击引导）
• 1：第二步引导（通常是操作引导）
• 2+：后续自定义引导步骤

数据持久化

所有引导数据都会自动保存到本地存储，确保用户重新进入游戏时能够继续之前的引导进度。

视觉引导组件

• GuideHand：手势引导组件，支持点击、拖拽等动画
• GuideHighlight：高亮显示组件，用于突出显示目标元素
• GuideMask：遮罩组件，用于聚焦用户注意力

版本要求

• Cocos Creator 2.4.0+
• TypeScript 支持

许可证

MIT License

支持

如有问题或建议，请参考 docs/ 目录下的详细文档。