Skip to content

Commit fae84f1

Browse files
cengiz-pzcengiz-pz
committed
Initial commit.
1 parent 29a1b2d commit fae84f1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+4604
-0
lines changed

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
custom: https://fund.godotengine.org/
2+
github: cengiz-pz

‎.github/ISSUE_TEMPLATE/bug_report.yaml‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
name: 🐞 Bug
2+
description: File a bug/issue
3+
title: "[BUG] <title>"
4+
labels: ["Bug", "Needs Triage"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the bug you encountered.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Current Behavior
16+
description: A clear and concise description of what the bug is.
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Expected Behavior
22+
description: A concise description of what you expected to happen.
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Steps To Reproduce
28+
description: Steps to reproduce the behavior.
29+
placeholder: |
30+
1. Installed manually | Installed via AssetLib
31+
2. Called method '....'
32+
3. Received signal '....'
33+
4. Noticed ADB Logcat error '...'
34+
validations:
35+
required: false
36+
- type: dropdown
37+
id: godot_version
38+
attributes:
39+
label: Godot Version
40+
description: What version of Godot are you running?
41+
options:
42+
- 4.3.stable
43+
- 4.4.1.stable
44+
- 4.5.stable
45+
- 4.x
46+
- Other
47+
default: 1
48+
validations:
49+
required: true
50+
- type: dropdown
51+
id: godot_os
52+
attributes:
53+
label: OS Godot Is Running On
54+
description: What operating system is Godot running on?
55+
options:
56+
- Windows 11
57+
- Windows (other)
58+
- macOS 15
59+
- macOS (other)
60+
- Android 14
61+
- Android 15
62+
- Android (other)
63+
- Other OS
64+
default: 0
65+
validations:
66+
required: true
67+
- type: dropdown
68+
id: plugin_version
69+
attributes:
70+
label: Plugin Version
71+
description: What version of the plugin are you running?
72+
options:
73+
- "3.0"
74+
- "3.1"
75+
- "3.2"
76+
- "3.3"
77+
- "4.0"
78+
- "5.0"
79+
- Other
80+
default: 4
81+
validations:
82+
required: true
83+
- type: dropdown
84+
id: plugin_os
85+
attributes:
86+
label: OS Plugin Is Running On
87+
description: What operating system the plugin (and your app) is running on?
88+
options:
89+
- Android 13
90+
- Android 14
91+
- Android 15
92+
- Android (other)
93+
- iOS 18.x
94+
- iOS 18.5
95+
- iOS (other)
96+
default: 2
97+
validations:
98+
required: true
99+
- type: textarea
100+
attributes:
101+
label: Anything else?
102+
description: |
103+
Links? References? Anything that will give more context about the issue you are encountering!
104+
105+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
106+
validations:
107+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# disable blank issue creation
2+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.yaml‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
name: 🐠 Feature Request
2+
description: Suggest an idea for this project
3+
title: "[FEATURE REQ] <title>"
4+
labels: ["Enhancement", "Question"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the bug you encountered.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Current Behavior
16+
description: Is your feature request related to a problem? Please describe.
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Proposed Behavior
22+
description: A clear and concise description of what you want to happen.
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Alternative Solutions
28+
description: Describe alternatives you've considered.
29+
placeholder: |
30+
A clear and concise description of any alternative solutions or features you've considered.
31+
validations:
32+
required: false
33+
- type: dropdown
34+
id: godot_version
35+
attributes:
36+
label: Godot Version
37+
description: What version of Godot are you running?
38+
options:
39+
- 4.3.stable
40+
- 4.4.1.stable
41+
- 4.5.stable
42+
- 4.x
43+
- Other
44+
default: 1
45+
validations:
46+
required: true
47+
- type: dropdown
48+
id: godot_os
49+
attributes:
50+
label: OS Godot Is Running On
51+
description: What operating system is Godot running on?
52+
options:
53+
- Windows 11
54+
- Windows (other)
55+
- macOS 15
56+
- macOS (other)
57+
- Android 14
58+
- Android 15
59+
- Android (other)
60+
- Other OS
61+
default: 0
62+
validations:
63+
required: true
64+
- type: dropdown
65+
id: plugin_version
66+
attributes:
67+
label: Plugin Version
68+
description: What version of the plugin are you running?
69+
options:
70+
- "3.0"
71+
- "3.1"
72+
- "3.2"
73+
- "3.3"
74+
- "4.0"
75+
- "5.0"
76+
- Other
77+
default: 4
78+
validations:
79+
required: true
80+
- type: dropdown
81+
id: plugin_os
82+
attributes:
83+
label: OS Plugin Is Running On
84+
description: What operating system the plugin (and your app) is running on?
85+
options:
86+
- Android 13
87+
- Android 14
88+
- Android 15
89+
- Android (other)
90+
- iOS 18.x
91+
- iOS 18.5
92+
- iOS (other)
93+
default: 2
94+
validations:
95+
required: true
96+
- type: textarea
97+
attributes:
98+
label: Anything else?
99+
description: |
100+
Links? References? Anything that will give more context about the issue you are encountering!
101+
102+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
103+
validations:
104+
required: false

‎.gitignore‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
#
2+
# © 2024-present https://github.com/cengiz-pz
3+
#
4+
5+
demo/addons
6+
demo/android
7+
demo/ios
8+
build/
9+
export.cfg
10+
11+
# General
12+
*.lock
13+
*.log
14+
15+
# Android
16+
.gradle/
17+
*.jar
18+
*.aar
19+
local.properties
20+
21+
# Android Studio/IntelliJ
22+
.idea/
23+
24+
# iOS
25+
*.d
26+
*.o
27+
*.dblite
28+
Pods/
29+
ios/godot/
30+
31+
# Godot 4+ specific ignores
32+
demo/.godot/*
33+
!demo/.godot/uid_cache.bin
34+
35+
# Godot-specific ignores
36+
.import/

‎README.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
<p align="center">
2+
<img width="256" height="256" src="demo/assets/inappreview-android.png">
3+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
4+
<img width="256" height="256" src="demo/assets/inappreview-ios.png">
5+
</p>
6+
7+
---
8+
9+
# <img src="addon/icon.png" width="24"> Godot In-app Review Plugin
10+
11+
Godot 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.
12+
13+
_This plugin has been moved under the umbrella of [Godot SDK Integrations](https://github.com/godot-sdk-integrations) organization in Github. Previously, the plugin was placed under three separate repositories: [Android](https://github.com/cengiz-pz/godot-android-inapp-review-plugin), [iOS](https://github.com/cengiz-pz/godot-ios-inapp-review-plugin), and [addon interface](https://github.com/cengiz-pz/godot-inapp-review-addon)._
14+
15+
<br/>
16+
17+
## <img src="addon/icon.png" width="20"> Installation
18+
_Before installing this plugin, make sure to uninstall any previous versions of the same plugin._
19+
20+
_If installing both Android and iOS versions of the plugin in the same project, then make sure that both versions use the same addon interface version._
21+
22+
There are 2 ways to install this plugin into your project:
23+
- Through the Godot Editor's AssetLib
24+
- Manually by downloading archives from Github
25+
26+
### <img src="addon/icon.png" width="18"> Installing via AssetLib
27+
Steps:
28+
- search for and select the `In-app Review` plugin in Godot Editor
29+
- click `Download` button
30+
- on the installation dialog...
31+
- keep `Change Install Folder` setting pointing to your project's root directory
32+
- keep `Ignore asset root` checkbox checked
33+
- click `Install` button
34+
- enable the plugin via the `Plugins` tab of `Project->Project Settings...` menu, in the Godot Editor
35+
36+
#### <img src="addon/icon.png" width="16"> Installing both Android and iOS versions of the plugin in the same project
37+
When installing via AssetLib, the installer may display a warning that states "_[x number of]_ files conflict with your project and won't be installed." You can ignore this warning since both versions use the same addon code.
38+
39+
### <img src="addon/icon.png" width="18"> Installing manually
40+
Steps:
41+
- download release archive from Github
42+
- unzip the release archive
43+
- copy to your Godot project's root directory
44+
- enable the plugin via the `Plugins` tab of `Project->Project Settings...` menu, in the Godot Editor
45+
46+
## <img src="addon/icon.png" width="20"> Usage
47+
Add an `InappReview` node to your scene and follow the following steps:
48+
- register listeners for the following signals emitted from the `InappReview` node
49+
- `review_info_generated`
50+
- `review_info_generation_failed`
51+
- `review_flow_launched`
52+
- `review_flow_launch_failed`
53+
- call the `generate_review_info()` method of the `InappReview` node
54+
- when the `review_info_generated` signal is received, call the `launch_review_flow()` of the `InappReview` node
55+
- Google Play Store API will display a dialog
56+
- Dialog may not be displayed if the review flow was launched recently
57+
- normal app functionality can resume when `review_flow_launched` signal is received
58+
59+
## <img src="addon/icon.png" width="20"> Demo
60+
The demo app's only purpose is to provide sample code. Since the demo app is not registered with the Google Play store, the Google Play in-app review dialog will not be displayed.
61+
62+
<br/><br/>
63+
64+
---
65+
66+
# <img src="addon/icon.png" width="24"> Android In-app Review Plugin
67+
68+
<p align="center">
69+
<img width="256" height="256" src="demo/assets/inappreview-android.png">
70+
</p>
71+
72+
73+
## [Android-specific Documentation](android/README.md)
74+
## [AssetLib Entry](https://godotengine.org/asset-library/asset/2549)
75+
76+
<br/><br/>
77+
78+
---
79+
80+
# <img src="addon/icon.png" width="24"> iOS In-app Review Plugin
81+
82+
<p align="center">
83+
<img width="256" height="256" src="demo/assets/inappreview-ios.png">
84+
</p>
85+
86+
## [iOS-specific Documentation](ios/README.md)
87+
## [AssetLib Entry](https://godotengine.org/asset-library/asset/2906)
88+
89+
<br/><br/>
90+
91+
---
92+
# <img src="addon/icon.png" width="24"> All Plugins
93+
94+
| Plugin | Android | iOS |
95+
| :--- | :---: | :---: |
96+
| [Notification Scheduler](https://github.com/godot-sdk-integrations/godot-notification-scheduler) | ✅ | ✅ |
97+
| [Admob](https://github.com/godot-sdk-integrations/godot-admob) | ✅ | ✅ |
98+
| [Deeplink](https://github.com/godot-sdk-integrations/godot-deeplink) | ✅ | ✅ |
99+
| [Share](https://github.com/godot-sdk-integrations/godot-share) | ✅ | ✅ |
100+
| [In-App Review](https://github.com/godot-sdk-integrations/godot-inapp-review) | ✅ | ✅ |
101+
102+
<br/><br/>
103+
104+
---
105+
# <img src="addon/icon.png" width="24"> Credits
106+
107+
Developed by [Cengiz](https://github.com/cengiz-pz)
108+
109+
iOS part is based on [DrMoriarty](https://github.com/DrMoriarty)'s [Godot iOS Plugin Template](https://github.com/DrMoriarty/godot_ios_plugin_template)
110+
111+
Original repository: [Godot In-app Review Plugin](godot-sdk-integrations/godot-inapp-review)

0 commit comments

Comments
 (0)