logo bannerlogo banner
Page Navigator

Intents are a way to enable specific features that are disabled by default for 1 of 2 reasons:

  1. They require extra API calls
  2. They are unusually intensive on your device

Here's a list:

  • Bot.Intents.BOT_STATS - has the bot fetch its own stats
    • does not include other game players' stats
  • Bot.Intents.CHALLENGES - has the bot fetch its own challenges
    • does not include other game players' challenges
  • Bot.Intents.PATHING - enables pathfinding logic
  • Bot.Intents.PING - enables pinging logic
  • Bot.Intents.COSMETIC_DATA - enables fetching of cosmetic data
    • If this is not enabled, bot.players[x].character will not have items but rather item IDs.
    • For example, bot.players[x].character.hat is usually an item ID. Enabling this makes it an item object.
    • This is due to the resources searching through items takes (it's usually not worth it).
  • Bot.Intents.PLAYER_HEALTH - enables player health tracking
    • health regen is currently somewhat intensive on your computer
    • player[x].hp will be occasionally updated without this, but it won't include health regeneration
  • Bot.Intents.PACKET_HOOK - enables the packet hook
  • Bot.Intents.LOG_PACKETS - enables logging of all packets to the console
    • only used for deep debugging
  • Bot.Intents.NO_LOGIN - disables the login process and authenticates with an empty session ID
    • this will cause issues with the normal shell servers, you should probably never use this
  • Bot.Intents.DEBUG_BUFFER - helps you debug buffer issues (mostly for package developer use only)
  • Bot.Intents.NO_AFK_KICK - sends keepAlive packets to prevent the bot from being AFK kicked
    • bots will be afk kicked if they do not send a chat message or spawn/move for 5 minutes
  • Bot.Intents.LOAD_MAP - fetches and loads the map data
    • enables player.inKotcZone, bot.game.map.raw, the mapLoad hook, and various other things
  • Bot.Intents.NO_REGION_CHECK - disables checking regions against the region list (custom servers >>)
  • Bot.Intents.NO_EXIT_ON_ERROR - disables the bot quitting the program when it runs into a critical error
    • this is useful for debugging, but you should NEVER use this in production
  • Bot.Intents.RENEW_SESSION - automatically renews bot sessions
    • this is useful for long-term account sessions
  • Bot.Intents.VIP_HIDE_BADGE - hides the VIP badge ingame if the bot is logged into a VIP account

You can enable any intent by passing them in the intents array:

const bot = new Bot({
    intents: [
        Bot.Intents.PING,
        Bot.Intents.NO_AFK_KICK,
        Bot.Intents.LOAD_MAP
    ]
});
Warning

You should NEVER blindly specify all intents! Many times, you will not need to do whatever the intent does. For example, if you're not processing item data, you should not enable Bot.Intents.COSMETIC_DATA. Enabling intents that you do not need will cause your bot to use more resources than it needs to, which can lead to performance issues.