-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
https://api.playfab.com/releaseNotes/#170109
- Loading branch information
Showing
17 changed files
with
339 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| Corona Getting Started Guide | ||
| ---- | ||
|
|
||
| Corona Project Setup | ||
| ---- | ||
|
|
||
| * OS: This guide is written for Windows 10, however it should also work fine with a Mac | ||
| * Download Corona Engine | ||
| * Download and install Corona | ||
| * https://coronalabs.com/ | ||
| * Run Corona, and create a new project | ||
| * This guide will help you through the first-time steps if you haven't already done them: | ||
| * https://docs.coronalabs.com/guide/start/installWin/index.html | ||
| * Once you've installed, logged in, and created a new project, you should see several windows that look something like this: | ||
| *  | ||
| * Activate the PlayFab Client plugin on the Corona Marketplace | ||
| * https://marketplace.coronalabs.com/plugin/playfab-client | ||
| * PlayFab installation complete! | ||
|
|
||
| Set up your first API call | ||
| ---- | ||
|
|
||
| This guide will provide the minimum steps make your first PlayFab API call. Confirmation will be visible in the Corona Engine output log. | ||
|
|
||
| In your favorite text-editor, ADD the following lines to build.settings: | ||
|
|
||
| ```LUA | ||
| settings = | ||
| { | ||
| -- ADD THESE THREE LINES at the top, leave everything else as-is | ||
| plugins = { | ||
| ["plugin.playfab.client"] = { publisherId = "com.playfab" } | ||
| }, | ||
|
|
||
| -- Other existing lines... | ||
| } | ||
| ``` | ||
|
|
||
| In your favorite text-editor, REPLACE the contents of main.lua file with this: | ||
|
|
||
| ```Lua | ||
| local pfClient = require("plugin.playfab.client") | ||
| local PlayFabClientApi = pfClient.PlayFabClientApi | ||
| PlayFabClientApi.settings.titleId = "144" | ||
|
|
||
| local loginRequest = { | ||
| -- https://api.playfab.com/Documentation/Client/method/LoginWithCustomID | ||
| CustomId = "GettingStartedGuide", | ||
| CreateAccount = true | ||
| } | ||
| PlayFabClientApi.LoginWithCustomID(loginRequest, | ||
| function(result) print("Congratulations, you made your first successful API call!") end, | ||
| function(error) print("Something went wrong with your first API call.\nHere's some debug information:\n" .. error.errorMessage) end | ||
| ) | ||
| ``` | ||
|
|
||
|
|
||
| Finish and Execute | ||
| ---- | ||
|
|
||
| * Corona automatically executes the project source immediately when you save. So as soon as you update and save these two files, you should see this: | ||
| *  | ||
| * At this point, you can start making other api calls, and building your game | ||
| * For a list of all available client API calls, see our documentation: | ||
| * https://api.playfab.com/ | ||
| * Happy coding! | ||
|
|
||
| Deconstruct the code | ||
| ---- | ||
|
|
||
| This optional last section describes each part of our example above, line by line. | ||
|
|
||
| * build.settings | ||
| * plugins = { | ||
| * This invokes the Corona plugin system, and tells it to download and install Corona Marketplace plugins in your project | ||
| * ["plugin.playfab.client"] = { publisherId = "com.playfab" } | ||
| * This tells it to download the PlayFab Client plugin specifically | ||
| * main.lua | ||
| * require() lines: | ||
| * This is the minimal imports you need to make PlayFab API calls | ||
| * PlayFabClientApi.settings.titleId = "xxxx" | ||
| * Every PlayFab developer creates a title in Game Manager. When you publish your game, you must code that titleId into your game. This lets the client know how to access the correct data within PlayFab. For most users, just consider it a mandatory step that makes PlayFab work. | ||
| * local loginRequest = { CustomId = "GettingStartedGuide", CreateAccount = true } | ||
| * Most PlayFab API methods require input parameters, and those input parameters are packed into a request object | ||
| * Every API method requires a unique request object, with a mix of optional and mandatory parameters | ||
| * For LoginWithCustomIDRequest, there is a mandatory parameter of CustomId, which uniquely identifies a player and CreateAccount, which allows the creation of a new account with this call | ||
| * PlayFabClientApi.LoginWithCustomID(loginRequest, {OnLoginSuccess-function}, {OnLoginError-function}) | ||
| * This begins the async request to "LoginWithCustomID", which will call the first (OnLoginSuccess) callback if successful, or the second (OnLoginError) function for failures | ||
| * For login, most developers will want to use a more appropriate login method | ||
| * See the [PlayFab Login Documentation](https://api.playfab.com/Documentation/Client#Authentication) for a list of all login methods, and input parameters. Common choices are: | ||
| * [LoginWithAndroidDeviceID](https://api.playfab.com/Documentation/Client/method/LoginWithAndroidDeviceID) | ||
| * [LoginWithIOSDeviceID](https://api.playfab.com/Documentation/Client/method/LoginWithIOSDeviceID) | ||
| * [LoginWithEmailAddress](https://api.playfab.com/Documentation/Client/method/LoginWithEmailAddress) | ||
| * OnLoginSuccess is any function which accepts a single parameter (result) | ||
| * The result object will contain the requested information, according to the API called | ||
| * LoginResult contains some basic information about the player, but for most users, login is simply a mandatory step before calling other APIs | ||
| * OnLoginError is any function which accepts a single parameter (error) | ||
| * API calls can fail for many reasons, and you should always attempt to handle failure | ||
| * Why API calls fail (In order of likelihood) | ||
| * PlayFabSettings.TitleId is not set. If you forget to set titleId to your title, then nothing will work. | ||
| * Request parameters. If you have not provided the correct or required information for a particular API call, then it will fail. See error.errorMessage, error.errorDetails, or error.GenerateErrorReport() for more info. | ||
| * Device connectivity issue. Cell-phones lose/regain connectivity constantly, and so any API call at any time can fail randomly, and then work immediately after. Going into a tunnel can disconnect you completely. | ||
| * PlayFab server issue. As with all software, there can be issues. See our [release notes](https://api.playfab.com/releaseNotes/) for updates. | ||
| * The internet is not 100% reliable. Sometimes the message is corrupted or fails to reach the PlayFab server. | ||
| * If you are having difficulty debugging an issue, and the information within the error information is not sufficient, please visit us on our [forums](https://community.playfab.com/index.html) |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,227 @@ | ||
| Defold Getting Started Guide | ||
| ---- | ||
|
|
||
| Defold Project Setup | ||
| ---- | ||
|
|
||
| * OS: This guide is written for Windows 10, however it should also work fine with a Mac | ||
| * Download Defold | ||
| * Create an account, or log in at http://www.defold.com/ (Uses Google O-Auth) | ||
| * Download and install Defold | ||
| * http://d.defold.com/stable/ | ||
| * Create a new project on the Defold Dashboard | ||
| * After logging in, you should find yourself at the Defold dashboard | ||
| * If you have not completed the Defold "Getting Started Tutorial", you should do that now | ||
| * Finally create a new project in the Defold web Dashboard | ||
| *  | ||
| * Run Defold, and load your new project | ||
| * You should see several windows that look something like this: | ||
| *  | ||
| * Update the Project Settings, and include PlayFab in the dependencies | ||
| * dependencies: https://github.com/PlayFab/LuaSdk/raw/master/Defold/PlayFabClientSdk.zip | ||
| *  | ||
| * Click: Project -> Fetch Libraries, and you should see a new builtin "PlayFab" folder: | ||
| *  | ||
| * Create a few files: | ||
| * main/PfGettingStarted.gui | ||
| * right-click "main" folder -> new -> Gui File -> PfGettingStarted.gui | ||
| * main/PfGettingStarted.gui_script | ||
| * right-click "main" folder -> new -> Gui Script File -> PfGettingStarted.gui_script | ||
| * Finally, hook up our new gui in the main.collection | ||
| * Double click main.collection to open it | ||
| * In the Outline panel: | ||
| * Right-Click, Add Game Object (Optionally rename to PfGui) | ||
| * Right-Click the new object, Add Component From File... | ||
| * PfGettingStarted.gui (Created above) | ||
| * The Outline panel viewing main.collection should look like this: | ||
| *  | ||
| * PlayFab installation complete | ||
| * This project isn't ready to build yet, but we'll fix that in the next step | ||
|
|
||
| Set up your first API call | ||
| ---- | ||
|
|
||
| This guide will provide the minimum steps make your first PlayFab API call. Confirmation will be visible in the game window. | ||
|
|
||
| * In the Defold editor, double-click PfGettingStarted.gui_script | ||
| * This should open the file for text editing | ||
| * Update the contents of PfGettingStarted.gui_script as follows: | ||
|
|
||
| ```Lua | ||
| local PlayFabClientApi = require("PlayFab.PlayFabClientApi") | ||
| local IPlayFabHttps = require("PlayFab.IPlayFabHttps") | ||
| local PlayFabHttps_Defold = require("PlayFab.PlayFabHttps_Defold") | ||
| IPlayFabHttps.SetHttp(PlayFabHttps_Defold) -- Assign the Defold-specific IHttps wrapper | ||
|
|
||
| PlayFabClientApi.settings.titleId = "144" -- Please change this value to your own titleId from PlayFab Game Manager | ||
|
|
||
| function init(self) | ||
| local loginRequest = { | ||
| -- https://api.playfab.com/Documentation/Client/method/LoginWithCustomID | ||
| TitleId = PlayFabClientApi.settings.titleId, | ||
| CustomId = "GettingStartedGuide", | ||
| CreateAccount = true | ||
| } | ||
| PlayFabClientApi.LoginWithCustomID(loginRequest, OnLoginSuccess, OnLoginFailed) | ||
| end | ||
|
|
||
| function OnLoginSuccess(result) | ||
| local pfTestOutput = gui.get_node("pfOutput") | ||
| gui.set_text(pfTestOutput, "Congratulations, you made your first successful API call!") | ||
| end | ||
|
|
||
| function OnLoginFailed(error) | ||
| local pfTestOutput = gui.get_node("pfOutput") | ||
| local message = "Something went wrong with your first API call.\n" | ||
| local message = message .. "Here's some debug information:\n" | ||
| local message = message .. error.errorMessage | ||
| gui.set_text(pfTestOutput, message) | ||
| end | ||
| ``` | ||
|
|
||
| * In the Defold editor, right-click PfGettingStarted.gui -> Open With -> Text Editor | ||
| * Unfortunately, this changes an internal setting in Defold, so: | ||
| * Open it again: right-click PfGettingStarted.gui -> Open With -> Gui Editor | ||
| * This resets the default back to normal | ||
| * Click the text-edit tab for PfGettingStarted.gui | ||
| * Update the text contents of PfGettingStarted.gui as follows: | ||
|
|
||
| ```text | ||
| script: "/main/PfGettingStarted.gui_script" | ||
| fonts { | ||
| name: "system_font" | ||
| font: "/builtins/fonts/system_font.font" | ||
| } | ||
| background_color { | ||
| x: 0.0 | ||
| y: 0.0 | ||
| z: 0.0 | ||
| w: 1.0 | ||
| } | ||
| nodes { | ||
| position { | ||
| x: 100.0 | ||
| y: 620.0 | ||
| z: 0.0 | ||
| w: 1.0 | ||
| } | ||
| rotation { | ||
| x: 0.0 | ||
| y: 0.0 | ||
| z: 0.0 | ||
| w: 1.0 | ||
| } | ||
| scale { | ||
| x: 1.0 | ||
| y: 1.0 | ||
| z: 1.0 | ||
| w: 1.0 | ||
| } | ||
| size { | ||
| x: 1080.0 | ||
| y: 520.0 | ||
| z: 0.0 | ||
| w: 1.0 | ||
| } | ||
| color { | ||
| x: 1.0 | ||
| y: 1.0 | ||
| z: 1.0 | ||
| w: 1.0 | ||
| } | ||
| type: TYPE_TEXT | ||
| blend_mode: BLEND_MODE_ADD | ||
| text: "Logging in..." | ||
| font: "system_font" | ||
| id: "pfOutput" | ||
| xanchor: XANCHOR_LEFT | ||
| yanchor: YANCHOR_TOP | ||
| pivot: PIVOT_NW | ||
| outline { | ||
| x: 1.0 | ||
| y: 1.0 | ||
| z: 1.0 | ||
| w: 1.0 | ||
| } | ||
| shadow { | ||
| x: 1.0 | ||
| y: 1.0 | ||
| z: 1.0 | ||
| w: 1.0 | ||
| } | ||
| adjust_mode: ADJUST_MODE_FIT | ||
| line_break: false | ||
| layer: "" | ||
| inherit_alpha: true | ||
| clipping_mode: CLIPPING_MODE_NONE | ||
| clipping_visible: true | ||
| clipping_inverted: false | ||
| alpha: 1.0 | ||
| outline_alpha: 1.0 | ||
| shadow_alpha: 1.0 | ||
| template_node_child: false | ||
| text_leading: 1.0 | ||
| text_tracking: 0.0 | ||
| size_mode: SIZE_MODE_AUTO | ||
| } | ||
| material: "/builtins/materials/gui.material" | ||
| adjust_reference: ADJUST_REFERENCE_PARENT | ||
| max_nodes: 512 | ||
| ``` | ||
|
|
||
| Finish and Execute | ||
| ---- | ||
|
|
||
| * Make sure everything is saved | ||
| * Click another tab, and look for " * " markers - sometimes Defold doesn't refresh | ||
| * Save everything | ||
| * Build your game | ||
| * Ctrl+b or dropdowns: Project -> Build and Launch | ||
| * You should see the following text on your screen: | ||
| * Congratulations, you made your first successful API call! | ||
| * At this point, you can start making other api calls, and building your game | ||
| * For a list of all available client API calls, see our documentation: | ||
| * https://api.playfab.com/ | ||
| * Happy coding! | ||
|
|
||
| Deconstruct the code | ||
| ---- | ||
|
|
||
| * PfGettingStarted.gui | ||
| * Our instructions for PfGettingStarted.gui are for expediency, not instruction. This file is a gui definition, which adds a text box to the screen, binds it to our other script: PfGettingStarted.gui_script. You would NOT typically edit these files in text-form. | ||
| * For proper instructions on how to build Defold GUI widgets, please read this guide: | ||
| * http://www.defold.com/manuals/gui/ | ||
| * PfGettingStarted.gui_script | ||
| * Require statements and setup | ||
| * PlayFabClientApi allows you to make Client API calls - This is why you're here | ||
| * IPlayFabHttps and PlayFabHttps_Defold: | ||
| * The PlayFab Defold plugins are built on the PlayFab LuaSdk. The Lua language does not have a proper HTTPS module. Each game-engine that uses Lua implements their own. These two variables tell PlayFabSdk how to access HTTPS. You only need to do this once in your project, in the first scene. Otherwise it's just required boilerplate | ||
| * PlayFabClientApi.settings.titleId = "144" | ||
| * Every project using PlayFab should create a unique title in the PlayFab website, which we call Game Manager. Find your titleId in game manager, and replace 144 with your titleId | ||
| * function init(self) | ||
| * Defold function - This is called when the gui is initialized | ||
| * local loginRequest = { TitleId = PlayFabClientApi.settings.titleId, CustomId = "GettingStartedGuide", CreateAccount = true } | ||
| * Most PlayFab API methods require input parameters, and those input parameters are packed into a request object | ||
| * Every API method requires a unique request object, with a mix of optional and mandatory parameters | ||
| * For LoginWithCustomIDRequest, there is a mandatory parameter of CustomId, which uniquely identifies a player and CreateAccount, which allows the creation of a new account with this call. | ||
| * For login, most developers will want to use a more appropriate login method | ||
| * See the [PlayFab Login Documentation](https://api.playfab.com/Documentation/Client#Authentication) for a list of all login methods, and input parameters. Common choices are: | ||
| * [LoginWithAndroidDeviceID](https://api.playfab.com/Documentation/Client/method/LoginWithAndroidDeviceID) | ||
| * [LoginWithIOSDeviceID](https://api.playfab.com/Documentation/Client/method/LoginWithIOSDeviceID) | ||
| * [LoginWithEmailAddress](https://api.playfab.com/Documentation/Client/method/LoginWithEmailAddress) | ||
| * PlayFabClientApi.LoginWithCustomID(loginRequest, OnLoginSuccess, OnLoginFailed) | ||
| * This performs the API call using the request, and provides callback functions for success and fail conditions | ||
| * function OnLoginSuccess(result) | ||
| * The result object of many API success callbacks will contain the requested information | ||
| * LoginResult contains some basic information about the player, but for most users, login is simply a mandatory step before calling other APIs. | ||
| * function OnLoginFailed(error) | ||
| * API calls can fail for many reasons, and you should always attempt to handle failure | ||
| * Why API calls fail (In order of likelihood) | ||
| * PlayFabSettings.TitleId is not set. If you forget to set titleId to your title, then nothing will work. | ||
| * Request parameters. If you have not provided the correct or required information for a particular API call, then it will fail. See error.errorMessage, error.errorDetails, or error.GenerateErrorReport() for more info. | ||
| * Device connectivity issue. Cell-phones lose/regain connectivity constantly, and so any API call at any time can fail randomly, and then work immediately after. Going into a tunnel can disconnect you completely. | ||
| * PlayFab server issue. As with all software, there can be issues. See our [release notes](https://api.playfab.com/releaseNotes/) for updates. | ||
| * The internet is not 100% reliable. Sometimes the message is corrupted or fails to reach the PlayFab server. | ||
| * If you are having difficulty debugging an issue, and the information within the error callback is not sufficient, please visit us on our [forums](https://community.playfab.com/index.html) | ||
| * local pfTestOutput = gui.get_node("pfOutput") | ||
| * This is another Defold gui function. It fetches the "pfOutput" gui object defined in our PfGettingStarted.gui file, and assigns it text to display to the user |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.