Skip to content

Latest commit

 

History

History
180 lines (133 loc) · 7.69 KB

README.md

File metadata and controls

180 lines (133 loc) · 7.69 KB
Raw


GodotAdMob
Godot AdMob Android

A Godot's plugin for Android of AdMob.

About • How to use • Docs • Downloads

❓ About

Preview

This repository is for a Godot Engine Plugin that allows showing the ads offered by AdMob in an easy way, without worrying about the building or version, just download and use.

The purpose of this plugin is to always keep up to date with Godot, supporting ALMOST ALL versions from v4.1+, and also make the code compatible on Android and iOS, so each advertisement will work identically on both systems.

🔑 Key features

  • It's a wrapper for Google Mobile Ads SDK. 🎁
  • Easy Configuration. 😀
  • Supports nearly all Ad Formats: Banner, Interstitial, Rewarded, Rewarded Interstitial. 📺
  • GDPR Compliance with UMP Support. ✉️
  • Targeting Capabilities. 🎯
  • Seamless integration with Mediation partners: AdColony, Meta, Vungle. 💰
  • CI/CD for streamlined development and deployment. 🔄🚀
  • Features a dedicated Godot Plugin, reducing the need for extensive coding. 🔌
  • There is also an iOS plugin available, which has the same behavior. 🍎

🙋‍♂️How to use

  • We recommend you to use the AdMob Plugin, you can download direcly from Godot Assets.
  • After download, we recommend you to read the README.md of the Plugin to know how to use.

📦Installing:

📥Download

  • To get started, download the poing-godot-admob-android-v{{ your_godot_version }}.zip file from the releases tab. We recommend checking the supported Godot version before proceeding. You can also use the AdMob Plugin for this step by navigating to Tools -> AdMob Download Manager -> Android -> LatestVersion.

🧑‍💻Usage

  • Video tutorial: https://youtu.be/WpVGn7ZasKM.
  • Enable Android Build Template. Check the tutorial here.
  • Inside poing-godot-admob-android-v{{ your_godot_version }}.zip you downloaded, you will face some folders like 'ads', 'adcolony', 'meta', 'vungle'. To AdMob works only 'ads' is required, but if you want Mediation, you need the other folders.
  • Move the content inside the folder which you need into res://android/plugins directory on your Godot project.
  • Add your AdMob App ID to your app's res://android/build/AndroidManifest.xml file by adding a <meta-data> tag with name com.google.android.gms.ads.APPLICATION_ID, as shown below. If you don't do this then you App will crash on start-up.
<!-- Sample AdMob app ID: ca-app-pub-3940256099942544~3347511713 -->
<meta-data
	android:name="com.google.android.gms.ads.APPLICATION_ID"
	android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
  • Export the project enabling the Use Custom Build and Ad Mob, if you have Mediation, also mark Ad Mob Meta, Ad Mob AdColony etc...

📎Useful links:

📄Documentation

For a complete documentation of this Plugin: check here.

Alternatively, you can check the docs of AdMob itself of Android.

🙏 Support

If you find our work valuable and would like to support us, consider contributing via these platforms:

Patreon

Ko-fi

Paypal

Your support helps us continue to improve and maintain this plugin. Thank you for being a part of our community!

🆘Getting help

DISCUSSIONS DISCORD

Development

All scripts must be executed within the project root folder

Downloading

Clear Download & Build Script:

Unix (Linux & MacOS):

./scripts/unix/clean_build.sh 4.3

Windows:

./scripts/windows/clean_build.ps1 4.3

Just Download:

Unix (Linux & MacOS):

./scripts/unix/download_godot.sh 4.3

Windows:

./scripts/windows/download_godot.ps1 4.3

Building, Exporting, Zipping

Just Build:

./gradlew build

Export files:

./gradlew exportFiles -PpluginExportPath=D:\godot-admob-editor\android\plugins

Build and exporting plugin files into the desired directory:

./gradlew build ; ./gradlew exportFiles -PpluginExportPath=D:\godot-admob-editor\android\plugins

Zip:

(-PgodotVersion is optional)

./gradlew zipPlugins -PgodotVersion=4.1.1

Logging

If you are having some issues with crashing or any expected behavior, you can easily get the log of the plugin with ADB:

Logcat AdMob Plugin & Godot (recommended)

adb logcat -s poing-godot-admob godot

Logcat AdMob Plugin

adb logcat -s poing-godot-admob

Logcat Godot

adb logcat -s godot

⭐ Star History

If you appreciate our work, don't forget to give us a star on GitHub! ⭐

Star History Chart