Ctrlk
HomeGeneral Info
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Facebook account setup

This guide describes the Facebook and leaderboard setup for the current HomeDesignMatch3Kit project.

The original Candy Smith guide uses the spelling Leadboard and describes a legacy Gamesparks/PlayFab flow. The original Facebook sequence is preserved below, while project-specific notes explain the current Unity Gaming Services (UGS) setup.

Source guide: How to setup Facebook and Leadboard.

The screenshots below are taken from the source guide. Meta and Unity may move controls or rename labels in newer dashboard and editor versions.

What is configured

  • Facebook Login through the Facebook Unity SDK.

  • Facebook as an identity provider in Unity Authentication.

  • A UGS leaderboard that stores the player's current level.

  • Cloud Code scripts for gifts and Facebook-to-Unity player mapping.

  • Optional Facebook friends access through the user_friends permission.

Prerequisites

Before starting, prepare the following:

  • A Meta developer account: Meta for Developers.

  • A Meta app registered for the game, or access to an existing Meta app for this game.

  • The Android package name and iOS Bundle ID from Unity Player Settings.

  • Access to the Unity organization and UGS project that will be used by the game.

  • A debug or release keystore and its Android key hash.

  • Test Facebook accounts. Do not use fake accounts; add real test users or app-role accounts in the Meta dashboard.

1

Link the Unity project

  1. Open the project in Unity 6000.0.80f1 or a compatible Unity version.

  2. Sign in to the Unity Editor.

  3. Open HomeDesignMatch3Kit > Settings > Setup Wizard.

  4. In step 1, open Project Services and link the project to the correct Unity organization and UGS project.

  5. Select the environment used for development or release.

The leaderboard and Cloud Code resources are created in the selected environment. Selecting a different environment later does not copy resources between environments.

2

Create and configure the Meta app

Open the Meta Developer Dashboard, open My Apps, and click Create App.

Create the app

  1. Enter the game name.

  2. Select the use case Authenticate and request data from users with Facebook Login. The wording may be shortened to Authenticate and request data from users in the current dashboard.

  3. At the Business step, select the business connected to the game or continue without connecting a business.

  4. Finish creating the app and open its dashboard.

Meta Developer Dashboard
Meta app creation form

Basic app settings

  1. Open App settings > Basic.

  2. Set the Category, Sub-category, and App icon when those fields are shown.

  3. Save the changes.

  4. Copy the numeric App ID.

  5. Copy the Client Token from the security section in Settings > Advanced.

  6. Keep the App Secret private. It is required to configure Unity Authentication, but it must not be committed to the repository or stored in LeaderboardSettings.asset.

Meta app basic settings

Android platform

Add an Android platform to the Meta app:

  1. Set the package name to the exact value from Project Settings > Player > Android > Package Name.

  2. Set the Unity deep-linking activity class to com.facebook.unity.FBUnityDeepLinkingActivity if the dashboard asks for it.

  3. Enable Single Sign On and Deep Linking when those options are available.

  4. Add every key hash used to sign the app, including separate debug and release hashes.

  5. Save the platform settings.

Add a platform in Meta
Select Android or iOS
Meta Android platform settings

The package name, signing key, and Facebook App ID must belong to the same build. A key hash from a debug keystore will not authenticate a release-signed APK.

iOS platform

Add an iOS platform and set its Bundle ID to the exact value from Project Settings > Player > iOS > Bundle Identifier.

If the dashboard asks for an App Store ID or other store metadata, use the values belonging to the final iOS app. Save the platform settings.

Before publishing the app, provide a valid privacy policy URL and complete the app's required verification and review steps.

Facebook Login OAuth settings

In Settings > Advanced, enable Native or desktop app when the option is available. Keep the app in development mode while testing; switch it to Live/public only after the required review and verification steps are complete.

Native app setting
Meta Client Token
3

Install and configure the Facebook SDK in Unity

