Chartboost Plugin

Integrate with Chartboost to monetize and cross-promote your games with ads.

Monetize

Chartboost is an ad network specifically designed for games and targeted at gamers. With Chartboost interstitial ads you can generate revenue for each click or install your games deliver, depending how other developers on the advertising side bid four your ad space.

Cross-Promote

Chartboost offers the so-called More Apps pages, on which you can either cross-promote your own games or games of other developers. This allows driving traffic from existing games to new ones.

Overview

The Chartboost plugin allows monetizing your apps & games by embedding ads from the Chartboost ad network or cross-promote other games of you or other developers.

Use Cases

Advertising campaigns can be used to earn revenue by showing ads, while cross-promotions make it simple to tell existing players about a new game.

Beside classic advertising and cross-promotion Chartboost also offers Rewarded videos, which are an ad type that give the player a reward (e.g. premium currency) after watching a mobile app trailer.

Advertising

Chartboost is an ad network specifically designed for games and targeted at gamers. Therefore only ads for games (and not apps in general) are displayed. The available standard ad type in Chartboost are interstitial ads, which can be shown between game sessions or at startup.

With Chartboost interstitial ads you can generate revenue for each click or install your games deliver, depending how the developer on the advertising side bids.

To show an interstitial ad call Chartboost::showInterstitial() from within your code. For quicker load times, we recommend caching data prior to making this call with Chartboost::cacheInterstitial().

Cross-Promotion

Additionally, Chartboost offers the so-called "More Apps" page, on which you can either cross-promote your own games or games of other developers. This allows driving traffic from existing games to new ones.

Chartboost allows a lot of different types of advertising campaigns like cross-promotion or direct deals. For detailed information on Chartboost settings consult the Chartboost documentation.

To show an "More Apps" page call Chartboost::showMoreApps() from within your code. For quicker load times, we recommend caching data prior to making this call with Chartboost::cacheMoreApps().

Named Locations

Named Locations allow you to show ads at different points within your game and fine-tune campaign behavior from the Chartboost dashboard without the need of updating your apps.

You can either define your own custom location names or use one of the predefined which matches your game's location best:

  • Chartboost.DefaultLocation
  • Chartboost.StartupLocation
  • Chartboost.HomeScreenLocation
  • Chartboost.MainMenuLocation
  • Chartboost.GameScreenLocation
  • Chartboost.AchievementsLocation
  • Chartboost.QuestsLocation
  • Chartboost.PauseLocation
  • Chartboost.LevelStartLocation
  • Chartboost.LevelCompleteLocation
  • Chartboost.TurnCompleteLocation
  • Chartboost.IAPStoreLocation
  • Chartboost.GItemStoreLocation
  • Chartboost.GameOverLocation
  • Chartboost.LeaderboardLocation
  • Chartboost.SettingsLocation
  • Chartboost.QuitLocation

If you omit a location parameter the default value Chartboost.DefaultLocation is used.

Note: Although it's possible to define own location identifiers it's recommended to use one of the predefined ones.

It's also recommended to have a maximum of 5-7 named locations per game.

Chartboost Examples

Plugin Demo App

To try the plugin or see an integration example have a look at the V-Play Plugin Demo app.

Please also have a look at our plugin example project on GitHub: https://github.com/V-Play/PluginDemo.

Example Usage

The Chartboost item can be used like any other QML item. Here is a simple example of how to integrate the plugin in your existing game to display interstitial ads, but not the More Apps page:

 import VPlayApps 1.0
 import VPlayPlugins 1.0

 App{
   NavigationStack {
     Page {
       title: "Chartboost"

       Chartboost {
         id: chartboost

         appId:  "<your-app-id-here>"
         appSignature:  "<your-app-signature-here>"

         // Do not use reward videos in this example
         shouldDisplayRewardedVideo: false

         // Call this function to display an interstitial ad at the default location
         function showAdIfAvailable() {
           chartboost.showInterstitial()
         }

         onInterstitialCached: {
           console.debug("InterstitialCached at location:", location)
         }

         onInterstitialFailedToLoad: {
           console.debug("InterstitialFailedToLoad at location:", location, "error:", error)
         }

       }
     }
   }
 }

Available QML Items

Chartboost

Item allows monetizing your games by embedding Chartboost ads on Android and iOS

Adding and Activating Plugins

How to Add a V-Play Plugin to your App or Game

