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 including 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=gray3}}.
# 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=gray3}}.
# 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=gray3}}.
# 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_file_(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=gray3}}, 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=gray3}}.

=== Change the image and colors ===
# [[Mod:Create_an_item#Open_the_file_(Entity_editor)|Open the item file]]
# Expand the {{False button|Image|color=gray|border=black}} tab.
# Click on the {{False button|...|color=gray|edge=black}} button to select an appearance to assign to your item ('''sprite''' or '''.spr''' file).{{Idea|It is not very useful to change the colors of an item, but 4 menus allow you to do so, with two dimmers, the first one controlling saturation and the second one controlling the color level}}

=== Assign a code name ===
A code name allows the item to be unique and recognized by [[Mod:Scripts|scripts]], in a quest for example.
# [[Mod:Create_an_item#Open_the_file_(Entity_editor)|Open the item file]]
# Expand the {{Fake button|Name|color=gray|bord=black}} tab and type in the code name of your choice to the right of {{Fake button|Tag Name :|color=gray3}}.
# Go to the {{Fake button|File|color=gray|black border}} menu and then {{Fake button|Save|color=gray3}}.

=== Change the characteristics ===
There are an infinite number of possible variations for the characteristics of an item you create...
# [[Mod:Create_an_item#Open_the_file_(Entity_editor)|Open the item file]]
# Expand the {{Fake button|Tabs|color=Gray|border=Black}} of your choice and change the features that you think are appropriate.
* The first word at the top, whether <font color = "yellow">- Yellow -</font> or {{False button|Red|color=gray|border=black}}, indicates the item type.
* The first section (under <font color = "yellow">- Section name -</font>) is about the main characteristics of the item, such as its code name, its image (sprite), its value, whether or not it produces a primary, secondary effect, etc.
* Under <font color = "yellow">- Requirements -</font>, the data entered is required to use the item.{{Warning|Only the {{False button|Stats|color=gray|bord=black}} tab is usable in this section.}}
* Under <font color = "yellow">- Effect -</font>, the data entered affects the character wearing the item (as a garment or in their hand).{{Warning|This data is useless for objects of type ''Consumable''}}
* Under <font color = "yellow">- Primary (Secondary, Final) Effect -</font>, the data entered affects the character who consumes (double-clicks on) the item, provided the fields associated with them at the top: {{False button|Effect [0,1 or 2] enabled:|color=gray3}} are checked (✓) with a set duration. If the duration is 0, the effect will be permanent.{{Warning|This data is only used for items of type ''Consumable''}}
* Under <font color = "yellow">- Addiction Effect -</font>, the data entered affects the character who consumes (double-clicks on) the item and becomes addicted to it, provided that the field associated with it at the top: {{False button|Addiction enabled:|color=gray3}} be checked (✓) with a fixed duration. If the duration is 0, the effect will be permanent. The chance of falling addicted depends on the {{False button|ChanceOfAddiction:|color=gray3}} field just below it.{{Avertissement|Ces données servent seulement aux items de type ''Consumable''}}
* Under <font color = "yellow">- Weapon Modes -</font>, the data entered adds one of the attack modes to a weapon.{{Warning|This data is only used for ''Weapon''-type items}}
# Go to the {{False button|File|color=gray|border=black}} menu then {{False button|Save|color=gray3}}.