@zachary_masson/modular-cli
v0.2.8
Published
CLI for modular-core
Readme
🤖 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:
modularThe 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 ModuleNew CommandNew EntityNew EventNew 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
Install the CLI:
npm i -g @zachary_masson/modular-cliInitialize the project:
modularCreate a new module:
modular # Select "New Module"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
- Zachary Masson - Lead Developer - GitHub Profile
📜 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.
