Skip to content

rabbitmq message format.md

Latest commit

 

History

History
97 lines (80 loc) · 2.74 KB

rabbitmq message format.md

File metadata and controls

97 lines (80 loc) · 2.74 KB

RabbitMQ Message Format

This document describes the message formats used for communication with the game system via RabbitMQ.

Starting a Game

To start a game, send a message to the game_queue channel with the following JSON format:

Message Structure

{
  "pattern": "new_game",
  "data": {
    "ID": "550e8400-e29b-41d4-a716-446655440000",
    "Image": "ghcr.io/42core-team/game-server:dev",
    "Bots": [
      {
        "ID": "550e8400-e29b-41d4-a716-446655440001",
        "Image": "ghcr.io/42core-team/my-core-bot:dev",
        "RepoURL": "https://github.com/42core-team/my-core-bot.git",
        "Name": "My Core Bot"
      },
      {
        "ID": "550e8400-e29b-41d4-a716-446655440002",
        "Image": "ghcr.io/42core-team/my-core-bot:dev",
        "RepoURL": "https://github.com/42core-team/my-core-bot.git",
        "Name": "Gridmaster"
      }
    ]
  }
}

Field Descriptions

  • pattern: Always set to "start" for game initiation messages
  • data.ID: Unique identifier for the game (UUID format)
  • data.Image: Docker image for the game server
  • data.Bots: Array of bot configurations
    • ID: Unique identifier for each bot (UUID format)
    • Image: Docker image for the bot
    • RepoURL: Git repository URL for the bot's source code
    • Name: Display name for the bot/player

Game Results

Game results will be published to the game_results queue in the following format:

{
  "pattern": "game_server",
  "data": {
    "team_results": [
      {
        "id": 2,
        "name": "YOUR TEAM NAME HERE",
        "place": 1
      },
      {
        "id": 1,
        "name": "Gridmaster",
        "place": 0
      }
    ],
    "game_end_reason": 0,
    "version": "1.0.0",
    "game_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Result Field Descriptions

  • pattern: Always "game_result" for game completion messages
  • data.team_results: Array of team results ordered by performance
    • id: Team identifier
    • name: Team name
    • place: Final placement (0-based, where 0 is the winner)
  • data.game_end_reason: Reason code for game termination
  • data.version: API version
  • data.game_id: UUID of the completed game

Look here for the game_end_reasons: https://github.com/42core-team/even_COREnier/blob/31f3628798926ea97b99aa1939182c723f382f42/inc/game/ReplayEncoder.h#L18

Queue Names

  • Input Queue: game_queue - Send game start messages here
  • Output Queue: game_results - Listen for game completion results here

Notes

  • All UUIDs should be in standard UUID format
  • Docker images should be fully qualified with registry, repository, and tag
  • Repository URLs should be accessible Git repositories
  • The system expects exactly the structure shown above for proper message processing