Implementación de compilaciones mediante PowerShell/API

Este artículo proporciona información general sobre cómo implementar o crear compilaciones para máquinas virtuales que usan Windows OS en PowerShell en un dispositivo de desarrollo con Windows 10. Al implementar una compilación mediante PowerShell/API, es probable que use una combinación de Game Manager y las API. Por ello, los comandos de PowerShell/API se enumeran a continuación por funcionalidad. Si es la primera vez que implementa una compilación, le recomendamos implementar una compilación con el ejemplo Wrapper, ya que incluye todos los recursos que necesita para implementar servidores.

Para poder usar y ver PlayFab Multiplayer Servers, debe habilitar la característica. Si es un usuario nuevo, le recomendamos usar el método de Game Manager para habilitar esta característica. Para obtener instrucciones, consulte Habilitar la característica PlayFab Server.

Obtención del identificador de título y la clave secreta de desarrollador

Obtenga su identificador de título de PlayFab
- Inicie sesión en su cuenta de desarrollador en PlayFab.com
- En Game Manager, vaya a la página My Studios and Titles. Busque su título de juego y obtenga el identificador de título de juego de PlayFab
Obtenga la clave secreta de desarrollador del título
- En Game Manager, seleccione su título > configuración (icono de engranaje)
- Seleccione Title settings y, después, seleccione la pestaña Secret Keys para obtener la clave secreta de desarrollador

Para más información sobre las claves secretas, consulte Administración de claves secretas.

Instalación del módulo de PowerShell PlayFab MultiplayerAPI

Abra Windows PowerShell como administrador
Si ha instalado anteriormente el módulo PlayFab Multiplayer PowerShell, desinstálelo con el siguiente comando. Este módulo está ahora en desuso.

Uninstall-Package PlayFabMultiplayer

Para ayudarle en la transición al nuevo módulo, consulte Asignación de comandos para encontrar los nuevos comandos equivalentes. Tenga en cuenta que tanto los comandos como los argumentos podrían ser diferentes.

Instale el nuevo módulo PlayFabMultiplayer API

Para obtener documentación detallada sobre cada comando, consulte la documentación de cmdlets.

Install-Module -Name PlayFabMultiplayerApi

Antes de instalar el módulo, es posible que primero deba establecer la directiva de ejecución ejecutando Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser en PowerShell. Para obtener más información, consulte Directivas de ejecución de PowerShell.

Obtenga más información sobre los cmdlets del módulo de PowerShell PlayFab Multiplayer ejecutando el siguiente comando. O puede consultar la documentación de referencia de cmdlets de PlayFabMultiplayerApi.

Get-Command -Module PlayFabMultiplayerApi | Get-Help

Obtención de un EntityToken para el título

Ejecute el siguiente comando con su identificador de título y la clave de desarrollador asociada. Debe ejecutar este comando al inicio de cualquier sesión cuando use el módulo de PowerShell PlayFabMultiplayerApi. Llama a la API GetEntityToken para obtener un EntityToken y lo almacena en una variable de entorno para su uso en cmdlets futuros.

Set-PfTitle -TitleID "mytitleID" -SecretKey "mysecretkey"

Habilitación de la característica de servidores multijugador para el título

Ejecute el cmdlet siguiente para habilitar las características de Multiplayer Servers. Llama a la API de habilitación de servidores multijugador.

Enable-PfMultiplayerServer

Si recibe un error que indica Title must have a valid payment instrument associated with it in order to enable Multiplayer Servers, consulte Habilitar PlayFab Multiplayer Servers mediante Game Manager para agregar su información de pago.

Carga de un recurso

Cargar un recurso es obligatorio cuando se implementa una compilación para servidores Windows. Esto se debe a que los recursos personalizan la imagen de contenedor Windows administrada. Sin embargo, es opcional al implementar una compilación para servidores Linux, ya que puede personalizar la imagen de contenedor Linux. Para obtener más información, consulte Creación e implementación de compilaciones de Linux. Ejecute este comando para cargar un recurso.

New-PfAsset -FilePath C:\MyAsset.zip -AssetName MyAsset.zip

