HyCitizens - Interactable NPCs v1.7.2

## Features

• Added an option to set the distance for citizen map markers.
• Added the ability to use custom images for citizen map markers.

## Improvements

• Major performance improvements.
• Disabled knockback on Idle citizens.
• Improved patrolling citizens to help prevent them from getting stuck on other citizens.
• The Edit Citizens menu now uses a "Return" button instead of a "Cancel" button.
• HyCitizensRoles has now been merged into HyCitizensData. After updating the plugin and restarting your server, the server will automatically shut down once to complete the migration process. You will then need to start the server again.

## Fixes

• Fixed an issue with the Interaction API, specifically with NPC Trading.
• Fixed an issue causing the hotbar to visually appear glitched.

Improvements​

• Patrolling and following citizens can now enter combat.
• You can now set the speed of patrolling citizens.
• Major Skin Customizer UI improvements.
• Players can now run interaction commands with Citizens even if they don’t have permissions for that command.
  Note: If you're using a third-party permissions plugin, it must be compatible with Hytale's built-in vanilla permissions system.
• Various other improvements.

Fixes​

• Fixed some non-human entities not applying their scale value correctly.
• Fixed model nametags rotating on their Y axis.
• Fixed walking animations not working for some patrol entities.
• Fixed an issue with markers turning into "X".
• Fixed an issue where attacking a citizen would display "This citizen is busy in combat" despite no left-click interaction existing.
• Fixed a rare crash when interacting with citizens.
• Fixed a possible issue with JSON data files.

Notes​

• If you're using citizens that are set to follow or patrol, you may need to adjust their speed to match what it was prior to this update.

Features

• Added "TP", "Clone", and "Remove" buttons to the Edit Citizens menu.
• Added support for using models for nametags.
• Implemented sub-groups.
• Added an option to enable markers on the map for where citizens are.
• Added a "Respawn All" button.

Improvements

• Removed console logs when citizens get stuck.
• NPCs rotating towards players will now rotate back to their original rotation when the player leaves the radius.
• Improved performance to help prevent unexpected behavior.
• Citizen death and respawn handling is now more reliable to help fix the rare respawning issue.
• Moved the "Quick Actions" buttons to a new "Configuration" section.
• Cloning citizens now spawns them at your current position.
• Citizen groups are now automatically removed when they no longer contain any citizens.
• Citizen scale can no longer be set higher than 100 to help prevent crashes.

Fixes

• Fixed an issue with some entity models missing certain cosmetics such as eyes.
• Fixed an issue with rotate distance ignoring Y / height distance.
• Fixed possible duplication issues introduced in v1.6.1.
• Fixed skins turning brown if Live Skin was active while using a random or customized skin.
• Fixed non-English text in nametags causing a crash.
• Fixed patrol stick breaking blocks.
• Fixed an issue with the {CitizenName} placeholder in commands and messages when the citizen's name has multiple lines.
• Fixed an issue with multi-line nametags.
• Fixed citizens with "Passive" attitude not being able to take damage.
• Fixed Citizen Daily Schedules.
• Fixed multiple UI formatting issues.
• Fixed an issue when spawning a non-player citizen for the first time.
• Fixed an issue with setting a citizen to follow another citizen.

This update doesn’t include everything I originally planned, but I’m aiming to release another update within the next week or two.

New Features

• Schedules: This feature is still a work in progress and hasn’t been heavily tested due to time constraints related to Hytale Update 4. If you encounter any issues, please report them in #feedback.
• Follow Movement Type: Citizens can now be set to follow other citizens.

Improvements

• Wandering or patrolling citizens will now automatically free themselves if they get stuck.

Bug Fixes

• Fixed issues introduced in Hytale Update 4
• Citizens will no longer duplicate (yes, again.. but this time it’s actually fully fixed )

New Features

• Added "Citizen Stick". With the citizen stick, you can hit citizens to edit them.
• Added "Edit Closest Citizen" button for quicker editing.
• Citizens can now be configured to attack other entities.
• Added chance configuration for death rewards.
• Added First-Time Interaction actions.
• Added group renaming support.
• Added patrol path renaming support.
• Added configurable option for "Rotate Towards Player" distance.
• Added "Nametag Lines" menu.
• Added health regeneration.

Improvements

• Improved overall UI layout and usability.
• Enhanced support for advanced configuration options.
• Added rich message formatting for citizen messages: Bold, Italic, and Clickable Links.
• Added new message and command placeholders: {NpcX}, {NpcY}, {NpcZ}.
• Improved death handling logic so respawning, drops, and death commands now trigger correctly when a citizen dies from non-player causes.
• Improved internal handling of respawn timers and citizen lifecycle management.
• Added random and sequential execution modes for Interaction Commands, Interaction Messages, and Death Commands.
• Patrol Stick usage now requires the hycitizens.admin permission.

Bug Fixes

