Added Keybinds for Snapping Camera to Cardinal Directions (#14)

* Added functionality to bind cardinal directions to custom keybinds.

* Update CompassCameraControlConfig.java

* Update CompassCameraControlPlugin.java

* update config formatting and text

Author: insizhen

src/main/java/com/compassCameraControl/CompassCameraControlConfig.java

@@ -1,8 +1,7 @@
 package com.compassCameraControl;
 
-import net.runelite.client.config.Config;
-import net.runelite.client.config.ConfigGroup;
-import net.runelite.client.config.ConfigItem;
+import net.runelite.client.config.*;
+import java.awt.event.KeyEvent;
 
 @ConfigGroup("compasscameracontrol")
 public interface CompassCameraControlConfig extends Config
@@ -44,4 +43,58 @@ default ShiftMode shiftClickMode()
 	{
 		return ShiftMode.OFF;
 	}
+
+	@ConfigSection(
+		name = "Keybindings",
+		position = 4,
+		closedByDefault = true,
+		description = "Settings for snapping the camera to cardinal directions<br/>" +
+			"To prevent these keys from appearing in chat<br/>" +
+			"Enable the \"Key Remapping\" plugin (included with RuneLite)"
+	)
+	String cardinalKeybindingSnap = "cardinalKeybindingSnap";
+
+	@ConfigItem(
+		keyName = "lookNorthKey",
+		name = "Look North Key",
+		description = "Face camera North on key press",
+		position = 5,
+		section = cardinalKeybindingSnap
+	)
+	default ModifierlessKeybind lookNorthKey() {
+		return new ModifierlessKeybind(KeyEvent.VK_UNDEFINED, 0);
+	}
+
+	@ConfigItem(
+		keyName = "lookSouthKey",
+		name = "Look South Key",
+		description = "Face camera South on key press",
+		position = 6,
+		section = cardinalKeybindingSnap
+	)
+	default ModifierlessKeybind lookSouthKey() {
+		return new ModifierlessKeybind(KeyEvent.VK_UNDEFINED, 0);
+	}
+
+	@ConfigItem(
+		keyName = "lookEastKey",
+		name = "Look East Key",
+		description = "Face camera East on key press",
+		position = 7,
+		section = cardinalKeybindingSnap
+	)
+	default ModifierlessKeybind lookEastKey() {
+		return new ModifierlessKeybind(KeyEvent.VK_UNDEFINED, 0);
+	}
+
+	@ConfigItem(
+		keyName = "lookWestKey",
+		name = "Look West Key",
+		description = "Face camera West on key press",
+		position = 8,
+		section = cardinalKeybindingSnap
+	)
+	default ModifierlessKeybind lookWestKey() {
+		return new ModifierlessKeybind(KeyEvent.VK_UNDEFINED, 0);
+	}
 }

src/main/java/com/compassCameraControl/CompassCameraControlPlugin.java

@@ -3,6 +3,7 @@
 import com.google.inject.Provides;
 import javax.inject.Inject;
 import javax.inject.Singleton;
+import java.awt.event.KeyEvent;
 import java.util.Map;
 import lombok.extern.slf4j.Slf4j;
 import net.runelite.api.Client;
@@ -13,6 +14,8 @@
 import net.runelite.api.events.MenuEntryAdded;
 import net.runelite.client.config.ConfigManager;
 import net.runelite.client.eventbus.Subscribe;
+import net.runelite.client.input.KeyListener;
+import net.runelite.client.input.KeyManager;
 import net.runelite.client.plugins.Plugin;
 import net.runelite.client.plugins.PluginDescriptor;
 
@@ -30,6 +33,10 @@ public class CompassCameraControlPlugin extends Plugin
 	@Inject
 	private CompassCameraControlConfig config;
 
+	@Inject
+	private KeyManager keyManager;
+
+
 	private static final int NORTH_YAW = 0;
 	private static final int SOUTH_YAW = 1024;
 	private static final int EAST_YAW = 1536;
@@ -180,4 +187,39 @@ private void alignYaw()
 
 		client.setCameraYawTarget(closestYaw);
 	}
+
+	private final KeyListener keyListener = new KeyListener() {
+		@Override
+		public void keyTyped(KeyEvent e) {
+
+		}
+
+		@Override
+		public void keyPressed(KeyEvent event) {
+			if (event.getKeyCode() == config.lookNorthKey().getKeyCode()) {
+				client.setCameraYawTarget(NORTH_YAW);
+			} else if (event.getKeyCode() == config.lookSouthKey().getKeyCode()) {
+				client.setCameraYawTarget(SOUTH_YAW);
+			} else if (event.getKeyCode() == config.lookEastKey().getKeyCode()) {
+				client.setCameraYawTarget(EAST_YAW);
+			} else if (event.getKeyCode() == config.lookWestKey().getKeyCode()) {
+				client.setCameraYawTarget(WEST_YAW);
+			}
+		}
+
+		@Override
+		public void keyReleased(KeyEvent event) {
+			// No action needed on key release
+		}
+	};
+
+	@Override
+	protected void startUp() throws Exception {
+		keyManager.registerKeyListener(keyListener);
+	}
+
+	@Override
+	protected void shutDown() throws Exception {
+		keyManager.unregisterKeyListener(keyListener);
+	}
 }