Skip to content

Commit efc8a4c

Browse files
Update README.md
1 parent eef18ee commit efc8a4c

File tree

1 file changed

+58
-1
lines changed

1 file changed

+58
-1
lines changed

README.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,59 @@
11
# GodotFirebaseAndroid
2-
Godot Android plugin for Firebase
2+
3+
Firebase plugin for Android export in Godot Engine.
4+
5+
## Features
6+
7+
- [x] Firebase Authentication (Email/Password, Google Sign-In)
8+
- [x] Cloud Firestore
9+
- [x] Realtime Database
10+
- [x] Cloud Storage
11+
- [ ] Cloud Messaging (coming soon)
12+
13+
---
14+
15+
## Quick Start
16+
17+
**Step 1: Install the Plugin**
18+
19+
- Download the latest release from the [Releases](https://github.com/your-repo/releases) page.
20+
21+
- Unzip and copy the plugin to your project’s `addons` folder:
22+
23+
```
24+
your_project/addons/GodotFirebaseAndroid/
25+
```
26+
27+
- In Godot, go to **Project > Project Settings > Plugins**, and enable **GodotFirebaseAndroid**.
28+
29+
---
30+
31+
**Step 2: Add Firebase to Your Project**
32+
33+
- Open [Firebase Console](https://console.firebase.google.com)
34+
- Create a Firebase project and register your Android app.
35+
- Enable the required services (e.g., Authentication, Firestore).
36+
- Download the `google-services.json` file.
37+
- Place it in:
38+
39+
```
40+
android/build/google-services.json
41+
```
42+
43+
---
44+
45+
**Step 3: Enable Gradle Build for Android Export**
46+
47+
- In Godot:
48+
**Project > Export > Android > gradle/use_gradle_build**: ✅
49+
50+
---
51+
52+
## Build Notes
53+
54+
This plugin automatically modifies `build.gradle` and `settings.gradle` at export time to include the necessary Firebase dependencies.
55+
56+
Make sure:
57+
58+
- Gradle build is enabled before exporting.
59+
- `google-services.json` exists in `android/build/` before export.

0 commit comments

Comments
 (0)