logo bannerlogo banner
Page Navigator
  • intents: Intent[] - an array of intents to use for the bot, default: no intents
  • proxy: string - the socks5 (or socks5h) proxy to use for the bot, default: null (no proxy)
  • instance: string - the instance of the game to use, default: 'shellshock.io'
  • protocol: string - the protocol to use, default: 'wss'
  • apiMaxRetries: number - the max retries for failed shell auth requests, default: 5
  • connectionTimeout: number - the timeout in milliseconds for connecting to the game server, default: 5000

You can pass any of these parameters when creating a bot like so:

import Bot from 'yolkbot/bot';
const bot = new Bot({
    proxy: 'socks5://user:pass@host:port',
    apiMaxRetries: 10,
    connectionTimeout: 10000
});

You can also, obviously, pass no parameters and just use the defaults:

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