Skip to content

添加安装阶段对整合包可选文件的支持 #1771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CaveNightingale wants to merge 26 commits into
base: main
Choose a base branch
from
Open

添加安装阶段对整合包可选文件的支持 #1771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
b1d29e4
Support optional files in modpacks
CaveNightingale Oct 3, 2022
b043491
Merge branch 'javafx' of github.com:huanghongxun/HMCL into javafx
CaveNightingale Jul 30, 2023
c5b340f
Merge & accelerate curseforge modpack loading
CaveNightingale Jul 30, 2023
63a12a8
Merge
CaveNightingale Jan 11, 2024
b9fe5d1
Show details for optional files && Allow retry
CaveNightingale Jan 13, 2024
addce8b
copyright
CaveNightingale Jan 13, 2024
c654654
Merge
CaveNightingale Jan 13, 2024
8007899
add icon
CaveNightingale Jan 13, 2024
b7af69d
Fix style
CaveNightingale Jan 24, 2024
342b385
Update style
CaveNightingale Feb 7, 2024
57153a8
Merge remote-tracking branch 'origin/main' into javafx
Glavo Feb 25, 2025
2617c54
fix build
Glavo Feb 25, 2025
08bf8c0
Merge remote-tracking branch 'origin/main' into javafx
Glavo Jun 10, 2025
54ec328
update
Glavo Jun 11, 2025
2cecf4f
Merge branch 'main' into javafx
Glavo Aug 14, 2025
f46c80c
fix
Glavo Aug 14, 2025
7554fd3
fix optional file list checkbox error, fix NPE during installation, …
CaveNightingale Aug 17, 2025
cc224a4
fix lint
CaveNightingale Aug 17, 2025
3bb5da6
Merge remote-tracking branch 'upstream/main' into javafx
CaveNightingale Feb 25, 2026
64fa8a1
fix lint
CaveNightingale Feb 25, 2026
23e4380
fix translation
CaveNightingale Feb 25, 2026
7234eda
make optional files in a separate page
CaveNightingale Feb 25, 2026
39158ed
fix retry
CaveNightingale Feb 26, 2026
dbdd932
fix lint
CaveNightingale Feb 27, 2026
87d20a5
mod detail icon
CaveNightingale Mar 4, 2026
edc55e1
Merge remote-tracking branch 'upstream/main' into javafx
Glavo Apr 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions HMCL/src/main/java/org/jackhuang/hmcl/game/HMCLModpackProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,7 @@
import com.google.gson.JsonParseException;
import kala.compress.archivers.zip.ZipArchiveReader;
import org.jackhuang.hmcl.download.DefaultDependencyManager;
import org.jackhuang.hmcl.mod.MismatchedModpackTypeException;
import org.jackhuang.hmcl.mod.Modpack;
import org.jackhuang.hmcl.mod.ModpackProvider;
import org.jackhuang.hmcl.mod.ModpackUpdateTask;
import org.jackhuang.hmcl.mod.*;
import org.jackhuang.hmcl.setting.Profile;
import org.jackhuang.hmcl.task.Task;
import org.jackhuang.hmcl.util.StringUtils;
Expand All @@ -33,6 +30,7 @@
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Path;
import java.util.Set;