• Fixed citizens occasionally breaking (interactions, animations, patrolling, etc).
• Fixed several advanced options not saving properly.
• Fixed citizen respawning logic triggering incorrectly when chunks reload.
• Fixed "Hide NPC" not persisting when chunks reload.
• Fixed multiple bugs affecting advanced options introduced in v1.5.
• Fixed several edge cases.

Developer / API

• Added citizen damage and death callback events.
• Added citizen add/remove callbacks events.

## Improvements & Additions:

• NPC + Nametags are now the same entity unless the citizen's name uses multiple lines or has an offset. This fixes nametags appearing to lag behind walking citizens.
• Increased citizen max health and damage limit to 1,000,000.
• When the plugin is first installed and creates the HyCitizensRoles asset pack, it now automatically enables it in the server's config.json when the DefaultModsEnabled is disabled.
• Added "Patrol Stick" to make it easier to setup patrol routes.
• Added scrollbar to Patrol Paths and Edit Paths menus.
• Added "TP", "Move Up", and "Move Down" buttons in the Patrol Path edit menu.
• Removed outdated and invalid roles.
• General stability improvements

## Bug Fixes:

• Fixed multiple issues that could cause in citizen duplication.
• Fixed player crashes/disconnects when killing NPCs.
• Fixed NPC desyncs / interactions stopping every so often.
• Fixed NPCs disappearing occasionally when updating skin.
• Fixed despawnCitizenNPC leaving citizens in a limbo state when the entity was already gone.
• Fixed an issue where nametags would sometimes stop updating.
• Fixed an issue when assigning NPC models.
• Fixed an issue with the citizen death commands.
• Fixed issue when assigning roles.
• Fixed a nametag spawn lock getting permanently stuck when a citizen's name is empty, preventing all future nametag spawns for that citizen.
• Fixed removeCitizen throwing a NullPointerException when the citizen ID was missing.
• Fixed citizens' armor not applying the max health stat correctly.
• Fixed "Live Skin Update" causing issues for random or customized skins.
• Fixed re-spawning/saving a citizen briefly showing them as a "naked" player.
• Fixed an issue where removing an entity from an unloaded world would not always despawn the NPC and nametag.
• Fixed "F" key interactions breaking citizens.
• Fixed a patrol move-target entity leak on the despawn path.
• Fixed an issue where certain characters in names or text could cause interactions or messages to break.
• Fixed an issue with the attack type auto-resolve button.
• Fixed the Interactable component being added but never removed when F-key interaction is no longer applicable.
• Fixed a chunk preload flow incorrectly accepting an invalid entity ref as resolved.
• Fixed several crashes in the Skin Customizer UI.
• Fixed user-provided patrol path names with special characters breaking HTML/event ID bindings.
• and more!

## Important:
If you are having issues with Citizens spawning after updating to v1.5, try updating your HytaleServer.jar, even if it's already on the latest version.

## Fixes:

• Fixed an issue where you couldn't open "Advanced settings" in the behavior menu
• Fixed an issue with non-citizens reacting to interactions
• Fixed an error in the patrol menu
• Fixed an issue with the interaction listener for the developer API and some other issues related to this. This also fixes an issue with the NPC Trading plugin.
• Fixed an issue with using apostrophes in citizen names

## Improvements:
* Added setForceFKeyInteractionText() for the developer API


Thank you to everyone who reported issues.

## Important

• First restart after installing will trigger a one-time automatic shutdown (expected).
• NPCs must be respawned (click “Save”) for new features to apply. Their chunk must be loaded.
• Patrolling is Part 1/2 — functional but improvements are coming.
• Developer API docs are outdated (v1.4–1.5 not included). Full documentation site launching soon.
• Upcoming updates will focus on polish, improvements, and fixes.

## Skin & Cosmetic Menu

• Fully custom human NPCs
• Local skin fetching (if player online)
• Fallback skin prevents invisible NPCs

## Custom Behavior System

NPCs now support configurable:
• Behavior, movement, combat & interactions
• Health, damage, drops
• Death messages & commands
• Developer death callback event

## Patrolling

• Waypoint-based patrol paths
• Path editing system

Limitations:
• No combat
• No reaction to attacks
• Editing UI needs improvement

## New Interaction System

• “F” works while wandering
• Separate left-click & “F” actions
• Fixed creative mode issues
• Optional delays between commands/messages
• Right-click still unsupported (engine limitation)

## Movement

• Custom wander radius
• API movement control
• TP now goes to actual NPC position

## Backend & Performance

• Async citizen loading
• Improved stability
• Reworked damage handling
• Improved skin fetching

## Improvements

• Alphabetical citizen list
• Command aliases:
/citizen /hycitizens /hycitizen

## Fixes

• Command order issues
• Hologram API functions
• Console warnings on join
• Rare data.json wipe
• Skin change bugs
• NPC/nametag duplication
• Special character name issues

## Developer Additions

• Death callback
• Movement API control
• Async improvements

## Known Issues

• Attack animations not customizable
• Patrolling NPCs can’t fight or react (for now)


Consider supporting HyCitizen's Development: https://ko-fi.com/electrogames