RADAGAST

Discord Bot for Epitech La Réunion
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Installation
  • Discord Bot Development
    • Add Event
    • Add Command
• Roadmap
• Contributing
• Contact
• Acknowledgements

About The Project

This project is a Discord Bot for Epitech La Réunion to manage students easily.

Built With

• NodeJS
• DiscordJS

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repo

git clone https://github.com/nicklamyeeman/RADAGAST.git

2. Use npm to build and run

npm install
npm run dev

Discord Bot Development

Add Event

The project allows you to add events easily by adding a js file in the public/events/ directory.

Example :

module.exports = {
  name: 'interactionCreate',
  execute(interaction) {
    if (interaction.isChatInputCommand()) {
      const command = interaction.client.commands.get(interaction.commandName);  
      if (!command) return;
      try {
        command.chatInputExecute(interaction);
      } catch (error) {
        console.error(error);
        interaction.reply({ content: `Error!`, ephemeral: true });
      }
    }
  },
};

Add Command

The project allows you to add commands easily by adding a js file in the public/commands/ directory.

Example :

  const { SlashCommandBuilder } = require("discord.js");

  module.exports = {
    data: new SlashCommandBuilder()
      .setName('ping')
      .setDescription('Replies with Pong!'),
    async chatInputExecute(interaction) {
      return interaction.reply({content: `Pong!`, ephemeral: false});
    }
  };

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Nick LAM YEE MAN - @nickauteen - nick.lam-yee-man@epitech.eu

Project Link: https://github.com/nicklamyeeman/RADAGAST

Acknowledgements

• Best-README Template