Difference between revisions of "HowTo:Add Descriptions"

From VsWiki
Jump to: navigation, search
m (→‎Steps to add a new item: Grammar)
m
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
 
}}
 
}}
 
----
 
----
−
=ADDING DESCRIPTIONS=
+
=Adding Item Descriptions=
  
−
Anything a player can buy in Vega Strike can have a text description.  These are contained in the {{CVS:MasterPartList}} file.
+
Anything a player can buy in Vega Strike can have a text description.  These are contained in the {{SVN:MasterPartList}} file.
  
 
==Master Parts List File==
 
==Master Parts List File==
−
The {{CVS:MasterPartList}} is a csv (comma delimited text) file which can be edited with any spreadsheet program.
+
The {{SVN:MasterPartList}} is a csv (comma separated values) text file which can be edited with a good text processing program.
 +
 
 +
 
 +
{{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.}}
  
−
'''NOTE''': Microsoft Works has problems with the long description columns.  For a free alternative, use [http://www.openoffice.org OpenOffice].
 
  
 
===Steps to add a new item===
 
===Steps to add a new item===
−
* Open the {{CVS:MasterPartList}} file in a spreadsheet application and, if you are adding a new item, add a new line. {{Fixme}} ''What's the meaning of this sentence?''
+
* 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:
−
* Fill the ''discription'' field with your description.
+
** The '''file''' column contains the unit name as specified in units.csv
−
* 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>
+
** 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.
 
* Save the file as a csv file.
 +
 +
 +
{{Fixme}} ''What role has the file data/units/units_description.csv?''
  
 
==Example row==
 
==Example row==

Latest revision as of 16: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 "https://wiki.vega-strike.org/mediawiki/index.php?title=HowTo:Add_Descriptions&oldid=18034"