Ultimate Retention System (Freeze, Shield, Energy, Milestones, Editors)

Ultimate Retention System is a powerful, plug-and-play solution designed to increase player engagement, retention, and monetization in your Unity game.

Built with flexibility and real production use in mind, this system includes all major retention mechanics used in top-performing mobile games — fully customizable and easy to integrate.

✨ FEATURES

🎁 Daily Reward System

• 7-day looping reward cycle
• Streak progression
• Missed day detection
• Freeze token protection system
• Comeback rewards for returning players

🔥 Streak System

• Tracks consecutive logins
• Milestone rewards (Bronze / Silver / Gold)
• Animated UI feedback
• Comeback bonus multiplier

🛡 Streak Shield System

• Protect streaks using Freeze Tokens
• 24-hour protection mechanic
• Expiration countdown UI
• Reminder notifications before expiry

🎲 Surprise Box (Cooldown Reward)

• Time-based reward (e.g. every 48h)
• Randomized rewards
• Animated UI feedback
• Fully configurable ranges

🏆 Weekend Reward System

• Rewards available only on weekends
• One claim per weekend (server-safe logic)
• Dynamic rewards based on player retention state:New players → higher rewards
  Loyal players → smaller rewards
  Churned players → re-engagement boosts

📊 Player Retention State System

Automatically categorizes players:

• New
• Active
• Loyal
• At Risk
• Returning
• Churned

Used to dynamically adjust rewards and incentives.

🔔 Notification System

• Cross-platform (iOS & Android)
• Daily reminders
• Streak warnings
• Comeback notifications
• Milestone alerts
• Fully customizable message templates

🧪 Developer Dashboard (Editor Tool)

• Simulate missed days
• Force rewards
• Trigger streaks and milestones
• Add freeze tokens
• Debug PlayerPrefs instantly

⏱ Time System (Secure & Flexible)

• Uses UTC or custom network time provider
• Safe against device time cheating
• Centralized time management

⚙️ WORKFLOW

The system follows a clean and modular flow:

1. Player opens game. Daily reward check runs
   Retention state is evaluated
   Notifications are scheduled
2. Player interacts. Claims daily reward
   Advances streak
   Unlocks milestone rewards
3. If player misses days. Freeze system activates
   Player can recover streak or reset
4. Weekend. Special reward becomes available
   Reward scales based on retention state
5. Long inactivity. Comeback rewards trigger
   Notifications bring player back

🛠 HOW TO IMPLEMENT

1. Import the Package

• Import into your Unity project
• Open your main scene

2. Add Core Objects

Create empty GameObjects and attach:

• InitScript
• RetentionPrefsKeys
• RetentionNotificationManager
• CrossPlatformNotificationManager

⚠️ These should exist once and persist across scenes.

3. Setup UI

Add and connect:

• Daily Reward UI
• Streak UI
• Weekend Popup
• Shield Popup
• Surprise Box UI

Assign references in the inspector:

• Text fields
• Buttons
• Images
• Popups

4. Configure Keys

In RetentionPrefsKeys, define:

Gems → "Gems"
FreezeTokens → "FreezeTokens"
DateReward → "DateReward"
Streak → "CurrentStreak"

⚠️ Keys must be UNIQUE

5. Hook Into Your Economy

The system uses:

InitScript.Instance.AddGems(amount);
InitScript.Instance.AddFreezeTokens(amount);

You can:

• Replace with your own currency system
• Or keep as-is

6. Setup Notifications

• Enable notifications in Player Settings
• Customize messages in RetentionNotificationConfig
• Test using the Dev Dashboard