Skip to content

Commit 401d036

Browse files
magicusmagicus
committed
feat: Add toggle button to show/hide child mods, and a search widget (#21)
* chore: Refactor package structure * refactor: Extract TitledScreen * refactor: Extract ModSettingsOption to top-level class * refactor: Rename ModSettingsOption to ModConfigInfo * feat: Filter list of mod based on search string and if child mods are included * chore: Fix incorrect whitespace * refactor: Cleanups and preparing for mod options * feat: Add icon button widgets * feat: Add toggle button to show or hide child mods, and a search widget to filter visible mods * chore: Update changelog
1 parent 15813dc commit 401d036

20 files changed

+372
-90
lines changed

‎CHANGELOG.md

+12
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Changelog
22

3+
## 2.0.0 - 2024-04-28
4+
5+
### Added
6+
7+
- Add a toggleable button for showing or hiding indirect mods. By default
8+
indirect mods are not shown. Indirect mods are installed as child mods from a
9+
top-level mod, and most of the time the setting screens are not relevant for
10+
those.
11+
- Add a search/filter widget to hide non-matching mods. This is useful when you
12+
have a lot of mods installed. By typing a few characters, only mods with a
13+
matching name or id will be shown.
14+
315
## 1.2.0 - 2024-04-28
416

517
### Fixed

‎src/main/java/se/icus/mag/modsettings/Main.java

+7-1
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@
88
import org.apache.logging.log4j.LogManager;
99
import org.apache.logging.log4j.Logger;
1010
import org.lwjgl.glfw.GLFW;
11-
import se.icus.mag.modsettings.gui.ModSettingsScreen;
11+
import se.icus.mag.modsettings.gui.screen.ModSettingsScreen;
1212

1313
public class Main implements ClientModInitializer {
1414
public static final Logger LOGGER = LogManager.getLogger("modsettings");
15+
public static final Options OPTIONS = new Options();
1516

1617
@Override
1718
public void onInitializeClient() {
@@ -25,4 +26,9 @@ public void onInitializeClient() {
2526
}
2627
});
2728
}
29+
30+
public static class Options {
31+
public String filterText = "";
32+
public boolean showIndirect = false;
33+
}
2834
}

‎src/main/java/se/icus/mag/modsettings/ModRegistry.java

+37-5
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,27 @@
44
import com.terraformersmc.modmenu.api.ModMenuApi;
55
import java.util.Comparator;
66
import java.util.HashMap;
7+
import java.util.HashSet;
78
import java.util.List;
89
import java.util.Locale;
910
import java.util.Map;
1011
import java.util.Optional;
12+
import java.util.Set;
1113
import java.util.stream.Collectors;
14+
import java.util.stream.Stream;
1215
import net.fabricmc.loader.api.EntrypointException;
1316
import net.fabricmc.loader.api.FabricLoader;
1417
import net.fabricmc.loader.api.ModContainer;
1518
import net.fabricmc.loader.api.entrypoint.EntrypointContainer;
1619
import net.fabricmc.loader.api.metadata.ModMetadata;
1720
import net.minecraft.client.gui.screen.Screen;
18-
import org.apache.logging.log4j.Level;
1921

