godot-vk-ads-android

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

godot-vk-ads-android

★ 9 Open GitHub ↗

💰 Vk plugin for advertising in Godot

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Godot Android VK Ads

[🇷🇺 Русская версия](README.ru.md)

Android plugin for [Godot 4](https://godotengine.org/) that integrates [VK Ads SDK (myTarget)](https://target.my.com/adv/help/sdk/).

Supports banner, interstitial, and rewarded video ads.

> Only works on Android. On other platforms the plugin gracefully does nothing.

## Requirements

- Godot 4.x
- Android export with Gradle build enabled

---

## Installation

### 1. Download

Download and unpack the latest [release archive](https://github.com/noctisalamandra/godot-vk-ads-android/releases/latest).

![Download](https://raw.githubusercontent.com/noctisalamandra/godot-vk-ads-android/main/screens/download.png)

### 2. Add to project

Copy the `addons/GodotAndroidVkAds` folder into the root of your Godot project.

![Project](https://raw.githubusercontent.com/noctisalamandra/godot-vk-ads-android/main/screens/project.png)

### 3. Enable the plugin

Open `Project → Project Settings → Plugins` and enable **GodotAndroidVkAds**.

![Settings](https://raw.githubusercontent.com/noctisalamandra/godot-vk-ads-android/main/screens/settings.png)

### 4. Configure Android export

In the export settings:

- Enable **Use Gradle Build**

![Plugin](https://raw.githubusercontent.com/noctisalamandra/godot-vk-ads-android/main/screens/plugin.png)

- Under **Permissions**, enable `Access Network State` and `Internet`

### 5. Configure Gradle

In `android/build/build.gradle`, add the following inside the `android {}` block:

```groovy
android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_17
        targetCompatibility JavaVersion.VERSION_17
    }
}
```

### 6. Add the node

Create a Node in your scene and attach the `vk_ads.gd` script from the plugin folder.

![Node](https://raw.githubusercontent.com/noctisalamandra/godot-vk-ads-android/main/screens/node.png)

---

## Configuration

The `VkAds` node exposes the following exported properties:

| Property | Type | Description |
|---|---|---|
| `banner_id` | `int` | Slot ID for banner ads |
| `banner_on_top` | `bool` | Show banner at top (`true`) or bottom (`false`, default) |
| `interstitial_id` | `int` | Slot ID for interstitial ads |
| `rewarded_id` | `int` | Slot ID for rewarded video ads |

Set the slot IDs in the Inspector:

![Key](https://raw.githubusercontent.com/noctisalamandra/godot-vk-ads-android/main/screens/key.png)

---

## API

### Methods

#### Banner

```gdscript
load_banner() -> void           # Load and display the banner
show_banner() -> void           # Show a previously hidden banner
hide_banner() -> void           # Hide the banner (keeps it in memory)
get_banner_dimension() -> Vector2  # Returns banner size in pixels
```

#### Interstitial

```gdscript
load_interstitial() -> void         # Load an interstitial ad
show_interstitial() -> void         # Show the loaded interstitial
is_interstitial_loaded() -> bool    # Check if interstitial is ready
```

#### Rewarded Video

```gdscript
load_rewarded_video() -> void         # Load a rewarded video ad
show_rewarded_video() -> void         # Show the loaded rewarded video
is_rewarded_video_loaded() -> bool    # Check if rewarded video is ready
```

### Signals

![Signals](https://raw.githubusercontent.com/noctisalamandra/godot-vk-ads-android/main/screens/signals.png)

#### Banner

| Signal | Arguments | Description |
|---|---|---|
| `banner_loaded` | — | Banner loaded successfully |
| `banner_failed_to_load` | `error_code: int` | Banner failed to load |

#### Interstitial

| Signal | Arguments | Description |
|---|---|---|
| `interstitial_loaded` | — | Interstitial loaded successfully |
| `interstitial_failed_to_load` | `error_code: int` | Interstitial failed to load |
| `interstitial_closed` | — | User closed the interstitial |

#### Rewarded Video

| Signal | Arguments | Description |
|---|---|---|
| `rewarded_video_loaded` | — | Rewarded video loaded successfully |
| `rewarded_video_failed_to_load` | `error_code: int` | Rewarded video failed to load |
| `rewarded_video_closed` | — | User closed the rewarded video |
| `rewarded` | `type: String` | User earned a reward |

---

## Usage Example

```gdscript
extends Node

func _ready():
    # Connect signals
    $VkAds.banner_loaded.connect(_on_banner_loaded)
    $VkAds.banner_failed_to_load.connect(_on_banner_failed_to_load)
    $VkAds.interstitial_loaded.connect(_on_interstitial_loaded)
    $VkAds.rewarded_video_loaded.connect(_on_rewarded_video_loaded)
    $VkAds.rewarded.connect(_on_rewarded)

# Load banner immediately
    $VkAds.load_banner()

func _on_banner_loaded():
    $VkAds.show_banner()

func _on_banner_failed_to_load(error_code: int):
    print("Banner failed: ", error_code)

# Call this when you want to show an interstitial
func show_interstitial_ad():
    if $VkAds.is_interstitial_loaded():
        $VkAds.show_interstitial()
    else:
        $VkAds.load_interstitial()

func _on_interstitial_loaded():
    $VkAds.show_interstitial()

# Call this when you want to show a rewarded video
func show_rewarded_ad():
    if $VkAds.is_rewarded_video_loaded():
        $VkAds.show_rewarded_video()
    else:
        $VkAds.load_rewarded_video()

func _on_rewarded_video_loaded():
    $VkAds.show_rewarded_video()

func _on_rewarded(type: String):
    print("Reward earned: ", type)
    # Grant the reward to the player here
```

---

## Demo project

A full example project is available [here](https://github.com/noctisalamandra/godot-vk-ads-android-demo).

## License

[MIT](LICENSE)

godot-vk-ads-android

Today's picks

Was this content helpful?

Recent Feedback

godot-vk-ads-android

Today's picks

Was this content helpful?

Recent Feedback

Download README