Configuración de la autenticación de PlayFab con Kongregate y Unity

Este tutorial muestra la configuración mínima necesaria para autenticar a los jugadores en PlayFab mediante Kongregate y Unity.

Requisitos

Una cuenta registrada de Kongregate.
Familiaridad con la Guía para desarrolladores de Kongregate.
Un título de PlayFab registrado.
Un proyecto de Unity con PlayFab configurado para el título.
Compatibilidad con Unity WebGL instalada.
Familiaridad con Conceptos básicos de inicio de sesión y procedimientos recomendados.

Configuración de una aplicación de Kongregate

Kongregate requiere que cargue una versión preliminar de la aplicación antes de obtener acceso a la información necesaria de la aplicación. Nuestro primer paso es preparar un archivo index.html con el contenido que se muestra a continuación.

<!doctype html>
<html lang="en-us">
<head></head>
<body>
 <h1>Placeholder</h1>
</body>
</html>

Vaya al sitio web de Kongregate.

Seleccione la pestaña Games.
Después, seleccione el botón Upload your game.

Se abrirá una página para configurar una nueva aplicación.

Asegúrese de escribir el Application Name.
Escriba una Game Description.
Después, seleccione una Category.
Envíe la nueva aplicación seleccionando el botón Continue.

Se le transferirá a la página Application Upload. En primer lugar (y esto es lo más importante), asegúrese de guardar la dirección URL de la barra de direcciones web en un lugar seguro y de fácil acceso. Esto le ahorrará mucho tiempo al restaurar el acceso a la aplicación una vez que cierre la página.

Una vez hecho esto, seleccione el archivo index.html preparado como Game File.
Después, configure el tamaño de la pantalla.
Asegúrese de aceptar todas las licencias necesarias.
Por último, cargue la aplicación seleccionando el botón Upload.

Cuando se abra la vista previa, ignore el contenido y abra el vínculo api information. Cuando se abra la página API Information, busque la API Key y guárdela en un lugar seguro y de fácil acceso para su uso posterior.

Configuración del título de PlayFab

En Game Manager del título de PlayFab:

Seleccione Add-ons en el menú de la izquierda.
Busque y seleccione el icono de Kongregate.

Se abrirá una nueva página que le permitirá configurar la integración con Kongregate:

Escriba la API Key que adquirió en la sección anterior.
Seleccione el botón Install Kongregate.

En este momento, si no recibe ningún mensaje de error, habrá configurado correctamente la integración del título de PlayFab con la aplicación de Kongregate.

Configuración de un proyecto de Unity

Use esta lista de comprobación de configuración de Unity:

[OPCIONAL] Instale las extensiones del editor de PlayFab.
- Configure TitleId en el objeto Scriptable Object PlayFabSharedSettings.
Para Unity 5.6+, descargue la plantilla WebGL de Kongregate Preloader y colóquela dentro de la carpeta Assets/WebGLTemplates (2).
Para Unity < 5.6, descargue la plantilla WebGL de Kongregate Preloader para 5.5 e inferiores y colóquela dentro de la carpeta Assets/WebGLTemplates (2).

Ahora vamos a crear la escena de trabajo.

Con fines de prueba, use un lienzo con escalado de pantalla con un par de etiquetas de texto.

Solo necesitaremos una etiqueta de texto para mostrar mensajes de depuración.

Cree un GameObject vacío y cámbiele el nombre a Kongregate.

Este GameObject contendrá un componente KongregateHandler con una etiqueta de texto conectada para los mensajes de depuración. El código del componente KongregateHandler se proporciona a continuación.

// We are specifically interested in importing PlayFab related namespaces
using PlayFab;
using PlayFab.ClientModels;
using UnityEngine;
using UnityEngine.UI;

public class KongregateHandler : MonoBehaviour
{
  
