Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs #239

Merged
merged 2 commits into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Issue with AdMob on iOS only
url: https://github.com/Poing-Studios/godot-admob-ios
url: https://github.com/poingstudios/godot-admob-ios
about: Check the iOS plugin repository.
- name: Issue with AdMob on Godot Editor
url: https://github.com/Poing-Studios/godot-admob-editor
- name: Issue with AdMob on Godot Plugin
url: https://github.com/poingstudios/godot-admob-plugin
about: Check the Android plugin repository.
2 changes: 1 addition & 1 deletion .github/workflows/manual_release_android.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:

- name: Build Android Action
id: build-android
uses: Poing-Studios/godot-android-action@master
uses: poingstudios/godot-android-action@master
with:
godot_version: ${{ github.event.inputs.godot_version }}
build_version: ${{ github.event.inputs.build_version }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release_android.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:

- name: Build Android Action
id: build-android
uses: Poing-Studios/godot-android-action@master
uses: poingstudios/godot-android-action@master
with:
godot_version: ${{matrix.GODOT_VERSIONS}}
project_path: admob
Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,41 +12,41 @@
<a href="https://godotengine.org">
<img src="https://img.shields.io/badge/GODOT-%23FFFFFF.svg?&logo=godot-engine">
</a>
<a href="https://github.com/Poing-Studios/godot-admob-android/releases">
<img src="https://img.shields.io/github/v/tag/Poing-Studios/godot-admob-android?label=Version">
<a href="https://github.com/poingstudios/godot-admob-android/releases">
<img src="https://img.shields.io/github/v/tag/poingstudios/godot-admob-android?label=Version">
</a>
<a href="https://github.com/Poing-Studios/godot-admob-android/actions">
<img src="https://github.com/Poing-Studios/godot-admob-android/workflows/Build%20Android/badge.svg">
<a href="https://github.com/poingstudios/godot-admob-android/actions">
<img src="https://github.com/poingstudios/godot-admob-android/workflows/Build%20Android/badge.svg">
</a>
<a href="https://github.com/Poing-Studios/godot-admob-android/blob/master/admob/AdMob.gdap">
<img src="https://img.shields.io/badge/GAD SDK Android-v22.0.0-informational">
<a href="https://github.com/poingstudios/godot-admob-android/blob/master/admob/AdMob.gdap">
<img src="https://img.shields.io/badge/GAD SDK Android-v23.0.0-informational">
</a>
<a href="https://github.com/Poing-Studios/godot-admob-android/releases">
<img src="https://img.shields.io/github/downloads/Poing-Studios/godot-admob-android/total?style=social">
<a href="https://github.com/poingstudios/godot-admob-android/releases">
<img src="https://img.shields.io/github/downloads/poingstudios/godot-admob-android/total?style=social">
</a>
<a href="#🌠star-history">
<img src="https://img.shields.io/github/stars/Poing-Studios/godot-admob-android?style=social">
<img src="https://img.shields.io/github/stars/poingstudios/godot-admob-android?style=social">
</a>
<img src="https://img.shields.io/github/license/Poing-Studios/godot-admob-android?style=plastic">
<img src="https://img.shields.io/github/license/poingstudios/godot-admob-android?style=plastic">
</p>

<p align="center">
<a href="/docs">📃Documentation</a> •
<a href="https://github.com/Poing-Studios/godot-admob-android/releases">💾Downloads</a>
<a href="https://github.com/poingstudios/godot-admob-android/releases">💾Downloads</a>
</p>

## 📖About
This repository is a _Godot Engine Plugin_ that makes it **easy** to display **AdMob** ads in your game, **just download and use**, no need to worry about building or version compatibility.

The plugin supports most versions of Godot from 3.x to 4.x and is **compatible** with both **Android and [iOS](https://github.com/Poing-Studios/godot-admob-ios)**.
The plugin supports most versions of Godot from 3.x to 4.x and is **compatible** with both **Android and [iOS](https://github.com/poingstudios/godot-admob-ios)**.

## 💡Features
- **Supports** _Almost_ all [AdFormats](https://support.google.com/admob/answer/6128738?hl=en)💵: `Banner`, `Interstitial`, `Rewarded`, `Rewarded Interstitial`
- EU Consent for GDPR **compliance** 🏦 _[EU Consent/UMP](https://support.google.com/admob/answer/7666519?hl=en)_
- Targeting **specific** ⭕ audience segments
- Has `CI/CD` to **test** ✅, **build** 🛠️ and **release versions** 📨
- Concise **documentation** 📄
- Same **behavior** as [iOS Plugin](https://github.com/Poing-Studios/godot-admob-ios) 🍎
- Same **behavior** as [iOS Plugin](https://github.com/poingstudios/godot-admob-ios) 🍎

## 🕵️‍♂️Preview
| Banner | Interstitial | Rewarded | Rewarded Interstitial |
Expand All @@ -56,11 +56,11 @@ The plugin supports most versions of Godot from 3.x to 4.x and is **compatible**
## 🔌Usage
### Prerequisites
- Basic knowledge about usage of Godot Plugins and AdMob
- Usage of [AdMob Editor Plugin](https://github.com/Poing-Studios/Godot-AdMob-Editor-Plugin)
- Usage of [AdMob Editor Plugin](https://github.com/poingstudios/godot-admob-plugin)

### Installation
- [YouTube Tutorial](https://youtu.be/ZnlH3INcAGs)
- Download the ```android-?-template-v{{ your_godot_version }}.zip``` in the [releases tab](https://github.com/Poing-Studios/godot-admob-android/releases), we recommend you to use always the latest.
- Download the ```android-?-template-v{{ your_godot_version }}.zip``` in the [releases tab](https://github.com/poingstudios/godot-admob-android/releases), we recommend you to use always the latest.
- Extract the content downloaded into ```res://android/plugins``` directory on your Godot project
- Add your [AdMob App ID](https://support.google.com/admob/answer/7356431) 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.
``` xml
Expand Down Expand Up @@ -89,7 +89,7 @@ The plugin supports most versions of Godot from 3.x to 4.x and is **compatible**
- For complete and detailed documentation check here: [LINK]()

## 🌠Star History
[![Star History Chart](https://api.star-history.com/svg?repos=Poing-Studios/godot-admob-android&type=Date)](https://star-history.com/#Poing-Studios/godot-admob-android&Date)
[![Star History Chart](https://api.star-history.com/svg?repos=poingstudios/godot-admob-android&type=Date)](https://star-history.com/#poingstudios/godot-admob-android&Date)

## 🪪License
This project is licensed under the [MIT License](https://github.com/Poing-Studios/godot-admob-android/blob/master/LICENSE).
This project is licensed under the [MIT License](https://github.com/poingstudios/godot-admob-android/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion admob/version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.1.6
2.1.7
Loading