/hk4e

『原神』 Game Server But Golang Ver.

Primary LanguageGoApache License 2.0Apache-2.0

hk4e

简介

『原神』 Game Server But Golang Ver.

本项目的目标为构建一个高性能高可用的ARPG游戏服务端,并非以完整还原游戏内原本功能点为目的

项目的客户端协议、配置表主要基于3.2版本修改而来,因此请尽量使用3.2版本的客户端,但不是必须的

3.2.0国际服客户端下载链接

客户端需要本地https代理和打破解补丁才能正常使用,详情请参考目前主流私服连接方法

可以使用新版补丁避免https代理,支持自定义密钥和连接任意地址的服务器,感谢Jx2f/mhypbase

特性

  • 原生的高可用集群架构,任意节点宕机不会影响到整个系统,可大量水平扩展
  • 玩家级无状态游戏服务器,无锁单线程模型,开发省时省力,完善的玩家数据交换机制(内存-缓存-数据库),拒绝同步阻塞的数据库访问
  • 新颖的玩家在线跨服无缝迁移功能
  • 独创的网关服务器侧客户端协议代理转换功能,拒绝因协议号消息号混淆而带来代码改动的烦恼
  • 完整的密钥交换机制实现,安全性++,拒绝一个写死的随机数种子和XOR密钥文件用到天荒地老

编译和运行环境

  • Go >= 1.18
  • Protoc >= 3.21
  • Protoc Gen Go >= 1.28
  • Docker >= 20.10
  • Docker Compose >= 1.29

本项目未使用CGO构建,理论上Windows、Linux、macOS系统都可以编译运行

快速启动

  • 首次需要安装工具
make dev_tool
  • 生成协议
make gen_natsrpc      # 生成natsrpc协议
make gen_proto        # 生成客户端协议
make gen_client_proto # 生成客户端协议代理(非必要 详见gate/client_proto/README.md)
  • 构建
make build         # 构建服务器二进制文件
make docker_config # 复制配置模板等文件
make docker_build  # 构建镜像
  • 启动
cd docker
# 启动前请先确保各服务器的配置文件正确(如docker/node/bin/application.toml)
docker-compose up -d # 启动服务器

第三方组件

  • mongodb
  • nats-server
  • redis

服务器组件

  • node 节点服务器 (仅单节点 有状态)
  • dispatch 登录服务器 (可多节点 无状态)
  • gate 网关服务器 (可多节点 有状态)
  • anticheat 反作弊服务器 (可多节点 有状态 尚不完善非必要启动)
  • pathfinding 寻路服务器 (可多节点 无状态 尚不完善非必要启动)
  • gs 游戏服务器 (可多节点 有状态)
  • gm 游戏管理服务器 (仅单节点 无状态)

其它

  • 独立运行需要配置环境变量
GOLANG_PROTOBUF_REGISTRATION_CONFLICT=ignore

代码提交规范

  • 提交前必须进行go fmt(GoLand可在commit窗口的设置里勾选,默认是启用的)
  • 进行全局格式化时,请跳过gdconf目录,这是配置表数据,包含大量的json、lua、txt等文件
  • 单行注释的注释符与注释内容之间需要加一个空格(GoLand可在设置Editor/CodeStyle/Go/Other里打开)
  • 导入包时需要将标准库、本地包、第三方包用空行分开(GoLand可在设置Editor/CodeStyle/Go/Imports里打开)