Godot Firebase Plugin

A Godot plugin that provides a unified GDScript interface for Firebase services on Android and iOS, with a modular node-based architecture that makes it easy to add and manage Firebase features directly in your scene tree. Supported services include Firebase Authentication and Cloud Firestore.

Key Features:

Firebase Authentication — email/password, Google Sign-In, and anonymous sign-in
User Management — create accounts, sign in/out, delete users, send verification and password-reset emails
Account Linking — link anonymous accounts to Google credentials
Cloud Firestore — add, set, get, update, and delete documents; query entire collections; and subscribe to real-time document change notifications
Typed Firestore Results — all Firestore responses are wrapped in FirestoreDocument, FirestoreResult, or FirestoreError objects rather than raw dictionaries
Modular Architecture — each Firebase service is a self-contained child node of the Firebase root node (e.g. FirebaseAuth, Firestore), making it easy to add only the modules you need
Signal-Based API — all async operations emit typed GDScript signals for clean, decoupled code
Cross-Platform — single GDScript interface for both Android and iOS native SDKs

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 Firebase 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 Firebase 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 a Firebase node to your main scene (or an autoload global scene), then add FirebaseAuth and/or Firestore nodes as children of Firebase to enable the services your project needs. Each Firebase module is a separate child node — only add the ones you use.

Connect to signals on the module nodes before calling any methods
Call methods directly on the FirebaseAuth or Firestore node
Use the returned FirebaseUser, FirestoreDocument, and FirestoreResult objects to access data

Authentication Example

@onready var firebase: Firebase = $Firebase
@onready var auth: FirebaseAuth = $Firebase/FirebaseAuth

func _ready() -> void:
	auth.auth_success.connect(_on_auth_success)
	auth.auth_failure.connect(_on_auth_failure)
	auth.sign_out_success.connect(_on_sign_out_success)

	# Check if a user is already signed in
	if auth.is_signed_in():
		var user: FirebaseUser = auth.get_current_user()
		print("Already signed in as: %s (%s)" % [user.get_name(), user.get_email()])
	else:
		auth.sign_in("user@example.com", "password123")

func _on_auth_success(user: FirebaseUser) -> void:
	print("Signed in: %s (verified: %s)" % [user.get_email(), user.get_is_email_verified()])

func _on_auth_failure(error_message: String) -> void:
	print("Auth failed: %s" % error_message)

func _on_sign_out_success(success: bool) -> void:
	print("Signed out successfully: %s" % success)

Firestore Example

@onready var firestore: Firestore = $Firebase/Firestore

func _ready() -> void:
	firestore.document_written.connect(_on_document_written)
	firestore.document_write_failed.connect(_on_document_write_failed)
	firestore.document_query_completed.connect(_on_document_query_completed)
	firestore.collection_query_completed.connect(_on_collection_query_completed)
	firestore.document_changed.connect(_on_document_changed)

	# Write a document
	var doc := FirestoreDocument.new()
	doc.set_collection("players").set_document_id("player_1").set_value("score", 9001)
	firestore.set_document(doc)

	# Read a document
	firestore.get_document("players", "player_1")

	# Query an entire collection
	firestore.get_collection("players")

	# Subscribe to real-time updates
	firestore.track_document("players", "player_1")

func _on_document_written(result: FirestoreDocument) -> void:
	print("Written to %s / %s" % [result.get_collection(), result.get_document_id()])

func _on_document_write_failed(error: FirestoreError) -> void:
	print("Write failed: %s" % error.get_error())

func _on_document_query_completed(result: FirestoreDocument) -> void:
	print("Score: %s" % result.get_value("score"))

func _on_collection_query_completed(result: FirestoreResult) -> void:
	for doc_id in result.get_all_document_ids():
		var doc: FirestoreDocument = result.get_document(doc_id)
		print("%s -> score: %s" % [doc_id, doc.get_value("score")])

func _on_document_changed(document: FirestoreDocument) -> void:
	print("Live update for %s: score = %s" % [document.get_document_id(), document.get_value("score")])

Signals

FirebaseAuth Signals

