diff --git a/README.md b/README.md index 505d8d8..f3e1921 100755 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@ - - + + @@ -30,76 +30,74 @@ Downloads

-## About +## ❓ 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 3.x to 4.x (when it is released), and also make the code **compatible** on **[Android](https://github.com/Poing-Studios/godot-admob-android) and iOS**, so each advertisement will work **identically on both systems**. +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**. - ![Preview](https://i.imgur.com/u5y2GEx.png) +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](https://github.com/Poing-Studios/godot-admob-android) and iOS**, so each advertisement will work **identically on both systems**. -

- (Preview) -

+### 🔑 Key features -
+- It's a wrapper for [Google Mobile Ads SDK](https://developers.google.com/admob/ios/download). 🎁 +- 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](https://github.com/Poing-Studios/godot-admob-plugin), reducing the need for extensive coding. 🔌 +- There is also an [Android Plugin](https://github.com/Poing-Studios/godot-admob-android) available, which has the same behavior. 🤖 -## Features - -| Ad Formats | Available 🍏 | -| :-------------------------------------------------------------------------------------: | :---------: | -| Banner | ✔️ | -| Interstitial | ✔️ | -| Rewarded | ✔️ | -| [Rewarded Interstitial](https://support.google.com/admob/answer/9884467) | ✔️ | -| Native is [REMOVED](https://github.com/Poing-Studios/Godot-AdMob-Android-iOS/issues/75) | ❗ | +## 🙋‍♂️How to use +- We recommend you to use the [AdMob Plugin](https://github.com/Poing-Studios/godot-admob-plugin), you can download direcly from [Godot Assets](https://godotengine.org/asset-library/asset/933). +- After download, we recommend you to read the [README.md](https://github.com/Poing-Studios/godot-admob-plugin/blob/master/README.md) of the Plugin to know how to use. -| Others | Available 🍏 | -| :--------: | :---------: | -| EU consent | ✔️ | -| Targeting | ✔️ | -| Mediation | ❌ | -| CI/CD | ✔️ | +## 📦Installing: +### 📥Download +- To get started, download the `poing-godot-admob-ios-v{{ your_godot_version }}.zip` file from the [releases tab](https://github.com/Poing-Studios/godot-admob-ios/releases). We recommend checking the [supported Godot version](https://github.com/Poing-Studios/godot-admob-versions/blob/master/versions.json) before proceeding. You can also use the [AdMob Plugin](https://github.com/Poing-Studios/godot-admob-plugin) for this step by navigating to `Tools -> AdMob Download Manager -> iOS -> LatestVersion`. -## Installation -- First of all you need to install the [AdMob Editor Plugin](https://github.com/Poing-Studios/Godot-AdMob-Editor-Plugin), you can download direcly from [Godot Assets](https://godotengine.org/asset-library/asset/933). -## iOS (v3.3+): -- Tutorial: https://youtu.be/ZnlH3INcAGs -- Download the ```ios-template-v{{ your_godot_version }}.zip``` in the [releases tab](https://github.com/Poing-Studios/godot-admob-ios/releases/tag/iOS_v3.3%2B) we recommend you to use always the latest. -- Download the [googlemobileadssdkios.zip](https://github.com/Poing-Studios/godot-admob-ios/releases/download/iOS_v3.3%2B/googlemobileadssdkios.zip) used to build the plugin. -- Extract the content in ```ios-template-v{{ your_godot_version }}.zip``` into ```res://ios/plugins``` directory on your Godot project -- Extract the content in ```googlemobileadssdkios.zip``` into ```res://ios/plugins/admob/lib```, will be like this: -- ![Folder Structure](https://i.imgur.com/Xdj8yqV.png) -- Update the configuration in ```res://ios/plugins/admob.gdip```. Updating `GADApplicationIdentifier` is required. -- Export the project enabling the `AdMob Plugin`: -- ![Export Project](https://i.imgur.com/4Zm3sjp.png) +### 🧑‍💻Usage +- Video tutorial - soon. +- Inside `poing-godot-admob-ios-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](https://support.google.com/admob/answer/13420272?hl=en), you need the other folders. +- Move the content inside the folder which you need into ```res://ios/plugins``` directory on your Godot project. +- Update the configuration in ```res://ios/plugins/poing-godot-admob-ads.gdip```. The `GADApplicationIdentifier` is required to change when release your game. +- If you are using Mediation: On `SKAdNetworkItems` in `.gdip` file, you can remove the comments of the [Mediations Networks](https://developers.google.com/admob/ios/choose-networks) which you are using. +- Export the project enabling the `Ad Mob`, if you have Mediation, also mark `Ad Mob Meta`, `Ad Mob AdColony` etc... -## Android (v3.2.2+): -- https://github.com/Poing-Studios/godot-admob-android -## User Messaging Platform (UMP): -- To use UMP due of EUROPE ePrivacy Directive and the General Data Protection Regulation (GDPR), you first need to do configure your [Funding Choices](https://support.google.com/fundingchoices/answer/9180084). -- If your app is "ForChildDirectedTreatment" then the UMP [won't appear and signals won't work for consent](https://stackoverflow.com/a/63232045), this is normal so don't worry. -- To show personalized or non-personalized ads, then you need to change inside your [AdMob Account](https://apps.admob.com/?utm_source=internal&utm_medium=et&utm_campaign=helpcentrecontextualopt&utm_term=http://goo.gl/6Xkfcf&subid=ww-ww-et-amhelpv4) -![npa-image](https://i.stack.imgur.com/0v1eL.png) +## 📎Useful links: +- 🤖 Android: https://github.com/Poing-Studios/godot-admob-android +- ⏳ Plugin for Godot below v4.1: https://github.com/Poing-Studios/godot-admob-ios/tree/v2 -## Documentation -For a complete documentation of this Plugin, [check our wiki](https://github.com/Poing-Studios/Godot-admob-android/wiki). +## 📄Documentation +For a complete documentation of this Plugin: [check here](docs). -Alternatively, you can check the docs of AdMob itself of [Android](https://developers.google.com/admob/android/quick-start) and [iOS](https://developers.google.com/admob/ios/quick-start). +Alternatively, you can check the docs of AdMob itself of [iOS](https://developers.google.com/admob/ios/quick-start). -## Contribute -We are a dedicated area to how contribute for Android and iOS on our wiki. -- Android: https://github.com/Poing-Studios/Godot-AdMob-Android-iOS/wiki/Android-Plugin#developing -- iOS: https://github.com/Poing-Studios/Godot-AdMob-Android-iOS/wiki/iOS-Plugin#developing +## 🙏 Support +If you find our work valuable and would like to support us, consider contributing via these platforms: -## Getting help -[![DISCUSSIONS](https://img.shields.io/badge/Poing%20AdMob-%F0%9F%86%98%20Discussions%C2%A0%F0%9F%86%98-green?style=for-the-badge)](https://github.com/Poing-Studios/Godot-AdMob-Android-iOS/discussions) +[![Patreon](https://img.shields.io/badge/Support%20us%20on-Patreon-orange?style=for-the-badge&logo=patreon)](https://patreon.com/poingstudios) + +[![Ko-fi](https://img.shields.io/badge/Buy%20us%20a-coffee-yellow?style=for-the-badge&logo=ko-fi)](https://ko-fi.com/poingstudios) + +[![Paypal](https://img.shields.io/badge/Donate-via%20Paypal-blue?style=for-the-badge&logo=paypal)](https://www.paypal.com/donate/?hosted_button_id=EBUVPEGF4BUR8) + +Your support helps us continue to improve and maintain this plugin. Thank you for being a part of our community! + + +## 🆘Getting help +[![DISCUSSIONS](https://img.shields.io/badge/Discussions-green?style=for-the-badge)](https://github.com/Poing-Studios/godot-admob-ios/discussions) +[![DISCORD](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge)](https://discord.com/invite/YEPvYjSSMk) + + +## ⭐ Star History +If you appreciate our work, don't forget to give us a star on GitHub! ⭐ + +![Star History Chart](https://api.star-history.com/svg?repos=Poing-studios/godot-admob-ios&type=Date)