3 releases

Uses new Rust 2021

0.1.7 Jul 28, 2022
0.1.6 Jul 22, 2022
0.1.5 Jul 14, 2022

#860 in Game dev

Apache-2.0

190KB
3K SLoC

Rust 1.5K SLoC // 0.0% comments Kotlin 1.5K SLoC // 0.2% comments

Crossbow Admob Plugin

About

This project is a Crossbow Plugin that allows showing AdMob ads from Rust. Without worrying about the building, just download and use.

Features

Ad Format Available
Banner
Interstitial
Rewarded
Rewarded Interstitial
Native

✅ = Works and tested — 🆗 = Works but may contain bugs — 🛠 = Under development — 📝 = Planned - ❌ = Not working - ❗ = Not planned to be implemented

Installation

Just add Rust dependencies like this:

[dependencies]
crossbow = "0.1.7"
crossbow-admob = "0.1.7"

And finally, add this to your Crossbow Android configuration:

[package.metadata.android]
plugins_remote = ["com.crossbow.admob:admob:0.1.7"]

That's it, now you can start using AdMob ads!

If you want to configure custom APPLICATION_ID add this to your Cargo.toml file:

[[package.metadata.android.meta_data]]
name = "com.google.android.gms.ads.APPLICATION_ID"
value = "<YOUR ID HERE>"
# By default: ca-app-pub-3940256099942544~3347511713

Usage

In your rust project, you will need to get JNIEnv first and retrieve the JNI Singleton instance of AdMob from Crossbow. To do this, write following code:

use crossbow::android::{permission::*, plugin};

let (_, vm) = crossbow::android::create_java_vm().unwrap();
let jnienv = vm.attach_current_thread_as_daemon().unwrap();

let admob_singleton = plugin::get_jni_singleton("AdMob").expect("Crossbow Error: AdMob is not registered");
let admob = crossbow_admob::AdMobPlugin::from_jnienv(admob_singleton.clone(), jnienv).unwrap();

To show Interstitial Ad, use following code:

admob.initialize(true, "G", false, true).unwrap();
admob.load_interstitial("ca-app-pub-3940256099942544/1033173712").unwrap();
admob.show_interstitial().unwrap();

To read signals:

if let Ok(signal) = admob_singleton.get_receiver().recv().await {
    println!("signal: {:?}", signal);
}

Complete documentation you can find here.

Thanks and inspiration

This Plugin was initially inspired by godot-admob-android.

Dependencies

~0.3–1MB
~21K SLoC