Rumpetroll 项目技术文档

1. 安装指南

环境变量设置

在启动服务器之前，需要设置以下环境变量：

• MONGO_URL="rumpetroll"
• SOCKET_PORT=8180
• ORIGIN_WHITE_LIST=http://rumpetroll.com http://localhost:3000 http://rumpetroll.motherfrog.com
• TWITTER_APP_KEY=KEY
• TWITTER_APP_SECRET=SECRET
• TWITTER_CALLBACK=http://rumpetroll.com/auth.html

MongoDB 启动

确保在本地运行 MongoDB 守护进程，监听端口 27017。

启动服务器

通过执行 em/daemon.rb 文件来启动服务器。可选参数包括：

• --dev：启动服务器并接受来自任何来源的连接。
• --verbose：将 EventMachine WebSockets 设置为调试模式。

2. 项目的使用说明

Rumpetroll 是一个基于 HTML5 的大规模多人在线实验项目，由 Daniel Mahal、Hans Petter Eikemo、Hugo Ahlberg 和 Simen Brekken 发起。项目的主要功能是通过 WebSocket 实现实时多人在线互动。

主要功能

• 实时互动：用户可以通过浏览器实时与其他用户进行互动。
• Twitter 集成：支持通过 Twitter 进行身份验证。

使用步骤

1. 打开浏览器，访问 http://rumpetroll.com。
2. 如果需要，可以通过 Twitter 进行身份验证。
3. 进入游戏后，可以与其他在线用户进行实时互动。

3. 项目API使用文档

WebSocket API

Rumpetroll 使用 WebSocket 进行实时通信。服务器监听端口 8180，客户端可以通过 WebSocket 连接到服务器。

消息格式

WebSocket 消息采用 JSON 格式，常见的消息类型包括：

• join：用户加入游戏。
• move：用户移动。
• chat：用户发送聊天消息。

示例

{
  "type": "join",
  "username": "user123"
}

4. 项目安装方式

依赖库

Rumpetroll 项目使用了以下库：

• EventMachine：用于事件驱动的网络编程。
• em-websockets：用于 WebSocket 支持。
• oauth-ruby：用于 Twitter 身份验证。
• MongoDB：用于数据存储。
• em-mongo：用于 MongoDB 的异步驱动。

安装步骤

1. 克隆项目代码：

   git clone https://github.com/danielmahal/Rumpetroll.git
   

2. 进入项目目录：

   cd Rumpetroll
   

3. 安装依赖库：

   bundle install
   

4. 设置环境变量（见“安装指南”部分）。
5. 启动 MongoDB 守护进程。
6. 运行服务器：

   ruby em/daemon.rb
   

通过以上步骤，您可以成功安装并运行 Rumpetroll 项目。