@woopsy/mcpanel 1.0.0

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 (14) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +151 -0
  3. package/dist/commands/commandRouter.js +525 -0
  4. package/dist/config/configManager.js +193 -0
  5. package/dist/index.js +776 -0
  6. package/dist/managers/backupManager.js +207 -0
  7. package/dist/managers/playitManager.js +450 -0
  8. package/dist/managers/serverManager.js +243 -0
  9. package/dist/services/downloadService.js +176 -0
  10. package/dist/services/processManager.js +242 -0
  11. package/dist/utils/colors.js +73 -0
  12. package/dist/utils/helpers.js +365 -0
  13. package/dist/utils/logger.js +85 -0
  14. package/package.json +67 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Woopsy (https://github.com/Woopsyyy)
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,151 @@
1
+ <p align="center">
2
+ <img src="assets/banner.svg" alt="MCPANEL — Terminal Minecraft Server Manager" width="100%" />
3
+ </p>
4
+
5
+ <p align="center">
6
+ <a href="https://www.npmjs.com/package/@woopsy/mcpanel"><img src="https://img.shields.io/npm/v/@woopsy/mcpanel?color=22c55e&label=npm" alt="npm version"></a>
7
+ <img src="https://img.shields.io/badge/node-%3E%3D22-22c55e" alt="node >=22">
8
+ <img src="https://img.shields.io/badge/platform-WSL%20%7C%20Windows%20%7C%20Linux%20%7C%20macOS-06b6d4" alt="platforms">
9
+ <img src="https://img.shields.io/badge/license-MIT-blue" alt="MIT license">
10
+ </p>
11
+
12
+ # MCPANEL
13
+
14
+ A terminal-based **single-server** Minecraft server manager with an Arch/neofetch-style
15
+ startup screen. Connect one server folder and control it with simple slash commands —
16
+ start/stop, live logs in a separate window, backups, plugins, `server.properties` editing,
17
+ Java switching, and one-click [Playit.gg](https://playit.gg) tunnels so friends can join.
18
+
19
+ ```
20
+ __ __ ____ ____ _ _ _ _____ _
21
+ | \/ |/ ___| _ \ / \ | \ | | ____| |
22
+ | |\/| | | | |_) / _ \ | \| | _| | |
23
+ | | | | |___| __/ ___ \| |\ | |___| |___
24
+ |_| |_|\____|_| /_/ \_\_| \_|_____|_____|
25
+ Minecraft Server Manager
26
+ ──────────────────────────────────────────────────
27
+ path: /home/you/servers/SMP
28
+ type: Fabric 26.1.2
29
+ ram: 4G
30
+ status: Running
31
+ java: 25.0.3
32
+ os: WSL
33
+ tunnel: Online
34
+ ──────────────────────────────────────────────────
35
+ mcpanel>
36
+ ```
37
+
38
+ ---
39
+
40
+ ## Requirements
41
+
42
+ - **Node.js 22+** — <https://nodejs.org>
43
+ - **Java** matching your Minecraft version (e.g. MC 26.x needs **Java 25**, MC 1.20–1.21 needs **Java 21**).
44
+ MCPANEL can list and switch between installed JVMs with `/java`.
45
+
46
+ ---
47
+
48
+ ## Install
49
+
50
+ MCPANEL installs as a global npm command. **However you install it, you run it the same way: type `mcpanel`.**
51
+
52
+ ### 🐧 WSL / Linux / macOS (bash/zsh)
53
+
54
+ ```bash
55
+ npm install -g @woopsy/mcpanel
56
+ mcpanel
57
+ ```
58
+
59
+ If you get `mcpanel: command not found`, your npm global `bin` isn't on `PATH`. Add it:
60
+
61
+ ```bash
62
+ echo 'export PATH="$(npm config get prefix)/bin:$PATH"' >> ~/.bashrc
63
+ source ~/.bashrc
64
+ ```
65
+
66
+ ### 🪟 Windows — Command Prompt (cmd)
67
+
68
+ ```bat
69
+ npm install -g @woopsy/mcpanel
70
+ mcpanel
71
+ ```
72
+
73
+ ### 🪟 Windows — PowerShell
74
+
75
+ ```powershell
76
+ npm install -g "@woopsy/mcpanel"
77
+ mcpanel
78
+ ```
79
+
80
+ > In PowerShell, quote the scoped name (`"@woopsy/mcpanel"`) so the `@` isn't parsed as a splat operator.
81
+
82
+ ### Run without installing (npx)
83
+
84
+ ```bash
85
+ npx @woopsy/mcpanel
86
+ ```
87
+
88
+ ---
89
+
90
+ ## First run
91
+
92
+ 1. Launch `mcpanel`.
93
+ 2. It shows the banner, then asks for your **server folder path** (a folder containing
94
+ `server.jar` and/or `server.properties`). Paste it and press Enter.
95
+ - On WSL you can paste a **Windows path** like `C:\Users\you\Server` — MCPANEL converts
96
+ it to `/mnt/c/...` automatically.
97
+ 3. MCPANEL detects the server type + Minecraft version, saves it, and drops you at the prompt.
98
+
99
+ To connect a different server later: `/sync <path>`.
100
+
101
+ ---
102
+
103
+ ## Commands
104
+
105
+ | Command | What it does |
106
+ |---|---|
107
+ | `/start` · `/stop` · `/restart` | Control the server process |
108
+ | `/console` | Interactive console (type commands sent to the server) |
109
+ | `/log` | Open **live logs in a new terminal window** (`tail -f`) |
110
+ | `/info` | Server path, type, version and status |
111
+ | `/sync <path>` | Connect a different server folder |
112
+ | `/properties` | Edit `server.properties` interactively |
113
+ | `/java [path]` | Show/list installed JVMs, or set the one used to launch |
114
+ | `/stats` | System + server CPU / RAM / disk usage |
115
+ | `/folder` | Open the server folder in your file explorer |
116
+ | `/backup create` · `list` · `restore <id>` | Manage ZIP backups |
117
+ | `/plugins list` · `install <url>` · `remove <name>` | Manage plugins |
118
+ | `/tunnel java` · `bedrock` · `status` · `stop` · `reset` | Playit.gg tunnels |
119
+ | `/config` · `/clear` · `/help` · `/exit` | Utilities |
120
+
121
+ Type `/help` inside MCPANEL for the full menu, and use **Tab** for autocompletion.
122
+
123
+ ---
124
+
125
+ ## Notes
126
+
127
+ - **Single server by design.** MCPANEL manages exactly one server (the one you sync).
128
+ - **Playit tunnel.** The first `/tunnel` claims a free Playit agent in your browser once;
129
+ the binary is downloaded automatically. Your secret is stored locally in `config.json`
130
+ (which is git-ignored — don't commit it).
131
+ - **`/log` in a new window.** On WSL it opens via the Windows console; on Linux it uses your
132
+ terminal emulator; on macOS it uses Terminal. If none is available it falls back to an
133
+ in-place read-only view (`/back` to exit).
134
+
135
+ ---
136
+
137
+ ## Development
138
+
139
+ ```bash
140
+ git clone https://github.com/Woopsyyy/MCPANEL.git
141
+ cd MCPANEL
142
+ npm install
143
+ npm run dev # run from TypeScript (ts-node)
144
+ npm run build # compile to dist/
145
+ ```
146
+
147
+ ---
148
+
149
+ ## License
150
+
151
+ [MIT](LICENSE) © [Woopsy](https://github.com/Woopsyyy)