Skip to content

Commit 15334a8

Browse files
Update README.md
1 parent d535881 commit 15334a8

File tree

1 file changed

+17
-20
lines changed

1 file changed

+17
-20
lines changed

README.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# GodotFirebaseAndroid
22

3-
Firebase plugin for Android export in Godot Engine.
3+
**GodotFirebaseAndroid** is an Android plugin for the Godot Engine that integrates Firebase services in Godot Android games and apps.
4+
It supports Godot 4.2+
45

56
## Features
67

@@ -12,48 +13,44 @@ Firebase plugin for Android export in Godot Engine.
1213

1314
---
1415

15-
## Quick Start
16+
## 🚀 Quick Start
1617

17-
**Step 1: Install the Plugin**
18+
### 1. Install the Plugin
1819

19-
- Download the latest release from the [Releases](https://github.com/your-repo/releases) page.
20+
- Download the latest release from the [Releases](https://github.com/syntaxerror247/GodotFirebaseAndroid/releases) page.
2021

2122
- Unzip and copy the plugin to your project’s `addons` folder:
2223

2324
```
2425
your_project/addons/GodotFirebaseAndroid/
2526
```
2627

27-
- In Godot, go to **Project > Project Settings > Plugins**, and enable **GodotFirebaseAndroid**.
28+
- In Godot, go to:
29+
**Project > Project Settings > Plugins**, and enable **GodotFirebaseAndroid**.
2830

2931
---
3032

31-
**Step 2: Add Firebase to Your Project**
33+
### 2. Add Firebase to Your Project
3234

33-
- Open [Firebase Console](https://console.firebase.google.com)
35+
- Visit [Firebase Console](https://console.firebase.google.com)
3436
- 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:
37+
- Enable required services (e.g., Authentication, Firestore).
38+
- Download the `google-services.json` file and place it in:
3839

3940
```
4041
android/build/google-services.json
4142
```
4243

4344
---
4445

45-
**Step 3: Enable Gradle Build for Android Export**
46+
### 3. Enable Gradle Build for Android Export
4647

47-
- In Godot:
48-
**Project > Export > Android > gradle/use_gradle_build**: ✅
48+
In Godot, go to:
4949

50-
---
51-
52-
## Build Notes
50+
**Project > Export > Android > gradle/use\_gradle\_build** and enable it ✅
5351

54-
This plugin automatically modifies `build.gradle` and `settings.gradle` at export time to include the necessary Firebase dependencies.
52+
---
5553

56-
Make sure:
54+
## 📚 Documentation
5755

58-
- Gradle build is enabled before exporting.
59-
- `google-services.json` exists in `android/build/` before export.
56+
Full documentation is available at: https://syntaxerror247.github.io/GodotFirebaseAndroid

0 commit comments

Comments
 (0)