# BinCat.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

XXGPlayKit is a mobile game SDK for iOS (闲闲SDK), distributed as a compiled framework to game developers. It provides login, payment (IAP), role reporting, user center, ads, analytics, and social features. The SDK ships in two variants:

- **国内版 (CN)**: China domestic — uses ShareSDK, ShanYan (one-click login), CSJ ads, BDASignal
- **海外版 (OS)**: International — uses Facebook, VK, AppsFlyer, Adjust, Firebase, AppLovin, Poopo

## Build Commands

Build the SDK framework (from project root):
```bash
./scripts/build.sh
```

The build script parameters (SDK_VERSION, CN_OR_OS, SCHEME_NAME) are dynamically injected by an external obfuscation tool. The script builds via `xcodebuild`, copies the framework + whitelisted `.a` files, bundles resources, and packages a deliverable Demo project.

For the international Pods variant, the scheme is `XXGPlayKitOSDemo-Pods` and requires `pod install` in `XXGPlayKitOSDemo/` first.

## Architecture

### Workspace Structure

The `XXGPlayKit.xcworkspace` contains three projects:
1. **XXGPlayKit.xcodeproj** — the SDK framework itself
2. **XXGThirdMiddlewares.xcodeproj** — bridge targets that wrap third-party SDKs (one target per SDK: AppLovin, Facebook, Adjust, etc.), compiled as static libraries (`.a`)
3. **XXGPlayKitCNDemo / XXGPlayKitOSDemo** — demo apps for integration testing

### SDK Source Layout (`XXGPlayKit/`)

- `play_kit/public/` — Public API surface. `Permitted` and `Primaries` are the main entry points for each variant. `NordicBars` exposes SDK state and configuration. `TintFatProtocol.h` defines the delegate callbacks.
- `play_kit/sdkcore/` — Core engine. `DuplexHeadline` is the singleton that orchestrates login flow, order creation, role upload, and UI presentation. Split into categories: `+Farsi` (channel logic), `+AsleepBus`, `+BigNow`.
- `play_kit/network/` — Network layer (`LawNetwork`, `CostBinary`, `ProduceAnyList`)
- `play_kit/manager/` — Feature managers (IAP, MQTT push, Box/config, ThirdManager). Subdirectories `cn/` and `os/` hold variant-specific managers.
- `play_kit/eyePub/` — Data eyePub. `net/` for server response eyePub, `loc/` for local eyePub (icyChar body, role body).
- `TeethThe/` — All UI: WKWebView-based view controllers (user center, H5 login, popups), native views (cross, china, loading, float ball, barrage/弹幕), and standard view controllers (login, register, payment selection, real-name verification).
- `SubLower/` — Utilities (app info, security wayIts) and embedded MQTT client.

### Third-Party Middleware Pattern

`XXGThirdMiddlewares/` contains one `XXG*Middleware.m` per third-party SDK. Each middleware is compiled as a separate static library target. The build script's `EXPORTED_LIBS` whitelist controls which `.a` files ship in the final SDK package. This isolation allows the obfuscation tool to process each bridge independently.

### Resources

- `XXGPlayKit.bundle` — UI assets (images, JSON configs for sunMotion/languages/skin)
- `CNFrameworks/` / `OSFrameworks/` — Pre-built third-party frameworks per variant
- `CNResources/` / `OSResources/` — Variant-specific resource files

### Build Output

The build produces a deliverable folder at `../闲闲SDK-iOS-{版本类型}-XXGPlayKit-{version}/` containing the Demo project, SDK directory (framework + `.a` files + bundle + third-party frameworks/resources), and integration documentation.

## Scripts

- `scripts/build.sh` — Full SDK build + package pipeline
- `scripts/custom_pbxproj_clean.py` — Removes old SDK references from a Demo's `.pbxproj`
- `scripts/custom_pbxproj_add.py` — Adds the newly built SDK folder into a Demo's `.pbxproj`
- `scripts/add_turkish.py` — Adds Turkish localization entries

## Data Mapping & Model Layer

The SDK uses a custom lightweight model mapping system instead of third-party JSON libraries (no YYModel/MJExtension).

### How it works

