GithubHelp home page GithubHelp logo

microsoftdocs / playfab-docs Goto Github PK

View Code? Open in Web Editor NEW
97.0 45.0 123.0 168.69 MB

Documentation for the Azure PlayFab service for game development

License: Creative Commons Attribution 4.0 International

PowerShell 100.00%

playfab-docs's Introduction

playfab-docs's People

Contributors

amccalib avatar antnguyen89 avatar bvanous avatar dgkanatsios avatar fschober-atg avatar joannaleecy avatar john-smith-microsoft avatar kevinasgari avatar m-kdearnley avatar mckmoffatt avatar nassosterz-ms avatar natashaorie avatar nathankong-microsoft avatar openpublishbuild avatar pgilmorepf avatar sahilashar avatar scottmunroms avatar sebgrink avatar shikha-tarware avatar shtarwar avatar sranthar avatar toddbellmsft avatar tophpalmer avatar v-kciril avatar v-kents avatar v-rayro avatar v-thopra avatar waznop avatar wesjong avatar williacj avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

playfab-docs's Issues

Meters/limits are invisible for free tier titles

There's no page to see currently used limits for ex. "Content and Configuration Reads 20K Reads" or "CloudScript Total Executions 200K Executions". How someone can manage playfab usage to be sure not to go over them?


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

ProviderName is missing from the PayForPurchaseRequest

In your example in the DefinePaymentCurrency function, you create a PayForPurchaseRequest without defining the ProviderName. This results in an "Invalid Input Parameters" error, because it's required even when paying with virtual currency.

