Unity游戏开发框架StarryFramework使用教程

Unity游戏开发框架StarryFramework使用教程

StarryFramework A lightweight general game development framework for Unity. 项目地址: https://gitcode.com/gh_mirrors/st/StarryFramework

1. 项目介绍

StarryFramework 是一个为Unity游戏开发设计的轻量级通用框架。它提供了一系列开箱即用的方法，如事件管理、存档管理、有限状态机、对象池、计时器、场景管理等，以帮助开发者提高开发效率，确保游戏质量。框架基于MOM（Model-View-Controller）架构设计，确保模块之间零耦合，便于维护和扩展。

2. 项目快速启动

安装框架

首先，从GitHub上克隆项目仓库：

git clone https://github.com/starryforest-ymxk/StarryFramework.git

然后将克隆下来的StarryFramework文件夹中的内容导入到你的Unity项目中。

配置启动场景

打开StarryFramework/Scene/GameFramework.unity场景，并将这个场景添加到Build Settings中的Scenes in Build里。确保GameFramework场景的buildIndex是0，使其作为游戏的启动场景。

初始化框架

在GameFramework场景中，确保有一个名为GameFramework的GameObject，并且它挂载了MainComponent脚本。在MainComponent的编辑器界面上，你可以配置Unity的运行设置以及框架的基础设置。

使用框架模块

在GameFramework的子对象中，根据需要添加对应的XXComponent脚本，例如EventComponent、SaveComponent等，以启用不同的框架功能。

注册事件监听

以下是一个注册事件监听的示例代码：

using StarryFramework;

// 在某个类中
Framework.EventComponent.AddEventListener<Object>("Event2", Event2);

确保你的类引用了StarryFramework命名空间。

3. 应用案例和最佳实践

事件管理

事件管理模块基于委托实现，通过自定义事件常量进行管理。开发者可以轻松添加、删除和触发事件，并支持携带多个参数的事件。

// 触发事件
Framework.EventComponent.TriggerEvent("EventName", param1, param2);

// 添加事件监听
Framework.EventComponent.AddEventListener("EventName", (param1, param2) => {
    // 事件处理逻辑
});

存档管理

存档模块提供自动存档、手动存档、存档检索等功能，支持为每个存档设置注释信息，并且使用Json格式存储游戏设置信息。

// 自动存档
Framework.SaveComponent.AutoSave();

// 手动存档
Framework.SaveComponent.Save(" SLOT_NAME ");

// 检索存档
var data = Framework.SaveComponent.Retrieve(" SLOT_NAME ");

4. 典型生态项目

音频模块扩展

如果你的游戏项目使用FMOD作为音频中间件，那么可以利用StarryFramework提供的音频模块扩展，它封装了FMOD的API，使得音频管理更加简洁和方便。

首先，导入StarryFramework_AudioExtention.unitypackage到项目中，然后在MainComponent的Modules Enabled下加入Audio模块，并配置相关设置。

// 播放背景音乐
Framework.AudioComponent.PlayBGM("bgm_name");

// 播放音效
Framework.AudioComponent.PlaySound("sound_name");

通过以上步骤，你可以快速上手并使用StarryFramework来加速你的Unity游戏开发流程。

StarryFramework A lightweight general game development framework for Unity. 项目地址: https://gitcode.com/gh_mirrors/st/StarryFramework