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

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

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

1. 项目的目录结构及介绍

StarryFramework 是一个轻量化的Unity游戏开发框架，旨在提供一系列开箱即用的方法，如事件、存档、有限状态机、对象池、计时器、场景管理等，以加快游戏开发速度并保证游戏质量。以下是项目的目录结构及介绍：

StarryFramework/
├── Attributes/              # 自定义拓展的Attribute，包括折叠框与场景选择等功能
├── Framework/
│   ├── Editor/              # 为每个模块编写的自定义编辑器面板
│   ├── Runtime/
│   │   ├── Base/            # 包含一些底层的基类，基础节点等
│   │   ├── Static/          # 框架静态内容，包括枚举类型定义，以及框架的入口类
│   │   ├── Utilities/       # 提供一些单例基类以及一些简单的工具函数
│   │   └── XXModule/        # 各种模块代码
├── Info/                   # readme 和 license
├── Scene/                  # 提供一个包含了框架节点的基础场景
└── Plugins/                # 包含框架需要引用的第三方库

2. 项目的启动文件介绍

项目的启动文件是 GameFramework.unity 场景，这个场景作为游戏的入口点，在游戏全程都不会卸载。场景中包含一个名为 GameFramework 的GameObject，它挂载了 MainComponent 脚本，负责管理整个框架的初始化和运行。

• MainComponent.cs：框架的主要组件脚本，用于初始化和管理工作流。
• XXComponent.cs：每个模块的组件脚本，负责对应模块的功能实现。

在Unity编辑器中，GameFramework 对象的属性面板允许你进行一些基础配置，如设置启动场景、模块启用情况等。

3. 项目的配置文件介绍

配置文件主要位于 Framework/Runtime/Static 目录下，包括但不限于以下文件：

• FrameworkSettings.cs：框架设置类，包含框架的基本设置，如启动场景、模块优先级等。
• ModuleSettings.cs：各个模块的设置类，用于存储和管理模块特定的配置信息。

在Unity编辑器中，通过 MainComponent 的属性面板可以访问和修改这些配置。每个模块的设置都可以在对应的 XXComponent 的属性面板中找到，并可以进行自定义配置。

以上是StarryFramework的基本介绍和配置方法，开发者可以根据自己的项目需求对框架进行相应的调整和扩展。

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