Add Helper Maker

src/main/java/com/questhelper/QuestHelperPlugin.java

@@ -25,6 +25,7 @@
  */
 package com.questhelper;
 
+import com.google.gson.Gson;
 import com.google.inject.Binder;
 import com.google.inject.Injector;
 import com.google.inject.Provides;
@@ -157,6 +158,12 @@ public class QuestHelperPlugin extends Plugin
 	@Inject
 	public SkillIconManager skillIconManager;
 
+	@Inject
+	public QuestHelperSharingManager questHelperSharingManager;
+
+	@Inject
+	public Gson gson;
+
 	private QuestHelperPanel panel;
 
 	private NavigationButton navButton;
@@ -192,7 +199,7 @@ protected void startUp() throws IOException
 
 		final BufferedImage icon = Icon.QUEST_ICON.getImage();
 
-		panel = new QuestHelperPanel(this, questManager, configManager);
+		panel = new QuestHelperPanel(this, questManager, configManager, gson);
 		questManager.startUp(panel);
 		navButton = NavigationButton.builder()
 			.tooltip("Quest Helper")
@@ -408,6 +415,14 @@ else if (developerMode && commandExecuted.getCommand().equals("qh-inv"))
 			}
 			System.out.println(inv);
 		}
+		else if (commandExecuted.getCommand().equals("import-helper"))
+		{
+			questHelperSharingManager.promptForImport();
+		}
+		else if (commandExecuted.getCommand().equals("helper-editor"))
+		{
+			panel.toggleQuestCreator();
+		}
 	}
 
 	@Subscribe(priority = 100)
@@ -469,6 +484,24 @@ public void onMenuEntryAdded(MenuEntryAdded event)
 		String target = Text.removeTags(event.getTarget());
 
 		questMenuHandler.setupQuestMenuOptions(menuEntries, widgetIndex, widgetID, target, option);
+
+		if (event.getMenuEntry().getNpc() != null)
+		{
+			menu.createMenuEntry(menuEntries.length - 1)
+					.setOption("Add NpcStep")
+					.setTarget("<col=ff9040>" + target + "</col>")
+					.onClick((menuEntry -> handleAddNpcStep(event.getMenuEntry().getNpc())))
+					.setType(MenuAction.RUNELITE)
+					.setParam0(widgetIndex)
+					.setParam1(widgetID);
+		}
+	}
+
+	private void handleAddNpcStep(NPC npc)
+	{
+		String name = npc.getName();
+		int id = npc.getId();
+		panel.getCreatorFrame().getStepMakingPanel().createNpcStep(id, name, npc.getWorldLocation());
 	}
 
 	@Subscribe
@@ -508,10 +541,8 @@ private void scanAndInstantiate()
 		}
 	}
 
-	private void instantiate(QuestHelperQuest quest)
+	void instantiate(QuestHelper questHelper, String name)
 	{
-		QuestHelper questHelper = quest.getQuestHelper();
-
 		Module questModule = (Binder binder) ->
 		{
 			binder.bind(QuestHelper.class).toInstance(questHelper);
@@ -520,10 +551,17 @@ private void instantiate(QuestHelperQuest quest)
 		Injector questInjector = RuneLite.getInjector().createChildInjector(questModule);
 		injector.injectMembers(questHelper);
 		questHelper.setInjector(questInjector);
-		questHelper.setQuest(quest);
 		questHelper.setConfig(config);
 		questHelper.setQuestHelperPlugin(this);
+		questHelper.setName(name);
 
-		log.debug("Loaded quest helper {}", quest.name());
+		log.debug("Loaded quest helper {}", name);
+	}
+
+	private void instantiate(QuestHelperQuest quest)
+	{
+		QuestHelper questHelper = quest.getQuestHelper();
+		instantiate(questHelper, quest.name());
+		questHelper.setQuest(quest);
 	}
 }

src/main/java/com/questhelper/QuestHelperSharingManager.java

