KBEngine

文档

安装

(注意：使用这种方式安装必须已经完成建立步骤)

在一个(Windows/Centos/Redhat/Debian/Ubuntu 等等)系统中安装KBEngine服务端, 请在命令行输入:

python kbengine/kbe/tools/server/install/installer.py install

如果你不信任脚本， 你也可以选择手动安装。

手动安装（注意：“可选”部分可以略过）

1. 创建kbe系统用户(可选)

创建一个独立的用户来运行KBEngine将会更加安全可靠以及便于维护。

如果您对此比较了解也可以省略这一步, 直接使用您的当前用户。

Linux:

	[root@localhost ~]# useradd kbe
	[root@localhost ~]# passwd pwd123456

	New UNIX password: ******
	Retype new UNIX password: ******
	passwd: all authentication tokens updated successfully 

Windows:
	"控制面板" -> "用户帐户" -> "创建一个新帐户"

2. 设置环境变量:(可选)

（提醒：在服务端资产库启动服务器的脚本中已经具备自动化临时设置环境变量正确启动服务器功能，因此没有特别复杂的部署需求可略过该章节。）

KBEngine会读取系统中设置的(KBE_ROOT, KBE_RES_PATH, KBE_BIN_PATH)环境变量, 环境变量的意义:

UID:

	操作系统用户账号的uid将被用于区分不同的服务器组，如果是多台硬件服务器共同维护一组服务，
	那么每一台机器上的系统uid环境变量都应该保持一致，否则无法形成服务组。
	另外uid必须大于0, 小于32767.
	(注意: Windows系统账号没有UID属性， 需要用户自己添加这个环境变量)

KBE_ROOT:

	引擎根目录。


KBE_RES_PATH:

	不同路径使用':'或者';'分隔, Windows由于操作系统规则必须使用';'分隔，默认情况下资源路径中第一个资源路径
	是引擎的资源路径， 第二个资源路径是用户脚本的资源路径。


KBE_BIN_PATH:

	引擎可执行文件所在目录。

按照如下步骤设置环境变量:

Linux: (假如kbe被安装在~/目录)

	[kbe@localhost ~]$ vim ~/.bashrc

	ulimit -c unlimited
	export KBE_ROOT=~/kbengine/
	export KBE_RES_PATH=$KBE_ROOT/kbe/res/:$KBE_ROOT/assets/:$KBE_ROOT/assets/scripts/:$KBE_ROOT/assets/res/
	export KBE_BIN_PATH=$KBE_ROOT/kbe/bin/server/
	
	使环境变量生效:
	[kbe@localhost ~]$ source ~/.bashrc

	操作系统用户账号的uid将被用于区分不同的服务器组，如果是多台硬件服务器共同维护一组服务，
	那么每一台机器上的系统uid环境变量都应该保持一致，否则无法形成服务组。
	另外uid必须大于0, 小于32767.

	root权限设置用户kbe的uid(假如设置为10103):
	[root@localhost ~]# usermod -u 10103 kbe
	

Windows:

	鼠标右键点击: "我的电脑"->"高级"->"环境变量"， 然后设置(假如安装在C盘)

	KBE_ROOT = C:/kbengine/
	KBE_RES_PATH = %KBE_ROOT%/kbe/res;%KBE_ROOT%/assets/;%KBE_ROOT%/assets/scripts;%KBE_ROOT%/assets/res/
	KBE_BIN_PATH = %KBE_ROOT%/kbe/bin/server/
	
	操作系统用户账号的uid将被用于区分不同的服务器组，如果是多台硬件服务器共同维护一组服务，
	那么每一台机器上的系统uid环境变量都应该保持一致，否则无法形成服务组。
	另外uid必须大于0, 小于32767.

	(注意: 在Linux上系统账号的id就是uid，Windows系统账号没有UID属性，需要用户自己添加这个环境变量，这里假如设置成10103)

	UID = 10103

3. 安装数据库:

安装Mysql:

Linux:

	安装
	[root @ localhost ~]# yum install mysql-server
	
	设定为开机自动启动
	[root @ localhost ~]# chkconfig mysqld on

	启动mysql服务
	[root @ localhost ~]# /etc/init.d/mysqld start

	检查是否启动成功
	[root@localhost ~]# /etc/init.d/mysqld status
	mysqld (pid  9234) is running...

Windows:

	下载并安装最新版本:
	http://dev.mysql.com/downloads/windows/

	(重启Mysql, CMD输入如下命令:)
	net stop mysql
	net start mysql

	检查Mysql大小写是否敏感:
	mysql> create database NEWTEST;
	mysql> show databases;
	+--------------------+
	| Database           |
	+--------------------+
	| information_schema |
	| NEWTEST            |
	| mysql              |
	| test               |
	+--------------------+
	4 row in set (0.00 sec)

创建数据库，假设是数据库名为”kbe”

	mysql> create database kbe;

删除匿名用户（一些系统中不删除匿名用户会出现使用kbe账号用本地IP登录mysql被拒绝访问）

	mysql> use mysql 
	mysql> delete from user where user=''; 
	mysql> FLUSH PRIVILEGES;

