Add FarmingTracker plugin

With help from NotFoxtrot

runelite-api/src/main/java/net/runelite/api/Varbits.java

@@ -310,7 +310,36 @@ public enum Varbits
 	FAIR_RING_LAST_DESTINATION(5374),
 	FAIRY_RING_DIAL_ADCB(3985), //Left dial
 	FAIRY_RIGH_DIAL_ILJK(3986), //Middle dial
-	FAIRY_RING_DIAL_PSRQ(3987); //Right dial
+	FAIRY_RING_DIAL_PSRQ(3987), //Right dial
+
+	/**
+	 * Transmog controllers for farming
+	 */
+	FARMING_4771(4771),
+	FARMING_4772(4772),
+	FARMING_4773(4773),
+	FARMING_4774(4774),
+
+	/**
+	 * Transmog controllers for grapes
+	 */
+	GRAPES_4953(4953),
+	GRAPES_4954(4954),
+	GRAPES_4955(4955),
+	GRAPES_4956(4956),
+	GRAPES_4957(4957),
+	GRAPES_4958(4958),
+	GRAPES_4959(4959),
+	GRAPES_4960(4960),
+	GRAPES_4961(4961),
+	GRAPES_4962(4962),
+	GRAPES_4963(4963),
+	GRAPES_4964(4964),
+
+	/**
+   * Automatically weed farming patches
+	 */
+	AUTOWEED(5557);
 
 	/**
 	 * varbit id

runelite-api/src/main/java/net/runelite/api/vars/Autoweed.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2018 Abex
+ * 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 net.runelite.api.vars;
+
+public enum Autoweed
+{
+	UNOWNED,
+	OFF,
+	ON
+}

runelite-client/src/main/java/net/runelite/client/plugins/farmingtracker/CropState.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2018 Abex
+ * 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 net.runelite.client.plugins.farmingtracker;
+
+import java.awt.Color;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+@Getter
+public enum CropState
+{
+	HARVESTABLE(Color.GREEN),
+	GROWING(Color.GREEN),
+	DISEASED(Color.ORANGE),
+	DEAD(Color.RED);
+
+	private final Color color;
+}

runelite-client/src/main/java/net/runelite/client/plugins/farmingtracker/FarmingPatch.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2018 Abex
+ * 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 net.runelite.client.plugins.farmingtracker;
+
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.Setter;
+import net.runelite.api.Varbits;
+
+@RequiredArgsConstructor(
+	access = AccessLevel.PACKAGE
+)
+@Getter
+public class FarmingPatch
+{
+	@Setter(AccessLevel.PACKAGE)
+	private FarmingRegion region;
+	private final String name;
+	private final Varbits varbit;
+	private final PatchImplementation implementation;
+}

runelite-client/src/main/java/net/runelite/client/plugins/farmingtracker/FarmingPatchPanel.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) 2018 Abex
+ * 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 net.runelite.client.plugins.farmingtracker;
+
+import java.awt.Dimension;
+import javax.swing.GroupLayout;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+import javax.swing.JProgressBar;
+import lombok.Getter;
+import net.runelite.client.ui.FontManager;
+
+@Getter
+class FarmingPatchPanel extends JPanel
+{
+	private final FarmingPatch patch;
+	private final JLabel icon = new JLabel();
+	private final JLabel estimate = new JLabel();
+	private final JProgressBar progress = new JProgressBar();
+
+	FarmingPatchPanel(FarmingPatch patch)
+	{
+		this.patch = patch;
+
+		GroupLayout layout = new GroupLayout(this);
+		this.setLayout(layout);
+
+		final JLabel location = new JLabel(patch.getRegion().getName() + " " + patch.getName());
+		location.setFont(FontManager.getRunescapeSmallFont());
+		icon.setMinimumSize(new Dimension(36, 32));
+
+		layout.setVerticalGroup(layout.createSequentialGroup()
+			.addGroup(layout.createParallelGroup(GroupLayout.Alignment.CENTER)
+				.addComponent(icon)
+				.addGroup(layout.createSequentialGroup()
+					.addGap(1)
+					.addComponent(location)
+					.addGap(1)
+					.addComponent(estimate)
+				)
+			)
+			.addComponent(progress, 8, 8, 8)
+			.addGap(4)
+		);
+
+		layout.setHorizontalGroup(layout.createParallelGroup()
+			.addGroup(layout.createSequentialGroup()
+				.addComponent(icon)
+				.addGroup(layout.createParallelGroup()
+					.addComponent(location)
+					.addComponent(estimate)
+				)
+			)
+			.addComponent(progress)
+		);
+	}
+}

runelite-client/src/main/java/net/runelite/client/plugins/farmingtracker/FarmingRegion.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2018 Abex
+ * 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 net.runelite.client.plugins.farmingtracker;
+
+import lombok.Getter;
+import net.runelite.api.Varbits;
+import net.runelite.api.coords.WorldPoint;
+
+@Getter
+public class FarmingRegion
+{
+	private final String name;
+	private final int regionID;
+	private final FarmingPatch[] patches;
+	private final Varbits[] varbits;
+
+	FarmingRegion(String name, int regionID, FarmingPatch... patches)
+	{
+		this.name = name;
+		this.regionID = regionID;
+		this.patches = patches;
+		this.varbits = new Varbits[patches.length];
+		for (int i = 0; i < patches.length; i++)
+		{
+			FarmingPatch p = patches[i];
+			p.setRegion(this);
+			varbits[i] = p.getVarbit();
+		}
+	}
+
+	public boolean isInBounds(WorldPoint loc)
+	{
+		return true;
+	}
+}

runelite-client/src/main/java/net/runelite/client/plugins/farmingtracker/FarmingTrackerConfig.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2018 Abex
+ * 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 net.runelite.client.plugins.farmingtracker;
+
+import net.runelite.client.config.Config;
+import net.runelite.client.config.ConfigGroup;
+import net.runelite.client.config.ConfigItem;
+
+@ConfigGroup(
+	keyName = "farmingTracker",
+	name = "Farming Tracker",
+	description = "Configuration for the farming tracker"
+)
+public interface FarmingTrackerConfig extends Config
+{
+	String KEY_NAME = "farmingTracker";
+	String AUTOWEED = "autoweed";
+
+	@ConfigItem(
+		keyName = "estimateRelative",
+		name = "Show relative time",
+		description = "Show amount of time remaining for a patch, opposed to when the patch is finished"
+	)
+	default boolean estimateRelative()
+	{
+		return false;
+	}
+
+	@ConfigItem(
+		keyName = "patch",
+		name = "Default patch",
+		description = "Default patch on opening the panel",
+		hidden = true
+	)
+	default Tab patch()
+	{
+		return Tab.ALLOTMENT;
+	}
+
+	@ConfigItem(
+		keyName = "patch",
+		name = "",
+		description = "",
+		hidden = true
+	)
+	void setPatch(Tab t);
+}