Signal	Parameters	Description
`auth_success`	`user: FirebaseUser`	Emitted when a sign-in or account creation succeeds. The resulting `FirebaseUser` object contains the authenticated user's profile.
`auth_failure`	`error_message: String`	Emitted when a sign-in or account creation attempt fails.
`link_with_google_success`	`user: FirebaseUser`	Emitted when an anonymous account is successfully linked to a Google credential.
`link_with_google_failure`	`error_message: String`	Emitted when linking an anonymous account to Google fails.
`sign_out_success`	`success: bool`	Emitted after a sign-out attempt, indicating whether it succeeded.
`password_reset_sent`	`success: bool`	Emitted after attempting to send a password-reset email, indicating whether it was sent successfully.
`email_verification_sent`	`success: bool`	Emitted after attempting to send a verification email to the current user, indicating whether it was sent successfully.
`user_deleted`	`success: bool`	Emitted after attempting to delete the current user's account, indicating whether the deletion succeeded.

Firestore Signals

Signal	Parameters	Description
`document_written`	`document: FirestoreDocument`	Emitted when a document is successfully written (via `add_document`, `set_document`, or `set_document_with_merge`). Returns the written document.
`document_write_failed`	`error: FirestoreError`	Emitted when a document write operation fails.
`document_query_completed`	`document: FirestoreDocument`	Emitted when a `get_document` call succeeds. Returns the retrieved document.
`document_query_failed`	`error: FirestoreError`	Emitted when a `get_document` call fails.
`collection_query_completed`	`result: FirestoreResult`	Emitted when a `get_collection` call succeeds. Returns a `FirestoreResult` containing all documents in the collection.
`collection_query_failed`	`error: FirestoreError`	Emitted when a `get_collection` call fails.
`document_updated`	`document: FirestoreDocument`	Emitted when an `update_document` call succeeds. Returns the updated document.
`document_update_failed`	`error: FirestoreError`	Emitted when an `update_document` call fails.
`document_deleted`	`document: FirestoreDocument`	Emitted when a `delete_document` call succeeds. Returns the document that was deleted.
`document_delete_failed`	`error: FirestoreError`	Emitted when a `delete_document` call fails.
`document_changed`	`document: FirestoreDocument`	Emitted whenever a tracked document changes in Firestore (real-time listener).

Methods

FirebaseAuth Methods

Method	Returns	Description
`create_user(email: String, password: String)`	`void`	Creates a new Firebase user account with the given email and password. Emits `auth_success` or `auth_failure`.
`sign_in(email: String, password: String)`	`void`	Signs in an existing user with email and password. Emits `auth_success` or `auth_failure`.
`sign_in_with_google()`	`void`	Starts the Google Sign-In flow. Emits `auth_success` or `auth_failure`.
`sign_in_anonymously()`	`void`	Signs in the user anonymously. Emits `auth_success` or `auth_failure`.
`link_anonymous_with_google()`	`void`	Links the currently signed-in anonymous account to a Google credential. Emits `link_with_google_success` or `link_with_google_failure`.
`is_signed_in()`	`bool`	Returns `true` if a user is currently signed in, `false` otherwise.
`get_current_user()`	`FirebaseUser`	Returns a `FirebaseUser` for the currently signed-in user, or `null` if no user is signed in.
`sign_out()`	`void`	Signs out the current user. Emits `sign_out_success`.
`send_password_reset_email(email: String)`	`void`	Sends a password-reset email to the given address. Emits `password_reset_sent`.
`send_verification_email()`	`void`	Sends an email-verification message to the current user's email address. Emits `email_verification_sent`.
`delete_current_user()`	`void`	Permanently deletes the currently signed-in user's account. Emits `user_deleted`.

Firestore Methods

Method	Returns	Description
`add_document(document: FirestoreDocument)`	`void`	Adds a new document to the specified collection, letting Firestore auto-generate its ID. Emits `document_written` or `document_write_failed`.
`set_document(document: FirestoreDocument)`	`void`	Writes a document at the specified collection/document-ID path, overwriting any existing data. Emits `document_written` or `document_write_failed`.
`set_document_with_merge(document: FirestoreDocument)`	`void`	Writes a document with merge enabled — existing fields not present in `document` are preserved. Emits `document_written` or `document_write_failed`.
`get_document(collection: String, document_id: String)`	`void`	Fetches a single document by collection and ID. Emits `document_query_completed` or `document_query_failed`.
`get_collection(collection: String)`	`void`	Fetches all documents in the specified collection. Emits `collection_query_completed` or `collection_query_failed`.
`update_document(document: FirestoreDocument)`	`void`	Updates only the fields present in `document`, leaving all other fields unchanged. Emits `document_updated` or `document_update_failed`.
`delete_document(collection: String, document_id: String)`	`void`	Deletes the document at the specified path. Emits `document_deleted` or `document_delete_failed`.
`track_document(collection: String, document_id: String)`	`void`	Attaches a real-time listener to the specified document. Emits `document_changed` whenever the document is modified in Firestore.