创建数据库用户，用户名是”kbe”，密码假设是”pwd123456”

	mysql> grant all privileges on *.* to kbe@'%' identified by 'pwd123456';
	mysql> grant select,insert,update,delete,create,drop on *.* to kbe@'%' identified by 'pwd123456';
	mysql> FLUSH PRIVILEGES;

	在CMD中测试一下是否能使用这个账号登陆Mysql(请注意默认Mysql端口为3306， 如不一致请修改
	kbengine_defaults.xml->dbmgr-><port>330x</port>)。

	另外请不要使用其他任何第三方工具来测试，必须使用mysql进行测试，第三方工具为了能够正确的连接到
	Mysql可能会采用一些兼容的方式，但这对于游戏服务端来说是不可靠的方式，权限应该由用户明确的设置。

	进入你的mysql安装目录找到mysql.exe所在目录, 然后cmd进入这个目录中执行如下语句:
	(如果没有提示错误则账号配置完毕，有错误请google)

	Windows:
		进入你的mysql安装目录找到mysql.exe, 然后在CMD执行如下命令:
		C:\mysql\bin> mysql -ukbe -ppwd123456 -hlocalhost -P3306

	Linux:
		[root@localhost ~] mysql -ukbe -ppwd123456 -hlocalhost -P3306

如果要修改数据库名称请修改res\server[kbengine_defaults.xml]配置中dbmgr段的databaseName参数 (建议在assets\res\server[kbengine.xml]中进行重载修改，这样kbengine在做改动后开发者更新时不会发生冲突)。

4. 优化操作系统(仅Linux) (可选)

设置允许打开的最大文件数 /etc/security/limits.conf:

	soft nofile 65535
	hard nofile 65535

修改socket发送窗口与接收窗口最大缓冲:

	[root@localhost ~]# echo 524288 > /proc/sys/net/core/rmem_max
	[root@localhost ~]# echo 524288 > /proc/sys/net/core/wmem_max
	
	可适当调整[kbengine_defaults.xml]->channelCommon->***BufferSize

参考: 高性能Linux服务器配置

5: 多网卡环境配置: (可选)

如果eth0是外部网卡地址, eth1是内部网卡地址执行如下命令设置广播地址为内部网卡地址（仅Linux）:

	/sbin/ip route del broadcast 255.255.255.255 dev eth0
	/sbin/ip route add broadcast 255.255.255.255 dev eth1
同时请设置引擎配置(kbengine.xml kbengine_defaults.xml)中的相关选项为如下: 
	baseapp 	: externalInterface = eth0, internalInterface = eth1
	loginapp	: externalInterface = eth0, internalInterface = eth1
	interfaces 	: externalInterface = eth0, internalInterface = eth1
	[others]	: externalInterface = eth1, internalInterface = eth1

	（注意：eth0、eth1为网卡名称，也可以直接配置对应的IP地址或MAC地址）

6. Linux 防火墙设置: (可选)

参考: Linux防火墙设置

7. 局域网内部署多组KBE服务器设置: (可选)

何为一组KBE服务器? 共同维护一个游戏世界的服务器组, 这些服务器上包含了整个KBE架构。

多个用户在同一个局域网, 并且都想部署一套自己的KBE服务器，那么需要注意两个地方:

1: 环境变量中的UID必须不能相同(查看系统中是否有设置过UID)
	UID用于区分不同的服务组。

2: 启动脚本中的cid必须唯一(kbengine\kbe\bin\server\start***)
	*** --cid=必须唯一 --grouporder=1  --globalorder=1
	cid既componentID, 用于标识一个KBE-APP, 如果探测到2个一样的cid必然会引起冲突。

8. IP与端口设置: (可选)

参考详细配置说明：kbengine.xml

数据库IP：

[kbengine.xml]->dbmgr->ip

数据库端口：

[kbengine.xml]->dbmgr->port

客户端登录IP：

[kbengine.xml]->loginapp->externalInterface
（由于读取的是网卡地址，某些环境下无法获得正确的ip地址，例如端口映射方式与外网交互，此时应该设置[kbengine.xml]->loginapp->externalAddress）

客户端登录端口：

[kbengine.xml]->loginapp->externalPorts_min

HTTP回调（EMAIL认证、密码重置）:

[kbengine.xml]->loginapp->http_cbport

BaseappIP：

[kbengine.xml]->baseapp->externalInterface
（由于读取的是网卡地址，某些环境下无法获得正确的ip地址，例如端口映射方式与外网交互，此时应该设置[kbengine.xml]->loginapp->externalAddress）

BaseappIP端口：

[kbengine.xml]->baseapp->externalPorts_min

Telnet服务端口(baseapp)：

[kbengine.xml]->baseapp->telnet_service->port

Telnet服务端口(cellapp)：

[kbengine.xml]->cellapp->telnet_service->port

压力测试虚拟客户端登录服务端的IP：

[kbengine.xml]->bots->ip

压力测试虚拟客户端登录服务端的端口：

[kbengine.xml]->bots->port

压力测试虚拟客户端Telnet服务端口：

[kbengine.xml]->bots->telnet_service->port

提供给工具明确连接的端口：

[kbengine.xml]->machine->externalPorts_min

运营接入服务监听的IP：

[kbengine.xml]->interfaces->ip

运营接入服务监听的端口：

[kbengine.xml]->interfaces->port

第三方计费服务的请求地址（计费，登录，等等）：

[kbengine.xml]->interfaces->thirdpartyChargeService_addr

第三方计费服务的请求端口（计费，登录，等等）：

[kbengine.xml]->interfaces->thirdpartyChargeService_port

第三方服务回调端口（计费，登录，等等）：

[kbengine.xml]->interfaces->thirdpartyService_cbport