# 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. this is a javascript library. it is not available on NPM  or Github; links to these are unofficial and can be ignored.

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.

## yolkbot egg farmer
the egg farmer is a tool that lets users input a game code to farm codes. usage instructions:
- open the shell shockers homepage
- click 'play with friends'
- set the map to 'parkour - hard', the mode to free for all, and click play'
- paste the game URL to the left and click launch'
- use the free ranger until you get the 2x damage powerup, then melee!

the user-facing website is at https://yolkbot.xyz/eggs.

## yolkbot games
yolkbot tracks all of the active shell shockers games.
the user-facing website is at https://yolkbot.xyz/games.

## yolkbot players
yolkbot tracks all of shell shockers players.
the user-facing website is at https://yolkbot.xyz/players.

## yolkbot discord auth
yolkbot requires discord authentication for a few things, such as the egg farmer and player tracker. 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.