Deeplink plugin allows processing of Android application links that enable direct navigation to requested app content.
For iOS version, visit https://github.com/cengiz-pz/godot-ios-deeplink-plugin .
Follow instructions on the following page to create a custom Android gradle build
Follow instructions on the following page to associate your Godot app with your website:
There are 2 ways to install the Deeplink
plugin into your project:
- Through the Godot Editor's AssetLib
- Manually by downloading archives from Github
Before starting installation, please delete any other versions of this plugin.
Steps:
- search for and select the
Deeplink
plugin in Godot Editor - click
Download
button - on the installation dialog...
- keep
Change Install Folder
setting pointing to your project's root directory - keep
Ignore asset root
checkbox checked - click
Install
button
- keep
- enable the plugin via the
Plugins
tab ofProject->Project Settings...
menu, in the Godot Editor
Steps:
- download release archive from Github
- unzip the release archive
- copy to your Godot project's root directory
- enable the plugin via the
Plugins
tab ofProject->Project Settings...
menu, in the Godot Editor
- Add
Deeplink
nodes to your scene per URL association and follow the following steps:- set the required field on each
Deeplink
nodescheme
host
path prefix
- note that
scheme
,host
, andpath prefix
must all match for a URI to be processed by the app- leave
path prefix
empty to process all paths inhost
- leave
- set the required field on each
- register a listener for the
deeplink_received
signal- process
url
,scheme
,host
, andpath
data from the signal
- process
- alternatively, use the following methods to get most recent deeplink data:
get_link_url()
-> full URL for the deeplinkget_link_scheme()
-> scheme for the deeplink (ie. 'https')get_link_host()
-> host for the deeplink (ie. 'www.example.com')get_link_path()
-> path for the deeplink (the part that comes after host)
- additional methods:
is_domain_associated(a_domain: String)
-> returns true if your application is correctly associated with the given domain on the tested devicenavigate_to_open_by_default_settings()
-> navigates to the Android OS'Open by Default
settings screen for your application
adb shell
command can be used to simulate app links as follows:
$> adb shell am start -a android.intent.action.VIEW -c android.intent.category.BROWSABLE -d "https://www.example.com/mydata/path"
- Make sure that the scene that contains your Deeplink nodes is selected in the Godot Editor when building and exporting for Android
- Close other scenes to make sure
- Deeplink nodes will be searched in the scene that is currently open in the Godot Editor
If your game is not handling your deeplinks, then make sure to revisit the Android Export and Prerequisites sections.
adb logcat
is one of the best tools for troubleshooting unexpected behavior
- use
$> adb logcat | grep 'godot'
on Linuxadb logcat *:W
to see warnings and errorsadb logcat *:E
to see only errorsadb logcat | grep 'godot|somethingElse'
to filter using more than one string at the same time
- use
#> adb.exe logcat | select-string "godot"
on powershell (Windows)
Also check out:
https://docs.godotengine.org/en/stable/tutorials/platform/android/android_plugin.html#troubleshooting
Developed by Cengiz
Original repository: Godot Android Deeplink Plugin
This section provides information on how to build the plugin for contributors.
- Remove
deeplink/addon_template
directory - Run
git submodule update --remote --merge