Repository files navigation

Scalable Distributed Game Server Engine with Hot Reload in Golang

• Features
• Architecture
• Introduction
• Get GoWorld
• Manage GoWorld Servers
• Demos
  • Chatroom Demo
  • Unity Demo:GoWorldUnityDemo.zip

中文文档
游戏服务器介绍
目录结构说明
使用GoWorld轻松实现分布式聊天服务器

1.安装和运行
2.Unity示例双端联调
3.手把手写一个聊天室
4.多个频道的聊天室
5.登录注册和存储
6.移动同步和AOI
7.源码解析之启动流程和热更新
8.码解析之gate
9.源码解析之dispatcher
10.源码解析之entity

欢迎加入Go服务端开发交流群：662182346

• Spaces & Entities: manage multiple spaces and entities with AOI support
• Distributed: increase server capacity by using more machines
• Hot-Swappable: update game logic by restarting server process
• Multiple Communication Protocols: supports TCP,KCP and WebSocket
• Traffic Compression & Encryption: traffic between clients and servers can be compressed and encrypted

GoWorld server adopts an entity framework, in which entities represent all players, monsters, NPCs.Entities in the same space can visit each other directly by calling methods or access attributes.Entities in different spaces can call each over using RPC.

A GoWorld server consists of one dispatcher, one or more games and one or more gates.The gates are responsible for handling client connections and receive/send packets from/to clients.The games manages all entities and runs all game logic.The dispatcher is responsible for redirecting packets among games and between games and gates.

The game processes arehot-swappable.We can swap a game by sendingSIGHUP to the process and restart the process with-restore parameter to bring gameback to work but with the latest executable image. This feature enables updating server-side logic or fixing server bugstransparently without significant interference of online players.

GoWorld requries Go 1.11+ to install.

go install github.com/xiaonanln/goworld/cmd/...

Use commandgoworld to build, start, stop and reload game servers.

Build Example Chatroom Server:

$ goworld build examples/chatroom_demo

Start Example Chatroom Server: (dispatcher -> game -> gate)

$ goworld start examples/chatroom_demo

Stop Game Server (gate -> game -> dispatcher):

$ goworld stop examples/chatroom_demo

Reload Game Servers:

$ goworld reload examples/chatroom_demo

Reload will reboot game processes with the current executable while preserving all game server states.However, it does not work on Windows.

List Server Processes:

$ goworld status examples/chatroom_demo> 1 dispatcher running, 1/1 gates running, 1/1 games (examples/chatroom_demo) running> 2763      dispatcher      /home/ubuntu/go/src/github.com/xiaonanln/goworld/components/dispatcher/dispatcher -dispid 1> 2770      chatroom_demo   /home/ubuntu/go/src/github.com/xiaonanln/goworld/examples/chatroom_demo/chatroom_demo -gid 1> 2779      gate            /home/ubuntu/go/src/github.com/xiaonanln/goworld/components/gate/gate -gid 1

The chatroom demo is a simple implementation of chatroom server and client. It illustrates howGoWorld can also be used for games which don't divide players by spaces.

The chatroom demo provides following features:

• register & login
• send chat message
• switch chatrooms

Build Server:

goworld build examples/chatroom_demo

Run Server:

goworld start examples/chatroom_demo

Chatroom Demo Client:

Chatroom demo client implements the client-server protocol in Javascript.
The client for chatroom demo is hosted atgithub.com/xiaonanln/goworld-chatroom-demo-client.The project was created and built inCocos Creater 1.5.

Unity Demo is a simple multiple player monster shooting game to show how spaces and entities of GoWorldcan be used to create multiple player online games.

• register & login
• move players in space
• summon monsters
• player shoot monsters
• monsters attack players

Developing features:

• Hit effects
• Players migrate among multiple spaces
• Server side map navigation

Build Server:

goworld build examples/unity_demo

Run Server:

goworld start examples/unity_demo

Unity Demo Client:

Unity demo client implements the client-server protocol in C#.The client for unity demo is hosted athttps://github.com/xiaonanln/goworld-unity-demo.The project was created and built inUnity 2017.1.

You can try the demo by downloadingGoWorldUnityDemo.zip.The demo connects to a goworld server on Huawei Cloud instance.