Getting Started

Overview

The Mobile Monetization Plugin is a comprehensive solution that combines Advertisement, In-App Purchases (IAP), Offerwalls, and System utilities into a unified framework. It handles initialization order, SDK dependencies, and cross-platform compatibility, allowing you to focus on gameplay logic.

Installation

1. Go to the GitHub Releases page.
2. Download the latest .unitypackage file from the Assets section.
3. In Unity, go to Assets > Import Package > Custom Package….
4. Select the downloaded .unitypackage file and click Open.
5. In the import dialog, ensure all files are checked, then click Import.

The plugin files will be placed under Assets/Mobile Monetization/ in your project.

1. Explore the Example Scene

Before diving into the manual setup, it is highly recommended to explore the provided example scene. This scene demonstrates the core components already configured and includes example script implementations.

1. In your Unity Project window, navigate to Assets/Mobile Monetization/Example.
2. Open the Mobile Monetization Example scene.
3. Review the SampleMobileAds.cs script to see a working example of how to implement the plugin.
4. You can also find pre-configured Default Plugin Settings in Assets/Mobile Monetization/Plugin Resources/Plugin Settings, which you can use directly or as a reference.

Essential Prefabs

Within the plugin, you will find several key prefabs (typically located in Assets/Mobile Monetization/Plugin Resources/Prefabs):

• GDPR: A prefab that you can freely customize to change the appearance of the privacy consent dialog.
• Core System Canvas: A prefab used for displaying pop-up messages and loading screens, which are necessary for Ads and IAP operations.
• Main System Manager: The core manager of the plugin. This prefab must be present in your scene to use the plugin.
• Note: The Ads Dummy and Item Panel prefabs are intended solely for the example scene.

2. Main System

The Main System acts as the brain of the plugin, initializing all other modules in the correct order.

Setup Steps

1. Prepare Settings:

   • Option A (Recommended): Use the existing MainSystemSettings located at Assets/Mobile Monetization/Plugin Resources/Plugin Settings.
   • Option B (Manual): Create it manually by right-clicking in the Project view > Mobile Core > Main System Settings.

2. Assign Modules:

   • Open your MainSystemSettings, then click the Add Module button to register the modules you need (e.g., Ads, IAP, Offerwall).
   
   Add Module Screenshot
   
   
   • Assign the MainSystemSettings you prepared to the Main System Manager prefab located at Assets/Mobile Monetization/Plugin Resources/Prefabs.

3. Scene Setup:
   • Add the Main System Manager prefab into your scene.
   • Recommendation: Place this prefab in an empty scene (e.g., a Bootstrap or Splash scene) that is loaded before your main gameplay scene. This is recommended because the prefab contains a DontDestroyOnLoad script and will automatically persist throughout the game’s lifecycle.

3. Enabling Third-Party SDKs (Define System)

The Mobile Monetization plugin acts as a bridge for many external third-party SDKs. To prevent dependency errors when these SDKs are missing, the plugin relies on C# preprocessor directives (defines) to carefully disable any integration code that lacks its corresponding SDK in your project.

For this reason, the Define System was created. This built-in tool can automatically detect the presence of installed SDKs within your project and safely insert the necessary Scripting Define Symbols to your Player Settings to enable the specific integration code.

1. Install SDK: Import your desired third-party SDKs (e.g., AdMob, Unity Ads, LevelPlay, Unity IAP, etc.) into the project.

2. Enable Defines:

   • Go to Tools > MobileCore > Define Symbols Manager.
   
   Menu Tools Define Symbol Manager
   
   
   • Click Refresh All Define Symbols.
   • The system will scan your project for the SDK classes (configured in Assets/Mobile Monetization/Define System/) and automatically add the necessary Scripting Define Symbols to Player Settings.
   
   Define Symbols Manager Window
   
   

4. Advertisement Setup

Unified API for AdMob, Unity Ads, IronSource (LevelPlay), AppLovin, and more.

1. Enable Module:

   • Open your Main System Settings asset.
   • Under the MODULES section, look for Advertisement Module.
   • If it’s missing, click Add Module > Advertisement Module.
   • Click the ENABLE/DISABLE button to ensure it reads DISABLE (meaning it is currently ENABLED) or check if the section is expanded and active. Actually, the button label shows the action to take, so if it says “DISABLE”, it is currently Enabled. ensure the module is Enabled.

2. Assign Settings:

   • Note: If you chose Option A in the Main System Setup, your AdsSettings is already configured by default and you can skip replacing it. If you chose Option B (Manual), follow the steps below:
   • Expand the Advertisement Module configuration.
   • Locate the Settings field (AdsSettings).
   • Click the “Generate AdSettings” button, and the settings will be automatically created and assigned.
   
   Generate AdSettings
   
   
   • Crucial: If this slot is empty, the Ads Manager will fail to initialize.

3. Configure AdsSettings:

   • Click the “Open” button in the Advertisement Module to open the AdsSettings asset directly.
   • Important: Make sure your desired SDK’s Define Symbol is already active (see Section 3). If not, the provider will not appear in the configuration dropdowns.
   • For full details on all available settings, see the Ads Inspector Reference.

5. In-App Purchases (IAP) Setup

Similar to the Ads setup, enable the In-App Purchase Module in your Main System Settings and open the IAPSettings via the “Open” button.

The key difference in IAP is the ProductKeyType system. ProductKeyType is an enum used as an internal identifier in your code — it is not the ID from the Play Store or App Store. With it, you can reference a product in your game logic (e.g., ProductKeyType.NoAds) without caring about what the actual store ID is.

The actual store IDs (androidID and iOSID) are stored separately inside each IAPItem. The IAPItem acts as the bridge — it maps each ProductKeyType enum value to the correct platform-specific store ID at runtime.

To add or modify your product keys, click the “Edit ProductKeyType Enum” button in the IAPSettings inspector.

This will open a dedicated panel where you can add, rename, or remove your product keys.

For full details on configuring products and all available settings, see the IAP Inspector Reference.

---

Next Steps

For detailed API documentation on the major revenue modules, see:

• Settings: Core | Ads | IAP
• API: Ads Reference | IAP Reference