Skip to content

Commit ef9feaf

Browse files
authored
Improve firebase getting started page (#165)
Fix formatting Reword a few things
1 parent 54932ea commit ef9feaf

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

docs/gdevelop5/all-features/firebase/quickstart.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,45 @@ To use Firebase, you have to connect it to a Firebase account. This page explain
77

88
### Step 1: Set Up Firebase
99

10-
First, go to <https://console.firebase.google.com/>. You should have your projects. Let's create a new one: ![](/gdevelop5/all-features/firebase/quickstart1.jpg)
10+
First, go to <https://console.firebase.google.com/>. You should see your projects. Let's create a new one, if you do not have one for your game yet:
1111

12-
Enter a name for your project. In this guide, we'll be calling it "Tutorial-GDevelop-5". ![](/gdevelop5/all-features/firebase/quickstart2.jpg)
12+
![](/gdevelop5/all-features/firebase/quickstart1.jpg)
1313

14-
Choose to enable Google Analytics or not (It is recommended that you enable it). In this example, we'll enable it as we want to showcase every feature, You can always change that later.
14+
Enter a name for your project. In this guide, we'll be calling it "Tutorial-GDevelop-5".
15+
16+
![](/gdevelop5/all-features/firebase/quickstart2.jpg)
17+
18+
Choose to enable Google Analytics or not. Enabling them will make Firebase collect a lot of data about your users to help you learn more about how they interact with your game. Note that all the data will be shared with Google as well. If you just want to know how many players play, how often, and fully preserve annonimity, respect of user's private data & GDPR compliance, you can also try GDevelop Analytics instead. In this example, we'll enable it as we want to showcase every feature. If you are unsure, you can always enable it later.
1519

1620
![](/gdevelop5/all-features/firebase/bandicam_2020-05-07_17-25-40-916.jpg)
1721

18-
Accept the terms
22+
Accept the terms to create the project.
1923

2024
![](/gdevelop5/all-features/firebase/bandicam_2020-05-07_17-25-55-986.jpg)
2125

22-
You should now have a Firebase dashboard.
26+
You should now have a Firebase dashboard for your game.
2327

2428
![](/gdevelop5/all-features/firebase/bandicam_2020-05-07_17-26-34-404.jpg)
2529

2630
### Step 2: Register an app for your GDevelop game
2731

28-
To register your game, you need to create a new "web app" in Firebase (even if your game is going to be exported to mobile/PC). To do so, click on the third button (the one with the angle brackets) to add a "web app" (see the following screenshot)
32+
To register your game, you need to create a new "Web App" in Firebase. Regardless of the platform GDevelop games are exported to, GDevelop will only work as a Web App. To do so, click on the third button (the one with the angle brackets) to add a "web app":
2933

3034
![](/gdevelop5/all-features/firebase/bandicam_2020-05-07_17-27-51-338.jpg)
3135

3236
Type any name you want again and untick "Set-Up Firebase Hosting".
3337

3438
!!! note
3539

36-
At the time of writing, there is no support for Firebase Hosting but it may be added to GDevelop later.
40+
GDevelop has no built-in integration to publish to Firebase Hosting. Try our integrated, in-house [gd.games](https://gd.games) hosting platform instead!
3741

38-
Firebase will now show you some code known as the firebase SDK that you would use if you were coding a website (we won't need everything).
42+
Firebase will now show you code to initialize the Firebase integration:
3943

4044
![](/gdevelop5/all-features/firebase/fb1.png)
4145

42-
You only need the Firebase configuration part. Copy-paste the part between the {} including the {}. For example, in this screenshot what we need to copy is: ```
46+
You only need the Firebase configuration. Copy-paste the part between the `{}`, including the `{}`, and excluding the semi-colon. For example, in this screenshot what we need to copy is:
47+
48+
```
4349
4450
{
4551
apiKey: "AIzaSyCbFhG_bCyAvnxlmVSgIgn7Em0XOYE9YXA",
@@ -54,7 +60,7 @@ You only need the Firebase configuration part. Copy-paste the part between the {
5460
5561
```
5662

57-
Now open the GDevelop project you want to integrate Firebase to, and go to the project properties. In the "Firebase Configuration" field, paste the configuration you copied. However, the format used by GDevelop is stricter than the code provided by Firebase. You need to wrap all the key names with quotes. The example would become:
63+
Now open the GDevelop project you want to integrate Firebase to, and go to the project properties. In the "Firebase Configuration" field, paste the configuration you copied. However, GDevelop only accepts the configuration in JSON format. You will need to wrap all the key names with quotes. Make sure you do not include a comma after the last key-value pair. The example would become:
5864

5965
```
6066
@@ -69,6 +75,8 @@ Now open the GDevelop project you want to integrate Firebase to, and go to the p
6975
"measurementId": "G-R0KBN0HPQ8"
7076
}
7177
72-
``` ![](/gdevelop5/all-features/firebase/quickstart6.png)
78+
```
79+
80+
![](/gdevelop5/all-features/firebase/quickstart6.png)
7381

7482
You can now start using [Firebase services](/gdevelop5/all-features/firebase).

0 commit comments

Comments
 (0)