Difference between revisions of "Modding:NPC data"

From Stardew Valley Wiki
Jump to navigation Jump to search
(→‎Guidance on pixel art: Changed reference to the Modding Index See Also section.)
Tags: Mobile edit Mobile web edit
Line 1: Line 1:
← [[Modding:Index|Index]]
+
← [[Modding: Index | Index]]
  
This page provides an overview of what's needed to create a custom NPC. This is an advanced guide for mod developers.
+
Esta página proporciona una descripción general de lo que se necesita para crear un NPC personalizado. Esta es una guía avanzada para desarrolladores de mods.
  
'''Before reading this page''', see [[Modding:Editing XNB files]] for the basic concepts.
+
'' 'Antes de leer esta página' '', consulte [[Modding: Editando archivos XNB]] para conocer los conceptos básicos.
  
==Files to edit==
+
== Archivos para editar ==
To create a new NPC, you need to edit a number of different files. However, you don't need any programming experience and it can be done with {{nexus mod|1915|Content Patcher}}.
+
Para crear un nuevo NPC, debe editar varios archivos diferentes. Sin embargo, no necesita ninguna experiencia en programación y se puede hacer con {{nexus mod | 1915 | Content Patcher}}.
  
===Basic info===
+
=== Información básica ===
The <tt>Data\NPCDispositions</tt> asset contains basic information for your character, including their name, birthday, relations to other characters, personality, and whether they can be dated.
+
El activo <tt> Data \ NPCDispositions </tt> contiene información básica de tu personaje, incluido su nombre, fecha de nacimiento, relaciones con otros personajes, personalidad y si pueden tener una fecha.
  
The file has one row per NPC like this:
+
El archivo tiene una fila por NPC como esta:
<syntaxhighlight lang="yaml">
+
<syntaxhighlight lang = "yaml">
   Abigail: "teen/rude/outgoing/neutral/female/datable/Sebastian/Town/fall 13/Caroline 'mom' Pierre 'dad'/SeedShop 1 9/Abigail"
+
   Abigail: "adolescente / grosera / extrovertida / neutral / femenina / datable / Sebastian / Town / otoño 13 / Caroline 'mamá' Pierre 'papá' / SeedShop 19 / Abigail"
 
</syntaxhighlight>
 
</syntaxhighlight>
  
The key (before the colon) is the internal name which uniquely identifies that NPC. This name isn't shown to the player, but will be used when referencing the NPC in other files. The value contains the following fields:
+
La clave (antes de los dos puntos) es el nombre interno que identifica de forma única a ese NPC. Este nombre no se muestra al jugador, pero se usará cuando se haga referencia al NPC en otros archivos. El valor contiene los siguientes campos:
  
