Cobblemon: Ride On!

• Fixed crashes that occurred with mods such as the Aether, where Whirlwinds invoke the "getPassengerRidingPosition" method of a Ride Pokemon. This was an instance of a non-passenger entity fetching a passenger attachment point, which was an unexpected occurrence that caused out-of-bounds index errors. This oversight has been addressed, meaning you can safely steer your Pokemon into billowing cyclones without worry of your server imploding.
• Fixed issues related to debug keybinds that were interfering with other keybinds even when "client.useDebugKeys" was disabled. Keybindings have been more closely aligned to how they are implemented in Cobblemon, which should reduce the likelihood of these issues moving forward.
• Restored ability for mounts to gradually turn with the player, like before v0.3.0. This issue arose after a switch to lerp functions based on the Mth class in Minecraft, which provides better stability and support for averaging between two rotations. But I goofed and set the lerp to use 100% of the player's rotation instead of the 50/50 that was used before. Sorry about that!
• Marked CobblemonRider and Cobblemon 1.7+ as incompatible with this mod for Fabric and NeoForge. Trying to run either mod/version alongside this one will now result in a crash.
  • Some people are probably going to be mad with me for this change, but this was made with two intentions. One, this will stop people from trying to run this mod alongside CobblemonRider; these mods are not compatible and only interfere with one another when used at the same time, so this is meant as a hard stop to discourage any further attempts to mix the two mods. Second, this will head off any attempts to run this mod with Cobblemon 1.7 after it releases; the upcoming version will change a lot of files, in addition to adding its own riding system, so it's just cleaner and safer to make sure this mod is marked as 100% incompatible with the newer version so that people will remember to remove this mod once 1.7 is out.

• Fixed crashes that occurred with mods such as the Aether, where Whirlwinds invoke the "getPassengerRidingPosition" method of a Ride Pokemon. This was an instance of a non-passenger entity fetching a passenger attachment point, which was an unexpected occurrence that caused out-of-bounds index errors. This oversight has been addressed, meaning you can safely steer your Pokemon into billowing cyclones without worry of your server imploding.
• Fixed issues related to debug keybinds that were interfering with other keybinds even when "client.useDebugKeys" was disabled. Keybindings have been more closely aligned to how they are implemented in Cobblemon, which should reduce the likelihood of these issues moving forward.
• Restored ability for mounts to gradually turn with the player, like before v0.3.0. This issue arose after a switch to lerp functions based on the Mth class in Minecraft, which provides better stability and support for averaging between two rotations. But I goofed and set the lerp to use 100% of the player's rotation instead of the 50/50 that was used before. Sorry about that!
• Marked CobblemonRider and Cobblemon 1.7+ as incompatible with this mod for Fabric and NeoForge. Trying to run either mod/version alongside this one will now result in a crash.
  • Some people are probably going to be mad with me for this change, but this was made with two intentions. One, this will stop people from trying to run this mod alongside CobblemonRider; these mods are not compatible and only interfere with one another when used at the same time, so this is meant as a hard stop to discourage any further attempts to mix the two mods. Second, this will head off any attempts to run this mod with Cobblemon 1.7 after it releases; the upcoming version will change a lot of files, in addition to adding its own riding system, so it's just cleaner and safer to make sure this mod is marked as 100% incompatible with the newer version so that people will remember to remove this mod once 1.7 is out.

• Fixed dismount logic where players could not dismount from Pokemon that are perpetually flying.
  • Some Pokemon, like Crobat, have behavior where they are always considered to be in a flying state and can never land. This created a problem when "common.canDismountInMidair" was false, however; players riding these Pokemon could never dismount, since the Pokemon's base behavior kept them from being grounded. The dismount logic has been updated such that, as long as the Pokemon's hitbox is within two blocks of height above solid ground, players can always dismount.
  • An extra system message has been added, to alert dismounting players when they are not close enough to the ground.
