shiny-engine

The shiny-engine is a modular distributed game server framework. Nodes and nodes use registration to associate messages for automatic routing. You can use the tool to generate the game logic structure data code into the framework, reducing the need to manually write tedious code.

Currently supports Window 64-bit systems and linux ubuntu 64-bit systems. Communication between nodes uses protobuf, zeromq, but communication with clients uses Socket TCP. Database currently only supports mysql.

The server architecture can look at some of the files in the doc directory. The current documentation is quite simple, mainly because the author is too lazy. Of course, follow-up will continue to complete the document and continue to improve the project.

Interested friends can contact me: Email: xqx83@hotmail.com Tencent QQ: 183708457

Why use shiny-engine

Distributed game server development general technology is relatively difficult and development cycle is relatively long. The traditional game server development model is to customize a distributed game framework for a game, so you should think it is not a common framework to solve Repeat the development of the framework and whether the public functions can be developed in advance through the framework. Whether it is possible to reduce the difficulty of development through an automated way, such as: automatic routing of messages, automatic update of data within the node server to the database, automatic memory management, automatic locking of multi-threaded operations, and so on.

With these problems, this framework was born.

为什么使用shiny-engine

分布式游戏服务端开发一般技术难度比较大而且开发周期比较长.传统的游戏服务端开发模式都是针对某款游戏定制一个分布式游戏框架,所以你应该会想是不是用通用的框架来解决重复开发框架的问题,并且能否通过框架的形式预先把公共的功能都开发好. 是否可以通过一种自动化的方式让开发难度降低,比如:自动路由消息,自动把节点内的数据更新到数据库,自动内存管理,多线程操作自动加锁等等.

就是带着这些问题,这套服务端框架就这样诞生了.

How to build

1.Building Shiny-Engine for Windows

Visual C++ .NET 2010

2.Building Shiny-Engine for Linux

Code::Blocks 16.01

如何编译

1.在Windows下编译 shiny-engine

Visual C++ .NET 2010

2.在Linux 下编译 shiny-engine

Code::Blocks 16.01

how to use

1. Set the configuration file for the node (Like agent_server, game_server, login_server, cache_server, etc. are all called nodes.)

Each node has a configuration file "App.config" (eg： agent_server path: agent_server\bin\win32\debug\App.config). Please set the corresponding field. The key field "ServerID" is not allowed to be duplicated.

2. Install Database for CacheServer

Each “CacheServer” node must have a database to configure related data. (For example: mysql_script\centredb\node_memcache.sql)
Each “CacheServer” node must also have a database for storing data. (For example: mysql_script\centredb\node_control_centre.sql)
Configure the node_control_centre.sql table information to node_memcache.sql (this process is equivalent to converting the relational table to a Key-Value structure)

3. GameServer is a template for all game logic nodes

The GameServer node can be expanded as a template: RankServer, BattleServer, ClanServer, and so on.

4. Let the tool generate code for GameServer that can automatically update data to the database

Use the tools\mc.rar tool to list fields in DataCodeGenerate\in.txt, such as:

// Character account ID
uint64_t account;
// Character Name
string name;
// Character level
int32_t level;
// Character experience
int32_t exp;

Then double-click DataCodeGenerate\Build.bat to get the code.

5. How nodes receive messages

Which receiving node's message the receiving node wants to receive requires that the receiving node's interested message be registered with the sending node.The interior of the node is assembled through modules. The receiving node registered in the sending node is also treated as a module.The messages processed in the module, that is, the messages that the module is interested in, also need to be listed and registered to the module management.
Therefore, what message the node needs to register needs to be registered, and the registration message is eventually divided into two steps:

Message registration between nodes
Message registration between modules within a node

Need special instructions:

They handle differently in the case of no message registration, no messages are registered between nodes, all messages are received, but the modules are no message is received without message registration.
The message is ultimately processed within the module.

Take GameServer as an example:
Messages sent by clients interested in the node are listed in the function "NodeProtocolInterests" in the file "game_server\src\framework\WorkerServiceImpHelper.h":

