Playvoi/Playvoi.Client/Assets/ShiroginSDK/README.md

101 lines
No EOL
5.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 📦 **Shirogin SDK**
**Shirogin SDK**, Unity projeleri için geliştirilen kapsamlı bir oyun içi servis paketidir.
Tek bir yapı altında **Reklam**, **Satın Alma (IAP)**, **Analitik**, **Facebook**, **Remote Config** ve **Veri Yönetimi** sistemlerini entegre eder.
Ayrıca özel **Editor araçları** sayesinde geliştirme süreçlerini hızlandırır ve yönetimi kolaylaştırır.
---
## 🛠 **Kurulum ve Setup Wizard**
ShiroginSDK artık akıllı bir **Kurulum Sihirbazı (Setup Wizard)** ile birlikte gelmektedir.
1. **Core Paketi İçe Aktarın:** ShiroginSDK Core paketini projenize sürükleyip bırakın.
2. **Setup Wizard:** Yükleme tamamlandığında **Setup Wizard** penceresi otomatik olarak açılacaktır. (Açılmazsa: `ShiroginSDK > 👋 Welcome` menüsünü kullanın).
3. **Tek Tıkla Kurulum:**
- Setup Wizard, projenizdeki eksik temel paketleri (Unity IAP, Firebase, AppLovin vb.) analiz eder.
- **"⬇ Download & Install All Core"** butonuna basarak tüm bağımlılıkları sırasıyla ve otomatik olarak kurun.
- Unity Package Manager (UPM) paketleri (örn. TextMeshPro, Android Logcat) otomatik olarak `Client.Add` yöntemiyle projeye eklenir.
---
## ⚙️ **Konfigürasyon**
Kurulum sonrası `Resources/ShiroginConfig` dosyası üzerinden modülleri yönetebilirsiniz:
- **Enable/Disable:** Kullanmayacağınız servisleri (örn. Facebook) tek tıkla kapatın.
- **API Keys:** AppLovin Key, AppsFlyer Dev Key gibi anahtarları buradan girin.
- **Asset Manager:** Dilediğiniz zaman `ShiroginSDK > Asset Manager` menüsünden paketlerinizi güncelleyebilir, dokümantasyonlarını indirebilir veya kaldırabilirsiniz.
---
---
## 🚀 **Temel Özellikler**
| Kategori | Açıklama | Versiyon / SDK |
| --------------------------- |-------------------------------------------------------------------------------------------------|------------------------------|
| 🎯 **Reklam Sistemi** | AppLovin destekli ödüllü, banner ve interstitial reklam yönetimi | AppLovin SDK **8.5.1** |
| 💳 **Satın Alma (IAP)** | Unity IAP üzerinden ürün yönetimi, ödül tanımları ve event tabanlı izleme | Unity IAP **4.13.0** |
| 📊 **Analitik (Analytics)** | Firebase, AppsFlyer ve Facebook event sistemi ShiroginEvents yapısıyla birleştirilir | Event-based Analytics Core |
| 🔥 **Firebase Service** | Analytics + Remote Config desteği, local cache fallback sistemiyle birlikte | Firebase SDK **13.6.0** |
| 📱 **Facebook SDK** | App Events, reklam kampanyası izleme ve kullanıcı giriş desteği | Facebook SDK **18.0.0** |
| 🧠 **AppsFlyer SDK** | Kurulum ve kullanıcı edinme (UA) analizleri | AppsFlyer SDK **6.17.72** |
| ⚙️ **Data System** | JSON tabanlı kayıt sistemi (`BaseData`) ile kalıcı veri yönetimi (Economy, Player, Settings...) | Dahili Sistem |
| 🧩 **Popup & UI Framework** | DOTweenPro tabanlı popup animasyon sistemi, temalı UI desteği | DOTween Pro **1.0.380** |
| 🧰 **Editor Tools** | PlayerPrefs Editor, SDK Configurator, Theme Manager, RemoteConfig Importer | PlayerPrefs Editor **1.2.4** |
---
## 🧠 **Teknik Yapı**
* **Modüler mimari:** Her sistem ayrı servis sınıfları üzerinden yönetilir (`IAPService`, `AdService`, `FirebaseService`, `AnalyticsService` vs).
* **Event-driven yapı:** Tüm servisler `ShiroginEvents` üzerinden haberleşir.
* **Scriptable Object tabanlı konfigürasyon:** `SDKConfig`, `StoreRepository`, `RemoteConfigDefinition` gibi varlıklar editor içinde yönetilir.
---
## 🧾 **Klasör Yapısı**
```
Assets/
└── ShiroginSDK/
├── Runtime/
│ ├── Core/
│ ├── Data/
│ ├── Events/
│ ├── IAP/
│ ├── Services/
│ ├── UI/
├── Editor/
│ ├── Tools/
│ └── Toolbar/
└── Documents/
└── (README, Kurulum Rehberleri, SDKConfig örnekleri)
```
---
## 📚 **Dokümantasyon**
Her modülün kurulum ve kullanım dökümanları `ShiroginSDK/Documents` klasörü altındadır:
* [📊 **AnalyticsService.md**](Documents/Analytics/AnalyticsService.md) → Analitik sistemlerinin genel yapısı (Firebase, AppsFlyer, Facebook)
* [💳 **IAPService.md**](Documents/IAP/IAPService.md) → Satın alma sistemi ve ödül yönetimi
* [🔥 **RemoteConfigService.md**](Documents/RemoteConfig/RemoteConfigService.md) → Firebase Remote Config entegrasyonu
* [📱 **FacebookService.md**](Documents/Facebook/FacebookService.md) → Facebook SDK kurulumu ve event takibi
* [🎯 **PopupService.md**](Documents/UI/PopupService.md) → Popup & UI animasyon sistemi
* [🎨 **ThemeService.md**](Documents/UI/ThemeService.md) → Tema yönetimi ve dinamik UI renk sistemi
* [🧰 **Editor Tools**](Documents/EditorTools/EditorTools.md) → SDK Configurator, PlayerPrefs Editor ve diğer editör araçları
---
## 🧩 **Desteklenen Unity Sürümü**
> Unity **6000.0.60f1**.
---
**Hazırlayan:** Emir Han MAMAK
**Version:** 1.1.0 (2025.12)
---