Documentation

Everything you need to get started with GameGlass

🚀 Quick Start

Get your first dashboard running in 5 minutes

  1. Create a GameGlass account
  2. Add your game in the dashboard
  3. Generate an API key
  4. Install the SDK in your game (Unity, Godot, etc.)
  5. Set up a Raspberry Pi device
  6. Pair the device to your game
  7. Watch your metrics appear on the display!

📦 SDK Integration

Unity

// Install via Package Manager
// Add to your game initialization:
GameGlass.Initialize("your-api-key", "your-api-secret");

// Track CCU
GameGlass.TrackCCU(currentPlayers);

// Track custom events
GameGlass.TrackEvent("player_level_up", new {
    level = 5,
    player_id = "player123"
});

See our Unity SDK guide for complete integration instructions.

Godot

# Add GameGlass plugin to your project
# Initialize in your game:
GameGlass.initialize("your-api-key", "your-api-secret")

# Track metrics
GameGlass.track_ccu(current_players)
GameGlass.track_event("player_level_up", {"level": 5})

See our Godot SDK guide for complete integration instructions.

Web/JavaScript

// Install via npm
npm install @gameglass/sdk

// Initialize
import { GameGlass } from '@gameglass/sdk';
const gg = new GameGlass('your-api-key', 'your-api-secret');

// Track metrics
gg.trackCCU(currentPlayers);
gg.trackEvent('player_level_up', { level: 5 });

See our JavaScript SDK guide for complete integration instructions.

📺 Raspberry Pi Setup

Hardware Requirements

  • Raspberry Pi 4 (recommended) or Raspberry Pi 3B+
  • MicroSD card (16GB minimum, 32GB recommended)
  • HDMI cable and display/TV
  • Power supply (official Raspberry Pi power supply recommended)
  • WiFi connection or Ethernet cable

Installation Steps

  1. Download the GameGlass Raspberry Pi image from your dashboard
  2. Flash the image to your microSD card using Raspberry Pi Imager
  3. Insert the microSD card into your Raspberry Pi
  4. Connect HDMI cable and power supply
  5. Boot the Raspberry Pi - it will show a pairing code
  6. In your GameGlass dashboard, add a new device
  7. Enter the pairing code or scan the QR code
  8. Your dashboard will appear on the display!

Tip: The Raspberry Pi will automatically connect to WiFi if configured, or you can use Ethernet. It will auto-boot to the dashboard on startup.

🔌 API Reference

Authentication

All API requests require authentication using your API key and secret:

Authorization: Bearer your-api-key
X-API-Secret: your-api-secret

Track Event

POST /api/v1/events

{
  "event_type": "player_level_up",
  "data": {
    "level": 5,
    "player_id": "player123"
  }
}

Track CCU

POST /api/v1/metrics/ccu

{
  "value": 1250,
  "timestamp": "2025-12-09T12:00:00Z"
}

Get Metrics Summary

GET /api/v1/metrics/summary

Returns a summary of your game's metrics including current CCU, recent events, and trends.

💬 Need Help?

If you need assistance, we're here to help:

  • 📧 Contact Support
  • 💬 Join our Discord community
  • 📚 Check our FAQ section