项目
管理接入金丝雀安全的应用项目
暂无项目,点击上方按钮创建
返回项目列表
策略命中统计
累计命中
0
24小时命中
0
安全配置
检测事件
设备视图
数据总览
检测趋势
策略类型分布
检测日志
所有项目的检测事件记录
接入文档
客户端接入金丝雀安全模块
Unity 接入
UE4 接入
Cocos 接入
Android 原生
云端 API
U
Unity 接入指南
适用于 Unity 2019.4 LTS 及以上版本
1. 环境要求
- Unity 2019.4 LTS 或更高版本
- 支持 Android (minSdkVersion 21+) / iOS (iOS 11+)
- IL2CPP 或 Mono 脚本后端均可
- 需要 Internet 网络权限
2. 获取 App Key
在控制台「项目管理」中创建项目,系统会自动生成唯一的 acg_xxxxxxxxxxxxxxxx 格式 App Key。
3. 导入 SDK
1. 下载 acg-unity-sdk.unitypackage 2. 在 Unity 中选择 Assets → Import Package → Custom Package 3. 选择下载的 .unitypackage 文件 4. 勾选所有文件,点击 Import
4. 初始化代码
在游戏启动的最早场景中挂载初始化脚本:
using ACGSDK; public class AntiCheatInit : MonoBehaviour { void Start() { // 替换为你在控制台获取的 App Key string appKey = "acg_your_app_key"; // 初始化 SDK AntiCheatGuard.Init(appKey); // 启动全部检测模块 AntiCheatGuard.StartDetection(); } }
5. 配置 AndroidManifest.xml
在 Assets/Plugins/Android/AndroidManifest.xml 中添加:
<manifest ...> <uses-permission android:name="android.permission.INTERNET"/> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> <application ...> <meta-data android:name="ACG_APP_KEY" android:value="acg_your_app_key"/> </application> </manifest>
6. iOS 配置(如需)
- 在 Xcode 项目中添加
Security.framework - 在 Info.plist 中添加
ACG_APP_KEY字段 - 确保 Other Linker Flags 包含
-ObjC
7. 可选:检测回调
AntiCheatGuard.OnDetectionResult = (result) => { Debug.Log("检测类型: " + result.type); Debug.Log("风险等级: " + result.riskLevel); Debug.Log("详情: " + result.detail); };
UE
Unreal Engine 4 接入指南
适用于 UE4 4.26 及以上版本
1. 环境要求
- Unreal Engine 4.26 或更高版本
- 支持 Android / iOS / Windows 平台
- Visual Studio 2019+ (Windows) / Xcode 13+ (macOS)
- 项目需使用 C++ 或蓝图 + C++ 混合开发
2. 获取 App Key
在控制台「项目管理」中创建项目,获取 acg_xxxxxxxxxxxxxxxx 格式的 App Key。
3. 集成插件
1. 将 ACGSDK 文件夹复制到项目的 Plugins 目录 2. 右键 .uproject → Generate Visual Studio project files 3. 重新编译项目 4. 启动 UE4 编辑器,在 Edit → Plugins 中确认 ACGSDK 已启用
4. 初始化代码(C++)
在 GameMode 的 BeginPlay 中初始化:
#include "ACGSDK.h" void AMyGameMode::BeginPlay() { Super::BeginPlay(); // 初始化反作弊 SDK FACGSDKModule::Get().Init("acg_your_app_key"); // 启动检测 FACGSDKModule::Get().StartDetection(); }
5. 蓝图节点
插件提供以下蓝图节点,可在蓝图中直接调用:
Init ACG— 初始化,传入 App KeyStart Detection— 启动检测Stop Detection— 停止检测Get Detection Result— 获取检测结果
6. Android 配置
在 Project Settings → Android → Advanced APK Packaging 中:
Extra Permissions: android.permission.INTERNET android.permission.ACCESS_NETWORK_STATE Extra Settings for Application: <meta-data android:name="ACG_APP_KEY" android:value="acg_your_app_key"/>
7. 可选:检测事件委托
FACGSDKModule::Get().OnDetectionResult().AddLambda([](const FACGResult& Result) { UE_LOG(LogTemp, Warning, TEXT("检测类型: %s"), *Result.Type); UE_LOG(LogTemp, Warning, TEXT("风险等级: %d"), Result.RiskLevel); });
CC
Cocos Creator 接入指南
适用于 Cocos Creator 2.4.x / 3.x 版本
1. 环境要求
- Cocos Creator 2.4.x 或 3.x 版本
- 支持 Android / iOS 平台
- Node.js 12+ (构建原生平台时需要)
- Android NDK r21+ (Android 平台)
2. 获取 App Key
在控制台「项目管理」中创建项目,获取 acg_xxxxxxxxxxxxxxxx 格式的 App Key。
3. 导入 SDK
1. 下载 acg-cocos-sdk.zip
2. 解压后将 acg-sdk 文件夹复制到项目 assets 目录
3. 在 Cocos Creator 中刷新资源管理器,确认模块已识别
4. 如为 3.x 版本,需在 tsconfig.json 中添加路径映射:
"paths": { "acg-sdk": ["./assets/acg-sdk"] }
4. 初始化代码(TypeScript)
在游戏主场景的启动脚本中初始化:
import { ACGSDK } from './acg-sdk/acg-sdk'; // 在游戏启动时初始化 onLoad() { // 替换为你的 App Key ACGSDK.init('acg_your_app_key'); // 启动检测 ACGSDK.startDetection(); }
5. Android 原生配置
构建 Android 项目后,在 proj.android/app/src/main/AndroidManifest.xml 中添加:
<uses-permission android:name="android.permission.INTERNET"/> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> <application ...> <meta-data android:name="ACG_APP_KEY" android:value="acg_your_app_key"/> </application>
6. iOS 配置(如需)
- 构建 iOS 项目后,在 Xcode 中添加
Security.framework - 在 Info.plist 添加
ACG_APP_KEY字段 - Other Linker Flags 添加
-ObjC
7. 可选:检测回调
ACGSDK.onDetectionResult((result) => { console.log('检测类型:', result.type); console.log('风险等级:', result.riskLevel); console.'详情:', result.detail); });
A
Android 原生接入指南
适用于纯 Android 原生开发项目
1. 环境要求
- Android SDK API Level 21+ (Android 5.0)
- Java 8+ 或 Kotlin 1.5+
- Gradle 7.0+
2. 获取 App Key
在控制台「项目管理」中创建项目,获取 acg_xxxxxxxxxxxxxxxx 格式的 App Key。
3. 添加依赖
在 app/build.gradle 中添加:
android {
defaultConfig {
minSdkVersion 21
}
}
dependencies {
implementation 'com.fairwatch.acg:acg-sdk:1.0.0'
}
4. 初始化代码(Java)
import com.fairwatch.acg.AntiCheatGuard; public class MyApp extends Application { @Override public void onCreate() { super.onCreate(); // 初始化 SDK AntiCheatGuard.init(this, "acg_your_app_key"); // 启动检测 AntiCheatGuard.startDetection(); } }
5. 初始化代码(Kotlin)
import com.fairwatch.acg.AntiCheatGuard class MyApp : Application() { override fun onCreate() { super.onCreate() AntiCheatGuard.init(this, "acg_your_app_key") AntiCheatGuard.startDetection() } }
6. AndroidManifest.xml 配置
<manifest ...> <uses-permission android:name="android.permission.INTERNET"/> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> <application android:name=".MyApp" ...> <meta-data android:name="ACG_APP_KEY" android:value="acg_your_app_key"/> </application> </manifest>
7. ProGuard 混淆规则
# ACG SDK 混淆规则(如开启混淆请添加)
-keep class com.fairwatch.acg.** { *; }
-dontwarn com.fairwatch.acg.**
API
云端 API 文档
服务端接口与客户端上报协议
1. 认证方式
所有 API 请求需在 Header 中携带 App Key:
X-App-Key: acg_xxxxxxxxxxxxxxxx
2. 拉取云端配置
客户端启动时调用,获取当前项目的检测策略配置:
GET /api/client/config Header: X-App-Key: acg_xxxxxxxxxxxxxxxx // 响应示例 { "detection_modules": { "anti_debug": true, "root_detect": true, "vpn_detect": true, "memory_protect": true, "watchdog": true, "virtualization": true }, "config_version": "v1.2.0", "poll_interval": 300 }
3. 上报检测事件
客户端检测到异常时上报事件:
POST /api/client/event Header: X-App-Key: acg_xxxxxxxxxxxxxxxx Content-Type: application/json { "event_type": "anti_debug", "detail": "TracerPid=1234", "risk_level": 2, "device_info": { "model": "Pixel 6", "android": 13, "device_id": "xxxxx" } } // 响应 { "status": "ok" }
4. 上报心跳
客户端定期上报存活状态(间隔由云端配置决定):
POST /api/client/heartbeat Header: X-App-Key: acg_xxxxxxxxxxxxxxxx Content-Type: application/json { "device_id": "xxxxx", "detection_active": true, "uptime": 3600 }
5. 事件类型说明
| event_type | 说明 | risk_level |
|---|---|---|
vpn_detect | VPN/代理检测 | 1-3 |
root_detect | Root/越狱检测 | 2-3 |
anti_debug | 反调试检测 | 2-3 |
memory_protect | 内存篡改检测 | 3 |
watchdog | 作弊工具检测 | 2-3 |
virtualization | 虚拟化环境检测 | 2-3 |
6. risk_level 等级说明
- 1 — 低风险:可能存在但需进一步确认(如仅VPN连接)
- 2 — 中风险:存在可疑行为,建议关注
- 3 — 高风险:确认为作弊行为,建议处理
更新日志
金丝雀安全模块版本发布记录