the basics
this is for yolkbot 2.0, which has not yet released. visit the existing documentation to learn about the current version of yolkbot.
everything yolkbot does can be tied back to one thing: the Bot.
bots do everything. it has everything that yolkbot has through some avenue. want to log in? the bot can do that. want to join or handle games? the bot can do that. want to manage chikn winner? the bot can do that. want to claim item codes? the bot can do that.
to make things simply, things have been split into two categories:
- logging in & accounts
- games
logging in and accounts has everything including:
- logging in
- viewing account stats & inventory
- playing & managing chikn winner
- viewing & claiming challenges
- buying items & redeeming codes in the shop
since most of the logging in features are in basic functions and properties, the only logging in documentation is provided in the simple logging in guide and relies on you to read the full API docs to find the specific functions/properties you want to use.
games has everything you'd typically do in a game, but it's split into multiple categories due to nuance:
- joining games - find public games, create private games, and join games!
- managing games - manage games the bot is in by "listening" and "dispatching" events
- chatting - chatting ingame, which is so oddly nuanced i had to write a whole separate guide on it
from here, it's time to turn you free and let you explore the documentation and build anything you want! if you want to see EVERYTHING yolkbot can do, you can always check the automatically generated and updated API reference.