# XFGameFramework

**Repository Path**: xianfengkeji/XFGameFramework

## Basic Information

- **Project Name**: XFGameFramework
- **Description**: XFGameFramework是一款基于MVC的游戏框架，该框架提供了View管理，UI管理，音频播放，事件系统，Http网络请求，计时器，对象池以及UI适配等功能!
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://space.bilibili.com/258939476
- **GVP Project**: No

## Statistics

- **Stars**: 78
- **Forks**: 20
- **Created**: 2020-03-05
- **Last Updated**: 2025-09-04

## Categories & Tags

**Categories**: game-dev

**Tags**: MVC, Unity3D, 游戏框架, GameFramework

## README

![](Documentation~/textures/logo_web.png)

# XFGameFramework

## 功能介绍

XFGameFramework是一款基于MVC的Unity3D引擎的游戏框架，该框架提供了View管理、UI管理、音频播放、事件系统、Http网络请求、计时器、对象池以及UI适配等功能!
除此还提供了丰富的拓展包，比如：可视化有限状态机、技能系统、Buff系统、多语言系统、动画系统、装备任务、任务系统、配表系统、存档系统、红点系统 等等 ， 大家可以根据自己需求选择安装！

## 框架规则

该框架基于MVC, 但不完全是MVC,这里 V 不仅仅是View， 把它理解为Object可能更合适一点，传统的MVC中的V指的是View(视图), 而该框架中的V指的是Object, 
Object中不仅可以包含View(视图), 也可以包含Model(数据) 和 Controller(业务逻辑)， 但是有一个前提， 就是 Model(数据) 和 Controller(业务逻辑) 必须与Object强关联，才能放到Object(View)中！ 

那怎么判断是否为强关联呢？ 比如，在游戏中有一个敌人，这个敌人有一个生命值的数据，这个生命值的数据是属于这个敌人的，当敌人死亡时被移除，这个数据也需要被移除，
这个数据和敌人就是强关联。

再举个例子，比如当前用户有金币的数据，这个金币的数据是属于当前用户的，它并不是属于某个游戏物体，所以这个金币数据必须要单独放到Model(数据)中，不能放到Object(View)中!



## 安装

> 推荐通过 Unity Package Manager 安装，点击Window/PackageManager 打开如下界面, 点击 + 选择 Add package from git URL...
> 
> ![UPM, add from Git URL dropdown](Documentation~/upm-via-git.png)
> 
>
> 1. 由于该插件依赖XFABManager,所以请先填入下面的地址来安装XFABManager(如已安装，请忽略)
>
> ```none
> https://gitee.com/xianfengkeji/xfabmanager.git
> ```
>
> 2. 填入下面的地址  安装最新版(推荐使用)
> ```none
> https://gitee.com/xianfengkeji/XFGameFramework.git
> ```
> 或安装指定版本
> ```none
> https://gitee.com/xianfengkeji/XFGameFramework.git#v1.0.3
> ```


## 文档

* [XFGameFramework 快速入门](Documentation~/XFGameFramework快速入门.md)
* [XFGameFramework API](Documentation~/XFGameFramework_API.md)：API文档
* [CHANGELOG](CHANGELOG.md)：版本修改记录
* [常见问题解答](Documentation~/faq.md)：记录常见问题


## 视频教程

https://www.bilibili.com/video/BV19Q4y1g7DW/
 
## 技术支持
 
XFGameFramework 交流群:946441033

## 常用插件推荐

[UI Particles 一款在UI中显示粒子特效的插件,可以很方便的控制层级](https://assetstore.unity.com/packages/tools/gui/ui-particles-72330) 

## 基于该框架的实战课程

[塔防游戏开发](https://www.bilibili.com/cheese/play/ss10031)

## 基于该框架的游戏

| 名称      | 商店 |
| ----------- | ----------- |
|  《flood of zombies》    | [Steam](https://store.steampowered.com/app/3347250/_/)        |  



## 特别说明

如有在使用该框架的过程中碰到任何bug,请及时与群主沟通，会尽快修复！！！

## 赞助框架

[请作者喝杯咖啡~](Documentation~/XFGameFramework_捐赠.md)

*该插件最低支持 Unity2020.3.48