Heroic Labs Logo
Login to Heroic Cloud

Documentation

  • Nakama
    • Getting Started
      +
      -
      • Overview
      • Installation
        +
        -
        • Overview
        • Docker Compose
        • Windows
        • macOS Binary
        • Linux
      • CLI Commands
      • Configuration
      • Upgrading
      • Metrics
      • Nakama Console
        +
        -
        • Overview
        • Status
        • User Management
        • Configuration
        • Runtime Modules
        • Accounts
        • User Groups
        • Storage
        • Leaderboards
        • Chat Messages
        • Purchases
        • Subscriptions
        • Matches
        • API Explorer
      • Architecture Overview
      • Benchmarks
      • Data Privacy
      • Release Notes
    • Concepts
      +
      -
      • Overview
      • Authentication
      • Sessions
        +
        -
        • Overview
        • Session Management
      • User accounts
      • Storage Engine
        +
        -
        • Overview
        • Collections
        • Access Controls
        • Storage Search
        • Modeling for Scalability
      • Friends
        +
        -
        • Overview
        • Best Practices
      • Groups
        +
        -
        • Overview
        • Groups Best Practices
      • Real-time Chat
      • Parties
      • Multiplayer Engine
        +
        -
        • Overview
        • Client Relayed Multiplayer
        • Authoritative Multiplayer
        • Session-Based Multiplayer
        • Match Listing
        • Matchmaker
          +
          -
          • Overview
          • Offline Matchmaking
        • Query Syntax
      • Status
      • Leaderboards
        +
        -
        • Overview
        • Leaderboards Best Practices
      • Tournaments
      • Notifications
      • In-app Purchase Validation
      • Events
      • Sockets
    • Server Framework
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Runtime Context
        • Hooks
      • TypeScript Runtime
        +
        -
        • Overview
        • Function Reference
          +
          -
          • Overview
          • Match Handler API
          • Match Runtime API
        • Code Samples
      • Go Runtime
        +
        -
        • Overview
        • Function Reference
          +
          -
          • Overview
          • Match Handler API
          • Match Runtime API
        • Code Samples
        • Dependency Pinning
      • Lua Runtime
        +
        -
        • Overview
        • Function Reference
          +
          -
          • Overview
          • Match Handler API
          • Match Runtime API
        • Code Samples
      • Server Runtime Examples
        +
        -
        • Overview
        • Server To Server
      • Streams
      • Server Configuration
    • Client Libraries
      +
      -
      • Overview
      • Game Console SDKs
      • Unity/.Net
      • Unreal
      • C++
      • JavaScript
      • Dart (Flutter)
      • Godot 3
      • Godot 4
      • Swift
      • Java/Android
      • Cocos2d-x C++
      • Cocos2d-x JavaScript
      • Defold
      • Snippets
        +
        -
        • Overview
        • Authoritative In-game Items
        • Authoritative Storage
        • Banning Users
        • Custom Authentication
        • Updating Group Metadata
        • Updating User Metadata
    • API
      +
      -
      • Overview
      • Client
      • Console
    • Tutorials
      +
      -
      • Overview
      • Godot
        +
        -
        • Overview
        • Fish Game
      • JavaScript
        +
        -
        • Overview
        • Tic-Tac-Toe PhaserJS
      • .Net/Unity
        +
        -
        • Overview
        • Fish Game
        • Pirate Panic
          +
          -
          • Overview
          • Authentication
          • Friends
          • Clans
          • Storage
          • Matchmaking
          • Multiplayer
          • Leaderboards
          • Notifications
        • Ninja Battle
    • Guides
      +
      -
      • Overview
      • Concepts
        +
        -
        • Overview
        • Edgegap Integration
        • GameLift Fleet Management
        • Bucketed Leaderboards
        • Custom Authentication with Third-Party Services
        • Custom Leaderboards
        • Creating an Economy
        • Daily Rewards
        • Initialize a New User
        • Matchmaking Around Blocked Users
        • Passive Multiplayer
        • Tiered Leagues
        • Creating a Lobby System
        • Unread Chat Messages
      • Server Framework
        +
        -
        • Overview
        • Satori Integration
        • Background Jobs
        • Debugging with Delve
          +
          -
          • Overview
          • Using VSCode Debugger
          • Using Goland Debugger
        • Guarding APIs
        • Sending Email Using SendGrid
        • Testing TypeScript Server Runtime Code with Jest
        • Using Hooks
      • Deployment
        +
        -
        • Overview
        • Asset Management
        • Deploy on Digital Ocean
        • Remote Configuration
    • Videos
  • Hiro
    • Concepts
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Release Notes
      • Getting Started
        +
        -
        • Overview
        • Installation
        • Configurations
        • GDD Templates
      • Achievements
        +
        -
        • Overview
        • Sub Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
        +
        -
        • Overview
        • Donations
        • Rewarded Video
        • Rewards
        • Virtual Currencies
        • Virtual Store
      • Energy
        +
        -
        • Overview
        • Energy Modifiers
      • Event Leaderboards
      • Incentives
      • Integrations
      • Inventory
      • Leaderboards
      • Personalizer
      • Progression
      • Publishers
      • Stats
      • Streaks
      • Teams
        +
        -
        • Overview
        • Team Achievements
        • Team Event Leaderboards
        • Team Inventory
        • Team Mailbox
        • Team Stats
        • Team Store
        • Team Wallet
      • Tutorials
      • Unlockables
    • Unity
      +
      -
      • Overview
      • Getting Started
        +
        -
        • Overview
        • Initializing the NakamaSystem
        • Creating Custom Systems
        • Observing System Changes
      • Offline Support
      • Achievements
      • Analytics
      • Auctions
      • Base
      • Challenges
      • Economy
        +
        -
        • Overview
        • Donations
        • Rewarded Video
        • Virtual Currencies
        • Virtual Store
      • Energy
      • Event Leaderboards
      • Incentives
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Unreal
      +
      -
      • Overview
      • Getting Started
        +
        -
        • Overview
        • Initializing the HiroClient
        • Blueprints Visual Scripting
        • Online Subsystem
      • Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
      • Energy
      • Event Leaderboards
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • C++
      +
      -
      • Overview
      • Achievements
      • Auctions
      • Base
      • Economy
      • Challenges
      • Energy
      • Event leaderboards
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Dart
      +
      -
      • Overview
      • Getting Started
      • Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
      • Energy
      • Event leaderboards
      • Incentives
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • TypeScript
      +
      -
      • Overview
      • Getting Started
      • Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
      • Energy
      • Event leaderboards
      • Incentives
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Godot
      +
      -
      • Overview
      • Getting Started
      • Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
      • Energy
      • Event leaderboards
      • Incentives
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Python
      +
      -
      • Overview
      • Getting Started
      • Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
      • Energy
      • Event leaderboards
      • Incentives
      • Inventor
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Server Framework
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Core Functions and Hooks
      • Achievements
      • Auctions
      • Base
      • Economy
      • Energy
      • Event Leaderboards
      • Incentives
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Guides
      +
      -
      • Overview
      • Gameplay Mechanics
        +
        -
        • Overview
        • Battle Pass
        • Collectible Cards (Clash Royale)
        • Event Leaderboard (Royal Match King's Cup)
        • In-Game Store (Fall Guys Style)
        • Quests (Hearthstone Quests)
        • Solo Live Event (Fortnite Style)
      • Personalizer
        +
        -
        • Overview
        • Level-Based Stats
        • One Time Store Offers
      • Server Framework
        +
        -
        • Overview
        • Testing Hiro RPCs via API Client
        • Unregister RPCs
  • Satori
    • Concepts
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Overview
        • Dashboard
        • Release Notes
      • Identities
        +
        -
        • Overview
        • Properties
        • Events
        • Audiences
        • Feature Flags
        • Experiments
        • Live Events
        • Messages
      • Audiences
        +
        -
        • Overview
        • Filter Expressions
        • Audience Computation
      • Feature Flags
        +
        -
        • Overview
        • Fetching Player Flags
      • Metrics
      • Experiments
      • Live Events
      • Messages
        +
        -
        • Overview
        • Templates
        • Message Schedules
        • Integrations
          +
          -
          • Overview
          • OneSignal
        • Direct Message
      • Reports
      • Taxonomy
      • Settings
        +
        -
        • Overview
        • Data Lakes
          +
          -
          • Overview
          • BigQuery
          • Snowflake
        • Webhooks
      • Category Labels
    • Client Libraries
      +
      -
      • Overview
      • Defold
      • Unity/.Net
      • JavaScript
      • Java/Android
      • Godot
      • Dart (Flutter)
      • Swift
    • Guides
      +
      -
      • Overview
      • Experimenting with Audiences
      • Personalized Content
      • Return Incentives
      • Targeting Lapsed Spenders
      • A/B Testing
      • How to Use Satori & Databricks to Predict and Prevent Player Churn
    • Console API
  • Heroic Cloud
    • Concepts
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Creating an Account
        • AWS Marketplace Sign Up
        • Whitelisting IP Addresses
      • Organizations
        +
        -
        • Overview
        • Settings
      • Projects
        +
        -
        • Overview
        • Managing Projects
      • Builders
        +
        -
        • Overview
        • Managing Builders
        • Best Practices

Products

  • Nakama
    • Social gameplay
    • Multiplayer
    • Competitive
    • Customization
  • Hiro
  • Satori
    • Experiments and Live Events
    • Event Capture
    • Segmentation Engine
    • Analytics Engine
  • Heroic Cloud
    • Pricing

Company

  • Customers
  • Case Studies
  • Partners
  • Blog
  • Team
  • Forum
  • GitHub
  • Twitter

Deploy Nakama and Satori

Get Started

  • Products
    Nakama

    The leading open source game server for online and social games.

    Hiro

    A Nakama toolkit to rapidly build standardized meta game features.

    Satori

    LiveOps: events, audiences, feature flags, experiments and more.

    Heroic Cloud

    Deploy and scale your Heroic Gamestack on our managed cloud platform.

    Heroic Cloud

    A managed or private cloud built for scaling the Heroic Game stack for the biggest games.

    • Nakama on Heroic Cloud
    • Satori on Heroic Cloud
    • Sign Up Login

    Deploy Nakama and Satori

    Get Started

  • Company

    Company

    • Customers
    • Case Studies
    • Partners
    • Team

     

    • Blog
    • Newsletter
    • Twitter
    • Contact Us
    We're Hiring

    A Heroic Ten Years: Special letter from our CEO, and invitation to our birthday party!

    Be part of the journey

    Heroic Labs Celebrates the Launch of FBC: Firebreak, a Co-op Shooter from Remedy Entertainment.

    Launch announcement

    Realism Meets Tactics in an Open-world MMOFPS: Powering Gray Zone Warfare to Early Success.

    In-depth case study

  • Docs

    Documentation

    • Nakama
    • Hiro
    • Satori
    • Heroic Cloud

     

    • Client Libraries
    • Tutorials
    • Guides
    • Videos

    Community

    • Forum
    • GitHub
    • Blog
    • YouTube
    We're Hiring

    Download and Install Nakama OSS

    Get started with Nakama in 5 minutes.

    Read the documentation

    Learn how to use Nakama

    Learn the basics, master the details.

    Watch videos now

  • Customers
  • Pricing
Login to Heroic Cloud
  • Nakama
  • Hiro
  • Satori
  • Heroic Cloud
  • Nakama
    • Getting Started
      +
      -
      • Overview
      • Installation
        +
        -
        • Overview
        • Docker Compose
        • Windows
        • macOS Binary
        • Linux
      • CLI Commands
      • Configuration
      • Upgrading
      • Metrics
      • Nakama Console
        +
        -
        • Overview
        • Status
        • User Management
        • Configuration
        • Runtime Modules
        • Accounts
        • User Groups
        • Storage
        • Leaderboards
        • Chat Messages
        • Purchases
        • Subscriptions
        • Matches
        • API Explorer
      • Architecture Overview
      • Benchmarks
      • Data Privacy
      • Release Notes
    • Concepts
      +
      -
      • Overview
      • Authentication
      • Sessions
        +
        -
        • Overview
        • Session Management
      • User accounts
      • Storage Engine
        +
        -
        • Overview
        • Collections
        • Access Controls
        • Storage Search
        • Modeling for Scalability
      • Friends
        +
        -
        • Overview
        • Best Practices
      • Groups
        +
        -
        • Overview
        • Groups Best Practices
      • Real-time Chat
      • Parties
      • Multiplayer Engine
        +
        -
        • Overview
        • Client Relayed Multiplayer
        • Authoritative Multiplayer
        • Session-Based Multiplayer
        • Match Listing
        • Matchmaker
          +
          -
          • Overview
          • Offline Matchmaking
        • Query Syntax
      • Status
      • Leaderboards
        +
        -
        • Overview
        • Leaderboards Best Practices
      • Tournaments
      • Notifications
      • In-app Purchase Validation
      • Events
      • Sockets
    • Server Framework
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Runtime Context
        • Hooks
      • TypeScript Runtime
        +
        -
        • Overview
        • Function Reference
          +
          -
          • Overview
          • Match Handler API
          • Match Runtime API
        • Code Samples
      • Go Runtime
        +
        -
        • Overview
        • Function Reference
          +
          -
          • Overview
          • Match Handler API
          • Match Runtime API
        • Code Samples
        • Dependency Pinning
      • Lua Runtime
        +
        -
        • Overview
        • Function Reference
          +
          -
          • Overview
          • Match Handler API
          • Match Runtime API
        • Code Samples
      • Server Runtime Examples
        +
        -
        • Overview
        • Server To Server
      • Streams
      • Server Configuration
    • Client Libraries
      +
      -
      • Overview
      • Game Console SDKs
      • Unity/.Net
      • Unreal
      • C++
      • JavaScript
      • Dart (Flutter)
      • Godot 3
      • Godot 4
      • Swift
      • Java/Android
      • Cocos2d-x C++
      • Cocos2d-x JavaScript
      • Defold
      • Snippets
        +
        -
        • Overview
        • Authoritative In-game Items
        • Authoritative Storage
        • Banning Users
        • Custom Authentication
        • Updating Group Metadata
        • Updating User Metadata
    • API
      +
      -
      • Overview
      • Client
      • Console
    • Tutorials
      +
      -
      • Overview
      • Godot
        +
        -
        • Overview
        • Fish Game
      • JavaScript
        +
        -
        • Overview
        • Tic-Tac-Toe PhaserJS
      • .Net/Unity
        +
        -
        • Overview
        • Fish Game
        • Pirate Panic
          +
          -
          • Overview
          • Authentication
          • Friends
          • Clans
          • Storage
          • Matchmaking
          • Multiplayer
          • Leaderboards
          • Notifications
        • Ninja Battle
    • Guides
      +
      -
      • Overview
      • Concepts
        +
        -
        • Overview
        • Edgegap Integration
        • GameLift Fleet Management
        • Bucketed Leaderboards
        • Custom Authentication with Third-Party Services
        • Custom Leaderboards
        • Creating an Economy
        • Daily Rewards
        • Initialize a New User
        • Matchmaking Around Blocked Users
        • Passive Multiplayer
        • Tiered Leagues
        • Creating a Lobby System
        • Unread Chat Messages
      • Server Framework
        +
        -
        • Overview
        • Satori Integration
        • Background Jobs
        • Debugging with Delve
          +
          -
          • Overview
          • Using VSCode Debugger
          • Using Goland Debugger
        • Guarding APIs
        • Sending Email Using SendGrid
        • Testing TypeScript Server Runtime Code with Jest
        • Using Hooks
      • Deployment
        +
        -
        • Overview
        • Asset Management
        • Deploy on Digital Ocean
        • Remote Configuration
    • Videos
  • Hiro
    • Concepts
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Release Notes
      • Getting Started
        +
        -
        • Overview
        • Installation
        • Configurations
        • GDD Templates
      • Achievements
        +
        -
        • Overview
        • Sub Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
        +
        -
        • Overview
        • Donations
        • Rewarded Video
        • Rewards
        • Virtual Currencies
        • Virtual Store
      • Energy
        +
        -
        • Overview
        • Energy Modifiers
      • Event Leaderboards
      • Incentives
      • Integrations
      • Inventory
      • Leaderboards
      • Personalizer
      • Progression
      • Publishers
      • Stats
      • Streaks
      • Teams
        +
        -
        • Overview
        • Team Achievements
        • Team Event Leaderboards
        • Team Inventory
        • Team Mailbox
        • Team Stats
        • Team Store
        • Team Wallet
      • Tutorials
      • Unlockables
    • Unity
      +
      -
      • Overview
      • Getting Started
        +
        -
        • Overview
        • Initializing the NakamaSystem
        • Creating Custom Systems
        • Observing System Changes
      • Offline Support
      • Achievements
      • Analytics
      • Auctions
      • Base
      • Challenges
      • Economy
        +
        -
        • Overview
        • Donations
        • Rewarded Video
        • Virtual Currencies
        • Virtual Store
      • Energy
      • Event Leaderboards
      • Incentives
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Unreal
      +
      -
      • Overview
      • Getting Started
        +
        -
        • Overview
        • Initializing the HiroClient
        • Blueprints Visual Scripting
        • Online Subsystem
      • Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
      • Energy
      • Event Leaderboards
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • C++
      +
      -
      • Overview
      • Achievements
      • Auctions
      • Base
      • Economy
      • Challenges
      • Energy
      • Event leaderboards
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Dart
      +
      -
      • Overview
      • Getting Started
      • Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
      • Energy
      • Event leaderboards
      • Incentives
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • TypeScript
      +
      -
      • Overview
      • Getting Started
      • Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
      • Energy
      • Event leaderboards
      • Incentives
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Godot
      +
      -
      • Overview
      • Getting Started
      • Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
      • Energy
      • Event leaderboards
      • Incentives
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Python
      +
      -
      • Overview
      • Getting Started
      • Achievements
      • Auctions
      • Base
      • Challenges
      • Economy
      • Energy
      • Event leaderboards
      • Incentives
      • Inventor
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Server Framework
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Core Functions and Hooks
      • Achievements
      • Auctions
      • Base
      • Economy
      • Energy
      • Event Leaderboards
      • Incentives
      • Inventory
      • Leaderboards
      • Progression
      • Stats
      • Streaks
      • Teams
      • Tutorials
      • Unlockables
    • Guides
      +
      -
      • Overview
      • Gameplay Mechanics
        +
        -
        • Overview
        • Battle Pass
        • Collectible Cards (Clash Royale)
        • Event Leaderboard (Royal Match King's Cup)
        • In-Game Store (Fall Guys Style)
        • Quests (Hearthstone Quests)
        • Solo Live Event (Fortnite Style)
      • Personalizer
        +
        -
        • Overview
        • Level-Based Stats
        • One Time Store Offers
      • Server Framework
        +
        -
        • Overview
        • Testing Hiro RPCs via API Client
        • Unregister RPCs
  • Satori
    • Concepts
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Overview
        • Dashboard
        • Release Notes
      • Identities
        +
        -
        • Overview
        • Properties
        • Events
        • Audiences
        • Feature Flags
        • Experiments
        • Live Events
        • Messages
      • Audiences
        +
        -
        • Overview
        • Filter Expressions
        • Audience Computation
      • Feature Flags
        +
        -
        • Overview
        • Fetching Player Flags
      • Metrics
      • Experiments
      • Live Events
      • Messages
        +
        -
        • Overview
        • Templates
        • Message Schedules
        • Integrations
          +
          -
          • Overview
          • OneSignal
        • Direct Message
      • Reports
      • Taxonomy
      • Settings
        +
        -
        • Overview
        • Data Lakes
          +
          -
          • Overview
          • BigQuery
          • Snowflake
        • Webhooks
      • Category Labels
    • Client Libraries
      +
      -
      • Overview
      • Defold
      • Unity/.Net
      • JavaScript
      • Java/Android
      • Godot
      • Dart (Flutter)
      • Swift
    • Guides
      +
      -
      • Overview
      • Experimenting with Audiences
      • Personalized Content
      • Return Incentives
      • Targeting Lapsed Spenders
      • A/B Testing
      • How to Use Satori & Databricks to Predict and Prevent Player Churn
    • Console API
  • Heroic Cloud
    • Concepts
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Creating an Account
        • AWS Marketplace Sign Up
        • Whitelisting IP Addresses
      • Organizations
        +
        -
        • Overview
        • Settings
      • Projects
        +
        -
        • Overview
        • Managing Projects
      • Builders
        +
        -
        • Overview
        • Managing Builders
        • Best Practices
  • Heroic Cloud

Table of Contents

Heroic Ship

Join our developer community and build beautiful realtime apps and live games!

Install Nakama   Learn More
Subscribe to to our newsletter
  • Product
  • Nakama Open Source
  • Nakama Enterprise
  • Hiro
  • Satori
  • Heroic Cloud
  • Company
  • Customers
  • Partners
  • Blog
  • Team
  • Twitter
  • Get help
  • Documentation
  • Video Tutorials
  • Forum
  • GitHub
  • Community
  • Resources
  • Terms of Service
  • Privacy Policy
  • © 2025 Heroic Labs