# NPCPremium

NPCPremium is a configurable NPC mod for Minecraft Fabric, Forge servers and clients.
It adds persistent player-like NPCs with custom skins, formatted name/subname, right-click actions, placeholders, messages, sounds, a full in-game editor GUI, real Emotecraft emotes played by the NPC itself, and a configurable lightweight AI behavior system. Created by zJuqni

Compatible with:
- Minecraft 1.21.1-1.20.1
- Fabric Loader 0.18.2+
- Fabric API
- Java 21
- Optional: Emotecraft 2.4.12+ (playeranimator may also be required depending on the setup)

## What it does
- Creates persistent NPC entities saved in world NBT.
- Supports custom name and subname, legacy formatting with `&` and `§`, and escaped ampersands with `\&`.
- Resolves skins from a player nickname, with Steve/Alex fallback if textures cannot be resolved.
- Supports right-click interaction with commands as player or console, click messages in chat or actionbar, click sounds, click emotes, per-NPC cooldowns, proximity radius, near-trigger emotes, and optional interaction restrictions.

## AI and behavior
- AI modes: `static`, `wander`, `patrol`, `follow`, `guard`, `orbit`, `greet`, `flee`, `mirror`, `showcase`.
- AI tuning: home, detection range, speed, radius, stop distance, and teleport range.
- Saved waypoint routes for patrol and showcase setups.
- AI presets: `host`, `guard`, `pet`, `shy`, `mirror`, `showcase`, `patrol`.
- Contextual greeting messages, greeting emotes, greeting cooldowns, and ambient emotes with configurable intervals.
- Uses a custom lightweight movement system instead of vanilla mob AI/pathfinding.

## Editor GUI
- `/npcpremium gui <npcName>` opens a tabbed editor for General, Position, AI Brain, Click, Feedback, and Emotes.
- Lets you manage most NPC settings in-game without memorizing the full command syntax.

## Other features
- Built-in placeholders for commands and messages: `%player%`, `%player_uuid%`, `%player_x%`, `%player_y%`, `%player_z%`, `%player_world%`, `%npc%`, `%npc_uuid%`, `%npc_x%`, `%npc_y%`, `%npc_z%`, `%npc_world%`, `%world%`.
- Optional PB4 Placeholder API support by reflection if present.
- `/summon npcpremium:npc` auto-registers summoned NPCs with numeric ids like `1`, `2`, `3`, and assigns a default visible name like `NPC #1` when needed.
- Advanced controls include `look static|nearest`, configurable look range, move to looked block, rotation presets, per-NPC damage toggle, and NPC cloning.

## Commands
- Core management: create, delete, list, tp, info, gui, name, subname, skin, move, rotate, look, clone, damage.
- Interaction and feedback: onclick, message, sound, emote, near radius, cooldown, interact onlyplayers, interact requirepermission.
- AI management: ai status, mode, home, range, speed, radius, stopdistance, teleportrange, ambientemote, ambientinterval, preset, waypoint add/list/remove/clear, greeting message/clear/cooldown/emote.

## Permissions
- `npcpremium.admin` grants admin access to `/npcpremium`.
- Falls back to the configured OP level if no compatible permission provider is available.
- Per-NPC `interact requirepermission <node>` can use real permission nodes when a compatible provider is present.

## Important limits
- The main interaction trigger is right-click.
- NPCs are static by default and do not use vanilla AI or vanilla pathfinding.
- AI movement is lightweight and behavior-driven, not full autonomous navigation.
- Emotes are optional and require Emotecraft support in the environment that renders them.
- Skin lookup may fall back to Steve/Alex if profile textures cannot be resolved.
- For the full experience, install the mod on both server and client. Install Emotecraft on the side that should render NPC emotes.

# ----- SPANISH -----

# NPCPremium

NPCPremium es un mod de NPCs configurables para Minecraft Fabric, Forge en servidor y cliente.
Añade NPCs tipo jugador persistentes con skins personalizadas, name/subname con formato, acciones por click derecho, placeholders, mensajes, sonidos, una GUI completa de edición, emotes reales de Emotecraft reproducidos por el propio NPC y un sistema configurable de IA ligera. Creador por zJuqni

