Heroic Labs Nakama
Login to Heroic Cloud

Documentation

  • Nakama
    • Getting Started
      +
      -
      • Overview
      • Install
        +
        -
        • Overview
        • Docker Compose
        • Windows
        • macOS Binary
        • Linux
      • CLI Commands
      • Configuration
      • Upgrading
      • Nakama Console
        +
        -
        • Overview
        • Status
        • User Management
        • Configuration
        • Runtime Modules
        • Accounts
        • User Groups
        • Storage
        • Leaderboards
        • Chat Messages
        • 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
        • Modeling for Scalability
      • Friends
        +
        -
        • Overview
        • Best Practices
      • Groups
        +
        -
        • Overview
        • Groups Best Practices
      • Real-time Chat
      • Parties
      • Multiplayer Engine
        +
        -
        • Overview
        • Client Relayed Multiplayer
        • Authoritative Multiplayer
        • Match Listing
        • Matchmaker
        • Query Syntax
      • Status
      • Leaderboards
        +
        -
        • Overview
        • Leaderboards Best Practices
      • Tournaments
      • Notifications
      • In-app Purchase Validation
      • Events
      • Sockets
    • Client Libraries
      +
      -
      • Overview
      • Unity/.Net
      • JavaScript
      • Godot
      • C++
      • Java/Android
      • Defold
      • Unreal
      • Cocos2d-x C++
      • Cocos2d-x JavaScript
      • Snippets
        +
        -
        • Overview
        • Authoritative In-game Items
        • Authoritative Storage
        • Banning Users
        • Custom Authentication
        • Updating Group Metadata
        • Updating User Metadata
    • Server Framework
      +
      -
      • Overview
      • Introduction
      • 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
      • Streams
    • 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
        • 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
        • Background Jobs
        • Debugging with Delve
          +
          -
          • Overview
          • Using VSCode 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
  • Heroic Cloud
    • Concepts
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Creating an Account
        • AWS Marketplace Sign Up
      • Organizations
        +
        -
        • Overview
        • Settings
      • Projects
        +
        -
        • Overview
        • Managing Projects
      • Builders
        +
        -
        • Overview
        • Managing Builders
        • Best Practices
  • Satori
    • Concepts
      +
      -
      • Overview
      • Introduction
      • Identities
        +
        -
        • Overview
        • Properties
        • Events
        • Audiences
        • Feature Flags
        • Experiments
        • Live Events
      • Audiences
        +
        -
        • Overview
        • Filter Expressions
      • Feature Flags
      • Metrics
      • Experiments
      • Live Events
      • Data Lakes
        +
        -
        • Overview
        • BigQuery
        • Snowflake
      • Settings
    • Client Libraries
      +
      -
      • Overview
      • Unity/.Net
      • JavaScript
    • Guides
      +
      -
      • Overview
      • Experimenting with Audiences
      • Personalized Content
      • Return Incentives
      • Targeting Lapsed Spenders
      • A/B Testing
  • Hiro GDK
    • Concepts
      +
      -
      • Overview
      • Introduction
      • Getting Started
        +
        -
        • Overview
        • Installation
        • Configurations
        • Initializing the NakamaSystem
        • Creating Custom Systems
        • Observing System Changes
      • Achievements
        +
        -
        • Overview
        • Sub Achievements
      • Analytics
      • Base
        +
        -
        • Overview
        • In-App Purchases
        • App Rating
        • Push Notifications
      • Economy
        +
        -
        • Overview
        • Donations
        • Inventory
        • Rewarded Video
        • Virtual Currencies
        • Virtual Store
      • Energy
        +
        -
        • Overview
        • Energy Modifiers
      • Event Leaderboards
      • Integrations
      • Leaderboards
      • Teams
      • Tutorials
      • Unlockables

Products

  • Nakama
    • Social gameplay
    • Multiplayer
    • Competitive
    • Customization
  • Satori
    • Segmentation Engine
  • Hiro
  • Heroic Cloud
    • Pricing

Company

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

Deploy Nakama and Satori