• Fixed issue where dismounting could rarely cause a crash.
• Fixed issue where trying to mount a Pokemon that you're already riding causes a crash.
• Added workaround compat with the Dismount Entity mod. The mod uses the same binding as the interaction wheel for removing entities from one another, so attempts by a second player to climb into a Pokemon resulted in no interaction wheel appearing and no feedback otherwise. This has been fixed by ensuring that Dismount Entity will ignore Ride Pokemon.
• Reworked interaction wheel additions by this mod to make use of events instead of mixins. This should be safer and more in-line with expected implementation standards for the feature.
  • As part of the rework, the interaction wheel options for riding will now only appear if the Pokemon has ride support. The "Remove saddle" option will only appear if the Pokemon has a saddle equipped.
• Updated default speed stat values, to help address some concerns related to greater speed post-Update 3. These will not reflect on existing servers, so it's recommended that you play with the config options to achieve the levels of speed you'd like to have.
• Added several debug-level messages for servers. Mounts and dismounts are now logged through the debug logger, to better troubleshoot any issues related to those steps in future incidents.
• Added debug controls for Ride Pokemon seating!
  • A new option "client.useDebugKeys" has been added. Enabling this feature adds four new keys to the controls menu intended for seating utility.
  • After mounting a Ride Pokemon, debug users can use the Mode Change key (default B) to swap which factors are affected by the Plus and Minus keys.
  • The Plus and Minus keys (default Right and Left Arrows) can be used to change between seats in Change Seat mode, or to increase/decrease the X, Y or Z position of the player in all other modes. The player's adjusted offset is then printed to the client system chat for convenience.
  • The Reset key (default Numpad 0) resets the debug and seat offsets for the user. These offsets are also automatically reset when the user dismounts the Pokemon.

• Fixed dismount logic where players could not dismount from Pokemon that are perpetually flying.
  • Some Pokemon, like Crobat, have behavior where they are always considered to be in a flying state and can never land. This created a problem when "common.canDismountInMidair" was false, however; players riding these Pokemon could never dismount, since the Pokemon's base behavior kept them from being grounded. The dismount logic has been updated such that, as long as the Pokemon's hitbox is within two blocks of height above solid ground, players can always dismount.
  • An extra system message has been added, to alert dismounting players when they are not close enough to the ground.
• Fixed issue where dismounting could rarely cause a crash.
• Fixed issue where trying to mount a Pokemon that you're already riding causes a crash.
• Added workaround compat with the Dismount Entity mod. The mod uses the same binding as the interaction wheel for removing entities from one another, so attempts by a second player to climb into a Pokemon resulted in no interaction wheel appearing and no feedback otherwise. This has been fixed by ensuring that Dismount Entity will ignore Ride Pokemon.
• Reworked interaction wheel additions by this mod to make use of events instead of mixins. This should be safer and more in-line with expected implementation standards for the feature.
  • As part of the rework, the interaction wheel options for riding will now only appear if the Pokemon has ride support. The "Remove saddle" option will only appear if the Pokemon has a saddle equipped.
• Updated default speed stat values, to help address some concerns related to greater speed post-Update 3. These will not reflect on existing servers, so it's recommended that you play with the config options to achieve the levels of speed you'd like to have.
• Added several debug-level messages for servers. Mounts and dismounts are now logged through the debug logger, to better troubleshoot any issues related to those steps in future incidents.
• Added debug controls for Ride Pokemon seating!
  • A new option "client.useDebugKeys" has been added. Enabling this feature adds four new keys to the controls menu intended for seating utility.
  • After mounting a Ride Pokemon, debug users can use the Mode Change key (default B) to swap which factors are affected by the Plus and Minus keys.
  • The Plus and Minus keys (default Right and Left Arrows) can be used to change between seats in Change Seat mode, or to increase/decrease the X, Y or Z position of the player in all other modes. The player's adjusted offset is then printed to the client system chat for convenience.
  • The Reset key (default Numpad 0) resets the debug and seat offsets for the user. These offsets are also automatically reset when the user dismounts the Pokemon.

• Changed backend logic to ignore sneaking state at the moment of mounting.
  • Players were having issues mounting their Pokemon while using mods like InvMove or accessibility features that maintain sneaking state. Vanilla Minecraft logic prevents mounting if sneaking is active, so I have changed the method call such that the game now ignores sneaking state when mounting a Pokemon.