Compatible con:
- Minecraft 1.21.1-1.20-1
- Fabric Loader 0.18.2+
- Fabric API
- Java 21
- Opcional: Emotecraft 2.4.12+ (playeranimator también puede ser necesario según la instalación)

## Qué hace
- Crea entidades NPC persistentes guardadas en el NBT del mundo.
- Soporta name y subname personalizados, formato legacy con `&` y `§`, y escape de ampersands con `\&`.
- Resuelve skins a partir del nick de un jugador, con fallback a Steve/Alex si no se pueden obtener las texturas.
- Soporta interacción por click derecho con comandos como player o console, mensajes al click en chat o actionbar, sonidos, emotes al click, cooldowns por NPC, radio de proximidad, emotes por cercanía y restricciones opcionales de interacción.

## IA y comportamiento
- Modos de IA: `static`, `wander`, `patrol`, `follow`, `guard`, `orbit`, `greet`, `flee`, `mirror`, `showcase`.
- Ajustes de IA: home, rango de detección, velocidad, radio, stop distance y teleport range.
- Rutas guardadas por waypoints para patrullas y setups de showcase.
- Presets de IA: `host`, `guard`, `pet`, `shy`, `mirror`, `showcase`, `patrol`.
- Mensajes de saludo contextuales, emotes de saludo, cooldown de saludo y emotes ambientales con intervalo configurable.
- Usa un sistema propio de movimiento ligero en lugar de la IA/pathfinding vanilla.

## GUI de editor
- `/npcpremium gui <npcName>` abre un editor por pestañas con General, Position, AI Brain, Click, Feedback y Emotes.
- Permite configurar casi todo el NPC dentro del juego sin memorizar toda la sintaxis de comandos.

## Otras funciones
- Placeholders integrados para comandos y mensajes: `%player%`, `%player_uuid%`, `%player_x%`, `%player_y%`, `%player_z%`, `%player_world%`, `%npc%`, `%npc_uuid%`, `%npc_x%`, `%npc_y%`, `%npc_z%`, `%npc_world%`, `%world%`.
- Compatibilidad opcional con PB4 Placeholder API por reflexión si está presente.
- `/summon npcpremium:npc` auto-registra NPCs invocados con ids numéricos como `1`, `2`, `3`, y les asigna un nombre visible por defecto como `NPC #1` cuando hace falta.
- Incluye controles avanzados como `look static|nearest`, rango de mirada configurable, mover al bloque que estás mirando, presets de rotación, toggle de daño por NPC y clonado de NPCs.

## Comandos
- Gestión principal: create, delete, list, tp, info, gui, name, subname, skin, move, rotate, look, clone, damage.
- Interacción y feedback: onclick, message, sound, emote, near radius, cooldown, interact onlyplayers, interact requirepermission.
- Gestión de IA: ai status, mode, home, range, speed, radius, stopdistance, teleportrange, ambientemote, ambientinterval, preset, waypoint add/list/remove/clear, greeting message/clear/cooldown/emote.

## Permisos
- `npcpremium.admin` da acceso administrativo a `/npcpremium`.
- Si no hay un provider de permisos compatible, usa como fallback el nivel OP configurado.
- `interact requirepermission <node>` puede usar nodos reales cuando existe un provider compatible.

## Límites importantes
- La interacción principal es con click derecho.
- Los NPCs son estáticos por defecto y no usan IA vanilla ni pathfinding vanilla.
- El movimiento de IA es ligero y basado en comportamiento, no navegación autónoma completa.
- Los emotes son opcionales y requieren soporte de Emotecraft en el entorno que los renderiza.
- La skin puede caer en Steve/Alex si no se pueden resolver las texturas del perfil.
- Para la experiencia completa, instala el mod en servidor y cliente. Instala Emotecraft en el lado que deba renderizar los emotes del NPC.

NpcPremium