Skip to content

A Godot plugin that provides a unified GDScript interface for in-app reviews via Google Play and App Store.

License

Notifications You must be signed in to change notification settings

godot-sdk-integrations/godot-inapp-review

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

      


Godot In-app Review Plugin

In-app Review Plugin provides access to in-app review functionality for Google Play Store on the Android platform and Apple App Store on the iOS platform through a unified GDScript interface.

Features:

  • Enable in-app review for Google Play
  • Enable in-app review for App Store

Table of Contents


Installation

Uninstall previous versions before installing. If using both Android & iOS, ensure same addon interface version.

Options:

  1. AssetLib
    • Search for In-app Review
    • Click DownloadInstall
    • Install to project root, Ignore asset root checked
    • Enable via Project → Project Settings → Plugins
    • Ignore file conflict warnings when installing both versions
  2. Manual
    • Download release from GitHub
    • Unzip to project root
    • Enable via Plugins tab

Usage

Add an InappReview node to your scene and follow the following steps:

  • register listeners for the all signals emitted from the InappReview node
  • call the generate_review_info() method of the InappReview node
  • when the review_info_generated signal is received, call the launch_review_flow() of the InappReview node
    • Depending on platform Google Play or App Store API will display a review dialog
    • Dialog may not be displayed if the review flow was launched recently
  • normal app functionality can resume when review_flow_launched signal is received

Demo

The demo app's only purpose is to provide sample code. Since the demo app is not registered with the Google Play store or App Store, the in-app review dialog will not be displayed.


Signals

  • review_info_generated: Emitted when info generation succeeded.
  • review_info_generation_failed: Emitted when info generation failed.
  • review_flow_launched: Emitted when review flow launched.
  • review_flow_launch_failed: Emitted when review flow launch failed.

Platform-Specific Notes

Android

iOS

  • Registration: App must be registered with the App Store.
  • Troubleshooting:

Links


All Plugins

Plugin Android iOS
Notification Scheduler
Admob
Deeplink
Share
In-App Review

Credits

Developed by Cengiz

iOS part is based on DrMoriarty's Godot iOS Plugin Template

Original repository: Godot In-app Review Plugin


Contributing

This section provides information on how to build the plugin for contributors.


iOS

Prerequisites


Build

  • Run ./script/build.sh -A <godot version> initially to run a full build
  • Run ./script/build.sh -cgA <godot version> to clean, redownload Godot, and rebuild
  • Run ./script/build.sh -ca to clean and build without redownloading Godot
  • Run ./script/build.sh -cb -z4.0 to clean and build plugin without redownloading Godot and package in a zip archive as version 4.0
  • Run ./script/build.sh -h for more information on the build script

Install Script

  • Run ./script/install.sh -t <target directory> -z <path to zip file> install plugin to a Godot project.
  • Example ./script/install.sh -t demo -z build/release/DeeplinkPlugin-v4.0.zip to install to demo app.

Libraries

Library archives will be created in the build/release directory.


Android

Build

Options:

  1. Use Android Studio to build via Build->Assemble Project menu
    • Switch Active Build Variant to release and repeat
    • Run packageDistribution task to create release archive
  2. Use project-root-level build.sh script
    • ./script/build.sh -ca - clean existing build, do a debug build for Android
    • ./script/build.sh -carz - clean existing build, do a release build for Android, and create archive

About

A Godot plugin that provides a unified GDScript interface for in-app reviews via Google Play and App Store.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

  •