Go to file
kercylan98 68378f2c58 LICENSE 2023-05-29 20:35:03 +08:00
.github README 2023-05-29 19:06:43 +08:00
component 文档及许可 2023-05-29 20:15:13 +08:00
config 文档及许可 2023-05-29 20:15:13 +08:00
examples 文档及许可 2023-05-29 20:15:13 +08:00
game 文档及许可 2023-05-29 20:15:13 +08:00
notify mod及import改为github.com/kercylan98/minotaur 2023-05-06 17:45:39 +08:00
planner/configexport 配置导出工具优化及示例 2023-05-19 14:09:36 +08:00
server 移除监控功能,不合理 2023-05-24 11:29:20 +08:00
tools/natapp natapp 2023-05-05 16:26:55 +08:00
utils 随机数范围错误修复 2023-05-29 15:44:48 +08:00
.gitignore 有限状态机实现 2023-05-26 10:49:16 +08:00
LICENSE LICENSE 2023-05-29 20:35:03 +08:00
README.md 文档 2023-05-29 20:24:01 +08:00
go.mod 简单2dAOI系统实现 2023-05-29 13:26:42 +08:00
go.sum 简单2dAOI系统实现 2023-05-29 13:26:42 +08:00
local-doc.bat 文档及许可 2023-05-29 20:15:13 +08:00
local-doc.sh 文档及许可 2023-05-29 20:15:13 +08:00

README.md

Minotaur

Go doc

Minotaur 是一个基于Golang 1.20 编写的服务端开发支持库,其中采用了大量泛型设计,用于游戏服务器开发。

未经严格测试,开发阶段,生产慎用!

目录结构概况

mindmap
  root((Minotaur))
    /component 通用组件接口定义
      /components 通用组件内置实现
    /config 针对配置导表的配置加载
    /game 游戏通用功能接口定义
      /builtin 游戏通用功能内置实现
    /notify 通知功能接口定义
    /planner 策划相关工具目录
      /configexport 配置导表功能实现
    /server 网络服务器支持
      /cross 内置跨服功能实现
      /router 内置路由器功能实现
    /tools 第三方工具
    /utils 常用辅助函数包

Server 架构预览

server-gdi.jpg

安装

注意:依赖于 Go 1.20 +

运行以下 Go 命令来安装软件包:minotaur

$ go get -u github.com/kercylan98/minotaur

用法

简单示例

创建一个基于Websocket的回响服务器。

package main

import (
	"github.com/kercylan98/minotaur/server"
)

func main() {
	srv := server.New(server.NetworkWebsocket)
	srv.RegConnectionReceiveWebsocketPacketEvent(func(srv *server.Server, conn *server.Conn, packet []byte, messageType int) {
		conn.Write(packet, messageType)
	})
	if err := srv.Run(":9999"); err != nil {
		panic(err)
	}
}

访问 WebSocket 在线测试 进行验证。

Websocket地址: ws://127.0.0.1:9999

事件

Miontaur 中,绝大多数场景都采用事件注册的方式进行回调,可通过XXX.RegXXXEvent的方式进行事件注册,例如:

package main

import (
	"github.com/kercylan98/minotaur/server"
)

func main() {
	srv := server.New(server.NetworkWebsocket)
	srv.RegConsoleCommandEvent("command", nil)
	srv.RegStartBeforeEvent(nil)
	srv.RegStartFinishEvent(nil)
	srv.RegConnectionClosedEvent(nil)
	srv.RegConnectionOpenedEvent(nil)
	srv.RegConnectionReceivePacketEvent(nil)
	srv.RegConnectionReceiveWebsocketPacketEvent(nil)
	srv.RegReceiveCrossPacketEvent(nil)
	srv.RegMessageErrorEvent(nil)
	srv.RegMessageLowExecEvent(nil)
}

其他的一些支持事件的结构体(非所有):

  • game.Room 游戏房间实现
  • synchronization.Map 并发安全的Map实现
  • ...

可选项

大部分的 New 函数均可使用可选项进行创建,具体函数前缀通常为 With

package main

import (
	"github.com/kercylan98/minotaur/server"
)

func main() {
	server.New(server.NetworkWebsocket, 
		server.WithTicker(50, false),
		server.WithProd(),
		server.WithMultiCore(3),
		// ...
	)
}

更多的网络模式

package main

import (
	"github.com/kercylan98/minotaur/server"
)

func main() {
	server.New(server.NetworkTcp)
	server.New(server.NetworkTcp4)
	server.New(server.NetworkTcp6)
	server.New(server.NetworkUdp)
	server.New(server.NetworkUdp4)
	server.New(server.NetworkUdp6)
	server.New(server.NetworkWebsocket)
	server.New(server.NetworkKcp)
	server.New(server.NetworkUnix)
	server.New(server.NetworkHttp)
	server.New(server.NetworkGRPC)
}