Creating User Installed Commands

This page will guide you through the setup of User-Installed commands

Disclaimer

This page has been created on the 26th June 2024, discord.js does not officialy support User Installed commands or has a Command Builder for it yet. If this changes, we will update this page. If we didnt, please let us know in our discord server.

What are User-Installed Commands?

Users have the option to install Apps/Discord Bots on their account directly. This means, they can use commands which you have added before as user installed commands in your code in all discord servers, group chats and direct messages. If the discord server "doesnt allow" to use user installed commands in their server, the discord bot will respons with ephemeral (only interaction user visible) messages. We still recommend to set ephemeral to true to not spam channels using the commands and provide a clean discord channel.

Handler Setup

You might have to setup your handler, you can find the code here for a dynamic support of commands: https://github.com/cptcr/nexus/blob/main/src/functions/handelCommands.js

Command Building

Here is an example code of a user installed commands which is a dictionary command. The command data has to be in a object format:

const { SlashCommandBuilder, EmbedBuilder } = require('discord.js');
const theme = require("../../../embedConfig.json");
module.exports = {
    data: {
        name: "dictionary",
        description: "search a word in the dictionary",
        "integration_types": [0, 1],
        "contexts": [0, 1, 2],
        options: [
            {
                name: "word",
                required: true,
                type: 3,
                description: "the word you want to search"
            },
        ]
    },

    async execute(interaction) {
 
        const word = interaction.options.getString('word');
 
        let data = await fetch(`https://api.dictionaryapi.dev/api/v2/entries/en/${word}`)
 
        if (data.statusText == 'Not Found') {
            return interaction.reply({ content: 'that word does not exist', ephemeral: true});
        }
 
        let info = await data.json();
        let result = info[0];
 
      let embedInfo = await result.meanings.map((data, index) => {
 
            let definition = data.definitions[0].definition || "No definition found";
            let example = data.definitions[0].example || "No example found";
 
 
            return {
                name: data.partOfSpeech.toUpperCase(),
                value: `\`\`\` Description: ${definition} \n Example: ${example} \`\`\``,
            };
 
 
        });
 
        const embed = new EmbedBuilder()
        .setColor(theme.theme)
        .setTitle(`Definition of | **${result.word}**`)
        .addFields(embedInfo)
 
        await interaction.reply({ embeds: [embed], ephemeral: true });
    }
}

Useful Links

Example of building user-installed commands by Discord (JavaScript)

user-install-example/commands.js at main · discord/user-install-exampleGitHub

Developing A User-Installable App

Discord Developer Portal — API Docs for Bots and DevelopersDiscord Developer Portal

Prebuilt Commands

nexus/src/commands/User_Installed at main · toowake/nexusGitHub

User Installed commands explained with short tutorial

Use Your Discord Bot Everywhere: User-Installable Apps (Discord.js + Robo.js)DEV Community