@nindroidsystems/pluginator 2.3.0 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +71 -208
  2. package/dist/cli.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,43 +1,49 @@
1
1
  # Pluginator
2
2
 
3
- [![Proprietary](https://img.shields.io/badge/license-Proprietary-red.svg)](LICENSE)
4
- [![Bun](https://img.shields.io/badge/runtime-Bun-black)](https://bun.sh)
5
- [![TypeScript](https://img.shields.io/badge/language-TypeScript-blue)](https://www.typescriptlang.org/)
3
+ <a href="https://bun.sh" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Built%20with-Bun-f9f1e1?logo=bun&logoColor=f9f1e1&labelColor=14151a" alt="Built with Bun"></a>
4
+ <a href="https://www.typescriptlang.org/" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/TypeScript-5.0-3178c6?logo=typescript&logoColor=white" alt="TypeScript"></a>
5
+ <a href="https://github.com/vadimdemedes/ink" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/Ink-React%20CLI-61dafb?logo=react&logoColor=white" alt="Ink React CLI"></a>
6
+ <a href="LICENSE"><img src="https://img.shields.io/badge/License-Proprietary-red" alt="License"></a>
7
+ <img src="https://img.shields.io/badge/Platform-Windows%20%7C%20macOS%20%7C%20Linux-blue" alt="Platform">
6
8
 
7
- > **Last Updated:** February 20, 2026
8
-
9
- A sophisticated Minecraft server plugin manager with multi-source update checking, sync/backup workflows, and a modern terminal UI.
9
+ A powerful Minecraft server plugin manager with multi-source update checking, sync/backup workflows, and a modern terminal UI.
10
10
 
11
11
  ## Features
12
12
 
13
- ### Core Features
14
- - **Multi-Source Support** - Check updates from Spigot, Modrinth, GitHub, CurseForge, Hangar, Jenkins, and custom web manifests
15
- - **Server Sync** - Synchronize plugins between production and test servers
16
- - **Smart Backups** - Create timestamped tar.gz backups with automatic cleanup
17
- - **Modern Terminal UI** - Interactive, keyboard-driven interface with 9 tabs and customizable themes
18
- - **Plugin Scanning** - Extract metadata from JAR files automatically
19
- - **Checksum Verification** - SHA-256 verification for all downloads
20
- - **Parallel Updates** - Check multiple plugins concurrently
21
- - **Plugin Registry** - 100+ popular plugins pre-configured with verified sources
22
- - **Tier System** - Free, Plus, Pro, and Max tiers with usage-based limits
23
- - **Auto-Updater** - Automatic update checking with one-command updates
24
-
25
- ### Analytics & Health (v2.0)
26
- - **Health Dashboard** - Plugin health scoring based on compatibility, security, and update status
27
- - **Performance Analytics** - Server performance monitoring with metrics collection and alerts
28
- - **Recommendations Engine** - Smart plugin recommendations based on your setup and usage patterns
29
- - **Server Panel Integrations** - Connect to AMP, Pterodactyl, Crafty Controller, and MCSManager
30
-
31
- ### Organization & Workflows (v2.0)
32
- - **Plugin Templates** - Apply pre-configured plugin bundles for different server types
33
- - **Widget Dashboard** - Customizable dashboard with health, analytics, and streaming widgets
34
- - **Tags & Groups** - Organize plugins with custom tags and groups
35
- - **Profiles** - Save and switch between different plugin configurations
36
- - **Scheduled Updates** - Configure automatic update windows with major version handling
37
- - **Data Import/Export** - Export and import plugin configurations
13
+ ### Core
14
+ - **Multi-Source Updates** — Check updates from Spigot, Modrinth, GitHub, CurseForge, Hangar, Jenkins, and custom web manifests
15
+ - **Server Sync** — Synchronize plugins between production and test servers
16
+ - **Smart Backups** — Timestamped tar.gz backups with automatic cleanup
17
+ - **Modern Terminal UI** — Interactive, keyboard-driven interface with 9 tabs and customizable themes
18
+ - **Plugin Registry** — 100+ popular plugins pre-configured with verified sources
19
+ - **Auto-Updater** — Automatic update checking with one-command updates
20
+ - **Checksum Verification** — SHA-256 verification for all downloads
21
+
22
+ ### Analytics & Health
23
+ - **Health Dashboard** — Plugin health scoring based on compatibility, security, and update status
24
+ - **Performance Analytics** — Server performance monitoring with metrics and alerts
25
+ - **Recommendations Engine** — Smart plugin recommendations based on your setup
26
+ - **Server Panel Integrations** — Connect to AMP, Pterodactyl, Crafty Controller, and MCSManager
27
+
28
+ ### Organization & Workflows
29
+ - **Tags & Groups** — Organize plugins with custom tags and groups
30
+ - **Profiles** — Save and switch between different plugin configurations
31
+ - **Scheduled Updates** — Configure automatic update windows with major version handling
32
+ - **Data Import/Export** — Export and import plugin configurations
33
+ - **Widget Dashboard** — Customizable dashboard with health, analytics, and streaming widgets
38
34
 
39
35
  ## Installation
40
36
 
37
+ ### Download Binary
38
+
39
+ | Platform | Download |
40
+ |----------|----------|
41
+ | Windows (x64) | [pluginator-windows-x64.zip](https://github.com/NindroidA/pluginator/releases/latest) |
42
+ | macOS (Intel) | [pluginator-darwin-x64.tar.gz](https://github.com/NindroidA/pluginator/releases/latest) |
43
+ | macOS (Apple Silicon) | [pluginator-darwin-arm64.tar.gz](https://github.com/NindroidA/pluginator/releases/latest) |
44
+ | Linux (x64) | [pluginator-linux-x64.tar.gz](https://github.com/NindroidA/pluginator/releases/latest) |
45
+ | Linux (ARM64) | [pluginator-linux-arm64.tar.gz](https://github.com/NindroidA/pluginator/releases/latest) |
46
+
41
47
  ### Quick Install
42
48
 
43
49
  ```bash
@@ -59,171 +65,34 @@ curl -fsSL https://pluginator.dev/install.sh | bash
59
65
 
60
66
  See [Installation Guide](docs/INSTALLATION.md) for detailed instructions.
61
67
 
62
- ### Prerequisites (npm/Bun install only)
63
-
64
- - [Bun](https://bun.sh) v1.1.0 or higher (or Node.js 18+)
65
-
66
- ## Usage
67
-
68
- ### Interactive Mode (Default)
69
-
70
- ```bash
71
- pluginator
72
- ```
73
-
74
- This launches the interactive terminal UI with tab-based navigation.
75
-
76
- #### Keyboard Shortcuts
77
-
78
- Pluginator uses a state-aware input system (v1.4.0) for consistent behavior.
79
-
80
- | Key | Action | Notes |
81
- |-----|--------|-------|
82
- | `Tab` / `Shift+Tab` | Navigate between tabs | |
83
- | `1-9` | Jump to tab | Home/Servers/Plugins/Updates/Logs/Sync/Health/Recs/Perf |
84
- | `j` / `↓` | Move down in lists | |
85
- | `k` / `↑` | Move up in lists | |
86
- | `g` / `G` | Jump to top/bottom | |
87
- | `Ctrl+C` | Quit (press twice) | 2s timeout |
88
- | `Ctrl+D` | Jump to Logs | Quick access |
89
- | `?` | Show help | |
90
- | `r` | Refresh | Home tab only |
91
- | `s` | Scan servers | Home tab only, throttled 500ms |
92
- | `u` | Check updates | Home tab only, throttled 1000ms |
93
- | `b` | Quick backup | Home tab only |
94
- | `c` | View changelog | In Updates view |
95
- | `Space` | Toggle selection | |
96
- | `Enter` | Confirm | |
97
- | `Esc` | Cancel | Context-aware |
98
- | `/` or `:` | Open command palette | 25+ commands |
99
-
100
- Keys are validated against the current UI state to prevent accidental actions during operations.
101
-
102
- ## CLI Commands
68
+ ## Quick Start
103
69
 
104
70
  ```bash
105
- # Setup wizard
71
+ # Initialize configuration
106
72
  pluginator setup
107
73
 
108
- # Sync plugins from production to test
109
- pluginator sync
110
-
111
- # Migrate plugins from test to production
112
- pluginator migrate
113
-
114
- # Create a backup
115
- pluginator backup
116
-
117
- # Check for updates
118
- pluginator check-updates
119
- ```
120
-
121
- ## Configuration
122
-
123
- Configuration file: `config/pluginator.config`
124
-
125
- ```ini
126
- # Debug mode (0 = off, 1 = on)
127
- PLUGINATOR_DEBUG=0
128
-
129
- # Server paths
130
- PROD_SERVER_PATH=./SERVER/prod
131
- TEST_SERVER_PATH=./SERVER/test
132
-
133
- # Backup settings
134
- BACKUP_DIR=./data/backups
135
- MAX_BACKUPS=5
136
-
137
- # Logging
138
- LOGS_DIR=./data/logs
139
- MAX_LOG_DAYS=30
140
-
141
- # Minecraft version for compatibility checks
142
- MINECRAFT_VERSION=1.21.1
143
-
144
- # Network settings
145
- API_TIMEOUT=30
146
- DOWNLOAD_THREADS=2
147
- ```
148
-
149
- ## Plugin Sources
150
-
151
- Pluginator supports multiple plugin sources:
152
-
153
- | Source | API | Rate Limit |
154
- |--------|-----|------------|
155
- | Spigot | Spiget API v2 | ~100 req/min |
156
- | Modrinth | Modrinth API v2 | 300 req/min |
157
- | GitHub | GitHub API v3 | 60/hr (unauth), 5000/hr (auth) |
158
- | CurseForge | CurseForge API | Requires API key |
159
- | Jenkins | Jenkins REST API | Server-dependent |
160
- | Hangar | Hangar API v1 | Generous |
161
- | Web Manifest | Custom JSON | Unlimited |
162
-
163
- ## Theming
164
-
165
- Choose from four built-in color themes: `default`, `ocean`, `forest`, `sunset`
166
-
167
- ```bash
168
- pluginator --theme ocean
169
- ```
170
-
171
- Or set in `~/.pluginator/config.json`:
172
- ```json
173
- { "theme": "ocean" }
174
- ```
175
-
74
+ # Launch interactive UI
75
+ pluginator
176
76
 
177
- ## Plugin Configuration
178
-
179
- Plugins are configured in `plugins.json`:
180
-
181
- ```json
182
- {
183
- "plugins": [
184
- {
185
- "name": "EssentialsX",
186
- "type": "spigot",
187
- "resourceId": "9089"
188
- },
189
- {
190
- "name": "LuckPerms",
191
- "type": "modrinth",
192
- "projectSlug": "luckperms"
193
- },
194
- {
195
- "name": "Vault",
196
- "type": "github",
197
- "repoSlug": "MilkBowl/Vault"
198
- }
199
- ]
200
- }
77
+ # Or use CLI commands
78
+ pluginator scan --prod # Scan production server
79
+ pluginator check-updates # Check for plugin updates
80
+ pluginator sync # Sync prod to test
201
81
  ```
202
82
 
203
- ### Plugin Types
204
-
205
- | Type | Required Fields | Description |
206
- |------|-----------------|-------------|
207
- | `spigot` | `resourceId` | Spiget resource ID |
208
- | `modrinth` | `projectSlug` | Modrinth project slug |
209
- | `github` | `repoSlug` | GitHub owner/repo format |
210
- | `bukkit` | `id` | CurseForge project ID |
211
- | `web` | `sourceUrl` | Custom manifest URL |
212
- | `jenkins` | `job` | Jenkins job name |
213
- | `manual` | - | Manual updates only |
83
+ ## Keyboard Shortcuts
214
84
 
215
- ### Optional Plugin Fields
216
-
217
- - `version` - Current installed version
218
- - `enabled` - Enable/disable plugin (default: true)
219
- - `disableOnTest` - Disable when synced to test server
220
- - `mcVersion` - Target Minecraft version
221
- - `filenamePattern` - Regex for JAR filename matching
85
+ | Key | Action |
86
+ |-----|--------|
87
+ | `1-9` | Switch tabs (Home/Servers/Plugins/Updates/Logs/Stats/Health/Recs/Perf) |
88
+ | `:` or `/` | Open command palette (25+ commands) |
89
+ | `j` / `k` or `↑` / `↓` | Navigate lists |
90
+ | `g` / `G` | Jump to top/bottom |
91
+ | `?` | Show help |
92
+ | `Ctrl+C` (2x) | Quit |
222
93
 
223
94
  ## Tier System
224
95
 
225
- Pluginator offers tiered subscriptions for different usage levels:
226
-
227
96
  | Tier | Price | Checks/Day | Downloads/Day |
228
97
  |------|-------|------------|---------------|
229
98
  | Free | $0 | 10 | 5 |
@@ -235,34 +104,28 @@ See [Tier System](docs/TIER_SYSTEM.md) for details.
235
104
 
236
105
  ## Documentation
237
106
 
238
- ### Getting Started
239
- - [Installation](docs/INSTALLATION.md) - Quick install for all platforms
240
- - [User Guide](docs/USER_GUIDE.md) - Detailed usage instructions
241
- - [Commands Reference](docs/COMMANDS.md) - Full command palette reference
107
+ - [Installation](docs/INSTALLATION.md) — Quick install for all platforms
108
+ - [User Guide](docs/USER_GUIDE.md) — Complete usage documentation
109
+ - [Commands Reference](docs/COMMANDS.md) — Full command palette reference
110
+ - [Plugin Registry](docs/PLUGIN_REGISTRY.md) — Curated plugin database
111
+ - [Tier System](docs/TIER_SYSTEM.md) — Subscription tiers and features
112
+ - [Error Codes](docs/ERROR_CODES.md) — Error code reference (PLG-NNNN)
113
+ - [Security](docs/SECURITY.md) — Security policy and reporting
114
+ - [Changelog](docs/CHANGELOG.md) — Version history
242
115
 
243
- ### Features
244
- - [Health System](docs/HEALTH_SYSTEM.md) - Plugin health scoring and dashboard
245
- - [Analytics](docs/ANALYTICS.md) - Performance monitoring and alerts
246
- - [Templates](docs/TEMPLATES.md) - Plugin configuration templates
247
- - [Organization](docs/ORGANIZATION.md) - Tags, groups, profiles, and favorites
116
+ ## Support
248
117
 
249
- ### Reference
250
- - [Architecture](docs/ARCHITECTURE.md) - System design and component overview
251
- - [Plugin Registry](docs/PLUGIN_REGISTRY.md) - Using the curated plugin database
252
- - [Tier System](docs/TIER_SYSTEM.md) - Subscription tiers and authentication
253
- - [File Organization](docs/FILE_ORGANIZATION.md) - Where files are stored
254
- - [Auto-Updater](docs/AUTO_UPDATER.md) - Keeping Pluginator up to date
255
- - [Security](docs/SECURITY.md) - Security considerations and best practices
256
- - [Changelog](docs/CHANGELOG.md) - Version history
118
+ - **Bug Reports:** [Open an issue](https://github.com/NindroidA/pluginator/issues/new?template=bug-report.yml)
119
+ - **Feature Requests:** [Open an issue](https://github.com/NindroidA/pluginator/issues/new?template=feature-request.yml)
120
+ - **General Feedback:** [Open an issue](https://github.com/NindroidA/pluginator/issues/new?template=general-feedback.yml)
121
+ - **Plugin Partnerships:** [Partnership request](https://github.com/NindroidA/pluginator/issues/new?template=plugin-developer-request.yml)
257
122
 
258
- ## Contributing
123
+ ## Development
259
124
 
260
- See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
125
+ 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.
261
126
 
262
127
  ## License
263
128
 
264
- [Proprietary](LICENSE) - Copyright (c) 2026 Nindroid Systems (Andrew Curtis)
265
-
266
- ## Development
129
+ Copyright (c) 2026 Nindroid Systems (Andrew Curtis - NindroidA). All Rights Reserved.
267
130
 
268
- 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.
131
+ This is proprietary software. See [LICENSE](LICENSE) for details.
package/dist/cli.js CHANGED
@@ -2359,7 +2359,7 @@ var require_commander = __commonJS((exports) => {
2359
2359
  });
2360
2360
 
2361
2361
  // package.json
2362
- var version = "2.3.0", package_default;
2362
+ var version = "2.3.1", package_default;
2363
2363
  var init_package = __esm(() => {
2364
2364
  package_default = {
2365
2365
  name: "@nindroidsystems/pluginator",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nindroidsystems/pluginator",
3
- "version": "2.3.0",
3
+ "version": "2.3.1",
4
4
  "description": "A sophisticated Minecraft server plugin manager with multi-source update checking, sync/backup workflows, and a modern terminal UI",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",