# MeowFrameworkToolKit

**Repository Path**: vw112266/meow-framework-tool-kit

## Basic Information

- **Project Name**: MeowFrameworkToolKit
- **Description**: 基于meow-framework-的超高性能超强功能的整合全平台适配工具流框架
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 22
- **Forks**: 1
- **Created**: 2024-05-31
- **Last Updated**: 2026-01-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MeowFrameworkToolKit

## 介绍
#### MeowFrameWork-Tool-Kit 是对Meow或QF超高性能框架的整合全平台适配工具流框架！
![Alt text](<Documentation/MeowToolKit Logo1.png>)


#### 框架包含工具流
1、MeowFrameWork

2、资源管理(自行接入):Yooasset

3、导表:Luban

4、UI实现：Meow原生UI管理

5、融合工具： 

    ①CharacherController2D

    ②MoveablePlatform2D

    ③Overlap

    ④圆角UI工具（UI圆角）

    ⑤ASE

    ⑥DoTweenPro

    ⑦Native Gallery Plugin（安卓、IOS相册打开保存）


6、网络部分: Fantsy(正在接入最新版本Fantasy)、MqttNet

#### 安装教程与使用说明

[接入流程视频教程](<https://www.bilibili.com/video/BV17Z421M7Ks/?spm_id_from=333.1007.top_right_bar_window_history.content.click&vd_source=97fc06ed9ba2fd14ce1fa7aa0910acb7>)

1.  克隆当前项目，unity直接打开即可

2.  自己项目接入：

    1、Meow.Client 是框架更目录新项目可以直接UnityHub打开这个文件夹就创建项目了
        PS：如果想自己接入框架到已有项目可以直接复制“meow-framework-tool-kit\Meow.Client\Assets\MeowFramework”文件夹到项目内即可完成接入 

3.  入口脚本流程：

    1、初始化脚本入口为 GameInitGame.CS 挂载这个脚本即可接入完整流程

    2、Yooasset的编辑器下资源设置配置如下是需要设置的（可以自行配置到其他路径，这里只是提醒需要配置这2个文件资源）
    
![!\[Alt text\](image-2.png)](Documentation/image-2.png)

#### 文档 

[沿用QF部分API指南](<Documentation/V1.0.136 API指南.md>)

[沿用QF部分kit使用指南](<Documentation/v1.0.136 使用指南 .md>)

[框架任务调度器TaskScheduler使用说明](Documentation/TaskScheduler用户手册.md)

[CharacherController2D 快速入门](Documentation/CharacherController2DDocumentation/CharacherController2D_QuickStart.md)

[MoveablePlatform2D快速入门](Documentation/MoveablePlatform_Documentation/MoveablePlatform_QuickStart.md)

[Overlap_QuickStart 快速入门](Documentation/Overlap_Documentation/Overlap_QuickStart.md)

[圆角UI工具 使用说明](Documentation/UiRoundedCorners/圆角工具使用说明.md)

[安卓IOS相册调用 使用说明](Documentation/安卓IOS相册调用文档.md)


[Fantasy使用教程“待更新”](<https://www.bilibili.com/video/BV1mu4y1v7kt/?spm_id_from=333.788&vd_source=97fc06ed9ba2fd14ce1fa7aa0910acb7>)

 #### 入口说明   
    ```
                using Fantasy;
                using Panty.QF;
                using System;
                using UnityEngine;
                using UnityEngine.SceneManagement;
                using YooAsset;
                namespace Panty.Test
                {
                    public class GameInitHub : ModuleHub<GameInitHub>
                    {
                        protected override void BuildModule()
                        {
                            AddModule<IResLoader>(new YooResLoader());//接入yoo资源管理模块
                            AddModule<IYooassetDownLoadModule>(new YooassetDownLoadModule()); //接入yoo资源下载更新对比模块
                            AddModule<ILubanInitModule>(new LubanInitModule());//接入鲁班导表模块
                            AddModule<IAudioPlayer>(new AudioPlayer()); //接入音频管理模块
                            AddModule<IFantsyNetModel>(new FantsyNetModel()); //添加网络层模块

                            AddModule<IBagModule>(new BagModule());  //接入背包模块

                        }
                    }
                    public class GameInitContorl : MonoBehaviour, IPermissionProvider
                    {
                        #region 面板IP配置字段
                        [SerializeField]
                        private EPlayMode playMode = EPlayMode.EditorSimulateMode;
                        [SerializeField]
                        private string defaultHostServer;
                        [SerializeField]
                        private string fallbackHostServer;
                        #endregion
                        IModuleHub IPermissionProvider.Hub => GameInitHub.GetIns();
                        private void Awake()
                        {
                            DontDestroyOnLoad(this);
                        }
                        private void Start()
                        {
                            //资源下载初始化
                            this.SendCmd<SetDownLoadURL, (EPlayMode, string, string)>((playMode, defaultHostServer, fallbackHostServer));          
                            //资源下载检测完毕后进行网络链接
                            this.SendCmd<InitFantsyNetConnect, (NetworkProtocolType, string, string,float)>((NetworkProtocolType.KCP, "127.0.0.1","20000",6000f));        
                            this.AddEvent<StartGamesEvent>(StartGames).RmvOnDestroy(this); //资源核对下载成功进入游戏            
                        }
                        async void StartGames(StartGamesEvent @event)
                        {
                            //如果使用Fantsy网络能力，导表可以不使用Luban，可以直接使用方便双端同一种导表工具
                            this.Module<ILubanInitModule>().InitSingle();


                            //网络框架发送消息接收消息示例,注意自行配置ProtoBuf
                            var messag =(A2C_TestResponse)await this.Module<IFantsyNetModel>().scene.Session.Call(new C2A_TestRequest() 
                            {
                            Acc="Meow",
                            pawss="123456"               
                            });
                            Debug.Log(messag.Remessage);


                            //ZMUI使用示例
                            UIModule.Instance.Initialize();

                            UIModule.Instance.PopUpWindow<BagPanle>();

                            //等待3秒消毁窗口
                            await Awaitable.WaitForSecondsAsync(3);

                            //资源加载资源示例
                            var go = await this.Module<IResLoader>().AsyncLoad<GameObject>("DefaultPackage:女战士");
                            go.InstantiateWithParent(this);

                            var packegs = YooAssets.GetPackage("DefaultPackage");
                            //场景加载示例
                            var scenhand = YooAssets.LoadSceneSync("Test",LoadSceneMode.Additive);
                            
                        }
                    }
                    public class GameInitUI : UIPanel, IPermissionProvider
                    {
                        IModuleHub IPermissionProvider.Hub => GameInitHub.GetIns();
                    }
                }

    ```

    已经做好了API文档自行查看即可

#### 参与贡献

1.  https://gitee.com/PantyNeko/MeowFramework

2.  https://gitee.com/liangxiegame/QFramework