Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.86 KB

README.md

File metadata and controls

56 lines (37 loc) · 1.86 KB

Project Name

🤖 Ali-Emil-Discord-Chat-Bot with OpenAI Integration

Overview

This project showcases a powerful Discord chat bot capable of engaging in intelligent conversations using the OpenAI API. The bot is built on Discord.js and offers a modular structure for easy command handling and extensibility.

Features

  • Intelligent Conversations: Leverage the OpenAI API for advanced chat completions and dynamic responses.
  • Command Structure: Organized command modules (/commands) for easy customization and expansion.
  • Testing Suite: Ensure security and functionality with a comprehensive test suite covering API key security, bot initialization, Discord and OpenAI integration, and individual command functionalities.

Getting Started

Follow these steps to set up and run the bot locally.

  1. Clone the Repository:
    git clone https://github.com/fac30/Ali-Emil-DiscordBot.git
    cd your-repo
    
  2. Install Dependencies:
  • npm install
  1. Configure Environment Variables:
  • Create a .env file with the following variables:
  • TOKEN=your_discord_bot_token
  • API_KEY=your_openai_api_key
  • GUILD_ID=your_discord_guild_id

4.Run the Bot:

  • npm run nodemon

Commands

  • /hi: Greet the bot and receive a friendly response.
  • /ping: Get a quick "Pong!" reply.
  • /server: Retrieve information about the Discord server.
  • /user: Get information about the user.

Testing

  • npm run tests
  • npm run ping
  • npm run hi

Contributing

  • Feel free to contribute by opening issues or submitting pull requests. Your ideas and improvements are welcome!

License

  • This project is licensed under the ISC License.
  • Feel free to customize the content based on your specific project details and preferences. If you have any additional information or preferences you'd like to include, let me know!