2022
public class ModRegistry {
2123
private static final ModRegistry INSTANCE = new ModRegistry();
2224

2325
private final Map<String, String> modNames = new HashMap<>();
26+
private final Map<String, Set<String>> modHierarchy = new HashMap<>();
27+
2428
private final Map<String, ConfigScreenFactory<?>> configScreenFactories = new HashMap<>();
2529
private final Map<String, ConfigScreenFactory<?>> overridingConfigScreenFactories = new HashMap<>();
2630

@@ -33,6 +37,18 @@ public static ModRegistry getInstance() {
3337

3438
/* This needs to be done att the right time of loading the mod, so cannot be done in the constructor. */
3539
public void registerMods() {
40+
for (ModContainer modContainer : FabricLoader.getInstance().getAllMods()) {
41+
String modId = modContainer.getMetadata().getId();
42+
Optional<ModContainer> parent = modContainer.getContainingMod();
43+
if (parent.isPresent()) {
44+
String parentId = parent.get().getMetadata().getId();
45+
Set<String> parentMod = modHierarchy.computeIfAbsent(parentId, k -> new HashSet<>());
46+
parentMod.add(modId);
47+
} else {
48+
modHierarchy.computeIfAbsent(modId, k -> new HashSet<>());
49+
}
50+
}
51+
3652
List<EntrypointContainer<Object>> modList =
3753
FabricLoader.getInstance().getEntrypointContainers("modmenu", Object.class);
3854

@@ -45,7 +61,7 @@ public void registerMods() {
4561
ModMenuApi modApi;
4662

4763
if (unknownApi instanceof com.terraformersmc.modmenu.api.ModMenuApi modernApi) {
48-
Main.LOGGER.log(Level.INFO,"Found configurable mod: " + modId + ", " + metadata.getName());
64+
Main.LOGGER.info("Found configurable mod: " + modId + ", " + metadata.getName());
4965
modApi = modernApi;
5066
} else {
5167
Main.LOGGER.warn("Unknown Mod Menu API version for mod " + modId + ", class: " + unknownApi.getClass());
@@ -62,7 +78,7 @@ public void registerMods() {
6278
Optional<ModContainer> container = FabricLoader.getInstance().getModContainer(overriddenModId);
6379
if (container.isPresent()) {
6480
String modName = container.get().getMetadata().getName();
65-
Main.LOGGER.log(Level.INFO, "Found overridden config for mod: " + overriddenModId + ", " + modName);
81+
Main.LOGGER.info("Found overridden config for mod: " + overriddenModId + ", " + modName);
6682

6783
modNames.put(overriddenModId, modName);
6884
}
@@ -73,14 +89,30 @@ public void registerMods() {
7389
}
7490
}
7591

76-
public List<String> getAllModIds() {
92+
public Stream<String> getAllModIds() {
7793
// Return mods sorted. This sorts on modID and not name, but is good enough.
7894
Comparator<String> sorter = Comparator.comparing(modId -> modId.toLowerCase(Locale.ROOT));
7995

8096
// Fabric treats Vanilla ("minecraft") as a mod and returns the normal Options screen.
8197
// We don't want that so filter it out.
8298
return modNames.keySet().stream().sorted(sorter)
83-
.filter(modId -> !modId.equals("minecraft")).collect(Collectors.toList());
99+
.filter(modId -> !modId.equals("minecraft"));
100+
}
101+
102+
public List<String> getVisibleModIds(boolean showIndirect, String filterText) {
103+
// If showIndirect is false, only include mods that is a parent.
104+
return getAllModIds()
105+
.filter(modId -> showIndirect || modHierarchy.containsKey(modId))
106+
.filter(modId -> filterText.isBlank() || modIdMatches(modId, filterText))
107+
.collect(Collectors.toList());
108+
}
109+
110+
private boolean matches(String haystack, String needle) {
111+
return haystack.toLowerCase(Locale.ROOT).contains(needle.toLowerCase(Locale.ROOT));
112+
}
113+
114+
private boolean modIdMatches(String modId, String filter) {
115+
return matches(modId, filter) || matches(getModName(modId), filter);
84116
}
85117

86118
public String getModName(String modId) {

‎src/main/java/se/icus/mag/modsettings/gui/MenuScreensChanger.java

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
import net.minecraft.client.gui.screen.Screen;
77
import net.minecraft.client.gui.widget.ClickableWidget;
88
import net.minecraft.text.Text;
9+
import se.icus.mag.modsettings.gui.screen.ModSettingsScreen;
10+
import se.icus.mag.modsettings.gui.widget.Button;
911

1012
public abstract class MenuScreensChanger {
1113
private static final int TITLE_FULL_BUTTON_WIDTH = 200;

‎src/main/java/se/icus/mag/modsettings/gui/ModConfigInfo.java

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
package se.icus.mag.modsettings.gui;
2+
3+
import net.minecraft.client.gui.screen.Screen;
4+
5+
public record ModConfigInfo(String modId, String modName, Screen configScreen) {
6+
}

‎src/main/java/se/icus/mag/modsettings/gui/ModSettingsScreen.java

-74
This file was deleted.

‎src/main/java/se/icus/mag/modsettings/gui/screen/ModSettingsScreen.java

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
package se.icus.mag.modsettings.gui.screen;
2+
3+
import java.util.LinkedList;
4+
import java.util.List;
5+
import net.minecraft.client.gui.screen.Screen;
6+
import net.minecraft.client.gui.tooltip.Tooltip;
7+
import net.minecraft.screen.ScreenTexts;
8+
import net.minecraft.text.Text;
9+
import net.minecraft.util.Identifier;
10+
import se.icus.mag.modsettings.Main;
11+
import se.icus.mag.modsettings.ModRegistry;
12+
import se.icus.mag.modsettings.gui.ModConfigInfo;
13+
import se.icus.mag.modsettings.gui.widget.Button;
14+
import se.icus.mag.modsettings.gui.widget.IconToggleButtonWidget;
15+
import se.icus.mag.modsettings.gui.widget.ModListWidget;
16+
import se.icus.mag.modsettings.gui.widget.SearchWidget;
17+
18+
public class ModSettingsScreen extends TitledScreen {
19+
private static final int FULL_BUTTON_WIDTH = 200;
20+
private static final int BUTTON_HEIGHT = 20;
21+
22+
private boolean initIsProcessing;
23+
private ModListWidget list;
24+
private SearchWidget searchWidget;
25+
26+
public ModSettingsScreen(Screen previous) {
27+
super(Text.translatable("modsettings.screen.title"), previous);
28+
}
29+
30+
@Override
31+
protected void init() {
32+
// Protect against mods like Content Creator Integration that triggers
33+
// a recursive call of Screen.init() while creating the settings screen...
34+
if (initIsProcessing) return;
35+
initIsProcessing = true;
36+
37+
// Add the toggle show indirect mods button
38+
IconToggleButtonWidget showIndirectButton = new IconToggleButtonWidget(10, 6,
39+
BUTTON_HEIGHT, BUTTON_HEIGHT, 15, 15,
40+
List.of(new Identifier("modsettings", "expand"),
41+
new Identifier("modsettings", "collapse")),
42+
List.of(Tooltip.of(Text.translatable("modsettings.indirect.show")),
43+
Tooltip.of(Text.translatable("modsettings.indirect.hide"))),
44+
Main.OPTIONS.showIndirect ? 1 : 0, selection -> {
45+
Main.OPTIONS.showIndirect = (selection == 1);
46+
updateModButtons();
47+
});
48+
this.addDrawableChild(showIndirectButton);
49+
50+
// Add the search widget
51+
searchWidget = new SearchWidget(40, 6, 100,
52+
Main.OPTIONS.filterText, this.textRenderer, text -> {
53+
Main.OPTIONS.filterText = text;
54+
updateModButtons();
55+
}, () -> this.setFocused(searchWidget));
56+
57+
this.addDrawableChild(searchWidget);
58+
this.setInitialFocus(searchWidget);
59+
60+
// Add the actual mod list buttons
61+
// Put the list between 32 pixels from top and bottom
62+
this.list = new ModListWidget(this.client, this.width, this.height - 64, 32, 25);
63+
64+
this.addDrawableChild(this.list);
65+
66+
// Add the Done button
67+
this.addDrawableChild(new Button(this.width / 2 - FULL_BUTTON_WIDTH / 2, this.height - 27, FULL_BUTTON_WIDTH, BUTTON_HEIGHT, ScreenTexts.DONE, button -> this.client.setScreen(this.previous)));
68+
69+
updateModButtons();
70+
initIsProcessing = false;
71+
}
72+
73+
private void updateModButtons() {
74+
List<String> visibleModIds = ModRegistry.getInstance().getVisibleModIds(Main.OPTIONS.showIndirect, Main.OPTIONS.filterText);
75+
this.list.setModButtons(getModConfigInfo(visibleModIds));
76+
}
77+
78+
private List<ModConfigInfo> getModConfigInfo(List<String> modIds) {
79+
List<ModConfigInfo> options = new LinkedList<>();
80+
for (String modId : modIds) {
81+
try {
82+
Screen configScreen = ModRegistry.getInstance().getConfigScreen(modId, this);
83+
if (configScreen != null) {
84+
options.add(new ModConfigInfo(modId, ModRegistry.getInstance().getModName(modId), configScreen));
85+
}
86+
} catch (Throwable e) {
87+
Main.LOGGER.error("Error creating Settings screen from mod " + modId, e);
88+
}
89+
}
90+
return options;
91+
}
92+
}

‎src/main/java/se/icus/mag/modsettings/gui/screen/TitledScreen.java

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
package se.icus.mag.modsettings.gui.screen;
2+
3+
import net.minecraft.client.gui.DrawContext;
4+
import net.minecraft.client.gui.screen.Screen;
5+
import net.minecraft.text.Text;
6+
7+
public class TitledScreen extends Screen {
8+
private static final int TITLE_COLOR = 0xffffff;
9+
protected final Screen previous;
10+
11+
public TitledScreen(Text title, Screen previous) {
12+
super(title);
13+
this.previous = previous;
14+
}
15+
16+
@Override
17+
public void render(DrawContext context, int mouseX, int mouseY, float delta) {
18+
super.render(context, mouseX, mouseY, delta);
19+
context.drawCenteredTextWithShadow(this.textRenderer, this.title, this.width / 2, 5, TITLE_COLOR);
20+
}
21+
22+
@Override
23+
public void close() {
24+
this.client.setScreen(this.previous);
25+
}
26+
}

‎src/main/java/se/icus/mag/modsettings/gui/Button.java ‎src/main/java/se/icus/mag/modsettings/gui/widget/Button.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package se.icus.mag.modsettings.gui;
1+
package se.icus.mag.modsettings.gui.widget;
22

33
import net.minecraft.client.gui.widget.ButtonWidget;
44
import net.minecraft.text.Text;

‎src/main/java/se/icus/mag/modsettings/gui/widget/IconButtonWidget.java

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
package se.icus.mag.modsettings.gui.widget;
2+
3+
import net.minecraft.client.font.TextRenderer;
4+
import net.minecraft.client.gui.DrawContext;
5+
import net.minecraft.client.gui.widget.ButtonWidget;
6+
import net.minecraft.text.Text;
7+
import net.minecraft.util.Identifier;
8+
9+
public class IconButtonWidget extends ButtonWidget {
10+
private final int textureWidth;
11+
private final int textureHeight;
12+
protected Identifier texture;
13+
14+
public IconButtonWidget(int x, int y, int width, int height,int textureWidth, int textureHeight,
15+
Identifier texture, ButtonWidget.PressAction onPress) {
16+
this(x, y, width, height, textureWidth, textureHeight, onPress);
17+
this.texture = texture;
18+
}
19+
20+
protected IconButtonWidget(int x, int y, int width, int height,int textureWidth, int textureHeight,
21+
ButtonWidget.PressAction onPress) {
22+
super(x, y, width, height, Text.empty(), onPress, DEFAULT_NARRATION_SUPPLIER);
23+
this.textureWidth = textureWidth;
24+
this.textureHeight = textureHeight;
25+
}
26+
27+
@Override
28+
public void renderWidget(DrawContext context, int mouseX, int mouseY, float delta) {
29+
super.renderWidget(context, mouseX, mouseY, delta);
30+
int x = this.getX() + this.getWidth() / 2 - this.textureWidth / 2;
31+
int y = this.getY() + this.getHeight() / 2 - this.textureHeight / 2;
32+
context.drawGuiTexture(this.texture, x, y, this.textureWidth, this.textureHeight);
33+
}
34+
35+
@Override
36+
public void drawMessage(DrawContext context, TextRenderer textRenderer, int color) {
37+
}
38+
}

0 commit comments

Comments
 (0)