https://github.com/emagood/godot_android_plugins
https://github.com/emagood/godot_android_plugins
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/emagood/godot_android_plugins
- Owner: emagood
- License: mit
- Created: 2025-03-10T20:30:38.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-10T21:13:42.000Z (3 months ago)
- Last Synced: 2025-03-10T21:32:08.412Z (3 months ago)
- Language: GDScript
- Size: 64.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Godot Android Plugin Template
This repository serves as a quickstart template for building a Godot Android plugin for Godot 4.3+.
## Contents
* An illustrative simple Godot project: [`plugin/demo`](plugin/demo)
* Preconfigured gradle build file to build and package the contents for the Android plugin:
[`plugin/build.gradle.kts`](plugin/build.gradle.kts)
* Preconfigured export scripts template:
[`plugin/export_scripts_template`](plugin/export_scripts_template)
* Preconfigured manifest for the Android plugin:
[`plugin/src/main/AndroidManifest.xml`](plugin/src/main/AndroidManifest.xml)
* Preconfigured source files for the Kotlin/Java logic of the Android plugin:
[`plugin/src/main/java`](plugin/src/main/java)
## Usage
**Note:** [Android Studio](https://developer.android.com/studio) is the recommended IDE for
developing Godot Android plugins.
You can install the latest version from https://developer.android.com/studio.
To use this template, log in to github and click the green "Use this template" button at the top
of the repository page.
This will let you create a copy of this repository with a clean git history.
### Configuring the template
After cloning your own copy to your local machine, configure the project as needed. Several
`TODO` have been added to the project to help identify where changes are needed; here's an
overview of the minimum set of modifications needed:
* Update the name of the Android plugin. Note that the name should not contain any spaces:
* Open [`settings.gradle.kts`](settings.gradle.kts) and update the value for `rootProject.name`
* Open [`plugin/build.gradle.kts`](plugin/build.gradle.kts) and update the value for `pluginName`
* Open [`plugin/export_scripts_template/plugin.cfg`](plugin/export_scripts_template/plugin.cfg)
and update the value for `name`
* Open [`plugin/export_scripts_template/export_plugin.gd`](plugin/export_scripts_template/export_plugin.gd)
and update the value for `_plugin_name`
* Update the package name of the Android plugin:
* Open [`plugin/build.gradle.kts`](plugin/build.gradle.kts) and update the value for `pluginPackageName`
* Make sure subdirectories under [`plugin/src/main/java`](plugin/src/main/java) match the
updated package name
* Make sure that `package` at the top of [`GodotAndroidPlugin.kt`](plugin/src/main/java/org/godotengine/plugin/android/template/GodotAndroidPlugin.kt)
matches the updated package name
* Complete the plugin configuration
* Open [`plugin/export_scripts_template/plugin.cfg`](plugin/export_scripts_template/plugin.cfg)
* Update the `description` field
* Update the `author` field
* Update the `version` field
### Building the configured Android plugin
- In a terminal window, navigate to the project's root directory and run the following command:
```
./gradlew assemble
```
- On successful completion of the build, the output files can be found in
[`plugin/demo/addons`](plugin/demo/addons)
### Testing the Android plugin
You can use the included [Godot demo project](plugin/demo/project.godot) to test the built Android
plugin
- Open the demo in Godot (4.2 or higher)
- Navigate to `Project` -> `Project Settings...` -> `Plugins`, and ensure the plugin is enabled
- Install the Godot Android build template by clicking on `Project` -> `Install Android Build Template...`
- Open [`plugin/demo/main.gd`](plugin/demo/main.gd) and update the logic as needed to reference
your plugin and its methods
- Connect an Android device to your machine and run the demo on it
#### Tips
Additional dependencies added to [`plugin/build.gradle.kts`](plugin/build.gradle.kts) should be added to the `_get_android_dependencies`
function in [`plugin/export_scripts_template/export_plugin.gd`](plugin/export_scripts_template/export_plugin.gd).
##### Simplify access to the exposed Java / Kotlin APIs
To make it easier to access the exposed Java / Kotlin APIs in the Godot Editor, it's recommended to
provide one (or multiple) gdscript wrapper class(es) for your plugin users to interface with.
For example:
```
class_name PluginInterface extends Object
## Interface used to access the functionality provided by this plugin
var _plugin_name = "GDExtensionAndroidPluginTemplate"
var _plugin_singleton
func _init():
if Engine.has_singleton(_plugin_name):
_plugin_singleton = Engine.get_singleton(_plugin_name)
else:
printerr("Initialization error: unable to access the java logic")
## Shows a 'Hello World' toast.
func helloWorld():
if _plugin_singleton:
_plugin_singleton.helloWorld()
else:
printerr("Initialization error")
```
## tener en cuenta
** godot 4.3 stable
** gradle se usa 8.1.0
plugins {
id("com.android.library") version "8.2.0" apply false
}
** sdk 34
android {
compileSdk = 34
targetSdk = 33 // ???
}
## android studio console build
.\gradlew.bat build --stacktrace
## gradle cache clean y build
.\gradlew.bat clean --refresh-dependencies
.\gradlew.bat build