Merge pull request #769 from FTBTeam/dev

Dev

Author: desht

CHANGELOG.md

@@ -4,6 +4,47 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2101.1.6]
+
+### Added
+* New hotkeys when hovering quests:
+  * Left-Alt & Left-Mouse opens directly to quest properties
+  * Right-Alt & Left-Mouse copies the quest
+* Added `/ftbquests change_progress <player> reset-all` and `... complete-all` commands
+  * These are equivalent to the existing `/ftbquests change_progress <player> reset 1` and `... complete 1` but are clearer, avoiding the use of the magic "1" id which represents the whole quest book
+* Added `/ftbquests reload quests` and `/ftbquests reload team_progress` variants to the existing `/ftbquests reload` command
+  * Reload just the quest book data or the team progression data
+* Added new quest theme property `"dependency_line_unavailable_color` to color lines drawn from currently locked quests to their dependents
+  * Default colour is a slightly faded version of the `dependency_line_uncompleted_color` property
+* Backspace key now actually moves back to previously viewed quest when pressed on the quest view panel (previously operated as Escape and just closed the panel)
+  *  Can be disabled in client config to get old behaviour back, but why would you want to?
+* The "click_event" -> "change_page" action in json text components in quest description text can now jump to a specific subpage of a quest if it has multiple pages
+  * Example syntax: `[ { "text": "click me", "underlined": true, "clickEvent": { "action": "change_page", "value": "74D53BE3AB369184/2" } } ]` jumps to page 2 of the quest (note the `/2` on the end of the quest ID)
+
+### Changed
+* Now using the FTB Library 2101.1.10 config system
+  * **IMPORTANT** the client config file `local/ftbquests/client-config.snbt` is now `config/ftbquests-client.snbt`
+  * Existing configs are auto-migrated; players do not need to take any action
+* Command rewards: replaced boolean "Run with Elevated Permission" with integer "Permission Level"
+  * Permission level may be anything between 0 and 4 inclusive; see https://minecraft.wiki/w/Permission_level
+  * Previous data is migrated; true value of "Run with Elevated Permission" maps to permission level 2
+* Kill Entity task now has "Entity Type" and "Entity Name" properties
+  * "Entity Type" is renamed from the old "Entity Name"
+  * "Entity Name" can be used to require that the entity have a custom name (either a player name or a name from a name tag for non-player entities)
+* Players no longer need to be in edit mode to do `/ftbquests reload` (but still must have editor permission, of course)
+
+### Fixed
+* Fixed chapter panel always starting open (and sliding shut) even if not pinned
+* Fixed `/ftbquests import_reward_table_from_chest` command not correctly updating quest book id mappings for new reward table
+* Quest view panel now uses the "quest_view_border" theme property from `ftb_quests_theme.txt` consistently now
+  * Previously a mixture of "quest_view_border" and "widget_border" were used to draw the border lines for the view panel
+* Fixed some quest button alignment issues depending on the zoom level of the quest panel
+* Fixed autoclaim rewards being given to entire team even when marked as team reward
+  * Also added tooltip to team reward setting in the reward properties GUI to clarify: team reward means one reward for the whole team
+* Fixed multiline quest editor "L" (insert link) button sometimes inserting a spurious comma, depending on current text selection
+* Leading/trailing whitespace is now silently trimmed from command text in command rewards (trailing whitespace could cause confusing failures to execute commands)
+* Fixed "Disable in JEI" quest property not being correctly saved or sync'd to clients
+
 ## [2101.1.5]
 
 ### Changed

common/src/main/java/dev/ftb/mods/ftbquests/FTBQuests.java

@@ -4,9 +4,11 @@
 import dev.architectury.utils.Env;
 import dev.architectury.utils.EnvExecutor;
 import dev.architectury.utils.GameInstance;
