安装指南
本指南将帮助你在各种平台上安装和构建 Croupier C++ SDK。
方法一:使用预构建包(推荐)
下载预构建包
访问 Releases 页面 下载:
静态库包:
croupier-cpp-sdk-static-{version}-windows-x64.zipcroupier-cpp-sdk-static-{version}-linux-x64.tar.gzcroupier-cpp-sdk-static-{version}-macos-arm64.tar.gz
动态库包:
croupier-cpp-sdk-dynamic-{version}-windows-x64.zipcroupier-cpp-sdk-dynamic-{version}-linux-x64.tar.gzcroupier-cpp-sdk-dynamic-{version}-macos-arm64.tar.gz
使用预构建包
解压后包含:
- 头文件 (
include/) - 库文件 (
lib/) - 示例程序 (
bin/)
在你的 CMake 项目中:
find_package(croupier-sdk REQUIRED)
target_link_libraries(your-target PRIVATE croupier-sdk::croupier-sdk)
方法二:从源代码构建
Linux/macOS
# 克隆仓库
git clone https://github.com/cuihairu/croupier-sdk-cpp.git
cd croupier-sdk-cpp
# 基础构建
./scripts/build.sh
# 清理重构建
./scripts/build.sh --clean
# 启用测试
./scripts/build.sh --tests ON
Windows
# 克隆仓库
git clone https://github.com/cuihairu/croupier-sdk-cpp.git
cd croupier-sdk-cpp
# 基础构建
.\scripts\build.ps1
# Debug 构建
.\scripts\build.ps1 -BuildType Debug
方法三:手动 CMake 构建
# 1. 配置构建
cmake -B build \
-DCMAKE_TOOLCHAIN_FILE=./cmake/vcpkg-bootstrap.cmake \
-DVCPKG_OVERLAY_PORTS=./vcpkg-overlays \
-DVCPKG_OVERLAY_TRIPLETS=./vcpkg-overlays/triplets \
-DCMAKE_BUILD_TYPE=Release
# 2. 构建
cmake --build build --parallel
# 3. 安装(可选)
cmake --install build --prefix /usr/local
依赖库
SDK 会自动安装以下依赖(通过 vcpkg):
- gRPC - RPC 通信框架
- Protobuf 5.29.x LTS - 协议缓冲区
- nlohmann/json - JSON 处理库
VS Code 配置
使用 CMakePresets.json 进行配置:
- 选择 Configure Preset:
CMake: Select Configure Preset - 根据平台选择:
- macOS:
macos-arm64-*-vcpkg或macos-x64-*-vcpkg - Linux:
linux-x64-*-vcpkg - Windows:
windows-x64-*-vcpkg
- macOS:
验证安装
# 运行示例程序
./build/bin/croupier-example
# 如果看到 "Connecting to agent..." 输出,说明安装成功
故障排除
Protobuf 版本冲突
如果看到 incompatible version of Protobuf 错误:
- 确保使用 vcpkg toolchain
- 清理构建目录:
rm -rf build - 重新配置构建
vcpkg 下载失败
中国大陆用户可设置镜像:
export VCPKG_DOWNLOADS=https://mirrors.tuna.tsinghua.edu.cn/vcpkg
Windows 上找不到 DLL
确保将以下目录添加到 PATH:
build\bin\(你的构建输出目录)vcpkg\installed\x64-windows\bin\
