feat: expand on rotation logic and update readme (#26)

* feat: closes #24

* chore: cleanup

* fix: rotateAfterSnap and cleanup

Author: RaazKH

README.md

@@ -37,7 +37,13 @@ You can set up shortcuts for quick camera control. To prevent shortcuts from app
 - **Look South Key**: Face camera South when pressed
 - **Look East Key**: Face camera East when pressed
 - **Look West Key**: Face camera West when pressed
+- **Rotate 180°**: Rotates the camera to opposite side (always 180°)
+- **Rotate Clockwise**: Rotates camera clockwise
+- **Rotate Counterclockwise**: Rotates camera counterclockwise
 
+### Keybind Options
+- **Rotate After Snap**: Snap to the closest cardinal direction before rotation, applies to all rotation keybindings
+- **Rotation Value**: Set rotation value for clockwise and counterclockwise rotation keybindings
 ---
 ### Custom Cycle Order
 You can specify a custom order for cycling through directions. For example, if you prefer to cycle between North and South, you can set the cycle order to `N,S`. Only `N`, `S`, `W`, and `E` are valid characters for this field, all other characters will be ignored.
@@ -50,4 +56,4 @@ If you encounter any bugs, have suggestions for improvements, or would like to g
 
 ---
 #### Contributors
-Thanks to [LlemonDuck](https://github.com/LlemonDuck) and [insizhen](https://github.com/insizhen) for their valuable code contributions.
+Thanks to [LlemonDuck](https://github.com/LlemonDuck), [insizhen](https://github.com/insizhen), and [Scarcy](https://github.com/Scarcy) for their valuable code contributions.

build.gradle

@@ -27,7 +27,7 @@ dependencies {
 }
 
 group = 'com.compassCameraControl'
-version = '1.0-SNAPSHOT'
+version = '1.2.2-SNAPSHOT'
 
 tasks.withType(JavaCompile).configureEach {
 	options.encoding = 'UTF-8'

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

@@ -60,33 +60,33 @@ default ShiftMode shiftClickMode()
 	String cardinalKeybindingSnap = "cardinalKeybindingSnap";
 
 	@ConfigItem(
-			keyName = "snapFacingKey",
-			name = "Snap Facing",
-			description = "Snaps the camera to the player's facing direction on key press",
-			position = 5,
-			section = cardinalKeybindingSnap
+		keyName = "snapFacingKey",
+		name = "Snap Facing",
+		description = "Snaps the camera to the player's facing direction on key press",
+		position = 5,
+		section = cardinalKeybindingSnap
 	)
 	default Keybind snapFacingKey() {
 		return new Keybind(KeyEvent.VK_UNDEFINED, 0);
 	}
 
 	@ConfigItem(
-			keyName = "snapCloseKey",
-			name = "Snap to Closest",
-			description = "Snaps the camera to the nearest cardinal direction on key press",
-			position = 6,
-			section = cardinalKeybindingSnap
+		keyName = "snapCloseKey",
+		name = "Snap to Closest",
+		description = "Snaps the camera to the nearest cardinal direction on key press",
+		position = 6,
+		section = cardinalKeybindingSnap
 	)
 	default Keybind snapCloseKey() {
 		return new Keybind(KeyEvent.VK_UNDEFINED, 0);
 	}
 
 	@ConfigItem(
-			keyName = "cycleCardinalKey",
-			name = "Cycle Cardinal",
-			description = "Cycles through cardinal directions on key press",
-			position = 7,
-			section = cardinalKeybindingSnap
+		keyName = "cycleCardinalKey",
+		name = "Cycle Cardinal",
+		description = "Cycles through cardinal directions on key press",
+		position = 7,
+		section = cardinalKeybindingSnap
 	)
 	default Keybind cycleCardinalKey() {
 		return new Keybind(KeyEvent.VK_UNDEFINED, 0);
@@ -136,32 +136,56 @@ default Keybind lookWestKey() {
 		return new Keybind(KeyEvent.VK_UNDEFINED, 0);
 	}
 
-
-
 	@ConfigItem(
-		keyName = "rotateWestKey",
-		name = "Rotate West Key",
-		description = "Rotate camera West, based on user configuration (Default 90°)",
+		keyName = "rotateFlipKey",
+		name = "Rotate 180° Key",
+		description = "Rotates the camera to opposite side (always 180°)",
 		position = 12,
 		section = cardinalKeybindingSnap
 	)
-	default Keybind rotateWestKey() { return new Keybind(KeyEvent.VK_UNDEFINED, 0);}
+	default Keybind rotateFlipKey() { return new Keybind(KeyEvent.VK_UNDEFINED, 0);}
+
+
+	@ConfigItem(
+		keyName = "rotateClockwiseKey",
+		name = "Rotate Clockwise Key",
+		position = 13,
+		section = cardinalKeybindingSnap,
+		description = "Rotate camera a user defined number of degrees clockwise<br/>" +
+				"Based on Rotation Degree"
+	)
+	default Keybind rotateClockwiseKey() { return new Keybind(KeyEvent.VK_UNDEFINED, 0);}
+
+	@ConfigItem(
+		keyName = "rotateCounterclockwiseKey",
+		name = "Rotate Counterclockwise Key",
+		position = 14,
+		section = cardinalKeybindingSnap,
+		description = "Rotate camera a user defined number of degrees counterclockwise<br/>" +
+				"Based on Rotation Degree"
+	)
+	default Keybind rotateCounterclockwiseKey() { return new Keybind(KeyEvent.VK_UNDEFINED, 0);}
 
 	@ConfigItem(
-			keyName = "rotateEastKey",
-			name = "Rotate East Key",
-			description = "Rotate camera East, based on user configuration (Default 90°)",
-			position = 13,
-			section = cardinalKeybindingSnap
+		keyName = "rotateAfterSnap",
+		name = "Rotate After Snap",
+		position = 15,
+		description = "Snap to the closest cardinal direction before rotation<br/>" +
+				"Applies to all rotation keybindings"
 	)
-	default Keybind rotateEastKey() { return new Keybind(KeyEvent.VK_UNDEFINED, 0);}
+	default boolean rotateAfterSnap()
+	{
+		return false;
+	}
 
 	@ConfigItem(
-			keyName = "rotateDegree",
-			name = "Rotation Degree",
-			description = "How many degrees to rotate",
-			position = 14,
-			section = cardinalKeybindingSnap
+		keyName = "rotateDegree",
+		name = "Rotation Degree",
+		position = 16,
+		description = "Rotation value for clockwise and counterclockwise rotation keybindings"
 	)
-	default int rotateDegree(){ return 90; }
+	default int rotateDegree()
+	{
+		return 90;
+	}
 }

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

@@ -221,26 +221,25 @@ private int degreesToYaw(int degrees) {
 		return (int) Math.round(degrees * 2048.0 / 360.0);
 	}
 
-	private void rotateWestYaw()
+	private void rotateYaw(String s)
 	{
 		int currentYaw = client.getCameraYaw();
-		int userInputDegree = config.rotateDegree();
-		int shift = degreesToYaw(userInputDegree);
+		int shift = s.equals("Flip") ? degreesToYaw(180) : degreesToYaw(config.rotateDegree());
+		int targetYaw;
 
-		int targetYaw = currentYaw + shift;
-		// Wraps yaw into camera range [0,2048)
-		targetYaw &= 2047;
+		if (config.rotateAfterSnap()) {
+			alignYaw();
+			// Above updates the yaw target in this tick, so use the target rather than the current yaw
+			currentYaw = client.getCameraYawTarget();
+		}
 
-		client.setCameraYawTarget(targetYaw);
-	}
-	
-	private void rotateEastYaw()
-	{
-		int currentYaw = client.getCameraYaw();
-		int userInputDegree = config.rotateDegree();
-		int shift = degreesToYaw(userInputDegree);
+		if(s.equals("Clockwise")){
+			targetYaw = currentYaw + shift;
+		}
+		else {
+			targetYaw = currentYaw - shift;
+		}
 
-		int targetYaw = currentYaw - shift;
 		// Wraps yaw into camera range [0,2048)
 		targetYaw &= 2047;
 
@@ -268,13 +267,15 @@ public void keyPressed(KeyEvent event) {
 			} else if (config.lookSouthKey().matches(event)) {
 				client.setCameraYawTarget(SOUTH_YAW);
 			} else if (config.lookEastKey().matches(event)) {
-				client.setCameraYawTarget(EAST_YAW);}
-			else if (config.lookWestKey().matches(event)) {
+				client.setCameraYawTarget(EAST_YAW);
+			} else if (config.lookWestKey().matches(event)) {
 				client.setCameraYawTarget(WEST_YAW);
-			} else if (config.rotateWestKey().matches(event)) {
-				rotateWestYaw();
-			} else if (config.rotateEastKey().matches(event)) {
-				rotateEastYaw();
+			} else if (config.rotateFlipKey().matches(event)) {
+				rotateYaw("Flip");
+			} else if (config.rotateClockwiseKey().matches(event)) {
+				rotateYaw("Clockwise");
+			} else if (config.rotateCounterclockwiseKey().matches(event)) {
+				rotateYaw("Counterclockwise");
 			} else {
 				handledEvent = false;
 			}