1. License. 2. Introduction. a. Read Leaderboard b. Write and Flush Leaderboards Custom widgets, 3D widgets and VR mode...

Transcription

1

2 Contents 1. License Introduction Plugin updates... 5 a. Update from previous versions to Example project GitHub Repository Getting started Plugin usage... 9 a. Blueprint implementation... 9 b. C++ implementation Identity a. Login and Logout b. Requesting permissions Users a. Query Users b. Download User Avatar Friends a. Query Friends b. Invite Friends Simple c. Invite Friends with prefill and custom dialog d. App Invites Share a. Share Post b. Share Image c. Share Link Content d. Share Photo Content e. Open Graph Story Achievements a. Write Achievement b. Query Achievements Leaderboards... 28

3 a. Read Leaderboard b. Write and Flush Leaderboards Custom widgets, 3D widgets and VR mode License Copyright 2018 gamedna Ltd. All rights reserved. gamedna Ltd grants you a non-exclusive, non-transferable, non-sublicensable license for a single User to use, reproduce, display, perform, and modify the Extended Facebook Online Subsystem for Unreal Engine 4 for any lawful purpose (the "License"). The License becomes effective on the date you buy Extended Facebook Online Subsystem for Unreal Engine 4. The License does not grant you any title or ownership in the Licensed Technology. You may Distribute the Extended Facebook Online Subsystem for Unreal Engine 4 incorporated in object code format only as an inseparable part of a Product to end users. The Product may not contain any Plugin Content in uncooked source format. Unreal is a trademark or registered trademark of Epic Games, Inc. in the United States of America and elsewhere. Unreal Engine, Copyright , Epic Games, Inc. All rights reserved. Facebook is a trademark of Facebook, Inc. 2. Introduction Extended Facebook Online Subsystem is a plugin for Unreal Engine 4 that integrates the Facebook social network for all platforms (using embedded UMG widget) and ios & Android (using native Facebook SDK). It implements Online Subsystem so you can use available features exposed by this and/or special functions and Blueprints nodes designed only for Facebook. Extended Facebook Online Subsystem plugin helps you creating social and interactive games by integrating features from Facebook for Games. Use this plugin to drive more installs and further engage players in your awesome game! Native implementation guarantees seamless integration and the best user experience. Embedded UMG widget implementation makes plugin available for all platforms. Required Unreal Engine 4.10 or above because of Android Plugin support! Current plugin version: Support: support@gamednastudio.com

4 FEATURES: Native implementation means native features provided by Facebook SDK for ios & Android (for example native platform dialogs). Embedded UMG widget implementation makes plugin available for all platforms. Supports 3D widgets for VR. It exposes simple but powerful API. No more HTTP requests or JSON parsing! Implements Unreal Engine Online Subsystem. All features are exposed to Blueprints. Out of the box for all platforms. No additional libraries are needed! Works with Blueprint-only & source code projects. Works with Launcher & GitHub UE4 versions. Facebook login and logout. Requesting new publish permissions. Requesting new read permissions. Getting Facebook users information. Getting users avatars. Getting list of all friends playing your game. Getting list of all friends not playing your game in order to invite. Inviting friends with Game Request. Inviting friends with AppInvite (without login requirement). Reading and writing Facebook Achievements. Reading and writing Facebook Leaderboards. Sharing post on the timeline (in the background without dialog). Sharing image on the timeline (in the background without dialog). Sharing image on the timeline via dialog (without login requirement). Sharing link on the timeline via dialog (without login requirement). Posting Open Graph story. WHAT YOU GET: All needed files and SDKs Full source code available on GitHub private repo! Compatible with ios & Android (all-in-one) Supports gamedna installer. No more downloading SDKs and creating packages on your own! Easy plugin setup All future updates are included Support via

5 3. Plugin updates a. Update from previous versions to Delete all files under Plugins/ExtendedFacebook directory and install plugin again.

6 4. Example project You can download example project at the following address: 5. GitHub Repository Please the receipt of this plugin's purchase to for access to the GitHub repository used to develop this plugin!

7 6. Getting started 1. Before using this plugin you should have basic knowledge about Facebook apps development so go to study some initial tutorials and create a new Facebook application. 2. Unpack the plugin archive to Plugins folder in your UE4 project folder (for project plugins) or Engine/Plugins/Marketplace (for engine plugins) and start the editor. 3. Enable Extended Facebook in Edit -> Plugins -> Online -> Extended Facebook. 4. Download gamedna installer plugin from the releases tab on the official GitHub repository Install plugin and SDKs as described in the included documentation.

8 5. Platforms other than mobile configuration (Web Browser mode): a) Go to Facebook Dashboard -> Your Game -> Facebook Login -> Settings. b) Copy link: and paste to the field called Valid OAuth redirect URIs. 6. Go to Project Settings -> Plugins -> Extended Facebook and configure Facebook settings. If you want to use Extended Facebook for VR on Android or ios you should enable Force Web Browser Mode.

9 7. Plugin usage a. Blueprint implementation In Blueprints you can use all awesome nodes specially designed for Facebook. It covers all functionality provided by this plugin.