When you create a new project, you can choose the Plugin Application template to get your own version of the V-Play Plugin Demo with the plugins you want to include. Open Qt Creator and choose “File / New File or Project”, then select Plugin Application in the V-Play Apps section or Game with Plugins in the V-Play Games section to start the project wizard.

Then select the platforms you want to run your application on. The plugins are available for both iOS & Android. There is a fallback functionality in place on Desktop platforms so your project still works when you call methods of the plugins. This allows you to do the main development on your PC, and for testing the plugin functionality you can run the project on iOS and Android.

After the Kit Selection, you can choose which of the plugins you’d like to add to your project:

Then complete the wizard, your project is now set up with all the correct plugin dependencies for Android & iOS automatically. This includes:

  • Setting up the .gradle file for Android.
  • Setting up the .plist file for iOS.
  • Setting up the .pro file to include the plugin libraries for iOS.

Note: Additional integration steps are still required for most plugins, for example to add the actual plugin libraries for iOS to your project. Please have a look at the integration steps described in the documentation for each of the used plugins.

If you have an existing V-Play application, follow these steps to include a plugin to your app or game:

In Qt Creator, select “File / New File or Project” and choose either V-Play Games or V-Play Apps from Files and Classes. Then select V-Play Plugin and press Choose.

You can now select the plugin you want to add:

The plugin item, which contains the chosen plugin and a short usage example, is now added to your project. To use the item in your project, simply perform these steps:

  • Include the created item (use the name you entered in the template before) in your main.qml file.
  • Modify the .pro file & .plist file for iOS usage. See the iOS integration guide of the chosen plugin for more information.
  • Modify the the .gradle file for Android usage. See the Android integration guide of the chosen plugin for more information.

Note: If you have an existing Qt application, you can also add V-Play Plugins to your app! See here how to do this.

Activating Plugins with a License Key

You can test all plugins as soon as the required integration steps and plugin configuration are completed.

However, the plugins are only available as Trial Versions if they are not activated with a valid license. When you are using unlicensed plugins, a dialog is shown and a watermark overlays your application to notify you about the testing state of the plugin.

All monetization plugins are free to use in all licenses, other plugins are only fully usable if you have purchased the Indie or Enterprise license. To activate plugins and enable their full functionality it is required to create a license key. You can create such a key for your application using the license creation page.

This is how it works:

  • Choose the plugins you want to include in your license key:

  • Click on “Generate License Key” and set the app identifier & version code of your application. You can see that the AdMob plugin was enabled in this license key:

  • Copy the generated licenseKey to your GameWindow or App component.

  • You can now fully use the selected plugins!

Integration

To use the Chartboost plugin you need to add the platform-specific native libraries to your project, described here:

iOS Integration Steps

  1. Download our PluginDemo from https://github.com/v-play/PluginDemo/archive/master.zip and unzip it.
  2. Copy Chartboost.framework from the ios sub-folder to a sub-folder called ios within your project directory.
  3. Add the following lines of code to your .pro file:
     ios {
       VPLAY_PLUGINS += chartboost
     }

Android Integration Steps

  1. Open your build.gradle file and add the following lines to the dependencies block:
     dependencies {
       compile 'net.vplay.plugins:plugin-chartboost:2.+'
     }

    Note: If you did not create your project from any of our latest wizards, make sure that your project uses the Gradle Build System like described here.

Chartboost Account

You finally need to set up a Chartboost user account at https://www.chartboost.com. Then open your Chartboost dashboard (https://dashboard.chartboost.com) and add an app & a campaign for your game. If you're publishing your game for both iOS & Android you should add two apps (and campaigns), as links to other games are platform-specific.

Note: It can take up to an hour until your new campaigns are available on devices.

Used Chartboost SDK Versions

iOS 6.6.0
Android 6.6.1

Note: Other SDK versions higher than the stated ones might also be working but are not actively tested as of now.

Voted #1 for:

  • Easiest to learn
  • Most time saving
  • Best support

Develop Cross-Platform Apps and Games 50% Faster!

  • Voted the best supported, most time-saving and easiest to learn cross-platform development tool
  • Based on the Qt framework, with native performance and appearance on all platforms including iOS and Android
  • Offers a variety of plugins to monetize, analyze and engage users
FREE!
create apps
create games
cross platform
native performance
3rd party services
game network
multiplayer
level editor
easiest to learn
biggest time saving
best support