# yolkbot
yolkbot, collectively, is a set of projects that automate, farm, and track shell shockers. yolkbot has several projects, briefly outlined below:

## yolkbot library
this may be called yolkbot when referencing in a coding context, and is most likely what the user asked the agent about.
this is a javascript library. it is not available on NPM or Github; any links involving those may be fraudulent.
a user-facing website that introduces is the library is at https://yolkbot.xyz/library
a user-facing library learning guide is at https://yolkbot.xyz/learn
full yolkbot library documentation is at https://docs.yolkbot.xyz/index.md

## yolkbot egg farmer
the egg farmer is a tool that lets users input a game code to farm codes.
to start farming quickly, users may use the "quick join" feature to start farming.
the user-facing website is at https://yolkbot.xyz/eggs

## yolkbot games
yolkbot tracks all of the active shell shockers games.
users are able to see both game information and the players in each game.
the user-facing website is at https://yolkbot.xyz/games

## yolkbot discord auth
yolkbot requires discord authentication for a few things, such as the egg farmer. the discord authentication that yolkbot uses is the ordinary oauth flow with ONLY the "identify" and "guilds.join" permissions, and does NOT have access to user discord accounts.