Documentation Portal

Getting Started with Nakama

Nakama is an open source online and multiplayer framework consisting of a extensible server framework and various client SDKs to add powerful features to your game:

Client Concepts

Connect to your Nakama server and use Nakama social and competitive features to build your game:

• Installing Nakama server
• Authentication with your server
• Learn about users and accounts
• Add chat, friends, groups, parties, leaderboards and tournaments
• Create matches and send networked game data

Server Framework

The most advanced game server that can be completely extended with Go, TypeScript/JavaScript and Lua to create server authoritative game logic and advanced features with greater control over permissions, storage engine and direct database access if you need it:

• Learn the basics
• Server framework Go configuration
• Go API function reference
• TypeScript function reference
• Lua API function reference

Client Libraries

Jump into a comprehensive guide for your engine:

• Unity/.Net
• JavaScript
• Godot
• Java/Android
• C++
• Unreal

Tutorials

Learn from easy-to-follow tutorials and complete sample games:

• Fish Game (Unity)
• Pirate Panic (Unity)
• Tic-Tac-Toe PhaserJS
• ...and many more

Devices supported

Hiro

Hiro is a client-server library built on Nakama game server to add economy, social, and LiveOps features rapidly and flexibly to your game. It is available as a C# library to use with Unity engine, a C++ library to use with Unreal Engine, or a npm package for TypeScript, and a server package which gets loaded by the game server.

Satori

Satori is the LiveOps solution from Heroic Labs, designed to help you gain valuable insights into your player base and identify actionable opportunities to grow your audience and revenue.

Heroic Cloud

Learn how to monitor, manage and scale your games on Nakama Enterprise running on Heroic Cloud.

Organization

• Roles & Permissions
• Auditing
• Admin settings

Projects

• Dashboards & charts
• Monitoring logs
• Auditing projects

Builders

• Deployment history
• Monitoring logs
• Auditing builds

Support

For Nakama Open Source

Forums

Get help from the Heroic Labs team and community on the forums:

• Set up your local dev environment
• Design your games with Nakama
• Discuss Client SDKs
• Discuss the Server Framework

GitHub

Report issues or submit pull requests on GitHub:

• Nakama Server
• Nakama Unity
• Nakama JavaScript
• Nakama Godot
• and more

Get commercial support

Expert development resources while building, launching and scaling your game.

Peace of mind while the Heroic Labs team monitors your infrastructure and alerts.

Direct access to the Heroic Labs team over chat, syncs, priority phone support and face-to-face meetings.

Chat to the Heroic Labs team about ensuring your game runs smoothly when you need it to.

Contact sales