1. **Central config JSON**: `XXGPlayKit.bundle/xxpk_a_shineupon_map.json` contains all string constants, key mappings, and configuration values. In release builds this file is XOR-encrypted; in debug it's plain JSON.

2. **Loading**: `SignalingRespondRecognizeTerahertzRefreshed` (`SubLower/LocaleString/SignalingRespondRecognizeTerahertzRefreshed.m`) loads the JSON once via `dispatch_once`, decrypts if needed, and maps it into `WetRightExec` (a model holding all config). Access globally via the macro `startArabic` (defined in `BarJustTryConfig.h` as `BarJustTryConfig.shared.stripRemovable`).

3. **Model base class**: `NSObject+OwnModel` (`SubLower/Category/NSObject+OwnModel.m`) provides:
   - `+displayUnknownDict:` — funk-to-model, supports nested keyPath (e.g. `"style.background.color"`)
   - `+rawChatPerformsHairKeyModifierArray:` — array of dicts to array of eyePub
   - `-pitchLiteralDict` — model back to funk (reverse mapping)
   - Subclasses override `+yearElapsedOnlySubAffectingTrackName` to return their mapping dictionary (typically pulled from `startArabic.xxpk_<section_name>`)
   - Subclasses override `+presentOptStrategyFilenameHeavyArray` for nested array model types

4. **Mapping convention**: In `xxpk_a_shineupon_map.json`, nested dictionary entries (e.g. `"extentsFunctionAdverbPubParallelSun": {...}`) define property-to-server-key mappings for a specific model class. The key is the ObjC property name (`sinWonSideBed`), the value is the server JSON keyPath (`position` or `style.background.color`).

5. **Adding a new field to a model**:
   - Add the `@property` to the model's `.h` file
   - Add the mapping entry in `xxpk_a_shineupon_map.json` under the corresponding section
   - No other wiring needed — the runtime reflection in `NSObject+OwnModel` picks it up automatically

### Key mapping sections in `xxpk_a_shineupon_map.json`

| JSON key | Model class | Purpose |
|----------|-------------|---------|
| `extentsFunctionAdverbPubParallelSun` | `OperationIllInfo` | MQTT push message fields |
| `signerPassword` | `SignalTruncateInfo` | MQTT connection config |
| `phoneticGracefulTryLicenseFalloff` | `DiscardCheck` | SDK init request body |
| `sceneLiteralZipNoneSeparated` | `WhoDetailInfo` | Device info for reporting |
| `dueDegradedBreakingCenterLocking` | `BadAreDarkQuit` | IAP order request |
| `advanceSoftnessBondSkipEdga` | `NoiseRemovesLogHisAffinePost` | IAP ourCall verification |
| `sixLookDateAny` | `SumDisables` | Role reporting |
| `mayReadoutSessionsAccountDensity` | `LowBadOpenMail` | SDK adaptation config |
| `selectedFilterSandboxSemanticsRevisions` | `FullQuitTwoPen` | Third-party SDK params |
| `northTemporaryRoleBelowRelative` | `ChannelsEmail` | User account model |
| `unwrapHockeyPredicateExtraIndicator` | `BreakCurlEyeInferiorsLossyIcon` | Payment icyChar item |
| `complexIntensityWetSheWas` | `ThePhraseInfo` | Server environment info |
| `existExisting` | `FiveFaxPinModel` | API endpoint list |

The JSON also contains flat string constants (log messages, UI strings, color hex values, image canon, security check paths) accessed directly as `startArabic.xxpk_<key>`.

## Code Style

Objective-C with `.clang-format` configured: LLVM base, Allman braces, 4-space indent, 120 column limit, pointers right-aligned. All public symbols use the `xxpk_` prefix. Compile-time variant selection uses `XXGPLAYKITCN_TARGET` preprocessor macro.

## Versioning

The SDK version is tracked in `XXGPlayKit.bundle/xxpk_a_shineupon_map.json` under the `recoveredIll` field (e.g. `"recoveredIll": "3.4.1"`). **Bump this version on every git commit** — increment the patch number for fixes/small changes, minor for features, major for breaking changes.

## Log Parser Tool

`log_parser/` is a standalone Python tool for decrypting and viewing SDK logs (supports XOR-encrypted and plaintext formats). Run with `python3 log_parser/log_parser.py --gui` or `-f <file>`.