Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xiaonanln/goworld

Scalable Distributed Game Server Engine with Hot Swapping in Golang
https://github.com/xiaonanln/goworld

entities entity-framework game-server golang packets rpc

Last synced: 21 days ago
JSON representation

Scalable Distributed Game Server Engine with Hot Swapping in Golang

Host: GitHub
URL: https://github.com/xiaonanln/goworld
Owner: xiaonanln
License: apache-2.0
Created: 2017-06-03T15:02:46.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-11-27T09:58:03.000Z (11 months ago)
Last Synced: 2024-10-01T16:42:28.527Z (about 1 month ago)
Topics: entities, entity-framework, game-server, golang, packets, rpc
Language: Go
Homepage:
Size: 1.87 MB
Stars: 2,563
Watchers: 129
Forks: 458
Open Issues: 27
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-go - goworld - Scalable game server engine, featuring space-entity framework and hot-swapping. (Game Development / Search and Analytic Databases)
awesome-go - goworld - Scalable game server engine, featuring space-entity framework and hot-swapping. Stars:`2.6K`. (Game Development / Search and Analytic Databases)
awesome-go - goworld - Scalable Distributed Game Server Engine with Hot Swapping in Golang - ★ 835 (Game Development)
awesome-go-extra - goworld - 06-03T15:02:46Z|2022-08-13T16:51:10Z| (Game Development / Advanced Console UIs)

README

# GoWorld
_**Scalable Distributed Game Server Engine with Hot Reload in Golang**_

[![GoDoc](https://godoc.org/github.com/xiaonanln/goworld?status.png)](https://godoc.org/github.com/xiaonanln/goworld)
[![Build Status](https://api.travis-ci.org/xiaonanln/goworld.svg?branch=master)](https://travis-ci.org/xiaonanln/goworld) [![Go Report Card](https://goreportcard.com/badge/github.com/xiaonanln/goworld)](https://goreportcard.com/report/github.com/xiaonanln/goworld) [![codecov](https://codecov.io/gh/xiaonanln/goworld/branch/master/graph/badge.svg)](https://codecov.io/gh/xiaonanln/goworld)
[![ApacheLicense](https://img.shields.io/badge/license-APACHE%20License-blue.svg)](https://raw.githubusercontent.com/xiaonanln/goworld/master/LICENSE)

* [Features](#features)
* [Architecture](#architecture)
* [Introduction](#introduction)
* [Get GoWorld](#get-goworld)
* [Manage GoWorld Servers](#manage-goworld-servers)
* [Demos](#demos)
* [Chatroom Demo](#chatroom-demo)
* [Unity Demo](#unity-demo): [GoWorldUnityDemo.zip](https://drive.google.com/file/d/1A1CJCVWFQWa-iMuAoAdHZ4JoXTtU5Q7z/view?usp=sharing)
---------------------------------------
#### 中文资料
> [中文文档](https://godoc.org/github.com/xiaonanln/goworld/cn)
> [游戏服务器介绍](http://www.cnblogs.com/isaiah/p/7259036.html)
> [目录结构说明](https://github.com/xiaonanln/goworld/wiki/GoWorld%E6%B8%B8%E6%88%8F%E6%9C%8D%E5%8A%A1%E5%99%A8%E5%BC%95%E6%93%8E%E7%9B%AE%E5%BD%95%E7%BB%93%E6%9E%84)
> [使用GoWorld轻松实现分布式聊天服务器](https://github.com/xiaonanln/goworld/wiki/%E4%BD%BF%E7%94%A8GoWorld%E6%B8%B8%E6%88%8F%E6%9C%8D%E5%8A%A1%E5%99%A8%E5%BC%95%E6%93%8E%E8%BD%BB%E6%9D%BE%E5%AE%9E%E7%8E%B0%E5%88%86%E5%B8%83%E5%BC%8F%E8%81%8A%E5%A4%A9%E6%9C%8D%E5%8A%A1%E5%99%A8)

#### 游戏服务端开源引擎GoWorld教程
1.[安装和运行](https://zhuanlan.zhihu.com/p/66304813 "安装和运行")
2.[Unity示例双端联调](https://zhuanlan.zhihu.com/p/67065981 "Unity示例双端联调")
3.[手把手写一个聊天室](https://zhuanlan.zhihu.com/p/67951379 "手把手写一个聊天室")
4.[多个频道的聊天室](https://zhuanlan.zhihu.com/p/68901701 "多个频道的聊天室")
5.[登录注册和存储](https://zhuanlan.zhihu.com/p/70039615 "登录注册和存储")
6.[移动同步和AOI](https://zhuanlan.zhihu.com/p/70778081 "移动同步和AOI")
7.[源码解析之启动流程和热更新](https://zhuanlan.zhihu.com/p/72093172 "源码解析之启动流程和热更新")
8.[码解析之gate](https://zhuanlan.zhihu.com/p/73727839 "码解析之gate")
9.[源码解析之dispatcher](https://zhuanlan.zhihu.com/p/73906406 "源码解析之dispatcher")
10.[源码解析之entity](https://zhuanlan.zhihu.com/p/74736032 "源码解析之entity")

---------------------------------------
> **欢迎加入Go服务端开发交流群：[662182346](http://shang.qq.com/wpa/qunwpa?idkey=f2a99bd9bd9e6df3528174180aad753d05b372a8828e1b8e5c1ec5df42b301db)**
---------------------------------------
## 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](https://github.com/skywind3000/kcp) and WebSocket
* **Traffic Compression & Encryption**: traffic between clients and servers can be compressed and encrypted

## Architecture
![GoWorld Architecture](https://docs.google.com/drawings/d/e/2PACX-1vS20sn1rD-x23P6PpBV-C4Uy5BI6vry4TjKV9pBPtmoghlkH_aP24Ip4usyUciPRC6tpvsJX4Gufgvj/pub?w=960&h=720 "GoWorld 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 `SIGHUP` 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.

## Installing GoWorld
GoWorld requries Go 1.11+ to install.
```bash
go install github.com/xiaonanln/goworld/cmd/...
```

## Manage GoWorld Servers
Use command `goworld` to build, start, stop and reload game servers.

**Build Example Chatroom Server:**
```bash
$ goworld build examples/chatroom_demo
```

**Start Example Chatroom Server: (dispatcher -> game -> gate)**
```bash
$ goworld start examples/chatroom_demo
```

**Stop Game Server (gate -> game -> dispatcher):**
```bash
$ goworld stop examples/chatroom_demo
```

**Reload Game Servers:**
```bash
$ 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:**
```bash
$ 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
```

## 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:**
```bash
goworld build examples/chatroom_demo
```
**Run Server:**
```bash
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 at [github.com/xiaonanln/goworld-chatroom-demo-client](https://github.com/xiaonanln/goworld-chatroom-demo-client).
The project was created and built in [Cocos Creater 1.5](http://www.cocos2d-x.org/).

### 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

**Build Server:**
```bash
goworld build examples/unity_demo
```
**Run Server:**
```bash
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 at [https://github.com/xiaonanln/goworld-unity-demo](https://github.com/xiaonanln/goworld-unity-demo).
The project was created and built in [Unity 2017.1](https://unity3d.com/).

You can try the demo by downloading [GoWorldUnityDemo.zip](https://drive.google.com/file/d/1A1CJCVWFQWa-iMuAoAdHZ4JoXTtU5Q7z/view?usp=sharing).
The demo connects to a goworld server on Huawei Cloud instance.