# ZyrenAuth – Secure Minecraft Authentication Plugin **ZyrenAuth** is a modern, robust, and privacy-focused authentication plugin for Minecraft 1.21.1+ servers, developed by [_Pheonix](https://pheonix.is-a.dev). It delivers strong account protection and a seamless, intuitive login experience for Paper (Spigot-compatible) environments. 🔗 **[Official Modrinth Page (updates & downloads)](https://modrinth.com/plugin/zyrenauth/versions)** 🔗 **[Official Website & Online Config Generator](https://zyrenauth.wuaze.com/)** --- ## ✨ Key Features - **Mandatory Reverse Word Captcha on Join** Every player must solve a reverse word captcha before login/registration. Fully configurable expiry/attempts and safe void teleport during the challenge. - **Dedicated 2FA Setup GUI** `/za 2fa setup` opens an in-game GUI to display your 2FA secret key and QR code URI, making authenticator setup seamless. - **Focused Authentication Teleportation** After solving captcha, players are teleported to a safe void (`0.5, 0.0, 0.5`) for `/login` or `/register`—no world interaction until auth is done. - **Comprehensive Player State Management** Original location, inventory, gamemode, health, food, experience, and potion effects are saved at auth start and reliably restored after success. - **Asynchronous Modrinth Update Checker** Plugin checks for the latest release version on startup and notifies server owners in the console if an update is available. - **Dynamic On-Screen Prompts** Clear, persistent titles and subtitles for `/register` and `/login` guide users through the process. - **Optional 2FA (Google Authenticator)** Players can enable/disable 2FA; required for their own logins once enabled. - **Smart Player Authentication** - **Online-Mode Servers:** Automatically registers/logs in legitimate Minecraft accounts, with auto-username update. - **Offline-Mode/Alternative Auth:** Registered players are auto-logged in; new players must register for account protection. - **Secure Logins** BCrypt password hashing and robust username validation. - **Flexible Storage** MySQL/MariaDB for scalable persistence. Robust encrypted file-based fallback. - **Optional Email Features** Supports email confirmation and password reset (requires MySQL+SMTP). - **Improved Command Interface** `/za` (alias: `/zyrenauthadmin`) for all admin, status, reload, migrate, delete, and 2FA subcommands. - **Streamlined File Management** All plugin files are organized under `plugins/config/zyrenauth/` for a clean server directory. --- ## 🚀 Supported Platforms - **Paper** (and all compatible forks) 1.21.1+ _Place ZyrenAuth `.jar` in your `plugins/` folder._ --- ## ⚡ Quick Start 1. **Download** the latest version from [Modrinth](https://modrinth.com/plugin/zyrenauth/versions). 2. Put the `.jar` in your server’s `plugins/` folder. 3. Start and stop the server to generate `config.json`. 4. **Easily configure** `config.json` using our [Online Config Generator](https://zyrenauth.wuaze.com/). 5. Restart the server and you're done! --- ## ⚙️ Key Configuration Options - Captcha: `captchaEnabled`, `captchaExpiryMinutes`, `maxCaptchaAttempts` - Password: `minPasswordLength`, `requireDigit`, `requireLowercase`, `requireUppercase`, `requireSpecialChar` - MySQL: `mysqlEnabled`, `mysqlHost`, `mysqlDatabase`, etc. - Email/SMTP: `emailFeaturesEnabled`, `smtpHost`, etc. - See all options at [zyrenauth.wuaze.com](https://zyrenauth.wuaze.com/). --- ## 📜 Commands - `/register ` – Register a new account. - `/login ` – Log into your account. - `/captcha ` – Solve the reverse word captcha. - `/addemail ` – Link an email. - `/emailconfirm ` – Confirm your email. - `/resetpassword` – Request a password reset. - `/resetconfirm ` – Confirm password reset. - `/za help` – Plugin help. - `/za status` – Plugin status (OP only). - `/za reload` – Reload config (OP only). - `/za migrate ` – Migration (OP only). - `/za delete [confirm]` – Delete account (OP only). - `/za 2fa setup|confirm

|disable |status` – Manage 2FA.

---

## 🤝 Support & License

- **Issues/Source:** [https://github.com/Hardik-Verma/ZyrenAuth](https://github.com/Hardik-Verma/ZyrenAuth)
- **License:** MIT
- **By [_Pheonix](https://pheonix.is-a.dev) – Website & app developer**

---

Thank you for choosing ZyrenAuth!

katch0420

katch0420

ZyrenAuth