Skip to content

Add configurable item ordering options #156

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
dvdkon wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add configurable item ordering options #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions src/main/java/cpw/mods/inventorysorter/Config.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ public class Config {
final ForgeConfigSpec.ConfigValue<List<? extends String>> containerBlacklist;
final ForgeConfigSpec.ConfigValue<List<? extends String>> slotBlacklist;

final ForgeConfigSpec.ConfigValue<ItemOrdering> itemOrdering;

private Config(ForgeConfigSpec.Builder builder) {
builder.comment("Inventory sorter blacklists");
builder.push("blacklists");
Expand All @@ -31,5 +33,10 @@ private Config(ForgeConfigSpec.Builder builder) {
.translation("inventorysorter.config.slotblacklist")
.defineList("slotBlacklist", new ArrayList<>(), t -> true);
builder.pop();

itemOrdering = builder
.comment("Item ordering method")
.translation("inventorysorter.config.itemordering")
.defineEnum("itemOrdering", ItemOrdering.BY_COUNT);
}
}
13 changes: 13 additions & 0 deletions src/main/java/cpw/mods/inventorysorter/InventorySorter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ public class InventorySorter
final Set<ResourceLocation> containerblacklist = new HashSet<>();
boolean configLoaded = false;

ItemOrdering itemOrdering = ItemOrdering.BY_COUNT;