donde:

Filepath: ruta al archivo local que quiere cargar
AssetName: nombre del recurso que se va a cargar

Para más detalles, consulte la documentación de referencia de New-PfAsset.

Creación de una compilación

Al crear una compilación para servidores Windows, debe haber cargado un recurso. Si no es así, consulte Carga de un recurso.
Al crear una compilación para servidores Linux, debe haber cargado su imagen de contenedor Linux personalizada en el registro de contenedores de PlayFab. Para obtener más información, consulte Creación e implementación de compilaciones de Linux.

Asegúrese de usar los valores correctos para $vmSize__ y __$ regions si planea aprovechar los recursos ofrecidos para la evaluación gratuita.

A continuación se muestra código de ejemplo para ayudar a implementar compilaciones para servidores de juegos Windows.

$vmSize = "Standard_D2as_v4"
$regions = @( @{ StandbyServers = 1; MaxServers = 1; Region = 'EastUS'; ScheduledStandbySettings = $NULL } )
$ports = @( @{ Name = 'tcp_port'; Num = 8080; Protocol = 'TCP' }, @{ Name = 'udp_port'; Num = 8081; Protocol = 'UDP' } )
$gameAssets = @( @{ FileName = 'MyAsset.zip'; MountPath = 'C:\Assets' } )

$buildResponse = New-PfBuild -BuildName ExampleBuild -ContainerFlavor ManagedWindowsServerCore -StartMultiplayerServerCommand 'C:\Assets\MyCustomServer.exe' -GameAssetReferences $gameAssets -VMSize $vmSize -MultiplayerServerCountPerVM 1 -Ports $ports -RegionConfigurations $regions

# All PlayFabMultiplayerApi cmdlets return objects, so we can pass the returned object to ConvertTo-Json for human readability.
$buildResponse | ConvertTo-Json -depth 5

A continuación se muestra código de ejemplo para ayudar a implementar compilaciones para servidores de juegos Linux.

$vmSize = "Standard_D2as_v4"
$ports = @( @{ Name = 'tcp_port'; Num = 8080; Protocol = 'TCP' }, @{ Name = 'udp_port'; Num = 8081; Protocol = 'UDP' } )
$regions = @( @{ 'MaxServers' = 1; 'Region' = 'AustraliaEast'; StandbyServers = 1; 'ScheduledStandbySettings' = $NULL } )
$containerImageReference = @{ ImageName = "MyLinuxContainerImage"; Tag = "0.2" }

$buildResponse = New-PfBuild -BuildName ExampleBuild -ContainerFlavor CustomLinux -ContainerImageReference $containerImageReference -VMSize $vmSize -MultiplayerServerCountPerVM 1 -Ports $ports -RegionConfigurations $regions

# All PlayFabMultiplayerApi cmdlets return objects, so we can pass the returned object to ConvertTo-Json for human readability.
$buildResponse | ConvertTo-Json -depth 5

Durante el desarrollo, apague las regiones sin usar o en mal estado para evitar el consumo de horas de núcleo de máquina virtual. El consumo de horas de núcleo comienza durante el inicio de la máquina virtual y continúa hasta que la máquina virtual se apaga. Las máquinas virtuales de una región no se apagarán automáticamente a menos que los servidores en espera de destino de la región lleguen a 0, o que se elimine una región.

Apagado de máquinas virtuales

Hay tres formas de apagar máquinas virtuales

Establezca el valor de servidores en espera de destino de una región en 0; esto apagará las máquinas virtuales solo de esa región.
Elimine una región específica de una compilación.
Elimine toda la compilación; esto apagará las máquinas virtuales de todas las regiones de esta compilación.

Enumeración de compilaciones implementadas

Para ver una lista de las compilaciones de su título, ejecute los comandos siguientes.

Get-PfBuild | ConvertTo-Json -depth 5

Solicitud de un servidor multijugador

Una vez que haya creado una compilación, se crearán uno o varios servidores después de ejecutar su archivo .exe. Estos servidores están ahora “en espera”. Puede verlos al enumerar todos los servidores que ejecutan la compilación con este comando.

