Difference between revisions of "HowTo:Add Descriptions"

From VsWiki
Jump to: navigation, search
 
m
 
(15 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
{{NAV_Manual |
 
{{NAV_Manual |
−
| previous=[[HowTo:Edit Systems|Edit Systems]]
+
| previous=[[HowTo:Take Screenshots|Take Screenshots]]
−
| up=[[HowTo]]
+
| up=[[HowTos]]
 
| next=[[HowTo:Add Conversations|Add Conversations]]
 
| next=[[HowTo:Add Conversations|Add Conversations]]
 
}}
 
}}
 
----
 
----
−
{{attention}}
+
=Adding Item Descriptions=
  
 +
Anything a player can buy in Vega Strike can have a text description.  These are contained in the {{SVN:MasterPartList}} file.
  
−
Not a very detailed explanation ...but basically you go to the '''[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vegastrike/data4.x/units/upgrades units/upgrades]''' directory and add an 'upgrade' (cargo is in here to), follow the example of the ones in there.
+
==Master Parts List File==
 +
The {{SVN:MasterPartList}} is a csv (comma separated values) text file which can be edited with a good text processing program.
  
−
Then you go to the '''[http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/vegastrike/data4.x/units/upgrades/master_part_list units/upgrades/master_part_list]''' directory (parts might be plural...) and edit the master_part_list file, once again, follow the example of the other things.
 
  
 +
{{warning_text |
 +
| text=Please note that Microsoft Office tools and Windows tools in general (like Windows Notepad) alter the csv files invisibly by adding hidden characters. We also don't recommend Open Office Calc for csv editing, as this tool adds unwanted characters, like the apostrophe to some fields. '''This can render the files unusable and even corrupt your entire game.''' For editing csv files, we recommend a text based editor, e.g. the libre [http://notepad-plus-plus.org/ Notepad++], which keeps the required format across Windows and Linux.}}
  
−
{{Warning_text |
+
 
−
| text=I think this description is out of date and is now wrong.  Don't you edit the UNITS.CVS file???}}
+
===Steps to add a new item===
 +
* Open the [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/master_part_list.csv?revision=HEAD&view=markup master_part_list.csv] file in a spreadsheet application and, if you are adding a new item, add a new line containing the required number of columns, separated by commas - "," as explained here:
 +
** The '''file''' column contains the unit name as specified in units.csv
 +
** Fill in the upgrade, cargo, or starship '''category''', e.g. "upgrades/Sensors/Confed".
 +
** Fill the numbers for base '''price''', '''mass''', and '''volume'''.
 +
** Fill the '''discription''' field with your description. To have a picture show up next to your description, preface the description with a texture (square, powers of two sides (16,64,128,256,etc)) in the following format: <code>@'''path/to/'''texture.png@</code>, where the path to texture starts from the ''data/textures'' folder.
 +
* Save the file as a csv file.
 +
 
 +
 
 +
{{Fixme}} ''What role has the file data/units/units_description.csv?''
 +
 
 +
==Example row==
 +
<pre>
 +
"file","categoryname","price","mass","volume","description"
 +
 
 +
"IntaTouch","Entertainment/Aera",50,0.01,1,
 +
"@cargo/cargo-hud.png@A tactile simulator that provides an Aera with relaxing sensations."
 +
</pre>
 +
 
 +
=See also=
 +
* {{CVS:MasterPartList}} in CVS 
 +
* [[HowTo:Add Cargo|Adding Cargo]]
 +
* [[HowTo:Add Upgrades|Adding Upgrades]]
 +
* [[HowTo:Edit master_part_list.csv|Editing Master_Part_List.csv]]
 +
* [[HowTo:Edit units.csv|Editing Units.csv]]
  
 
----
 
----
 
{{NAV_Manual |
 
{{NAV_Manual |
−
| previous=[[HowTo:Edit Systems|Edit Systems]]
+
| previous=[[HowTo:Take Screenshots|Take Screenshots]]
−
| up=[[HowTo]]
+
| up=[[HowTos]]
 
| next=[[HowTo:Add Conversations|Add Conversations]]
 
| next=[[HowTo:Add Conversations|Add Conversations]]
 
}}
 
}}
  
−
[[Category:HowTo|Add Descriptions]]
+
[[Category:HowTos|Add Descriptions]]
 
[[Category:Development|Add Descriptions]]
 
[[Category:Development|Add Descriptions]]

Latest revision as of 17:08, 1 March 2011

arrow_left.png Take Screenshots arrow_up.png HowTos Add Conversations arrow_right.png

Adding Item Descriptions

Anything a player can buy in Vega Strike can have a text description. These are contained in the Master Part List file.

Master Parts List File

The Master Part List is a csv (comma separated values) text file which can be edited with a good text processing program.


Please note that Microsoft Office tools and Windows tools in general (like Windows Notepad) alter the csv files invisibly by adding hidden characters. We also don't recommend Open Office Calc for csv editing, as this tool adds unwanted characters, like the apostrophe to some fields. This can render the files unusable and even corrupt your entire game. For editing csv files, we recommend a text based editor, e.g. the libre Notepad++, which keeps the required format across Windows and Linux.


Steps to add a new item

  • Open the master_part_list.csv file in a spreadsheet application and, if you are adding a new item, add a new line containing the required number of columns, separated by commas - "," as explained here:
    • The file column contains the unit name as specified in units.csv
    • Fill in the upgrade, cargo, or starship category, e.g. "upgrades/Sensors/Confed".
    • Fill the numbers for base price, mass, and volume.
    • Fill the discription field with your description. To have a picture show up next to your description, preface the description with a texture (square, powers of two sides (16,64,128,256,etc)) in the following format: @path/to/texture.png@, where the path to texture starts from the data/textures folder.
  • Save the file as a csv file.


FIXME What role has the file data/units/units_description.csv?

Example row

"file","categoryname","price","mass","volume","description"

"IntaTouch","Entertainment/Aera",50,0.01,1,
"@cargo/cargo-hud.png@A tactile simulator that provides an Aera with relaxing sensations."

See also

arrow_left.png Take Screenshots arrow_up.png HowTos Add Conversations arrow_right.png
Retrieved from "http://wiki.vega-strike.org/mediawiki/index.php?title=HowTo:Add_Descriptions&oldid=18034"