{| class="wikitable"
+
{| class = "wikitable"
|-
+
| -
! index
+
! índice
! field
+
! campo
! example
+
! ejemplo
! purpose
+
! propósito
|-
+
| -
 
| 0
 
| 0
| age
+
| edad
| <tt>teen</tt>
+
| <tt> adolescente </tt>
| Whether the NPC is a <tt>child</tt>, <tt>teen</tt>, or <tt>adult</tt>. This affects generated dialogue lines (e.g. a child would say ''stupid'' and an adult would say ''depressing''), generic dialogue (e.g. a child would respond to dumpster diving with "''Eww... What are you doing?''" and a teen would say "''Um... Why are you digging in the trash?''"), and the gift they choose as [[Feast of the Winter Star|a secret gift-giver]]. Children are also excluded from item delivery quests.
+
| Si el NPC es un <tt> niño </tt>, <tt> adolescente </tt> o <tt> adulto </tt>. Esto afecta las líneas de diálogo generadas (por ejemplo, un niño diría '' estúpido '' y un adulto diría '' deprimente ''), el diálogo genérico (por ejemplo, un niño respondería a un contenedor de basura buceando con '' 'Eww ... haciendo? '' "y un adolescente diría" '' Um ... ¿Por qué estás cavando en la basura? '' "), y el regalo que eligen como [[Fiesta de la Estrella de Invierno | un obsequio secreto] ]. Los niños también están excluidos de las misiones de entrega de artículos.
|-
+
| -
 
| 1
 
| 1
| manners
+
| modales
| <tt>rude</tt>
+
| <tt> grosero </tt>
| Whether the NPC is <tt>polite</tt>, <tt>rude</tt>, or <tt>neutral</tt>. This affects some generic dialogue lines.
+
| Si el NPC es <tt> cortés </tt>, <tt> grosero </tt> o <tt> neutral </tt>. Esto afecta a algunas líneas de diálogo genéricas.
|-
+
| -
 
| 2
 
| 2
| social anxiety
+
| ansiedad social
| <tt>outgoing</tt>
+
| <tt> saliente </tt>
| Whether the NPC is <tt>outgoing</tt>, <tt>shy</tt>, or <tt>neutral</tt>. This affects some generic dialogue lines.
+
| Si el NPC es <tt> extrovertido </tt>, <tt> tímido </tt> o <tt> neutral </tt>. Esto afecta a algunas líneas de diálogo genéricas.
|-
+
| -
 
| 3
 
| 3
| optimism
+
| optimismo
| <tt>neutral</tt>
+
| <tt> neutral </tt>
| Whether the NPC is <tt>positive</tt>, <tt>negative</tt>, or <tt>neutral</tt>. ''Unused.''
+
| Si el NPC es <tt> positivo </tt>, <tt> negativo </tt> o <tt> neutral </tt>. ''No usado.''
|-
+
| -
 
| 4
 
| 4
| gender
+
| género
| <tt>female</tt>
+
| <tt> mujer </tt>
| Whether the NPC is <tt>male</tt>, <tt>female</tt>, or <tt>undefined</tt>. This affects dialogue, whether children in marriage are obtained through adoption or pregnancy, and the reserved frames' positions on the spritesheet.
+
| Si el NPC es <tt> hombre </tt>, <tt> mujer </tt> o <tt> indefinido </tt>. Esto afecta el diálogo, si los hijos en matrimonio se obtienen mediante adopción o embarazo, y las posiciones de los marcos reservados en la hoja de sprites.
|-
+
| -
 
| 5
 
| 5
 
| datable
 
| datable
| <tt>datable</tt>
+
| <tt> datable </tt>
| Whether the NPC is <tt>datable</tt> or <tt>not-datable</tt>. This toggles the romance features (e.g. 'single' label in the social menu, bouquet gifting, and marriage).
+
| Si el NPC es <tt> datable </tt> o <tt> no datable </tt>. Esto alterna las características de romance (por ejemplo, etiqueta 'única' en el menú social, regalo de ramo y matrimonio).
|-
+
| -
 
| 6
 
| 6
| love interest
+
| interés amoroso
| <tt>Sebastian</tt>
+
| <tt> Sebastián </tt>
| ''Unused.''
+
| ''No usado.''
|-
+
| -
 
| 7
 
| 7
| home region
+
| región de origen
| <tt>Town</tt>
+
| <tt> Ciudad </tt>
| Whether the NPC lives in the <tt>Desert</tt>, <tt>Town</tt>, or <tt>Other</tt>. This is used when improving friendship points for all NPCs in a given region, which is currently only used for the [[Luau]] friendship boost (which only affects NPCs in the <tt>Town</tt> region).
+
| Si el NPC vive en el <tt> Desierto </tt>, <tt> Pueblo </tt> u <tt> Otro </tt>. Esto se usa para mejorar los puntos de amistad para todos los NPC en una región determinada, que actualmente solo se usa para el impulso de amistad [[Luau]] (que solo afecta a los NPC en la región <tt> Town </tt>).
|-
+
| -
 
| 8
 
| 8
| birthday
+
| cumpleaños
| <tt>fall 13</tt>
+
| <tt> otoño 13 </tt>
| The season and day for the NPC's birthday.
+
| La temporada y el día del cumpleaños del NPC.
|-
+
| -
 
| 9
 
| 9
| relationships
+
| relaciones
| <tt>Caroline 'mom' Pierre 'dad'</tt>
+
| <tt> Caroline 'mamá' Pierre 'papá' </tt>
| This affects generic dialogue for revealing likes and dislikes to family members. May also affect the inlaw_<NPC> dialogue. Can be empty if not applicable (e.g. <code>/fall 13//SeedShop 1 9/</code>).
+
| Esto afecta el diálogo genérico para revelar lo que le gusta y lo que no le gusta a los miembros de la familia. También puede afectar el diálogo inlaw_ <NPC>. Puede estar vacío si no corresponde (por ejemplo, <code> / fall 13 // SeedShop 1 9 / </code>).
|-
+
| -
 
| 10
 
| 10
| default map & position
+
| mapa y posición predeterminados
| <tt>SeedShop 1 9</tt>
+
| <tt> SeedShop 1 9 </tt>
| The location name and [[Modding:Modder Guide/Game Fundamentals#Tiles|tile position]] where the NPC starts and ends each day.
+
| El nombre de la ubicación y [[Modding: Modder Guide / Game Fundamentals # Tiles | tile position]] donde el NPC comienza y termina cada día.
|-
+
| -
 
| 11
 
| 11
| display name
+
| nombre para mostrar
| <tt>Abigail</tt>
+
| <tt> Abigail </tt>
| The NPC name shown to the player.
+
| El nombre del NPC que se muestra al jugador.
 
|}
 
|}
  
===Gift tastes===
+
=== Sabores de regalo ===
The <tt>Data\NPCGiftTastes</tt> asset contains their gift preferences (e.g. which gifts they love or hate), and their responses when they receive one. See [[Modding:Gift taste data]] for more info.
+
El activo <tt> Data \ NPCGiftTastes </tt> contiene sus preferencias de obsequio (p. Ej., Qué obsequios aman u odian) y sus respuestas cuando reciben uno. Consulte [[Modding: Gift taste data]] para obtener más información.
  
The file has one row per NPC like this:
+
El archivo tiene una fila por NPC como esta:
<syntaxhighlight lang="yaml">
+
<syntaxhighlight lang = "yaml">
   Abigail: "I seriously love this! You're the best, @!/66 128 220 226 276 611/Hey, how'd you know I was hungry? This looks delicious!//What am I supposed to do with this?/-5 -75 -79 16 245 246/What were you thinking? This is awful!/330/You brought me a present? Thanks.// " #!String
+
   Abigail: "¡En serio me encanta esto! ¡Eres la mejor, @! / 66 128 220 226 276 611 / Oye, ¿cómo sabías que tenía hambre? ¡Esto se ve delicioso! // ¿Qué se supone que debo hacer con esto? / -5-75-79 16 245 246 / ¿Qué estabas pensando? ¡Esto es horrible! / 330 / ¿Me trajiste un regalo? Gracias.// "#! String
 
</syntaxhighlight>
 
</syntaxhighlight>
  
The line can be broken down into 5 pairs of dialogue + item IDs in this order: Love, Like, Neutral, Dislike, Hate. If a dialogue field is empty, the game will use a generic dialogue text. See [[Modding:Object data]] for the item IDs.
+
La línea se puede dividir en 5 pares de diálogos + ID de elementos en este orden: Amor, Me gusta, Neutral, No me gusta, Odio. Si un campo de diálogo está vacío, el juego utilizará un texto de diálogo genérico. Consulte [[Modding: datos del objeto]] para conocer los ID de los artículos.
  
====Birthday gift responses====
+
==== Respuestas de regalos de cumpleaños ====
The <tt>Strings\StringsFromCSFiles</tt> asset contains the generic responses given by NPCs to birthday gifts based on their gift preferences and manners. These shared strings can be customized for a specific NPC by editing them conditionally, such as only on the NPC's (non-shared) birthday. The following criteria are used to select from among the strings:
+
El activo <tt> Strings \ StringsFromCSFiles </tt> contiene las respuestas genéricas dadas por los NPC a los regalos de cumpleaños según sus preferencias y modales. Estas cadenas compartidas se pueden personalizar para un NPC específico editándolas condicionalmente, como solo en el cumpleaños (no compartido) del NPC. Los siguientes criterios se utilizan para seleccionar entre las cadenas:
  
{| class="wikitable"
+
{| class = "wikitable"
|-
+
| -
! gift taste
+
! sabor de regalo
! manners
+
! modales
! chance
+
! oportunidad
! string
+
! cuerda
|-
+
| -
| rowspan="4" | love, like
+
| rowpan = "4" | amar como
| rowspan="2" | rude
+
| rowpan = "2" | maleducado
 
| 50%
 
| 50%
| <tt>NPC.cs.4274</tt>
+
| <tt> NPC.cs.4274 </tt>
|-
+
| -
 
| 50%
 
| 50%
| <tt>NPC.cs.4276</tt>
+
| <tt> NPC.cs.4276 </tt>
|-
+
| -
| rowspan="2" | polite, neutral
+
| rowpan = "2" | educado, neutral
 
| 50%
 
| 50%
| <tt>NPC.cs.4275</tt>
+
| <tt> NPC.
|-
 
| 50%
 
| <tt>NPC.cs.4277</tt>
 
|-
 
| rowspan="2" | dislike, hate
 
| rude
 
| 100%
 
| <tt>NPC.cs.4278</tt>
 
|-
 
| polite, neutral
 
| 100%
 
| <tt>NPC.cs.4279</tt>
 
|-
 
| rowspan="2" | neutral
 
| rude
 
| 100%
 
| <tt>NPC.cs.4280</tt>
 
|-
 
| polite, neutral
 
| 100%
 
| <tt>NPC.cs.4281</tt>
 
|}
 
 
 
===Overworld sprites===
 
The overworld sprites are stored in <tt>Characters/NpcName</tt>, including movement and animation frames. Each frame is exactly 16x32 pixels. Here's an [https://cdn.discordapp.com/attachments/156109690059751424/729807097835028540/unknown.png example sprite guide], courtesy of TheLimeyDragon#1993 on Discord. Some positions are reserved for certain actions:
 
<ul>
 
<li>the first sixteen frames are generic movement (four frames per direction);</li>
 
<li>frames 40–47 (female) and 44–47 (male) must be the Flower Dance dance, if they participate;</li>
 
<li>frames 36–38 (female) 48–50 (male) are reserved for marriageable NPCs (Contains Wedding sprite);</li>
 
<li>and the kissing sprite/direction varies depending on NPC:
 
{| class="wikitable"
 
 
|-
 
|-
 
! character
 
! character

Revision as of 01:03, 7 August 2021

Index

Esta página proporciona una descripción general de lo que se necesita para crear un NPC personalizado. Esta es una guía avanzada para desarrolladores de mods.

'Antes de leer esta página' , consulte Modding: Editando archivos XNB para conocer los conceptos básicos.

Archivos para editar

Para crear un nuevo NPC, debe editar varios archivos diferentes. Sin embargo, no necesita ninguna experiencia en programación y se puede hacer con 1915 Content Patcher.

Información básica

El activo Data \ NPCDispositions contiene información básica de tu personaje, incluido su nombre, fecha de nacimiento, relaciones con otros personajes, personalidad y si pueden tener una fecha.

El archivo tiene una fila por NPC como esta:

   Abigail: "adolescente / grosera / extrovertida / neutral / femenina / datable / Sebastian / Town / otoño 13 / Caroline 'mamá' Pierre 'papá' / SeedShop 19 / Abigail"

La clave (antes de los dos puntos) es el nombre interno que identifica de forma única a ese NPC. Este nombre no se muestra al jugador, pero se usará cuando se haga referencia al NPC en otros archivos. El valor contiene los siguientes campos:

- índice campo ejemplo propósito - 0 edad adolescente Si el NPC es un niño , adolescente o adulto . Esto afecta las líneas de diálogo generadas (por ejemplo, un niño diría estúpido y un adulto diría deprimente ), el diálogo genérico (por ejemplo, un niño respondería a un contenedor de basura buceando con 'Eww ... haciendo? "y un adolescente diría" Um ... ¿Por qué estás cavando en la basura? "), y el regalo que eligen como [[Fiesta de la Estrella de Invierno | un obsequio secreto] ]. Los niños también están excluidos de las misiones de entrega de artículos. - 1 modales grosero Si el NPC es cortés , grosero o neutral . Esto afecta a algunas líneas de diálogo genéricas. - 2 ansiedad social saliente Si el NPC es extrovertido , tímido o neutral . Esto afecta a algunas líneas de diálogo genéricas. - 3 optimismo neutral Si el NPC es positivo , negativo o neutral . No usado. - 4 género mujer Si el NPC es hombre , mujer o indefinido . Esto afecta el diálogo, si los hijos en matrimonio se obtienen mediante adopción o embarazo, y las posiciones de los marcos reservados en la hoja de sprites. - 5 datable datable Si el NPC es datable o no datable . Esto alterna las características de romance (por ejemplo, etiqueta 'única' en el menú social, regalo de ramo y matrimonio). - 6 interés amoroso Sebastián No usado. - 7 región de origen Ciudad Si el NPC vive en el Desierto , Pueblo u Otro . Esto se usa para mejorar los puntos de amistad para todos los NPC en una región determinada, que actualmente solo se usa para el impulso de amistad Luau (que solo afecta a los NPC en la región Town ). - 8 cumpleaños otoño 13 La temporada y el día del cumpleaños del NPC. - 9 relaciones Caroline 'mamá' Pierre 'papá' Esto afecta el diálogo genérico para revelar lo que le gusta y lo que no le gusta a los miembros de la familia. También puede afectar el diálogo inlaw_ <NPC>. Puede estar vacío si no corresponde (por ejemplo, / fall 13 // SeedShop 1 9 / ). - 10 mapa y posición predeterminados SeedShop 1 9 El nombre de la ubicación y tile position donde el NPC comienza y termina cada día. - 11 nombre para mostrar Abigail El nombre del NPC que se muestra al jugador.

Sabores de regalo

El activo Data \ NPCGiftTastes contiene sus preferencias de obsequio (p. Ej., Qué obsequios aman u odian) y sus respuestas cuando reciben uno. Consulte Modding: Gift taste data para obtener más información.

El archivo tiene una fila por NPC como esta:

   Abigail: "¡En serio me encanta esto! ¡Eres la mejor, @! / 66 128 220 226 276 611 / Oye, ¿cómo sabías que tenía hambre? ¡Esto se ve delicioso! // ¿Qué se supone que debo hacer con esto? / -5-75-79 16 245 246 / ¿Qué estabas pensando? ¡Esto es horrible! / 330 / ¿Me trajiste un regalo? Gracias.// "#! String

La línea se puede dividir en 5 pares de diálogos + ID de elementos en este orden: Amor, Me gusta, Neutral, No me gusta, Odio. Si un campo de diálogo está vacío, el juego utilizará un texto de diálogo genérico. Consulte Modding: datos del objeto para conocer los ID de los artículos.

Respuestas de regalos de cumpleaños

El activo Strings \ StringsFromCSFiles contiene las respuestas genéricas dadas por los NPC a los regalos de cumpleaños según sus preferencias y modales. Estas cadenas compartidas se pueden personalizar para un NPC específico editándolas condicionalmente, como solo en el cumpleaños (no compartido) del NPC. Los siguientes criterios se utilizan para seleccionar entre las cadenas:

- sabor de regalo modales oportunidad cuerda - amar como maleducado 50% NPC.cs.4274 - 50% NPC.cs.4276 - educado, neutral 50% NPC.
character kissing frame facing direction
Abigail and Emily 33 left
Alex 42 right
Elliott 35 left
Haley 28 right
Harvey 31 left
Leah 25 right
Maru 28 left
Penny 35 right
Sam 36 right
Sebastian 40 left
Shane 34 left
any other NPC 28 right

Portraits

The dialogue portraits are stored in Portraits/NpcName. Each frame is exactly 64x64 per portrait. The first six represent specific emotions (see Modding:Dialogue#Portrait commands), followed by any number of custom portraits. The first portrait is used when the dialogue doesn't specify one.

Here's an example portrait guide, courtesy of TheLimeyDragon#1993 on Discord.

Schedule

Their schedule file tells the game where the NPC starts and moves based on on the time. You need to add strings to a separate schedules file found in the Strings folder to allow custom dialogue. See Modding:Schedule data for more info.

Dialogue and events

The NPC dialogue and events are stored in several files; see Modding:Dialogue and Modding:Event data for more info.

Festivals

Festivals are tricky things. Everyone in the vanilla game is added to the festival map by placing tiles on the Set-Up and MainEvent map layers from a character tilesheet that draws from NPCDispositions to get exactly who to place. This is not ideal for custom NPCs, since you have no way of knowing where on the NPCDispositions data list your NPC goes when a player is using multiple custom NPCs. For this reason, it is recommended to use TMXLoader, as it has a festival addition function to add your character to the Festival Maps, since it will draw upon your character's internal name instead of their position on the list. It's fairly easy to do, and there's an explanation on the TMXLoader Nexus Description.

For adding them to festivals in 1.5 using Content Patcher, see Modding:Migrate to Stardew Valley 1.5#Festival changes.

Adding your NPC

Here's how you'd create an example NPC we'll name Dobson:

  1. Create an empty Content Patcher content pack. By convention, we'll name the folder [CP] Dobson.
  2. Create the following files:
    • assets/dialogue.json containing the dialogue.
    • assets/marriageDialogue.json containing the marriage dialogue (if applicable).
    • assets/sprites.png containing their overworld sprites.
    • assets/portraits.png containing their portraits.
    • assets/schedule.json containing their schedule data.
  3. Edit the content.json to load the files:
    {
        "Format": "2.0.0",
        "Changes": [
            {
                "Action": "Load",
                "Target": "Characters/Dobson",
                "FromFile": "assets/sprites.png",
            },
            {
                "Action": "Load",
                "Target": "Portraits/Dobson",
                "FromFile": "assets/portraits.png",
            },
            {
                "Action": "Load",
                "Target": "Characters/Dialogue/Dobson",
                "FromFile": "assets/dialogue.json",
            },
            {
                "Action": "Load",
                "Target": "Characters/Dialogue/MarriageDialogueDobson",
                "FromFile": "assets/marriageDialogue.json",
            },
            {
                "Action": "Load",
                "Target": "Characters/schedules/Dobson",
                "FromFile": "assets/schedule.json",
            },
            {
                "Action": "EditData",
                "Target": "Data/NPCDispositions",
                "Entries": {
                    "Dobson": "adult/rude/neutral/positive/male/datable//Town/summer 7//BusStop 19 4/Dobson"
                },
            },
            {
                "Action": "EditData",
                "Target": "Data/NPCGiftTastes",
                "Entries": {
                    "Dobson": "You're giving this to me? This is amazing!/207 232 233 400/Thank you! This is a very interesting specimen./-5 -79 422/...What is this?/80 330/This is disgusting./2/That was very thoughtful of you./-4/ ",
                },
            },
            {
                "Action": "EditData",
                "Target": "Data/EngagementDialogue",
                "Entries": {
                    "Dobson0": "I can't believe I am about to be married!$h",
                    "Dobson1": "I hope I don't get cold feet",
                },
            },
        ]
    }
    

That's it! If you load your game, the NPC should appear. If you want to create events, don't forget to add that file too.

Guidance on pixel art

If you'd like additional guidance on pixel art, See Modding:Index#See_also for some recommended guides.