Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 2.25 KB

README.md

File metadata and controls

82 lines (60 loc) · 2.25 KB

🤖 Modular CLI

An NPM package that allows you to create a modular Discord bot. Each module handles a distinct functionality, with inter-module capabilities for optimal use.

🌟 Overview

This project provides a CLI to initialize and manage modular Discord bots, making it easy to add commands, entities, events, and buttons.

✨ Features

  • 📦 Easy installation and configuration.
  • 🔧 Modular management of functionalities.
  • ⚙️ Intuitive commands to create modules, commands, entities, events, and buttons.
  • 🔄 Interconnectivity between modules.

🚀 Installation

To install the CLI, use npm:

npm i -g @zachary_masson/modular-cli

🛠️ Usage

Project Initialization

In your project working directory, run the following command to initialize the main files:

modular

The CLI will prompt you to initialize the project, installing all the necessary main files.

Creating New Elements

Once initialization is complete, run modular again to access the following options:

  • New Module
  • New Command
  • New Entity
  • New Event
  • New Button

Creating a New Module

To start correctly, choose New Module to create a module. This will structure your Discord bot into distinct and interconnected functionalities.

📋 Workflow Example

  1. Install the CLI:

    npm i -g @zachary_masson/modular-cli

  2. Initialize the project:

    modular

  3. Create a new module:

     modular
 # Select "New Module"

  4. Add commands, entities, events, and buttons:

    modular
# Select "New Command", "New Entity", "New Event", or "New Button"

🌐 Useful Links

🤝 Contributions

Contributions are welcome! If you have improvement ideas or bugs to report, please submit an issue or a pull request.

👨‍💻 Author

📜 License

This project is licensed under the Apache 2.0. See the LICENSE file for details.

💬 Acknowledgements

  • 🙏 Thanks to all contributors and users of the library.