Editing Mod:Create an item

This tutorial explains how to create or modify an item in ''[[Wikipedia 2197|The Sum]]''. {{Warning|'''The Sum''' already has a lot of generic items, so it is not recommended to add new ones. Some special (unique) items for lore purposes are however often necessary.}}
[[file:Entity Editor Item.jpg|thumb|This tutorial uses mainly the Entity Editor.]]
== Required tools ==
* [[Mod:Editors#Entity_editor.29|Entity Editor]]
* [[Mod:Editors#Notepad.2B.2B|Notepad++]]

== Before you start ==
Take some time to learn how the Entity editor works by checking out the [http://10projets.org/nousaurons/editor_readme.html#Section3 readme file of the Fallout Tactics editor].

== Create a new item ==
{{Idea|Items include several elements that are necessary for the game to function properly in general, it is recommended that you create an item from an existing item in the folder ''Game/core/entities/Weapons/'' or in the folder ''Game/core/entities/Items/'' }}

=== Existing item as basis ===
# Open the ''Game''/ folder and then '''FT Improver.EXE''' {{Warning|Use '''FT Tools.exe''' instead will result in an error}}
# Pass the videos by clicking on them.
# Click on {{False button|MORE|color=black|button=yes}}.
# Click {{False button|ENTITY EDITOR|color=black|button=yes}}.
# Navigate to the {{False Button|File|color=gray|border=black}} menu then {{False Button|Open|color=gray}}.
# Open a file of the same type as the one to be created, which must end with '''.ent''' (stored in ''Game/core/entities/Weapons/'' or ''Game/core/entities/Items/'').
# Go to the {{False Button|File|color=gray|border=black}} menu then {{False Button|Save As|color=gray}}.
# Save this item under another name in the same folder {{Warning|The item must be saved in a folder corresponding to its type}}.

== Modify an item ==
=== Open the file ('''Entity editor''') ===
# Open the ''Game''/ folder and then '''FT Improver.EXE''' {{Warning|Using '''FT Tools.exe''' instead will result in an error}}
# Pass the videos by clicking on them.
# Click on {{False button|MORE|color=black|button=yes}}.
# Click {{False button|ENTITY EDITOR|color=black|button=yes}}.
# Navigate to the {{False Button|File|color=gray|border=black}} menu then {{False Button|Open|color=gray}}.
# Open the file of your item previously created which must end with '''.ent'''.

=== Name and description ===
Every item has a name and a description, stored in ''Game/NousAurons/locale/Game/'''items.txt''''' (French version) and ''Game/core/locale/Game/'''items.txt''''' (English version).
# Open the two files '''items.txt''' and for each of them:
## Under ''OBJECTS (DESCRIPTION & NAMES)'', copy/paste the following code: <syntaxhighlight>
name_of_item_code_name = {Name of item}
desc_item_code_name = {<Cw>Description of the item in the appropriate language.\n\n<Jc><rgb:125,125,125>USE}
</syntaxhighlight>
* '''USE:''' This short message (appearing in gray), indicates the use (and sometimes the effect) of the object. Example: Eat DBL-CLICK\nHUNGER ÌÌÌ (where Ì corresponds to ↓ in the game).
# [[Mod:Create_an_item#Open_the_item_in_Entity_editor|Open the item file]]
# Expand the {{False Button|Name|color=gray|border=black}} tab.
# To the right of {{Fake Button|Display Name|color=gray}}, add the item's code name.{{Warning|This name should not include the word "name_", but rather look like this: "item_code_name".}}
# Go to the {{False button|File|color=gray|border=black}} menu then {{False button|Save|color=gray}}.

=== Changer l'image et les couleurs ===
# [[Mod:Créer_un_item#Ouvrir_le_fichier_de_l.27item_.28.C3.A9diteur_d.27entit.C3.A9s.29|Ouvrez le fichier de l'item]]
# Développez l'onglet {{Faux bouton|Image|couleur=gris|bordure=noir}}.
# Cliquez sur le bouton {{Faux bouton|...|couleur=gris|bordure=noir}} pour sélectionner une apparence à assigner à votre item (''sprite'' ou fichier '''.spr''').{{Idée|Il n'est pas très utile de changer les couleurs d'un item, mais 4 menus vous permettent de le faire, avec deux gradateurs, le premier contrôlant la saturation et le deuxième le niveau de couleur.}}

=== Assigner un nom de code ===
Un nom de code permet à l'item d'être unique et reconnu par des [[Mod:Scripts|scripts]], dans une quête par exemple.
# [[Mod:Créer_un_item#Ouvrir_le_fichier_de_l.27item_.28.C3.A9diteur_d.27entit.C3.A9s.29|Ouvrez le fichier de l'item]]
# Développez l'onglet {{Faux bouton|Name|couleur=gris|bordure=noir}} et tapez le nom de code de votre choix à la droite de {{Faux bouton|Tag Name|couleur=gris}}.
# Accédez au menu {{Faux bouton|File|couleur=gris|bordure=noir}} puis {{Faux bouton|Save|couleur=gris}}.

=== Changer les caractéristiques ===
Il existe une infinité de variations possibles pour les caractéristiques d'un item que vous créez...
# [[Mod:Créer_un_item#Ouvrir_le_fichier_de_l.27item_.28.C3.A9diteur_d.27entit.C3.A9s.29|Ouvrez le fichier de l'item]]
# Développez les {{Faux bouton|onglets|couleur=gris|bordure=noir}} de votre choix et modifiez les caractéristiques qui vous semblent appropriées.
* Le premier mot en haut, qu'il soit <font color = "yellow">- Jaune -</font> ou {{Faux bouton|Rouge|couleur=gris|bordure=noir}}, indique le type d'item.
* La première section (sous <font color = "yellow">- Nom de section -</font>) concerne les caractéristiques principales de l'item, comme son nom de code, son image (sprite), sa valeur, si oui ou non il produit un effet primaire, secondaire, etc.
* Sous <font color = "yellow">- Requirements -</font>, les données entrées sont requises pour utiliser l'item.{{Avertissement|Seul l'onglet {{Faux bouton|Stats|couleur=gris|bordure=noir}} est utilisable dans cette section.}}
* Sous <font color = "yellow">- Effect -</font>, les données entrées affectent le personnage qui porte l'item (comme un vêtement ou dans sa main).{{Avertissement|Ces données sont inutiles pour les objets de type ''Consumable''}}
* Sous <font color = "yellow">- Primary (Secondary, Final) Effect -</font>, les données entrées affectent le personnage qui consomme (double-clique sur) l'item, à condition que les champs leur étant associés en haut: {{Faux bouton|Effect[0,1 ou 2] Enabled|couleur=gris}} soient cochés avec une durée déterminée. Si la durée est de 0, l'effet sera permanent.{{Avertissement|Ces données servent seulement aux items de type ''Consumable''}}
* Sous <font color = "yellow">- Addiction Effect -</font>, les données entrées affectent le personnage qui consomme (double-clique sur) l'item et en tombe dépendant, à condition que le champ lui étant associé en haut: {{Faux bouton|Addiction Enabled|couleur=gris}} soit coché avec une durée déterminée. Si la durée est de 0, l'effet sera permanent. La chance de tomber dépendant dépend du champ {{Faux bouton|ChanceOfAddiction|couleur=gris}} juste en dessous.{{Avertissement|Ces données servent seulement aux items de type ''Consumable''}}
* Sous <font color = "yellow">- Weapon Modes -</font>, les données entrées ajoutent un.des mode.s d'attaque à une arme.{{Avertissement|Ces données servent uniquement aux items de type ''Weapon''}}
# Accédez au menu {{Faux bouton|File|couleur=gris|bordure=noir}} puis {{Faux bouton|Save|couleur=gris}}.