@minecraft-docker/mcctl 0.1.5 → 1.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.
- package/README.md +81 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# @minecraft-docker/mcctl
|
|
2
|
+
|
|
3
|
+
CLI tool for managing Docker Minecraft servers with mc-router.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Multi-server management** with hostname-based routing
|
|
8
|
+
- **Auto-scaling**: Servers start on connect, stop when idle
|
|
9
|
+
- **Interactive mode**: Guided prompts for all operations
|
|
10
|
+
- **World management**: Assign and release worlds between servers
|
|
11
|
+
- **Backup system**: GitHub-based world backup and restore
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install -g @minecraft-docker/mcctl
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Quick Start
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# Initialize platform in ~/minecraft-servers
|
|
23
|
+
mcctl init
|
|
24
|
+
|
|
25
|
+
# Create a new server (interactive)
|
|
26
|
+
mcctl create
|
|
27
|
+
|
|
28
|
+
# Create with arguments
|
|
29
|
+
mcctl create myserver -t PAPER -v 1.21.1
|
|
30
|
+
|
|
31
|
+
# Check server status
|
|
32
|
+
mcctl status
|
|
33
|
+
|
|
34
|
+
# Start/stop servers
|
|
35
|
+
mcctl start myserver
|
|
36
|
+
mcctl stop myserver
|
|
37
|
+
|
|
38
|
+
# View logs
|
|
39
|
+
mcctl logs myserver
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Commands
|
|
43
|
+
|
|
44
|
+
| Command | Description |
|
|
45
|
+
|---------|-------------|
|
|
46
|
+
| `mcctl init` | Initialize the platform |
|
|
47
|
+
| `mcctl create [name]` | Create a new server |
|
|
48
|
+
| `mcctl delete [name]` | Delete a server |
|
|
49
|
+
| `mcctl status` | Show all server status |
|
|
50
|
+
| `mcctl start <name>` | Start a server |
|
|
51
|
+
| `mcctl stop <name>` | Stop a server |
|
|
52
|
+
| `mcctl logs <name>` | View server logs |
|
|
53
|
+
| `mcctl world list` | List all worlds |
|
|
54
|
+
| `mcctl world assign` | Assign world to server |
|
|
55
|
+
| `mcctl world release` | Release world from server |
|
|
56
|
+
| `mcctl backup push` | Backup worlds to GitHub |
|
|
57
|
+
| `mcctl backup restore` | Restore worlds from backup |
|
|
58
|
+
|
|
59
|
+
## Server Types
|
|
60
|
+
|
|
61
|
+
| Type | Description |
|
|
62
|
+
|------|-------------|
|
|
63
|
+
| `PAPER` | Paper server (default, recommended) |
|
|
64
|
+
| `VANILLA` | Official Minecraft server |
|
|
65
|
+
| `FORGE` | Forge mod server |
|
|
66
|
+
| `FABRIC` | Fabric mod server |
|
|
67
|
+
|
|
68
|
+
## Requirements
|
|
69
|
+
|
|
70
|
+
- Node.js >= 18.0.0
|
|
71
|
+
- Docker & Docker Compose
|
|
72
|
+
- Linux or macOS
|
|
73
|
+
|
|
74
|
+
## Documentation
|
|
75
|
+
|
|
76
|
+
- [Full Documentation](https://smallmiro.github.io/minecraft-server-manager/)
|
|
77
|
+
- [GitHub Repository](https://github.com/smallmiro/minecraft-server-manager)
|
|
78
|
+
|
|
79
|
+
## License
|
|
80
|
+
|
|
81
|
+
Apache-2.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@minecraft-docker/mcctl",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.3.1",
|
|
4
4
|
"description": "CLI tool for managing Docker Minecraft servers with mc-router",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"darwin"
|
|
47
47
|
],
|
|
48
48
|
"dependencies": {
|
|
49
|
-
"@minecraft-docker/shared": "^
|
|
49
|
+
"@minecraft-docker/shared": "^1.3.1",
|
|
50
50
|
"@clack/prompts": "^0.8.0",
|
|
51
51
|
"picocolors": "^1.1.0"
|
|
52
52
|
},
|