Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 3.67 KB

README.md

File metadata and controls

88 lines (60 loc) · 3.67 KB

PlayFabBuddy.Cli

Setup

  1. Copy settings.json to local.settings.json
  2. Fill out the required settings to connect to your PlayFab Title:
    1. titleId: Log in to PlayFab. You should see the titleId on your the front page after logging in, or in the URL of the browser when in teh Game Manager.
    2. devSecret:
      1. Got to the Game Manager of your Title
      2. Click on the cogwheel on top of the left menu (next to your Title's name). Click it
      3. Select "Title Settings"
      4. Select "Secret Keys" tab (have no one watch over your shoulder, these secret keys will be visible!)
      5. Click "New secret key"
      6. Give it a potential name (and optional: an expiry date)
      7. Click "Save secret key"
      8. Copy they key to your local.settings.json

Commands

Players

Commands related to players.

Create

dotnet run -- players create <number of players>

Delete

WARNING: This will delete ALL Master Player Accounts from the Title, which have been previously created with PlayFabBuddy on this very machine!

dotnet run -- players delete --local <Local_Path>

Delete by Segment

Will delete all Master Player Accounts from a given segment, identified by segment name. If a Master Player Account is assigned to another Title as well, players will NOT be deleted!

dotnet run -- players delete --remote <PlayFab_Segment_Name>

As segment name, you may use one of the pre-defined segment names:

  • All Players - All players
  • Lapsed Players - Last login greater than 30 days ago
  • Payers - Total value to date in USD greater than $0.00
  • Week Two Active Players - First login less than 14 days ago AND First login greater than or equal to 7 days ago AND Last login less than 7 days ago

Please note: Due to the nature of how segments work, you may need to execute this action multiple times to make sure to really delete all players in the given segment.

List

Running this will connect to your PlayFab Advanced Analytics cluster and run some query's on it to give your a list with all players using a specific IP. Before you can run this query you need to setup your PlayFab to enable PlayFabBuddy to access the data.

  1. Create a Azure Active Director Application Like: https://docs.microsoft.com/en-us/gaming/playfab/features/insights/connectivity/creating-aad-app-for-insights

  2. Configure Client ID and Client Secret for PlayFab Buddy to use

  3. Run the command

    dotnet run -- players list <IP_ADDRESS>

Matchmaking

Manages Matchmaking Queues

Create

This will create a new simple matchmaking queue with a name and min / max number of players. Currently there are no additional rules supported.

dotnet run -- matchmaking create

Policy

You can apply predefined policies by PlayFabBuddy to your title.

Add

This adds a new policy to your title, it makes sure to remove any conflicting policies that might be already in place. In the current iteration we are checking if the comment field in the policy as well in order to validate if a policy is already set. For now this is to make sure we are mainly managing policies created by PlayFabBuddy.

dotnet run -- policy add <NameOfPolicy>

Currently supported Policies:

  • AllowCustomIdLogin
  • DenyCustomIdLogin

These policies either block or allow login and creation of user accounts with customId.

List

This command has to option, if it's run without the remote parameter like:

dotnet run -- policy list

you will get a list of policies that PlayFabBuddy can manage for you.

If this command is used with the remote parameter like:

dotnet run -- policy list --remote

all policies that are currently assigned to your title are beeing fetched and printed to command line.