Get Started

  • Products
    Nakama

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

    Satori

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

    Hiro

    A Nakama toolkit to rapidly build standardized meta game features.

    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
      Sign up via AWS Marketplace

    Deploy Nakama and Satori

    Get Started

  • Company

    Company

    • Customers
    • Case Studies
    • Community
    • Team

     

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

    Deploy Nakama and Satori

    Get Started

    Nakama on Heroic Cloud Available on AWS Marketplace

    November 10, 2022, in Announcement

    Read the news

    Marauders by Small Impact Games

    December 9, 2022, in Case Studies

    Read on our blog

  • Docs

    Documentation

    • Nakama
    • Satori
    • Hiro
    • Heroic Cloud

     

    • Client Libraries
    • Tutorials
    • Guides
    • Videos

    Community

    • Forum
    • GitHub
    • Newsletter
    • 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
  • Heroic Cloud
  • Satori
  • Hiro GDK
  • Nakama
    • Getting Started
      +
      -
      • Overview
      • Install
        +
        -
        • Overview
        • Docker Compose
        • Windows
        • macOS Binary
        • Linux
      • CLI Commands
      • Configuration
      • Upgrading
      • Nakama Console
        +
        -
        • Overview
        • Status
        • User Management
        • Configuration
        • Runtime Modules
        • Accounts
        • User Groups
        • Storage
        • Leaderboards
        • Chat Messages
        • 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
        • Modeling for Scalability
      • Friends
        +
        -
        • Overview
        • Best Practices
      • Groups
        +
        -
        • Overview
        • Groups Best Practices
      • Real-time Chat
      • Parties
      • Multiplayer Engine
        +
        -
        • Overview
        • Client Relayed Multiplayer
        • Authoritative Multiplayer
        • Match Listing
        • Matchmaker
        • Query Syntax
      • Status
      • Leaderboards
        +
        -
        • Overview
        • Leaderboards Best Practices
      • Tournaments
      • Notifications
      • In-app Purchase Validation
      • Events
      • Sockets
    • Client Libraries
      +
      -
      • Overview
      • Unity/.Net
      • JavaScript
      • Godot
      • C++
      • Java/Android
      • Defold
      • Unreal
      • Cocos2d-x C++
      • Cocos2d-x JavaScript
      • Snippets
        +
        -
        • Overview
        • Authoritative In-game Items
        • Authoritative Storage
        • Banning Users
        • Custom Authentication
        • Updating Group Metadata
        • Updating User Metadata
    • Server Framework
      +
      -
      • Overview
      • Introduction
      • 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
      • Streams
    • 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
        • 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
        • Background Jobs
        • Debugging with Delve
          +
          -
          • Overview
          • Using VSCode 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
  • Heroic Cloud
    • Concepts
      +
      -
      • Overview
      • Introduction
        +
        -
        • Overview
        • Creating an Account
        • AWS Marketplace Sign Up
      • Organizations
        +
        -
        • Overview
        • Settings
      • Projects
        +
        -
        • Overview
        • Managing Projects
      • Builders
        +
        -
        • Overview
        • Managing Builders
        • Best Practices
  • Satori
    • Concepts
      +
      -
      • Overview
      • Introduction
      • Identities
        +
        -
        • Overview
        • Properties
        • Events
        • Audiences
        • Feature Flags
        • Experiments
        • Live Events
      • Audiences
        +
        -
        • Overview
        • Filter Expressions
      • Feature Flags
      • Metrics
      • Experiments
      • Live Events
      • Data Lakes
        +
        -
        • Overview
        • BigQuery
        • Snowflake
      • Settings
    • Client Libraries
      +
      -
      • Overview
      • Unity/.Net
      • JavaScript
    • Guides
      +
      -
      • Overview
      • Experimenting with Audiences
      • Personalized Content
      • Return Incentives
      • Targeting Lapsed Spenders
      • A/B Testing
  • Hiro GDK
    • Concepts
      +
      -
      • Overview
      • Introduction
      • Getting Started
        +
        -
        • Overview
        • Installation
        • Configurations
        • Initializing the NakamaSystem
        • Creating Custom Systems
        • Observing System Changes
      • Achievements
        +
        -
        • Overview
        • Sub Achievements
      • Analytics
      • Base
        +
        -
        • Overview
        • In-App Purchases
        • App Rating
        • Push Notifications
      • Economy
        +
        -
        • Overview
        • Donations
        • Inventory
        • Rewarded Video
        • Virtual Currencies
        • Virtual Store
      • Energy
        +
        -
        • Overview
        • Energy Modifiers
      • Event Leaderboards
      • Integrations
      • Leaderboards
      • Teams
      • Tutorials
      • Unlockables
  • Hiro GDK

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
  • Satori
  • Hiro GDK
  • Heroic Cloud
  • Company
  • Customers
  • Community
  • Blog
  • Team
  • Twitter
  • Get help
  • Documentation
  • Video Tutorials
  • Forum
  • GitHub
  • Resources
  • Photon Comparison
  • Firebase Comparison
  • Terms of Service
  • Privacy Policy
  • © 2023 Heroic Labs