Museum: Display hydrated items for items taken outside of the repo (#621)

Co-authored-by: Lulonaut <lulonaut@tutanota.de>

11 files changed, 410 insertions, 33 deletions

diff --git a/Update Notes/2.1.1.md b/Update Notes/2.1.1.md
index eb6fcc31..47a0d207 100644
--- a/Update Notes/2.1.1.md
+++ b/Update Notes/2.1.1.md
@@ -8,7 +8,6 @@
 - Added universal GUI editor - nopo
 - Added Essenceupgrades GUI - Lulonaut
 - Added Katsitting recipe upgrade - nea89
-- Added cheapest museum item overlay - Lulonaut
 - Added Frozen Treasure Highlighter - heyngra
 - Added SkyBlock levels to PV - efefury 
 
diff --git a/src/main/java/io/github/moulberry/notenoughupdates/NEUManager.java b/src/main/java/io/github/moulberry/notenoughupdates/NEUManager.java
index a001850e..5eab77f9 100644
--- a/src/main/java/io/github/moulberry/notenoughupdates/NEUManager.java
+++ b/src/main/java/io/github/moulberry/notenoughupdates/NEUManager.java
@@ -102,7 +102,7 @@ public class NEUManager {
 	private final TreeMap<String, JsonObject> itemMap = new TreeMap<>();
 	private boolean hasBeenLoadedBefore = false;
 
-	private final TreeMap<String, HashMap<String, List<Integer>>> titleWordMap = new TreeMap<>();
+	public final TreeMap<String, HashMap<String, List<Integer>>> titleWordMap = new TreeMap<>();
 	private final TreeMap<String, HashMap<String, List<Integer>>> loreWordMap = new TreeMap<>();
 
 	public final KeyBinding keybindGive =
@@ -320,7 +320,7 @@ public class NEUManager {
 				synchronized (titleWordMap) {
 					int wordIndex = 0;
 					for (String str : json.get("displayname").getAsString().split(" ")) {
-						str = clean(str);
+						str = cleanForTitleMapSearch(str);
 						if (!titleWordMap.containsKey(str)) {
 							titleWordMap.put(str, new HashMap<>());
 						}
@@ -338,7 +338,7 @@ public class NEUManager {
 					int wordIndex = 0;
 					for (JsonElement element : json.get("lore").getAsJsonArray()) {
 						for (String str : element.getAsString().split(" ")) {
-							str = clean(str);
+							str = cleanForTitleMapSearch(str);
 							if (!loreWordMap.containsKey(str)) {
 								loreWordMap.put(str, new HashMap<>());
 							}
@@ -466,8 +466,8 @@ public class NEUManager {
 		int lastStringMatch = -1;
 		ArrayList<DebugMatch> debugMatches = new ArrayList<>();
 
-		toSearch = clean(toSearch).toLowerCase();
-		query = clean(query).toLowerCase();
+		toSearch = cleanForTitleMapSearch(toSearch).toLowerCase();
+		query = cleanForTitleMapSearch(query).toLowerCase();
 		String[] splitToSearch = toSearch.split(" ");
 		String[] queryArray = query.split(" ");
 
@@ -684,7 +684,7 @@ public class NEUManager {
 	public Set<String> search(String query, TreeMap<String, HashMap<String, List<Integer>>> wordMap) {
 		HashMap<String, List<Integer>> matches = null;
 
-		query = clean(query).toLowerCase();
+		query = cleanForTitleMapSearch(query).toLowerCase();
 		for (String queryWord : query.split(" ")) {
 			HashMap<String, List<Integer>> matchesToKeep = new HashMap<>();
 			for (HashMap<String, List<Integer>> wordMatches : subMapWithKeysThatAreSuffixes(queryWord, wordMap).values()) {
@@ -859,7 +859,7 @@ public class NEUManager {
 		return item;
 	}
 
-	private String clean(String str) {
+	public static String cleanForTitleMapSearch(String str) {
 		return str.replaceAll("(\u00a7.)|[^0-9a-zA-Z ]", "").toLowerCase().trim();
 	}
 
diff --git a/src/main/java/io/github/moulberry/notenoughupdates/events/GuiContainerBackgroundDrawnEvent.java b/src/main/java/io/github/moulberry/notenoughupdates/events/GuiContainerBackgroundDrawnEvent.java
new file mode 100644
index 00000000..bdb6d1a1
--- /dev/null
+++ b/src/main/java/io/github/moulberry/notenoughupdates/events/GuiContainerBackgroundDrawnEvent.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright (C) 2022 NotEnoughUpdates contributors
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.events;
+
+import lombok.Value;
+import net.minecraft.client.gui.inventory.GuiContainer;
+
+@Value
+public class GuiContainerBackgroundDrawnEvent extends NEUEvent {
+	public GuiContainer container;
+	public float partialTicks;
+}
diff --git a/src/main/java/io/github/moulberry/notenoughupdates/mixins/MixinGuiContainer.java b/src/main/java/io/github/moulberry/notenoughupdates/mixins/MixinGuiContainer.java
index a5bb99b8..8aca73d1 100644
--- a/src/main/java/io/github/moulberry/notenoughupdates/mixins/MixinGuiContainer.java
+++ b/src/main/java/io/github/moulberry/notenoughupdates/mixins/MixinGuiContainer.java
@@ -21,6 +21,7 @@ package io.github.moulberry.notenoughupdates.mixins;
 
 import io.github.moulberry.notenoughupdates.NEUOverlay;
 import io.github.moulberry.notenoughupdates.NotEnoughUpdates;
+import io.github.moulberry.notenoughupdates.events.GuiContainerBackgroundDrawnEvent;
 import io.github.moulberry.notenoughupdates.events.SlotClickEvent;
 import io.github.moulberry.notenoughupdates.listener.RenderListener;
 import io.github.moulberry.notenoughupdates.miscfeatures.AbiphoneFavourites;
@@ -330,6 +331,6 @@ public abstract class MixinGuiContainer extends GuiScreen {
 
 	@Inject(method = "drawScreen", at = @At(value = "INVOKE", target = "Lnet/minecraft/client/renderer/GlStateManager;color(FFFF)V", ordinal = 1))
 	private void drawBackground(int mouseX, int mouseY, float partialTicks, CallbackInfo ci) {
-		AbiphoneFavourites.getInstance().onDrawBackground(this);
+		new GuiContainerBackgroundDrawnEvent(((GuiContainer) (Object) this), partialTicks).post();
 	}
 }
diff --git a/src/main/java/io/github/moulberry/notenoughupdates/options/NEUConfig.java b/src/main/java/io/github/moulberry/notenoughupdates/options/NEUConfig.java
index 552cb5b1..e9c34e03 100644
--- a/src/main/java/io/github/moulberry/notenoughupdates/options/NEUConfig.java
+++ b/src/main/java/io/github/moulberry/notenoughupdates/options/NEUConfig.java
@@ -56,6 +56,7 @@ import io.github.moulberry.notenoughupdates.options.seperateSections.Mining;
 import io.github.moulberry.notenoughupdates.options.seperateSections.MinionHelper;
 import io.github.moulberry.notenoughupdates.options.seperateSections.Misc;
 import io.github.moulberry.notenoughupdates.options.seperateSections.MiscOverlays;
+import io.github.moulberry.notenoughupdates.options.seperateSections.Museum;
 import io.github.moulberry.notenoughupdates.options.seperateSections.NeuAuctionHouse;
 import io.github.moulberry.notenoughupdates.options.seperateSections.Notifications;
 import io.github.moulberry.notenoughupdates.options.seperateSections.PetOverlay;
@@ -387,6 +388,13 @@ public class NEUConfig extends Config {
 
 	@Expose
 	@Category(
+		name = "Museum",
+		desc = "Museum overlays"
+	)
+	public Museum museum = new Museum();
+
+	@Expose
+	@Category(
 		name = "Profile Viewer",
 		desc = "Profile Viewer"
 	)
diff --git a/src/main/java/io/github/moulberry/notenoughupdates/options/seperateSections/Museum.java b/src/main/java/io/github/moulberry/notenoughupdates/options/seperateSections/Museum.java
new file mode 100644
index 00000000..c476fc3b
--- /dev/null
+++ b/src/main/java/io/github/moulberry/notenoughupdates/options/seperateSections/Museum.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2023 NotEnoughUpdates contributors
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.options.seperateSections;
+
+import com.google.gson.annotations.Expose;
+import io.github.moulberry.notenoughupdates.core.config.annotations.ConfigEditorBoolean;
+import io.github.moulberry.notenoughupdates.core.config.annotations.ConfigEditorColour;
+import io.github.moulberry.notenoughupdates.core.config.annotations.ConfigOption;
+
+public class Museum {
+
+	@Expose
+	@ConfigOption(
+		name = "Show Museum Items",
+		desc = "Show real items instead of green dye in the museum"
+	)
+	@ConfigEditorBoolean
+	public boolean museumItemShow = false;
+
+	@Expose
+	@ConfigOption(
+		name = "Highlight virtual museum items",
+		desc = "Highlight virtual museum items with a background color"
+	)
+	@ConfigEditorColour
+	public String museumItemColor = "0:255:0:255:0";
+
+}
diff --git a/src/main/java/io/github/moulberry/notenoughupdates/util/ItemResolutionQuery.java b/src/main/java/io/github/moulberry/notenoughupdates/util/ItemResolutionQuery.java
index ea5e13ab..280a0d3d 100644
--- a/src/main/java/io/github/moulberry/notenoughupdates/util/ItemResolutionQuery.java
+++ b/src/main/java/io/github/moulberry/notenoughupdates/util/ItemResolutionQuery.java
@@ -24,6 +24,7 @@ import com.google.gson.JsonParseException;
 import io.github.moulberry.notenoughupdates.NEUManager;
 import io.github.moulberry.notenoughupdates.NotEnoughUpdates;
 import io.github.moulberry.notenoughupdates.core.util.StringUtils;
+import lombok.var;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.gui.Gui;
 import net.minecraft.client.gui.inventory.GuiChest;
@@ -36,9 +37,10 @@ import net.minecraft.nbt.NBTTagCompound;
 
 import javax.annotation.Nullable;
 import java.util.Arrays;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Locale;
-import java.util.Map;
+import java.util.Set;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -188,31 +190,63 @@ public class ItemResolutionQuery {
 		return null;
 	}
 
+	/**
+	 * Search for an item by the display name
+	 *
+	 * @param displayName  The display name of the item we are searching
+	 * @param mayBeMangled Whether the item name may be mangled (for example: reforges, stars)
+	 * @return the internal neu item id of that item, or null
+	 */
+	public static String findInternalNameByDisplayName(String displayName, boolean mayBeMangled) {
+		var cleanDisplayName = StringUtils.cleanColour(displayName);
+		var manager = NotEnoughUpdates.INSTANCE.manager;
+		String bestMatch = null;
+		int bestMatchLength = -1;
+		for (String internalName : findInternalNameCandidatesForDisplayName(cleanDisplayName)) {
+			var item = manager.createItem(internalName);
+			if (item.getDisplayName() == null) continue;
+			var cleanItemDisplayName = StringUtils.cleanColour(item.getDisplayName());
+			if (cleanItemDisplayName.length() == 0) continue;
+			if (mayBeMangled
+				? !cleanDisplayName.contains(cleanItemDisplayName)
+				: !cleanItemDisplayName.equals(cleanDisplayName)) {
+				continue;
+			}
+			if (cleanItemDisplayName.length() > bestMatchLength) {
+				bestMatchLength = cleanItemDisplayName.length();
+				bestMatch = internalName;
+			}
+		}
+		return bestMatch;
+	}
+
+	/**
+	 * Find potential item ids for a given display name. This function is over eager to give results,
+	 * and may give invalid results, but if there is a matching item in the repository it will return <em>at least</em>
+	 * that item. This should be used as a first filtering pass. Use {@link #findInternalNameByDisplayName} for a more
+	 * user-friendly API.
+	 *
+	 * @param displayName The display name of the item we are searching
+	 * @return a list of internal neu item ids some of which may have a matching display name
+	 */
+	public static Set<String> findInternalNameCandidatesForDisplayName(String displayName) {
+		var cleanDisplayName = NEUManager.cleanForTitleMapSearch(displayName);
+		var titleWordMap = NotEnoughUpdates.INSTANCE.manager.titleWordMap;
+		var candidates = new HashSet<String>();
+		for (var partialDisplayName : cleanDisplayName.split(" ")) {
+			if (!titleWordMap.containsKey(partialDisplayName)) continue;
+			candidates.addAll(titleWordMap.get(partialDisplayName).keySet());
+		}
+		return candidates;
+	}
+
 	private String resolveItemInCatacombsRngMeter() {
 		List<String> lore = ItemUtils.getLore(compound);
 		if (lore.size() > 16) {
 			String s = lore.get(15);
 			if (s.equals("§7Selected Drop")) {
 				String displayName = lore.get(16);
-				return getInternalNameByDisplayName(displayName);
-			}
-		}
-
-		return null;
-	}
-
-	private String getInternalNameByDisplayName(String displayName) {
-		String cleanDisplayName = StringUtils.cleanColour(displayName);
-		for (Map.Entry<String, JsonObject> entry : NotEnoughUpdates.INSTANCE.manager
-			.getItemInformation()
-			.entrySet()) {
-
-			JsonObject object = entry.getValue();
-			if (object.has("displayname")) {
-				String name = object.get("displayname").getAsString();
-				if (StringUtils.cleanColour(name).equals(cleanDisplayName)) {
-					return entry.getKey();
-				}
+				return findInternalNameByDisplayName(displayName, false);
 			}
 		}
 
diff --git a/src/main/java/io/github/moulberry/notenoughupdates/util/LRUCache.java b/src/main/java/io/github/moulberry/notenoughupdates/util/LRUCache.java
index f107d522..6adbc30d 100644
--- a/src/main/java/io/github/moulberry/notenoughupdates/util/LRUCache.java
+++ b/src/main/java/io/github/moulberry/notenoughupdates/util/LRUCache.java
@@ -32,13 +32,15 @@ public interface LRUCache<K, V> extends Function<K, V> {
 	}
 
 	static <K, V> LRUCache<K, V> memoize(Function<K, V> mapper, IntSupplier maxCacheSize) {
-		Map<K, V> cache = new LinkedHashMap<K, V>(10, 0.75F, true) {
+		Map<K, Object> cache = new LinkedHashMap<K, Object>(10, 0.75F, true) {
 			@Override
-			protected boolean removeEldestEntry(Map.Entry<K, V> eldest) {
+			protected boolean removeEldestEntry(Map.Entry<K, Object> eldest) {
 				return this.size() > maxCacheSize.getAsInt();
 			}
 		};
-		Map<K, V> synchronizedCache = Collections.synchronizedMap(cache);
+		Object SENTINEL_CACHE_RESULT_NULL = new Object();
+		Function<K, Object> sentinelAwareMapper = mapper.andThen(it -> it == null ? SENTINEL_CACHE_RESULT_NULL : it);
+		Map<K, Object> synchronizedCache = Collections.synchronizedMap(cache);
 		return new LRUCache<K, V>() {
 			@Override
 			public void clearCache() {
@@ -52,7 +54,8 @@ public interface LRUCache<K, V> extends Function<K, V> {
 
 			@Override
 			public V apply(K k) {
-				return synchronizedCache.computeIfAbsent(k, mapper);
+				Object value = synchronizedCache.computeIfAbsent(k, sentinelAwareMapper);
+				return value == SENTINEL_CACHE_RESULT_NULL ? null : (V) value;
 			}
 		};
 	}
diff --git a/src/main/kotlin/io/github/moulberry/notenoughupdates/miscfeatures/inventory/MuseumItemHighlighter.kt b/src/main/kotlin/io/github/moulberry/notenoughupdates/miscfeatures/inventory/MuseumItemHighlighter.kt
new file mode 100644
index 00000000..945449ba
--- /dev/null
+++ b/src/main/kotlin/io/github/moulberry/notenoughupdates/miscfeatures/inventory/MuseumItemHighlighter.kt
@@ -0,0 +1,121 @@
+/*
+ * Copyright (C) 2022 Linnea Gräf
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.miscfeatures.inventory
+
+import io.github.moulberry.notenoughupdates.NotEnoughUpdates
+import io.github.moulberry.notenoughupdates.autosubscribe.NEUAutoSubscribe
+import io.github.moulberry.notenoughupdates.core.ChromaColour
+import io.github.moulberry.notenoughupdates.core.util.StringUtils
+import io.github.moulberry.notenoughupdates.events.GuiContainerBackgroundDrawnEvent
+import io.github.moulberry.notenoughupdates.events.ReplaceItemEvent
+import io.github.moulberry.notenoughupdates.events.RepositoryReloadEvent
+import io.github.moulberry.notenoughupdates.util.ItemResolutionQuery
+import io.github.moulberry.notenoughupdates.util.ItemUtils
+import io.github.moulberry.notenoughupdates.util.LRUCache
+import io.github.moulberry.notenoughupdates.util.MuseumUtil
+import net.minecraft.client.gui.Gui
+import net.minecraft.init.Items
+import net.minecraft.inventory.ContainerChest
+import net.minecraft.inventory.IInventory
+import net.minecraft.item.EnumDyeColor
+import net.minecraft.item.ItemStack
+import net.minecraftforge.fml.common.eventhandler.SubscribeEvent
+
+@NEUAutoSubscribe
+object MuseumItemHighlighter {
+
+    private val manager get() = NotEnoughUpdates.INSTANCE.manager
+    private val config get() = NotEnoughUpdates.INSTANCE.config.museum
+
+    private fun getHighlightColor() = ChromaColour.specialToChromaRGB(config.museumItemColor)
+
+
+    private val findRawItemForName = LRUCache.memoize(::findRawItemForName0, 4 * 7 * 2)
+
+    @SubscribeEvent
+    fun onRepositoryReload(event: RepositoryReloadEvent) {
+        findRawItemForName.clearCache()
+    }
+
+    private fun findRawItemForName0(arg: Pair<String, Boolean>): ItemStack? {
+        val (name, armor) = arg
+        return MuseumUtil.findItemsByName(name, armor).firstOrNull()?.let { manager.createItem(it) }
+    }
+
+
+    @SubscribeEvent
+    fun onItemOverride(event: ReplaceItemEvent) {
+        if (!config.museumItemShow) return
+        if (!isMuseumInventory(event.inventory)) return
+        val original = event.original ?: return
+        if (!isCompletedRetrievedItem(original)) return
+        val armor = StringUtils.cleanColour(event.inventory.displayName.unformattedText).endsWith("Armor Sets")
+        val rawItem = findRawItemForName.apply(original.displayName to armor) ?: return
+        val hydratedItem = hydrateMuseumItem(rawItem, original)
+        event.replaceWith(hydratedItem)
+    }
+
+    fun isCompletedRetrievedItem(itemStack: ItemStack): Boolean {
+        return itemStack.hasDisplayName() && itemStack.item == Items.dye && EnumDyeColor.byDyeDamage(itemStack.itemDamage) == EnumDyeColor.LIME
+    }
+
+    fun isMuseumInventory(inventory: IInventory): Boolean {
+        return StringUtils.cleanColour(inventory.displayName.unformattedText).startsWith("Museum ➜")
+    }
+
+    @SubscribeEvent
+    fun onBackgroundDrawn(event: GuiContainerBackgroundDrawnEvent) {
+        val egui = event.container ?: return
+        val chest = egui.inventorySlots as? ContainerChest ?: return
+        if (!config.museumItemShow) return
+        if (!isMuseumInventory(chest.lowerChestInventory)) return
+        val fixedHighlightColor = getHighlightColor()
+        for (slot in chest.inventorySlots) {
+            if (slot == null || slot.stack == null) continue
+            if (isHydratedMuseumItem(slot.stack) || isCompletedRetrievedItem(slot.stack)) {
+                val left = slot.xDisplayPosition
+                val top = slot.yDisplayPosition
+                Gui.drawRect(
+                    left, top,
+                    left + 16, top + 16,
+                    fixedHighlightColor
+                )
+            }
+        }
+    }
+
+    fun hydrateMuseumItem(rawItem: ItemStack, original: ItemStack) = rawItem.copy().apply {
+        setStackDisplayName(original.displayName)
+        val originalLore = ItemUtils.getLore(original).toMutableList()
+        ItemUtils.setLore(this, originalLore)
+        val data = ItemUtils.getOrCreateTag(this)
+        val extraAttributes = data.getCompoundTag("ExtraAttributes")
+        extraAttributes.setByte("donated_museum", 1)
+        data.setTag("ExtraAttributes", extraAttributes)
+        data.setBoolean(MUSEUM_HYDRATED_ITEM_TAG, true)
+    }
+
+    fun isHydratedMuseumItem(stack: ItemStack): Boolean {
+        return ItemUtils.getOrCreateTag(stack).getBoolean(MUSEUM_HYDRATED_ITEM_TAG)
+    }
+
+    const val MUSEUM_HYDRATED_ITEM_TAG = "NEU_HYDRATED_MUSEUM_ITEM"
+
+}
diff --git a/src/main/kotlin/io/github/moulberry/notenoughupdates/util/KotlinStringUtils.kt b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/KotlinStringUtils.kt
new file mode 100644
index 00000000..dc1e800c
--- /dev/null
+++ b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/KotlinStringUtils.kt
@@ -0,0 +1,24 @@
+/*
+ * Copyright (C) 2022 NotEnoughUpdates contributors
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.util
+
+import net.minecraft.util.StringUtils
+
+fun String.stripControlCodes(): String = StringUtils.stripControlCodes(this)
diff --git a/src/main/kotlin/io/github/moulberry/notenoughupdates/util/MuseumUtil.kt b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/MuseumUtil.kt
new file mode 100644
index 00000000..dd52d175
--- /dev/null
+++ b/src/main/kotlin/io/github/moulberry/notenoughupdates/util/MuseumUtil.kt
@@ -0,0 +1,113 @@
+/*
+ * Copyright (C) 2023 NotEnoughUpdates contributors
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.util
+
+import io.github.moulberry.notenoughupdates.NEUManager
+import io.github.moulberry.notenoughupdates.NotEnoughUpdates
+import net.minecraft.item.EnumDyeColor
+import net.minecraft.item.ItemDye
+import net.minecraft.item.ItemStack
+
+object MuseumUtil {
+
+    data class MuseumItem(
+        /**
+         * A potentially non-exhaustive list of item ids that are required for this museum donation.
+         */
+        val skyblockItemIds: List<String>,
+        val state: DonationState,
+    )
+
+    enum class DonationState {
+        /**
+         * Donated armor only shows one piece, so we use that for id resolution, which might result in incomplete
+         * results (hence the separate state). This still means that the entire set is donated, but it is guaranteed to
+         * be only a partial result. Other values of this enum do not guarantee a full result, but at least they do not
+         * guarantee a partial one.
+         */
+        DONATED_PRESENT_PARTIAL,
+        DONATED_PRESENT,
+        DONATED_VACANT,
+        MISSING,
+    }
+
+    fun findMuseumItem(stack: ItemStack, isOnArmorPage: Boolean): MuseumItem? {
+        val item = stack.item ?: return null
+        val items by lazy { findItemsByName(stack.displayName, isOnArmorPage)}
+        if (item is ItemDye) {
+            val dyeColor = EnumDyeColor.byDyeDamage(stack.itemDamage)
+            if (dyeColor == EnumDyeColor.LIME) {
+                // Item is donated, but not present in the museum
+                return MuseumItem(items, DonationState.DONATED_VACANT)
+            } else if (dyeColor == EnumDyeColor.GRAY) {
+                // Item is not donated
+                return MuseumItem(items, DonationState.MISSING)
+            }
+            // Otherwise unknown item, try to analyze as normal item.
+        }
+        val skyblockId = NotEnoughUpdates.INSTANCE.manager.createItemResolutionQuery().withItemStack(stack)
+            .resolveInternalName()
+        if (skyblockId != null) {
+            return MuseumItem(
+                listOf(skyblockId),
+                if (isOnArmorPage) DonationState.DONATED_PRESENT_PARTIAL else DonationState.DONATED_PRESENT
+            )
+        }
+        return MuseumItem(
+            items,
+            DonationState.DONATED_PRESENT
+        )
+    }
+
+    fun findItemsByName(displayName: String, armor: Boolean): List<String> {
+        return (if (armor)
+            findMuseumArmorSetByName(displayName)
+        else
+            listOf(findMuseumItemByName(displayName))).filterNotNull()
+
+    }
+
+    fun findMuseumItemByName(displayName: String): String? =
+        ItemResolutionQuery.findInternalNameByDisplayName(displayName, true)
+
+
+    fun findMuseumArmorSetByName(displayName: String): List<String?> {
+        val armorSlots = arrayOf(
+            "HELMET",
+            "LEGGINGS",
+            "CHESTPLATE",
+            "BOOTS"
+        )
+        val monochromeName = NEUManager.cleanForTitleMapSearch(displayName)
+        val results = ItemResolutionQuery.findInternalNameCandidatesForDisplayName(displayName)
+            .asSequence()
+            .filter {
+                val item = NotEnoughUpdates.INSTANCE.manager.createItem(it)
+                val name = NEUManager.cleanForTitleMapSearch(item.displayName)
+                monochromeName.replace("armor", "") in name
+            }
+            .toSet()
+        return armorSlots.map { armorSlot ->
+            results.singleOrNull { armorSlot in it }
+        }
+    }
+
+
+}