Shield

A modern, robust Discord client modification framework built with security and reliability in mind.

🚀 Features

• Security First: Built with security as the primary focus
• Modern Architecture: Utilizes the latest web technologies and best practices
• Plugin System: Powerful and flexible plugin architecture
• Developer Friendly: Comprehensive documentation and developer tools
• Active Development: Regular updates and community support

📦 Installation

1. Download the latest release from the releases page
2. Follow the installation guide in our documentation

🛠️ Development

Prerequisites

• Node.js 18 or higher
• pnpm 9.7.0 or higher

Setup

# Clone the repository
git clone https://github.com/Jackgawe/Shield.git
cd Shield

# Install dependencies
pnpm install

# Start development
pnpm dev

Project Structure

• packages/ - Core packages and modules
  • shield/ - Main framework
  • shield-ui/ - User interface components
  • shield-docs/ - Documentation
  • shield-assets/ - Static assets
  • shield-defs/ - TypeScript definitions
  • lune/ - Utility library

📚 Documentation

• Getting Started
• Plugin Development
• API Reference

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📝 License

This project is licensed under the CC0-1.0 License - see the LICENSE file for details.

🌟 Acknowledgments

• Original shelter project by uwu.network
• The Discord client modding community
• All our contributors and users
• PS: If shelter wants me to takedown this fork, i'm more than pleased to do so.