---

Template Initialization

---

Run the init.sh script in order to initialize the repository.

How To Run init.sh

Use the -n option to rename plugin:

$ godot-plugin-template > ./script/init.sh -n NameOfYourPlugin

or optionally specify the name of the plugin author and author's GitHub username:

$ godot-plugin-template > ./script/init.sh -n NameOfYourPlugin -a "Author Name" -g "github-username"

Example:

$ godot-plugin-template > ./script/init.sh -n GameBooster

or:

$ godot-plugin-template > ./script/init.sh -n GameBooster -a "Maria Wang" -g "mariawang"

Dry Run init.sh

Use the -d option to dry-run init.sh:

$ godot-plugin-template > ./script/init.sh -n NameOfYourPlugin -d

or:

$ godot-plugin-template > ./script/init.sh -n NameOfYourPlugin -a "Author Name" -g "github-username" -d

The dry-run will show what would be done without making changes.

---

---

Godot Plugin Template Plugin

A Godot plugin that provides a unified GDScript interface for getting information on plugin templates on Android and iOS.

Key Features:

• Get information about all available plugin templates
• Know when a template is ready
• ...

Table of Contents

• Installation
• Usage
• Signals
• Methods
• Classes
• Platform-Specific Notes
• Links
• All Plugins
• Credits
• Contributing

Installation

Before installing this plugin, make sure to uninstall any previous versions of the same plugin.

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.

There are 2 ways to install the PluginTemplate plugin into your project:

• Through the Godot Editor's AssetLib
• Manually by downloading archives from Github

Installing via AssetLib

Steps:

• search for and select the PluginTemplate 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
• enable the plugin via the Plugins tab of Project->Project Settings... menu, in the Godot Editor

Installing both Android and iOS versions of the plugin in the same project

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.

Installing manually

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 of Project->Project Settings... menu, in the Godot Editor

Usage

Add PluginTemplate node to your main scene or an autoload global scene.

• use the PluginTemplate node's get_plugin_template() method to get information on all available plugin templates
• connect PluginTemplate node signals
  • template_ready(a_template: PluginTemplateInfo)
  • ...

Example usage:

@onready var plugin_template := $PluginTemplate

func _ready():
	plugin_template.template_ready.connect(_on_template_ready)

	var templates: Array[PluginTemplateInfo] = plugin_template.get_plugin_template()
	for template in templates:
		print("Template description: %s" % [template.get_description()])

func _on_template_ready(template: PluginTemplateInfo):
	print("Template ready:", template.get_description())

Signals

• register listeners to the following signals of the PluginTemplate node:
  • template_ready(a_template: PluginTemplateInfo)
  • ...

Methods

• get_plugin_template() -> Array[PluginTemplateInfo] - returns an array of PluginTemplateInfo objects

Classes

PluginTemplateInfo

• Encapsulates plugin template information.
• Properties:
  • description: description of the template
  • other: ...
  • ...

Platform-Specific Notes

Android

• Download Android export template and enable gradle build from export settings
• Troubleshooting:
• Logs: adb logcat | grep 'godot' (Linux), adb.exe logcat | select-string "godot" (Windows)
• You may find the following resources helpful:
  • https://docs.godotengine.org/en/stable/tutorials/export/exporting_for_android.html
  • https://developer.android.com/tools/adb
  • https://developer.android.com/studio/debug
  • https://developer.android.com/courses

iOS

• Follow instructions on Exporting for iOS
• View XCode logs while running the game for troubleshooting.
• See Godot iOS Export Troubleshooting.

Links

• AssetLib Entry Android
• AssetLib Entry iOS

All Plugins

✦	Plugin	Android	iOS	Latest Release	Downloads	Stars
	Admob	✅	✅
	Connection State	✅	✅
	Deeplink	✅	✅
	Firebase	⏰	⏰	🔜	-
	In-App Review	✅	✅
	Native Camera	✅	✅
	Notification Scheduler	✅	✅
	OAuth 2.0	✅	✅
	QR	✅	✅
	Share	✅	✅
	Vision	⏰	⏰	🔜	-
	Plugin Template	✅	✅	-	-

Credits

Developed by <>

Original repository: Godot Plugin Template Plugin

Contributing

See our guide if you would like to contribute to this project.

💖 Support the Project

If this plugin has helped you, consider supporting its development! Every bit of support helps keep the plugin updated and bug-free.

✦	Ways to Help	How to do it
✨⭐	Spread the Word	Star this repo to help others find it.
💡✨	Give Feedback	Open an issue or suggest a feature.
🧩	Contribute	Submit a PR to help improve the codebase.
❤️	Buy a Coffee	Support the maintainers on GitHub Sponsors or other platforms.

⭐ Star History