10 b. C++ implementation Add the following line to your *.Build.cs file private dependency module name: PrivateDependencyModuleNames.AddRange(new string[] { "OnlineSubsystemExtendedFacebook" }); Now you can use standard UE4 Online Subsystem 1 but it s highly recommended to use special functions provided by this plugin because basic Online Subsystem is very raw and complicated. In this plugin exists two types of functions: Async Tasks (need delegates for handle callbacks) and Blueprint Library. Example of calling Blueprint Library: #include "OnlineSubsystemExtendedFacebookBlueprintLibrary.h" bool IsLogged = UOnlineSubsystemExtendedFacebookBlueprintLibrary::CheckIfPlayerLoggedIn( ); Example of calling Async Task: #include "Utils/Identity/FacebookLogin.h" UFacebookLogin* FacebookLoginObject = UFacebookLogin::FacebookLogin(); FacebookLoginObject->OnSuccess.AddDynamic(this, &UClassName::SuccessCallback) FacebookLoginObject->OnFail.AddDynamic(this, &UClassName::FailCallback) FacebookLoginObject->Activate(); 1

11 8. Identity Related Facebook documentation about login: Guide about permissions: Guide about Access Token: Guide about Login Review: a. Login and Logout Facebook Login is a fast and convenient way for people to create accounts and log into your game across multiple platforms. You can simply place Blueprint nodes Facebook Login or Facebook Logout for login/logout behavior (and that's all!). After successfully login you can immediately get Access Token, User ID and Username. CheckIfFacebookPlayerLoggedIn is useful when you want to check if player is connected to Facebook and if Access Token is valid. Login

12 Sample Facebook Login native dialog: Logout

13 b. Requesting permissions Sometimes you need to request additional permissions so FacebookRequestNewPublishPermissions and FacebookRequestNewReadPermissions can be helpful for that. In plugin settings you can set default read permissions which are requested during first Facebook login. Permissions should be comma separated. Read Permissions Sample Facebook Request Read Permissions native dialog:

14 Publish Permissions Sample Facebook Request Publish Permissions native dialog:

15 9. Users Permissions reference: a. Query Users You can query any Facebook user but depends on user permissions and relationships it returns different results. For example for query user birthday info it requires user_birthday permission and for query it requires permission. If user haven t granted these permissions, result for the corresponding parameters will be empty.

16 b. Download User Avatar If you queried Facebook User, you can get Cached Facebook User Info, retrieve Avatar URL and then Download Image based on URL.

17 10. Friends Related Facebook documentation to inviting friends: Related Facebook documentation to App Invite: a. Query Friends Required permissions: user_friends You can query friends who already play your game and get Facebook ID, Name and Avatar URL. b. Invite Friends Simple Required permissions: user_friends You can simply show native invitation Facebook dialog and user can select friends to invite to your game.

18 Sample simple native invitation Facebook dialog: c. Invite Friends with prefill and custom dialog Required permissions: user_friends You can query friends who haven't installed your game yet and make custom invitation dialog. Then user can select friends to invite to your game and provide Facebook User IDs to FacebookInviteFriends function.

19 Sample custom invitation Facebook dialog:

20 d. App Invites [It works only on ios & Android] App Invites allows to invite friends without Facebook login and requesting permissions! What means App Link URL and Preview Image URL you can find in Facebook documentation: Sample App Invites Dialog:

21 11. Share Related Facebook documentation to sharing: a. Share Post Required permissions: publish_actions Share Post allows to share post in the background without showing Facebook dialog. You need to send your game to App Review. Sample Share Post result on Facebook timeline:

22 b. Share Image Required permissions: publish_actions Share Image allows to share image in the background without showing Facebook dialog. You need to send your game to App Review. Sample Share Image result on Facebook timeline:

23 c. Share Link Content [It works only on ios & Android] Share Link Content allows to share post with link without Facebook login and requesting permissions! Sample Share Link Content Dialog:

24 d. Share Photo Content [It works only on ios & Android] Share Photo Content allows to share image without Facebook login and requesting permissions! Sample Share Photo Content Dialog:

25 e. Open Graph Story Related Facebook documentation to Open Graph stories: Required permissions: publish_actions You can post custom Open Graph story. Firstly, you should read Facebook documentation about Open Graph stories and then create your own story on Facebook dashboard. FacebookOpenGraphPost requires Graph Path and Open Graph parameters. Sample Open Graph story posted on Facebook timeline:

26 12. Achievements Related Facebook documentation: a. Write Achievement Required permissions: publish_actions WriteAchievement lets unlock player achievement and post it to user s timeline. Sample achievement unlocked post on Facebook timeline:

27 b. Query Achievements Required permissions: publish_actions

28 13. Leaderboards Related Facebook documentation: a. Read Leaderboard Required permissions: publish_actions b. Write and Flush Leaderboards Required permissions: publish_actions

29 14. Custom widgets, 3D widgets and VR mode Plugin provides functionality for 3D widgets (also in VR mode) and loading Facebook dialog in another widget than main viewport. It is intended for all platforms except mobile. You should simply pass reference of Canvas Panel in your widget (2D or 3D) to Change Facebook Active Widget node and from this moment all Facebook dialogs will be displayed in this Canvas Panel. You can have only one active widget for Facebook. That s all!