• Changed backend logic to ignore sneaking state at the moment of mounting.
  • Players were having issues mounting their Pokemon while using mods like InvMove or accessibility features that maintain sneaking state. Vanilla Minecraft logic prevents mounting if sneaking is active, so I have changed the method call such that the game now ignores sneaking state when mounting a Pokemon.

The Re-Mounted Update!

• Mounting and Dismounting Rework!
  • Moved mounting-related actions to Cobblemon's built-in interaction wheel. Users must now Sneak and Interact with a Pokemon to mount it.
    • Added three interaction wheels buttons: "Ride", "Eject passengers", and "Remove saddle".
    • Added client messages that display if a player tries using any of the above actions unsuccessfully, e.g. trying to remove passengers from a Pokemon that has no passengers.
    • A separate interaction wheel for players trying to mount Pokemon belonging to another player has been added.
    • Minor adjustments to base Cobblemon logic, to fix minor issues with the interaction wheel GUI and to block item interactions that may trigger while opening the interaction wheel.
    • The above changes also means that all items should work normally moving forward, since mounting will no longer conflict with their use on a Pokemon.
  • Added configurable option to require saddles for mounting! This new option can be found in the server-level configuration under Restrictions.
    • When enabled, players must first attach a saddle to a Pokemon before they can successfully mount it. Saddles can be easily attached to a Pokemon by right-clicking on it with a saddle. Players can reclaim saddles using the "Remove saddle" interaction wheel option.
    • You cannot equip saddles to Pokemon you do not own or ones that do not have ride data.
    • As an anti-frustration feature, players can remove saddles from Pokemon to which they have previously attached saddles in the event that datapack changes removes ride support for a Pokemon.
    • Added a new "saddled" custom property to Cobblemon-related commands, e.g. "/pokeedit". Users with the right permissions can now set if a Pokemon is equipped with a saddle using these commands!
    • Added a small blip to the Summary and PC screens which appears for Pokemon that have a saddle equipped. This is a small QOL to help owners track which of their Pokemon are currently saddled.
  • Multi-seat riding!
    • An "additionalSeats" attribute has been added to Pokemon data files, which takes a list of offset arrays. Each array added to the list is treated as a new seat, and there is no upper limit to how many seats can be added to a Pokemon.
    • Current logic for resolving seating is that players can mount in a first-come, first-serve manner until there are no more empty seats. The Pokemon's owner get priority for the first seat; if there is no room when an owner tries to mount, the owner will take the first seat, all previous passengers will be bumped down a seat, and the last passenger will be ejected.
    • Added a small blip to the Summary, PC and Pokedex screens that appears for Pokemon with two or more seats. Mousing over the blip renders a tooltip that reveals the seat capacity of the Pokemon.
  • Dismount adjustments!
    • The default keybinding for Dismount has been adjusted such that the key pressed in combination with Send Out Pokemon can be configured!
      • Users can now set one of "SNEAK", "SPRINT", "ALT" (LAlt) or "NONE" to be held in combination with R for dismounting. This can be set with the new "client.dismountCombinationKey" config option. This was added to give users different options to use for the standard dismount action, especially where Sneak is tied to descending. If an invalid option is provided, it will default to "SNEAK".
    • An optional dismount keybind has also been added as an alternative to the above. Binding this key will allow you to instead use the keybind for dismounting, while disabling the default combination option.
    • Whichever option above is used, the client message that displays after mounting will update in accordance to the selected option and keybinds.
    • Dismount logic has been adjusted such that riders can dismount regardless of whether the mount is their actively selected Pokemon or one belonging to another player. Recalling a Pokemon you are actively mounting is still disabled, but you can still send out and recall other Pokemon in your party without trouble.
    • Dismount logic has also been rewritten such that dismounting activates on the positive edge of all keybind interactions. In the case of the default bind, this means dismounting triggers when you first press R while holding Sneak instead of when R is released. This is meant to make dismounting more consistent across all keybind options and aligns it better with how vanilla dismounting feels.
    • Ghost sneaking has been fixed. Now when you dismount from a Pokemon, the player's sneaking state should be correctly unset to prevent any further post-dismount Interact problems.