@@ -0,0 +1,116 @@
+/*
+ * Copyright (c) 2024, Zoinkwiz <https://www.github.com/Zoinkwiz
+ * Copyright (c) 2021, Adam <Adam@sigterm.info>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.questhelper;
+
+import com.google.common.base.Strings;
+import com.google.gson.Gson;
+import com.google.gson.JsonSyntaxException;
+import com.questhelper.questimport.JsonToQuest;
+import com.questhelper.managers.QuestManager;
+import com.questhelper.questhelpers.QuestHelper;
+import lombok.extern.slf4j.Slf4j;
+import net.runelite.api.ChatMessageType;
+import net.runelite.client.callback.ClientThread;
+import net.runelite.client.chat.ChatMessageManager;
+import net.runelite.client.chat.QueuedMessage;
+import net.runelite.client.game.ItemManager;
+import java.awt.Toolkit;
+import java.awt.datatransfer.DataFlavor;
+import java.awt.datatransfer.UnsupportedFlavorException;
+import java.io.IOException;
+import javax.inject.Inject;
+
+@Slf4j
+public class QuestHelperSharingManager
+{
+	private final QuestHelperPlugin plugin;
+	private final QuestManager questManager;
+	private final ChatMessageManager chatMessageManager;
+	private final ClientThread clientThread;
+	private final ItemManager itemManager;
+	private final Gson gson;
+
+	@Inject
+	private QuestHelperSharingManager(QuestHelperPlugin plugin, ClientThread clientThread, QuestManager questManager, ChatMessageManager chatMessageManager,
+									  ItemManager itemManager, Gson gson)
+	{
+		this.plugin = plugin;
+		this.clientThread = clientThread;
+		this.questManager = questManager;
+		this.chatMessageManager = chatMessageManager;
+		this.itemManager = itemManager;
+		this.gson = gson;
+	}
+
+	public void promptForImport()
+	{
+		final String clipboardText;
+		try
+		{
+			clipboardText = Toolkit.getDefaultToolkit()
+				.getSystemClipboard()
+				.getData(DataFlavor.stringFlavor)
+				.toString();
+		}
+		catch (IOException | UnsupportedFlavorException ex)
+		{
+			sendChatMessage("Unable to read system clipboard.");
+			log.warn("error reading clipboard", ex);
+			return;
+		}
+
+		log.debug("Clipboard contents: {}", clipboardText);
+		if (Strings.isNullOrEmpty(clipboardText))
+		{
+			sendChatMessage("You do not have any quest helper helpers copied in your clipboard.");
+			return;
+		}
+
+		try
+		{
+			JsonToQuest jsonToQuest = new JsonToQuest(itemManager);
+			QuestHelper questHelper = jsonToQuest.importQuestFromJson(gson, clipboardText);
+			clientThread.invokeLater(() -> {
+				plugin.instantiate(questHelper, "Imported Helper");
+				questManager.startUpQuest(questHelper, true);
+			});
+
+		}
+		catch (JsonSyntaxException e)
+		{
+			log.debug("Malformed JSON for clipboard import", e);
+			sendChatMessage("Invalid helper copied in your clipboard.");
+		}
+	}
+
+	private void sendChatMessage(final String message)
+	{
+		chatMessageManager.queue(QueuedMessage.builder()
+			.type(ChatMessageType.CONSOLE)
+			.runeLiteFormattedMessage(message)
+			.build());
+	}
+}

src/main/java/com/questhelper/managers/QuestManager.java

@@ -380,7 +380,7 @@ public void startUpBackgroundQuest(String questHelperName)
 			return;
 		}
 
-		if (selectedQuest != null && selectedQuest.getQuest().getName().equals(questHelperName))
+		if (selectedQuest != null && selectedQuest.getQuest() != null && selectedQuest.getQuest().getName().equals(questHelperName))
 		{
 			return;
 		}

src/main/java/com/questhelper/panel/PanelDetails.java

@@ -53,6 +53,7 @@ public class PanelDetails
 	private Requirement hideCondition;
 
 	@Getter
+	@Setter
 	private List<Requirement> requirements;
 
 	@Getter

src/main/java/com/questhelper/panel/QuestHelperPanel.java

@@ -24,7 +24,9 @@
  */
 package com.questhelper.panel;
 
+import com.google.gson.Gson;
 import com.questhelper.managers.QuestManager;
+import com.questhelper.panel.questmaking.QuestCreatorFrame;
 import com.questhelper.panel.skillfiltering.SkillFilterPanel;
 import com.questhelper.tools.Icon;
 import com.questhelper.QuestHelperConfig;
@@ -52,6 +54,8 @@
 import javax.swing.event.DocumentEvent;
 import javax.swing.event.DocumentListener;
 import javax.swing.plaf.basic.BasicButtonUI;
+
+import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
 import net.runelite.api.*;
 import net.runelite.client.config.ConfigManager;
@@ -86,12 +90,19 @@ public class QuestHelperPanel extends PluginPanel
 	private boolean settingsPanelActive = false;
 	public boolean questActive = false;
 
+	private final JButton createQuestButton;
+
 	private final ArrayList<QuestSelectPanel> questSelectPanels = new ArrayList<>();
 
 	QuestHelperPlugin questHelperPlugin;
 
 	QuestManager questManager;
 