The setup wizard can install the Facebook Unity SDK used by this project.

The original guide describes a manual SDK flow: download the Facebook Unity SDK package, open the .unitypackage, and click Import. Use that flow only if the setup wizard cannot install the SDK; do not import a second SDK copy.

Facebook SDK package menu
Facebook SDK import dialog

  1. Return to HomeDesignMatch3Kit > Settings > Setup Wizard.

  2. Open step 4, Set up Facebook.

  3. Click Install Facebook SDK if the SDK is not installed.

  4. Enter the Meta App ID and Client Token in the Facebook SDK Settings section.

  5. Enter the App Secret only in the password field used by Configure Facebook Automatically.

  6. Click Configure Facebook Automatically.

  7. Click Regenerate Android Manifest if the wizard did not regenerate it successfully.

Unity Facebook SDK settings

The original guide also shows the App ID copied from Meta into the Unity Facebook settings:

App ID in Unity Facebook settings

The wizard synchronizes the App ID and Client Token with Assets/FacebookSDK/SDK/Resources/FacebookSettings.asset, configures iOS stripping, regenerates the Android manifest, and registers or updates the Facebook identity provider in Unity Authentication. The App Secret is used for the setup operation and is not saved in the project.

Generated Android manifest with Facebook activities

Do not import a second copy of the Facebook SDK. Duplicate SDK assemblies can produce errors such as Facebook.Unity.Settings being imported more than once.

4

Configure the UGS leaderboard

  1. In the setup wizard, open step 5, Configure the leaderboard.

  2. Set the leaderboard ID. The default value is global_leaderboard.

  3. Set Score Fetch Limit and Opponent Count as required by the UI.

  4. Click Save Settings.

  5. Click Configure Leaderboard.

The provisioner creates the leaderboard in the selected environment with descending sort order and Keep Best update behavior. Running the action again reuses an existing leaderboard with the same ID.

The settings asset is stored at:

The runtime submits the player's current level and reads scores through Unity Leaderboards. The current popup displays UGS leaderboard entries; it is not the legacy Gamesparks friend leaderboard.

Facebook provider in Unity Authentication
5

Enable Cloud Save and upload Cloud Code

  1. In the selected UGS environment, open Cloud Save and enable it.

  2. Return to the setup wizard.

  3. Open step 6, Upload and publish Cloud Code.

  4. Click Upload Cloud Code.

The action creates or updates and publishes the included scripts for gifts and Facebook player mapping. The facebookPlayerMappings collection is created automatically after the first successful Facebook sign-in.

If the game uses Facebook friends, complete the separate user_friends permission setup before testing that flow.

6

Optional Meta App Center setup

The original guide includes Dashboard > App Center > Set up. Add the game's screenshots and description there if the game should be represented in Meta's App Center.

Meta App Center setup
7

Test the integration

Use a device build rather than relying only on the Unity Editor:

  1. Build with the same Android package name or iOS Bundle ID configured in Meta.

  2. Install the build on a test device.

  3. Open the Settings popup and tap the Facebook button.

  4. Complete Facebook Login with an allowed test account.

  5. Open the leaderboard and finish at least one level so a score can be submitted.

  6. Confirm that the login completes, the UGS player is authenticated, and the score appears in the selected leaderboard.

  7. If friends functionality is enabled, test it with two Facebook accounts that both use the app.

For Unity Editor testing, the Facebook SDK uses its Mock Login Dialog and expects a valid Facebook user access token. An App ID, Client Token, or App Secret is not a user access token.

The original guide also includes a video tutorial and Unity test. Use a device build and the navigation that exists in the submitted version of this project.

8

Legacy backend note

The source guide links to a paid PlayFab setup guide for its leaderboard, friends-on-map, and player-cloud-store flow. This project uses UGS instead, so the PlayFab/Gamesparks setup is not required for the current build.

Next steps

  • Request the user_friends permission

  • Facebook and leaderboard troubleshooting

Last updated