• Third person support!
  • Added client config options to allow for automatic switching to third-person and first-person cameras when mounting and dismounting respectively (both true by default).
  • Added support for Better Third Person when mounted upon a Ride Pokemon.
• Config changes
  • Speed scaling with stats has been updated with new options for what factors influence the speed. The factors can be changed by adjusting the value of the new "speedStat.speedSelection" option in the mod's configuration. The available options are listed below:
    • BASE_SPEED: Base speed only
    • BASE_NATURE: Base speed and nature
    • BASE_NATURE_VALUES: Base speed, nature, IVs and EVs (the new default)
    • TOTAL_SPEED: Base speed, nature, IVs, EVs, and level (the previous default)
  • A new Common subsection has been added to the mod's configuration file. This new subsection will include any options that can be set and used by the client, but which the server can override if desired.
  • A new option "overrideClientCommonConfig" has been added to Restrictions. Servers can enable this option to override the client's common configuration options with their own.
  • Moved "canDismountInMidair" into the Common subsection, so that servers - especially PvP ones - can regulate if players should collectively be allowed to dismount in midair.
  • Removed max limits for various config options, such as speed modifiers and server-set speed limits. Please be responsible.
• Pokemon data adjustments
  • Added initial multi-ride support for multiple Pokemon.
    • 2 seats: Rapidash (Normal and Galarian), Lapras, Wailmer, Metagross, Crustle, Bouffalant, Mudsdale, Corviknight and Cetitan
    • 3 seats: Dondozo
    • 4 seats: Avalugg
    • 15 seats: Wailord
  • Added ride support for Crobat and Gholdengo.
  • Fixed seating position for Alolan Exeggutor. Riders will no longer find themselves stuck underground and suffocating if they try to mount one.
• Implicitly doubled flight speed in Ride Pokemon movement speed calculations. This is because flight physics are different from grounded physics, which has been leading to slower speeds in air even when multipliers between mediums have been the same. This implicit multiplier acts as a temporary fix until a better fix can be implemented.
• Removed the no_mount_items and no_mount_battle_items tags, since the above changes remove the need to whitelist items during right clicks.
• Removed Pet Your Cobblemon integrations, since the above changes remove the need to check for PYC's Interaction Mode prior to mounting.
• Updated project's Kotlin version to v2.0.21.

The Re-Mounted Update!

• Mounting and Dismounting Rework!
  • Moved mounting-related actions to Cobblemon's built-in interaction wheel. Users must now Sneak and Interact with a Pokemon to mount it.
    • Added three interaction wheels buttons: "Ride", "Eject passengers", and "Remove saddle".
    • Added client messages that display if a player tries using any of the above actions unsuccessfully, e.g. trying to remove passengers from a Pokemon that has no passengers.
    • A separate interaction wheel for players trying to mount Pokemon belonging to another player has been added.
    • Minor adjustments to base Cobblemon logic, to fix minor issues with the interaction wheel GUI and to block item interactions that may trigger while opening the interaction wheel.
    • The above changes also means that all items should work normally moving forward, since mounting will no longer conflict with their use on a Pokemon.
  • Added configurable option to require saddles for mounting! This new option can be found in the server-level configuration under Restrictions.
    • When enabled, players must first attach a saddle to a Pokemon before they can successfully mount it. Saddles can be easily attached to a Pokemon by right-clicking on it with a saddle. Players can reclaim saddles using the "Remove saddle" interaction wheel option.
    • You cannot equip saddles to Pokemon you do not own or ones that do not have ride data.
    • As an anti-frustration feature, players can remove saddles from Pokemon to which they have previously attached saddles in the event that datapack changes removes ride support for a Pokemon.
    • Added a new "saddled" custom property to Cobblemon-related commands, e.g. "/pokeedit". Users with the right permissions can now set if a Pokemon is equipped with a saddle using these commands!
    • Added a small blip to the Summary and PC screens which appears for Pokemon that have a saddle equipped. This is a small QOL to help owners track which of their Pokemon are currently saddled.
  • Multi-seat riding!
    • An "additionalSeats" attribute has been added to Pokemon data files, which takes a list of offset arrays. Each array added to the list is treated as a new seat, and there is no upper limit to how many seats can be added to a Pokemon.
    • Current logic for resolving seating is that players can mount in a first-come, first-serve manner until there are no more empty seats. The Pokemon's owner get priority for the first seat; if there is no room when an owner tries to mount, the owner will take the first seat, all previous passengers will be bumped down a seat, and the last passenger will be ejected.
    • Added a small blip to the Summary, PC and Pokedex screens that appears for Pokemon with two or more seats. Mousing over the blip renders a tooltip that reveals the seat capacity of the Pokemon.
  • Dismount adjustments!
    • The default keybinding for Dismount has been adjusted such that the key pressed in combination with Send Out Pokemon can be configured!
      • Users can now set one of "SNEAK", "SPRINT", "ALT" (LAlt) or "NONE" to be held in combination with R for dismounting. This can be set with the new "client.dismountCombinationKey" config option. This was added to give users different options to use for the standard dismount action, especially where Sneak is tied to descending. If an invalid option is provided, it will default to "SNEAK".
    • An optional dismount keybind has also been added as an alternative to the above. Binding this key will allow you to instead use the keybind for dismounting, while disabling the default combination option.
    • Whichever option above is used, the client message that displays after mounting will update in accordance to the selected option and keybinds.
    • Dismount logic has been adjusted such that riders can dismount regardless of whether the mount is their actively selected Pokemon or one belonging to another player. Recalling a Pokemon you are actively mounting is still disabled, but you can still send out and recall other Pokemon in your party without trouble.
    • Dismount logic has also been rewritten such that dismounting activates on the positive edge of all keybind interactions. In the case of the default bind, this means dismounting triggers when you first press R while holding Sneak instead of when R is released. This is meant to make dismounting more consistent across all keybind options and aligns it better with how vanilla dismounting feels.
    • Ghost sneaking has been fixed. Now when you dismount from a Pokemon, the player's sneaking state should be correctly unset to prevent any further post-dismount Interact problems.
