《开源精选》是我们分享Github、Gitee等开源社区中优质项目的栏目，包括技术、学习、实用与各种有趣的内容。本期推荐的Nakama是一个开源在线多人游戏框架。

Nakama 是一个开源在线多人游戏框架，由可扩展的服务器框架和各种客户端 SDK 组成，可为您的游戏添加强大的功能。

客户概念：连接到您的 Nakama 服务器并使用 Nakama 社交和竞争功能来构建您的游戏：

服务器框架：最先进的游戏服务器，可以使用 Go、TypeScript/JAVAScript 和 Lua 进行完全扩展，以创建服务器权威游戏逻辑和高级功能，并在需要时更好地控制权限、存储引擎和直接数据库访问。

项目特性

• Users- 通过社交网络、电子邮件或设备 ID 注册/登录新用户。
• Storage- 将用户记录、设置和其他对象存储在集合中。
• Social- 用户可以与朋友联系并加入群组。内置社交图，以查看如何连接用户。
• Chat- 用户之间的一对一、群组和全球聊天。保留聊天记录的消息。
• Multiplayer- 实时或基于回合的主动和被动多人游戏。
• Leaderboards- 动态、季节性、获得顶级成员或用户周围的成员。有尽可能多的。
• Tournaments- 邀请玩家一起争夺奖品。将许多人联系在一起创建联赛。
• Parties- 将团队游戏添加到游戏中。用户可以组队并与党员进行交流。
• Runtime code- 使用用 Lua、TypeScript/JavaScript 或本机 Go 代码编写的自定义逻辑扩展服务器。

快速开始

使用 Docker Compose 安装 Nakama

• 安装到原始环境
• 为 Nakama轻松安装和运行CockroachDB或PostgreSQL数据库
• 在不影响您的主要操作系统的情况下拍摄快照、删除并重新安装 Nakama
• 无论您的操作系统如何，都可以享受快速而简化的安装体验

运行Nakama

1 首先创建一个您的 Nakama 服务器所在的目录，例如Desktop/nakama.

2 在此文件夹中创建一个docker-compose.yml文件并使用您喜欢的文本编辑器打开它。

3 Heroic Labs 提供了两个 YML 文件供使用：使用CockroachDB或PostgreSQL作为数据库。

docker-compose.yml：

version: '3'
services:
  cockroachdb:
    image: cockroachdb/cockroach:latest-v20.2
    command: start-single-node --insecure --store=attrs=ssd,path=/var/lib/cockroach/
    restart: "no"
    volumes:
      - data:/var/lib/cockroach
    expose:
      - "8080"
      - "26257"
    ports:
      - "26257:26257"
      - "8080:8080"
  nakama:
    image: heroiclabs/nakama:3.9.0
    entrypoint:
      - "/bin/sh"
      - "-ecx"
      - >
        /nakama/nakama migrate up --database.address root@cockroachdb:26257 &&
        exec /nakama/nakama --name nakama1 --database.address root@cockroachdb:26257 --logger.level DEBUG --session.token_expiry_sec 7200 --metrics.prometheus_port 9100        
    restart: "no"
    links:
      - "cockroachdb:db"
    depends_on:
      - cockroachdb
      - prometheus
    volumes:
      - ./:/nakama/data
    expose:
      - "7349"
      - "7350"
      - "7351"
      - "9100"
    ports:
      - "7349:7349"
      - "7350:7350"
      - "7351:7351"
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:7350/"]
      interval: 10s
      timeout: 5s
      retries: 5
  prometheus:
    image: prom/prometheus
    entrypoint: /bin/sh -c
    command: |
      'sh -s <<EOF
        cat > ./prometheus.yml <<EON
      global:
        scrape_interval:     15s
        evaluation_interval: 15s
      scrape_configs:
        - job_name: prometheus
          static_configs:
          - targets: ['localhost:9090']
        - job_name: nakama
          metrics_path: /
          static_configs:
          - targets: ['nakama:9100']
      EON
      prometheus --config.file=./prometheus.yml
      EOF'      
    ports:
      - '9090:9090'
volumes:
  data:

docker-compose-postgres.yml：