Classes

FirebaseUser

Extends RefCounted. Encapsulates the profile data of an authenticated Firebase user. Instances are returned by FirebaseAuth.get_current_user() and carried by the auth_success and link_with_google_success signals.

Method	Returns	Description
`get_user_id()`	`String`	The unique Firebase UID for this user.
`set_user_id(a_user_id: String)`	`void`	Sets the user's UID.
`get_name()`	`String`	The user's display name.
`set_name(a_name: String)`	`void`	Sets the user's display name.
`get_email()`	`String`	The user's email address.
`set_email(a_email: String)`	`void`	Sets the user's email address.
`get_photo_url()`	`String`	URL of the user's profile photo.
`set_photo_url(a_photo_url: String)`	`void`	Sets the user's profile photo URL.
`get_is_email_verified()`	`bool`	Returns `true` if the user's email address has been verified.
`set_is_email_verified(a_is_email_verified: bool)`	`void`	Sets the email-verified flag.
`get_is_anonymous()`	`bool`	Returns `true` if the user is signed in anonymously.
`set_is_anonymous(a_is_anonymous: bool)`	`void`	Sets the anonymous flag.

FirestoreDocument

Extends RefCounted. Represents a single Firestore document — its collection path, document ID, and all of its field values. Used as the input to write operations and returned by read operations and real-time listeners. Setter methods return self to enable method chaining.

Method	Returns	Description
`get_collection()`	`String`	The Firestore collection this document belongs to.
`set_collection(a_collection: String)`	`FirestoreDocument`	Sets the collection name. Returns `self` for chaining.
`get_document_id()`	`String`	The document's unique ID within its collection.
`set_document_id(a_document_id: String)`	`FirestoreDocument`	Sets the document ID. Returns `self` for chaining.
`get_value(key: String)`	`Variant`	Returns the value stored under `key`, or `null` if the key does not exist.
`set_value(key: String, value: Variant)`	`FirestoreDocument`	Stores `value` under `key` in the document's data map. Returns `self` for chaining.
`get_data()`	`Dictionary`	Returns the full key/value data dictionary for this document.
`set_data(a_data: Dictionary)`	`FirestoreDocument`	Replaces the document's data with the provided dictionary. Returns `self` for chaining.

FirestoreResult

Extends RefCounted. Wraps the response from a collection query (get_collection). Provides access to every document returned, either by iterating all IDs or by fetching a specific document by ID.

Method	Returns	Description
`get_all_document_ids()`	`Array[String]`	Returns an array of all document IDs in this result set.
`get_document(document_id: String)`	`FirestoreDocument`	Returns the `FirestoreDocument` for the given ID, or `null` if not found.
`get_documents()`	`Dictionary`	Returns the full dictionary of all documents, keyed by document ID.
`set_documents(a_documents: Dictionary)`	`void`	Replaces the internal document map with the provided dictionary.

FirestoreError

Extends RefCounted. Carries error information emitted by any failed Firestore operation signal (e.g. document_write_failed, document_query_failed).

Method	Returns	Description
`get_error()`	`String`	A human-readable description of the error.
`set_error(a_error: String)`	`void`	Sets the error message.

FirebaseModule

Extends Node. Abstract base class for all Firebase feature module nodes (e.g. FirebaseAuth, Firestore). Handles locating and caching the native plugin singleton, and automatically re-acquires it when the app resumes from the background. All module nodes must be direct children of a Firebase node — the editor will display a configuration warning if this requirement is not met.

Nodes

The plugin exposes its functionality through a tree of custom Godot nodes. Add the Firebase root node to your scene and attach only the module child nodes for the Firebase services your project uses.