+import dev.ftb.mods.ftblibrary.config.manager.ConfigManager;
 import dev.ftb.mods.ftbquests.api.FTBQuestsAPI;
 import dev.ftb.mods.ftbquests.client.FTBQClientProxy;
 import dev.ftb.mods.ftbquests.client.FTBQuestsClient;
+import dev.ftb.mods.ftbquests.client.FTBQuestsClientConfig;
 import dev.ftb.mods.ftbquests.integration.RecipeModHelper;
 import dev.ftb.mods.ftbquests.net.ClearDisplayCacheMessage;
 import dev.ftb.mods.ftbquests.net.FTBQuestsNetHandler;
@@ -37,6 +39,8 @@ public class FTBQuests {
 	public FTBQuests() {
 		FTBQuestsAPI._init(FTBQuestsAPIImpl.INSTANCE);
 
+		ConfigManager.getInstance().registerClientConfig(FTBQuestsClientConfig.CONFIG, FTBQuestsAPI.MOD_ID);
+
 		PROXY = EnvExecutor.getEnvSpecific(() -> FTBQClientProxy::new, () -> FTBQServerProxy::new);
 
 		TaskTypes.init();

common/src/main/java/dev/ftb/mods/ftbquests/FTBQuestsEventHandler.java

@@ -188,11 +188,13 @@ private void cloned(ServerPlayer oldPlayer, ServerPlayer newPlayer, boolean wonG
 			return;
 		}
 
-		for (int i = 0; i < oldPlayer.getInventory().items.size(); i++) {
-			ItemStack stack = oldPlayer.getInventory().items.get(i);
+		if (!ServerQuestFile.INSTANCE.dropBookOnDeath()) {
+			for (int i = 0; i < oldPlayer.getInventory().items.size(); i++) {
+				ItemStack stack = oldPlayer.getInventory().items.get(i);
 
-			if (stack.getItem() == ModItems.BOOK.get() && newPlayer.addItem(stack)) {
-				oldPlayer.getInventory().items.set(i, ItemStack.EMPTY);
+				if (stack.getItem() == ModItems.BOOK.get() && newPlayer.addItem(stack)) {
+					oldPlayer.getInventory().items.set(i, ItemStack.EMPTY);
+				}
 			}
 		}
 	}

common/src/main/java/dev/ftb/mods/ftbquests/client/FTBQuestsClient.java

@@ -3,6 +3,7 @@
 import com.mojang.blaze3d.platform.InputConstants;
 import dev.architectury.event.events.client.ClientLifecycleEvent;
 import dev.architectury.networking.NetworkManager;
+import dev.architectury.platform.Platform;
 import dev.architectury.registry.ReloadListenerRegistry;
 import dev.architectury.registry.client.keymappings.KeyMappingRegistry;
 import dev.architectury.registry.client.rendering.RenderTypeRegistry;
@@ -20,7 +21,6 @@
 import dev.ftb.mods.ftbquests.quest.TeamData;
 import dev.ftb.mods.ftbquests.quest.theme.ThemeLoader;
 import dev.ftb.mods.ftbquests.registry.ModBlocks;
-import dev.ftb.mods.ftbquests.registry.ModItems;
 import net.minecraft.client.KeyMapping;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.player.LocalPlayer;
@@ -31,7 +31,6 @@
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;
 import net.minecraft.core.HolderLookup;
-import net.minecraft.core.RegistryAccess;
 import net.minecraft.server.packs.PackType;
 import net.minecraft.util.RandomSource;
 import net.minecraft.world.InteractionHand;
@@ -42,14 +41,17 @@
 import net.minecraft.world.level.block.state.BlockState;
 import org.jetbrains.annotations.Nullable;
 
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.List;
 import java.util.Optional;
 
 public class FTBQuestsClient {
 	public static KeyMapping KEY_QUESTS;
 
 	public static void init() {
-		FTBQuestsClientConfig.init();
+		maybeMigrateClientConfig();
 
 		ClientLifecycleEvent.CLIENT_SETUP.register(FTBQuestsClient::onClientSetup);
 		ReloadListenerRegistry.register(PackType.CLIENT_RESOURCES, new QuestFileCacheReloader());
@@ -59,6 +61,21 @@ public static void init() {
 		new FTBQuestsClientEventHandler().init();
 	}
 
+	private static void maybeMigrateClientConfig() {
+		// TODO delete in 1.22
+		Path oldConfig = Platform.getGameFolder().resolve("local/ftbquests/client-config.snbt");
+		Path newConfig = Platform.getConfigFolder().resolve("ftbquests-client.snbt");
+
+		if (Files.exists(oldConfig) && !Files.exists(newConfig)) {
+			try {
+				Files.move(oldConfig, newConfig);
+				FTBQuests.LOGGER.info("migrated {} to {}", oldConfig, newConfig);
+			} catch (IOException e) {
+				FTBQuests.LOGGER.error("can't migrate {} to {}: {}", oldConfig, newConfig, e.getMessage());
+			}
+		}
+	}
+
 	private static void onClientSetup(Minecraft minecraft) {
 		RenderTypeRegistry.register(RenderType.translucent(), ModBlocks.BARRIER.get());
 		RenderTypeRegistry.register(RenderType.translucent(), ModBlocks.STAGE_BARRIER.get());

common/src/main/java/dev/ftb/mods/ftbquests/client/FTBQuestsClientConfig.java

@@ -1,65 +1,32 @@
 package dev.ftb.mods.ftbquests.client;
 
-import dev.architectury.networking.NetworkManager;
-import dev.ftb.mods.ftblibrary.config.ConfigGroup;
-import dev.ftb.mods.ftblibrary.config.ui.EditConfigScreen;
+import dev.ftb.mods.ftblibrary.config.manager.ConfigManager;
 import dev.ftb.mods.ftblibrary.snbt.config.*;
 import dev.ftb.mods.ftblibrary.util.PanelPositioning;
 import dev.ftb.mods.ftbquests.api.FTBQuestsAPI;
 import dev.ftb.mods.ftbquests.client.config.LocaleValue;
-import dev.ftb.mods.ftbquests.net.RequestTranslationTableMessage;
-import net.minecraft.client.Minecraft;
-import net.minecraft.client.gui.screens.Screen;
-
-import static dev.ftb.mods.ftblibrary.snbt.config.ConfigUtil.LOCAL_DIR;
-import static dev.ftb.mods.ftblibrary.snbt.config.ConfigUtil.loadDefaulted;
+import dev.ftb.mods.ftbquests.client.gui.QuestsClientConfigScreen;
 
 public interface FTBQuestsClientConfig {
-    SNBTConfig CONFIG = SNBTConfig.create(FTBQuestsAPI.MOD_ID + "-client");
-    String CLIENT_CONFIG = "client-config.snbt";
+    String KEY = FTBQuestsAPI.MOD_ID + "-client";
+    SNBTConfig CONFIG = SNBTConfig.create(KEY);
 
     SNBTConfig UI = CONFIG.addGroup("ui", 0);
     BooleanValue OLD_SCROLL_WHEEL = UI.addBoolean("old_scroll_wheel", false);
     EnumValue<PanelPositioning> PINNED_QUESTS_POS = UI.addEnum("pinned_quests_pos", PanelPositioning.NAME_MAP, PanelPositioning.RIGHT);
     IntValue PINNED_QUESTS_INSET_X = UI.addInt("pinned_quests_inset_x", 2);
     IntValue PINNED_QUESTS_INSET_Y = UI.addInt("pinned_quests_inset_y", 2);
     BooleanValue SHOW_LOCK_ICON = UI.addBoolean("show_lock_icon", true);
+    BooleanValue BACKSPACE_HISTORY = UI.addBoolean("backspace_history", true);
 
     SNBTConfig XLATE = CONFIG.addGroup("xlate", 1);
     StringValue EDITING_LOCALE = XLATE.add(new LocaleValue(XLATE,"editing_locale", ""));
     BooleanValue HILITE_MISSING = XLATE.addBoolean("hilite_missing", true);
 
     // TODO migrate chapter-pinned and pinned-quests data out of per-player team data into here
 
-    static void openSettings(Screen screen) {
-        String prevLocale = EDITING_LOCALE.get();
-
-        ConfigGroup group = new ConfigGroup("ftbquests", accepted -> {
-            if (accepted) {
-                saveConfig();
-                if (!prevLocale.equals(EDITING_LOCALE.get()) && ClientQuestFile.INSTANCE != null) {
-                    NetworkManager.sendToServer(new RequestTranslationTableMessage(ClientQuestFile.INSTANCE.getLocale()));
-                    ClientQuestFile.INSTANCE.clearCachedData();
-                }
-            }
-            Minecraft.getInstance().setScreen(screen);
-        });
-        CONFIG.createClientConfig(group);
-        EditConfigScreen gui = new EditConfigScreen(group) {
-            @Override
-            public boolean doesGuiPauseGame() {
-                return screen.isPauseScreen();
-            }
-        };
-
-        gui.openGui();
-    }
-
-    static void init() {
-        loadDefaulted(CONFIG, LOCAL_DIR.resolve(FTBQuestsAPI.MOD_ID), FTBQuestsAPI.MOD_ID, CLIENT_CONFIG);
-    }
-
-    static void saveConfig() {
-        CONFIG.save(LOCAL_DIR.resolve(FTBQuestsAPI.MOD_ID).resolve(CLIENT_CONFIG));
+    static void openSettings(boolean pauseGame) {
+        ConfigManager.getInstance().createConfigGroup(KEY)
+                .ifPresent(group -> new QuestsClientConfigScreen(group, pauseGame).openGui());
     }
 }

common/src/main/java/dev/ftb/mods/ftbquests/client/gui/MultilineTextEditorScreen.java

@@ -219,8 +219,8 @@ private void doLinkInsertion(long questID) {
 
 				StringBuilder builder = new StringBuilder("[ ");
 				if (!parts.get(0).isEmpty()) builder.append("\"").append(parts.get(0)).append("\", ");
-				builder.append(String.format(LINK_TEXT_TEMPLATE, parts.get(1), questID)).append(", ");
-				if (!parts.get(2).isEmpty()) builder.append("\"").append(parts.get(2)).append("\"");
+				builder.append(String.format(LINK_TEXT_TEMPLATE, parts.get(1), questID));
+				if (!parts.get(2).isEmpty()) builder.append(", ").append("\"").append(parts.get(2)).append("\"");
 				builder.append(" ]");
 
 				textBox.selectCurrentLine();

common/src/main/java/dev/ftb/mods/ftbquests/client/gui/QuestsClientConfigScreen.java

@@ -0,0 +1,37 @@
+package dev.ftb.mods.ftbquests.client.gui;
+
+import dev.architectury.networking.NetworkManager;
+import dev.ftb.mods.ftblibrary.config.ConfigGroup;
+import dev.ftb.mods.ftblibrary.config.ui.EditConfigScreen;
+import dev.ftb.mods.ftbquests.client.ClientQuestFile;
+import dev.ftb.mods.ftbquests.net.RequestTranslationTableMessage;
+
+public class QuestsClientConfigScreen extends EditConfigScreen {
+    private final String prevLocale;
+    private final boolean pause;
+
+    public QuestsClientConfigScreen(ConfigGroup group, boolean pause) {
+        super(group);
+
+        this.pause = pause;
+        this.prevLocale = ClientQuestFile.INSTANCE.getLocale();
+
+        setAutoclose(true);
+    }
+
+    @Override
+    public boolean doesGuiPauseGame() {
+        return pause;
+    }
+
+    @Override
+    protected void doAccept() {
+        super.doAccept();
+
+        ClientQuestFile file = ClientQuestFile.INSTANCE;
+        if (file != null && !prevLocale.equals(file.getLocale())) {
+            NetworkManager.sendToServer(new RequestTranslationTableMessage(file.getLocale()));
+            file.clearCachedData();
+        }
+    }
+}

common/src/main/java/dev/ftb/mods/ftbquests/client/gui/quests/ChapterPanel.java

@@ -47,8 +47,8 @@ public class ChapterPanel extends Panel {
 
 	private final QuestScreen questScreen;
 	boolean expanded = isPinned();
-	int curX = expanded ? 0 : -width;
-	int prevX = curX;
+	int curX;
+	int prevX;
 
 	public ChapterPanel(Panel panel) {
 		super(panel);
@@ -59,24 +59,12 @@ public ChapterPanel(Panel panel) {
 	public void addWidgets() {
 		add(new ModpackButton(this, questScreen.file));
 
-        /*
-		if (Platform.isModLoaded("ftbmoney")) {
-			add(new OpenShopButton(this));
-			Color4I borderColor = ThemeProperties.WIDGET_BORDER.get(treeGui.selectedChapter);
-			add(new ColorWidget(this, borderColor, null).setPosAndSize(1, 0, width - 2, 1));
-		}
-		 */
-
 		boolean canEdit = questScreen.file.canEdit();
 
 		for (Chapter chapter : questScreen.file.getDefaultChapterGroup().getVisibleChapters(questScreen.file.selfTeamData)) {
 			add(new ChapterButton(this, chapter));
 		}
 
-		if (canEdit) {
-			//add(new AddChapterButton(this, questScreen.file.defaultChapterGroup));
-		}
-
 		questScreen.file.forAllChapterGroups(group -> {
 			if (!group.isDefaultGroup()) {
 				ChapterGroupButton button = new ChapterGroupButton(this, group);
@@ -109,6 +97,8 @@ public void alignWidgets() {
 		if (getContentHeight() <= height) {
 			setScrollY(0);
 		}
+
+		curX = expanded ? 0 : -width;
 	}
 
 	@Override
@@ -147,6 +137,15 @@ public void drawBackground(GuiGraphics graphics, Theme theme, int x, int y, int
 		ThemeProperties.CHAPTER_PANEL_BACKGROUND.get().draw(graphics, x, y, w, h);
 	}
 
+	@Override
+	public void onClosed() {
+		super.onClosed();
+
+		if (!isPinned()) {
+			curX = -width;
+		}
+	}
+
 	@Override
 	public void draw(GuiGraphics graphics, Theme theme, int x, int y, int w, int h) {
 		graphics.pose().pushPose();

common/src/main/java/dev/ftb/mods/ftbquests/client/gui/quests/OtherButtonsPanelBottom.java

@@ -4,7 +4,6 @@
 import dev.ftb.mods.ftblibrary.icon.Icons;
 import dev.ftb.mods.ftblibrary.ui.ContextMenuItem;
 import dev.ftb.mods.ftblibrary.ui.Panel;
-import dev.ftb.mods.ftblibrary.ui.ScreenWrapper;
 import dev.ftb.mods.ftblibrary.ui.WidgetLayout;
 import dev.ftb.mods.ftblibrary.ui.input.MouseButton;
 import dev.ftb.mods.ftbquests.client.ClientQuestFile;
@@ -89,7 +88,7 @@ public EditPlayerPrefsButton(OtherButtonsPanelBottom panel) {
 
 		@Override
 		public void onClicked(MouseButton button) {
-			FTBQuestsClientConfig.openSettings(new ScreenWrapper(questScreen));
+			FTBQuestsClientConfig.openSettings(questScreen.doesGuiPauseGame());
 		}
 	}