M8 CMS SDK for Unity

A powerful Unity SDK for integrating with the M8 CMS (GameFlow CMS) backend, enabling real-time content management and delivery for mobile games.

📚 Documentation

🚀 Quick Start

1. Add to Scene

   ShellCopy code
   Add M8CMS_SDK_Prefab to your scene

2. Access the SDK

   C#Copy code
   using M8CMS;
   
   var cmsManager = M8CMSManager.Instance;

3. Get Your Content

   C#Copy code
   // Listen for data loaded event
   M8CMSManager.OnGameDataLoaded += (GameData data) => {
       Debug.Log($"Loaded {data.levels.Count} levels!");
   };
   
   // Load level image
   var sprite = await cmsManager.GetLevelSpriteAsync(levelIndex);
   myImage.sprite = sprite;

That's it! Your content is now live from Firebase.

✨ Key Features

• 🔄 Automatic Content Management - Intelligent downloading based on player progress
• 🗃️ Version Management - Support for multiple content versions (Live, Latest, Specific)
• 💾 Smart Caching - Three-level cache system (in-memory, file system, preload)
• 📱 Cross-Platform - Supports Android, iOS, and Web
• ⚡ Event-Driven - Subscribe to events for reactive updates
• 🎨 Built-in Content - Optional offline fallback content
• 📊 Progress Tracking - Track player consumption for intelligent pre-downloading

📖 What You Get

Levels & Collections

C#Copy code
// Get level data
Level level = cmsManager.GetLevelByIndex(5);

// Load images and videos
var image = await cmsManager.GetLevelSpriteAsync(levelIndex);
var video = await cmsManager.GetLevelVideoAsync(levelIndex);

Automatic Downloads

C#Copy code
// When player reaches a level
cmsManager.ConsumeLevelContent(levelIndex);

// SDK automatically downloads:
// - Current level content
// - N levels ahead (configurable)

Version Management

C#Copy code
// Switch content versions
cmsManager.SetVersionSelectionMode(VersionSelectionMode.Specific);
cmsManager.SetSelectedVersionName("v1.2.0");

// Get available versions
var versions = await cmsManager.GetAllVersionsAsync();

📋 Requirements

• Unity 2021.3 or higher
• Firebase Unity SDK (included)
• Internet connection for Firebase (optional with built-in content)

🎯 Use Cases

Level-Based Games

C#Copy code
void StartLevel(int levelIndex)
{
    // Track player progress
    cmsManager.ConsumeLevelContent(levelIndex);
    
    // Get level configuration
    Level level = cmsManager.GetLevelByIndex(levelIndex);
    SetupGrid(level.gridSize);
    SetReward(level.rewardCoin);
}

Collection Galleries

C#Copy code
void DisplayCollection()
{
    var collections = cmsManager.GetAllCollections();
    foreach (var item in collections) {
        LoadGalleryItem(item);
    }
}

Content Previews

C#Copy code
async void ShowPreview(int levelIndex)
{
    var sprite = await cmsManager.GetLevelSpriteAsync(levelIndex);
    previewImage.sprite = sprite;
}

🛠️ Configuration

Configure the SDK in Unity Inspector:

📁 Project Structure

Assets/
├── Scripts/M8CMS/
│   ├── M8CMSManager.cs          # Main SDK manager
│   ├── Examples/                  # Example implementations
│   ├── Services/                 # Firebase services
│   ├── Helpers/                  # Utility helpers
│   └── Models/                   # Data models
├── M8CMS_SDK_Prefab.prefab       # Preconfigured prefab
└── Resources/                    # Built-in content (optional)

📚 Example Scenes

Check out the example scenes in Assets/Scripts/M8CMS/Examples/:

• M8CMSExample.cs - Basic usage and UI
• M8CMSVersionManagerExample.cs - Version management

🔧 API Overview

Initialization

C#Copy code
// SDK auto-initializes
M8CMSManager.OnInitializationComplete += (bool success) => {
    // Ready to use
};

Loading Content

C#Copy code
// Async methods
var sprite = await cmsManager.GetLevelSpriteAsync(index);
var video = await cmsManager.GetLevelVideoAsync(index);

Events

C#Copy code
// Subscribe to events
M8CMSManager.OnGameDataLoaded += OnDataLoaded;
cmsManager.OnLevelContentReady += OnLevelReady;

🐛 Troubleshooting

SDK not initializing?

• Check internet connection
• Verify appKey is correct
• Enable debug logs

Content not loading?

• Check Firebase URLs
• Verify cache size limits
• Check content availability

See Documentation for more solutions.

📞 Support

• 📖 Complete Documentation
• ⚡ Quick Start Guide
• 📝 API Reference
• 💬 Contact M8 CMS support team

📄 License

This SDK is part of the M8 CMS ecosystem. Use in accordance with your agreement with M8 CMS.

Made with ❤️ for Unity Developers