Nala

Nala is an open-source Discord bot designed to meet various needs with a flexible command structure and seamless integration with Discord's API.

Features

• Slash Commands: Easily define and manage commands.
• Subcommands: Organize commands for better functionality.
• Utility Functions: Built-in utilities for logging and temporary replies.
• Customizable Configuration: Manage settings for initialization and command logging.
• Deno Compatibility: Run the bot with Deno for improved performance and security.

Table of Contents

• Installation
  • Node.js Setup
  • Deno Setup
• Usage
  • Starting the Bot
  • Defining Commands
• Contributing
• License
• Support

Installation

Node.js Setup

Prerequisites

• Node.js (v14 or higher) OR Deno
• Git

Steps

1. Clone the Repository

   git clone https://github.com/Its3rr0rsWRLD/nala.git
   cd nala

2. Install Dependencies

   npm install

3. Set Up Environment Variables

   Create a .env file in the root directory and add your Discord bot token:

   TOKEN=your_discord_bot_token_here

4. Configure Settings

   Edit settings.json to customize the bot's settings:

   {
     "defaultTempReply": 5000,
     "invalidCommand": {
       "enabled": true,
       "timeout": 1,
       "message": "## Woops! How did this happen?\nThis command does not exist! 😅"
     },
     "initMessage": {
       "enabled": true,
       "message": "Nala is ready for liftoff! 🚀"
     },
     "logCommandsInit": true,
     "banCheckTime": 60,
     "alertBanToUser": true,
     "useOpenAIWhisperAPI": false,
     "bugReport": {
       "enabled": true,
       "webhook": ""
     }
   }

Steps

1. Clone the Repository

   git clone https://github.com/Its3rr0rsWRLD/nala.git
   cd nala

2. Run the Bot with Deno

   Use the following command to start the bot:

   deno run --allow-net --allow-env --allow-read src/main.ts

3. Set Up Environment Variables

   Ensure your .env file contains the bot token:

   TOKEN=your_discord_bot_token_here

4. Install Deno Dependencies (Optional)

   If any additional Deno modules are required, install them using:

   deno install [module]

Usage

Starting the Bot

With Node.js

Run the bot using:

npm start

With Deno

deno run --allow-net --allow-env --allow-read src/main.ts

Defining Commands

Place your command files in the commands directory. Each command file should export an object with data and execute properties.

Contributing

We welcome contributions!

1. Fork the Repository

   Click the "Fork" button at the top right of the GitHub page.

2. Create a New Branch

   git checkout -b feature/my-new-feature

3. Make Your Changes

   Add new features, fix bugs, or improve documentation.

4. Commit Your Changes

   git add .
   git commit -m "Add new feature"

5. Push to Your Fork

   git push origin feature/my-new-feature

6. Create a Pull Request

   Go to the original repository and click "New Pull Request". Describe your changes and submit.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

If you have any issues or questions, feel free to open an issue on GitHub or join our Discord server.