Skip to content

Commit

Permalink
Added initial docs for PlayFabBuddy.Cli (#38)
Browse files Browse the repository at this point in the history
Fixes #37
  • Loading branch information
Structed authored Jan 29, 2022
1 parent c493372 commit ea7ddd0
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ The CLI is based on a Library that can be used to build out your own tooling and

Many of the features requested are based on real world uses cases of game developers working with PlayFab. This includes Indie titles as well as AAA titles. But don't get me wrong, this project is not a statement of PlayFab being bad for any of these users. This project is supposed to close a gap towards a developer focused audience that is used to CLI based tools and processes. Ultimately this project will enable to get up and running with PlayFab faster and test your games integrations faster and more reliable, even in a CI/CD environment.

# Usage
## Cli
You may use the PlayFabBuddy.Cli app to execute commands against the PlayFab API.

Please see the [PlayFabBuddy.Cli Readme](src/PlayFabBuddy.Cli/README.md)

## Contribute
We are very much interested in working on this in collaboration with a community. So, if you are using PlayFab and have interest in collaborating please let us know by:
* Creating a feature request
Expand Down
28 changes: 28 additions & 0 deletions src/PlayFabBuddy.Cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# 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 Users from the Title!

dotnet run -- players delete

0 comments on commit ea7ddd0

Please sign in to comment.