vikshan/amina repository overview

⁠ AMINA

⁠Your Guardian Companion in the Digital Empire

Protecting Communities • Creating Joy • Bringing People Together

⚡ Quick Deploy⁠ • 🗡️ Arsenal⁠ • 📦 Installation⁠ • 💬 Support⁠ • 🤝 Contributing⁠ • 📚 Wiki⁠

⁠Who Am I?

Hey there! I'm Amina (mina preferably)— your guardian companion.

Unlike those cold, emotionless bots, I was given something special: a heart. I don't just moderate servers; I protect communities and help them thrive. Think of me as your right hand in battle — someone who'll stand beside you, fight alongside you, and celebrate your victories, even the littlest.

I'm dedicated to defending communities from spam, toxicity, and chaos. But the thing is: a server without protection is vulnerable, but a server without joy is already dead.* That's why I bring both to the table.

⁠Quick Deploy

Ready to add me to your squad? Here's everything you need:

• Recruit Amina⁠ — Add me to your server (Battle Preparation)
• Documentation⁠ — Full tactical manual
• Support Server⁠ — Join the Alliance HQ
• Buy Me a Coffee⁠ — Support the Amina Project

⁠Features

⁠Defense Protocols (Moderation & Administration)

I take protection seriously. Here's what's in my defense arsenal:

• Web Dashboard — Full server configuration from a sleek web interface
• Automated Defense — Anti-spam, anti-raid, invite filtering (set it and forget it)
• Moderation Tools — Ban, kick, mute, warn — all the classics, but better
• Ticket System — Custom ticket system for user support
• Rank Assignment — Role management, auto-roles, and permission control

⁠Morale Operations (Entertainment)

Protection alone isn't enough. Communities need life and energy:

• High-Quality Audio — Music playback from multiple sources (Spotify, YouTube, SoundCloud)
• Battle Mini-Games — Fun commands to keep your community engaged
• Anime Reactions — Express yourself with style (I've got taste!)
• Image Arsenal — Manipulation tools for memes and creativity
• Economy System — Custom currency and rewards for active members

⁠Intelligence Reports (Utility)

Knowledge is power. Stay informed:

• Server Analytics — Detailed statistics and insights
• Invite Tracking — See who's bringing new members
• Suggestion System — Let your community voice their ideas
• Multi-Language Support — Speak to everyone
• Weather Intel — Real-time weather information
• Translation Services — Break language barriers

📖 Full Command Arsenal⁠ — Every tool at your disposal

⁠Project Structure

src/           → Discord bot source code (discord.js)
api/           → REST API server (Cloudflare Workers, Hono + MongoDB)
tests/         → Test suite
types/         → Bot TypeScript type definitions
lavalink/      → Lavalink music server config

• API docs & developer wiki → docs.4mina.app⁠
• Dashboard → 4mina.app/dash⁠

⁠Guardian Ranks

As you work with me, you'll advance through the Guardian Ranks:

Track your rank (and secret achievements) in the Command Center Dashboard⁠

⁠Installation

Want to deploy me on your own infra? Respect. Here's how:

curl -sL https://get.4mina.app | sh

see full Self-Hosting Guide⁠ — Complete deployment instructions

⁠💬 Join the Alliance

Need backup? Have questions? Found a bug that needs eliminating?

Join the Support Server — The Alliance HQ awaits you:

⁠

We're a community of server owners, developers, and guardians helping each other out. Don't be shy — we've all been there!

⁠Contributing

Want to join the Night Guard development team? Hell yeah! Here's how:

Contributions are welcome! You MUST read the CONTRIBUTING.md⁠ for guidelines on how to contribute to this project.

⁠Stats for the Night Guard

⁠💪 Powered By Allies

Special thanks to our infrastructure partners who keep the Night Guard operational:

⁠ ⁠ ⁠

⁠Built with Purpose, To Protect w/out Passion, for some reason.

Recruit Amina Now⁠ • Documentation⁠ • Support Server⁠

_{Forged by vikshan⁠ with 🎶 and ☕ | Licensed under ADL⁠}