Merge pull request #9 from Saibot393/DEVELOPMENT-v1.6.0

release v1.6.0

CHANGELOG.md

@@ -1,3 +1,17 @@
+## v1.6.0
+- Added titles to settings
+- Added on-token setting Token form which determines how the border is defined
+- Added on-token setting Riders can move freely
+  - If this option is toggled on all riders this token can move freely within its borders and keep their relative position should the token be moved
+- Added global default rideable setting
+  - Added on-token rideable setting (overrides world rideable setting)
+- Added client setting to only show popup messages from own tokens
+- Added on-token setting for maximum riders (overrides world setting)
+- Moved the "Rider movement" option to client settings
+- For PF2e: changed name of "Rideable" trait setting to clarify that it is now only one optional way to make tokens rideable
+- Added support for arms reach
+  - Added an option which overrides the mounting distance with the arms-reach distance
+
 ## v1.5.1
 - fixed a bug that appeared when only a familiar was riding a token
 

README.md

@@ -13,18 +13,25 @@ Ridden tokens can themselfve ride other tokens.
 ### Settings:
 
 #### World:
+- Tokens rideable by default: to change if tokens are rideable by default
 - Riding Height: to change the relative z-height of the riders 
 - Mounting distance: to limit the distance from which a token can mount another token
-- Border to border: distance to change the way the distance for the above option is calculated
+- Border to border distance: distance to change the way the distance for the above option is calculated
 - Maximum riders per token: to limit the amounts of token that can ride the same token
-- Rider movement: to decide what shall happen if a rider tries to move while still being mounted, either dismount the rider or stop the movement
 - Link rotations: to link the rotation of the rider tokens to the ridden token (or vice versa with the "Move ridden on rider movement" option)
 - Apply "Mounted" effect: to apply an appropriate effect to the riding token if the game system supports this
-- Mounts require "Rideable" trait: to use the Pf2e trait system to decide if a token can be ridden
+- "Rideable" trait: to use the Pf2e trait system to decide if a token can be ridden
 - Familiar riding: to allow familiars to ride their master (familiars will be placed on their masters corners)
 - Prevent enemy riding: to stop tokens from riding enemy tokens (GMs ignore this setting)
-#### Client
+#### Client:
+- Rider movement: to decide what shall happen if a rider tries to move while still being mounted, either dismount the rider or stop the movement
 - Message popups: to activate some pop ups on certain actions
+- Own message popups only: to only show message popups from tokens you control
+#### Tokens:
+- Token is Rideable: to override world default for this token
+- Maximum riders: to override world default for this token
+- Token form: to set the form used to define this tokens border
+- Riders can move freely: to allow riders to move freely within this tokens borders (if the token is moved, all riders will keep their relative position)
 
 ### Compatibility:
 