Note: Additional module nodes (extending FirebaseModule) will be added here as support for more Firebase services is introduced.

Firebase

Extends: Node

The root node for the entire plugin. Add this node to your main scene or an autoload scene. It automatically tracks all FirebaseModule child nodes as they enter and leave the scene tree, and surfaces editor configuration warnings when the node tree is set up incorrectly.

Properties:

Property	Type	Description
`auth`	`FirebaseAuth`	Reference to the `FirebaseAuth` child node, or `null` if none is present. Updated automatically as children are added or removed.
`firestore`	`Firestore`	Reference to the `Firestore` child node, or `null` if none is present. Updated automatically as children are added or removed.

Configuration warnings (shown in the Godot editor):

Shown when no FirebaseAuth child node is present (authentication features will be unavailable).
Shown when more than one FirebaseAuth child node is detected (only one is supported at a time).
Shown when more than one Firestore child node is detected (only one is supported at a time).

FirebaseAuth

Extends: FirebaseModule → Node

Add this node as a direct child of Firebase to enable Firebase Authentication. It bridges GDScript signals and method calls to the underlying native Android/iOS Firebase Auth SDK via the plugin singleton.

Signals: see Signals — FirebaseAuth section above.

Methods: see Methods — FirebaseAuth section above.

Firestore

Extends: FirebaseModule → Node

Add this node as a direct child of Firebase to enable Cloud Firestore. It bridges GDScript signals and method calls to the underlying native Android/iOS Firestore SDK via the plugin singleton.

Signals: see Signals — Firestore section above.

Methods: see Methods — Firestore section above.

Scene tree example:

Main (Node)
└-- Firebase (Firebase)
    ├-- FirebaseAuth (FirebaseAuth)
    └-- Firestore (Firestore)

Platform-Specific Notes

Android

Download Android export template and enable gradle build from export settings
Log into the Firebase Console
- Create a Firebase project and register your Android app
- Enable all necessary Firebase features (Auth, Firestore, etc.) that you plan to use
- Download google-services.json and place it in your project's android/build/ directory prior to export
Troubleshooting:
Logs: adb logcat | grep 'godot' (Linux), adb.exe logcat | select-string "godot" (Windows)
You may find the following resources helpful:

iOS

Follow instructions on Exporting for iOS
Log into the Firebase Console
- Create a Firebase project (or use existing project with Android app) and register your iOS app
- Enable all necessary Firebase features (Auth, Firestore, etc.) that you plan to use
- Download GoogleService-Info.plist and add it to your exported Xcode project
View Xcode logs while running the game for troubleshooting.
See Godot iOS Export Troubleshooting.

Links

All Plugins

Plugin	Android	iOS
Admob	✅	✅
Connection State	✅	✅
Deeplink	✅	✅
Firebase	✅	✅
In-App Review	✅	✅
Native Camera	✅	✅
Notification Scheduler	✅	✅
OAuth 2.0	✅	✅
QR	✅	✅
Share	✅	✅
Vision	✅	✅

Credits

Developed by Godot Firebase Team

Based on Godot Mobile Plugin Template v7

Original repository: Godot Firebase Plugin

Contributing

Contributions are welcome. Please see the contributing guide in the repository for details.

💖 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.

Name		Name	Last commit message	Last commit date
Latest commit History 9 Commits
.github		.github
addon		addon
android		android
common		common
demo		demo
docs		docs
ios		ios
script		script
.editorconfig		.editorconfig
.gitignore		.gitignore
LICENSE		LICENSE

Uh oh!

Folders and files

Latest commit

History

Repository files navigation

Godot Firebase Plugin

Table of Contents

Installation

Installing via AssetLib

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

Installing manually

Usage

Authentication Example

Firestore Example

Signals

FirebaseAuth Signals

Firestore Signals

Methods

FirebaseAuth Methods

Firestore Methods

Classes

FirebaseUser

FirestoreDocument

FirestoreResult

FirestoreError

FirebaseModule

Nodes

Firebase

FirebaseAuth

Firestore

Platform-Specific Notes

Android

iOS

Links

All Plugins

Credits

Contributing

💖 Support the Project

⭐ Star History

About

Topics

Resources

License

Code of conduct

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases 1

Sponsor this project

Uh oh!

Contributors

Uh oh!

Languages