Skip to content

getting-started.md

Latest commit

 

History

History
111 lines (77 loc) · 4.35 KB

getting-started.md

File metadata and controls

111 lines (77 loc) · 4.35 KB

Making a Ping-Pong Bot

Creating a Discord Bot

  1. Go to https://discord.com/developers/applications

  2. Create an Application

  3. Give the application an awesome name (this will be used as the bots initial username)

    name

  4. Click Save Changes

  5. Open the Bot tab

    create bot

  6. Make sure to make your bot public, this allows others to invite your bot to your server.

    public bot

    You only want "Requires OAuth2 code grant" enabled if you plan to use an OAuth2 flow, the general user will not need this.

Add your Discord Bot to a Server

  1. Retrieve your application/client ID from the General Information tab

    client id

  2. Create an OAuth2 authorization URL (reference docs).

    This is the URL to invite your bot to a server, for example, https://discord.com/api/oauth2/authorize?client_id=492747769036013578&scope=bot

    !!! note This can be done from the Bot tab at the very bottom. Here you can select the scope bot and some permissions required for your bots functionality (optional).

  3. Open the authorization dialogue (click link from step 2)

  4. Select your Server (Requires permission to manage server)

  5. Click Authorize

    authorize

Connecting to Discord with a Bot Account

  1. Retrieve your Bot Token from your application dashboard (https://discord.com/developers/applications)

    get token

    !!! danger You must not show this token to anyone, ever.

  2. Set up your JDA project:

    Download

  3. Create JDABuilder instance, using the static methods and your token

    !!! tip

     It is often better to load your token in from an external file or environment variable, especially if you plan on publishing the source code.

  4. Enable the "Message content intent" on your bot's dashboard, and add the MESSAGE_CONTENT intent on your JDABuilder

    While receiving messages is enabled by default, Discord requires an additional privileged intent for the content of the message.

  5. Build JDA using JDABuilder.build()

    public static void main(String[] arguments) throws Exception
{
    JDA api = JDABuilder.createDefault(BOT_TOKEN)
                        .enableIntents(GatewayIntent.MESSAGE_CONTENT)
                        .build();
}

    !!! note You must not build JDA more than once.

Making a Ping-Pong Protocol

  1. Setup your JDA instance (see Connecting To Discord)

  2. Implement an EventListener or extend ListenerAdapter

    public class MyListener extends ListenerAdapter 
{
    @Override
    public void onMessageReceived(MessageReceivedEvent event)
    {
        if (event.getAuthor().isBot()) return;
        // We don't want to respond to other bot accounts, including ourself
        Message message = event.getMessage();
        String content = message.getContentRaw(); 
        // getContentRaw() is an atomic getter
        // getContentDisplay() is a lazy getter which modifies the content for e.g. console view (strip discord formatting)
        if (content.equals("!ping"))
        {
            MessageChannel channel = event.getChannel();
            channel.sendMessage("Pong!").queue(); // Important to call .queue() on the RestAction returned by sendMessage(...)
        }
    }
}

    !!! info More information about RestActions can be found here

  3. Register your listener with either JDABuilder.addEventListeners(new MyListener()) or JDA.addEventListeners(new MyListener()) (see Events)