Merge pull request #4 from RaazKH/add-tooltip-and-update-author

RaazKH · web-flow · commit 608b375accf7 · 2024-10-21T08:58:08.000-05:00
refactor: update description and add for plugin hover
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Compass Camera Control
 
-A RuneLite plugin that allows you to control the camera direction by simply clicking the compass orb, cycling through cardinal directions without using the arrow keys. Ideal for trackpad users!
+A RuneLite plugin that allows you to control the camera direction by simply clicking the compass orb, cycling through cardinal directions or snapping to the closest one. 
 
 ## Configuration
 
diff --git a/runelite-plugin.properties b/runelite-plugin.properties
@@ -1,6 +1,6 @@
 displayName=Compass Camera control
-author=Khoshnood
+author=Raaz
 support=https://github.com/RaazKH/CompassCameraControl
-description=Clicking on compass will do more than just face camera north
+description=Expands compass functionality
 tags=camera, compass, control, navigation, usability, convenience
 plugins=com.compassCameraControl.CompassCameraControlPlugin
diff --git a/src/main/java/com/compassCameraControl/CompassCameraControlPlugin.java b/src/main/java/com/compassCameraControl/CompassCameraControlPlugin.java
@@ -15,7 +15,9 @@
 
 @Slf4j
 @PluginDescriptor(
-	name = "Compass Camera Control"
+	name = "Compass Camera Control",
+	description = "Expands compass functionality",
+	tags = {"camera, compass, control, navigation, usability, convenience"}
 )
 public class CompassCameraControlPlugin extends Plugin
 {
@@ -106,7 +108,6 @@ private void alignYaw()
 		if (dWest < closestYawDistance)
 		{
 			closestYaw = WEST_YAW;
-			closestYawDistance = dWest;
 		}
 
 		client.setCameraYawTarget(closestYaw);

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,9 @@`
`15`	`15`
`16`	`16`	`@Slf4j`
`17`	`17`	`@PluginDescriptor(`
`18`		`- name = "Compass Camera Control"`
	`18`	`+ name = "Compass Camera Control",`
	`19`	`+ description = "Expands compass functionality",`
	`20`	`+ tags = {"camera, compass, control, navigation, usability, convenience"}`
`19`	`21`	`)`
`20`	`22`	`public class CompassCameraControlPlugin extends Plugin`
`21`	`23`	`{`
`@@ -106,7 +108,6 @@ private void alignYaw()`
`106`	`108`	`if (dWest < closestYawDistance)`
`107`	`109`	`{`
`108`	`110`	`closestYaw = WEST_YAW;`
`109`		`- closestYawDistance = dWest;`
`110`	`111`	`}`
`111`	`112`
`112`	`113`	`client.setCameraYawTarget(closestYaw);`