logo bannerlogo banner

learn yolkbot

Warning

this is for yolkbot 2.0, which is in open beta. visit the old documentation to learn about the current release version of yolkbot.

yolkbot is an amazing framework that builds bots for shell shockers.

if you can't code, stop here, learn to code, and come back.

yolkbot has 100% coverage of the game, and can be used in many places, so there's a lot of variation bot-to-bot. this guide tries to first establish how yolkbot can be used, and then how to use it to control games.

yolkbot can be used in two ways:

  • the package - traditional NPM package (best for node/bun users and bundler-based web apps)
  • the bundles - bundled script from CDN (best for tampermonkey scripts, raw HTML apps, and other basic web environments)

the only things these change is how yolkbot is imported and how you can get classes/enums, which you can learn in those files. from there, get started with the basics!

you can always share projects with me in the community, i can't wait to see what you build! ❤️