# Pluginator Built with Bun TypeScript Ink React CLI License Platform A powerful Minecraft server plugin manager with multi-source update checking, sync/backup workflows, and a modern terminal UI. ## Features ### Core - **Multi-Source Updates** — Check updates from Spigot, Modrinth, GitHub, Hangar, Jenkins, GeyserMC, Voxel, BuiltByBit, and custom web manifests (9 source types) - **Server Sync** — Synchronize plugins between production and test servers - **Smart Backups** — Timestamped tar.gz backups with automatic cleanup, atomic writes, and crash recovery - **Modern Terminal UI** — Interactive, keyboard-driven interface with 8 tabs and customizable themes - **Plugin Registry** — 120+ popular plugins pre-configured with verified sources - **Checksum Verification** — SHA-256 verification for all downloads ### Update Automation - **Hash-Based Identification** — Fingerprints each plugin JAR to identify it precisely across sources, even with no version in the filename - **Premium Plugin Support** — Version checks and store deep-links for paid plugins; `pluginator complete` installs a browser-downloaded update from your Downloads folder, ToS-safely - **Test → Production Promotion** — Updates soak on your test server before `pluginator promote` moves them to production; bad updates can be quarantined - **Snapshots & Rollback** — Automatic JAR + data-folder snapshot before every update; `pluginator rollback ` fully restores a previous version - **Safe Live-Server Updates** — Stages updates into Bukkit's `plugins/update/` folder when the server is running, applied on next restart - **Scheduled / Unattended Updates** — Headless `auto-update` for cron/systemd with JSON output, CI exit codes, and Discord/webhook notifications - **Compatibility Gates** — Checks each update against your server's Minecraft and Java version before installing - **Off-Market Plugin Manifests** — Track plugins from any source via a simple JSON manifest (`pluginator manifest`) ### Health & Recommendations - **Health Dashboard** — 5-component health scoring (compatibility, security, version, maintenance, dependencies) with A+/F grading - **Recommendations Engine** — Smart plugin recommendations based on your setup - **Superseded-By Advisories** — Abandoned plugins suggest a maintained replacement instead of showing "up to date" forever ### Organization & Workflows - **Tags & Groups** — Organize plugins with custom tags and groups - **Profiles** — Save and switch between different plugin configurations - **Data Import/Export** — Export and import plugin configurations - **Plugin Notes** — Attach notes to individual plugins - **Notification History** — Persistent toast log accessible via `/notifications` - **Post-Action Hooks** — Run user-configured shell commands after sync/download/backup/migrate ### Power-User - **Command Palette** — 80+ commands accessible via `:` or `/` with fuzzy search - **Vim Mode** — Optional modal navigation (Plus+) with motions, marks, search, and macros - **Jump List** — `Ctrl+o` / `Ctrl+i` to navigate between recent positions - **Quick Actions** — `Ctrl+P` for context-aware quick actions - **Custom Keybindings** — 5 presets (default, vim, emacs, minimal, custom) with full inheritance ### Security - **SSRF Protection** — Blocks private-IP and metadata-endpoint URLs by default - **Atomic File Writes** — Crash-safe writes for cache, config, and journal files - **Operation Journal** — Records destructive operations with crash recovery on next launch - **PID Locks** — File-based exclusive locks prevent concurrent operations ## Installation ### Download Binary | Platform | Download | |----------|----------| | Windows (x64) | [pluginator-windows-x64.zip](https://github.com/NindroidA/pluginator/releases/latest) | | macOS (Intel) | [pluginator-darwin-x64.tar.gz](https://github.com/NindroidA/pluginator/releases/latest) | | macOS (Apple Silicon) | [pluginator-darwin-arm64.tar.gz](https://github.com/NindroidA/pluginator/releases/latest) | | Linux (x64) | [pluginator-linux-x64.tar.gz](https://github.com/NindroidA/pluginator/releases/latest) | | Linux (ARM64) | [pluginator-linux-arm64.tar.gz](https://github.com/NindroidA/pluginator/releases/latest) | ### Quick Install ```bash # macOS (Homebrew) brew tap NindroidA/pluginator && brew install pluginator # Windows (Scoop) scoop bucket add pluginator https://github.com/NindroidA/scoop-pluginator && scoop install pluginator # npm (any platform) npm install -g @nindroidsystems/pluginator # Bun (any platform) bun install -g @nindroidsystems/pluginator # curl | bash (Linux/macOS) curl -fsSL https://raw.githubusercontent.com/NindroidA/pluginator/main/scripts/install.sh | bash ``` See [Installation Guide](docs/INSTALLATION.md) for detailed instructions. ## Quick Start ```bash # Initialize configuration pluginator setup # Launch interactive UI pluginator # Or use CLI commands pluginator scan --prod # Scan production server pluginator check-updates # Check for plugin updates pluginator auto-update # Scan, check, and download updates to test pluginator complete # Finish a premium update from your Downloads folder pluginator promote --list # See what's soaking / ready to promote to prod pluginator rollback # Restore a plugin's previous version pluginator sync # Sync prod to test pluginator self-update # Update Pluginator itself ``` ## Keyboard Shortcuts | Key | Action | |-----|--------| | `1-8` | Switch tabs (Home/Servers/Plugins/Updates/Logs/Stats/Health/Recs) | | `:` or `/` | Open command palette (80+ commands) | | `Ctrl+P` | Quick actions menu | | `Ctrl+O` / `Ctrl+I` | Jump back/forward (history) | | `j` / `k` or `↑` / `↓` | Navigate lists | | `g` / `G` | Jump to top/bottom | | `?` | Show help | | `Ctrl+C` (2x) | Quit | ## Tier System | Tier | Price | Update Checks/Day | Downloads/Day | Tabs | |------|-------|---|---|---| | Free | $0 | 1 | 5 | Home/Plugins/Updates only | | Plus | $9.99 (one-time) | 50 | 25 | + Servers/Logs/Stats | | Pro | $2.99/mo or $24.99/yr | 100 | 50 | + Health/Recs, scheduling, promotion, vim mode | | Max | $4.99/mo or $44.99/yr | Unlimited | Unlimited | All features, priority support | Plus owners get discounted upgrades ($1.99/mo Pro, $3.99/mo Max). See [Tier System](docs/TIER_SYSTEM.md) for full details. ## Documentation - [Installation](docs/INSTALLATION.md) — Quick install for all platforms - [User Guide](docs/USER_GUIDE.md) — Complete usage documentation - [Commands Reference](docs/COMMANDS.md) — Full command palette reference - [Plugin Registry](docs/PLUGIN_REGISTRY.md) — Curated plugin database - [Tier System](docs/TIER_SYSTEM.md) — Subscription tiers and features - [Troubleshooting](docs/TROUBLESHOOTING.md) — Common issues and fixes - [Error Codes](docs/ERROR_CODES.md) — Error code reference (PLG-NNNN) - [Security](docs/SECURITY.md) — Security policy and reporting - [Changelog](docs/CHANGELOG.md) — Version history ## Support - **Bug Reports:** [Open an issue](https://github.com/NindroidA/pluginator/issues/new?template=bug-report.yml) - **Feature Requests:** [Open an issue](https://github.com/NindroidA/pluginator/issues/new?template=feature-request.yml) - **General Feedback:** [Open an issue](https://github.com/NindroidA/pluginator/issues/new?template=general-feedback.yml) - **Plugin Partnerships:** [Partnership request](https://github.com/NindroidA/pluginator/issues/new?template=plugin-developer-request.yml) ## Development This project's development has been accelerated through the use of AI-assisted development tools, including GitHub Copilot, Claude Code, and other AI programming assistants. These tools have enhanced productivity while maintaining code quality and best practices. All AI-generated code has been reviewed, tested, and refined to ensure reliability. ## License Copyright (c) 2026 Nindroid Systems (Andrew Curtis - NindroidA). All Rights Reserved. This is proprietary software. See [LICENSE](LICENSE) for details.