nakama README

The project's README from github.com/heroiclabs/nakama. As one markdown file: README.md.

Nakama - Distributed server for social and realtime games and apps

Version Downloads License Nakama Forum Nakama Documentation

Features

Build scalable games and apps with a production ready server used by ambitious game studios and app developers all around the world. Have a look at the documentation and join the developer community for more info.

Getting Started

The server is simple to setup and run for local development and can be deployed to any cloud provider. See the deployment notes for recommendations on how to deploy the project for production. Nakama server requires CockroachDB or another Postgres wire-compatible server as it's database.

Docker

The fastest way to run the server and the database is with Docker. Setup Docker and start the daemon.

  1. Set up a docker-compose file and place it in a folder for your project.

  2. Run docker-compose -f ./docker-compose.yml up to download container images and run the servers.

For more detailed instructions have a look at our Docker quickstart guide.

Nakama Docker images are maintained on Docker Hub and prerelease images are occasionally published for cutting edge features of the server.

Binaries

You can run the servers with native binaries for your platform.

  1. Download the server from our releases page and the database.

  2. Follow the database instructions to start it.

  3. Run a migration which will setup or upgrade the database schema:

    nakama migrate up --database.address "[email protected]:26257"

  4. Start Nakama and connect to the database:

    nakama --database.address "[email protected]:26257"

When connected you'll see server output which describes all settings the server uses for configuration.

{"level":"info","ts":"2018-04-29T10:14:41.249+0100","msg":"Node","name":"nakama","version":"2.0.0+7e18b09","runtime":"go1.10.1","cpu":4}
{"level":"info","ts":"2018-04-29T10:14:41.249+0100","msg":"Database connections","dsns":["[email protected]:26257"]}
...

Usage

Nakama supports a variety of protocols optimized for various gameplay or app use cases. For request/response it can use GRPC or the HTTP1.1+JSON fallback (REST). For realtime communication you can use WebSockets or rUDP.

For example with the REST API to authenticate a user account with a device identifier.

curl "127.0.0.1:7350/v2/account/authenticate/device?create=true" \
  --user "defaultkey:" \
  --data '{"id": "someuniqueidentifier"}'

Response:

{
"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1MjQ5OTU2NDksInVpZCI6Ijk5Y2Q1YzUyLWE5ODgtNGI2NC04YThhLTVmMTM5YTg4MTgxMiIsInVzbiI6InhBb1RxTUVSdFgifQ.-3_rXNYx3Q4jKuS7RkxeMWBzMNAm0vl93QxzRI8p_IY"
}

There's a number of official client libraries available on GitHub with documentation. The current platform/language support includes: .NET (in C#), Unity engine, JavaScript, Java (with Android), Unreal engine, Godot, Defold, and Swift (with iOS). If you'd like to contribute a client or request one let us know.

Nakama Console

The server provides a web UI which teams can use to inspect various data stored through the server APIs, view lightweight service metrics, manage player data, update storage objects, restrict access to production with permission profiles, and gain visibility into realtime features like active multiplayer matches. There is no separate installation required as it is embedded as part of the single server binary.

You can navigate to it on your browser on http://127.0.0.1:7351.

View Screenshots Nakama Console dashboard view Nakama Console players view Nakama Console API explorer view Nakama Console storage view Nakama Console modules view

Deployment

Nakama can be deployed to any cloud provider such as Google Cloud, Azure, AWS, Digital Ocean, Heroku, or your own private cloud. You should setup and provision separate nodes for Nakama and CockroachDB.

The recommended minimum production infrastructure for CockroachDB is outlined in these docs and Nakama can be run on instance types as small as "g1-small" on Google Cloud although we recommend a minimum of "n1-standard-1" in production. The specific hardware requirements will depend on what features of the server are used. Reach out to us for help and advice on what servers to run.

Heroic Cloud

You can support development, new features, and maintainance of the server by using the Heroic Labs' Heroic Cloud for deployment. This service handles the uptime, replication, backups, logs, data upgrades, and all other tasks involved with production server environments.

Have a look at our Heroic Cloud service for more details.

Contribute

The development roadmap is managed as GitHub issues and pull requests are welcome. If you're interested to add a feature which is not mentioned on the issue tracker please open one to create a discussion or drop in and discuss it in the community forum.

Simple Builds

All dependencies required for a build are vendored as part of the Go project. We recommend a modern release of the Go toolchain and do not store the codebase in the old GOPATH.

  1. Download the source tree.

    git clone "https://github.com/heroiclabs/nakama" nakama
