Introduction

Welcome to Shard. Integrate auto-recording, track bugs and metrics, or spin up multiplayer servers with a click.

Choose Your Engine

Shard supports multiple game engines. Select your engine to get started:

Quick Start

1. Install the ShardKit CLI

The ShardKit CLI helps you manage recording and social events across all engines:

npm install -g @shard-dev/shardkit

2. Initialize Your Project

cd your-game-project
 
shardkit init

The CLI will prompt you for:

• Game name - Your game’s name
• Engine - godot3, godot4, unity, monogame, gamemaker, or rpgmaker
• Game type - Singleplayer or multiplayer
• Features - Recording, error tracking, social events

3. Install the SDK

Follow the engine-specific installation guide:

→ ShardKit CLI Reference

Features

All Shard SDKs provide the same core features with engine-specific APIs.

Recording

Automatically capture gameplay moments like boss fights, achievements, and speedruns. Players get clips without manual recording.

→ Get started with Recording

Error Tracking

Track errors in production with stack traces, breadcrumbs, and context. Debug issues faster with real-time telemetry.

→ Get started with Error Tracking

Social Events

Trigger contextual content in the launcher overlay based on in-game events.

→ Get started with Social Events

Multiplayer

Build competitive multiplayer games with authoritative servers, client-side prediction, and automatic state sync.

→ Get started with Multiplayer

Unified API

All SDKs follow the same API patterns. Here’s how to trigger a recording event in each engine:

ShardSDK.recording.trigger_event("myGame_bossDefeated")

ShardSDK.Recording.TriggerEvent("myGame_bossDefeated");

ShardSDK.Recording.TriggerEvent("myGame_bossDefeated");

shard_recording_trigger("myGame_bossDefeated");

ShardSDK.Recording.triggerEvent("myGame_bossDefeated");

SDK Consistency

All Shard SDKs share these characteristics:

Requirements

• Shard Launcher - Required for players (handles recording, error tracking, social features)
• Node.js 18+ - For ShardKit CLI (development only)
• Engine-specific requirements - See individual SDK documentation

Supported Platforms