+	Gson gson;
+
+	@Getter
+	QuestCreatorFrame creatorFrame;
+
 	private static final ImageIcon DISCORD_ICON;
 	private static final ImageIcon GITHUB_ICON;
 	private static final ImageIcon PATREON_ICON;
@@ -109,13 +120,17 @@ public class QuestHelperPanel extends PluginPanel
 		EXPANDED_ICON = Icon.EXPANDED.getIcon();
 	}
 
-	public QuestHelperPanel(QuestHelperPlugin questHelperPlugin, QuestManager questManager, ConfigManager configManager)
+	public QuestHelperPanel(QuestHelperPlugin questHelperPlugin, QuestManager questManager, ConfigManager configManager, Gson gson)
 	{
 		super(false);
 
 		this.questHelperPlugin = questHelperPlugin;
 		this.questManager = questManager;
 		this.configManager = configManager;
+		this.gson = gson;
+
+		this.creatorFrame = new QuestCreatorFrame(gson);
+		this.creatorFrame.setVisible(false);
 
 		setBackground(ColorScheme.DARK_GRAY_COLOR);
 		setLayout(new BorderLayout());
@@ -126,16 +141,19 @@ public QuestHelperPanel(QuestHelperPlugin questHelperPlugin, QuestManager questM
 		titlePanel.setLayout(new BorderLayout());
 
 		JTextArea title = JGenerator.makeJTextArea();
-		title.setText("Quest Helper");
+		title.setText("QH");
 		title.setForeground(Color.WHITE);
 		titlePanel.add(title, BorderLayout.WEST);
 
+		createQuestButton = new JButton("Create New Quest");
+		createQuestButton.addActionListener(e -> toggleQuestCreator());
+		titlePanel.add(createQuestButton, BorderLayout.EAST);
+
 		// Options
 		final JPanel viewControls = new JPanel(new GridLayout(1, 3, 10, 0));
 		viewControls.setBackground(ColorScheme.DARK_GRAY_COLOR);
 
 		// Settings
-		// TODO: Removed until the Runelite API allows for a link to the actual config panel
 		JButton settingsBtn = new JButton();
 		SwingUtil.removeButtonDecorations(settingsBtn);
 		settingsBtn.setIcon(SETTINGS_ICON);
@@ -304,9 +322,6 @@ public void changedUpdate(DocumentEvent e)
 		JPanel orderPanel = makeDropdownPanel(orderDropdown, "Ordering");
 		orderPanel.setPreferredSize(new Dimension(PANEL_WIDTH, DROPDOWN_HEIGHT));
 
-		JPanel assistanceToggles = new JPanel();
-
-
 		// Skill filtering
 		SkillFilterPanel skillFilterPanel = new SkillFilterPanel(questHelperPlugin.skillIconManager, questHelperPlugin.getConfigManager());
 		skillFilterPanel.setVisible(false);
@@ -415,6 +430,11 @@ private void onSearchBarChanged()
 		revalidate();
 	}
 
+	public void toggleQuestCreator()
+	{
+		creatorFrame.setVisible(!creatorFrame.isVisible());
+	}
+
 	private JComboBox<Enum> makeNewDropdown(Enum[] values, String key)
 	{
 		JComboBox<Enum> dropdown = new JComboBox<>(values);
@@ -706,4 +726,9 @@ public void refreshSkillFiltering()
 			skillExpandButton.setText(String.format("%d active", numFilteredSkills));
 		}
 	}
+
+	public boolean isMakerActive()
+	{
+		return creatorFrame.isActive();
+	}
 }

src/main/java/com/questhelper/panel/QuestOverviewPanel.java

@@ -270,7 +270,7 @@ public void addQuest(QuestHelper quest, boolean isActive)
 
 		if (quest.getCurrentStep() != null)
 		{
-			questNameLabel.setText(quest.getQuest().getName());
+			questNameLabel.setText(quest.getName());
 			actionsContainer.setVisible(true);
 
 			if (quest.getConfigs() != null)
@@ -573,7 +573,7 @@ private void updateExternalResourcesPanel(QuestHelper quest)
 			externalResourcesList = Collections.singletonList(ExternalQuestResources.valueOf(quest.getQuest().name().toUpperCase()).getWikiURL());
 		} catch (Exception e)
 		{
-			externalResourcesList = Collections.singletonList("https://oldschool.runescape.wiki/w/" + StringUtils.lowerCase(URLEncoder.encode(quest.getQuest().name(), StandardCharsets.UTF_8)));
+			externalResourcesList = Collections.singletonList("https://oldschool.runescape.wiki/w/" + StringUtils.lowerCase(URLEncoder.encode(quest.getName(), StandardCharsets.UTF_8)));
 		}
 		JButton wikiBtn = new JButton();