public InventorySorter() {
INSTANCE = this;
final IEventBus bus = FMLJavaModLoadingContext.get().getModEventBus();
Expand Down Expand Up @@ -110,6 +112,7 @@ private void updateConfig() {
if (!configLoaded) return;
Config.CONFIG.containerBlacklist.set(containerblacklist.stream().map(Objects::toString).collect(Collectors.toList()));
Config.CONFIG.slotBlacklist.set(new ArrayList<>(slotblacklist));
Config.CONFIG.itemOrdering.set(itemOrdering);
}

private void preinit(FMLCommonSetupEvent evt) {
Expand All @@ -125,6 +128,8 @@ void onConfigLoad(ModConfigEvent configEvent) {
this.slotblacklist.addAll(Config.CONFIG.slotBlacklist.get());
this.containerblacklist.clear();
this.containerblacklist.addAll(Config.CONFIG.containerBlacklist.get().stream().map(ResourceLocation::new).collect(Collectors.toSet()));

itemOrdering = Config.CONFIG.itemOrdering.get();
}

boolean wheelModConflicts() {
Expand Down Expand Up @@ -192,6 +197,14 @@ static int showBlacklist(final CommandContext<CommandSourceStack> context) {

static Stream<ResourceLocation> listContainers() {
return ForgeRegistries.MENU_TYPES.getEntries().stream().map(e->e.getKey().location());
}

static int setItemOrdering(final CommandContext<CommandSourceStack> context) {
final ItemOrdering newOrdering = context.getArgument("ordering", ItemOrdering.class);
INSTANCE.itemOrdering = newOrdering;
INSTANCE.updateConfig();
context.getSource().sendSuccess(Component.translatable("inventorysorter.commands.inventorysorter.setorder.ok", newOrdering.toString()), true);
return 0;
}

static Stream<ResourceLocation> listBlacklist() {
Expand Down
8 changes: 5 additions & 3 deletions src/main/java/cpw/mods/inventorysorter/InventorySorterCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import net.minecraftforge.fml.loading.StringUtils;
import net.minecraftforge.registries.DeferredRegister;
import net.minecraftforge.registries.RegistryObject;
import net.minecraftforge.server.command.EnumArgument;

public class InventorySorterCommand {
public static void register(final CommandDispatcher<CommandSourceStack> dispatcher) {
Expand All @@ -49,13 +50,14 @@ private enum CommandAction {
BLADD(InventorySorter::blackListAdd, 1, Commands.argument("container", new ContainerResourceLocationArgument()).suggests(suggester(InventorySorter::listContainers))),
BLREMOVE(InventorySorter::blackListRemove, 4, Commands.argument("container", new ContainerResourceLocationArgument()).suggests(suggester(InventorySorter::listBlacklist))),
SHOWLAST(InventorySorter::showLast, 1, null),
LIST(InventorySorter::showBlacklist, 1, null);
LIST(InventorySorter::showBlacklist, 1, null),
SETORDERING(InventorySorter::setItemOrdering, 1, Commands.argument("ordering", EnumArgument.enumArgument(ItemOrdering.class)));

private final int permissionLevel;
private RequiredArgumentBuilder<CommandSourceStack, ResourceLocation> suggester;
private RequiredArgumentBuilder<CommandSourceStack, ?> suggester;
private final ToIntFunction<CommandContext<CommandSourceStack>> action;

CommandAction(final ToIntFunction<CommandContext<CommandSourceStack>> action, final int permissionLevel, final RequiredArgumentBuilder<CommandSourceStack, ResourceLocation> suggester) {
CommandAction(final ToIntFunction<CommandContext<CommandSourceStack>> action, final int permissionLevel, final RequiredArgumentBuilder<CommandSourceStack, ?> suggester) {
this.action = action;
this.permissionLevel = permissionLevel;
this.suggester = suggester;
Expand Down
71 changes: 71 additions & 0 deletions src/main/java/cpw/mods/inventorysorter/ItemOrdering.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/*
* Copyright © 2022 David Koňařík
* This file is part of Inventorysorter.
*
* Inventorysorter is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Inventorysorter 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Inventorysorter. If not, see <http://www.gnu.org/licenses/>.
*/

package cpw.mods.inventorysorter;

import java.util.Comparator;
import java.util.stream.Stream;

import com.google.common.collect.Multiset;
import com.google.common.collect.Multiset.Entry;

import net.minecraftforge.registries.ForgeRegistries;

/**
* Enum deciding how to order items during sorting
*/
public enum ItemOrdering {
BY_COUNT,
BY_MOD_AND_NAME,
BY_NAME;

public Stream<Entry<ItemStackHolder>> ordered(Multiset<ItemStackHolder> itemCounts) {
if (this == BY_COUNT)
return orderedByCount(itemCounts);
if (this == BY_MOD_AND_NAME)
return orderedByModAndName(itemCounts);
if (this == BY_NAME)
return orderedByName(itemCounts);
throw new IllegalStateException();
}

private static Stream<Entry<ItemStackHolder>> orderedByCount(Multiset<ItemStackHolder> itemCounts) {
return itemCounts.entrySet().stream()
.sorted((a, b) -> {
int countComp = Integer.compare(a.getCount(), b.getCount());
if (countComp != 0)
return -countComp; // Descending
var itemA = a.getElement().is.getItem();
var itemB = b.getElement().is.getItem();
return ForgeRegistries.ITEMS.getKey(itemA).toString()
.compareTo(ForgeRegistries.ITEMS.getKey(itemB).toString());
});
}

private static Stream<Entry<ItemStackHolder>> orderedByModAndName(Multiset<ItemStackHolder> itemCounts) {
return itemCounts.entrySet().stream()
.sorted(Comparator.comparing(e ->
ForgeRegistries.ITEMS.getKey(e.getElement().is.getItem()).toString()));
}

private static Stream<Entry<ItemStackHolder>> orderedByName(Multiset<ItemStackHolder> itemCounts) {
return itemCounts.entrySet().stream()
.sorted(Comparator.comparing(e ->
ForgeRegistries.ITEMS.getKey(e.getElement().is.getItem()).getPath()));
}
}
9 changes: 7 additions & 2 deletions src/main/java/cpw/mods/inventorysorter/SortingHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
import com.google.common.base.*;
import com.google.common.collect.*;
import net.minecraft.core.Registry;
import com.google.common.collect.Multiset.Entry;

import net.minecraft.world.inventory.AbstractContainerMenu;
import net.minecraft.world.inventory.InventoryMenu;
import net.minecraft.world.inventory.Slot;
Expand All @@ -29,6 +31,9 @@
import org.apache.logging.log4j.*;

import javax.annotation.*;

import java.util.Comparator;
import java.util.Iterator;
import java.util.function.*;

import net.minecraft.world.inventory.CraftingContainer;
Expand Down Expand Up @@ -125,10 +130,10 @@ private void compactInventory(final ContainerContext context, final Multiset<Ite
}

InventorySorter.INSTANCE.debugLog("Container \"{}\" being sorted", ()->new String[] {containerTypeName.toString()});
final UnmodifiableIterator<Multiset.Entry<ItemStackHolder>> itemsIterator;
final Iterator<Multiset.Entry<ItemStackHolder>> itemsIterator;
try
{
itemsIterator = Multisets.copyHighestCountFirst(itemcounts).entrySet().iterator();
itemsIterator = InventorySorter.INSTANCE.itemOrdering.ordered(itemcounts).iterator();
}
catch (Exception e)
{
Expand Down
3 changes: 2 additions & 1 deletion src/main/resources/assets/inventorysorter/lang/en_us.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"inventorysorter.commands.inventorysorter.showlast.nosort": "You have not sorted a container yet. Try sorting one!",
"inventorysorter.commands.inventorysorter.showblacklist.message": "Current blacklist §e{0}§f",
"inventorysorter.commands.inventorysorter.showblacklist.empty": "The blacklist is empty",
"inventorysorter.commands.inventorysorter.setorder.ok": "Set ordering method to §e{0}§f",
"inventorysorter.config.containerblacklist": "Container blacklist",
"inventorysorter.config.slotblacklist": "Slot type blacklist"
}
}
3 changes: 2 additions & 1 deletion src/main/resources/assets/inventorysorter/lang/en_us.lang
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ inventorysorter.commands.inventorysorter.blremove.message=Removed %1$s§f from c
inventorysorter.commands.inventorysorter.show.message=Last container sorted %1$s
inventorysorter.commands.inventorysorter.list.message=Current blacklist %1$s
inventorysorter.commands.inventorysorter.list.empty=The blacklist is empty
inventorysorter.commands.inventorysorter.noop=§cThe last command had no effect (maybe try sorting a container?)
inventorysorter.commands.inventorysorter.noop=§cThe last command had no effect (maybe try sorting a container?)
inventorysorter.commands.inventorysorter.setorder.ok=Set ordering method to §e{0}§f