GoWorld

Scalable Distributed Game Server Engine with Hot Reload in Golang

Features
Architecture
Introduction
Get GoWorld
Manage GoWorld using goworld.py
Demos
- Chatroom Demo
- Unity Demo

中文资料：游戏服务器介绍目录结构说明使用GoWorld轻松实现分布式聊天服务器 欢迎加入Go服务端开发交流群：662182346

Features

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

Architecture

Introduction

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 are hot-swappable. We can swap a game by sending SIGUSR1 to the process and restart the process with -restore parameter to bring game back to work but with the latest executable image. This feature enables updating server-side logic or fixing server bugs transparently without significant interference of online players.

Get GoWorld

$ go get github.com/xiaonanln/goworld

Install dependencies

GoWorld uses Dep to manage packages.

Install Go Dep:

go get -u github.com/golang/dep/cmd/dep

Install Dependencies:

Windows: run install-deps-win.bat

Linux: $ make install-deps

For Chinese only: **的朋友可能会碰到网络问题，那么您可以通过点击下载vendor.zip，并将其解压到goworld根目录下。不过vendor.zip里的内容有可能不是最新的。

Manage GoWorld using goworld.py

goworld.py is a script for managing goworld server easily. Running goworld.py requires python 2.7.x and psutil module. We can use goworld.py to build, start, stop and reload game servers.

$ pip install psutil

Build Dispatcher & Gate:

$ python goworld.py build dispatcher gate

Build Example Chatroom Server:

$ python goworld.py build examples/chatroom_demo

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

$ python goworld.py start examples/chatroom_demo

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

$ python goworld.py stop

Reload Game Servers:

$ python goworld.py reload

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

Demos

Chatroom Demo

The chatroom demo is a simple implementation of chatroom server and client. It illustrates how GoWorld 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:

$ python goworld.py build dispatcher gate chatroom_demo

Run Server:

$ python goworld.py start chatroom_demo

Chatroom Demo Client:

Chatroom demo client implements the client-server protocol in Javascript.
The client for chatroom demo is hosted at github.com/xiaonanln/goworld-chatroom-demo-client. The project was created and built in Cocos Creater 1.5. A running server and client demo can also be found at http://goworldgs.com/chatclient/.

Unity Demo

Unity Demo is a simple multiple player monster shooting game to show how spaces and entities of GoWorld can 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