dpmcl 26.1__tar.gz

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 (38) hide show
  1. dpmcl-26.1/LICENSE +21 -0
  2. dpmcl-26.1/MANIFEST.in +11 -0
  3. dpmcl-26.1/PKG-INFO +307 -0
  4. dpmcl-26.1/README.md +282 -0
  5. dpmcl-26.1/dpmcl/__init__.py +64 -0
  6. dpmcl-26.1/dpmcl/__main__.py +6 -0
  7. dpmcl-26.1/dpmcl/_internal/__init__.py +24 -0
  8. dpmcl-26.1/dpmcl/_internal/accounts.py +601 -0
  9. dpmcl-26.1/dpmcl/_internal/assets.py +286 -0
  10. dpmcl-26.1/dpmcl/_internal/config.py +586 -0
  11. dpmcl-26.1/dpmcl/_internal/install.py +1116 -0
  12. dpmcl-26.1/dpmcl/_internal/java.py +673 -0
  13. dpmcl-26.1/dpmcl/_internal/launch.py +745 -0
  14. dpmcl-26.1/dpmcl/_internal/libraries.py +309 -0
  15. dpmcl-26.1/dpmcl/_internal/mods.py +312 -0
  16. dpmcl-26.1/dpmcl/_internal/net.py +407 -0
  17. dpmcl-26.1/dpmcl/_internal/options.py +137 -0
  18. dpmcl-26.1/dpmcl/_internal/progress.py +202 -0
  19. dpmcl-26.1/dpmcl/_internal/rules.py +131 -0
  20. dpmcl-26.1/dpmcl/_internal/util.py +352 -0
  21. dpmcl-26.1/dpmcl/_internal/version.py +331 -0
  22. dpmcl-26.1/dpmcl/accounts.py +25 -0
  23. dpmcl-26.1/dpmcl/api.py +613 -0
  24. dpmcl-26.1/dpmcl/cli.py +2198 -0
  25. dpmcl-26.1/dpmcl/config.py +74 -0
  26. dpmcl-26.1/dpmcl/constants.py +23 -0
  27. dpmcl-26.1/dpmcl/engine.py +27 -0
  28. dpmcl-26.1/dpmcl/errors.py +33 -0
  29. dpmcl-26.1/dpmcl/i18n.py +178 -0
  30. dpmcl-26.1/dpmcl.egg-info/PKG-INFO +307 -0
  31. dpmcl-26.1/dpmcl.egg-info/SOURCES.txt +36 -0
  32. dpmcl-26.1/dpmcl.egg-info/dependency_links.txt +1 -0
  33. dpmcl-26.1/dpmcl.egg-info/entry_points.txt +2 -0
  34. dpmcl-26.1/dpmcl.egg-info/requires.txt +4 -0
  35. dpmcl-26.1/dpmcl.egg-info/top_level.txt +1 -0
  36. dpmcl-26.1/main.py +6 -0
  37. dpmcl-26.1/pyproject.toml +39 -0
  38. dpmcl-26.1/setup.cfg +4 -0
