Index

Let's be honest; reading API documentation is a bit of a pain. These guides are meant to help you get started with the library and offer a point of reference.

Note

As with many Python libraries, you may use import interactions and do interactions.X for your objects. The documentation leads more towards using from interactions import X, however.

Events, errors, and utilities are under their own sub-namespace when using import interactions. For example, events are under interactions.events.X.

  • Getting Started

    Ready to get your Python on and create a Discord bot? This guide's got you covered with installation options and a basic bot code example.

  • Creating Your Bot

    Want to create your own bot but don't know where to start? This guide has you covered from bot-tom to top!

  • Slash Commands

    Slash commands are a cut above the rest - this guide will show you how to create your very own slash commands.

  • Context Menus

    Create menus that are so good, they'll have your users right-clicking for more.

  • Components

    While interactions are cool and all, they are still missing a vital component. Introducing components, aka Buttons, Selects, soon Text Input Fields

  • Modals

    Ready to pop-up your user interface game? This guide will show you how to create modals.

  • Converters

    If your bot is complex enough, you might find yourself wanting to use custom models in your commands. Converters are classes that allow you to do just that.

  • Events

    HEY! LISTEN! If you want to know more about events, you can check out this guide.

  • Extensions

    Damn, your code is getting pretty messy now, huh? Wouldn't it be nice if you could organise your commands and listeners into separate files?

  • Voice Support

    So you want to start playing some 🎵tunes🎶 in voice channels? Well let's get that going for you.

  • Localisation

    So your bot has grown, and now you need to localize localise your bot. Well thank god we support localisation then, huh?

  • Prefixed Commands

    Going old-school with prefixed-commands? No problem. Let's get your message commands up and running.

  • Pagination

    We've all hit that point where Discord won't let you send enough characters, at that point you can either flood the channel with multiple messages, or you can start paginating your messages.

  • Tasks

    Tasks are background processes that can be used to asynchronously run code with a specified trigger.

  • Sharding

    Oh damn, your bot is getting pretty big, huh? Well I guess its time we discuss sharding.

  • Migration from discord.py

    What's the difference between interactions.py and discord.py?

  • Migration from v4

    How do I migrate from interactions.py v4 to v5?

  • Migration from NAFF

    How do I migrate from NAFF to i.py v5?