cd nakama

  2. Build the project from source.

    go build -trimpath -mod=vendor
./nakama --version

Full Source Builds

The codebase uses Protocol Buffers, GRPC, GRPC-Gateway, buf, and the OpenAPI spec as part of the project. These dependencies are generated as sources and committed to the repository to simplify builds for contributors.

To build the codebase and generate all sources follow these steps.

  1. Install the toolchain.

    go install \
    "google.golang.org/protobuf/cmd/protoc-gen-go" \
    "google.golang.org/grpc/cmd/protoc-gen-go-grpc" \
    "github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway" \
    "github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2"

  2. Install buf.

  3. Re-generate the protocol buffers and gateway code.

    # Run the shell script:
./buf.sh

  4. Build the codebase.

    go build -trimpath -mod=vendor

Testing

In order to run all the unit and integration tests run:

docker-compose -f ./docker-compose-tests.yml up --build --abort-on-container-exit; docker-compose -f ./docker-compose-tests.yml down -v

This will create an isolated environment with Nakama and database instances, run all the tests, and drop the environment afterwards.

License

This project is licensed under the Apache-2 License.

nakama (heroiclabs/nakama)

Searching Database…

13.5K ·GitHub
Nakama
Что это такое?Nakama — это масштабируемый игровой сервер с открытым исходным кодом. Он предоставляет многопользовательский режим, подбор игроков, таблицы лидеров, турниры, чат, группы игроков и социальные функции, чтобы игровым студиям не приходилось создавать серверную инфраструктуру с нуля.
Это библиотека, которую я подключаю, или отдельный сервер, который я запускаю?Это отдельный серверный исполняемый файл (или Docker-контейнер), к которому игровые клиенты подключаются по GRPC, REST, WebSocket или rUDP. Клиентские SDK есть для Unity, Unreal, Godot, .NET, JavaScript, Java/Android и Swift/iOS.
Как это запустить?Самый быстрый способ — Docker: создайте файл docker-compose и выполните 'docker-compose -f ./docker-compose.yml up'. Также можно скачать нативные бинарные файлы, выполнить миграцию базы данных и запустить Nakama с подключением к ней.
Нужна ли для этого конкретная база данных?Да, Nakama требует CockroachDB или другую базу данных, совместимую с протоколом Postgres, в качестве хранилища.
Можно ли расширять логику сервера и на каких языках?Да, можно писать собственную серверную логику на Lua, TypeScript/JavaScript или нативном Go, чтобы выйти за рамки встроенных возможностей сервера.
Какие игровые движки поддерживаются официально?Официальные клиентские библиотеки есть для Unity, Unreal Engine, Godot, Defold, а также для .NET/C#, JavaScript, Java/Android и Swift/iOS для собственных приложений.
Где можно развернуть сервер?Nakama можно развернуть у любого облачного провайдера, например Google Cloud, Azure, AWS, Digital Ocean, Heroku, или на собственной частной инфраструктуре. Кроме того, разработчик предлагает управляемый вариант «Heroic Cloud».
Есть ли в комплекте панель администратора?Да, веб-интерфейс Nakama Console встроен в серверный исполняемый файл. Он позволяет командам просматривать сохранённые данные, смотреть метрики, управлять данными игроков и следить за активными матчами без отдельной установки.
Какие протоколы связи в реальном времени поддерживаются?Для игрового процесса в реальном времени поддерживаются WebSocket или rUDP, а для запросов и ответов можно использовать GRPC или запасной вариант — REST по HTTP1.1+JSON.
Какие функции для соцсетей и монетизации есть из коробки?Из коробки поддерживаются социальный вход (через соцсети, email или ID устройства), друзья и группы, чат с историей, таблицы лидеров и турниры, группы игроков, проверка покупок в приложении и push-уведомления подключённым клиентам.
Есть ли управляемый хостинг, если я не хочу запускать сервер сам?Да, Heroic Labs предлагает платный управляемый сервис «Heroic Cloud», который берёт на себя аптайм, репликацию, резервное копирование, логи и обновления.
What are similar projects?SpacetimeDB, 3d-game-shaders-for-beginners, centrifugo, luanti, xLua, MonoGame, UnityCsReference, unity-mcp
Which topics is it in?cockroachdb, unity3d, godot, unreal-engine, unity, multiplayer, grpc, gamedev, lua, chat, game-development, dotnet
Creator
heroiclabs
Size
168.5 MB
Stars
13.5K
Updated
CommitOct 16Releasev3.41.0Sep 18
Age
9y
Commits · 90 Days