Skip to content
Kyle Szklenski edited this page Oct 16, 2024 · 15 revisions

Welcome to the GodotFirebase wiki!

Here you will find all the documentation on how to use this Godot Firebase Plugin.

If you are unsure where to start, check out the following pages:

WARNING NOTE: If you are downloading the addon straight from this repo, make sure if you're on a 4.x version of Godot that you use the main branch! If you're still on 3.x, then the 3.x branch is what you want.

Design

This plugin is designed around the Firebase REST API. This means it is massively cross-platform, far more than any other Firebase plugin or library, because they have code that is (generally) Android- or iOS-only. Since it's a Godot plugin, it also does not require recompiling the Godot with an additional module whenever an updated version is released. It is verified to work across all of the following platforms at present:

Supported platforms

  • Android
  • iOS
  • Mac
  • HTML5
  • Windows
  • Linux
  • Serverless

Supported features

  • Realtime Database
  • Firestore
  • Authentication and User Management
  • Storage
  • Dynamic Links
  • Cloud Functions
  • RemoteConfig (requires significant work to enable)

Unsupported features

  • Analytics - no real REST API at the moment
  • Offline support - implementation attempted but only for Firestore; not effective, so turned off temporarily until I can resolve it satisfactorily

Support email: godotnuts@gmail.com