logo bannerlogo banner
Page Navigator

Bots can be created in 2 lines by importing the package and creating a bot:

import Bot from 'yolkbot/bot';
const bot = new Bot();

Once you create a bot, it can join a game using the join method. This method takes two parameters: the bot's name and the game code. Here's an example of how to join a game:

await bot.join('my bot name', 'game-code-here');

Which means that all together, you create a bot in 3 lines. We do no false advertising.

Note

For the rest of these guides, it's important to note that anytime you see the word bot, it assumes that you have already imported and created a bot instance. So, for example, if you see bot.join(...), it means you should have already done the following:

import Bot from 'yolkbot/bot';
const bot = new Bot();

From here, it's up to you what you want to read. Here's a few pathways you can take:

You can also check out the param guide to see some global configuration options for your bot.

Happy botting!