CroupierCroupier
指南
架构
API 参考
  • C++ SDK
  • Go SDK
  • Java SDK
  • JavaScript SDK
  • Python SDK
  • C# SDK
  • Lua SDK
分析
GitHub
指南
架构
API 参考
  • C++ SDK
  • Go SDK
  • Java SDK
  • JavaScript SDK
  • Python SDK
  • C# SDK
  • Lua SDK
分析
GitHub
  • 入门指南

    • 首页
    • 新手教程
    • 快速开始
    • 安装指南
    • 配置管理
    • 部署指南
    • 常见问题
  • 核心概念

    • 系统概览
    • 虚拟对象系统
    • 函数管理
    • 权限控制
  • 运维指南

    • 监控指南
    • 安全配置
    • 故障排查

安装指南

本指南详细介绍 Croupier 各组件的安装和配置方法。

目录

  • 目录
  • 系统要求
    • 最低要求
    • 硬件要求
  • 开发环境安装
    • 1. 安装 Go
    • 2. 安装 Node.js 和 pnpm
    • 3. 安装 buf
    • 4. 克隆项目
  • 生产环境安装
    • Docker 部署
    • 二进制部署
  • SDK 安装
    • Go SDK
    • C++ SDK
    • Java SDK
    • JavaScript/TypeScript SDK
    • Python SDK
  • 配置文件
    • Server 配置
    • Agent 配置
  • 验证安装
    • 健康检查
    • 功能测试
  • 故障排查
    • 常见问题
  • 下一步

系统要求

最低要求

组件最低版本推荐版本
Go1.251.25+
Node.js2222+
pnpm1010.22+
buf-latest
操作系统Linux/macOS/WindowsLinux/macOS

硬件要求

场景CPU内存磁盘
开发2 核4 GB10 GB
生产(小规模)4 核8 GB50 GB
生产(大规模)8 核+16 GB+100 GB+

开发环境安装

1. 安装 Go

macOS

# 使用 Homebrew
brew install go

# 验证安装
go version

Linux (Ubuntu/Debian)

# 下载并安装
wget https://go.dev/dl/go1.25.0.linux-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.25.0.linux-amd64.tar.gz

# 配置 PATH
echo 'export PATH=$PATH:/usr/local/go/bin' >> ~/.bashrc
source ~/.bashrc

Windows

从 Go 官网 下载安装程序并运行。

2. 安装 Node.js 和 pnpm

# 使用 fnm 安装 Node.js(推荐)
curl -fsSL https://fnm.vercel.app/install | bash
fnm install 22
fnm use 22

# 安装 pnpm
npm install -g pnpm

# 验证安装
node -v
pnpm -v

3. 安装 buf

# 使用 go install
go install github.com/bufbuild/buf/cmd/buf@latest

# 或使用 Homebrew(macOS)
brew install bufbuild/buf/buf

# 验证安装
buf --version

4. 克隆项目

# 克隆主仓库
git clone https://github.com/cuihairu/croupier.git
cd croupier

# 初始化子模块
git submodule update --init --recursive

生产环境安装

Docker 部署

使用 Docker Compose

# 构建镜像
docker-compose build

# 启动服务
docker-compose up -d

# 查看日志
docker-compose logs -f

单独部署

# 构建 Server 镜像
docker build -t croupier-server:latest -f docker/Dockerfile.server .

# 运行 Server
docker run -d \
  --name croupier-server \
  -p 8443:8443 \
  -p 8080:8080 \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/configs:/app/configs \
  croupier-server:latest

二进制部署

下载预构建版本

从 Release 页面 下载对应平台的二进制文件。

从源码构建

# 克隆仓库
git clone https://github.com/cuihairu/croupier.git
cd croupier
git submodule update --init --recursive

# 构建发布版本
make build-release

# 二进制文件位于 bin/ 目录
ls -la bin/

SDK 安装

Go SDK

go get github.com/cuihairu/croupier-sdk-go@latest

C++ SDK

# 使用 vcpkg
vcpkg install croupier-sdk-cpp

# 或从源码构建
cd sdks/cpp
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make install

Java SDK

<dependency>
    <groupId>com.github.cuihairu</groupId>
    <artifactId>croupier-sdk-java</artifactId>
    <version>LATEST</version>
</dependency>

JavaScript/TypeScript SDK

# npm
npm install @croupier/sdk-js

# pnpm
pnpm add @croupier/sdk-js

# yarn
yarn add @croupier/sdk-js

Python SDK

pip install croupier-sdk-python

配置文件

Server 配置

server:
  addr: ":8443"              # gRPC 监听地址
  http_addr: ":8080"         # HTTP 监听地址
  tls:
    cert_file: "data/server.crt"
    key_file: "data/server.key"
  db:
    driver: postgres
    datasource: "postgres://user:pass@localhost:5432/croupier"
  log:
    level: info
    format: json

Agent 配置

agent:
  server_addr: "localhost:8443"
  local_addr: ":19090"
  game_id: "my-game"
  env: "dev"
  tls:
    ca_file: "data/ca.crt"
    cert_file: "data/agent.crt"
    key_file: "data/agent.key"

验证安装

健康检查

# Server 健康检查
curl http://localhost:8080/healthz

# 预期输出
{"status":"ok"}

功能测试

# 运行单元测试
make test

# 运行集成测试
make test-integration

故障排查

常见问题

Go 版本不兼容

确保 Go 版本为 1.25 或更高:

go version

如果不满足,请升级 Go 版本。

子模块为空

重新初始化子模块:

git submodule deinit --all
git submodule update --init --recursive
buf 命令未找到

确保 $GOPATH/bin 在 PATH 中:

export PATH=$PATH:$(go env GOPATH)/bin
端口已被占用

修改配置文件中的端口:

server:
  addr: ":9443"      # 修改为其他端口
  http_addr: ":9080"

下一步

安装完成后,请参考:

  • 配置指南 - 详细配置选项
  • 部署指南 - 生产环境部署
  • 核心概念 - 了解系统设计
在 GitHub 上编辑此页
最后更新: 2026/1/9 23:19
Prev
快速开始
Next
配置管理