version: '3'
services:
  postgres:
    contAIner_name: postgres
    image: postgres:9.6-alpine
    environment:
      - POSTGRES_DB=nakama
      - POSTGRES_PASSword=localdb
    volumes:
      - data:/var/lib/postgresql/data
    expose:
      - "8080"
      - "5432"
    ports:
      - "5432:5432"
      - "8080:8080"
  nakama:
    container_name: nakama
    image: heroiclabs/nakama:3.9.0
    entrypoint:
      - "/bin/sh"
      - "-ecx"
      - >
        /nakama/nakama migrate up --database.address postgres:localdb@postgres:5432/nakama &&
        exec /nakama/nakama --name nakama1 --database.address postgres:localdb@postgres:5432/nakama --logger.level DEBUG --session.token_expiry_sec 7200        
    restart: always
    links:
      - "postgres:db"
    depends_on:
      - postgres
    volumes:
      - ./:/nakama/data
    expose:
      - "7349"
      - "7350"
      - "7351"
    ports:
      - "7349:7349"
      - "7350:7350"
      - "7351:7351"
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:7350/"]
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  data:

将首选选项的内容复制并粘贴到docker-compose.yml文件中。

4 打开终端窗口并导航到您的 Nakama 目录。例如：

cd desktop/nakama

5 要提取所有必需的图像并启动您的应用程序，请运行以下命令：

docker compose up

6 恭喜！您的 Nakama 服务器现已启动并运行，可在127.0.0.1:7350

中间控制台

您还可以通过将浏览器导航到127.0.0.1:7351来访问 Nakama 控制台：

配置文件

您可以为 Nakama 服务器自定义许多可用的配置选项。您可以为要设置的所有配置创建一个 YML 文件，并将该文件传递给您的 Docker 容器。

首先，您需要为 Docker 提供一个本地存储卷：

1 docker-compose.yml在您喜欢的文本编辑器中打开您的文件。

2 编辑nakama:volumes:条目以指定所需的音量。例如，要/data在我们desktop/nakama上面使用的目录中创建一个文件夹，该文件夹在 Docker 容器中可用nakama/data，它如下所示：

volumes:
  - ./data:/nakama/data

3 保存更改的文件并重新启动 Docker 容器以使更改生效。从您的终端：

docker compose restart

4 接下来，创建您的自定义配置文件，例如my-config.yml，并将其放在/data上面您为 Docker 提供的文件夹中。

my-config.yml：

name: nakama-node-1
data_dir: "./data/"

logger:
    stdout: false
    level: "warn"
    file: "/nakama/data/logfile.log"

console:
    port: 7351
    username: "my_user"
    password: "my_password"

5 再次打开您的docker-compose.yml文件，这次编辑nakama:entrypoint条目以添加--config指向您的配置文件的标志。它应该如下所示：

nakama:
    entrypoint:
    - "/bin/sh"
    - "-ecx"
    - >
        /nakama/nakama migrate up --database.address root@cockroachdb:26257 &&
        /nakama/nakama --config /nakama/data/my-config.yml  

6 保存更改的文件并重新启动 Docker 容器以使更改生效。从您的终端：

docker compose restart

项目预览

Status：

状态页面提供 Nakama 服务器的实时视图，包括每个节点的使用详情以及带宽和延迟的一般视图，包括：

• 延迟：执行远程过程调用 (RPC) 函数所花费的时间，以毫秒 (ms) 为单位
• 速率：每秒的 RPC 数
• 输入：以千字节每秒 (kb/s) 为单位的入站流量
• 输出：以千字节每秒 (kb/s) 为单位的出站流量

User management:

用户管理页面允许您添加新的控制台用户，或删除任何现有用户。创建新用户时，有四个可用角色，使您能够设置支持团队，使其只能访问他们需要的 UI 功能。

Runtime modules:

运行时模块页面使您可以轻松地观察项目中哪些函数处于活动状态以及上次修改它们的时间。

Accounts:

Accounts 页面显示所有用户账户的列表，可根据用户ID和用户名进行搜索。从这里您可以查看、编辑和删除任何用户。

Leaderboards:

排行榜页面使您能够查看和管理您的排行榜和锦标赛，以及它们的相应记录。

—END—

开源协议：Apache-2.0 License

开源地址：
https://github.com/heroiclabs/nakama