• Third person support!
  • Added client config options to allow for automatic switching to third-person and first-person cameras when mounting and dismounting respectively (both true by default).
  • Added support for Better Third Person when mounted upon a Ride Pokemon.
• Config changes
  • Speed scaling with stats has been updated with new options for what factors influence the speed. The factors can be changed by adjusting the value of the new "speedStat.speedSelection" option in the mod's configuration. The available options are listed below:
    • BASE_SPEED: Base speed only
    • BASE_NATURE: Base speed and nature
    • BASE_NATURE_VALUES: Base speed, nature, IVs and EVs (the new default)
    • TOTAL_SPEED: Base speed, nature, IVs, EVs, and level (the previous default)
  • A new Common subsection has been added to the mod's configuration file. This new subsection will include any options that can be set and used by the client, but which the server can override if desired.
  • A new option "overrideClientCommonConfig" has been added to Restrictions. Servers can enable this option to override the client's common configuration options with their own.
  • Moved "canDismountInMidair" into the Common subsection, so that servers - especially PvP ones - can regulate if players should collectively be allowed to dismount in midair.
  • Removed max limits for various config options, such as speed modifiers and server-set speed limits. Please be responsible.
• Pokemon data adjustments
  • Added initial multi-ride support for multiple Pokemon.
    • 2 seats: Rapidash (Normal and Galarian), Lapras, Wailmer, Metagross, Crustle, Bouffalant, Mudsdale, Corviknight and Cetitan
    • 3 seats: Dondozo
    • 4 seats: Avalugg
    • 15 seats: Wailord
  • Added ride support for Crobat and Gholdengo.
  • Fixed seating position for Alolan Exeggutor. Riders will no longer find themselves stuck underground and suffocating if they try to mount one.
• Implicitly doubled flight speed in Ride Pokemon movement speed calculations. This is because flight physics are different from grounded physics, which has been leading to slower speeds in air even when multipliers between mediums have been the same. This implicit multiplier acts as a temporary fix until a better fix can be implemented.
• Removed the no_mount_items and no_mount_battle_items tags, since the above changes remove the need to whitelist items during right clicks.
• Removed Pet Your Cobblemon integrations, since the above changes remove the need to check for PYC's Interaction Mode prior to mounting.
• Updated project's Kotlin version to v2.0.21.