shadow-core/README.md

A modular core framework for Discord bot development, providing commands, buttons, menus, middleware, and more.

# ShadowCore  

ShadowCore is a **modular core framework** for Discord bot development. It provides a streamlined system for **commands, events, buttons, menus, middleware execution, API requests, and more**, making bot development faster and more efficient.

![GitHub issues](https://img.shields.io/github/issues/Shadows-Development/ShadowCore?style=flat-square)  
![GitHub forks](https://img.shields.io/github/forks/Shadows-Development/ShadowCore?style=flat-square)  
![GitHub stars](https://img.shields.io/github/stars/Shadows-Development/ShadowCore?style=flat-square)  
![GitHub license](https://img.shields.io/github/license/Shadows-Development/ShadowCore?style=flat-square)  
![npm version](https://img.shields.io/npm/v/shadow-core?style=flat-square)  

## 📖 Documentation
The full documentation for ShadowCore can be found at:  
➡️ [ShadowCore Documentation](https://docs.shadowdevelopment.net/shadowcore)

## 🌟 Features
- 🚀 **Modular Command System** - Auto-loads commands from categorized folders.
- 🎛 **Dynamic Button & Menu Handling** - Supports dynamic custom IDs (`feature:action:{id}`). 
- 🛠 **Middleware Support** - Allows pre/post-execution logic for commands.
- ⏳ **Rate Limiting & Cooldowns** - Prevents spam and abuse.
- 🌐 **API Utility with Axios** - Simplifies external API requests.
- 📜 **Logging with Loki** - Built-in structured logging.
- ⏰ **Task Scheduler** - Run background tasks automatically.

## 🚀 Getting Started
Check out the [Getting Started Guide](https://docs.shadowdevelopment.net/shadowcore/getting-started) for a step-by-step setup process.

## 📜 License
This project is licensed under the **GNU General Public License v3.0**. See the [LICENSE](LICENSE) file for details.

## 🤝 Contributing
1. **Fork the repository** on GitHub.
2. **Clone your fork** to your local machine:
   ```bash
   git clone https://github.com/Shadows-Development/ShadowCore.git
   ```
3. **Create a new branch** for your changes:
   ```bash
   git checkout -b feat/new-functionality
   ```
4. **Make changes** and commit them:
   ```bash
   git commit -m "Added new feature"
   ```
5. **Push the branch** and create a pull request:
   ```bash
   git push origin feat/new-functionality
   ```
6. **Submit a pull request** on GitHub and wait for review.

## 🌎 Community & Support
- **GitHub Issues** - Report bugs & request features.