ETFramework 项目教程

ETFramework 项目教程

ETFramework ET Extension Framework 项目地址: https://gitcode.com/gh_mirrors/et/ETFramework

1. 项目目录结构及介绍

ETFramework 是一个基于 Unity3D 和 C# 的客户端与服务端双端框架。以下是项目的目录结构及其介绍：

ETFramework/
├── Assets/
│   ├── Scripts/
│   │   ├── Client/
│   │   ├── Server/
│   │   ├── Shared/
│   ├── Config/
│   ├── Resources/
├── Packages/
├── ProjectSettings/
├── README.md
├── LICENSE
├── .gitignore
├── .gitattributes
├── ET.sln
├── Unity.sln
├── Unity.userprefs
├── Unity.log

目录结构介绍

• Assets/: 存放 Unity 项目的主要资源文件，包括脚本、配置文件、资源文件等。
  • Scripts/: 存放项目的脚本文件，分为客户端 (Client/)、服务端 (Server/) 和共享代码 (Shared/)。
  • Config/: 存放项目的配置文件，如数据库配置、网络配置等。
  • Resources/: 存放项目的资源文件，如图片、音频、预制体等。
• Packages/: 存放 Unity 项目的包管理文件。
• ProjectSettings/: 存放 Unity 项目的设置文件，如编辑器设置、播放器设置等。
• README.md: 项目的介绍文件，通常包含项目的概述、安装说明、使用说明等。
• LICENSE: 项目的开源许可证文件。
• .gitignore: Git 版本控制系统的忽略文件配置。
• .gitattributes: Git 版本控制系统的属性配置。
• ET.sln: 项目的 Visual Studio 解决方案文件。
• Unity.sln: Unity 项目的解决方案文件。
• Unity.userprefs: Unity 编辑器的用户偏好设置文件。
• Unity.log: Unity 编辑器的日志文件。

2. 项目启动文件介绍

ETFramework 的启动文件主要位于 Assets/Scripts/Server/ 目录下。以下是主要的启动文件及其介绍：

• ServerLauncher.cs: 服务端的启动文件，负责初始化服务端环境、加载配置文件、启动服务端进程等。
• ClientLauncher.cs: 客户端的启动文件，负责初始化客户端环境、加载配置文件、启动客户端进程等。

启动文件示例

// ServerLauncher.cs
using System;
using ET;

namespace ET
{
    public class ServerLauncher
    {
        public static void Main(string[] args)
        {
            try
            {
                // 初始化服务端环境
                Game.EventSystem.Init();

                // 加载配置文件
                ConfigHelper.LoadAll();

                // 启动服务端进程
                Game.Scene.AddComponent<NetOuterComponent>();
                Game.Scene.AddComponent<TimerComponent>();
                Game.Scene.AddComponent<OpcodeTypeComponent>();
                Game.Scene.AddComponent<MessageDispatcherComponent>();

                // 启动服务端
                Game.EventSystem.Run();
            }
            catch (Exception e)
            {
                Log.Error(e);
            }
        }
    }
}

3. 项目的配置文件介绍

ETFramework 的配置文件主要位于 Assets/Config/ 目录下。以下是主要的配置文件及其介绍：

• ServerConfig.json: 服务端的配置文件，包含服务端的网络配置、数据库配置、日志配置等。
• ClientConfig.json: 客户端的配置文件，包含客户端的网络配置、资源配置、日志配置等。

配置文件示例

// ServerConfig.json
{
    "Network": {
        "Port": 12345,
        "MaxConnections": 1000
    },
    "Database": {
        "ConnectionString": "Server=localhost;Database=ETFramework;User Id=sa;Password=123456;"
    },
    "Logging": {
        "LogLevel": "Debug",
        "LogFilePath": "Logs/ServerLog.txt"
    }
}

通过以上配置文件，可以灵活地调整服务端和客户端的运行参数，以适应不同的开发和生产环境。

---

以上是 ETFramework 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你快速上手并使用 ETFramework 进行开发。

ETFramework ET Extension Framework 项目地址: https://gitcode.com/gh_mirrors/et/ETFramework