dpmcl-26.1/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 dianbtcmputr
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.
dpmcl-26.1/MANIFEST.in ADDED
@@ -0,0 +1,11 @@
1
+ include README.md
2
+ include LICENSE
3
+ include pyproject.toml
4
+ include main.py
5
+
6
+ recursive-exclude * __pycache__
7
+ recursive-exclude * *.py[cod]
8
+ prune .minecraft
9
+ exclude launcher.json
10
+ exclude accounts.json
11
+ exclude _e2e_summary.txt
dpmcl-26.1/PKG-INFO ADDED
@@ -0,0 +1,307 @@
1
+ Metadata-Version: 2.4
2
+ Name: dpmcl
3
+ Version: 26.1
4
+ Summary: Minecraft: Java Edition command-line launcher with a progress-callback library API
5
+ Author: dianbtcmputr
6
+ License-Expression: MIT
7
+ Keywords: minecraft,launcher,fabric,forge,neoforge,quilt
8
+ Classifier: Development Status :: 4 - Beta
9
+ Classifier: Environment :: Console
10
+ Classifier: Intended Audience :: End Users/Desktop
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3.10
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
16
+ Classifier: Programming Language :: Python :: 3.13
17
+ Classifier: Topic :: Games/Entertainment
18
+ Requires-Python: >=3.10
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: requests>=2.28
22
+ Provides-Extra: clipboard
23
+ Requires-Dist: pyperclip>=1.8; extra == "clipboard"
24
+ Dynamic: license-file
25
+
26
+ # DPMCL
27
+
28
+ DPMCL 是一个使用纯 Python 编写的 Minecraft: Java Edition 命令行启动器,支持原版、Fabric、Quilt、Forge 与 NeoForge 的安装、管理和启动。
29
+
30
+ 核心逻辑位于 `dpmcl/` 公共库包中,`main.py` 仅提供命令行入口;库的调用方式见“库 API”一节。
31
+
32
+ ## 安装
33
+
34
+ 发布版本:
35
+
36
+ ```bash
37
+ pip install dpmcl
38
+ # 可选:启用设备码自动复制到剪贴板
39
+ pip install "dpmcl[clipboard]"
40
+ dpmcl
41
+ ```
42
+
43
+ 从源码安装或直接运行:
44
+
45
+ ```bash
46
+ pip install .
47
+ python main.py
48
+ ```
49
+
50
+ ## 运行
51
+
52
+ 环境要求:
53
+
54
+ - Python 3.10 或更高版本;
55
+ - `requests`(网络请求);
56
+ - `pyperclip`(可选,用于复制微软登录设备码)。
57
+
58
+ 交互模式:
59
+
60
+ ```bash
61
+ dpmcl
62
+ # 源码运行:python main.py
63
+ ```
64
+
65
+ 进入后显示 `DPMCL>` 提示符,输入命令并回车;`help` 查看帮助,`exit` 退出。
66
+
67
+ 单次执行:
68
+
69
+ ```bash
70
+ python main.py list partition
71
+ python main.py play 1.21 123
72
+ python main.py install 1.21.1 loader=fabric
73
+ ```
74
+
75
+ 命令支持前缀缩写(例如 `l p`、`sel par 2`)。版本名、分区集名称或路径包含空格时需加引号:
76
+
77
+ ```text
78
+ select partition "1.21-Fabric 0.16.5"
79
+ mod install "D:\Mods\a b.jar"
80
+ ```
81
+
82
+ ## 命令
83
+
84
+ ### 查看与选择
85
+
86
+ | 命令 | 说明 |
87
+ | --- | --- |
88
+ | `list user` | 列出账号(类型、别名、令牌状态) |
89
+ | `list partition [all]` | 列出分区;`all` 包含已隐藏的分区 |
90
+ | `list set` | 列出分区集(多个 `.minecraft` 游戏目录) |
91
+ | `list java` | 列出已检测到的 Java(主版本、来源、路径) |
92
+ | `select user <用户名/别名>` | 选择账号 |
93
+ | `select partition <序号/名称>` | 选择分区 |
94
+ | `select set <序号/名称/路径>` | 切换分区集 |
95
+ | `select` | 显示当前分区集、分区与用户 |
96
+ | `info` | 查看当前分区详情 |
97
+ | `cmd` | 打印启动命令(令牌已隐藏) |
98
+ | `logs [行数]` | 查看最近一次启动日志 |
99
+
100
+ ### 安装与启动
101
+
102
+ | 命令 | 说明 |
103
+ | --- | --- |
104
+ | `create partition <vanilla\|fabric\|forge\|neoforge\|quilt>` | 创建待安装分区 |
105
+ | `create set <路径> [名称]` | 添加并切换分区集 |
106
+ | `format game=<版本> [type=<加载器>] [loader=<加载器版本>]` | 安装或补全当前分区 |
107
+ | `install <MC 版本> [loader=..] [loader_ver=..]` | 直接安装,无需先创建分区 |
108
+ | `play [分区] [账号] [--wait N] [--kill]` | 启动游戏 |
109
+ | `delete partition [purge]` | 隐藏分区;`purge` 同时删除文件 |
110
+ | `delete set <序号/名称/路径>` | 从列表移除分区集,不删除游戏文件 |
111
+ | `enable [序号/名称]` | 恢复被隐藏的分区 |
112
+ | `rename <新名称>` | 重命名分区 |
113
+ | `doctor [all\|序号\|名称]` | 检查启动所需文件 |
114
+
115
+ ### 账号
116
+
117
+ | 命令 | 说明 |
118
+ | --- | --- |
119
+ | `create user <mojang\|offline\|littleskin>` | 创建待登录账号 |
120
+ | `login [name=..] [pwd=..] [profile=..]` | 登录;正版使用微软设备码 |
121
+ | `assign letter=<a>` | 设置或清除(`.`)单字母序列号 |
122
+ | `assign profile=<角色>` | 切换 LittleSkin 角色 |
123
+ | `delete user` | 删除当前账号 |
124
+
125
+ ### 模组
126
+
127
+ | 命令 | 说明 |
128
+ | --- | --- |
129
+ | `mod list` | 列出当前分区的模组(编号、游戏内名称、文件、大小、状态) |
130
+ | `mod install <文件\|文件夹>` | 安装 `.jar` / `.zip`;文件夹安装其中全部模组文件 |
131
+ | `mod disable <编号>` / `mod enable <编号>` | 禁用或启用模组 |
132
+ | `mod delete <编号>` | 删除模组文件 |
133
+
134
+ ### Java
135
+
136
+ | 命令 | 说明 |
137
+ | --- | --- |
138
+ | `create java` | 列出可安装的官方 Java 运行时 |
139
+ | `create java <版本\|组件名>` | 安装官方 Java 运行时 |
140
+ | `assign java=<版本\|路径\|auto>` | 为当前分区指定 Java;`auto` 恢复自动选择 |
141
+
142
+ ### 维护
143
+
144
+ | 命令 | 说明 |
145
+ | --- | --- |
146
+ | `versions <vanilla\|fabric\|forge\|neoforge\|quilt> [game=..] [n=..]` | 查询可安装版本 |
147
+ | `config [键=值 ...]` | 查看或修改配置 |
148
+ | `help [命令]` | 显示帮助 |
149
+ | `exit` | 退出并保存当前选择 |
150
+
151
+ ## 分区集
152
+
153
+ 分区集是一个 `.minecraft` 游戏目录。配置文件可保存多个分区集,切换后分区列表、启动、模组与诊断均使用新的游戏目录:
154
+
155
+ ```text
156
+ list set
157
+ create set "D:\另一个\.minecraft" 另一个分区集
158
+ select set 2
159
+ delete set 2
160
+ ```
161
+
162
+ 配置文件中对应 `minecraft_sets` 与 `current_set`;`minecraft_dir` 为兼容字段。删除分区集只移除记录,不删除游戏文件。
163
+
164
+ ## 配置
165
+
166
+ 执行 `config` 可查看全部配置项、当前值与说明。键支持前缀缩写(如 `mem`、`iso`、`mir`、`trace`、`wor`)及常用别名。
167
+
168
+ | 键 | 说明 |
169
+ | --- | --- |
170
+ | `minecraft_dir` | 游戏目录;末级不是 `.minecraft` 时自动追加。设为 `#this` 时使用配置文件同级目录下的 `.minecraft` |
171
+ | `minecraft_sets` / `current_set` | 分区集列表与当前分区集 |
172
+ | `memory_mb` / `min_memory_mb` | 最大与最小内存(MB) |
173
+ | `isolation` | 版本隔离:每个分区使用独立游戏目录,默认开启 |
174
+ | `debug` | 使用 `java.exe` 启动并输出到控制台 |
175
+ | `java` | 按主版本指定 Java,例如 `config java21=<java.exe 路径>` |
176
+ | `partition_java` | 按分区指定 Java,通常由 `assign java=..` 维护 |
177
+ | `width` / `height` | 窗口尺寸 |
178
+ | `download_mirror` | `auto`、`official` 或 `bmcl` |
179
+ | `download_workers` | 并发下载线程数 |
180
+ | `show_traceback` | 出错时是否打印 Python 堆栈 |
181
+ | `auto_chinese` | 安装或启动时将游戏语言设为中文 |
182
+ | `skip_accessibility` | 写入 `onboardAccessibility:false`,跳过首次启动的无障碍引导 |
183
+ | `jvm_args` / `game_args` | 追加到 JVM 或游戏参数末尾 |
184
+
185
+ `#this` 不会保存为绝对路径,而是在运行时解析,因此可随配置文件整体迁移。相对路径以配置文件所在目录为基准;库调用可通过 `Config(path, home=...)` 指定其他基准目录。
186
+
187
+ 示例:
188
+
189
+ ```text
190
+ config minecraft_dir=#this
191
+ config memory=6144
192
+ config download_mirror=bmcl
193
+ config java25=C:\Program Files\Microsoft\jdk-25.0.5.21-hotspot\bin\java.exe
194
+ ```
195
+
196
+ 配置默认保存为 `launcher.json`:
197
+
198
+ - 源码运行:项目根目录;
199
+ - 安装版:用户数据目录(Windows 为 `%APPDATA%\DPMCL`,macOS 为 `~/Library/Application Support/DPMCL`,Linux 为 `$XDG_CONFIG_HOME/dpmcl` 或 `~/.config/dpmcl`);
200
+ - 可通过 `DPMCL_CONFIG` 指定其他位置。
201
+
202
+ ## Java 管理
203
+
204
+ Java 按以下顺序选择:
205
+
206
+ 1. 当前分区通过 `assign java=<路径|主版本>` 指定的 Java;
207
+ 2. 全局主版本覆盖,例如 `config java21=<路径>`;
208
+ 3. 自动选择:优先精确主版本,其次选择最低的兼容高版本。
209
+
210
+ ```text
211
+ list java
212
+ create java
213
+ create java 16
214
+ select partition 4
215
+ assign java=16
216
+ assign java=auto
217
+ ```
218
+
219
+ `create java` 将官方运行时安装到 `<游戏目录>/runtime/<组件>`,包括 `jre-legacy`(8)、`java-runtime-alpha`(16)、`beta`/`gamma`(17)、`delta`(21)与 `epsilon`(25)。
220
+
221
+ ## 库 API
222
+
223
+ `dpmcl` 提供安装、启动、Java、模组、分区和诊断接口。安装进度通过回调传递结构化事件,事件字段为常量,不包含本地化文本:
224
+
225
+ ```python
226
+ from dpmcl import Config, Launcher
227
+
228
+ config = Config(r"D:\DPMCL\launcher.json", home=r"D:\DPMCL")
229
+ launcher = Launcher(config=config)
230
+
231
+ def on_progress(event):
232
+ print(
233
+ event.operation, event.stage, event.status,
234
+ event.current, event.total, event.item, event.code,
235
+ dict(event.data),
236
+ )
237
+
238
+ result = launcher.install("1.21.1", loader="fabric", progress=on_progress)
239
+ print(result.version_name, result.status, result.options)
240
+
241
+ for issue in result.issues:
242
+ print(issue.code, issue.stage, issue.data)
243
+ ```
244
+
245
+ 主要类型:
246
+
247
+ - `Operation`:操作类型;
248
+ - `Stage`:当前步骤,如解析版本、补全依赖库、下载安装器、运行安装器、补全资源、检查文件;
249
+ - `Status`:`RUNNING`、`PROGRESS`、`OK`、`WARNING`、`FAILED` 等;
250
+ - `Code`:事件或告警原因码;
251
+ - `DpmclError`:失败时抛出,包含稳定的 `code` 与结构化 `details`。
252
+
253
+ `Launcher` 还提供 `list_partitions()`、`doctor()`、`launch()`、`list_java()`、`install_java()`、`list_mods()`、`install_mod()`、`disable_mod()`、`enable_mod()` 与 `delete_mod()`。
254
+
255
+ ## 环境变量
256
+
257
+ | 变量 | 作用 |
258
+ | --- | --- |
259
+ | `DPMCL_MINECRAFT_DIR` | 临时指定游戏目录,不写入配置 |
260
+ | `DPMCL_CONFIG` | 指定 `launcher.json` 路径 |
261
+ | `DPMCL_HOME` | 指定可写启动器目录 |
262
+ | `DPMCL_ACCOUNTS` | 指定 `accounts.json` 路径 |
263
+ | `DPMCL_TRACEBACK` | 出错时打印完整堆栈,等同 `config show_traceback=on` |
264
+
265
+ `DPMCL_*` 变量均以当前配置文件为准。
266
+
267
+ ## 目录结构
268
+
269
+ ```text
270
+ dpmcl/ 公共库包
271
+ __init__.py
272
+ api.py Launcher 与安装、启动、Java、模组 API
273
+ cli.py 命令行实现(dpmcl 命令入口)
274
+ __main__.py python -m dpmcl 入口
275
+ constants.py Operation / Stage / Status / Code
276
+ errors.py DpmclError
277
+ config.py 配置、分区集与 #this
278
+ accounts.py 账号数据与令牌
279
+ engine.py 底层引擎接口
280
+ i18n.py 命令行中文文案
281
+ _internal/ 内部实现
282
+ progress.py 进度事件与 ProgressReporter
283
+ config.py 配置与路径
284
+ util.py 通用工具
285
+ rules.py 规则判定
286
+ libraries.py Maven 坐标、natives、classpath
287
+ version.py 版本 JSON 与继承合并
288
+ java.py Java 探测与选择
289
+ net.py 下载、重试、镜像与校验
290
+ assets.py 资源索引与资源对象
291
+ install.py 原版与加载器安装
292
+ launch.py 启动参数、natives 与进程
293
+ accounts.py 账号与登录
294
+ mods.py 模组管理
295
+
296
+ main.py 源码启动壳(保留 python main.py 用法)
297
+ pyproject.toml 构建与 PyPI 元数据
298
+ MANIFEST.in sdist 打包规则
299
+ LICENSE MIT 许可证
300
+ ```
301
+
302
+ ## 常见问题
303
+
304
+ - **启动后立即退出**:`play` 会输出日志末尾;也可执行 `logs 100` 查看完整日志。
305
+ - **提示缺少 Java**:执行 `config` 查看已检测的 Java,或通过 `config java21=<路径>` 指定。
306
+ - **下载缓慢**:执行 `config download_mirror=bmcl` 切换至 BMCLAPI 镜像。
307
+ - **不需要版本隔离**:执行 `config isolation=off`,各版本共用 `.minecraft` 根目录。
dpmcl-26.1/README.md ADDED
@@ -0,0 +1,282 @@
1
+ # DPMCL
2
+
3
+ DPMCL 是一个使用纯 Python 编写的 Minecraft: Java Edition 命令行启动器,支持原版、Fabric、Quilt、Forge 与 NeoForge 的安装、管理和启动。
4
+
5
+ 核心逻辑位于 `dpmcl/` 公共库包中,`main.py` 仅提供命令行入口;库的调用方式见“库 API”一节。
6
+
7
+ ## 安装
8
+
9
+ 发布版本:
10
+
11
+ ```bash
12
+ pip install dpmcl
13
+ # 可选:启用设备码自动复制到剪贴板
14
+ pip install "dpmcl[clipboard]"
15
+ dpmcl
16
+ ```
17
+
18
+ 从源码安装或直接运行:
19
+
20
+ ```bash
21
+ pip install .
22
+ python main.py
23
+ ```
24
+
25
+ ## 运行
26
+
27
+ 环境要求:
28
+
29
+ - Python 3.10 或更高版本;
30
+ - `requests`(网络请求);
31
+ - `pyperclip`(可选,用于复制微软登录设备码)。
32
+
33
+ 交互模式:
34
+
35
+ ```bash
36
+ dpmcl
37
+ # 源码运行:python main.py
38
+ ```
39
+
40
+ 进入后显示 `DPMCL>` 提示符,输入命令并回车;`help` 查看帮助,`exit` 退出。
41
+
42
+ 单次执行:
43
+
44
+ ```bash
45
+ python main.py list partition
46
+ python main.py play 1.21 123
47
+ python main.py install 1.21.1 loader=fabric
48
+ ```
49
+
50
+ 命令支持前缀缩写(例如 `l p`、`sel par 2`)。版本名、分区集名称或路径包含空格时需加引号:
51
+
52
+ ```text
53
+ select partition "1.21-Fabric 0.16.5"
54
+ mod install "D:\Mods\a b.jar"
55
+ ```
56
+
57
+ ## 命令
58
+
59
+ ### 查看与选择
60
+
61
+ | 命令 | 说明 |
62
+ | --- | --- |
63
+ | `list user` | 列出账号(类型、别名、令牌状态) |
64
+ | `list partition [all]` | 列出分区;`all` 包含已隐藏的分区 |
65
+ | `list set` | 列出分区集(多个 `.minecraft` 游戏目录) |
66
+ | `list java` | 列出已检测到的 Java(主版本、来源、路径) |
67
+ | `select user <用户名/别名>` | 选择账号 |
68
+ | `select partition <序号/名称>` | 选择分区 |
69
+ | `select set <序号/名称/路径>` | 切换分区集 |
70
+ | `select` | 显示当前分区集、分区与用户 |
71
+ | `info` | 查看当前分区详情 |
72
+ | `cmd` | 打印启动命令(令牌已隐藏) |
73
+ | `logs [行数]` | 查看最近一次启动日志 |
74
+
75
+ ### 安装与启动
76
+
77
+ | 命令 | 说明 |
78
+ | --- | --- |
79
+ | `create partition <vanilla\|fabric\|forge\|neoforge\|quilt>` | 创建待安装分区 |
80
+ | `create set <路径> [名称]` | 添加并切换分区集 |
81
+ | `format game=<版本> [type=<加载器>] [loader=<加载器版本>]` | 安装或补全当前分区 |
82
+ | `install <MC 版本> [loader=..] [loader_ver=..]` | 直接安装,无需先创建分区 |
83
+ | `play [分区] [账号] [--wait N] [--kill]` | 启动游戏 |
84
+ | `delete partition [purge]` | 隐藏分区;`purge` 同时删除文件 |
85
+ | `delete set <序号/名称/路径>` | 从列表移除分区集,不删除游戏文件 |
86
+ | `enable [序号/名称]` | 恢复被隐藏的分区 |
87
+ | `rename <新名称>` | 重命名分区 |
88
+ | `doctor [all\|序号\|名称]` | 检查启动所需文件 |
89
+
90
+ ### 账号
91
+
92
+ | 命令 | 说明 |
93
+ | --- | --- |
94
+ | `create user <mojang\|offline\|littleskin>` | 创建待登录账号 |
95
+ | `login [name=..] [pwd=..] [profile=..]` | 登录;正版使用微软设备码 |
96
+ | `assign letter=<a>` | 设置或清除(`.`)单字母序列号 |
97
+ | `assign profile=<角色>` | 切换 LittleSkin 角色 |
98
+ | `delete user` | 删除当前账号 |
99
+
100
+ ### 模组
101
+
102
+ | 命令 | 说明 |
103
+ | --- | --- |
104
+ | `mod list` | 列出当前分区的模组(编号、游戏内名称、文件、大小、状态) |
105
+ | `mod install <文件\|文件夹>` | 安装 `.jar` / `.zip`;文件夹安装其中全部模组文件 |
106
+ | `mod disable <编号>` / `mod enable <编号>` | 禁用或启用模组 |
107
+ | `mod delete <编号>` | 删除模组文件 |
108
+
109
+ ### Java
110
+
111
+ | 命令 | 说明 |
112
+ | --- | --- |
113
+ | `create java` | 列出可安装的官方 Java 运行时 |
114
+ | `create java <版本\|组件名>` | 安装官方 Java 运行时 |
115
+ | `assign java=<版本\|路径\|auto>` | 为当前分区指定 Java;`auto` 恢复自动选择 |
116
+
117
+ ### 维护
118
+
119
+ | 命令 | 说明 |
120
+ | --- | --- |
121
+ | `versions <vanilla\|fabric\|forge\|neoforge\|quilt> [game=..] [n=..]` | 查询可安装版本 |
122
+ | `config [键=值 ...]` | 查看或修改配置 |
123
+ | `help [命令]` | 显示帮助 |
124
+ | `exit` | 退出并保存当前选择 |
125
+
126
+ ## 分区集
127
+
128
+ 分区集是一个 `.minecraft` 游戏目录。配置文件可保存多个分区集,切换后分区列表、启动、模组与诊断均使用新的游戏目录:
129
+
130
+ ```text
131
+ list set
132
+ create set "D:\另一个\.minecraft" 另一个分区集
133
+ select set 2
134
+ delete set 2
135
+ ```
136
+
137
+ 配置文件中对应 `minecraft_sets` 与 `current_set`;`minecraft_dir` 为兼容字段。删除分区集只移除记录,不删除游戏文件。
138
+
139
+ ## 配置
140
+
141
+ 执行 `config` 可查看全部配置项、当前值与说明。键支持前缀缩写(如 `mem`、`iso`、`mir`、`trace`、`wor`)及常用别名。
142
+
143
+ | 键 | 说明 |
144
+ | --- | --- |
145
+ | `minecraft_dir` | 游戏目录;末级不是 `.minecraft` 时自动追加。设为 `#this` 时使用配置文件同级目录下的 `.minecraft` |
146
+ | `minecraft_sets` / `current_set` | 分区集列表与当前分区集 |
147
+ | `memory_mb` / `min_memory_mb` | 最大与最小内存(MB) |
148
+ | `isolation` | 版本隔离:每个分区使用独立游戏目录,默认开启 |
149
+ | `debug` | 使用 `java.exe` 启动并输出到控制台 |
150
+ | `java` | 按主版本指定 Java,例如 `config java21=<java.exe 路径>` |
151
+ | `partition_java` | 按分区指定 Java,通常由 `assign java=..` 维护 |
152
+ | `width` / `height` | 窗口尺寸 |
153
+ | `download_mirror` | `auto`、`official` 或 `bmcl` |
154
+ | `download_workers` | 并发下载线程数 |
155
+ | `show_traceback` | 出错时是否打印 Python 堆栈 |
156
+ | `auto_chinese` | 安装或启动时将游戏语言设为中文 |
157
+ | `skip_accessibility` | 写入 `onboardAccessibility:false`,跳过首次启动的无障碍引导 |
158
+ | `jvm_args` / `game_args` | 追加到 JVM 或游戏参数末尾 |
159
+
160
+ `#this` 不会保存为绝对路径,而是在运行时解析,因此可随配置文件整体迁移。相对路径以配置文件所在目录为基准;库调用可通过 `Config(path, home=...)` 指定其他基准目录。
161
+
162
+ 示例:
163
+
164
+ ```text
165
+ config minecraft_dir=#this
166
+ config memory=6144
167
+ config download_mirror=bmcl
168
+ config java25=C:\Program Files\Microsoft\jdk-25.0.5.21-hotspot\bin\java.exe
169
+ ```
170
+
171
+ 配置默认保存为 `launcher.json`:
172
+
173
+ - 源码运行:项目根目录;
174
+ - 安装版:用户数据目录(Windows 为 `%APPDATA%\DPMCL`,macOS 为 `~/Library/Application Support/DPMCL`,Linux 为 `$XDG_CONFIG_HOME/dpmcl` 或 `~/.config/dpmcl`);
175
+ - 可通过 `DPMCL_CONFIG` 指定其他位置。
176
+
177
+ ## Java 管理
178
+
179
+ Java 按以下顺序选择:
180
+
181
+ 1. 当前分区通过 `assign java=<路径|主版本>` 指定的 Java;
182
+ 2. 全局主版本覆盖,例如 `config java21=<路径>`;
183
+ 3. 自动选择:优先精确主版本,其次选择最低的兼容高版本。
184
+
185
+ ```text
186
+ list java
187
+ create java
188
+ create java 16
189
+ select partition 4
190
+ assign java=16
191
+ assign java=auto
192
+ ```
193
+
194
+ `create java` 将官方运行时安装到 `<游戏目录>/runtime/<组件>`,包括 `jre-legacy`(8)、`java-runtime-alpha`(16)、`beta`/`gamma`(17)、`delta`(21)与 `epsilon`(25)。
195
+
196
+ ## 库 API
197
+
198
+ `dpmcl` 提供安装、启动、Java、模组、分区和诊断接口。安装进度通过回调传递结构化事件,事件字段为常量,不包含本地化文本:
199
+
200
+ ```python
201
+ from dpmcl import Config, Launcher
202
+
203
+ config = Config(r"D:\DPMCL\launcher.json", home=r"D:\DPMCL")
204
+ launcher = Launcher(config=config)
205
+
206
+ def on_progress(event):
207
+ print(
208
+ event.operation, event.stage, event.status,
209
+ event.current, event.total, event.item, event.code,
210
+ dict(event.data),
211
+ )
212
+
213
+ result = launcher.install("1.21.1", loader="fabric", progress=on_progress)
214
+ print(result.version_name, result.status, result.options)
215
+
216
+ for issue in result.issues:
217
+ print(issue.code, issue.stage, issue.data)
218
+ ```
219
+
220
+ 主要类型:
221
+
222
+ - `Operation`:操作类型;
223
+ - `Stage`:当前步骤,如解析版本、补全依赖库、下载安装器、运行安装器、补全资源、检查文件;
224
+ - `Status`:`RUNNING`、`PROGRESS`、`OK`、`WARNING`、`FAILED` 等;
225
+ - `Code`:事件或告警原因码;
226
+ - `DpmclError`:失败时抛出,包含稳定的 `code` 与结构化 `details`。
227
+
228
+ `Launcher` 还提供 `list_partitions()`、`doctor()`、`launch()`、`list_java()`、`install_java()`、`list_mods()`、`install_mod()`、`disable_mod()`、`enable_mod()` 与 `delete_mod()`。
229
+
230
+ ## 环境变量
231
+
232
+ | 变量 | 作用 |
233
+ | --- | --- |
234
+ | `DPMCL_MINECRAFT_DIR` | 临时指定游戏目录,不写入配置 |
235
+ | `DPMCL_CONFIG` | 指定 `launcher.json` 路径 |
236
+ | `DPMCL_HOME` | 指定可写启动器目录 |
237
+ | `DPMCL_ACCOUNTS` | 指定 `accounts.json` 路径 |
238
+ | `DPMCL_TRACEBACK` | 出错时打印完整堆栈,等同 `config show_traceback=on` |
239
+
240
+ `DPMCL_*` 变量均以当前配置文件为准。
241
+
242
+ ## 目录结构
243
+
244
+ ```text
245
+ dpmcl/ 公共库包
246
+ __init__.py
247
+ api.py Launcher 与安装、启动、Java、模组 API
248
+ cli.py 命令行实现(dpmcl 命令入口)
249
+ __main__.py python -m dpmcl 入口
250
+ constants.py Operation / Stage / Status / Code
251
+ errors.py DpmclError
252
+ config.py 配置、分区集与 #this
253
+ accounts.py 账号数据与令牌
254
+ engine.py 底层引擎接口
255
+ i18n.py 命令行中文文案
256
+ _internal/ 内部实现
257
+ progress.py 进度事件与 ProgressReporter
258
+ config.py 配置与路径
259
+ util.py 通用工具
260
+ rules.py 规则判定
261
+ libraries.py Maven 坐标、natives、classpath
262
+ version.py 版本 JSON 与继承合并
263
+ java.py Java 探测与选择
264
+ net.py 下载、重试、镜像与校验
265
+ assets.py 资源索引与资源对象
266
+ install.py 原版与加载器安装
267
+ launch.py 启动参数、natives 与进程
268
+ accounts.py 账号与登录
269
+ mods.py 模组管理
270
+
271
+ main.py 源码启动壳(保留 python main.py 用法)
272
+ pyproject.toml 构建与 PyPI 元数据
273
+ MANIFEST.in sdist 打包规则
274
+ LICENSE MIT 许可证
275
+ ```
276
+
277
+ ## 常见问题
278
+
279
+ - **启动后立即退出**:`play` 会输出日志末尾;也可执行 `logs 100` 查看完整日志。
280
+ - **提示缺少 Java**:执行 `config` 查看已检测的 Java,或通过 `config java21=<路径>` 指定。
281
+ - **下载缓慢**:执行 `config download_mirror=bmcl` 切换至 BMCLAPI 镜像。
282
+ - **不需要版本隔离**:执行 `config isolation=off`,各版本共用 `.minecraft` 根目录。
@@ -0,0 +1,64 @@
1
+ """DPMCL 公共库。
2
+
3
+ 安装、启动、Java、模组等逻辑都可以直接调用这里的 API;进度通过
4
+ ``progress`` 回调接收结构化的 :class:`ProgressEvent`,事件字段为常量,
5
+ 不包含本地化文案。CLI 文案映射在 :mod:`dpmcl.i18n`。
6
+ """
7
+
8
+ __version__ = "26.1"
9
+
10
+ from .api import (
11
+ DoctorSummary,
12
+ GameProfile,
13
+ InstallIssue,
14
+ InstallResult,
15
+ JavaInfo,
16
+ Launcher,
17
+ LaunchHandle,
18
+ ModInfo,
19
+ PartitionInfo,
20
+ install,
21
+ launch,
22
+ list_partitions,
23
+ offline_profile,
24
+ )
25
+ from .config import Config, MinecraftSet, default_config_path, load_config
26
+ from .constants import (
27
+ Code,
28
+ Operation,
29
+ ProgressCallback,
30
+ ProgressEvent,
31
+ ProgressReporter,
32
+ Stage,
33
+ Status,
34
+ )
35
+ from .errors import DpmclError
36
+
37
+ __all__ = [
38
+ "__version__",
39
+ "Code",
40
+ "Operation",
41
+ "ProgressCallback",
42
+ "ProgressEvent",
43
+ "ProgressReporter",
44
+ "Stage",
45
+ "Status",
46
+ "DpmclError",
47
+ "Config",
48
+ "MinecraftSet",
49
+ "default_config_path",
50
+ "load_config",
51
+ "Launcher",
52
+ "PartitionInfo",
53
+ "InstallIssue",
54
+ "InstallResult",
55
+ "LaunchHandle",
56
+ "DoctorSummary",
57
+ "JavaInfo",
58
+ "ModInfo",
59
+ "GameProfile",
60
+ "offline_profile",
61
+ "install",
62
+ "launch",
63
+ "list_partitions",
64
+ ]
@@ -0,0 +1,6 @@
1
+ """``python -m dpmcl`` 入口。"""
2
+
3
+ from .cli import main
4
+
5
+ if __name__ == "__main__":
6
+ raise SystemExit(main())