@@ -35,6 +42,8 @@ The module should be compatible with all game systems on Foundry v10 and v11, th
 - [Wall-Height](https://foundryvtt.com/packages/wall-height):
   - Additional setting "Use token height": to use the the ridden tokens height instead of the "Riding Height" setting
   - If the above setting is activated the ridden tokens elevation will automatically be updated should the ridden tokens height change
+- [FoundryVTT Arms Reach](https://foundryvtt.com/packages/foundryvtt-arms-reach):
+  - Additional setting "Use Arms Reach distance": to use the "Arms Reach" distance instead of the set Mounting distance
 
 ### Languages:
 
@@ -43,5 +52,3 @@ The module contains an English and a German translation
 ---
 
 **If you have suggestions, questions, or requests for additional features please [let me know](https://github.com/Saibot393/Rideable/issues).**
-
-*If you have installed the module pre v1.1.3 i recommend uninstalling it and redownloading it. In previous versions an error in the manifest prevented Foundrys automatic module updater to find new versions, so that older versions can not be updated by Foundry directly.*

lang/de.json

@@ -1,6 +1,17 @@
 {
 	"Rideable" : {
+		"Titles" : {
+			"Rideable"					: "Rideable",
+			"WorldSettings"				: "Welt Einstellungen (nur SL)",
+			"ClientSettings"			: "Nutzer Einstellungen"
+		},
+
 		"Settings" : {
+			"defaultRideable" : {
+				"name" 					: "Marken standardmäßig reitbar",
+				"descrp"				: "Ob marken standardmäßig reitbar sein sollen(kann für jede Marke in den Markeneinstellungen geändert werden)"
+			},
+
 			"RidingHeight" : {
 				"name" 					: "Reithöhe",
 				"descrp"				: "Die z-Höhe welche eine reitende Marke im vergleich zur getrittenen Marke hat (es wird ein Wert über 0 empfohlen)"
@@ -16,6 +27,11 @@
 				"descrp"				: "Die maximale Distanz die zwischen einer Marke und ihrem Reitziel liegen kann (-1 für eine unendliche Reitdistanz)"
 			},
 
+			"UseArmReachDistance": {
+				"name" 					: "Nutze \"Arms Reach\"-Distanz",
+				"descrp"				: "Nutzt die Distanz welche in \"Arms Reach\" eingestellt ist für die Reitdistanz"	
+			},
+
 			"BorderDistance" : {
 				"name" 					: "Rand zu Rand Distanz",
 				"descrp"				: "Ob die Reitdistanz vom Rand anstatt der Mitte einer Marke berechnet werden soll (funktioniert nur mit Kreis/Quadrat Marken)"
@@ -47,8 +63,8 @@
 			},
 
 			"RideableTag" : {
-				"name" 					: "Gerittene Marken benötigen die \"Rideable\" Eigenschaft",
-				"descrp"				: "Erlaube nur Marken welche die \"Rideable\" Eigenschaft haben geritten zu werden (die \"Rideable\" Eigenschaft muss manuell eingetragen werden unter settings>Pathfinder 2nd Edition>Manage Honebrew Elements>Creature Traits)"				
+				"name" 					: "\"Rideable\" Eigenschaft",
+				"descrp"				: "Erlaube es Marken welche die \"Rideable\" Eigenschaft haben geritten zu werden (die \"Rideable\" Eigenschaft muss manuell eingetragen werden unter settings>Pathfinder 2nd Edition>Manage Honebrew Elements>Creature Traits)"				
 			},
 
 			"FamiliarRiding" : {
@@ -64,6 +80,11 @@
 			"MessagePopUps" : {
 				"name" 					: "Pop-up Meldungen",
 				"descrp"				: "Aktiviert mehrere pop-up Meldungen bei aktionen wie dem Auf- oder Absteigen"				
+			},		
+
+			"OnlyownedMessagePopUps" : {
+				"name" 					: "Nur eigene Pop-up Meldungen",
+				"descrp"				: "Zeigt nur die Pop-up Meldungen der Marken unter eigener Kontrolle"				
 			}		
 		},
 
@@ -96,6 +117,32 @@
 			"Toofaraway"				: "{pRiddenName} ist zu weit weg"
 		},	
 
-		"RideableTag.str"							: "rideable"	
+		"TokenSettings" : {
+			"MaxRiderFlag" : {
+				"name"					: "Maximale Reiter",
+				"descrp"				: "Überschreibt die Welt Einstellung für diese Marke (-1 für unlimitiert, leer lassen um zur Welt Einstellung zurück zu kehren)"
+			},
+
+			"issetRideableFlag" : {
+				"name"					: "Marke ist Reitbar",
+				"descrp"				: "Überschreibt den Globalen standard"
+			},
+
+			"TokenFormFlag" : {
+				"name"					: "Markenform",
+				"descrp"				: "",
+				"options" : {
+					"TokenFormCircle"	: "Kreis",
+					"TokenFormRectangle": "Rechteck"
+				}
+			},
+
+			"InsideMovementFlag" : {
+				"name"					: "Reiter können sich frei bewegen",
+				"descrp"				: "Ob Reiter sich frei in den Grenzen dieser Marke bewegen können"
+			}
+		},
+
+		"RideableTag.str"				: "rideable"	
 	}
 }

lang/en.json

@@ -1,6 +1,17 @@
 {
 	"Rideable" : {
+		"Titles" : {
+			"Rideable"					: "Rideable",
+			"WorldSettings"				: "World settings (GM only)",
+			"ClientSettings"			: "Client settings"
+		},
+
 		"Settings" : {
+			"defaultRideable" : {
+				"name" 					: "Tokens rideable by default",
+				"descrp"				: "Wether all tokens should be rideable by default (can be changed for each token in the token settings)"
+			},
+
 			"RidingHeight" : {
 				"name" 					: "Riding height",
 				"descrp"				: "The z-height which a riding token has compared to its mount (recommended to be above 0)"
@@ -16,6 +27,11 @@
 				"descrp"				: "The maximum distance a token can have to its mounting target (-1 for an unlimited range)"
 			},
 
+			"UseArmReachDistance": {
+				"name" 					: "Use \"Arms Reach\" distance",
+				"descrp"				: "Uses the distance set in the \"Arms Reach\" for the mounting distance"	
+			},
+
 			"BorderDistance" : {
 				"name" 					: "Border to border distance",
 				"descrp"				: "If the mounting distance should be calculated from the tokens border instead of the middle point (only works correctly for circular/square tokens)"
@@ -47,8 +63,8 @@
 			},
 
 			"RideableTag" : {
-				"name" 					: "Mounts require \"Rideable\" trait",
-				"descrp"				: "Allows only tokens which have the 'Rideable' trait to be ridden (the \"Rideable\" trait has to be manually added under settings>Pathfinder 2nd Edition>Manage Honebrew Elements>Creature Traits)"				
+				"name" 					: "\"Rideable\" trait",
+				"descrp"				: "Allows tokens which have the 'Rideable' trait to be ridden (the \"Rideable\" trait has to be manually added under settings>Pathfinder 2nd Edition>Manage Honebrew Elements>Creature Traits)"				
 			},
 
 			"FamiliarRiding" : {
@@ -64,7 +80,12 @@
 			"MessagePopUps" : {
 				"name" 					: "Message popups",
 				"descrp"				: "Enables multible popups upon actions such as mounting or dismounting"				
-			}		
+			},		
+
+			"OnlyownedMessagePopUps" : {
+				"name" 					: "Own message popups only",
+				"descrp"				: "Only shows the message popups from tokens you control"				
+			}
 		},
 
 		"Keys" : {
@@ -96,6 +117,32 @@
 			"Toofaraway"				: "{pRiddenName} is too far away"
 		},	
 
-		"RideableTag.str"							: "rideable"	
+		"TokenSettings" : {
+			"MaxRiderFlag" : {
+				"name"					: "Maximum riders",
+				"descrp"				: "Overrides the global setting for this token (-1 for unlimited, leave empty to return to default world setting)"
+			},
+
+			"issetRideableFlag" : {
+				"name"					: "Token is Rideable",
+				"descrp"				: "Overrides the global default setting"
+			},
+
+			"TokenFormFlag" : {
+				"name"					: "Token form",
+				"descrp"				: "",
+				"options" : {
+					"TokenFormCircle"	: "Circle",
+					"TokenFormRectangle": "Rectangle"
+				}
+			},
+
+			"InsideMovementFlag" : {
+				"name"					: "Riders can move freely",
+				"descrp"				: "If riders can move freely within the boundaries of this token"
+			}
+		},
+
+		"RideableTag.str"				: "rideable"	
 	}
 }

module.json

@@ -7,7 +7,7 @@
     "name": "saibot"
     }
   ],
-  "version": "1.5.1",
+  "version": "1.6.0",
   "compatibility": {
     "minimum": "10",
     "verified": "11"
@@ -29,13 +29,16 @@
   ],
   "esmodules": [
 	"scripts/RideableCompUtils.js",
+	"scripts/GeometricUtils.js",
 	"scripts/RideableUtils.js",
+	"scripts/RideablePopups.js",
 	"scripts/RideableFlags.js",
 	"scripts/RidingScript.js",
 	"scripts/MountingScript.js",
 	"scripts/SocketHandler.js",
 	"scripts/MacroHooks.js",
 	"scripts/RideableSettings.js",
+	"scripts/RideableTokenSettings.js",
 	"scripts/RideableCompatibility.js"
   ],
   "packs": [
@@ -47,7 +50,7 @@
 	}
   ],
   "url": "https://github.com/Saibot393/Rideable",
-  "download": "https://github.com/Saibot393/Rideable/archive/refs/tags/v1.5.1.zip",
+  "download": "https://github.com/Saibot393/Rideable/archive/refs/tags/v1.6.0.zip",
   "manifest": "https://github.com/Saibot393/Rideable/releases/latest/download/module.json",
   "readme": "https://github.com/Saibot393/Rideable/blob/main/README.md",
   "changelog": "https://github.com/Saibot393/Rideable/blob/main/CHANGELOG.md",