《開源精選》是我們分享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