tgf 项目安装和配置指南

tgf 项目安装和配置指南

tgf ​ tgf框架是使用golang开发的一套游戏分布式框架,支持全球一服.项目采用了rpcx做为底层rpc的通讯,consul提供服务注册发现.定义了一整套的模块开发规范. 项目地址: https://gitcode.com/gh_mirrors/tg/tgf

1. 项目基础介绍和主要的编程语言

tgf 是一个使用 Golang 开发的游戏分布式框架。该项目旨在为中小型团队和独立开发者提供一个开箱即用的项目框架，帮助他们快速开发游戏。框架提供了一整套开发工具，并定义了模块开发规范，开发者只需关注业务逻辑，无需关心用户并发和节点状态等复杂情况。

2. 项目使用的关键技术和框架

• Golang：项目的主要编程语言。
• rpcx：作为底层 RPC 的通讯框架。
• Consul：提供服务注册和发现功能。
• Redis：用于数据缓存。
• hashmap：线程安全的集合。
• ants：高性能 Go 协程池。
• redislock：分布式 Redis 锁。
• snowflake：雪花算法。
• doublejump：一致性哈希。
• godotenv：环境变量工具。
• zap：日志框架。
• lumberjack：日志切割工具。
• excelize：Excel 工具。
• sonic：高性能 JSON 工具。

3. 项目安装和配置的准备工作和详细的安装步骤

3.1 准备工作

在开始安装和配置之前，请确保您的开发环境满足以下要求：

• Golang 版本：1.22 或更高版本。
• Git：用于克隆项目代码。
• Consul：用于服务注册和发现。
• Redis：用于数据缓存。

3.2 安装步骤

3.2.1 克隆项目代码

首先，使用 Git 克隆项目代码到本地：

git clone https://github.com/thkhxm/tgf.git

3.2.2 安装依赖

进入项目目录并安装所需的依赖：

cd tgf
go mod download

3.2.3 配置环境变量

项目使用 .env 文件来管理环境变量。您可以在项目根目录下创建一个 .env 文件，并根据需要配置相关参数。例如：

# 示例配置
CONSUL_ADDRESS=127.0.0.1:8500
REDIS_ADDRESS=127.0.0.1:6379

3.2.4 启动 Consul

确保 Consul 服务已经启动并运行。您可以使用以下命令启动 Consul：

consul agent -dev

3.2.5 启动 Redis

确保 Redis 服务已经启动并运行。您可以使用以下命令启动 Redis：

redis-server

3.2.6 运行项目

在完成上述配置后，您可以使用以下命令运行项目：

go run main.go

3.3 验证安装

项目启动后，您可以通过访问默认的 API 端点来验证安装是否成功。默认情况下，项目会监听 8080 端口。您可以在浏览器中访问 http://localhost:8080 来查看项目是否正常运行。

4. 总结

通过以上步骤，您已经成功安装并配置了 tgf 项目。该项目提供了一个强大的游戏分布式框架，帮助开发者快速构建和部署游戏应用。如果您在安装和配置过程中遇到任何问题，可以参考项目的文档或加入项目的交流群进行讨论。

tgf ​ tgf框架是使用golang开发的一套游戏分布式框架,支持全球一服.项目采用了rpcx做为底层rpc的通讯,consul提供服务注册发现.定义了一整套的模块开发规范. 项目地址: https://gitcode.com/gh_mirrors/tg/tgf