    // Standard unity callback, executed once for the script to start
    public void Start()
    {
        // Utility: show feedback
        SetMessage("Loading kongregate api...");

        /*
         * Important: execute Javascript in the external context to initialize
         * Kongregate API, Unity Support and set up callback GameObject and Method.
         * In this case, callback is set to a GameObject called Kongregate and a
         * method called OnKongregateAPILoaded, which we define later in this class.
         * Once Kongregate API is initialized, Unity will locate this object by name
         * ("Kongregate") and execute a method "OnKongregateAPILoaded" passing in user
         * info string as an argument.
         */
        Application.ExternalEval(
          "if(typeof(kongregateUnitySupport) != 'undefined'){" +
          " kongregateUnitySupport.initAPI('Kongregate', 'OnKongregateAPILoaded');" +
          "} else {" +
          " console.error('No unity support!');" +
          "};"
        );
    }

    /*
     * Executed once Kongregate API is ready. This method is invoked by KongregateAPI
     * and receives a structured text with multiple pieces of data you must parse manually.
     * The userInfo string parameter has the following structure: 'user_identifier|user_name|auth_token'
     */
    public void OnKongregateAPILoaded(string userInfo)
    {
        SetMessage("Received user info! Logging though playfab...");

        // We split userInfo string using '|' character to acquire auth token and Kongregate ID.
        var userInfoArray = userInfo.Split('|');
        var authTicket = userInfoArray[2];
        var kongregateId = userInfoArray[0];

        LogToBrowser("Auth Token: " + authTicket);
        LogToBrowser("Kongregate Id: " + kongregateId);

        /*
         * We then execute PlayFab API call called LoginWithKongregate.
         * LoginWithKongregate requires KongregateID and AuthTicket.
         * We also pass CreateAccount flag, to automatically create player account.
         */
        PlayFabClientAPI.LoginWithKongregate(new LoginWithKongregateRequest
        {
            KongregateId = kongregateId,
            AuthTicket = authTicket,
            CreateAccount = true
        }, OnLoggedIn, OnFailed);
    }

    /*
     * The rest of the code serves as a utility to process results, log debug statements
     * and display them using Text message label.
     */

    private void OnLoggedIn(LoginResult obj)
    {
        SetMessage("Logged in through PlayFab!");
    }
    private void OnFailed(PlayFabError error)
    {
        SetMessage("Failed to login in with PlayFab: " + error.GenerateErrorReport());
    }

    private void SetMessage(string message)
    {
        InfoLabel.text = message;
    }

    private void LogToBrowser(string message)
    {
        Application.ExternalEval(string.Format("console.log('{0}')", message));
    }

    public Text InfoLabel;
}

Pruebas

La única manera de probar realmente la integración es cargar el prototipo en Kongregate.

Abra la ventana Build y asegúrese de que WebGL esté seleccionado en el menú.
Después, abra Player Settings seleccionando el botón.

Dentro de la pantalla Player Settings, busque la compilación Settings for WebGL:

Compruebe que el tamaño esté configurado correctamente.
Después, seleccione Kongregate Preloader Template.

Compile la aplicación y abra la carpeta Build.

Obtendrá un archivo index.html y un conjunto de otros archivos (según la versión de Unity).
Tome todos los archivos excepto index.html y colóquelos dentro de un archivo zip, como se muestra en el ejemplo que se proporciona a continuación.

Use la dirección URL que guardó anteriormente para acceder a la página Application Upload.

Seleccione index.html como Game File.
Después, seleccione el archivo zip como Additional files.
- Acepte las licencias y cargue.

Cuando se abra la vista previa, debería poder ver el juego en directo a medida que cambia el mensaje. Al finalizar, el mensaje debería indicar que el inicio de sesión a través de PlayFab se realizó correctamente. En este momento, habrá integrado correctamente PlayFab y Kongregate.

​Requisitos

​Configuración de una aplicación de Kongregate

​Configuración del título de PlayFab

​Configuración de un proyecto de Unity

​Pruebas

Requisitos

Configuración de una aplicación de Kongregate

Configuración del título de PlayFab

Configuración de un proyecto de Unity

Pruebas