Get-PFMultiplayerServer -BuildId $buildResponse.data.BuildId -Region "EastUS"

Una vez que veamos algunos servidores en espera, solicitemos uno para jugar…

$sessionId = New-Guid
$serverResponse = Request-PfMultiplayerServer -BuildId $buildResponse.data.BuildId -PreferredRegions @('EastUS') -SessionId $sessionId

La respuesta a esa llamada incluye una dirección IPv4 y un número de puerto a los que pueden conectarse los clientes. En el caso de WindowsRunnerCSharp.exe, hospeda un servidor web sencillo, por lo que puede navegar a la dirección IPv4 y al número de puerto para obtener una respuesta:

curl "http://$($serverResponse.data.Ipv4Address):$($serverResponse.data.Ports[0].Num)"

Este es el núcleo de los servidores multijugador de PlayFab: en un plazo de 3 segundos desde que su servicio de emparejamiento llama a RequestMultiplayerServer, PlayFab asignará un nuevo servidor. Estos servidores provienen de grupos de servidores en espera que se rellenan continuamente y que usted configura por región y por compilación.

Asignación de comandos

La tabla siguiente muestra el nuevo equivalente de los comandos antiguos. Se trata de una asignación rápida para ayudar a quienes han usado la versión anterior del módulo de PowerShell y necesitan convertir sus comandos existentes. Asegúrese de leer la definición de cada comando para conocer todos los detalles del cambio, ya que algunos de los argumentos también han cambiado.

Comando de MultiplayerPowershell (antiguo)	Módulo MpsPowershell API (nuevo)
Add-PFMultiplayerAsset	New-PfAsset
Add-PFMultiplayerCertificate	Invoke-PfUploadCertificate
Enable-PFMultiplayerServer	Enable-PfMultiplayerServer
Get-PFMultiplayerAsset	Get-PfAssetSummary
Get-PFMultiplayerBuild	Get-PfBuild
Get-PFMultiplayerCertificate	Get-PfCertificateSummary
Get-PFMultiplayerContainerImages	Get-PfContainerImage
Get-PFMultiplayerImageTags	Get-PfContainerImageTag
Get-PFMultiplayerQosServer	Get-PfQosServer
Get-PFMultiplayerServer	Get-PfMultiplayerServer
Get-PFTitleEntityToken	en desuso
New-PFMultiplayerBuild	New-PfBuild
New-PFMultiplayerServer	Request-PfMultiplayerServer
Remove-PFMultiplayerAsset	Remove-PfAsset
Remove-PFMultiplayerBuild	Remove-PfBuild
Remove-PFMultiplayerCertificate	Remove-PfCertificate
Remove-PFMultiplayerContainerImageTag	Invoke-PfImageUntagContainer
Set-PFTitle	Set-PfTitle

XBOX Services

PlayFab

Obtención del identificador de título y la clave secreta de desarrollador

Instalación del módulo de PowerShell PlayFab MultiplayerAPI

Obtención de un EntityToken para el título

Habilitación de la característica de servidores multijugador para el título

Carga de un recurso

Creación de una compilación

Apagado de máquinas virtuales

Enumeración de compilaciones implementadas

Solicitud de un servidor multijugador

Asignación de comandos

Consulte también

​Obtención del identificador de título y la clave secreta de desarrollador

​Instalación del módulo de PowerShell PlayFab MultiplayerAPI

​Obtención de un EntityToken para el título

​Habilitación de la característica de servidores multijugador para el título

​Carga de un recurso

​Creación de una compilación

​Apagado de máquinas virtuales

​Enumeración de compilaciones implementadas

​Solicitud de un servidor multijugador

​Asignación de comandos

​Consulte también

Obtención del identificador de título y la clave secreta de desarrollador

Instalación del módulo de PowerShell PlayFab MultiplayerAPI

Obtención de un EntityToken para el título

Habilitación de la característica de servidores multijugador para el título

Carga de un recurso

Creación de una compilación

Apagado de máquinas virtuales

Enumeración de compilaciones implementadas

Solicitud de un servidor multijugador

Asignación de comandos

Consulte también