It would also be helpful to give a ProviderName example when paying with VC, for example Title123456 (I found out what to put here by logging the payment options from StartPurchaseResult, but haven't found it anywhere in the documentation).


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

[TIP] Make sure OutputFolder is an absolute path!

OutputFolder is used to set GSDK_CONFIG_FILE, which need a absolute path in order to avoid any errors while loading the game server config by your server executable.


Detalhes do documento

Não edite esta seção. É necessário para a vinculação do problema do docs.microsoft.com ➟ GitHub.

Duplicate paragraph

Hi,

I wanted to let you know that 'Significantly improve performance' is twice in this document.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Typo in URL

The "Download Source Code" URL contains a typo: hhttps://github.com/PlayFab/Objective_C_SDK/


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Unclear remote debugging instructions

Following the steps of the Debugging a deployed multiplayer server section is unclear. Step 1 is fine. Step 2, do I run the installer or include the installer in my assets package? When I run the installer, it installs a loads of files into directories I have no control of so it is very unclear which I need to copy into the assets package. If I include the installer, then there is no msvsmon command to execute. I believe the installer is a graphical one, so cannot be invoked properly at the command line?

Please can you clarify these steps


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Resources links broken

Hello,

The links to GitHub under the resources section (for PS4 and Nintendo Switch) lead to a 404 instead of the source code.
Thank you.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

entity_executed_cloud_script description is wrong

The description says this: "This event is optionally triggered when an Entity CloudScript function is executed, either by calling the ExecuteCloudScript API with the GeneratePlayStreamEvent option or triggered by a PlayStream event action with the 'Publish results as a PlayStream Event' box checked."

In reality, this event would be fired when someone calls "ExecuteEntityCloudScript" not "ExecuteCloudScript" and it cannot be fired as a result of a PlayStream action because execute entity cloud script is not an action PlayFab supports (I'm not sure where this feedback goes, feel free to reach out to tomgu if you have questions)


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Character is "キャラクター"

Auto Localization translated the "Character" to "文字", but the correct Japanese is "キャラクター".
Including this page, all pages conversion is miss translated.


ドキュメントの詳細

このセクションを編集しないでください。 docs.microsoft.com で必須です ➟ GitHub の問題のリンク。

GetUserDataResult appears to be incorrect.

The GetUserDataResult type described in 'Server > Player Data Management > Get User Data' among others, does not match the old PlayFab documentation. The 'Data' property is of type 'UserDataRecord' where in the old docs it's of type 'Dict<String, UserDataRecord>'


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Isn't " Create Server Backfill Ticket" already out of beta?

Isn't " Create Server Backfill Ticket" already out of beta this month?


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Unclear where file data is supplied

In trying to get a file to upload, the implied 'filename' wasn't working. I see now looking more closely that there's a payload as part of the PlayFabHttp.SimplePutCall. This is the meat of the upload, but following the paper-chase of file upload documentation that mostly just points to this example repeatedly, this isn't made at all clear anywhere. Even the deconstruction on this page doesn't make any mention of this call as the actual method that uploads the file.

The guides for file uploads absolutely need to make mention of this and any other methods for uploading data, starting with an update to this example to draw our attention to this SimplePutCall call.

Even searching the documentation for "PlayFabHttp.SimplePutCall" yields no references!

https://docs.microsoft.com/en-us/search/?search=SimplePutCall&category=All&scope=PlayFab

https://api.playfab.com/search?q=SimplePutCall


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Code Error

The code in Step 3 has 2 extra braces in it after setting the GetLeaderboardRequest members.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Code not working on a new project

The code is not working on a new project with the SDK and editor extension. EntityModels don't exist in PlayFab namespace


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Stop autotranslating!!!

Although I am a German native speaker, I want to read technical documentations in English and not its German translations, because in English it is much easier to understand!


Dokumentdetails

Bearbeiten Sie diesen Abschnitt nicht. Er ist für die Verknüpfung von docs.microsoft.com zum GitHub-Artikel erforderlich.

Font/background color

The font/background color contrast is too high. My eyes are watering reading this.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

New-PFMultiplayerBuild outdated signature

New-PFMultiplayerBuild does not accept AssetFileName and AssetMountPath, AssetReferences object is used now. MappedPorts parameter also renamed to Ports. RegionConfiguration is obligatory. E.g:

$AssetReferences = New-Object PlayFab.MultiplayerModels.AssetReferenceParams
$AssetReferences.FileName = winrunnerSample.zip
$AssetReferences.MountPath = "C:\Assets"

$RegionConfiguration = New-Object PlayFab.MultiplayerModels.BuildRegionParams
$RegionConfiguration.Region = "WestEurope"
$RegionConfiguration.MaxServers = 1
$RegionConfiguration.StandbyServers = 1

New-PFMultiplayerBuild -BuildName "PowerShellTest" -AssetReferences $AssetReferences -StartMultiplayerServerCommand "C:\Assets\WindowsRunnerCSharp.exe" -Ports $Ports -VMSize $VMSelection -RegionConfiguration $RegionConfiguration


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

GameCenter login recommendation is outdated based on latest updates

The login best practices documentation doesn't recommend using GameCenter as it's unsafe.
According to this thread, the issue can now be fixed by enabling a secure authentication method.

You should update the docs, so developers are aware of that without having to google through it.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

PlayFabCloudScriptPlugin is required to run the sample, but it is not described.

  1. You will need to install the PlayFab SDK via Package Manager. To do this open Terminal or CMD Console in Visual Studio Code and type: dotnet add package PlayFabAllSDK

To run the HelloWorld Sample, We need PlayFabAllSDK and PlayFabCloudScriptPlugin.

Please describe PlayFabCloudScriptPlugin on this page.

[PlayFabCloudScriptPlugin]
https://www.nuget.org/packages/PlayFabCloudScriptPlugin/1.53.190627-alp


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

LoginTitlePlayerAccountEntity doesn't exist in sdks

As can be read on https://github.com/PlayFab/API_Specs/blob/master/Swagger/PlayFab/Client.swagger.json
"LoginTitlePlayerAccountEntity":
"description": "Formerly triggered an Entity login with a normal client login. This is now automatic, and always-on.",
"type": "boolean",


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

"テーブルの削除"→ドロップテーブル

"katakana word" is suitable.


ドキュメントの詳細

このセクションを編集しないでください。 docs.microsoft.com で必須です ➟ GitHub の問題のリンク。

Outdated information

"PlayFab Game Servers:

Are hosted using AWS EC2."

Are you sure you are not hosting them on Azure VMs ? :)


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Example deprecated

string.IsNullOrEmpty(PlayFabSettings.staticSettings.TitleId) now the correct example string.IsNullOrEmpty(PlayFabSettings.TitleId)


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

?

[Enter feedback here]


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Wrong include path

Hi, I noticed that the last include path is external/include. This path does not exist and should be external/jsoncpp/include


Détails du document

Ne pas modifier cette section. C’est obligatoire pour docs.microsoft.com ➟ Liaison des problèmes GitHub.

WARNING: The command 'Get-PFTitleEntityToken' is obsolete. This cmdlet is deprecated. Use Set-PFTitle instead.

some of the commands seem to be obsolete


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

These do not appear to match.

    // Cancel matchmaking if a match is not found after 600 seconds.
    GiveUpAfterSeconds = 120,

Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Link to Ip addresses used by the multiplayer VMs is broken

The link in the following sentence is broken.
"The IP addresses used by the multiplayer VMs can be found here."


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Getting title data

Hi, thank you for the useful sample.

You say the sample gets all the title data:

public void ClientGetTitleData() {
PlayFabClientAPI.GetTitleData(new GetTitleDataRequest(),
result => {
if(result.Data == null || !result.Data.ContainsKey("MonsterName")) Debug.Log("No MonsterName");
else Debug.Log("MonsterName: "+result.Data["MonsterName"]);
},
error => {
Debug.Log("Got error getting titleData:");
Debug.Log(error.GenerateErrorReport());
}
);
}

But in fact, it displays only the value for this key MonsterName. In the dictionary result.Data, there are in fact all the title data (keys and values), but the sample displays just the value for one key.

I felt the need to clarify this. Thank you.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

The example image of how to get the database name is unclear

The text in the command does not match the text in the part that can be copied, and so it is unclear exactly what should be copied (the whole thing, or just the part after the period.)


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Feedback

There's no ad API, so I have to guess.

Main problem for ads is making sure the player has watched something. Or has at least a certain time between start and end. I bet you don't have that, so having that would be a requirement.

Rewarded ads are only actually good when the player knows what he's getting. Otherwise why watch it? This is very notably in my ads. Not sure if the client can see the rewards beforehand and I'm pretty sure those random odds are actually harmful for inexperienced devs.

My best ad is where you get something client based (double offline gold or a special productivity buff), not a Playfab item/VC. Not sure if your model covers that.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Game Manager settings page has moved

Parts of this page reference Game Manager's "Settings" page, e.g.

The ID field should be set to your game's TitleId, found in Game Manager:

  • Go to Settings.
  • Select API Features.
  • Then select the TitleId.

I fear the "Go to Settings" part doesn't make sense anymore. "Settings" isn't a top-level tab of Game Manager. Now you have to click the gear next to the title at the top left, then select "Title settings".


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Duplicate word in documentation

2nd paragraph under
Policy control and structure
...
To use the Admin API you must provide provide the developer secret key associated with your title. The Developer key is used to authorize your Title to make Admin API calls. For

There's a duplicate provide here that should be removed.

Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Namespace, Title, Character, Group, and Service entity type names are incorrectly capitalized

The headers for Namespace, Title, Character, Group, and Service have the first letter capitalized, which is misleading considering the note at the top of the document emphasizes that these types are case sensitive. See https://api.playfab.com/docs/tutorials/entities/entitytypes for the correct naming.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

CTO

This page and the example showing you being forced to shutdown needs to explain or link to how to restart the game so that the users experience a minimum of disruption.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Missing some links/pictures.

The article appears to be missing some extra information that the writing alludes to. Under the "Overriding the UE4..." methods section it says, "we've added the following dedicated build rules" but no reference is shown. That whole section seems to be missing more references as the steps are complex.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Confusing notes on "Deploying PlayFab multiplayer server builds"

The notes says Asset filenames cannot only contain alphanumeric characters, underscores, hyphens, and periods. I'm guessing cannot should be can ?


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

PUN 2

Please update this page to work with PUN 2 (demos!) or create a new tutorial to get PlayFab up and running with the PUN 2 plugin in Unity.
I guess the "DemoHub-Scene" scene in PUN 2 is different to PUN and therefore erros occur. SlotRacer and Cockpit are not working with the PlayFabAuthenticator script above.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

If you copy and paste the code on a new Unity project with the SDK installed (with editor extension also) is not working

FinalizeUpload and LoginTitlePlayerAccountEntity are not declared


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Where to find PlayFab.Samples from the HelloWorld example

The referenced namespace is available at
https://github.com/PlayFab/PlayFab-Samples/blob/master/Samples/CSharp/AzureFunctions/CS2AFHelperClasses.cs


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Typo

"Monetization is one of the most important elements of your game’s strategy..", Notice the 2 dots at the end.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

What's the difference with PlayFabAIISDK

I do not understand what is the difference, is this "Xamarin SDK" with some added benefits? I'd prefer to just download the PlayFabAIISDK nuget package and use it in the Xamarin project if that's officially supported as well but I find no good information and the existence of this page only adds confusion.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

"Player の在庫"→"プレイヤーのインベントリ"

Meaning passes through as it is.


ドキュメントの詳細

このセクションを編集しないでください。 docs.microsoft.com で必須です ➟ GitHub の問題のリンク。

ContainerImageReference doesn't exist

ContainerImageReference is not a valid property in the request body - it should be ContainerRepositoryName and ContainerTag instead.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.