Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added CompleteTutorial to Documentation #5078

Merged
merged 3 commits into from
Sep 2, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/configuration_files.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
- [Egg Incubator](#egg-incubator)
- [ShowBestPokemon](#showbestpokemon)
- [Telegram Task](#telegram-task)
- [CompleteTutorial](#completetutorial)

#Configuration files

Expand Down Expand Up @@ -1017,3 +1018,46 @@ Bot answer on command '/info' self stats.
}
}
```

## CompleteTutorial
[[back to top](#table-of-contents)]

### Description
[[back to top](#table-of-contents)]

Completes the tutorial:

* Legal screen
* Avatar selection
* First Pokemon capture
* Set nickname
* Firte time experience
* Pick team at level 5


### Options
[[back to top](#table-of-contents)]

* `nickname` : Nickname to be used ingame.
* `team` : `Default: 0`. Team to pick after reaching level 5.

Available `team` :
```
0: Neutral (No team)
1: Blue (Mystic)
2: Red (Valor)
3: Yellow (Instinct)
```

### Sample configuration
[[back to top](#table-of-contents)]
```json
{
"type": "CompleteTutorial",
"config": {
"enabled": true,
"nickname": "PokemonGoF",
"team": 2
}
}
```