public final class HMCLModpackProvider implements ModpackProvider {
public static final HMCLModpackProvider INSTANCE = new HMCLModpackProvider();
Expand All @@ -48,7 +46,7 @@ public Task<?> createCompletionTask(DefaultDependencyManager dependencyManager,
}

@Override
public Task<?> createUpdateTask(DefaultDependencyManager dependencyManager, String name, Path zipFile, Modpack modpack) throws MismatchedModpackTypeException {
public Task<?> createUpdateTask(DefaultDependencyManager dependencyManager, String name, Path zipFile, Modpack modpack, Set<? extends ModpackFile> selectedFiles) throws MismatchedModpackTypeException {
if (!(modpack.getManifest() instanceof HMCLModpackManifest))
throw new MismatchedModpackTypeException(getName(), modpack.getManifest().getProvider().getName());

Expand Down Expand Up @@ -79,7 +77,7 @@ public Modpack readManifest(ZipArchiveReader file, Path path, Charset encoding)

private final static class HMCLModpack extends Modpack {
@Override
public Task<?> getInstallTask(DefaultDependencyManager dependencyManager, Path zipFile, String name, String iconUrl) {
public Task<?> getInstallTask(DefaultDependencyManager dependencyManager, Path zipFile, String name, String iconUrl, Set<? extends ModpackFile> selectedFiles) {
return new HMCLModpackInstallTask(((HMCLGameRepository) dependencyManager.getGameRepository()).getProfile(), zipFile, this, name);
}
}
Expand Down
16 changes: 9 additions & 7 deletions HMCL/src/main/java/org/jackhuang/hmcl/game/ModpackHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Stream;

import static org.jackhuang.hmcl.util.Lang.mapOf;
Expand Down Expand Up @@ -191,7 +192,7 @@ public static Task<?> getInstallManuallyCreatedModpackTask(Profile profile, Path
});
}

public static Task<?> getInstallTask(Profile profile, Path zipFile, String name, Modpack modpack, String iconUrl) {
public static Task<?> getInstallTask(Profile profile, Path zipFile, String name, Modpack modpack, String iconUrl, Set<? extends ModpackFile> selectedFiles) {
profile.getRepository().markVersionAsModpack(name);

ExceptionalRunnable<?> success = () -> {
Expand All @@ -211,17 +212,17 @@ public static Task<?> getInstallTask(Profile profile, Path zipFile, String name,
};

if (modpack.getManifest() instanceof MultiMCInstanceConfiguration)
return modpack.getInstallTask(profile.getDependency(), zipFile, name, iconUrl)
return modpack.getInstallTask(profile.getDependency(), zipFile, name, iconUrl, selectedFiles)
.whenComplete(Schedulers.defaultScheduler(), success, failure)
.thenComposeAsync(createMultiMCPostInstallTask(profile, (MultiMCInstanceConfiguration) modpack.getManifest(), name))
.withStagesHints(new Task.StagesHint("hmcl.modpack"), new Task.StagesHint("hmcl.modpack.download", List.of("hmcl.install.assets", "hmcl.install.libraries")));
else if (modpack.getManifest() instanceof McbbsModpackManifest)
return modpack.getInstallTask(profile.getDependency(), zipFile, name, iconUrl)
return modpack.getInstallTask(profile.getDependency(), zipFile, name, iconUrl, selectedFiles)
.whenComplete(Schedulers.defaultScheduler(), success, failure)
.thenComposeAsync(createMcbbsPostInstallTask(profile, (McbbsModpackManifest) modpack.getManifest(), name))
.withStagesHints(new Task.StagesHint("hmcl.modpack"), new Task.StagesHint("hmcl.modpack.download", List.of("hmcl.install.assets", "hmcl.install.libraries")));
else
return modpack.getInstallTask(profile.getDependency(), zipFile, name, iconUrl)
return modpack.getInstallTask(profile.getDependency(), zipFile, name, iconUrl, selectedFiles)
.whenComplete(Schedulers.javafx(), success, failure)
.withStagesHints(new Task.StagesHint("hmcl.modpack"), new Task.StagesHint("hmcl.modpack.download", List.of("hmcl.install.assets", "hmcl.install.libraries")));
}
Expand All @@ -237,18 +238,19 @@ public static Task<Void> getUpdateTask(Profile profile, ServerModpackManifest ma
}
}

public static Task<?> getUpdateTask(Profile profile, Path zipFile, Charset charset, String name, ModpackConfiguration<?> configuration) throws UnsupportedModpackException, ManuallyCreatedModpackException, MismatchedModpackTypeException {
public static Task<?> getUpdateTask(Profile profile, Path zipFile, Charset charset, String name, ModpackConfiguration<?> configuration, Set<? extends ModpackFile> selectedFiles) throws UnsupportedModpackException, ManuallyCreatedModpackException, MismatchedModpackTypeException {
Modpack modpack = ModpackHelper.readModpackManifest(zipFile, charset);
ModpackProvider provider = getProviderByType(configuration.getType());
if (provider == null) {
throw new UnsupportedModpackException();
}
Task<?> updateTask = provider.createUpdateTask(profile.getDependency(), name, zipFile, modpack, selectedFiles);
if (modpack.getManifest() instanceof MultiMCInstanceConfiguration)
return provider.createUpdateTask(profile.getDependency(), name, zipFile, modpack)
return updateTask
.thenComposeAsync(() -> createMultiMCPostUpdateTask(profile, (MultiMCInstanceConfiguration) modpack.getManifest(), name))
.thenComposeAsync(profile.getRepository().refreshVersionsAsync());
else
return provider.createUpdateTask(profile.getDependency(), name, zipFile, modpack)
return updateTask
.thenComposeAsync(profile.getRepository().refreshVersionsAsync());
}

Expand Down
80 changes: 72 additions & 8 deletions HMCL/src/main/java/org/jackhuang/hmcl/ui/download/LocalModpackPage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,18 @@
import javafx.application.Platform;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.collections.ObservableSet;
import javafx.collections.transformation.FilteredList;
import javafx.stage.FileChooser;
import org.jackhuang.hmcl.game.HMCLGameRepository;
import org.jackhuang.hmcl.game.ManuallyCreatedModpackException;
import org.jackhuang.hmcl.game.ModpackHelper;
import org.jackhuang.hmcl.mod.Modpack;
import org.jackhuang.hmcl.mod.ModpackFile;
import org.jackhuang.hmcl.mod.ModpackManifest;
import org.jackhuang.hmcl.setting.DownloadProviders;
import org.jackhuang.hmcl.setting.Profile;
import org.jackhuang.hmcl.setting.Profiles;
import org.jackhuang.hmcl.task.Schedulers;
Expand All @@ -40,8 +47,15 @@
import org.jackhuang.hmcl.util.StringUtils;
import org.jackhuang.hmcl.util.io.CompressingUtils;
import org.jackhuang.hmcl.util.io.FileUtils;
import org.jetbrains.annotations.Nullable;

import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;
import java.nio.file.Path;

import static org.jackhuang.hmcl.util.logging.Logger.LOG;
Expand All @@ -52,9 +66,18 @@ public final class LocalModpackPage extends ModpackPage {
private final BooleanProperty installAsVersion = new SimpleBooleanProperty(true);
private Modpack manifest = null;
private Charset charset;
private final ObservableList<ModpackFile> allFiles = FXCollections.observableList(new ArrayList<>());
private final ObservableSet<ModpackFile> excludedFiles = FXCollections.observableSet(new HashSet<>());
private final BooleanProperty loadingOptionalFiles = new SimpleBooleanProperty(false);
private final BooleanProperty loadedOptionalFiles = new SimpleBooleanProperty(true);

public LocalModpackPage(WizardController controller) {
super(controller);
btnOptionalFiles.setOnAction((ev) -> {
controller.onNext(new OptionalFilesPage(this::onInstall, this::loadOptionalFiles,
loadingOptionalFiles, loadedOptionalFiles,
new FilteredList<>(allFiles, ModpackFile::isOptional), excludedFiles));
});

Profile profile = controller.getSettings().get(ModpackPage.PROFILE);

Expand All @@ -67,12 +90,15 @@ public LocalModpackPage(WizardController controller) {
if (installAsVersion) {
txtModpackName.getValidators().setAll(
new RequiredValidator(),
new Validator(i18n("install.new_game.already_exists"), str -> !profile.getRepository().versionIdConflicts(str)),
new Validator(i18n("install.new_game.already_exists"),
str -> !profile.getRepository().versionIdConflicts(str)),
new Validator(i18n("install.new_game.malformed"), HMCLGameRepository::isValidVersionId));
} else {
txtModpackName.getValidators().setAll(
new RequiredValidator(),
new Validator(i18n("install.new_game.already_exists"), str -> !ModpackHelper.isExternalGameNameConflicts(str) && Profiles.getProfiles().stream().noneMatch(p -> p.getName().equals(str))),
new Validator(i18n("install.new_game.already_exists"),
str -> !ModpackHelper.isExternalGameNameConflicts(str)
&& Profiles.getProfiles().stream().noneMatch(p -> p.getName().equals(str))),
new Validator(i18n("install.new_game.malformed"), HMCLGameRepository::isValidVersionId));
}
});
Expand Down Expand Up @@ -101,10 +127,17 @@ public LocalModpackPage(WizardController controller) {
Task.supplyAsync(() -> CompressingUtils.findSuitableEncoding(selectedFile))
.thenApplyAsync(encoding -> {
charset = encoding;
manifest = ModpackHelper.readModpackManifest(selectedFile, encoding);
return manifest;
return ModpackHelper.readModpackManifest(selectedFile, encoding);
})
.whenComplete(Schedulers.javafx(), (manifest, exception) -> {
this.manifest = manifest;
if (manifest.getManifest() instanceof ModpackManifest.SupportOptional) {
Copy link
Copy Markdown
Member

@Glavo Glavo Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

manifest 可能为 null。

allFiles.setAll(((ModpackManifest.SupportOptional) manifest.getManifest()).getFiles());
if (allFiles.stream().anyMatch(ModpackFile::isOptional)) {
loadOptionalFiles();
btnOptionalFiles.setVisible(true);
}
}
if (exception instanceof ManuallyCreatedModpackException) {
hideSpinner();
nameProperty.set(FileUtils.getName(selectedFile));
Expand All @@ -115,14 +148,17 @@ public LocalModpackPage(WizardController controller) {
txtModpackName.setText(FileUtils.getNameWithoutExtension(selectedFile));
}

Controllers.confirm(i18n("modpack.type.manual.warning"), i18n("install.modpack"), MessageDialogPane.MessageType.WARNING,
() -> {},
Controllers.confirm(i18n("modpack.type.manual.warning"), i18n("install.modpack"),
MessageDialogPane.MessageType.WARNING,
() -> {
},
controller::onEnd);

controller.getSettings().put(MODPACK_MANUALLY_CREATED, true);
} else if (exception != null) {
LOG.warning("Failed to read modpack manifest", exception);
Controllers.dialog(i18n("modpack.task.install.error"), i18n("message.error"), MessageDialogPane.MessageType.ERROR);
Controllers.dialog(i18n("modpack.task.install.error"), i18n("message.error"),
MessageDialogPane.MessageType.ERROR);
Platform.runLater(controller::onEnd);
} else {
hideSpinner();
Expand All @@ -141,6 +177,25 @@ public LocalModpackPage(WizardController controller) {
}).start();
}

private void loadOptionalFiles() {
Objects.requireNonNull(manifest);
loadingOptionalFiles.set(true);
loadedOptionalFiles.set(false);
Task.supplyAsync(() -> manifest.getManifest().getProvider().loadFiles(DownloadProviders.getDownloadProvider(), manifest.getManifest()))
.whenComplete(Schedulers.javafx(), (manifest1, exception) -> {
List<? extends ModpackFile> files = ((ModpackManifest.SupportOptional) manifest
.setManifest(manifest1).getManifest()).getFiles();
allFiles.setAll(files);
loadingOptionalFiles.set(false);
if (exception != null || files.stream()
.anyMatch(s -> s.isOptional() && (s.getMod() == null || s.getFileName() == null))) {
LOG.warning("Failed to load optional files", exception);
} else {
loadedOptionalFiles.set(true);
}
}).start();
}

@Override
public void cleanup(SettingsMap settings) {
settings.remove(MODPACK_FILE);
Expand All @@ -158,6 +213,7 @@ protected void onInstall() {
.yesOrNo(() -> {
controller.getSettings().put(MODPACK_NAME, name);
controller.getSettings().put(MODPACK_CHARSET, charset);
controller.getSettings().put(MODPACK_SELECTED_FILES, getSelectedFiles());
controller.onFinish();
}, () -> {
// The user selects Cancel and does nothing.
Expand All @@ -166,10 +222,15 @@ protected void onInstall() {
} else {
controller.getSettings().put(MODPACK_NAME, name);
controller.getSettings().put(MODPACK_CHARSET, charset);
controller.getSettings().put(MODPACK_SELECTED_FILES, getSelectedFiles());
controller.onFinish();
}
}

private @Nullable Set<? extends ModpackFile> getSelectedFiles() {
return allFiles.stream().filter(file -> !excludedFiles.contains(file)).collect(Collectors.toSet());
}

protected void onDescribe() {
if (manifest != null)
Controllers.navigate(new WebPage(i18n("modpack.description"), manifest.getDescription()));
Expand All @@ -179,6 +240,9 @@ protected void onDescribe() {
public static final SettingsMap.Key<String> MODPACK_NAME = new SettingsMap.Key<>("MODPACK_NAME");
public static final SettingsMap.Key<Modpack> MODPACK_MANIFEST = new SettingsMap.Key<>("MODPACK_MANIFEST");
public static final SettingsMap.Key<Charset> MODPACK_CHARSET = new SettingsMap.Key<>("MODPACK_CHARSET");
public static final SettingsMap.Key<Boolean> MODPACK_MANUALLY_CREATED = new SettingsMap.Key<>("MODPACK_MANUALLY_CREATED");
public static final SettingsMap.Key<Boolean> MODPACK_MANUALLY_CREATED = new SettingsMap.Key<>(
"MODPACK_MANUALLY_CREATED");
public static final SettingsMap.Key<String> MODPACK_ICON_URL = new SettingsMap.Key<>("MODPACK_ICON_URL");
public static final SettingsMap.Key<Set<? extends ModpackFile>> MODPACK_SELECTED_FILES = new SettingsMap.Key<>(
"MODPACK_SELECTED_FILES");
}
7 changes: 5 additions & 2 deletions HMCL/src/main/java/org/jackhuang/hmcl/ui/download/ModpackInstallWizardProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.jackhuang.hmcl.mod.Modpack;
import org.jackhuang.hmcl.mod.ModpackCompletionException;
import org.jackhuang.hmcl.mod.UnsupportedModpackException;
import org.jackhuang.hmcl.mod.*;
import org.jackhuang.hmcl.mod.server.ServerModpackManifest;
import org.jackhuang.hmcl.setting.Profile;
import org.jackhuang.hmcl.task.Schedulers;
Expand All @@ -39,6 +40,7 @@
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Path;
import java.util.Set;

import static org.jackhuang.hmcl.util.i18n.I18n.i18n;

Expand Down Expand Up @@ -89,6 +91,7 @@ private Task<?> finishModpackInstallingAsync(SettingsMap settings) {
Modpack modpack = settings.get(LocalModpackPage.MODPACK_MANIFEST);
String name = settings.get(LocalModpackPage.MODPACK_NAME);
String iconUrl = settings.get(LocalModpackPage.MODPACK_ICON_URL);
Set<? extends ModpackFile> selectedFiles = settings.get(LocalModpackPage.MODPACK_SELECTED_FILES);
Charset charset = settings.get(LocalModpackPage.MODPACK_CHARSET);
boolean isManuallyCreated = settings.getOrDefault(LocalModpackPage.MODPACK_MANUALLY_CREATED, false);

Expand All @@ -107,7 +110,7 @@ private Task<?> finishModpackInstallingAsync(SettingsMap settings) {
if (serverModpackManifest != null) {
return ModpackHelper.getUpdateTask(profile, serverModpackManifest, modpack.getEncoding(), name, ModpackHelper.readModpackConfiguration(profile.getRepository().getModpackConfiguration(name)));
} else {
return ModpackHelper.getUpdateTask(profile, selected, modpack.getEncoding(), name, ModpackHelper.readModpackConfiguration(profile.getRepository().getModpackConfiguration(name)));
return ModpackHelper.getUpdateTask(profile, selected, modpack.getEncoding(), name, ModpackHelper.readModpackConfiguration(profile.getRepository().getModpackConfiguration(name)), selectedFiles);
}
} catch (UnsupportedModpackException | ManuallyCreatedModpackException e) {
Controllers.dialog(i18n("modpack.unsupported"), i18n("message.error"), MessageType.ERROR);
Expand All @@ -122,7 +125,7 @@ private Task<?> finishModpackInstallingAsync(SettingsMap settings) {
return ModpackHelper.getInstallTask(profile, serverModpackManifest, name, modpack)
.thenRunAsync(Schedulers.javafx(), () -> profile.setSelectedVersion(name));
} else {
return ModpackHelper.getInstallTask(profile, selected, name, modpack, iconUrl)
return ModpackHelper.getInstallTask(profile, selected, name, modpack, iconUrl, selectedFiles)
.thenRunAsync(Schedulers.javafx(), () -> profile.setSelectedVersion(name));
}
}
Expand Down
Loading