https://github.com/leancloud/multiplayer-server-plugin-getting-started
https://github.com/leancloud/multiplayer-server-plugin-getting-started
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/leancloud/multiplayer-server-plugin-getting-started
- Owner: leancloud
- Created: 2019-05-24T02:04:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T05:25:36.000Z (almost 2 years ago)
- Last Synced: 2025-01-09T10:33:02.630Z (about 1 year ago)
- Language: Python
- Size: 66.4 KB
- Stars: 2
- Watchers: 15
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# multiplayer server plugin getting started
## 测试服务器使用说明
测试服务器指在本地启动的游戏服务器，用于测试游戏的 Plugin 功能，可以用任意 APP ID 登录，但整个服务最多只能同时登录 20 个客户端。
为了能正常启动，请至少准备 512M 空余内存。需要提前安装 jdk8 以上版本 jdk。
### 启动
1. [在 Releases](https://github.com/leancloud/multiplayer-server-plugin-getting-started/releases) 内找最新一次 Release 记录打开 Assets 下载 game-standalone.tar.gz
1. 解压 game-standalone.tar.gz 后进入 game-standalone 目录
1. 执行 game-standalone 目录内 launch.sh 来启动 game 服务
1. game 服务启动后，launch.sh 会自动展示 game 服务的 STDOUT 输出，不关心其输出时可以 CTRL + C 退出，game 服务会在后台继续运行
1. 安装 python3 以及配合使用的 pip
1. 执行 `pip install -r multiplayer-server-plugin-getting-started/testing-tools/requirements.txt` 安装测试依赖
1. 执行 `multiplayer-server-plugin-getting-started/integration-test-scripts/run-tests.sh` 能正常运行完毕表示 Plugin 部署成功，并成功测试了作为示例的 `master_is_watching_you_plugin`
### 关闭
1. 进入 game-standalone 目录内执行 shutdown.sh 来关闭后台运行的 game 服务
### 重启
1. 进入 game-standalone 目录内执行 restart.sh 来重启后台运行的 game 服务
### 日志
game 服务在后台运行时产生的日志记录会留在 `game-standlone/logs` 目录内。目前日志名称和用途如下：
文件 | 说明
---- | ---
gc-XXX.current | GC 日志
server.log | game 服务运行日志
stdout.log | 进程的 STDOUT 输出
plugin.log | 用户实现的 plugin 输出的日志
event.log | 事件日志，如用户登录登出等
### 启动过程常见错误处理
1. game-standalone 启动后 STDOUT 输出 ”java.net.BindException: Address already in use“
该错误为当前系统运行了多个 game-standalone 服务，请通过查找并杀死系统内已经存在的 game-standalone 进程，再尝试重新启动 game-standalone 服务。
2. 启动 game-standalone 后提示错误 "service game-standalone is running, please check pid file."
请通过系统工具确认是否已经有 game-standalone 进程在系统内运行，如果有请将该进程杀死后重新执行启动 game-standalone 服务。如果没有，请在 game-standalone 目录下找到 proc.pid 文件并将其删除。之后重试启动 game-standalone 服务。
## 示例 Game Plugin 打包与部署
测试游戏服务器已经将最新版本的 multiplayer-server-plugin-getting-started 工程打包，测试游戏服务器启动后会自动加载 multiplayer-server-plugin-getting-started 实现的 Plugin。
在对 multiplayer-server-plugin-getting-started 工程做修改后，想打包新的 Plugin 至测试服务器方法如下：
1. 请先将游戏测试服务器运行起来
1. 进入修改后的 Plugin 工程，以 multiplayer-server-plugin-getting-started 为例就是进入 multiplayer-server-plugin-getting-started 目录下，执行 `mvn clean package`
1. 拷贝生成的 `multiplayer-server-plugin-getting-started/target/multiplayer-server-plugin-getting-started-xxx-jar-with-dependencies.jar` 至 `game-standalone/extensions`
1. 等待几秒后游戏测试服务器会自动加载新的 Plugin