GodotFacebookAuth

Plugin for authorization with Facebook for Godot Game Engine (iOS)

• Supports iOS deployment target >= 10.0
• Supports Godot version >= 3.3
• FacebookSDK 12.0.2
• Supports simulator

Installation

1. Download Plugin for your version of Godot, unzip and copy files to your Godot project's res://ios/plugins/godot_facebook_auth directory.

2. You can find and activate plugin by going to Project -> Export... -> iOS and in the Options tab, scrolling to the Plugins section.

   

3. After exporting, you must configure an Info.plist file with an XML snippet that contains data about your app.

• Right-click Info.plist, and choose Open As ▸ Source Code.

  

• Copy and paste the following XML snippet into the body of your file ( <dict>...</dict>).

  

• XML snippet

<key>CFBundleURLTypes</key>
<array>
  <dict>
  <key>CFBundleURLSchemes</key>
  <array>
    <string>fbAPP-ID</string>
  </array>
  </dict>
</array>
<key>FacebookAppID</key>
<string>APP-ID</string>
<key>FacebookClientToken</key>
<string>CLIENT-TOKEN</string>
<key>FacebookDisplayName</key>
<string>APP-NAME</string>

<key>LSApplicationQueriesSchemes</key>
<array>
  <string>fbapi</string>
  <string>fbauth</string>
  <string>fbauth2</string>
</array>

1. In <array><string> in the key [CFBundleURLSchemes], replace APP-ID with your App ID.
2. In <string> in the key FacebookAppID, replace APP-ID with your App ID.
3. In <string> in the key FacebookClientToken, replace CLIENT-TOKEN with the value found under Settings > Advanced > Client Token in your App Dashboard.
4. In <string> in the key FacebookDisplayName, replace APP-NAME with the name of your app.

Description

• Methods

# Check the status of authentication
credential() -> void
# Sign in with facebook
sign_in() -> void
# Sign out with facebook
sign_out() -> void

• Signals

credential(result: Dictionary)
authorization(result: Dictionary)

Samples and Example Usage

• Initialization

var godot_facebook_auth: Object

func _ready():
	if Engine.has_singleton("GodotFacebookAuth"):
		godot_facebook_auth = Engine.get_singleton("GodotFacebookAuth")
		godot_facebook_auth.connect("credential", self, "_on_credential")
		godot_facebook_auth.connect("authorization", self, "_on_authorization")

• Checking credential status

# 1. Call the method anywhere in the code
godot_facebook_auth.credential()
# 2. Wait for the answer in the method below
func _on_credential(result: Dictionary):
	if result.has("error"):
		print(result.error)
	else:
		print(result.state)
		# "authorized" <- user ID is in good state
		# "not_found" <- user ID was not found
		# "revoked" <- user ID was revoked by the user

• Sign In

# 1. Call the method anywhere in the code
godot_facebook_auth.sign_in()
# 2. Wait for the answer in the method below
func _on_authorization(result: Dictionary):
	if result.has("error"):
		print(result.error)
	else:
		# Required
		print(result.token)
		print(result.user_id)
		# Optional (can be empty)
		print(result.email)
		print(result.name)

• Sign Out

# Call the method anywhere in the code
godot_facebook_auth.sign_out()

Build from Source

• Just run scripts/build.sh -v 3.3.4 where -v is desired Godot version

  You will find the ready-to-use archive with the plugin in the bin directory.

Created by Oleksandr Kurtsev (Copyright © 2021) LICENSE