@tobylai/qmcli 0.0.3 → 0.0.5

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Toby Lai
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,55 @@
1
+ # QMCLI
2
+ English | [简体中文](README_zh_cn.md)
3
+
4
+ A Quick Minecraft Launcher CLI (Work In Progress)
5
+
6
+ ## Installation
7
+ ```bash
8
+ $ npm install -g @tobylai/qmcli
9
+ $ # check the installation
10
+ $ qmcli
11
+ ```
12
+
13
+ ## Usage
14
+ ```bash
15
+ $ qmcli --help
16
+ Usage: qmcli [options] [command]
17
+
18
+ A Quick Minecraft CLI Launcher
19
+
20
+ Options:
21
+ -V, --version output the version number
22
+ -h, --help display help for command
23
+
24
+ Commands:
25
+ versions manage minecraft versions
26
+ settings manage settings
27
+ users add/manage users
28
+ help [command] display help for command
29
+ ```
30
+ ## Features
31
+ many features are still working in progress
32
+
33
+ - versions
34
+ - [X] download minecraft versions
35
+ - [X] launch minecraft
36
+ - [ ] edit minecraft launch settings
37
+ - [ ] java path
38
+ - users
39
+ - [X] add/remove users
40
+ - [X] offline users
41
+ - [ ] mojang users
42
+ - [ ] microsoft users
43
+ - settings
44
+ - [X] change download mirror
45
+ - [X] official
46
+ - [X] bmclapi
47
+ - [X] manage minecraft installation paths
48
+ - [ ] change java path
49
+ - localization
50
+ - [X] support en(English)
51
+ - [ ] support zh_cn(简体中文)
52
+
53
+ ## FAQ
54
+ ### Why the name?
55
+ QMCLI is for **Q**uick **M**ine**C**raft **L**auncher **CL****I**