Static void NodeProtocolInterests(::node::InterestPacket& outInterests)  {  
    outInterests.add_interests(P_CMD_C_LOGIN);  
    outInterests.add_interests(P_CMD_S_LOGOUT);  
    outInterests.add_interests(P_CMD_C_PLAYER_RENAME);  
                    .
                    .
                    .
}

Then pass the "NodeProtocolInterests" function pointer to the CWorkerServiceImp instance.
CWorkerServiceImp instance is Defined in "game_server\src\framework\GameServer.cpp" function
bool Init(int argc, char** argv);
If the message is transmitted between nodes, Please list the message in the file "game_server\src\framework\WorkerServiceImpHelper.h" function "NodeNotificationInterests" :

Static void NodeNotificationInterests(::node::InterestPacket& outInterests) {
    outInterests.add_interests(N_CMD_KICK_LOGGED);
                    . 
                    .
                    .
}

Then pass the "NodeNotificationInterests" function pointer to the CWorkerServiceImp instance.

如何使用

1.为节点设置配置文件（像 agent_server、game_server、login_server、cache_server 等等，都称为节点）

每一个节点都有一个配置文件“App.config”（比如：agent_server 路径：agent_server\bin\win32\debug\App.config), 请设置下对应的字段。其中关键字段“ServerID” 是不允许重复的。

2.给CacheServer安装数据库

每个CacheServer节点必须设置一个数据库用于配置相关数据。（比如：mysql_script\centredb\node_memcache.sql）
每个CacheServer还必须要一个用于存储数据的数据库。（比如：mysql_script\centredb\node_control_centre.sql）
把 node_control_centre.sql 表信息配置到 node_memcache.sql (这个过程相当于把关系表转换成Key-Value结构）

3.GameServer 是所有游戏逻辑节点的模板

可以把 GameServer节点作为模板扩展成：排行服（RankServer）、战斗服（BattleServer)、公会服（ClanServer)等等。

4.让工具给GameServer生成可以自动更新数据到数据库的代码

使用 tools\mc.rar 工具，在 DataCodeGenerate\in.txt 列举出字段，比如:

// 角色账号ID
uint64_t account;
// 角色名称
string name;
// 角色等级
int32_t level;
// 角色经验
int32_t exp;

然后鼠标双击 DataCodeGenerate\Build.bat 获得代码。

5.节点如何接收消息

接收节点要收取哪个发送节点的消息就需要把接收节点感兴趣的消息注册给发送节点。节点内部是通过模块组合起来的，在发送节点里被注册过来的接收节点也是被当成一个模块处理的。模块内处理的消息，也就是模块感兴趣的消息，也需要列举出来注册到模块管理。
所以，节点接收什么消息就需要注册什么消息，注册消息最终分成两步:

节点间的消息注册
节点内模块间的消息注册

需要特别说明的是:

他们在没有消息注册的情况处理有所不同，节点间在没有消息注册的情况是接收所有消息，而模块间在没有消息注册的情况下是不接收任何消息。
消息最终是在模块内被处理。

以GameServer为例：
节点感兴趣的客户端消息在文件 "game_server\src\framework\WorkerServiceImpHelper.h" 的“NodeProtocolInterests”函数列举出来：

static void NodeProtocolInterests(::node::InterestPacket& outInterests) {    
    outInterests.add_interests(P_CMD_C_LOGIN);   
    outInterests.add_interests(P_CMD_S_LOGOUT);   
    outInterests.add_interests(P_CMD_C_PLAYER_RENAME);    
                    .      
                    .     
                    .    
 }

然后把“NodeProtocolInterests”函数指针传给 CWorkerServiceImp 实例。
CWorkerServiceImp 实例在 "game_server\src\framework\GameServer.cpp" 的 bool Init(int argc, char** argv)；函数内定义。
如果是节点间的消息请在 "game_server\src\framework\WorkerServiceImpHelper.h" 的“NodeNotificationInterests”函数列举出来:

static void NodeNotificationInterests(::node::InterestPacket& outInterests) {  
    outInterests.add_interests(N_CMD_KICK_LOGGED);  
                    .     
                    .     
                    .    
}

然后把“NodeNotificationInterests”函数指针传给 CWorkerServiceImp 实例。

huasonl/shiny-engine