Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanfranke committed Jul 4, 2022
1 parent 8d3f8a1 commit d68b193
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 53 deletions.
137 changes: 84 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,98 @@
# Godot-AdMob-Editor-Plugin
This repository is for Godot's Addons to integrate natively AdMob to your Game Project without much configurations, with a beautiful UI and directly inside Godot Editor!
[![Download Asset Library](https://img.shields.io/badge/Download-Asset%20Library-darkgreen?style=for-the-badge)](https://godotengine.org/asset-library/asset/1108)
![Stars](https://img.shields.io/github/stars/Poing-Studios/godot-admob-editor?style=for-the-badge)
![License](https://img.shields.io/github/license/Poing-Studios/godot-admob-editor?style=for-the-badge)

<u>is pretty basic right now, but with time will be improved</u>
# Godot AdMob Editor Plugin

Tutorial Video: https://youtu.be/ZnlH3INcAGs
This addon provides an easy and beautiful way to configure AdMob directly through the editor. Supports [godot-admob-android](https://github.com/Poing-Studios/godot-admob-android) and [godot-admob-ios](https://github.com/Poing-Studios/godot-admob-ios).

# Installation:
Please read this tutorial: https://docs.godotengine.org/pt_BR/stable/tutorials/plugins/editor/installing_plugins.html
### [Installation and Usage Tutorial](https://www.youtube.com/watch?v=ZnlH3INcAGs)

Manual:
1. Go to Tags of the project: https://github.com/Poing-Studios/Godot-AdMob-Editor-Plugin/tags
2. Download and extract the `.zip` or `.tar.gz`
3. Put the "addons/admob" folder which was extracted into your "res://addons" of your Game Project
# Installation

Godot Asset Library:
1. Find the Plugin `AdMob` then download and install
2. Enable the Plugin: https://docs.godotengine.org/pt_BR/stable/tutorials/plugins/editor/installing_plugins.html#enabling-a-plugin
Godot Asset Library (recommended):
1. Find the AdMob plugin by `poing.studios` \
<img height=100 src="static/asset_library.png">
2. Click Download and Install
3. Enable in Project→Project Settings→Plugins
4. Install [godot-admob-android](https://github.com/Poing-Studios/godot-admob-android) and/or [godot-admob-ios](https://github.com/Poing-Studios/godot-admob-ios)

# Usage:
Manual install for custom versions:
1. Pick a [specific version](https://github.com/Poing-Studios/godot-admob-editor/tags) from tags
2. Download and extract as a `.zip` or `.tar.gz`
3. Copy the extracted `addons/admob` folder into `res://addons` on your project
4. Install [godot-admob-android](https://github.com/Poing-Studios/godot-admob-android) and/or [godot-admob-ios](https://github.com/Poing-Studios/godot-admob-ios)

After you installed, the Plugin will automaticly add an AutoLoad called `MobileAds`, this is the AdMob for Godot and you can call methods like: `MobileAds.load_banner()` to show a banner ad!
# Usage

A example scene is here: `res://addons/admob/develop/Example.tscn`
After installation, the singleton `MobileAds` will be available. Try it out by calling `MobileAds.load_banner()`!

To your plugin work, you need to download the `AdMob Plugin` here: https://github.com/Poing-Studios/Godot-AdMob-Android-iOS#readme
# API

### Methods:

# Signals:
```gdscript
void load_banner(ad_unit_name = "standard")
void load_interstitial(ad_unit_name = "standard")
void load_rewarded(ad_unit_name = "standard")
void load_rewarded_interstitial(ad_unit_name = "standard")
void destroy_banner()
void show_banner()
void hide_banner()
void show_interstitial()
void show_rewarded()
void show_rewarded_interstitial()
void request_user_consent()
void reset_consent_state(will_request_user_consent = false)
int get_banner_width()
int get_banner_width_in_pixels()
int get_banner_height()
int get_banner_height_in_pixels()
bool get_is_banner_loaded()
bool get_is_interstitial_loaded()
bool get_is_rewarded_loaded()
bool get_is_rewarded_interstitial_loaded()
```
signal initialization_complete(status, adapter_name)
signal consent_form_dismissed()
signal consent_status_changed(consent_status_message)
signal consent_form_load_failure(error_code, error_message)
signal consent_info_update_success(consent_status_message)
signal consent_info_update_failure(error_code, error_message)
signal banner_loaded()
signal banner_failed_to_load(error_code)
signal banner_opened()
signal banner_clicked()
signal banner_closed()
signal banner_recorded_impression()
signal banner_destroyed()
signal interstitial_failed_to_load(error_code)
signal interstitial_loaded()
signal interstitial_failed_to_show(error_code)
signal interstitial_opened()
signal interstitial_closed()
signal rewarded_ad_failed_to_load(error_code)
signal rewarded_ad_loaded()
signal rewarded_ad_failed_to_show(error_code)
signal rewarded_ad_opened()
signal rewarded_ad_closed()
signal rewarded_interstitial_ad_failed_to_load(error_code)
signal rewarded_interstitial_ad_loaded()
signal rewarded_interstitial_ad_failed_to_show(error_code)
signal rewarded_interstitial_ad_opened()
signal rewarded_interstitial_ad_closed()
signal user_earned_rewarded(currency, amount)

### Signals:

```gdscript
initialization_complete(status, adapter_name)
consent_form_dismissed()
consent_status_changed(consent_status_message)
consent_form_load_failure(error_code, error_message)
consent_info_update_success(consent_status_message)
consent_info_update_failure(error_code, error_message)
banner_loaded()
banner_failed_to_load(error_code)
banner_opened()
banner_clicked()
banner_closed()
banner_recorded_impression()
banner_destroyed()
interstitial_failed_to_load(error_code)
interstitial_loaded()
interstitial_failed_to_show(error_code)
interstitial_opened()
interstitial_closed()
rewarded_ad_failed_to_load(error_code)
rewarded_ad_loaded()
rewarded_ad_failed_to_show(error_code)
rewarded_ad_opened()
rewarded_ad_closed()
rewarded_interstitial_ad_failed_to_load(error_code)
rewarded_interstitial_ad_loaded()
rewarded_interstitial_ad_failed_to_show(error_code)
rewarded_interstitial_ad_opened()
rewarded_interstitial_ad_closed()
user_earned_rewarded(currency, amount)
```
Empty file added static/.gdignore
Empty file.
Binary file added static/asset_library.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d68b193

Please sign in to comment.