VsWiki - User contributions [en]

Development:Tools:UnitConverter

2020-05-07T03:45:47Z

Pyramid: /* Installation and Starting */

=Introduction=

Raising from the stone age of workflows, in which every task, from texture conversion to editing of unit stats, had to be accomplished manually and only by quite knowledgeable magistrates who knew the alchemy of units.csv columns, xmesh files, and had a magic with meshers. Now, UnitConverter shines upon us, still in the distance, but unmovable like a beacon on solid rock, to be the church of the artists, to accommodate the apostles of Blender, CineMut, and LaGrande, to bring the holy spirit of salvation to this compassionate universe of ours.

Some of the main Unit Converter features:
* bi-directionally converts meshes between obj and bfxm files
* assign textures to (sub)models
* convert model and shield meshes
* compress default and faction input textures to dds output textures
* saves the complete workspace in portable config files
* change model techniques and blend mode
* checks and corrects invalid obj files, recreates mtl files
* creates a model directory if none exists and copies all required files
* compresses hud image and creates a .sprite file
* units.csv entry editor and creator (with default unit stats for new units)
* displays model using VS
* reads mesh dimensions from obj file
* placement of thrusters, turrets, mounts, docks, and blink lights from marker obj file
* on-screen instructions for each workflow module
* production tested

==Important Note==
{{warning_text |
|text=Due to the way ''mesher'' handles command line options (separates different inputs by spaces), it will not allow to use folders or file names with spaces (as common on Windows).
Should you be getting runtime errors during the conversion, you should rename your folder to something like "UnitName" or "Unit_Name_working_folder", i.e. substitute spaces with underscores "_". Do the same for the input files, i.e. "Unit_Name.obj".}}

=Requirements=

In order to run UnitConverter on your system is to have Python 2.5 or 2.6 installed on your system. Python 3.x has different syntax and UnitConveter will not work as long as it hasn't been ported to Python 3. Tkinter library is required to run UnitConverter, however it comes installed with most python distributions. Some Linux distributions require a separate installation of Tkinter.

A requirement for the '''model obj files''' is that no mtl file is provided. UnitConverter will generate its own texture information based on the input given under the '''Model''' panel.
The best way for exporting files from blender is to use the following three options *only*: '''Edges''', '''UVs''', '''Objects'''. You may also enable Normals, and Groups. However the '''Materials''' export option should be explicitly disabled.

Especially when reworking existing units, it is recommended that the model '''obj''' file is named the same way as the unit in ''units.csv'', in particular what concerns the letter case, usually following the CamelCase convention.

You will further require master textures for the object, which must be on the '''png''' file format and [[Development:Graphics_Requirements#Image_dimensions|Power-Of-Two]].
Master textures for factions should have the faction name prefixed to the texture name, e.g. "confed_hull.png".

Optionally, an '''obj''' file with markers can be supplied and must contain the name "marker" in the file name.

Optionally, a shield '''obj''' file can be supplied, containing the name "shield" in the file name.

=Quick Start Guide=

==Configuration==
You must first configure the paths under Config including the application in the path:
* ''path\data'' (to edit unit stats and view model in Vega Strike)
* ''path\mesher.exe'' (to convert model to bfxm) - [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/win32/bin/ get mesher]
* ''path\nvcompress'' (to compress textures) - [[Links:Graphic_Applications#nVidia_Texture_Tools|see here for instructions on nvcompress]]
(There is no need to set the working dir, as this field is purely informational)

==Integrating Models==
Assuming you have exported:
* ship mesh to ''Ship.obj''
* shield to ''Ship-Shield.obj''
* helpers to ''Ship-Mounts.obj
''
... the steps to convert your model are:
* In UnitConverter, under "Model" add all three obj files to workspace.
* Then select the main Ship model in the drop down.
* Under "Textures" you add the ones you have provided.
* Press "Save and Convert"
* Press "Convert Textures"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

This will call vegastrike and the modelview.mission with your new unit enabled.

==Converting Hud Image==
Under "HUDImage":
* Open the "''Ship-hud.png''" image using the "..." button
* Press "Convert Image"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

==Using Uncompressed Images==
* Under "Config" check the "Bypass compression" option.
* Under "Textures" press "Save and Convert"
* Press "Copy Data"
* Under "View" press "View"

==Adding Thruster, Docks, Mounts==
* Under "Model" press "Add Model"
* Select the "''Ship-Mounts.obj''" file with your mount markers.
* Under "Unit" and "Unit2" review the stats
* Under "Unit" press "Save"
* Under "View" press "View"

==Editing Stats==
* Under "Unit", in "Unit name" write the units.csv key (e.g. ''Llama.begin'')
* Press "Load"
* Edit fields under "Unit" and "Unit2"
* Under "Unit" press "Save"

==Comparing Units==
* Under '''Unit''' tab, in '''Unit name''' write the units.csv key (e.g. ''Llama.begin'')
* Press '''Load'''
* Use '''<''' and '''>''' to browse backward and forward.
* After editing a parameter make sure to press '''Save'''

==Getting Help==
In case of problems, please report to the [https://forums.vega-strike.org/viewtopic.php?f=20&t=11885 Unit Converter thread].

=UnitConverter Tool=

==Installation and Starting==

You can download the latest version of UnitConverter from the Vega Strike svn repository:
* View repo [https://github.com/vegastrike/Tools/tree/master/modtools/UnitConverter Tools/modtools/UnitConverter for Python 2].
* View repo [https://github.com/vegastrike/Tools/tree/master/modtools/UnitConverter3 Tools/modtools/UnitConverter3 for Python 3].
* Download with
<code><pre>svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/modtools/UnitConverter</pre></code>

To install, copy all files to a directory of your choice.

To run UnitConverter, open command line/shell, change to the installation directory, and depending your operating system type (without the ">" which denotes the command line prompt:

Windows: <code><pre>> uc</pre></code>

Linux: <code><pre>> ./uc</pre></code>

Other: <code><pre>> python unitconverter.py</pre></code>

First thing you'll need to do is to configure the paths for Vega Strike data directory, mesher and nvcompress.

{{warning_text |
| text='''Important:''' To be fully able utilize UnitConverter functionality, please configure the paths under [[Development:Tools:UnitConverter#Configuration_2|'''Config''']].}}

==Models Workspace==
Models Workspace Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f1_workspace.jpg

The following operations are available:
* '''Clear Workspace''' - to start a new model integration
* '''Add Model''' - to add a new model to workspace. The following files are accepted:
** ''.obj'' file containing the model mesh
** ''?-Shield.obj'' file containing the shield mesh
** ''?-Marker.obj'' file containing the marker objects as described in the [[Development:Model_Guidelines#Object_Marker|objects marker modeling section]]
** ''.bfxm'' files to backward convert meshes to obj files
* '''Clear Model''' - to remove the selected model from the workspace
* '''Load Workspace''' - to load an ''.ini'' configuration file of the workspace
* '''Active Model''' - change active model on the dropdown to edit its textures

It is important that your first model in workspace should be the main model, as further information like directory name and units.csv entry name will be derived from the main model name.

Under '''Model/Files''' the ''.obj'' and ''.mtl'' files for the active model will be displayed.
Under '''Material Info''' you can find information on the ''.obj'' file's material library and material names.

To edit texture assignments, proceed to the '''Textures''' tab on the left.

==Textures==
Textures Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f2_textures.jpg

In this tab you can assign textures to model submeshes:
* Under '''Submodels''' select the submesh you'd like to assign textures to. By default the first submesh is selected when the model is activated.
* Add the available '''Textures 0-5''' by pressing the '''...''' buttons between the '''Input Texture''' and '''Output Texture''' columns and browse to the appropriate file. The output texture name will be set (naming convention: '''tex_'''''model'''''_'''''submodel'''''_'''''texture'''''.texture''')
* Select the appropriate '''Technique''', i.e. leave it empty for conventional shading approach or choose e.g. ''cinemut_opaque'' if your input textures are provided with CineMut shader family compatible packing.
* Select '''Blend mode'''.
** For main meshes leave it at ''ONE ZERO''
** For shield mesh and blink light submeshes choose ''ONE ONE''

Once you have assigned textures to all your submeshes, you can now start the conversion:
* Press '''Save and Convert''' to save the texture assignment information and convert your model to Vega Strike compatible ''bfxm'' format.
* You may '''Compress Textures''' using nvcompress if you have configured the command path previously
* Finally, '''Copy Data'' will copy textures and ''bfxm'' files to the unit directory

To add the HUD image, proceed to the '''HUDImage''' tab on the left.

===Advanced Usage - Converting faction textures===

Faction textures must follow the naming of the default textures with prefixed faction name.
When your default diffuse texture is ''dif.png'' and ''tex_000.texture'', the faction input and output textures for the Uln faction will be ''uln_dif.png'' and ''uln_tex_000.texture'' and so on for all the other textures and factions.

Unit converter can assist you with DDS conversion of the input textures provided the naming convention is followed. To convert a faction texture:
* Select the '''Faction''' from the drop down, then
* '''Compress Textures''', and when done
* '''Copy Data''' to put the faction textures into the unit data directory

==HUD Image==
HUD Image Screen

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f3_hud.jpg

Adding a HUD image to the data is fairly easy, simply:
* Browse for the image using the '''...''' button. The appropriate entry will also be created in the '''Unit''' editor.
* '''Compress Image''' to make it DDS, and
* '''Copy Data''' to the unit data directory. This button evokes the same command as the one on the '''Textures''' tab. This means, the ''image'', ''sprite'', ''bfxm'', and ''texture'' files will be copied together.

To edit the unit properties and parameters, proceed to the '''Unit''' tab on the left.

==Unit Editor==

The Unit Editor provides facilities for editing your most important parameters of the unit:
* '''Load''' - loads the unit parameters
* '''Save''' - saves the edited parameters
* '''Reset''' - reloads unit parameters for active model without previously saving changes

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f4_unit.jpg

The most critical parameters for successful integration of the unit are:
* '''Unit description''' - the text that will be displayed in-game about the unit
* '''Unit type''' and '''Unit role''' - used in-game and to correctly view vessels and installations as such
* Under '''Unit dimensions''' you will find the
** '''Dimensions''' as derived from the ''obj'' mesh file.
** To bring the model up to the expected scale, you'll need to set the '''Scale''' parameter. The final size of the model in-game will be the multiplication result of dimensions and the scale.

The remaining entries will be created from your marker object:
* '''Engine Thruster''' will be derived from markers named ''engine_*''. You may '''Update''' the '''Thruster type''' to a different than the default one (''supernova.bmp.bfxm'').
* '''Turrets & Subunits''' will be derived from markers named ''turret_*'' or ''subunit_*''. You may browse the '''Subunit nr.''' (number) by using the '''<''' and '''>''' buttons and change the turret type from the '''Subunit type''' dropdown and confirmation by '''Update'''.
* '''Docking Ports''' will be derived from markers named ''dock_*''

To continue editing unit parameters, proceed to the '''Unit 2''' tab on the left.

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f5_unit2.jpg

To add upgrades, under '''Upgrades''' select the '''Upgrade class''' and '''Upgrade type''' and then '''Add Upgrade'' to the unit.
To delete an upgrade, simply remove the entries between (and including) the {} brackets.

All other parameters on this tab and the following '''Unit 3''' tab can be manually edited

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f6_unit3.jpg

Don't forget to actually '''Save''' your changes before proceeding to '''View''' the unit in-game.

===Advanced Usage - Independent Unit Editor===
You can use built-in Unit editor of the '''Unit Converter''' to edit units without having to load the mesh files. To do so:
* On the '''Model''' tab do '''Clear Workspace'''
* On the '''Unit''' tab, manually write the unit key under '''Unit name'''
* '''Load''' the unit parameters

You can also browse the units.csv file by using the '''<''' and '''>''' buttons on the sides of the '''Unit name''' to row-wise move back and fore between the entries. Browse, '''Load'''/'''Save''' buttons are also available on '''Unit 2''' and '''Unit 3''' tabs.

==View==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f7_view.jpg

By pressing '''View''' Vega Strike can be loaded and you can test your unit in-game.

To test faction textures (if provided) you may previously select the '''Faction''' from the drop down, otherwise leave it at ''privateer'' to use default textures.

Testing of units will happen in two different ways:
* For vessels, using a special mission, the ''modelview.mission'' that spawns the unit as a ship.
** Use the '''F6''' key to view your own unit.
** Use the '''T''' key to target a second unit of the same type and then press the '''D''' key to stop it from SPECing away, then turn around to it to verify the docking ports. Repeat pressing '''D''' every 10 seconds to prevent it from flying away suddenly.
* Use the '''N''' key to target the nearest station, fly to it and start shooting while switching to '''F6''' view to test your shield mesh.
* For installations, the ''Modelview.system'' will be equipped with the edited station.
** Use the '''N''' key to target the station, then '''D''' to see the docking ports.

==Configuration==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f8_config.jpg

The '''Config''' tab defines presets to supports some of the functionality of the '''Unit Converter''':
* '''Vega Strike directory''' - is the directory where ''Version.txt'' and all data subdirectories reside (''ai'', ''animations'', ...)
** Use the '''Browse''' button to locate it
* '''Path to mesher''':
** Click the '''Browse''' button on the right to locate ''mesher''
** Find the ''mesher(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix.
* '''Path to nvcompress''':
** Click the '''Browse''' button on the right to locate ''nvcompress''
** Find the ''nvcompress(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** You will not require to install ''nvcompress'' if you just want to test your models. In this case please make sure you enable the '''Bypass compression''' option further below.
** Techno-talk: The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix. (If nvcompress is in your search path, you may only provide the command.)

===Advanced Configuration===

You may also change defaults that will be used anytime you reopen the Unit Converter:
* '''Current Technique''' - set the default technique you will be working with so that you don't need to remember adjusting it when editing textures.
* '''Use unit class directory''' - used to calculate target for copying model and texture files.
** when checked will store vessels in ''data/units/vessels/unitname'' directory and installations in ''data/units/installations/unitname'' directory. This is the default behavior for Vega Strike Upon The Coldest Sea game.
** If your mod is using a flat directory structure, you can uncheck the option and all your units will be stored in ''data/units/unitname'' directory.
* '''Bypass compression''' - when checked the input texture will be used as output texture. This is useful when editing and testing textures without the need to reconvert the model to bfxm.
* '''Backup obj/mtl files''' - when checked will copy original ''obj'' and ''mtl'' files to ''obj~'' and ''mtl~'' before writing new information.
* '''Create xmesh file''' - though the xmesh format is obsolete, when converting from ''obj'' to ''bfxm'', it might be useful to also create ''xmesh'' files to test the conversion process.
* Under '''Admin''' you can '''Standard Sort units.csv''' file. Though it is standard sorted by default, you might want to make sure it is after a manual editing of the file.

==About==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f9_about.jpg

What's that about?

=Code Reference=

==Python Modules==

Admittedly, the structure of the program could be more modular.

Unit Converter is written in Python using only ''Tkinter'' UI building functionality. On Windows Tkinter is distributed with Python, on Linux, it's available for download in all repositories. No further additional modules are required to run Unit Converter.

Source modules for Unit Converter:
* ''unitconverter.py'' - main module containing the complete program
* ''appwindow.py'' - frame creator for the different tabs
* ''objparse.py'' - ''.obj'' and ''.mtl'' file reader, parser, and writer
* ''vsunitcsv.py'' - ''units.csv'' file reader, parser, and writer
* ''vsmission.py'' - ''.mission'' file reader, parser, and writer
* ''vssystem.py'' - ''.system'' file reader, parser, and writer
* ''vector.py'' - mathematical vector functions
* ''png.py'' - ''.png'' file format reader

Other files:
* ''unitconverter.ini'' - Unit Converter configuration file. Not distributed. Will be created upon first start.
* ''unitconverter.ico'' - Windows icon file.
* ''uc'' - Linux shell script for starting Unit Converter
* ''uc.bat'' - Windows batch file (shell script) for starting Unit Converter
* ''uc_releasenotes.txt'' - Unit Converter release notes
* ''UnitWorkingDir/UnitName.ini'' - Unit workspace configuration file

==Program Flow==

The GUI building section starts with:
<code><pre> def __init__(self, master):</pre></code>

The code is visually separated into:
* variable initialization
* GUI building sections
* program execution, start-up, and shutdown

The GUI building section for each tab contains elements that have event triggers which call other functions within the first part of the ''unitconverter.py'' code.

Further, there a unique watch function that supervises the change of some of the contents of GUI element variables for elements that, in Tkinter, do not come with an event handler (option drop downs, text variables, option check boxes):
<code><pre> def processEvents(self):</pre></code>

==Data Elements==

There is a lot of data being handled within the Unit Converter. The main data elements shall be explained here:
* ''workspace[modelnr][submodelnr][parameternr]'' - array containing the complete workspace information, where
** modelnr is the index from ''models[modelnr]'' which stores the model names in workspace
** submodelnr comes from the list ''submodelsListBox''
** ''PARAMS'' - array holding the parameter names for ''workspace''
* ''textures[submodelnr][counter]'' - holds the textures for the active model only prepared for the mtl export in the array form ''["map_0","tex_000.texture"]''
* ''unit*'' - variables holding the unit editor values
* ''textureN'' - with N = 0-5, holds the output texture screen name
* ''texmasterN'' - holds the input texture name
* ''activemodel'' - name of the active (selected) model in workspace
* ''unitname'' - name of the key from units.csv
* ''vegastrike'' - Vega Strike installation directory root
* ''workdir'' - working directory

Most of the variables are commented within the code.

Development:Tools:UnitConverter

2020-05-07T02:44:07Z

Pyramid: /* Getting Help */

=Introduction=

Raising from the stone age of workflows, in which every task, from texture conversion to editing of unit stats, had to be accomplished manually and only by quite knowledgeable magistrates who knew the alchemy of units.csv columns, xmesh files, and had a magic with meshers. Now, UnitConverter shines upon us, still in the distance, but unmovable like a beacon on solid rock, to be the church of the artists, to accommodate the apostles of Blender, CineMut, and LaGrande, to bring the holy spirit of salvation to this compassionate universe of ours.

Some of the main Unit Converter features:
* bi-directionally converts meshes between obj and bfxm files
* assign textures to (sub)models
* convert model and shield meshes
* compress default and faction input textures to dds output textures
* saves the complete workspace in portable config files
* change model techniques and blend mode
* checks and corrects invalid obj files, recreates mtl files
* creates a model directory if none exists and copies all required files
* compresses hud image and creates a .sprite file
* units.csv entry editor and creator (with default unit stats for new units)
* displays model using VS
* reads mesh dimensions from obj file
* placement of thrusters, turrets, mounts, docks, and blink lights from marker obj file
* on-screen instructions for each workflow module
* production tested

==Important Note==
{{warning_text |
|text=Due to the way ''mesher'' handles command line options (separates different inputs by spaces), it will not allow to use folders or file names with spaces (as common on Windows).
Should you be getting runtime errors during the conversion, you should rename your folder to something like "UnitName" or "Unit_Name_working_folder", i.e. substitute spaces with underscores "_". Do the same for the input files, i.e. "Unit_Name.obj".}}

=Requirements=

In order to run UnitConverter on your system is to have Python 2.5 or 2.6 installed on your system. Python 3.x has different syntax and UnitConveter will not work as long as it hasn't been ported to Python 3. Tkinter library is required to run UnitConverter, however it comes installed with most python distributions. Some Linux distributions require a separate installation of Tkinter.

A requirement for the '''model obj files''' is that no mtl file is provided. UnitConverter will generate its own texture information based on the input given under the '''Model''' panel.
The best way for exporting files from blender is to use the following three options *only*: '''Edges''', '''UVs''', '''Objects'''. You may also enable Normals, and Groups. However the '''Materials''' export option should be explicitly disabled.

Especially when reworking existing units, it is recommended that the model '''obj''' file is named the same way as the unit in ''units.csv'', in particular what concerns the letter case, usually following the CamelCase convention.

You will further require master textures for the object, which must be on the '''png''' file format and [[Development:Graphics_Requirements#Image_dimensions|Power-Of-Two]].
Master textures for factions should have the faction name prefixed to the texture name, e.g. "confed_hull.png".

Optionally, an '''obj''' file with markers can be supplied and must contain the name "marker" in the file name.

Optionally, a shield '''obj''' file can be supplied, containing the name "shield" in the file name.

=Quick Start Guide=

==Configuration==
You must first configure the paths under Config including the application in the path:
* ''path\data'' (to edit unit stats and view model in Vega Strike)
* ''path\mesher.exe'' (to convert model to bfxm) - [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/win32/bin/ get mesher]
* ''path\nvcompress'' (to compress textures) - [[Links:Graphic_Applications#nVidia_Texture_Tools|see here for instructions on nvcompress]]
(There is no need to set the working dir, as this field is purely informational)

==Integrating Models==
Assuming you have exported:
* ship mesh to ''Ship.obj''
* shield to ''Ship-Shield.obj''
* helpers to ''Ship-Mounts.obj
''
... the steps to convert your model are:
* In UnitConverter, under "Model" add all three obj files to workspace.
* Then select the main Ship model in the drop down.
* Under "Textures" you add the ones you have provided.
* Press "Save and Convert"
* Press "Convert Textures"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

This will call vegastrike and the modelview.mission with your new unit enabled.

==Converting Hud Image==
Under "HUDImage":
* Open the "''Ship-hud.png''" image using the "..." button
* Press "Convert Image"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

==Using Uncompressed Images==
* Under "Config" check the "Bypass compression" option.
* Under "Textures" press "Save and Convert"
* Press "Copy Data"
* Under "View" press "View"

==Adding Thruster, Docks, Mounts==
* Under "Model" press "Add Model"
* Select the "''Ship-Mounts.obj''" file with your mount markers.
* Under "Unit" and "Unit2" review the stats
* Under "Unit" press "Save"
* Under "View" press "View"

==Editing Stats==
* Under "Unit", in "Unit name" write the units.csv key (e.g. ''Llama.begin'')
* Press "Load"
* Edit fields under "Unit" and "Unit2"
* Under "Unit" press "Save"

==Comparing Units==
* Under '''Unit''' tab, in '''Unit name''' write the units.csv key (e.g. ''Llama.begin'')
* Press '''Load'''
* Use '''<''' and '''>''' to browse backward and forward.
* After editing a parameter make sure to press '''Save'''

==Getting Help==
In case of problems, please report to the [https://forums.vega-strike.org/viewtopic.php?f=20&t=11885 Unit Converter thread].

=UnitConverter Tool=

==Installation and Starting==

You can download the latest version of UnitConverter from the Vega Strike svn repository:
* View repo [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/modtools/UnitConverter/ trunk/modtools/UnitConverter].
* Download with
<code><pre>svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/modtools/UnitConverter</pre></code>

To install, copy all files to a directory of your choice.

To run UnitConverter, open command line/shell, change to the installation directory, and depending your operating system type (without the ">" which denotes the command line prompt:

Windows: <code><pre>> uc</pre></code>

Linux: <code><pre>> ./uc</pre></code>

Other: <code><pre>> python unitconverter.py</pre></code>

First thing you'll need to do is to configure the paths for Vega Strike data directory, mesher and nvcompress.

{{warning_text |
| text='''Important:''' To be fully able utilize UnitConverter functionality, please configure the paths under [[Development:Tools:UnitConverter#Configuration_2|'''Config''']].}}

==Models Workspace==
Models Workspace Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f1_workspace.jpg

The following operations are available:
* '''Clear Workspace''' - to start a new model integration
* '''Add Model''' - to add a new model to workspace. The following files are accepted:
** ''.obj'' file containing the model mesh
** ''?-Shield.obj'' file containing the shield mesh
** ''?-Marker.obj'' file containing the marker objects as described in the [[Development:Model_Guidelines#Object_Marker|objects marker modeling section]]
** ''.bfxm'' files to backward convert meshes to obj files
* '''Clear Model''' - to remove the selected model from the workspace
* '''Load Workspace''' - to load an ''.ini'' configuration file of the workspace
* '''Active Model''' - change active model on the dropdown to edit its textures

It is important that your first model in workspace should be the main model, as further information like directory name and units.csv entry name will be derived from the main model name.

Under '''Model/Files''' the ''.obj'' and ''.mtl'' files for the active model will be displayed.
Under '''Material Info''' you can find information on the ''.obj'' file's material library and material names.

To edit texture assignments, proceed to the '''Textures''' tab on the left.

==Textures==
Textures Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f2_textures.jpg

In this tab you can assign textures to model submeshes:
* Under '''Submodels''' select the submesh you'd like to assign textures to. By default the first submesh is selected when the model is activated.
* Add the available '''Textures 0-5''' by pressing the '''...''' buttons between the '''Input Texture''' and '''Output Texture''' columns and browse to the appropriate file. The output texture name will be set (naming convention: '''tex_'''''model'''''_'''''submodel'''''_'''''texture'''''.texture''')
* Select the appropriate '''Technique''', i.e. leave it empty for conventional shading approach or choose e.g. ''cinemut_opaque'' if your input textures are provided with CineMut shader family compatible packing.
* Select '''Blend mode'''.
** For main meshes leave it at ''ONE ZERO''
** For shield mesh and blink light submeshes choose ''ONE ONE''

Once you have assigned textures to all your submeshes, you can now start the conversion:
* Press '''Save and Convert''' to save the texture assignment information and convert your model to Vega Strike compatible ''bfxm'' format.
* You may '''Compress Textures''' using nvcompress if you have configured the command path previously
* Finally, '''Copy Data'' will copy textures and ''bfxm'' files to the unit directory

To add the HUD image, proceed to the '''HUDImage''' tab on the left.

===Advanced Usage - Converting faction textures===

Faction textures must follow the naming of the default textures with prefixed faction name.
When your default diffuse texture is ''dif.png'' and ''tex_000.texture'', the faction input and output textures for the Uln faction will be ''uln_dif.png'' and ''uln_tex_000.texture'' and so on for all the other textures and factions.

Unit converter can assist you with DDS conversion of the input textures provided the naming convention is followed. To convert a faction texture:
* Select the '''Faction''' from the drop down, then
* '''Compress Textures''', and when done
* '''Copy Data''' to put the faction textures into the unit data directory

==HUD Image==
HUD Image Screen

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f3_hud.jpg

Adding a HUD image to the data is fairly easy, simply:
* Browse for the image using the '''...''' button. The appropriate entry will also be created in the '''Unit''' editor.
* '''Compress Image''' to make it DDS, and
* '''Copy Data''' to the unit data directory. This button evokes the same command as the one on the '''Textures''' tab. This means, the ''image'', ''sprite'', ''bfxm'', and ''texture'' files will be copied together.

To edit the unit properties and parameters, proceed to the '''Unit''' tab on the left.

==Unit Editor==

The Unit Editor provides facilities for editing your most important parameters of the unit:
* '''Load''' - loads the unit parameters
* '''Save''' - saves the edited parameters
* '''Reset''' - reloads unit parameters for active model without previously saving changes

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f4_unit.jpg

The most critical parameters for successful integration of the unit are:
* '''Unit description''' - the text that will be displayed in-game about the unit
* '''Unit type''' and '''Unit role''' - used in-game and to correctly view vessels and installations as such
* Under '''Unit dimensions''' you will find the
** '''Dimensions''' as derived from the ''obj'' mesh file.
** To bring the model up to the expected scale, you'll need to set the '''Scale''' parameter. The final size of the model in-game will be the multiplication result of dimensions and the scale.

The remaining entries will be created from your marker object:
* '''Engine Thruster''' will be derived from markers named ''engine_*''. You may '''Update''' the '''Thruster type''' to a different than the default one (''supernova.bmp.bfxm'').
* '''Turrets & Subunits''' will be derived from markers named ''turret_*'' or ''subunit_*''. You may browse the '''Subunit nr.''' (number) by using the '''<''' and '''>''' buttons and change the turret type from the '''Subunit type''' dropdown and confirmation by '''Update'''.
* '''Docking Ports''' will be derived from markers named ''dock_*''

To continue editing unit parameters, proceed to the '''Unit 2''' tab on the left.

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f5_unit2.jpg

To add upgrades, under '''Upgrades''' select the '''Upgrade class''' and '''Upgrade type''' and then '''Add Upgrade'' to the unit.
To delete an upgrade, simply remove the entries between (and including) the {} brackets.

All other parameters on this tab and the following '''Unit 3''' tab can be manually edited

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f6_unit3.jpg

Don't forget to actually '''Save''' your changes before proceeding to '''View''' the unit in-game.

===Advanced Usage - Independent Unit Editor===
You can use built-in Unit editor of the '''Unit Converter''' to edit units without having to load the mesh files. To do so:
* On the '''Model''' tab do '''Clear Workspace'''
* On the '''Unit''' tab, manually write the unit key under '''Unit name'''
* '''Load''' the unit parameters

You can also browse the units.csv file by using the '''<''' and '''>''' buttons on the sides of the '''Unit name''' to row-wise move back and fore between the entries. Browse, '''Load'''/'''Save''' buttons are also available on '''Unit 2''' and '''Unit 3''' tabs.

==View==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f7_view.jpg

By pressing '''View''' Vega Strike can be loaded and you can test your unit in-game.

To test faction textures (if provided) you may previously select the '''Faction''' from the drop down, otherwise leave it at ''privateer'' to use default textures.

Testing of units will happen in two different ways:
* For vessels, using a special mission, the ''modelview.mission'' that spawns the unit as a ship.
** Use the '''F6''' key to view your own unit.
** Use the '''T''' key to target a second unit of the same type and then press the '''D''' key to stop it from SPECing away, then turn around to it to verify the docking ports. Repeat pressing '''D''' every 10 seconds to prevent it from flying away suddenly.
* Use the '''N''' key to target the nearest station, fly to it and start shooting while switching to '''F6''' view to test your shield mesh.
* For installations, the ''Modelview.system'' will be equipped with the edited station.
** Use the '''N''' key to target the station, then '''D''' to see the docking ports.

==Configuration==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f8_config.jpg

The '''Config''' tab defines presets to supports some of the functionality of the '''Unit Converter''':
* '''Vega Strike directory''' - is the directory where ''Version.txt'' and all data subdirectories reside (''ai'', ''animations'', ...)
** Use the '''Browse''' button to locate it
* '''Path to mesher''':
** Click the '''Browse''' button on the right to locate ''mesher''
** Find the ''mesher(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix.
* '''Path to nvcompress''':
** Click the '''Browse''' button on the right to locate ''nvcompress''
** Find the ''nvcompress(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** You will not require to install ''nvcompress'' if you just want to test your models. In this case please make sure you enable the '''Bypass compression''' option further below.
** Techno-talk: The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix. (If nvcompress is in your search path, you may only provide the command.)

===Advanced Configuration===

You may also change defaults that will be used anytime you reopen the Unit Converter:
* '''Current Technique''' - set the default technique you will be working with so that you don't need to remember adjusting it when editing textures.
* '''Use unit class directory''' - used to calculate target for copying model and texture files.
** when checked will store vessels in ''data/units/vessels/unitname'' directory and installations in ''data/units/installations/unitname'' directory. This is the default behavior for Vega Strike Upon The Coldest Sea game.
** If your mod is using a flat directory structure, you can uncheck the option and all your units will be stored in ''data/units/unitname'' directory.
* '''Bypass compression''' - when checked the input texture will be used as output texture. This is useful when editing and testing textures without the need to reconvert the model to bfxm.
* '''Backup obj/mtl files''' - when checked will copy original ''obj'' and ''mtl'' files to ''obj~'' and ''mtl~'' before writing new information.
* '''Create xmesh file''' - though the xmesh format is obsolete, when converting from ''obj'' to ''bfxm'', it might be useful to also create ''xmesh'' files to test the conversion process.
* Under '''Admin''' you can '''Standard Sort units.csv''' file. Though it is standard sorted by default, you might want to make sure it is after a manual editing of the file.

==About==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f9_about.jpg

What's that about?

=Code Reference=

==Python Modules==

Admittedly, the structure of the program could be more modular.

Unit Converter is written in Python using only ''Tkinter'' UI building functionality. On Windows Tkinter is distributed with Python, on Linux, it's available for download in all repositories. No further additional modules are required to run Unit Converter.

Source modules for Unit Converter:
* ''unitconverter.py'' - main module containing the complete program
* ''appwindow.py'' - frame creator for the different tabs
* ''objparse.py'' - ''.obj'' and ''.mtl'' file reader, parser, and writer
* ''vsunitcsv.py'' - ''units.csv'' file reader, parser, and writer
* ''vsmission.py'' - ''.mission'' file reader, parser, and writer
* ''vssystem.py'' - ''.system'' file reader, parser, and writer
* ''vector.py'' - mathematical vector functions
* ''png.py'' - ''.png'' file format reader

Other files:
* ''unitconverter.ini'' - Unit Converter configuration file. Not distributed. Will be created upon first start.
* ''unitconverter.ico'' - Windows icon file.
* ''uc'' - Linux shell script for starting Unit Converter
* ''uc.bat'' - Windows batch file (shell script) for starting Unit Converter
* ''uc_releasenotes.txt'' - Unit Converter release notes
* ''UnitWorkingDir/UnitName.ini'' - Unit workspace configuration file

==Program Flow==

The GUI building section starts with:
<code><pre> def __init__(self, master):</pre></code>

The code is visually separated into:
* variable initialization
* GUI building sections
* program execution, start-up, and shutdown

The GUI building section for each tab contains elements that have event triggers which call other functions within the first part of the ''unitconverter.py'' code.

Further, there a unique watch function that supervises the change of some of the contents of GUI element variables for elements that, in Tkinter, do not come with an event handler (option drop downs, text variables, option check boxes):
<code><pre> def processEvents(self):</pre></code>

==Data Elements==

There is a lot of data being handled within the Unit Converter. The main data elements shall be explained here:
* ''workspace[modelnr][submodelnr][parameternr]'' - array containing the complete workspace information, where
** modelnr is the index from ''models[modelnr]'' which stores the model names in workspace
** submodelnr comes from the list ''submodelsListBox''
** ''PARAMS'' - array holding the parameter names for ''workspace''
* ''textures[submodelnr][counter]'' - holds the textures for the active model only prepared for the mtl export in the array form ''["map_0","tex_000.texture"]''
* ''unit*'' - variables holding the unit editor values
* ''textureN'' - with N = 0-5, holds the output texture screen name
* ''texmasterN'' - holds the input texture name
* ''activemodel'' - name of the active (selected) model in workspace
* ''unitname'' - name of the key from units.csv
* ''vegastrike'' - Vega Strike installation directory root
* ''workdir'' - working directory

Most of the variables are commented within the code.

Vegastrike

2020-05-01T14:14:01Z

Pyramid: updated svn link

{{Languages|En|Vegastrike}}
{{Wiki_Nav_Index}}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956; border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|
<center>'''Welcome to the Vega Strike Wiki'''</center>

Welcome to the '''Vega Strike''' [[wikipedia:Wiki|Wiki]], a user-edited manual and development guide for users and developers of the [http://www.opensource.org/ open source] '''Vega Strike''' game. Feel free to edit or add any pages you feel are necessary, but please read the [[VsWiki:Manual of Style|Manual of Style]] first, and please only add data to the [[Database]] that originates from an authoritative source.
|- valign="top"
|style="background:#ffdead;" width="50%"|<center>'''[[Manual|Player's Planet]]'''</center>
|style="background:#afa8ee;" width="50%"|<center>'''[[Development|Contributor's Station]]'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Everything you wanted to know about Vega Strike''' (playing/story/etc)</center>
{|class="mainpagetable" style="color:#493956;"
|http://vegastrike.sourceforge.net/gallery/main.php?g2_view=core.DownloadItem&g2_itemId=5842&g2_serialNumber=2&ext=.png
|
* [[Manual]] - The complete game manual.
* [[Manual:New users|Information for new users]]
* [[Story Elements]]
* [[FAQ]]s - Frequently asked questions
* [[OOG Tools|Out of Game Tools]] - map viewers, route finders, etc.
* [[Database]] - Info on the Vega Strike Universe
* [[MODs|Full list of Mods]] for the Vega Strike Engine
|}
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Feel free to help with the development of Vega Strike. The links below are a good starting point to do so.'''
</center>
'''''Want to contribute but don't know where to start'''''
* [[HowTo:Contribute|The Vega Strike Contributor's Guide]]
* [[Development]] & [[HowTos]] - Miscellaneous information for contributors
'''''For Artists and Modders'''''
* [[Development#Artistic_Contribution|Artists Guidelines]] - 3d models, space scapes, planet and station backgrounds, ...
* [[Development#Data_Modding|Modding Guidelines]] - config variables, missions, quests, modding tools, ...
* [[Artstyle_guides|Art Style Guides]] - VS universe style information for artists
'''''Engine References'''''
* [[DOCs]] - Engine documentation
'''''For Coders'''''
* [[Development#Code-related_Development|Coding Guidelines]] - dependencies, svn layout, code style, network protocol, ...
'''''Administrative'''''
* [[Vegastrike:Project|Project]] - Project information page
* [[Development:Roadmap|Roadmap]] - Vega Strike development plan
* [[Development#Status.2Ftask_list_pages|Status & Task List pages]]
* [[FAQ:Feature_Requests|Feature Requests]] - Ask, and you will have asked.
'''''Other'''''
* [[FAQ]]s - Frequently asked questions
* [[HowTos#Sourcecode HowTos|Sourcecode HowTos]] - Getting and installing the latest unstable version.
* [http://svn.code.sf.net/p/vegastrike/code/ Browse the SVN repository]

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|<center>'''The Vega Strike Community'''
If you want to help out with the wiki, or get help that this wiki cannot provide, check out the links below.
</center>
|-
|style="background:#7dcf7d;" width="50%"|<center>'''Wiki Trading Post'''</center>
|style="background:#ae6e9f;" width="50%"|<center>'''Help Shipyard'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|
* [[VsWiki:Manual of Style|Manual of Style]] - Please read it before editing, and please make any testing of the wiki system in the [[SandBox|Sandbox]].
*[http://forums.vega-strike.org/viewtopic.php?f=21&t=13186 Village Pump] - Make any discussions you wish about better organizing the wiki, or adding major new additions to the wiki.
* [[VsWiki:Requested Articles|Article Requests]] - Needed/wanted pages
* [[Wikipedia:How to edit a page|How to edit a wiki page]]
* [[:Category:Pages_needing_attention|Pages that need attention]]
* [[Special:Listusers|User list]] | [[Special:Popularpages|Most popular pages]]

* More special pages are here [[Special:Specialpages]]
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>Do you need help? Then try the forums, the main source for development or help! Or you can leave the site by any one of a number of other links...
</center>
* [http://forums.vega-strike.org Vega Strike Forums]

* [[Links]]
* irc.freenode.net #vegastrike (Main chanel)
** irc://irc.freenode.net/#vegastrike
** irc://irc.freenode.net/vegastrike (link for mIRC user)
* irc.stealth.net #vegastrike (Backup chanel)
** irc://irc.stealth.net/#vegastrike
** irc://irc.stealth.net/vegastrike (link for mIRC user)

Recommended open-source multi-protocol clients (IRC, ICQ/AIM, Jabber, Y!M, ...):
* Linux: [http://kopete.kde.org/ Kopete]
* Windows: [http://ayttm.sourceforge.net/ Ayttm]
* Mac: [http://fire.sourceforge.net/ Fire]

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|valign="top" |<center>'''Creating a wiki account'''
If you want to create an account in the wiki, you need to '''go to the [http://forums.vegastrike.org forum] and create an account there'''. This is because the logins are linked and creation is only possible there.
</center>
|}

----
Please see [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface]
and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for usage and configuration help.

Vegastrike:Credits

2011-05-03T22:17:45Z

Pyramid: /* Supporting Programmers */

{{Languages|En|Vegastrike:Credits}}
{{NAV_Manual |
| previous=[[Vegastrike:Features|Features]]
| up=[[Manual]]
| next=[[Manual:Install|Installing the game]]
}}
{{Fixme}}
----
'''This page is severely outdated. If your name's not here, trust us - it's not out of spite, this page is just going to take a lot of editing to be worthwhile.'''
 
A thought - there should also probably (at some point) be an "Content Credits" page which associates particular pieces of 2D, 3D and Musical art with their creator (I suggest indexing by artist).

----
=Project Leads=
<table width="100%" border="0" cellspacing="2">
<tr>
<td width="20%">Name</td>

<td width="76%">Roles</td>
</tr>

<tr >
<td valign="top">Daniel Horn</td>
<td>VS Creator. Original Mover. Head honcho. Big cheese (though he's not big on cheese). Many years and mountains of code later, he's still here and we wouldn't be without him. Fortunately for all of us, we don't let him make all the models in Emacs anymore ;-). </td>
</tr>
<tr> </tr>
<tr>
<td valign="top">Patrick Horn</td>

<td>Lead Python developer, lead networking developer.</td>
</tr>
<tr> </tr>
<tr>
<td valign="top">Jack Sampson</td>

<td>Vega Strike Minister of Information. Arbiter of canon. Herder of cats (Executive Art Director). VS fiction lead. Auxiliary code mangler. </td>
</tr>

</table>
==Emeritus==
<table width="100%" border="0" cellspacing="2">
<tr><td width="20%"></td><td width="76%"></td></tr>
<tr >
<td valign="top">Alan Shieh</td>
<td>One of the "back in the day" VS fogies, Alan has gone on to discover he actually liked being outside when not working towards his Ph.D. Last seen kayaking, biking, and publishing papers (or something like that).</td>
</tr>
</table>

=Lead Programmers=
<table width="100%" border="0" cellspacing="2" >
<tr>
<td width="20%">Name</td>
<td width="76%">Contributions</td>

</tr>
<tr >
<td valign="top">Claudio Freire</td>
<td>From work on graphics and sound to the twines of code at the beating heart of the VS engine. Currently working on moving the graphical backend to OGRE.
</td>
</tr>
</table>
=Supporting Programmers=
<table width="100%" border="0" cellspacing="2" >
<tr>
<td width="20%">Name</td>
<td width="76%">Contributions</td>
</tr>
<tr >
<td valign="top">Kephra "kraehe"</td>
<td>Code patches.</td>
</tr>
<tr >
<td valign="top">strook</td>
<td>Ogre port and seamless planetary flight.</td>
</tr>
</table>

==Python Scripting==
<table width="100%" border="0" cellspacing="2" >
<tr><td width="20%"></td><td width="76%"></td></tr>
<tr >
<td valign="top">Daniel Aleksandrow "dandandaman"</td>
<td>Many of the python modules.</td>
</tr>
</table>

==Development Utilities==
<table width="100%" border="0" cellspacing="2" >
<tr><td width="20%"></td><td width="76%"></td></tr>
<tr>
<td valign="top">"pontiac"</td>
<td>Wings 3D art import/export program.</td>
</tr>

</table>

==Coders of Yesteryear==
<table width="100%" border="0" cellspacing="2" >
<tr><td width="20%"></td><td width="76%"></td></tr>
<tr >
<td valign="top">Stephane Vaxelaire</td>
<td>Divided up game into physics and graphics modules, worked on multiplayer infrastructure.
</td>
</tr>

<tr>
<td valign="top">Alexander Rawass</td>
<td>Joystick and config files. Wrote a scripting language for missions affectionately known as Cb ("C flat"). Worked on improving missions and scripting.
</td>
</tr>
<tr >
<td valign="top">Sabarok Aresh</td>
<td>Made Vegastrike Setup and Mission Launcher. Wrote mission selector
for glut, Worked on Cargo/Docking GUI.</td>
</tr>
</table>

=Artists=
==2D==
<table width="100%" border="0" cellspacing="2" >
<tr><td width="30%"></td><td width="66%"></td></tr>
<tr>
<td valign="top">Strangelet, Fendorin, Dunkelheit</td>
<td>Bases and planet backgrounds</td>
</tr>
<tr>
<td valign="top">Bálint Szilárd</td>
<td>Various ship designs</td>
</tr>
<tr>
<td valign="top">Dandandaman, Esgaroth, Hellcatv, jackS, Klauss, Pyramid, Strangelet</td>
<td>Planet textures</td>
</tr>
<tr >
<td valign="top">Pyramid</td>
<td>Various cargo images</td>
</tr>
<tr>
<td valign="top">Oblivion</td>
<td>Splash screens</td>
</tr>
</table>

==3D==
<table width="100%" border="0" cellspacing="2" >
<tr><td width="20%"></td><td width="76%"></td></tr>
<tr >
<td valign="top">Strangelet</td>
<td>Many notable models</td>
</tr>
<tr >
<td valign="top">Etheral Walker</td>
<td>Some key models, assorted WIPs</td>
</tr>
<tr >
<td valign="top">Tiny Paintings</td>
<td>Various WIPs</td>
</tr>
<tr >
<td valign="top">Chuck & Coffeebot</td>
<td>Their elevators might even go all the way to the top ;-)</td>
</tr>
<tr >
<td valign="top">Pontiac</td>
<td>Assorted Models, many WIPs</td>
</tr>

</table>
==Graphical Design==
<table width="100%" border="0" cellspacing="2" >
<tr><td width="20%"></td><td width="76%"></td></tr>
<tr>
<td valign="top">Aazelone 'Zaydana' Pyoleri</td>

<td>Logo design and future website prototyping.</td>
</tr>
</table>
==Music==
<table width="100%" border="0" cellspacing="2" >
<tr><td width="20%"></td><td width="76%"></td></tr>
<tr >
<td valign="top">Ken Seguro</td>
<td></td>
</tr>
<tr >
<td valign="top">"PeteyG"</td>
<td></td>
</tr>
</table>

==Sound==

==Speech==
<table width="100%" border="0" cellspacing="2" >
<tr><td width="20%"></td><td width="76%"></td></tr>
<tr>
<td valign="top">Turbo</td>
<td>Oswald tutorial speech, Aera alien and translator speech</td>
</tr>
<tr>
<td valign="top">CLoneWolf</td>
<td>Andolian speech voice acting</td>
</tr>
</table>

==Emeritus==
<table width="100%" border="0" cellspacing="2" >
<tr><td width="20%"></td><td width="76%"></td></tr>
<tr>
<td valign="top">H.E. Day</td>

<td>3D Modeler and texturing professional. Ushered in new quality levels for 0.4.x 3D art. Explosions, cockpits, Rlaan, Aera, and Confederation craft that are likely to remain with us for some time. Left to work on his own project.</td>
</tr>
<tr>
<td valign="top">Cub of Judah's Lion</td>

<td>Some darn good art - and he still stops by on occasion.</td>
</tr>

</table>
==Artists of Yesteryear==
<table width="100%" border="0" cellspacing="2" >
<tr><td width="20%"></td><td width="76%"></td></tr>

<tr >
<td valign="top">PeteyG</td>
<td>Wrote much base music, did many models and textures (including our beloved Llama).</td>
</tr>
<tr >
<td valign="top">Electrotech</td>

<td>3D modeling (derivative convolution determinant, ... ) in data 0.4.0 - 0.4.3.</td>
</tr>
<tr >
<td valign="top">Duality</td>
<td>Terran light map redo and assorted artwork.</td>
</tr>

<tr >
<td valign="top">Jeff Graw</td>

<td>Did lots of backgrounds and assorted artwork improvement to 0.3.x. Did comm voices.</td>
</tr>
<tr >
<td valign="top">Jason Winzenried</td>
<td>3D modeling, cockpit and various starships.</td>
</tr>
<tr>
<td valign="top">Marcel Paré</td>

<td>Modeling, 0.3.x ship database. </td>
</tr>
<tr >
<td valign="top">Fire Hawk</td>
<td>3D Modeling</td>
</tr>
<tr>
<td valign="top">Vortis</td>

<td></td>
</tr>
<tr >
<td valign="top">Martin Baldwin</td>
<td>Worked on game map for 0.3.x </td>
</tr>
<tr>
<td valign="top">Kinnear Penman</td>

<td>Fixed OpenAL sound to work in XP, and made PiMp Installer Script! Art...fiction</td>
</tr>
<tr>
<td valign="top">RearAdmiralTolwyn</td>

<td>3D modeling (Longhaul, Katar, Khanjarli) 0.3.x </td>
</tr>
<tr >
<td valign="top">Henrik Eklund</td>
<td>Celeste story, (0.3.x intro)</td>
</tr>
<tr>
<td valign="top">f109 Vampire</td>

<td>3D modeling, 0.3.x (f109 Vampire, others)</td>
</tr>
<tr >
<td valign="top">James Carthew</td>
<td>3D modeling 0.2.x? - 0.3.x. Made Missile models and Sol system and Drone model and jump portal. Fixed SDL version in 0.2.9. </td>
</tr>
<tr>
<td valign="top">Spiner</td>

<td>Modeling, 0.3.x (Solar Glares and Asteroid base)</td>
</tr>
<tr >
<td valign="top">Julien Chateau</td>
<td>Modeling</td>
</tr>

<tr >
<td valign="top">Tobias Wollgarn, Major A Payne & Somall</td>
<td>Made Vegastrike sounds (from scratch)</td>
</tr>
</table>

=Testing / Support=
<table width="100%" border="0" cellspacing="0">
<tr>
<td width="20%">Name</td>
<td width="76%">Contribution</td>

</tr>
<tr >
<td valign="top">Eagle-1</td>
<td>Testing (Multiplayer) </td>
</tr>
</table>

Web Development
<table width="100%" border="0" cellspacing="0">
<tr>

<td width="20%">Name</td>
<td width="76%">Contribution</td>
</tr>
<tr>
<td>Matthew Kruer</td>
<td>Created the Website, installed and configured various aspects of the site (Gallery, Fourms, etc...) Curently working on [http://wasteland.solsector.net Wing Commander: The Wasteland Incident] MOD for the VegaStrike Engine</td>

</tr>
</table>
----
{{NAV_Manual |
| previous=[[Vegastrike:Features|Features]]
| up=[[Manual]]
| next=[[Manual:Install|Installing the game]]
}}

Development:Roadmap:0.6.0

2011-05-03T22:15:48Z

Pyramid: /* 0.5.2 */

Vega Strike Upon the Coldest Sea stable version 0.5.0 was released on 2008-04-24.

This is a task list for intermediate 0.5.x releases. The stuff that should get done for each intermediate and until the 0.6.0 release.

=Generic Roadmap=
This roadmap is in need of further broken down into release specific tasks and assignment of those.

==Factions rework==
*Hierarchical factions (e.g. *_citizen, affects *)
*Allowing for non-factions (privateer is already our non-faction, we just need to fix some of the behavior.)
*Ability for player joining a faction

==AI==
*Faction-level AI (race / faction strategy)
*Micro AI (ship, fg, collision avoidance, tactical and navigational AI, roles definition)
*Macro (fg/faction)
* Flightgroups
** Classification (fleet, squadron, flotilla? etc. - something to differentiate between {5 plowshares} and {3 archimedes, 2 Tesla, 8 kahan, 20 schroedinger, 10 goddard, 5 watson} )
** Flightgroups should have subsets of ships that spawn together (combined arms)
* add another dimension to roles (attack AND defend/predator AND prey roles) instead of forcing both to be the same.
* AI spec drive use, escorts...

==Content Creation Tools==
*Prerequisite: straight XML, DTD (Document Type Definition) support
*System Editor
*Unit Editor
*CSV Editor (MPL, faction_ships.py, units.csv)
*Mission Editor
*Campaign Editor
*Config Editor

==Multiplayer==
*Persistence (systems, bases, flight groups, …)

==Building/Packaging==
*Move to cmake

==Documentation==
*Document the general function/flow of the game
*Engine internals, API (development documentation)
*Python bindings
*Should we use the builtin python documentation standards for documenting this stuff--maybe in the stubs folder?
*Faction documentation

==Engine rework==
*Audio subsystem overhaul
*Support for texture versions and normal map tangents
*Shader updates

=Release Roadmap=

There are up to three sections in each roadmap release chapter:
* '''VS Engine''' relates to: modifications to c++, shaders, and python code (not including missions), repository structure changes, packaging system, support tools, ogre version
* '''VS Data - Upon The Coldest Sea''' relates to: modifications to art, data, and mission scripts for Upon The Coldest Sea (sometimes also called Vega Strike The Game as opposed to Vega Strike The Engine
* '''Documentation & Mod Tools & Other''' relates to: documentation, wiki, project web page, masters repository, project management

Each task item should also have a prefixed tag in the form of ['''STATUS'''{=OPEN, ONGOING, DONE}, development-coordinator{=''username''}]

== 0.5.1 ==

'''VS Engine'''
* '''[FINISHED]''' (''safemode'') Separate bin and data tree structure. Note: those who have data4.x already, set your client to not pull external repos or cancel when it tries to download data4.x. Then move your current data4.x alongside /bin, renaming it to data. Updates should work seamlessly and recurse into /data and /bin afterwards. Newcomers can just pull win32.
* '''[FINISHED]''' (''ace123'') Rename data4.x to data and patch corresponding source code where necessary.
* '''[FINISHED]''' (''safemode'') Make a high quality graphics texture pack (''hqtextures'').
* '''[FINISHED]''' (''safemode'') Preparation of a cross-platform packaging system (cmake)
* '''[FINISHED]''' (''pyramid'') Updates to the shader (commit chuck's unit shader)
* '''[FINISHED]''' (''pyramid'') Correct rings generation to be always in the same plane
* '''[FINISHED]''' (''pyramid'') Support for target shield gauges definition
* '''[FINISHED]''' (''klauss'') Add support for "TexturePackingVersion" variable in xmesh
* '''[FINISHED]''' (''klauss'') Add support for techniques and far z-buffering correction
* '''[FINISHED]''' (''klauss'') Tangent support for normal maps
* '''[FINISHED]''' (''klauss'') sound refactoring phase I - basic functionality
* '''[FINISHED]''' (''klauss'') movie support
* '''[FINISHED]''' (''klauss'') CubeMap engine support
* Minor bug fixes.
** '''[FINISHED]''' (''ace123'') fixed player relationship with each faction in savegame
** '''[FINISHED]''' (''pyramid'') planetary rings are always coplanar
** '''[FINISHED]''' (''pyramid'') system ownership (faction) and sector info shown in RVDU and on map
** '''[FINISHED]''' (''pyramid'') python modules can be organized in additional subfolders (ai, mission, quests)

'''VS Data - Upon The Coldest Sea'''
* '''[FINISHED]''' (''pyramid'') Extensions renaming and standardization (.image, .texture, .sprite).
* '''[FINISHED]''' (''safemode'') Added some textures to hqtextures.
* '''[FINISHED]''' (''pyramid'') 8 faces for armor HUD images
* '''[FINISHED]''' (''pyramid'') Higher pay for combat missions.
* '''[FINISHED]''' (''pyramid'') Tutorial mission
* '''[FINISHED]''' (''pyramid'') splash screen grouping in pre-load and load ani directories
* '''[FINISHED]''' (''pyramid'') additional art (planet backgrounds for lava, forest, rock, and frigid_mud, new space backgrounds, hud images)
* '''[FINISHED]''' (''pyramid'') partial extensions renaming (cockpits, sprites, backgrounds)
* '''[FINISHED]''' (''pyramid'') Visually enhanced target shield gauges
* '''[FINISHED]''' (''pyramid'') New and updated cargo and upgrade image contributions
* '''[FINISHED]''' (''pyramid'') Standardized factions coloring scheme
* '''[FINISHED]''' (''pyramid'') Units subdirectories for vessels and installations
* '''[FINISHED]''' (''pyramid'') Various new ship models (Kahan, Knight, Tridacna, ....) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Various new installation models (Rlaan, Uln, Shaper, ...) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Porting of old quests to new engine; done for: blockade, dispute, shipyard bomb, slaver, surplus

'''Documentation & Mod Tools & Other'''
* '''[FINISHED]''' (''pyramid'') Unit Converter OBJ->BFXM - a mesher frontend.
* '''[FINISHED]''' (''pyramid'') Re-organization of vessels model requirements on [[Development:3D_Models]].

== 0.5.1.5 ==

'''VS Engine'''
* '''[ONGOING]''' (''strook'') Implementing alpha version of VegaOgre, merging it into vegastrike.
the Ogre technology preview will be executable with '''vegastrike --with-ogre-engine''' until it is released.[http://vegastrike.sourceforge.net/forums/viewtopic.php?f=27&t=15545 see blog]

== 0.5.2 ==
'''VS Engine'''
* '''[OPEN]''' (''safemode'') Implement opcode's Ray Collider for ray-mesh collisions. (alongside bsp collider tunable via configure switch ala how opcode was done). Wont be turned on by default until 0.5.3
* '''[ONGOING]''' (''klauss'') More shader fixes, texture updates/additions.
* '''[OPEN]''' (''safemode'') Make tools and readers operate on a Proper XML format , this could be switchable via special comment at top of xml input. This is for backwards compat with non proper xml files in mods. To be made default in 0.5.5
* '''[OPEN]''' (''klauss'') sound refactoring Phase II would add mixer channels (a feature to get seamless blending with music, comm chatter and sfx)
* '''[OPEN]''' (''klauss'') put gfxlib into a class, or at the _very_least_ a namespace
* '''[ONGOING]''' (''chuck_starchaser'') CineMut shader family - v0.5
* '''[OPEN]''' (''strook'') Make VegaOgre Engine using vegastrike engine to implement gameplay with vegaogre.
* Minor bug fixes and improvements
** '''[FINISHED]''' (''pyramid'') Show, save, and load correct stardate
** '''[FINISHED]''' (''pyramid'') Corrected missing mission description for fixer missions
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data - Upon The Coldest Sea'''
* '''[FINISHED]''' ''(pyramid)'' Added quit image with default key mapping
* '''[OPEN]''' ''(pyramid)'' New quests, missions, and campaigns
* '''[OPEN]''' ''(pyramid)'' Revision of planet types
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 0.5
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key

== 0.5.3 ==
'''VS Engine'''
* '''[OPEN]''' ''(safemode)'' Ray collider turned on, BSP stuff removed.
* '''[OPEN]''' ''(klauss)'' XGUI support for scripts
* '''[OPEN]''' ''(klauss)'' More shader fixes (should be pretty good by now), texture updates/additions
* '''[OPEN]''' ''(safemode)'' Continue to work on proper XML parsing in engine
* '''[OPEN]''' ''(safemode)'' update xml files in VS to be proper mode
* '''[OPEN]''' ''(safemode)'' setup tool
* '''[OPEN]''' (''chuck_starchaser'') CineMut shader family - v1.0

'''VS Data - Upon The Coldest Sea'''
* '''[OPEN]''' ''(pyramid)'' Create custom systems with Homeworlds for races and factions
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 1.0

== 0.5.4 ==
'''VS Engine'''
* '''[ONGOING SPECIFICATION]''' (''klauss, darkmage'') content creation tools: end user tools for helping with content creation. These should be a part of vegastrike code-base, to keep things in sync and reduce maintenance.
* make proper xml mode default, remove code to parse obsolete xml-ish code.
* Get codebase stabilized in prep for refactoring graphics code.
* '''[OPEN]''' ''(safemode)'' new wormhole effects
* '''[OPEN]''' ''(safemode)'' improved ship AI
* '''[OPEN]''' ''(klauss)'' cleaning up unused mesh legacy formats (mesh_bin.cpp, ...)

'''VS Data - Upon The Coldest Sea'''

== 0.5.5 ==
'''VS Engine'''
* Refactor graphics code.
* ['''OPEN'''] (''ace123'') Make jump points be drawn on HUD only.

'''VS Data - Upon The Coldest Sea'''

== 0.5.6 ==
'''VS Engine'''
* Bug fixes.
* Texture additions/ etc
* Document refactored graphics and sound code.

'''VS Data - Upon The Coldest Sea'''

== 0.5.7 ==
'''VS Engine'''
* Thread graphics code and sound code with boost threads.
* Bug Fixing.

'''VS Data - Upon The Coldest Sea'''

== 0.5.9 ==
'''VS Engine'''
* sound refactoring Phase III would add environmental effects
* Bug Fixing.
* Documentation
* Credits

'''VS Data - Upon The Coldest Sea'''

== 0.6.0 ==
'''VS Engine'''
* Minor bug fixes from previous revision
* Packaging

'''VS Data - Upon The Coldest Sea'''
* documentation

[[Category:Roadmaps]]

Development:Roadmap:0.6.0

2011-05-03T22:14:59Z

Pyramid: /* Release Roadmap */

Vega Strike Upon the Coldest Sea stable version 0.5.0 was released on 2008-04-24.

This is a task list for intermediate 0.5.x releases. The stuff that should get done for each intermediate and until the 0.6.0 release.

=Generic Roadmap=
This roadmap is in need of further broken down into release specific tasks and assignment of those.

==Factions rework==
*Hierarchical factions (e.g. *_citizen, affects *)
*Allowing for non-factions (privateer is already our non-faction, we just need to fix some of the behavior.)
*Ability for player joining a faction

==AI==
*Faction-level AI (race / faction strategy)
*Micro AI (ship, fg, collision avoidance, tactical and navigational AI, roles definition)
*Macro (fg/faction)
* Flightgroups
** Classification (fleet, squadron, flotilla? etc. - something to differentiate between {5 plowshares} and {3 archimedes, 2 Tesla, 8 kahan, 20 schroedinger, 10 goddard, 5 watson} )
** Flightgroups should have subsets of ships that spawn together (combined arms)
* add another dimension to roles (attack AND defend/predator AND prey roles) instead of forcing both to be the same.
* AI spec drive use, escorts...

==Content Creation Tools==
*Prerequisite: straight XML, DTD (Document Type Definition) support
*System Editor
*Unit Editor
*CSV Editor (MPL, faction_ships.py, units.csv)
*Mission Editor
*Campaign Editor
*Config Editor

==Multiplayer==
*Persistence (systems, bases, flight groups, …)

==Building/Packaging==
*Move to cmake

==Documentation==
*Document the general function/flow of the game
*Engine internals, API (development documentation)
*Python bindings
*Should we use the builtin python documentation standards for documenting this stuff--maybe in the stubs folder?
*Faction documentation

==Engine rework==
*Audio subsystem overhaul
*Support for texture versions and normal map tangents
*Shader updates

=Release Roadmap=

There are up to three sections in each roadmap release chapter:
* '''VS Engine''' relates to: modifications to c++, shaders, and python code (not including missions), repository structure changes, packaging system, support tools, ogre version
* '''VS Data - Upon The Coldest Sea''' relates to: modifications to art, data, and mission scripts for Upon The Coldest Sea (sometimes also called Vega Strike The Game as opposed to Vega Strike The Engine
* '''Documentation & Mod Tools & Other''' relates to: documentation, wiki, project web page, masters repository, project management

Each task item should also have a prefixed tag in the form of ['''STATUS'''{=OPEN, ONGOING, DONE}, development-coordinator{=''username''}]

== 0.5.1 ==

'''VS Engine'''
* '''[FINISHED]''' (''safemode'') Separate bin and data tree structure. Note: those who have data4.x already, set your client to not pull external repos or cancel when it tries to download data4.x. Then move your current data4.x alongside /bin, renaming it to data. Updates should work seamlessly and recurse into /data and /bin afterwards. Newcomers can just pull win32.
* '''[FINISHED]''' (''ace123'') Rename data4.x to data and patch corresponding source code where necessary.
* '''[FINISHED]''' (''safemode'') Make a high quality graphics texture pack (''hqtextures'').
* '''[FINISHED]''' (''safemode'') Preparation of a cross-platform packaging system (cmake)
* '''[FINISHED]''' (''pyramid'') Updates to the shader (commit chuck's unit shader)
* '''[FINISHED]''' (''pyramid'') Correct rings generation to be always in the same plane
* '''[FINISHED]''' (''pyramid'') Support for target shield gauges definition
* '''[FINISHED]''' (''klauss'') Add support for "TexturePackingVersion" variable in xmesh
* '''[FINISHED]''' (''klauss'') Add support for techniques and far z-buffering correction
* '''[FINISHED]''' (''klauss'') Tangent support for normal maps
* '''[FINISHED]''' (''klauss'') sound refactoring phase I - basic functionality
* '''[FINISHED]''' (''klauss'') movie support
* '''[FINISHED]''' (''klauss'') CubeMap engine support
* Minor bug fixes.
** '''[FINISHED]''' (''ace123'') fixed player relationship with each faction in savegame
** '''[FINISHED]''' (''pyramid'') planetary rings are always coplanar
** '''[FINISHED]''' (''pyramid'') system ownership (faction) and sector info shown in RVDU and on map
** '''[FINISHED]''' (''pyramid'') python modules can be organized in additional subfolders (ai, mission, quests)

'''VS Data - Upon The Coldest Sea'''
* '''[FINISHED]''' (''pyramid'') Extensions renaming and standardization (.image, .texture, .sprite).
* '''[FINISHED]''' (''safemode'') Added some textures to hqtextures.
* '''[FINISHED]''' (''pyramid'') 8 faces for armor HUD images
* '''[FINISHED]''' (''pyramid'') Higher pay for combat missions.
* '''[FINISHED]''' (''pyramid'') Tutorial mission
* '''[FINISHED]''' (''pyramid'') splash screen grouping in pre-load and load ani directories
* '''[FINISHED]''' (''pyramid'') additional art (planet backgrounds for lava, forest, rock, and frigid_mud, new space backgrounds, hud images)
* '''[FINISHED]''' (''pyramid'') partial extensions renaming (cockpits, sprites, backgrounds)
* '''[FINISHED]''' (''pyramid'') Visually enhanced target shield gauges
* '''[FINISHED]''' (''pyramid'') New and updated cargo and upgrade image contributions
* '''[FINISHED]''' (''pyramid'') Standardized factions coloring scheme
* '''[FINISHED]''' (''pyramid'') Units subdirectories for vessels and installations
* '''[FINISHED]''' (''pyramid'') Various new ship models (Kahan, Knight, Tridacna, ....) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Various new installation models (Rlaan, Uln, Shaper, ...) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Porting of old quests to new engine; done for: blockade, dispute, shipyard bomb, slaver, surplus

'''Documentation & Mod Tools & Other'''
* '''[FINISHED]''' (''pyramid'') Unit Converter OBJ->BFXM - a mesher frontend.
* '''[FINISHED]''' (''pyramid'') Re-organization of vessels model requirements on [[Development:3D_Models]].

== 0.5.1.5 ==

'''VS Engine'''
* '''[ONGOING]''' (''strook'') Implementing alpha version of VegaOgre, merging it into vegastrike.
the Ogre technology preview will be executable with '''vegastrike --with-ogre-engine''' until it is released.[http://vegastrike.sourceforge.net/forums/viewtopic.php?f=27&t=15545 see blog]

== 0.5.2 ==
'''VS Engine'''
* '''[OPEN]''' (''safemode'') Implement opcode's Ray Collider for ray-mesh collisions. (alongside bsp collider tunable via configure switch ala how opcode was done). Wont be turned on by default until 0.5.3
* '''[ONGOING]''' (''klauss'') More shader fixes, texture updates/additions.
* '''[OPEN]''' (''safemode'') Make tools and readers operate on a Proper XML format , this could be switchable via special comment at top of xml input. This is for backwards compat with non proper xml files in mods. To be made default in 0.5.5
* '''[OPEN]''' (''klauss'') sound refactoring Phase II would add mixer channels (a feature to get seamless blending with music, comm chatter and sfx)
* '''[OPEN]''' (''klauss'') put gfxlib into a class, or at the _very_least_ a namespace
* '''[ONGOING]''' (''chuck_starchaser'') CineMut shader family - v0.5
* '''[OPEN]''' (''strook'') Make VegaOgre Engine using vegastrike engine to implement gameplay with vegaogre.
* Minor bug fixes and improvements
** '''[FINISHED]''' (''pyramid'') Show, save, and load correct stardate
** '''[FINISHED]''' (''pyramid'') Corrected missing mission description for fixer missions
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data - Upon The Coldest Sea'''
* '''[FINISHED]''' ''(pyramid)'' Added quit image with default key mapping
* '''[OPEN]''' ''(pyramid)'' Revision of planet types
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 0.5
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key

== 0.5.3 ==
'''VS Engine'''
* '''[OPEN]''' ''(safemode)'' Ray collider turned on, BSP stuff removed.
* '''[OPEN]''' ''(klauss)'' XGUI support for scripts
* '''[OPEN]''' ''(klauss)'' More shader fixes (should be pretty good by now), texture updates/additions
* '''[OPEN]''' ''(safemode)'' Continue to work on proper XML parsing in engine
* '''[OPEN]''' ''(safemode)'' update xml files in VS to be proper mode
* '''[OPEN]''' ''(safemode)'' setup tool
* '''[OPEN]''' (''chuck_starchaser'') CineMut shader family - v1.0

'''VS Data - Upon The Coldest Sea'''
* '''[OPEN]''' ''(pyramid)'' Create custom systems with Homeworlds for races and factions
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 1.0

== 0.5.4 ==
'''VS Engine'''
* '''[ONGOING SPECIFICATION]''' (''klauss, darkmage'') content creation tools: end user tools for helping with content creation. These should be a part of vegastrike code-base, to keep things in sync and reduce maintenance.
* make proper xml mode default, remove code to parse obsolete xml-ish code.
* Get codebase stabilized in prep for refactoring graphics code.
* '''[OPEN]''' ''(safemode)'' new wormhole effects
* '''[OPEN]''' ''(safemode)'' improved ship AI
* '''[OPEN]''' ''(klauss)'' cleaning up unused mesh legacy formats (mesh_bin.cpp, ...)

'''VS Data - Upon The Coldest Sea'''

== 0.5.5 ==
'''VS Engine'''
* Refactor graphics code.
* ['''OPEN'''] (''ace123'') Make jump points be drawn on HUD only.

'''VS Data - Upon The Coldest Sea'''

== 0.5.6 ==
'''VS Engine'''
* Bug fixes.
* Texture additions/ etc
* Document refactored graphics and sound code.

'''VS Data - Upon The Coldest Sea'''

== 0.5.7 ==
'''VS Engine'''
* Thread graphics code and sound code with boost threads.
* Bug Fixing.

'''VS Data - Upon The Coldest Sea'''

== 0.5.9 ==
'''VS Engine'''
* sound refactoring Phase III would add environmental effects
* Bug Fixing.
* Documentation
* Credits

'''VS Data - Upon The Coldest Sea'''

== 0.6.0 ==
'''VS Engine'''
* Minor bug fixes from previous revision
* Packaging

'''VS Data - Upon The Coldest Sea'''
* documentation

[[Category:Roadmaps]]

Development:Roadmap:0.6.0

2011-05-03T22:10:04Z

Pyramid: /* 0.5.1 */

Vega Strike Upon the Coldest Sea stable version 0.5.0 was released on 2008-04-24.

This is a task list for intermediate 0.5.x releases. The stuff that should get done for each intermediate and until the 0.6.0 release.

=Generic Roadmap=
This roadmap is in need of further broken down into release specific tasks and assignment of those.

==Factions rework==
*Hierarchical factions (e.g. *_citizen, affects *)
*Allowing for non-factions (privateer is already our non-faction, we just need to fix some of the behavior.)
*Ability for player joining a faction

==AI==
*Faction-level AI (race / faction strategy)
*Micro AI (ship, fg, collision avoidance, tactical and navigational AI, roles definition)
*Macro (fg/faction)
* Flightgroups
** Classification (fleet, squadron, flotilla? etc. - something to differentiate between {5 plowshares} and {3 archimedes, 2 Tesla, 8 kahan, 20 schroedinger, 10 goddard, 5 watson} )
** Flightgroups should have subsets of ships that spawn together (combined arms)
* add another dimension to roles (attack AND defend/predator AND prey roles) instead of forcing both to be the same.
* AI spec drive use, escorts...

==Content Creation Tools==
*Prerequisite: straight XML, DTD (Document Type Definition) support
*System Editor
*Unit Editor
*CSV Editor (MPL, faction_ships.py, units.csv)
*Mission Editor
*Campaign Editor
*Config Editor

==Multiplayer==
*Persistence (systems, bases, flight groups, …)

==Building/Packaging==
*Move to cmake

==Documentation==
*Document the general function/flow of the game
*Engine internals, API (development documentation)
*Python bindings
*Should we use the builtin python documentation standards for documenting this stuff--maybe in the stubs folder?
*Faction documentation

==Engine rework==
*Audio subsystem overhaul
*Support for texture versions and normal map tangents
*Shader updates

=Release Roadmap=

There are up to three sections in each roadmap release chapter:
* '''VS Engine''' relates to: modifications to c++, shaders, and python code (not including missions), repository structure changes, packaging system, support tools, ogre version
* '''VS Data''' relates to: modifications to art, data, and mission scripts
* '''Other''' relates to: documentation, wiki, project web page, masters repository, project management

Each task item should also have a prefixed tag in the form of ['''STATUS'''{=OPEN, ONGOING, DONE}, development-coordinator{=''username''}]

== 0.5.1 ==

'''VS Engine'''
* '''[FINISHED]''' (''safemode'') Separate bin and data tree structure. Note: those who have data4.x already, set your client to not pull external repos or cancel when it tries to download data4.x. Then move your current data4.x alongside /bin, renaming it to data. Updates should work seamlessly and recurse into /data and /bin afterwards. Newcomers can just pull win32.
* '''[FINISHED]''' (''ace123'') Rename data4.x to data and patch corresponding source code where necessary.
* '''[FINISHED]''' (''safemode'') Make a high quality graphics texture pack (''hqtextures'').
* '''[FINISHED]''' (''safemode'') Preparation of a cross-platform packaging system (cmake)
* '''[FINISHED]''' (''pyramid'') Updates to the shader (commit chuck's unit shader)
* '''[FINISHED]''' (''pyramid'') Correct rings generation to be always in the same plane
* '''[FINISHED]''' (''pyramid'') Support for target shield gauges definition
* '''[FINISHED]''' (''klauss'') Add support for "TexturePackingVersion" variable in xmesh
* '''[FINISHED]''' (''klauss'') Add support for techniques and far z-buffering correction
* '''[FINISHED]''' (''klauss'') Tangent support for normal maps
* '''[FINISHED]''' (''klauss'') sound refactoring phase I - basic functionality
* '''[FINISHED]''' (''klauss'') movie support
* '''[FINISHED]''' (''klauss'') CubeMap engine support
* Minor bug fixes.
** '''[FINISHED]''' (''ace123'') fixed player relationship with each faction in savegame
** '''[FINISHED]''' (''pyramid'') planetary rings are always coplanar
** '''[FINISHED]''' (''pyramid'') system ownership (faction) and sector info shown in RVDU and on map
** '''[FINISHED]''' (''pyramid'') python modules can be organized in additional subfolders (ai, mission, quests)

'''VS Data'''
* '''[FINISHED]''' (''pyramid'') Extensions renaming and standardization (.image, .texture, .sprite).
* '''[FINISHED]''' (''safemode'') Added some textures to hqtextures.
* '''[FINISHED]''' (''pyramid'') 8 faces for armor HUD images
* '''[FINISHED]''' (''pyramid'') Higher pay for combat missions.
* '''[FINISHED]''' (''pyramid'') Tutorial mission
* '''[FINISHED]''' (''pyramid'') splash screen grouping in pre-load and load ani directories
* '''[FINISHED]''' (''pyramid'') additional art (planet backgrounds for lava, forest, rock, and frigid_mud, new space backgrounds, hud images)
* '''[FINISHED]''' (''pyramid'') partial extensions renaming (cockpits, sprites, backgrounds)
* '''[FINISHED]''' (''pyramid'') Visually enhanced target shield gauges
* '''[FINISHED]''' (''pyramid'') New and updated cargo and upgrade image contributions
* '''[FINISHED]''' (''pyramid'') Standardized factions coloring scheme
* '''[FINISHED]''' (''pyramid'') Units subdirectories for vessels and installations
* '''[FINISHED]''' (''pyramid'') Various new ship models (Kahan, Knight, Tridacna, ....) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Various new installation models (Rlaan, Uln, Shaper, ...) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Porting of old quests to new engine; done for: blockade, dispute, shipyard bomb, slaver, surplus

'''Documentation & Mod Tools & Other'''
* '''[FINISHED]''' (''pyramid'') Unit Converter OBJ->BFXM - a mesher frontend.
* '''[FINISHED]''' (''pyramid'') Re-organization of vessels model requirements on [[Development:3D_Models]].

== 0.5.1.5 ==

'''VS Engine'''
* '''[ONGOING]''' (''strook'') Implementing alpha version of VegaOgre, merging it into vegastrike.
the Ogre technology preview will be executable with '''vegastrike --with-ogre-engine''' until it is released.[http://vegastrike.sourceforge.net/forums/viewtopic.php?f=27&t=15545 see blog]

== 0.5.2 ==
'''VS Engine'''
* '''[OPEN]''' (''safemode'') Implement opcode's Ray Collider for ray-mesh collisions. (alongside bsp collider tunable via configure switch ala how opcode was done). Wont be turned on by default until 0.5.3
* '''[ONGOING]''' (''klauss'') More shader fixes, texture updates/additions.
* '''[OPEN]''' (''safemode'') Make tools and readers operate on a Proper XML format , this could be switchable via special comment at top of xml input. This is for backwards compat with non proper xml files in mods. To be made default in 0.5.5
* '''[OPEN]''' (''klauss'') sound refactoring Phase II would add mixer channels (a feature to get seamless blending with music, comm chatter and sfx)
* '''[OPEN]''' (''klauss'') put gfxlib into a class, or at the _very_least_ a namespace
* '''[ONGOING]''' (''chuck_starchaser'') CineMut shader family - v0.5
* '''[OPEN]''' (''strook'') Make VegaOgre Engine using vegastrike engine to implement gameplay with vegaogre.
* Minor bug fixes and improvements
** '''[FINISHED]''' (''pyramid'') Show, save, and load correct stardate
** '''[FINISHED]''' (''pyramid'') Corrected missing mission description for fixer missions
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data'''
* '''[OPEN]''' ''(pyramid)'' Revision of planet types
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 0.5
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key

== 0.5.3 ==
'''VS Engine'''
* '''[OPEN]''' ''(safemode)'' Ray collider turned on, BSP stuff removed.
* '''[OPEN]''' ''(klauss)'' XGUI support for scripts
* '''[OPEN]''' ''(klauss)'' More shader fixes (should be pretty good by now), texture updates/additions
* '''[OPEN]''' ''(safemode)'' Continue to work on proper XML parsing in engine
* '''[OPEN]''' ''(safemode)'' update xml files in VS to be proper mode
* '''[OPEN]''' ''(safemode)'' setup tool
* '''[OPEN]''' (''chuck_starchaser'') CineMut shader family - v1.0

'''VS Data'''
* '''[OPEN]''' ''(pyramid)'' Create custom systems with Homeworlds for races and factions
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 1.0

== 0.5.4 ==
'''VS Engine'''
* '''[ONGOING SPECIFICATION]''' (''klauss, darkmage'') content creation tools: end user tools for helping with content creation. These should be a part of vegastrike code-base, to keep things in sync and reduce maintenance.
* make proper xml mode default, remove code to parse obsolete xml-ish code.
* Get codebase stabilized in prep for refactoring graphics code.
* '''[OPEN]''' ''(safemode)'' new wormhole effects
* '''[OPEN]''' ''(safemode)'' improved ship AI
* '''[OPEN]''' ''(klauss)'' cleaning up unused mesh legacy formats (mesh_bin.cpp, ...)

'''VS Data'''

== 0.5.5 ==
'''VS Engine'''
* Refactor graphics code.
* ['''OPEN'''] (''ace123'') Make jump points be drawn on HUD only.

'''VS Data'''

== 0.5.6 ==
'''VS Engine'''
* Bug fixes.
* Texture additions/ etc
* Document refactored graphics and sound code.

'''VS Data'''

== 0.5.7 ==
'''VS Engine'''
* Thread graphics code and sound code with boost threads.
* Bug Fixing.

'''VS Data'''

== 0.5.9 ==
'''VS Engine'''
* sound refactoring Phase III would add environmental effects
* Bug Fixing.
* Documentation
* Credits

'''VS Data'''

== 0.6.0 ==
'''VS Engine'''
* Minor bug fixes from previous revision
* Packaging

'''VS Data'''
* documentation

[[Category:Roadmaps]]

Development:Roadmap:0.6.0

2011-05-03T22:09:29Z

Pyramid: /* 0.5.1 */

Vega Strike Upon the Coldest Sea stable version 0.5.0 was released on 2008-04-24.

This is a task list for intermediate 0.5.x releases. The stuff that should get done for each intermediate and until the 0.6.0 release.

=Generic Roadmap=
This roadmap is in need of further broken down into release specific tasks and assignment of those.

==Factions rework==
*Hierarchical factions (e.g. *_citizen, affects *)
*Allowing for non-factions (privateer is already our non-faction, we just need to fix some of the behavior.)
*Ability for player joining a faction

==AI==
*Faction-level AI (race / faction strategy)
*Micro AI (ship, fg, collision avoidance, tactical and navigational AI, roles definition)
*Macro (fg/faction)
* Flightgroups
** Classification (fleet, squadron, flotilla? etc. - something to differentiate between {5 plowshares} and {3 archimedes, 2 Tesla, 8 kahan, 20 schroedinger, 10 goddard, 5 watson} )
** Flightgroups should have subsets of ships that spawn together (combined arms)
* add another dimension to roles (attack AND defend/predator AND prey roles) instead of forcing both to be the same.
* AI spec drive use, escorts...

==Content Creation Tools==
*Prerequisite: straight XML, DTD (Document Type Definition) support
*System Editor
*Unit Editor
*CSV Editor (MPL, faction_ships.py, units.csv)
*Mission Editor
*Campaign Editor
*Config Editor

==Multiplayer==
*Persistence (systems, bases, flight groups, …)

==Building/Packaging==
*Move to cmake

==Documentation==
*Document the general function/flow of the game
*Engine internals, API (development documentation)
*Python bindings
*Should we use the builtin python documentation standards for documenting this stuff--maybe in the stubs folder?
*Faction documentation

==Engine rework==
*Audio subsystem overhaul
*Support for texture versions and normal map tangents
*Shader updates

=Release Roadmap=

There are up to three sections in each roadmap release chapter:
* '''VS Engine''' relates to: modifications to c++, shaders, and python code (not including missions), repository structure changes, packaging system, support tools, ogre version
* '''VS Data''' relates to: modifications to art, data, and mission scripts
* '''Other''' relates to: documentation, wiki, project web page, masters repository, project management

Each task item should also have a prefixed tag in the form of ['''STATUS'''{=OPEN, ONGOING, DONE}, development-coordinator{=''username''}]

== 0.5.1 ==

'''VS Engine'''
* '''[FINISHED]''' (''safemode'') Separate bin and data tree structure. Note: those who have data4.x already, set your client to not pull external repos or cancel when it tries to download data4.x. Then move your current data4.x alongside /bin, renaming it to data. Updates should work seamlessly and recurse into /data and /bin afterwards. Newcomers can just pull win32.
* '''[FINISHED]''' (''ace123'') Rename data4.x to data and patch corresponding source code where necessary.
* '''[FINISHED]''' (''safemode'') Make a high quality graphics texture pack (''hqtextures'').
* '''[FINISHED]''' (''safemode'') Preparation of a cross-platform packaging system (cmake)
* '''[FINISHED]''' (''pyramid'') Updates to the shader (commit chuck's unit shader)
* '''[FINISHED]''' (''pyramid'') Correct rings generation to be always in the same plane
* '''[FINISHED]''' (''pyramid'') Support for target shield gauges definition
* '''[FINISHED]''' (''klauss'') Add support for "TexturePackingVersion" variable in xmesh
* '''[FINISHED]''' (''klauss'') Add support for techniques and far z-buffering correction
* '''[FINISHED]''' (''klauss'') Tangent support for normal maps
* '''[FINISHED]''' (''klauss'') sound refactoring phase I - basic functionality
* '''[FINISHED]''' (''klauss'') movie support
* '''[FINISHED]''' (''klauss'') CubeMap engine support
* Minor bug fixes.
** '''[FINISHED]''' (''ace123'') fixed player relationship with each faction in savegame
** '''[FINISHED]''' (''pyramid'') planetary rings are always coplanar
** '''[FINISHED]''' (''pyramid'') system ownership (faction) and sector info shown in
RVDU and on map
** '''[FINISHED]''' (''pyramid'') python modules can be organized in additional subfolders (ai, mission, quests)

'''VS Data'''
* '''[FINISHED]''' (''pyramid'') Extensions renaming and standardization (.image, .texture, .sprite).
* '''[FINISHED]''' (''safemode'') Added some textures to hqtextures.
* '''[FINISHED]''' (''pyramid'') 8 faces for armor HUD images
* '''[FINISHED]''' (''pyramid'') Higher pay for combat missions.
* '''[FINISHED]''' (''pyramid'') Tutorial mission
* '''[FINISHED]''' (''pyramid'') splash screen grouping in pre-load and load ani directories
* '''[FINISHED]''' (''pyramid'') additional art (planet backgrounds for lava, forest, rock, and frigid_mud, new space backgrounds, hud images)
* '''[FINISHED]''' (''pyramid'') partial extensions renaming (cockpits, sprites, backgrounds)
* '''[FINISHED]''' (''pyramid'') Visually enhanced target shield gauges
* '''[FINISHED]''' (''pyramid'') New and updated cargo and upgrade image contributions
* '''[FINISHED]''' (''pyramid'') Standardized factions coloring scheme
* '''[FINISHED]''' (''pyramid'') Units subdirectories for vessels and installations
* '''[FINISHED]''' (''pyramid'') Various new ship models (Kahan, Knight, Tridacna, ....) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Various new installation models (Rlaan, Uln, Shaper, ...) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Porting of old quests to new engine; done for: blockade, dispute, shipyard bomb, slaver, surplus

'''Documentation & Mod Tools & Other'''
* '''[FINISHED]''' (''pyramid'') Unit Converter OBJ->BFXM - a mesher frontend.
* '''[FINISHED]''' (''pyramid'') Re-organization of vessels model requirements on [[Development:3D_Models]].

== 0.5.1.5 ==

'''VS Engine'''
* '''[ONGOING]''' (''strook'') Implementing alpha version of VegaOgre, merging it into vegastrike.
the Ogre technology preview will be executable with '''vegastrike --with-ogre-engine''' until it is released.[http://vegastrike.sourceforge.net/forums/viewtopic.php?f=27&t=15545 see blog]

== 0.5.2 ==
'''VS Engine'''
* '''[OPEN]''' (''safemode'') Implement opcode's Ray Collider for ray-mesh collisions. (alongside bsp collider tunable via configure switch ala how opcode was done). Wont be turned on by default until 0.5.3
* '''[ONGOING]''' (''klauss'') More shader fixes, texture updates/additions.
* '''[OPEN]''' (''safemode'') Make tools and readers operate on a Proper XML format , this could be switchable via special comment at top of xml input. This is for backwards compat with non proper xml files in mods. To be made default in 0.5.5
* '''[OPEN]''' (''klauss'') sound refactoring Phase II would add mixer channels (a feature to get seamless blending with music, comm chatter and sfx)
* '''[OPEN]''' (''klauss'') put gfxlib into a class, or at the _very_least_ a namespace
* '''[ONGOING]''' (''chuck_starchaser'') CineMut shader family - v0.5
* '''[OPEN]''' (''strook'') Make VegaOgre Engine using vegastrike engine to implement gameplay with vegaogre.
* Minor bug fixes and improvements
** '''[FINISHED]''' (''pyramid'') Show, save, and load correct stardate
** '''[FINISHED]''' (''pyramid'') Corrected missing mission description for fixer missions
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data'''
* '''[OPEN]''' ''(pyramid)'' Revision of planet types
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 0.5
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key

== 0.5.3 ==
'''VS Engine'''
* '''[OPEN]''' ''(safemode)'' Ray collider turned on, BSP stuff removed.
* '''[OPEN]''' ''(klauss)'' XGUI support for scripts
* '''[OPEN]''' ''(klauss)'' More shader fixes (should be pretty good by now), texture updates/additions
* '''[OPEN]''' ''(safemode)'' Continue to work on proper XML parsing in engine
* '''[OPEN]''' ''(safemode)'' update xml files in VS to be proper mode
* '''[OPEN]''' ''(safemode)'' setup tool
* '''[OPEN]''' (''chuck_starchaser'') CineMut shader family - v1.0

'''VS Data'''
* '''[OPEN]''' ''(pyramid)'' Create custom systems with Homeworlds for races and factions
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 1.0

== 0.5.4 ==
'''VS Engine'''
* '''[ONGOING SPECIFICATION]''' (''klauss, darkmage'') content creation tools: end user tools for helping with content creation. These should be a part of vegastrike code-base, to keep things in sync and reduce maintenance.
* make proper xml mode default, remove code to parse obsolete xml-ish code.
* Get codebase stabilized in prep for refactoring graphics code.
* '''[OPEN]''' ''(safemode)'' new wormhole effects
* '''[OPEN]''' ''(safemode)'' improved ship AI
* '''[OPEN]''' ''(klauss)'' cleaning up unused mesh legacy formats (mesh_bin.cpp, ...)

'''VS Data'''

== 0.5.5 ==
'''VS Engine'''
* Refactor graphics code.
* ['''OPEN'''] (''ace123'') Make jump points be drawn on HUD only.

'''VS Data'''

== 0.5.6 ==
'''VS Engine'''
* Bug fixes.
* Texture additions/ etc
* Document refactored graphics and sound code.

'''VS Data'''

== 0.5.7 ==
'''VS Engine'''
* Thread graphics code and sound code with boost threads.
* Bug Fixing.

'''VS Data'''

== 0.5.9 ==
'''VS Engine'''
* sound refactoring Phase III would add environmental effects
* Bug Fixing.
* Documentation
* Credits

'''VS Data'''

== 0.6.0 ==
'''VS Engine'''
* Minor bug fixes from previous revision
* Packaging

'''VS Data'''
* documentation

[[Category:Roadmaps]]

Development:Roadmap:0.6.0

2011-05-03T22:08:45Z

Pyramid: /* 0.5.2 */

Vega Strike Upon the Coldest Sea stable version 0.5.0 was released on 2008-04-24.

This is a task list for intermediate 0.5.x releases. The stuff that should get done for each intermediate and until the 0.6.0 release.

=Generic Roadmap=
This roadmap is in need of further broken down into release specific tasks and assignment of those.

==Factions rework==
*Hierarchical factions (e.g. *_citizen, affects *)
*Allowing for non-factions (privateer is already our non-faction, we just need to fix some of the behavior.)
*Ability for player joining a faction

==AI==
*Faction-level AI (race / faction strategy)
*Micro AI (ship, fg, collision avoidance, tactical and navigational AI, roles definition)
*Macro (fg/faction)
* Flightgroups
** Classification (fleet, squadron, flotilla? etc. - something to differentiate between {5 plowshares} and {3 archimedes, 2 Tesla, 8 kahan, 20 schroedinger, 10 goddard, 5 watson} )
** Flightgroups should have subsets of ships that spawn together (combined arms)
* add another dimension to roles (attack AND defend/predator AND prey roles) instead of forcing both to be the same.
* AI spec drive use, escorts...

==Content Creation Tools==
*Prerequisite: straight XML, DTD (Document Type Definition) support
*System Editor
*Unit Editor
*CSV Editor (MPL, faction_ships.py, units.csv)
*Mission Editor
*Campaign Editor
*Config Editor

==Multiplayer==
*Persistence (systems, bases, flight groups, …)

==Building/Packaging==
*Move to cmake

==Documentation==
*Document the general function/flow of the game
*Engine internals, API (development documentation)
*Python bindings
*Should we use the builtin python documentation standards for documenting this stuff--maybe in the stubs folder?
*Faction documentation

==Engine rework==
*Audio subsystem overhaul
*Support for texture versions and normal map tangents
*Shader updates

=Release Roadmap=

There are up to three sections in each roadmap release chapter:
* '''VS Engine''' relates to: modifications to c++, shaders, and python code (not including missions), repository structure changes, packaging system, support tools, ogre version
* '''VS Data''' relates to: modifications to art, data, and mission scripts
* '''Other''' relates to: documentation, wiki, project web page, masters repository, project management

Each task item should also have a prefixed tag in the form of ['''STATUS'''{=OPEN, ONGOING, DONE}, development-coordinator{=''username''}]

== 0.5.1 ==

'''VS Engine'''
* '''[FINISHED]''' (''safemode'') Separate bin and data tree structure. Note: those who have data4.x already, set your client to not pull external repos or cancel when it tries to download data4.x. Then move your current data4.x alongside /bin, renaming it to data. Updates should work seamlessly and recurse into /data and /bin afterwards. Newcomers can just pull win32.
* '''[FINISHED]''' (''ace123'') Rename data4.x to data and patch corresponding source code where necessary.
* '''[FINISHED]''' (''safemode'') Make a high quality graphics texture pack (''hqtextures'').
* '''[FINISHED]''' (''safemode'') Preparation of a cross-platform packaging system (cmake)
* '''[FINISHED]''' (''pyramid'') Updates to the shader (commit chuck's unit shader)
* '''[FINISHED]''' (''pyramid'') Correct rings generation to be always in the same plane
* '''[FINISHED]''' (''pyramid'') Support for target shield gauges definition
* '''[FINISHED]''' (''klauss'') Add support for "TexturePackingVersion" variable in xmesh
* '''[FINISHED]''' (''klauss'') Add support for techniques and far z-buffering correction
* '''[FINISHED]''' (''klauss'') Tangent support for normal maps
* '''[FINISHED]''' (''klauss'') sound refactoring phase I - basic functionality
* '''[FINISHED]''' (''klauss'') movie support
* '''[FINISHED]''' (''klauss'') CubeMap engine support
* Minor bug fixes.
** '''[FINISHED]''' (''ace123'') fixed player relationship with each faction in savegame
** '''[FINISHED]''' (''pyramid'') planetary rings are always coplanar
** '''[FINISHED]''' (''pyramid'') system ownership (faction) and sector info shown in
RVDU and on map
** '''[FINISHED]''' (''pyramid'') python modules can be organized in additional subfolders (ai, mission, quests)
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data'''
* '''[FINISHED]''' (''safemode'') Added some textures to hqtextures.
* '''[FINISHED]''' (''pyramid'') 8 faces for armor HUD images
* '''[FINISHED]''' (''pyramid'') Higher pay for combat missions.
* '''[FINISHED]''' (''pyramid'') Tutorial mission
* '''[FINISHED]''' (''pyramid'') splash screen grouping in pre-load and load ani directories
* '''[FINISHED]''' (''pyramid'') additional art (planet backgrounds for lava, forest, rock, and frigid_mud, new space backgrounds, hud images)
* '''[FINISHED]''' (''pyramid'') partial extensions renaming (cockpits, sprites, backgrounds)
* '''[FINISHED]''' (''pyramid'') Visually enhanced target shield gauges
* '''[FINISHED]''' (''pyramid'') New and updated cargo and upgrade image contributions
* '''[FINISHED]''' (''pyramid'') Standardized factions coloring scheme
* '''[FINISHED]''' (''pyramid'') Units subdirectories for vessels and installations
* '''[FINISHED]''' (''pyramid'') Various new ship models (Kahan, Knight, Tridacna, ....) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Various new installation models (Rlaan, Uln, Shaper, ...) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Porting of old quests to new engine; done for: blockade, dispute, shipyard bomb, slaver, surplus

'''Documentation & Mod Tools & Other'''
* '''[FINISHED]''' (''pyramid'') Unit Converter OBJ->BFXM - a mesher frontend.
* '''[FINISHED]''' (''pyramid'') Re-organization of vessels model requirements on [[Development:3D_Models]].

== 0.5.1.5 ==

'''VS Engine'''
* '''[ONGOING]''' (''strook'') Implementing alpha version of VegaOgre, merging it into vegastrike.
the Ogre technology preview will be executable with '''vegastrike --with-ogre-engine''' until it is released.[http://vegastrike.sourceforge.net/forums/viewtopic.php?f=27&t=15545 see blog]

== 0.5.2 ==
'''VS Engine'''
* '''[OPEN]''' (''safemode'') Implement opcode's Ray Collider for ray-mesh collisions. (alongside bsp collider tunable via configure switch ala how opcode was done). Wont be turned on by default until 0.5.3
* '''[ONGOING]''' (''klauss'') More shader fixes, texture updates/additions.
* '''[OPEN]''' (''safemode'') Make tools and readers operate on a Proper XML format , this could be switchable via special comment at top of xml input. This is for backwards compat with non proper xml files in mods. To be made default in 0.5.5
* '''[OPEN]''' (''klauss'') sound refactoring Phase II would add mixer channels (a feature to get seamless blending with music, comm chatter and sfx)
* '''[OPEN]''' (''klauss'') put gfxlib into a class, or at the _very_least_ a namespace
* '''[ONGOING]''' (''chuck_starchaser'') CineMut shader family - v0.5
* '''[OPEN]''' (''strook'') Make VegaOgre Engine using vegastrike engine to implement gameplay with vegaogre.
* Minor bug fixes and improvements
** '''[FINISHED]''' (''pyramid'') Show, save, and load correct stardate
** '''[FINISHED]''' (''pyramid'') Corrected missing mission description for fixer missions
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data'''
* '''[OPEN]''' ''(pyramid)'' Revision of planet types
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 0.5
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key

== 0.5.3 ==
'''VS Engine'''
* '''[OPEN]''' ''(safemode)'' Ray collider turned on, BSP stuff removed.
* '''[OPEN]''' ''(klauss)'' XGUI support for scripts
* '''[OPEN]''' ''(klauss)'' More shader fixes (should be pretty good by now), texture updates/additions
* '''[OPEN]''' ''(safemode)'' Continue to work on proper XML parsing in engine
* '''[OPEN]''' ''(safemode)'' update xml files in VS to be proper mode
* '''[OPEN]''' ''(safemode)'' setup tool
* '''[OPEN]''' (''chuck_starchaser'') CineMut shader family - v1.0

'''VS Data'''
* '''[OPEN]''' ''(pyramid)'' Create custom systems with Homeworlds for races and factions
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 1.0

== 0.5.4 ==
'''VS Engine'''
* '''[ONGOING SPECIFICATION]''' (''klauss, darkmage'') content creation tools: end user tools for helping with content creation. These should be a part of vegastrike code-base, to keep things in sync and reduce maintenance.
* make proper xml mode default, remove code to parse obsolete xml-ish code.
* Get codebase stabilized in prep for refactoring graphics code.
* '''[OPEN]''' ''(safemode)'' new wormhole effects
* '''[OPEN]''' ''(safemode)'' improved ship AI
* '''[OPEN]''' ''(klauss)'' cleaning up unused mesh legacy formats (mesh_bin.cpp, ...)

'''VS Data'''

== 0.5.5 ==
'''VS Engine'''
* Refactor graphics code.
* ['''OPEN'''] (''ace123'') Make jump points be drawn on HUD only.

'''VS Data'''

== 0.5.6 ==
'''VS Engine'''
* Bug fixes.
* Texture additions/ etc
* Document refactored graphics and sound code.

'''VS Data'''

== 0.5.7 ==
'''VS Engine'''
* Thread graphics code and sound code with boost threads.
* Bug Fixing.

'''VS Data'''

== 0.5.9 ==
'''VS Engine'''
* sound refactoring Phase III would add environmental effects
* Bug Fixing.
* Documentation
* Credits

'''VS Data'''

== 0.6.0 ==
'''VS Engine'''
* Minor bug fixes from previous revision
* Packaging

'''VS Data'''
* documentation

[[Category:Roadmaps]]

Development:Roadmap:0.6.0

2011-05-03T22:07:58Z

Pyramid: /* 0.5.2 */

Vega Strike Upon the Coldest Sea stable version 0.5.0 was released on 2008-04-24.

This is a task list for intermediate 0.5.x releases. The stuff that should get done for each intermediate and until the 0.6.0 release.

=Generic Roadmap=
This roadmap is in need of further broken down into release specific tasks and assignment of those.

==Factions rework==
*Hierarchical factions (e.g. *_citizen, affects *)
*Allowing for non-factions (privateer is already our non-faction, we just need to fix some of the behavior.)
*Ability for player joining a faction

==AI==
*Faction-level AI (race / faction strategy)
*Micro AI (ship, fg, collision avoidance, tactical and navigational AI, roles definition)
*Macro (fg/faction)
* Flightgroups
** Classification (fleet, squadron, flotilla? etc. - something to differentiate between {5 plowshares} and {3 archimedes, 2 Tesla, 8 kahan, 20 schroedinger, 10 goddard, 5 watson} )
** Flightgroups should have subsets of ships that spawn together (combined arms)
* add another dimension to roles (attack AND defend/predator AND prey roles) instead of forcing both to be the same.
* AI spec drive use, escorts...

==Content Creation Tools==
*Prerequisite: straight XML, DTD (Document Type Definition) support
*System Editor
*Unit Editor
*CSV Editor (MPL, faction_ships.py, units.csv)
*Mission Editor
*Campaign Editor
*Config Editor

==Multiplayer==
*Persistence (systems, bases, flight groups, …)

==Building/Packaging==
*Move to cmake

==Documentation==
*Document the general function/flow of the game
*Engine internals, API (development documentation)
*Python bindings
*Should we use the builtin python documentation standards for documenting this stuff--maybe in the stubs folder?
*Faction documentation

==Engine rework==
*Audio subsystem overhaul
*Support for texture versions and normal map tangents
*Shader updates

=Release Roadmap=

There are up to three sections in each roadmap release chapter:
* '''VS Engine''' relates to: modifications to c++, shaders, and python code (not including missions), repository structure changes, packaging system, support tools, ogre version
* '''VS Data''' relates to: modifications to art, data, and mission scripts
* '''Other''' relates to: documentation, wiki, project web page, masters repository, project management

Each task item should also have a prefixed tag in the form of ['''STATUS'''{=OPEN, ONGOING, DONE}, development-coordinator{=''username''}]

== 0.5.1 ==

'''VS Engine'''
* '''[FINISHED]''' (''safemode'') Separate bin and data tree structure. Note: those who have data4.x already, set your client to not pull external repos or cancel when it tries to download data4.x. Then move your current data4.x alongside /bin, renaming it to data. Updates should work seamlessly and recurse into /data and /bin afterwards. Newcomers can just pull win32.
* '''[FINISHED]''' (''ace123'') Rename data4.x to data and patch corresponding source code where necessary.
* '''[FINISHED]''' (''safemode'') Make a high quality graphics texture pack (''hqtextures'').
* '''[FINISHED]''' (''safemode'') Preparation of a cross-platform packaging system (cmake)
* '''[FINISHED]''' (''pyramid'') Updates to the shader (commit chuck's unit shader)
* '''[FINISHED]''' (''pyramid'') Correct rings generation to be always in the same plane
* '''[FINISHED]''' (''pyramid'') Support for target shield gauges definition
* '''[FINISHED]''' (''klauss'') Add support for "TexturePackingVersion" variable in xmesh
* '''[FINISHED]''' (''klauss'') Add support for techniques and far z-buffering correction
* '''[FINISHED]''' (''klauss'') Tangent support for normal maps
* '''[FINISHED]''' (''klauss'') sound refactoring phase I - basic functionality
* '''[FINISHED]''' (''klauss'') movie support
* '''[FINISHED]''' (''klauss'') CubeMap engine support
* Minor bug fixes.
** '''[FINISHED]''' (''ace123'') fixed player relationship with each faction in savegame
** '''[FINISHED]''' (''pyramid'') planetary rings are always coplanar
** '''[FINISHED]''' (''pyramid'') system ownership (faction) and sector info shown in
RVDU and on map
** '''[FINISHED]''' (''pyramid'') python modules can be organized in additional subfolders (ai, mission, quests)
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data'''
* '''[FINISHED]''' (''safemode'') Added some textures to hqtextures.
* '''[FINISHED]''' (''pyramid'') 8 faces for armor HUD images
* '''[FINISHED]''' (''pyramid'') Higher pay for combat missions.
* '''[FINISHED]''' (''pyramid'') Tutorial mission
* '''[FINISHED]''' (''pyramid'') splash screen grouping in pre-load and load ani directories
* '''[FINISHED]''' (''pyramid'') additional art (planet backgrounds for lava, forest, rock, and frigid_mud, new space backgrounds, hud images)
* '''[FINISHED]''' (''pyramid'') partial extensions renaming (cockpits, sprites, backgrounds)
* '''[FINISHED]''' (''pyramid'') Visually enhanced target shield gauges
* '''[FINISHED]''' (''pyramid'') New and updated cargo and upgrade image contributions
* '''[FINISHED]''' (''pyramid'') Standardized factions coloring scheme
* '''[FINISHED]''' (''pyramid'') Units subdirectories for vessels and installations
* '''[FINISHED]''' (''pyramid'') Various new ship models (Kahan, Knight, Tridacna, ....) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Various new installation models (Rlaan, Uln, Shaper, ...) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Porting of old quests to new engine; done for: blockade, dispute, shipyard bomb, slaver, surplus

'''Documentation & Mod Tools & Other'''
* '''[FINISHED]''' (''pyramid'') Unit Converter OBJ->BFXM - a mesher frontend.
* '''[FINISHED]''' (''pyramid'') Re-organization of vessels model requirements on [[Development:3D_Models]].

== 0.5.1.5 ==

'''VS Engine'''
* '''[ONGOING]''' (''strook'') Implementing alpha version of VegaOgre, merging it into vegastrike.
the Ogre technology preview will be executable with '''vegastrike --with-ogre-engine''' until it is released.[http://vegastrike.sourceforge.net/forums/viewtopic.php?f=27&t=15545 see blog]

== 0.5.2 ==
'''VS Engine'''
* '''[OPEN]''' (''safemode'') Implement opcode's Ray Collider for ray-mesh collisions. (alongside bsp collider tunable via configure switch ala how opcode was done). Wont be turned on by default until 0.5.3
* '''[ONGOING]''' (''klauss'') More shader fixes, texture updates/additions.
* '''[OPEN]''' (''safemode'') Make tools and readers operate on a Proper XML format , this could be switchable via special comment at top of xml input. This is for backwards compat with non proper xml files in mods. To be made default in 0.5.5
* '''[OPEN]''' (''klauss'') sound refactoring Phase II would add mixer channels (a feature to get seamless blending with music, comm chatter and sfx)
* '''[OPEN]''' (''klauss'') put gfxlib into a class, or at the _very_least_ a namespace
* '''[ONGOING]''' (''chuck_starchaser'') CineMut shader family - v0.5
* '''[OPEN]''' (''strook'') Make VegaOgre Engine using vegastrike engine to implement gameplay with vegaogre.
* Minor bug fixes and improvements
** '''[FINISHED]''' (''pyramid'') Show, save, and load correct stardate
** '''[FINISHED]''' (''pyramid'') Corrected missing mission description for fixer missions
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data'''
* '''[ONGOING]''' (''pyramid'') Extensions renaming and standardization (.image, .texture, .sprite).
* '''[OPEN]''' ''(pyramid)'' Revision of planet types
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 0.5
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key

== 0.5.3 ==
'''VS Engine'''
* '''[OPEN]''' ''(safemode)'' Ray collider turned on, BSP stuff removed.
* '''[OPEN]''' ''(klauss)'' XGUI support for scripts
* '''[OPEN]''' ''(klauss)'' More shader fixes (should be pretty good by now), texture updates/additions
* '''[OPEN]''' ''(safemode)'' Continue to work on proper XML parsing in engine
* '''[OPEN]''' ''(safemode)'' update xml files in VS to be proper mode
* '''[OPEN]''' ''(safemode)'' setup tool
* '''[OPEN]''' (''chuck_starchaser'') CineMut shader family - v1.0

'''VS Data'''
* '''[OPEN]''' ''(pyramid)'' Create custom systems with Homeworlds for races and factions
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 1.0

== 0.5.4 ==
'''VS Engine'''
* '''[ONGOING SPECIFICATION]''' (''klauss, darkmage'') content creation tools: end user tools for helping with content creation. These should be a part of vegastrike code-base, to keep things in sync and reduce maintenance.
* make proper xml mode default, remove code to parse obsolete xml-ish code.
* Get codebase stabilized in prep for refactoring graphics code.
* '''[OPEN]''' ''(safemode)'' new wormhole effects
* '''[OPEN]''' ''(safemode)'' improved ship AI
* '''[OPEN]''' ''(klauss)'' cleaning up unused mesh legacy formats (mesh_bin.cpp, ...)

'''VS Data'''

== 0.5.5 ==
'''VS Engine'''
* Refactor graphics code.
* ['''OPEN'''] (''ace123'') Make jump points be drawn on HUD only.

'''VS Data'''

== 0.5.6 ==
'''VS Engine'''
* Bug fixes.
* Texture additions/ etc
* Document refactored graphics and sound code.

'''VS Data'''

== 0.5.7 ==
'''VS Engine'''
* Thread graphics code and sound code with boost threads.
* Bug Fixing.

'''VS Data'''

== 0.5.9 ==
'''VS Engine'''
* sound refactoring Phase III would add environmental effects
* Bug Fixing.
* Documentation
* Credits

'''VS Data'''

== 0.6.0 ==
'''VS Engine'''
* Minor bug fixes from previous revision
* Packaging

'''VS Data'''
* documentation

[[Category:Roadmaps]]

Development:Roadmap:0.6.0

2011-05-03T22:04:36Z

Pyramid: /* 0.5.1 */

Vega Strike Upon the Coldest Sea stable version 0.5.0 was released on 2008-04-24.

This is a task list for intermediate 0.5.x releases. The stuff that should get done for each intermediate and until the 0.6.0 release.

=Generic Roadmap=
This roadmap is in need of further broken down into release specific tasks and assignment of those.

==Factions rework==
*Hierarchical factions (e.g. *_citizen, affects *)
*Allowing for non-factions (privateer is already our non-faction, we just need to fix some of the behavior.)
*Ability for player joining a faction

==AI==
*Faction-level AI (race / faction strategy)
*Micro AI (ship, fg, collision avoidance, tactical and navigational AI, roles definition)
*Macro (fg/faction)
* Flightgroups
** Classification (fleet, squadron, flotilla? etc. - something to differentiate between {5 plowshares} and {3 archimedes, 2 Tesla, 8 kahan, 20 schroedinger, 10 goddard, 5 watson} )
** Flightgroups should have subsets of ships that spawn together (combined arms)
* add another dimension to roles (attack AND defend/predator AND prey roles) instead of forcing both to be the same.
* AI spec drive use, escorts...

==Content Creation Tools==
*Prerequisite: straight XML, DTD (Document Type Definition) support
*System Editor
*Unit Editor
*CSV Editor (MPL, faction_ships.py, units.csv)
*Mission Editor
*Campaign Editor
*Config Editor

==Multiplayer==
*Persistence (systems, bases, flight groups, …)

==Building/Packaging==
*Move to cmake

==Documentation==
*Document the general function/flow of the game
*Engine internals, API (development documentation)
*Python bindings
*Should we use the builtin python documentation standards for documenting this stuff--maybe in the stubs folder?
*Faction documentation

==Engine rework==
*Audio subsystem overhaul
*Support for texture versions and normal map tangents
*Shader updates

=Release Roadmap=

There are up to three sections in each roadmap release chapter:
* '''VS Engine''' relates to: modifications to c++, shaders, and python code (not including missions), repository structure changes, packaging system, support tools, ogre version
* '''VS Data''' relates to: modifications to art, data, and mission scripts
* '''Other''' relates to: documentation, wiki, project web page, masters repository, project management

Each task item should also have a prefixed tag in the form of ['''STATUS'''{=OPEN, ONGOING, DONE}, development-coordinator{=''username''}]

== 0.5.1 ==

'''VS Engine'''
* '''[FINISHED]''' (''safemode'') Separate bin and data tree structure. Note: those who have data4.x already, set your client to not pull external repos or cancel when it tries to download data4.x. Then move your current data4.x alongside /bin, renaming it to data. Updates should work seamlessly and recurse into /data and /bin afterwards. Newcomers can just pull win32.
* '''[FINISHED]''' (''ace123'') Rename data4.x to data and patch corresponding source code where necessary.
* '''[FINISHED]''' (''safemode'') Make a high quality graphics texture pack (''hqtextures'').
* '''[FINISHED]''' (''safemode'') Preparation of a cross-platform packaging system (cmake)
* '''[FINISHED]''' (''pyramid'') Updates to the shader (commit chuck's unit shader)
* '''[FINISHED]''' (''pyramid'') Correct rings generation to be always in the same plane
* '''[FINISHED]''' (''pyramid'') Support for target shield gauges definition
* '''[FINISHED]''' (''klauss'') Add support for "TexturePackingVersion" variable in xmesh
* '''[FINISHED]''' (''klauss'') Add support for techniques and far z-buffering correction
* '''[FINISHED]''' (''klauss'') Tangent support for normal maps
* '''[FINISHED]''' (''klauss'') sound refactoring phase I - basic functionality
* '''[FINISHED]''' (''klauss'') movie support
* '''[FINISHED]''' (''klauss'') CubeMap engine support
* Minor bug fixes.
** '''[FINISHED]''' (''ace123'') fixed player relationship with each faction in savegame
** '''[FINISHED]''' (''pyramid'') planetary rings are always coplanar
** '''[FINISHED]''' (''pyramid'') system ownership (faction) and sector info shown in
RVDU and on map
** '''[FINISHED]''' (''pyramid'') python modules can be organized in additional subfolders (ai, mission, quests)
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data'''
* '''[FINISHED]''' (''safemode'') Added some textures to hqtextures.
* '''[FINISHED]''' (''pyramid'') 8 faces for armor HUD images
* '''[FINISHED]''' (''pyramid'') Higher pay for combat missions.
* '''[FINISHED]''' (''pyramid'') Tutorial mission
* '''[FINISHED]''' (''pyramid'') splash screen grouping in pre-load and load ani directories
* '''[FINISHED]''' (''pyramid'') additional art (planet backgrounds for lava, forest, rock, and frigid_mud, new space backgrounds, hud images)
* '''[FINISHED]''' (''pyramid'') partial extensions renaming (cockpits, sprites, backgrounds)
* '''[FINISHED]''' (''pyramid'') Visually enhanced target shield gauges
* '''[FINISHED]''' (''pyramid'') New and updated cargo and upgrade image contributions
* '''[FINISHED]''' (''pyramid'') Standardized factions coloring scheme
* '''[FINISHED]''' (''pyramid'') Units subdirectories for vessels and installations
* '''[FINISHED]''' (''pyramid'') Various new ship models (Kahan, Knight, Tridacna, ....) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Various new installation models (Rlaan, Uln, Shaper, ...) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Porting of old quests to new engine; done for: blockade, dispute, shipyard bomb, slaver, surplus

'''Documentation & Mod Tools & Other'''
* '''[FINISHED]''' (''pyramid'') Unit Converter OBJ->BFXM - a mesher frontend.
* '''[FINISHED]''' (''pyramid'') Re-organization of vessels model requirements on [[Development:3D_Models]].

== 0.5.1.5 ==

'''VS Engine'''
* '''[ONGOING]''' (''strook'') Implementing alpha version of VegaOgre, merging it into vegastrike.
the Ogre technology preview will be executable with '''vegastrike --with-ogre-engine''' until it is released.[http://vegastrike.sourceforge.net/forums/viewtopic.php?f=27&t=15545 see blog]

== 0.5.2 ==
'''VS Engine'''
* '''[OPEN]''' (''safemode'') Implement opcode's Ray Collider for ray-mesh collisions. (alongside bsp collider tunable via configure switch ala how opcode was done). Wont be turned on by default until 0.5.3
* '''[OPEN]''' (''klauss'') More shader fixes, texture updates/additions.
* '''[OPEN]''' (''safemode'') Make tools and readers operate on a Proper XML format , this could be switchable via special comment at top of xml input. This is for backwards compat with non proper xml files in mods. To be made default in 0.5.5
* '''[OPEN]''' (''klauss'') sound refactoring Phase II would add mixer channels (a feature to get seamless blending with music, comm chatter and sfx)
* '''[OPEN]''' (''klauss'') put gfxlib into a class, or at the _very_least_ a namespace
* '''[ONGOING]''' (''chuck_starchaser'') CineMut shader family - v0.5
* '''[OPEN]''' (''strook'') Make VegaOgre Engine using vegastrike engine to implement gameplay with vegaogre.
'''VS Data'''
* '''[ONGOING]''' (''pyramid'') Extensions renaming and standardization (.image, .texture, .sprite).
* '''[OPEN]''' ''(pyramid)'' Revision of planet types
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 0.5
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key

== 0.5.3 ==
'''VS Engine'''
* '''[OPEN]''' ''(safemode)'' Ray collider turned on, BSP stuff removed.
* '''[OPEN]''' ''(klauss)'' XGUI support for scripts
* '''[OPEN]''' ''(klauss)'' More shader fixes (should be pretty good by now), texture updates/additions
* '''[OPEN]''' ''(safemode)'' Continue to work on proper XML parsing in engine
* '''[OPEN]''' ''(safemode)'' update xml files in VS to be proper mode
* '''[OPEN]''' ''(safemode)'' setup tool
* '''[OPEN]''' (''chuck_starchaser'') CineMut shader family - v1.0

'''VS Data'''
* '''[OPEN]''' ''(pyramid)'' Create custom systems with Homeworlds for races and factions
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 1.0

== 0.5.4 ==
'''VS Engine'''
* '''[ONGOING SPECIFICATION]''' (''klauss, darkmage'') content creation tools: end user tools for helping with content creation. These should be a part of vegastrike code-base, to keep things in sync and reduce maintenance.
* make proper xml mode default, remove code to parse obsolete xml-ish code.
* Get codebase stabilized in prep for refactoring graphics code.
* '''[OPEN]''' ''(safemode)'' new wormhole effects
* '''[OPEN]''' ''(safemode)'' improved ship AI
* '''[OPEN]''' ''(klauss)'' cleaning up unused mesh legacy formats (mesh_bin.cpp, ...)

'''VS Data'''

== 0.5.5 ==
'''VS Engine'''
* Refactor graphics code.
* ['''OPEN'''] (''ace123'') Make jump points be drawn on HUD only.

'''VS Data'''

== 0.5.6 ==
'''VS Engine'''
* Bug fixes.
* Texture additions/ etc
* Document refactored graphics and sound code.

'''VS Data'''

== 0.5.7 ==
'''VS Engine'''
* Thread graphics code and sound code with boost threads.
* Bug Fixing.

'''VS Data'''

== 0.5.9 ==
'''VS Engine'''
* sound refactoring Phase III would add environmental effects
* Bug Fixing.
* Documentation
* Credits

'''VS Data'''

== 0.6.0 ==
'''VS Engine'''
* Minor bug fixes from previous revision
* Packaging

'''VS Data'''
* documentation

[[Category:Roadmaps]]

Development:Roadmap:0.6.0

2011-05-03T21:58:53Z

Pyramid: /* 0.5.2 */

Vega Strike Upon the Coldest Sea stable version 0.5.0 was released on 2008-04-24.

This is a task list for intermediate 0.5.x releases. The stuff that should get done for each intermediate and until the 0.6.0 release.

=Generic Roadmap=
This roadmap is in need of further broken down into release specific tasks and assignment of those.

==Factions rework==
*Hierarchical factions (e.g. *_citizen, affects *)
*Allowing for non-factions (privateer is already our non-faction, we just need to fix some of the behavior.)
*Ability for player joining a faction

==AI==
*Faction-level AI (race / faction strategy)
*Micro AI (ship, fg, collision avoidance, tactical and navigational AI, roles definition)
*Macro (fg/faction)
* Flightgroups
** Classification (fleet, squadron, flotilla? etc. - something to differentiate between {5 plowshares} and {3 archimedes, 2 Tesla, 8 kahan, 20 schroedinger, 10 goddard, 5 watson} )
** Flightgroups should have subsets of ships that spawn together (combined arms)
* add another dimension to roles (attack AND defend/predator AND prey roles) instead of forcing both to be the same.
* AI spec drive use, escorts...

==Content Creation Tools==
*Prerequisite: straight XML, DTD (Document Type Definition) support
*System Editor
*Unit Editor
*CSV Editor (MPL, faction_ships.py, units.csv)
*Mission Editor
*Campaign Editor
*Config Editor

==Multiplayer==
*Persistence (systems, bases, flight groups, …)

==Building/Packaging==
*Move to cmake

==Documentation==
*Document the general function/flow of the game
*Engine internals, API (development documentation)
*Python bindings
*Should we use the builtin python documentation standards for documenting this stuff--maybe in the stubs folder?
*Faction documentation

==Engine rework==
*Audio subsystem overhaul
*Support for texture versions and normal map tangents
*Shader updates

=Release Roadmap=

There are up to three sections in each roadmap release chapter:
* '''VS Engine''' relates to: modifications to c++, shaders, and python code (not including missions), repository structure changes, packaging system, support tools, ogre version
* '''VS Data''' relates to: modifications to art, data, and mission scripts
* '''Other''' relates to: documentation, wiki, project web page, masters repository, project management

Each task item should also have a prefixed tag in the form of ['''STATUS'''{=OPEN, ONGOING, DONE}, development-coordinator{=''username''}]

== 0.5.1 ==

'''VS Engine'''
* '''[FINISHED]''' (''safemode'') Separate bin and data tree structure. Note: those who have data4.x already, set your client to not pull external repos or cancel when it tries to download data4.x. Then move your current data4.x alongside /bin, renaming it to data. Updates should work seamlessly and recurse into /data and /bin afterwards. Newcomers can just pull win32.
* '''[FINISHED]''' (''ace123'') Rename data4.x to data and patch corresponding source code where necessary.
* '''[FINISHED]''' (''safemode'') Make a high quality graphics texture pack (''hqtextures'').
* '''[FINISHED]''' (''safemode'') Preparation of a cross-platform packaging system (cmake)
* '''[FINISHED]''' (''pyramid'') Updates to the shader (commit chuck's unit shader)
* '''[FINISHED]''' (''pyramid'') Correct rings generation to be always in the same plane
* '''[FINISHED]''' (''pyramid'') Support for target shield gauges definition
* '''[FINISHED]''' (''klauss'') Add support for "TexturePackingVersion" variable in xmesh
* '''[FINISHED]''' (''klauss'') Add support for techniques and far z-buffering correction
* '''[FINISHED]''' (''klauss'') Tangent support for normal maps
* '''[FINISHED]''' (''klauss'') sound refactoring phase I - basic functionality
* '''[FINISHED]''' (''klauss'') movie support
* '''[FINISHED]''' (''klauss'') CubeMap engine support
* Minor bug fixes.
** '''[FINISHED]''' (''ace123'') fixed player relationship with each faction in savegame
** '''[FINISHED]''' (''pyramid'') planetary rings are always coplanar
** '''[FINISHED]''' (''pyramid'') system ownership (faction) and sector info shown in
RVDU and on map
** '''[FINISHED]''' (''pyramid'') python modules can be organized in additional subfolders (ai, mission, quests)
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data'''
* '''[FINISHED]''' (''safemode'') Added some textures to hqtextures.
* '''[FINISHED]''' (''pyramid'') 8 faces for armor HUD images
* '''[FINISHED]''' (''pyramid'') Higher pay for combat missions.
* '''[FINISHED]''' (''pyramid'') Tutorial mission
* '''[FINISHED]''' (''pyramid'') splash screen grouping in pre-load and load ani directories
* '''[FINISHED]''' (''pyramid'') additional art (planet backgrounds for lava, forest, rock, and frigid_mud, new space backgrounds, hud images)
* '''[FINISHED]''' (''pyramid'') partial extensions renaming (cockpits, sprites, backgrounds)
* '''[FINISHED]''' (''pyramid'') Visually enhanced target shield gauges
* '''[FINISHED]''' (''pyramid'') New and updated cargo and upgrade image contributions
* '''[FINISHED]''' (''pyramid'') Standardized factions coloring scheme
* '''[FINISHED]''' (''pyramid'') Units subdirectories for vessels and installations
* '''[FINISHED]''' (''pyramid'') Various new ship models (Kahan, Knight, Tridacna, ....) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Various new installation models (Rlaan, Uln, Shaper, ...) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Porting of old quests to new engine; done for: blockade, dispute, shipyard bomb, slaver, surplus

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key was replaced with D.
* '''[FINISHED]''' (''pyramid'') Unit Converter OBJ->BFXM - a mesher frontend.
* '''[FINISHED]''' (''pyramid'') Re-organization of vessels model requirements on [[Development:3D_Models]].

== 0.5.1.5 ==

'''VS Engine'''
* '''[ONGOING]''' (''strook'') Implementing alpha version of VegaOgre, merging it into vegastrike.
the Ogre technology preview will be executable with '''vegastrike --with-ogre-engine''' until it is released.[http://vegastrike.sourceforge.net/forums/viewtopic.php?f=27&t=15545 see blog]

== 0.5.2 ==
'''VS Engine'''
* '''[OPEN]''' (''safemode'') Implement opcode's Ray Collider for ray-mesh collisions. (alongside bsp collider tunable via configure switch ala how opcode was done). Wont be turned on by default until 0.5.3
* '''[OPEN]''' (''klauss'') More shader fixes, texture updates/additions.
* '''[OPEN]''' (''safemode'') Make tools and readers operate on a Proper XML format , this could be switchable via special comment at top of xml input. This is for backwards compat with non proper xml files in mods. To be made default in 0.5.5
* '''[OPEN]''' (''klauss'') sound refactoring Phase II would add mixer channels (a feature to get seamless blending with music, comm chatter and sfx)
* '''[OPEN]''' (''klauss'') put gfxlib into a class, or at the _very_least_ a namespace
* '''[ONGOING]''' (''chuck_starchaser'') CineMut shader family - v0.5
* '''[OPEN]''' (''strook'') Make VegaOgre Engine using vegastrike engine to implement gameplay with vegaogre.
'''VS Data'''
* '''[ONGOING]''' (''pyramid'') Extensions renaming and standardization (.image, .texture, .sprite).
* '''[OPEN]''' ''(pyramid)'' Revision of planet types
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 0.5
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key

== 0.5.3 ==
'''VS Engine'''
* '''[OPEN]''' ''(safemode)'' Ray collider turned on, BSP stuff removed.
* '''[OPEN]''' ''(klauss)'' XGUI support for scripts
* '''[OPEN]''' ''(klauss)'' More shader fixes (should be pretty good by now), texture updates/additions
* '''[OPEN]''' ''(safemode)'' Continue to work on proper XML parsing in engine
* '''[OPEN]''' ''(safemode)'' update xml files in VS to be proper mode
* '''[OPEN]''' ''(safemode)'' setup tool
* '''[OPEN]''' (''chuck_starchaser'') CineMut shader family - v1.0

'''VS Data'''
* '''[OPEN]''' ''(pyramid)'' Create custom systems with Homeworlds for races and factions
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 1.0

== 0.5.4 ==
'''VS Engine'''
* '''[ONGOING SPECIFICATION]''' (''klauss, darkmage'') content creation tools: end user tools for helping with content creation. These should be a part of vegastrike code-base, to keep things in sync and reduce maintenance.
* make proper xml mode default, remove code to parse obsolete xml-ish code.
* Get codebase stabilized in prep for refactoring graphics code.
* '''[OPEN]''' ''(safemode)'' new wormhole effects
* '''[OPEN]''' ''(safemode)'' improved ship AI
* '''[OPEN]''' ''(klauss)'' cleaning up unused mesh legacy formats (mesh_bin.cpp, ...)

'''VS Data'''

== 0.5.5 ==
'''VS Engine'''
* Refactor graphics code.
* ['''OPEN'''] (''ace123'') Make jump points be drawn on HUD only.

'''VS Data'''

== 0.5.6 ==
'''VS Engine'''
* Bug fixes.
* Texture additions/ etc
* Document refactored graphics and sound code.

'''VS Data'''

== 0.5.7 ==
'''VS Engine'''
* Thread graphics code and sound code with boost threads.
* Bug Fixing.

'''VS Data'''

== 0.5.9 ==
'''VS Engine'''
* sound refactoring Phase III would add environmental effects
* Bug Fixing.
* Documentation
* Credits

'''VS Data'''

== 0.6.0 ==
'''VS Engine'''
* Minor bug fixes from previous revision
* Packaging

'''VS Data'''
* documentation

[[Category:Roadmaps]]

Development:Roadmap:0.6.0

2011-05-03T21:58:38Z

Pyramid: /* 0.5.1 */

Vega Strike Upon the Coldest Sea stable version 0.5.0 was released on 2008-04-24.

This is a task list for intermediate 0.5.x releases. The stuff that should get done for each intermediate and until the 0.6.0 release.

=Generic Roadmap=
This roadmap is in need of further broken down into release specific tasks and assignment of those.

==Factions rework==
*Hierarchical factions (e.g. *_citizen, affects *)
*Allowing for non-factions (privateer is already our non-faction, we just need to fix some of the behavior.)
*Ability for player joining a faction

==AI==
*Faction-level AI (race / faction strategy)
*Micro AI (ship, fg, collision avoidance, tactical and navigational AI, roles definition)
*Macro (fg/faction)
* Flightgroups
** Classification (fleet, squadron, flotilla? etc. - something to differentiate between {5 plowshares} and {3 archimedes, 2 Tesla, 8 kahan, 20 schroedinger, 10 goddard, 5 watson} )
** Flightgroups should have subsets of ships that spawn together (combined arms)
* add another dimension to roles (attack AND defend/predator AND prey roles) instead of forcing both to be the same.
* AI spec drive use, escorts...

==Content Creation Tools==
*Prerequisite: straight XML, DTD (Document Type Definition) support
*System Editor
*Unit Editor
*CSV Editor (MPL, faction_ships.py, units.csv)
*Mission Editor
*Campaign Editor
*Config Editor

==Multiplayer==
*Persistence (systems, bases, flight groups, …)

==Building/Packaging==
*Move to cmake

==Documentation==
*Document the general function/flow of the game
*Engine internals, API (development documentation)
*Python bindings
*Should we use the builtin python documentation standards for documenting this stuff--maybe in the stubs folder?
*Faction documentation

==Engine rework==
*Audio subsystem overhaul
*Support for texture versions and normal map tangents
*Shader updates

=Release Roadmap=

There are up to three sections in each roadmap release chapter:
* '''VS Engine''' relates to: modifications to c++, shaders, and python code (not including missions), repository structure changes, packaging system, support tools, ogre version
* '''VS Data''' relates to: modifications to art, data, and mission scripts
* '''Other''' relates to: documentation, wiki, project web page, masters repository, project management

Each task item should also have a prefixed tag in the form of ['''STATUS'''{=OPEN, ONGOING, DONE}, development-coordinator{=''username''}]

== 0.5.1 ==

'''VS Engine'''
* '''[FINISHED]''' (''safemode'') Separate bin and data tree structure. Note: those who have data4.x already, set your client to not pull external repos or cancel when it tries to download data4.x. Then move your current data4.x alongside /bin, renaming it to data. Updates should work seamlessly and recurse into /data and /bin afterwards. Newcomers can just pull win32.
* '''[FINISHED]''' (''ace123'') Rename data4.x to data and patch corresponding source code where necessary.
* '''[FINISHED]''' (''safemode'') Make a high quality graphics texture pack (''hqtextures'').
* '''[FINISHED]''' (''safemode'') Preparation of a cross-platform packaging system (cmake)
* '''[FINISHED]''' (''pyramid'') Updates to the shader (commit chuck's unit shader)
* '''[FINISHED]''' (''pyramid'') Correct rings generation to be always in the same plane
* '''[FINISHED]''' (''pyramid'') Support for target shield gauges definition
* '''[FINISHED]''' (''klauss'') Add support for "TexturePackingVersion" variable in xmesh
* '''[FINISHED]''' (''klauss'') Add support for techniques and far z-buffering correction
* '''[FINISHED]''' (''klauss'') Tangent support for normal maps
* '''[FINISHED]''' (''klauss'') sound refactoring phase I - basic functionality
* '''[FINISHED]''' (''klauss'') movie support
* '''[FINISHED]''' (''klauss'') CubeMap engine support
* Minor bug fixes.
** '''[FINISHED]''' (''ace123'') fixed player relationship with each faction in savegame
** '''[FINISHED]''' (''pyramid'') planetary rings are always coplanar
** '''[FINISHED]''' (''pyramid'') system ownership (faction) and sector info shown in
RVDU and on map
** '''[FINISHED]''' (''pyramid'') python modules can be organized in additional subfolders (ai, mission, quests)
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data'''
* '''[FINISHED]''' (''safemode'') Added some textures to hqtextures.
* '''[FINISHED]''' (''pyramid'') 8 faces for armor HUD images
* '''[FINISHED]''' (''pyramid'') Higher pay for combat missions.
* '''[FINISHED]''' (''pyramid'') Tutorial mission
* '''[FINISHED]''' (''pyramid'') splash screen grouping in pre-load and load ani directories
* '''[FINISHED]''' (''pyramid'') additional art (planet backgrounds for lava, forest, rock, and frigid_mud, new space backgrounds, hud images)
* '''[FINISHED]''' (''pyramid'') partial extensions renaming (cockpits, sprites, backgrounds)
* '''[FINISHED]''' (''pyramid'') Visually enhanced target shield gauges
* '''[FINISHED]''' (''pyramid'') New and updated cargo and upgrade image contributions
* '''[FINISHED]''' (''pyramid'') Standardized factions coloring scheme
* '''[FINISHED]''' (''pyramid'') Units subdirectories for vessels and installations
* '''[FINISHED]''' (''pyramid'') Various new ship models (Kahan, Knight, Tridacna, ....) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Various new installation models (Rlaan, Uln, Shaper, ...) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Porting of old quests to new engine; done for: blockade, dispute, shipyard bomb, slaver, surplus

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key was replaced with D.
* '''[FINISHED]''' (''pyramid'') Unit Converter OBJ->BFXM - a mesher frontend.
* '''[FINISHED]''' (''pyramid'') Re-organization of vessels model requirements on [[Development:3D_Models]].

== 0.5.1.5 ==

'''VS Engine'''
* '''[ONGOING]''' (''strook'') Implementing alpha version of VegaOgre, merging it into vegastrike.
the Ogre technology preview will be executable with '''vegastrike --with-ogre-engine''' until it is released.[http://vegastrike.sourceforge.net/forums/viewtopic.php?f=27&t=15545 see blog]

== 0.5.2 ==
'''VS Engine'''
* '''[OPEN]''' (''safemode'') Implement opcode's Ray Collider for ray-mesh collisions. (alongside bsp collider tunable via configure switch ala how opcode was done). Wont be turned on by default until 0.5.3
* '''[OPEN]''' (''klauss'') More shader fixes, texture updates/additions.
* '''[OPEN]''' (''safemode'') Make tools and readers operate on a Proper XML format , this could be switchable via special comment at top of xml input. This is for backwards compat with non proper xml files in mods. To be made default in 0.5.5
* '''[OPEN]''' (''klauss'') sound refactoring Phase II would add mixer channels (a feature to get seamless blending with music, comm chatter and sfx)
* '''[OPEN]''' (''klauss'') put gfxlib into a class, or at the _very_least_ a namespace
* '''[ONGOING]''' (''chuck_starchaser'') CineMut shader family - v0.5
* '''[OPEN]''' (''strook'') Make VegaOgre Engine using vegastrike engine to implement gameplay with vegaogre.
'''VS Data'''
* '''[ONGOING]''' (''pyramid'') Extensions renaming and standardization (.image, .texture, .sprite).
* '''[OPEN]''' ''(pyramid)'' Revision of planet types
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 0.5
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine

== 0.5.3 ==
'''VS Engine'''
* '''[OPEN]''' ''(safemode)'' Ray collider turned on, BSP stuff removed.
* '''[OPEN]''' ''(klauss)'' XGUI support for scripts
* '''[OPEN]''' ''(klauss)'' More shader fixes (should be pretty good by now), texture updates/additions
* '''[OPEN]''' ''(safemode)'' Continue to work on proper XML parsing in engine
* '''[OPEN]''' ''(safemode)'' update xml files in VS to be proper mode
* '''[OPEN]''' ''(safemode)'' setup tool
* '''[OPEN]''' (''chuck_starchaser'') CineMut shader family - v1.0

'''VS Data'''
* '''[OPEN]''' ''(pyramid)'' Create custom systems with Homeworlds for races and factions
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 1.0

== 0.5.4 ==
'''VS Engine'''
* '''[ONGOING SPECIFICATION]''' (''klauss, darkmage'') content creation tools: end user tools for helping with content creation. These should be a part of vegastrike code-base, to keep things in sync and reduce maintenance.
* make proper xml mode default, remove code to parse obsolete xml-ish code.
* Get codebase stabilized in prep for refactoring graphics code.
* '''[OPEN]''' ''(safemode)'' new wormhole effects
* '''[OPEN]''' ''(safemode)'' improved ship AI
* '''[OPEN]''' ''(klauss)'' cleaning up unused mesh legacy formats (mesh_bin.cpp, ...)

'''VS Data'''

== 0.5.5 ==
'''VS Engine'''
* Refactor graphics code.
* ['''OPEN'''] (''ace123'') Make jump points be drawn on HUD only.

'''VS Data'''

== 0.5.6 ==
'''VS Engine'''
* Bug fixes.
* Texture additions/ etc
* Document refactored graphics and sound code.

'''VS Data'''

== 0.5.7 ==
'''VS Engine'''
* Thread graphics code and sound code with boost threads.
* Bug Fixing.

'''VS Data'''

== 0.5.9 ==
'''VS Engine'''
* sound refactoring Phase III would add environmental effects
* Bug Fixing.
* Documentation
* Credits

'''VS Data'''

== 0.6.0 ==
'''VS Engine'''
* Minor bug fixes from previous revision
* Packaging

'''VS Data'''
* documentation

[[Category:Roadmaps]]

Development:Roadmap:0.6.0

2011-05-03T21:57:38Z

Pyramid: /* 0.5.2 */

Vega Strike Upon the Coldest Sea stable version 0.5.0 was released on 2008-04-24.

This is a task list for intermediate 0.5.x releases. The stuff that should get done for each intermediate and until the 0.6.0 release.

=Generic Roadmap=
This roadmap is in need of further broken down into release specific tasks and assignment of those.

==Factions rework==
*Hierarchical factions (e.g. *_citizen, affects *)
*Allowing for non-factions (privateer is already our non-faction, we just need to fix some of the behavior.)
*Ability for player joining a faction

==AI==
*Faction-level AI (race / faction strategy)
*Micro AI (ship, fg, collision avoidance, tactical and navigational AI, roles definition)
*Macro (fg/faction)
* Flightgroups
** Classification (fleet, squadron, flotilla? etc. - something to differentiate between {5 plowshares} and {3 archimedes, 2 Tesla, 8 kahan, 20 schroedinger, 10 goddard, 5 watson} )
** Flightgroups should have subsets of ships that spawn together (combined arms)
* add another dimension to roles (attack AND defend/predator AND prey roles) instead of forcing both to be the same.
* AI spec drive use, escorts...

==Content Creation Tools==
*Prerequisite: straight XML, DTD (Document Type Definition) support
*System Editor
*Unit Editor
*CSV Editor (MPL, faction_ships.py, units.csv)
*Mission Editor
*Campaign Editor
*Config Editor

==Multiplayer==
*Persistence (systems, bases, flight groups, …)

==Building/Packaging==
*Move to cmake

==Documentation==
*Document the general function/flow of the game
*Engine internals, API (development documentation)
*Python bindings
*Should we use the builtin python documentation standards for documenting this stuff--maybe in the stubs folder?
*Faction documentation

==Engine rework==
*Audio subsystem overhaul
*Support for texture versions and normal map tangents
*Shader updates

=Release Roadmap=

There are up to three sections in each roadmap release chapter:
* '''VS Engine''' relates to: modifications to c++, shaders, and python code (not including missions), repository structure changes, packaging system, support tools, ogre version
* '''VS Data''' relates to: modifications to art, data, and mission scripts
* '''Other''' relates to: documentation, wiki, project web page, masters repository, project management

Each task item should also have a prefixed tag in the form of ['''STATUS'''{=OPEN, ONGOING, DONE}, development-coordinator{=''username''}]

== 0.5.1 ==

'''VS Engine'''
* '''[FINISHED]''' (''safemode'') Separate bin and data tree structure. Note: those who have data4.x already, set your client to not pull external repos or cancel when it tries to download data4.x. Then move your current data4.x alongside /bin, renaming it to data. Updates should work seamlessly and recurse into /data and /bin afterwards. Newcomers can just pull win32.
* '''[FINISHED]''' (''ace123'') Rename data4.x to data and patch corresponding source code where necessary.
* '''[FINISHED]''' (''safemode'') Make a high quality graphics texture pack (''hqtextures'').
* '''[FINISHED]''' (''safemode'') Preparation of a cross-platform packaging system (cmake)
* '''[FINISHED]''' (''pyramid'') Updates to the shader (commit chuck's unit shader)
* '''[FINISHED]''' (''pyramid'') Correct rings generation to be always in the same plane
* '''[FINISHED]''' (''pyramid'') Support for target shield gauges definition
* '''[FINISHED]''' (''klauss'') Add support for "TexturePackingVersion" variable in xmesh
* '''[FINISHED]''' (''klauss'') Add support for techniques and far z-buffering correction
* '''[FINISHED]''' (''klauss'') Tangent support for normal maps
* '''[FINISHED]''' (''klauss'') sound refactoring phase I - basic functionality
* '''[FINISHED]''' (''klauss'') movie support
* '''[FINISHED]''' (''klauss'') CubeMap engine support
* Minor bug fixes.
** '''[FINISHED]''' (''ace123'') fixed player relationship with each faction in savegame
** '''[FINISHED]''' (''pyramid'') planetary rings are always coplanar
** '''[FINISHED]''' (''pyramid'') system ownership (faction) and sector info shown in
RVDU and on map
** '''[FINISHED]''' (''pyramid'') python modules can be organized in additional subfolders (ai, mission, quests)
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data'''
* '''[FINISHED]''' (''safemode'') Added some textures to hqtextures.
* '''[FINISHED]''' (''pyramid'') 8 faces for armor HUD images
* '''[FINISHED]''' (''pyramid'') Higher pay for combat missions.
* '''[FINISHED]''' (''pyramid'') Tutorial mission
* '''[FINISHED]''' (''pyramid'') splash screen grouping in pre-load and load ani directories
* '''[FINISHED]''' (''pyramid'') additional art (planet backgrounds for lava, forest, rock, and frigid_mud, new space backgrounds, hud images)
* '''[FINISHED]''' (''pyramid'') partial extensions renaming (cockpits, sprites, backgrounds)
* '''[FINISHED]''' (''pyramid'') Visually enhanced target shield gauges
* '''[FINISHED]''' (''pyramid'') New and updated cargo and upgrade image contributions
* '''[FINISHED]''' (''pyramid'') Standardized factions coloring scheme
* '''[FINISHED]''' (''pyramid'') Units subdirectories for vessels and installations
* '''[FINISHED]''' (''pyramid'') Various new ship models (Kahan, Knight, Tridacna, ....) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Various new installation models (Rlaan, Uln, Shaper, ...) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine (done: blockade, dispute, shipyard bomb, slaver, surplus)

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key was replaced with D.
* '''[FINISHED]''' (''pyramid'') Unit Converter OBJ->BFXM - a mesher frontend.
* '''[FINISHED]''' (''pyramid'') Re-organization of vessels model requirements on [[Development:3D_Models]].

== 0.5.1.5 ==

'''VS Engine'''
* '''[ONGOING]''' (''strook'') Implementing alpha version of VegaOgre, merging it into vegastrike.
the Ogre technology preview will be executable with '''vegastrike --with-ogre-engine''' until it is released.[http://vegastrike.sourceforge.net/forums/viewtopic.php?f=27&t=15545 see blog]

== 0.5.2 ==
'''VS Engine'''
* '''[OPEN]''' (''safemode'') Implement opcode's Ray Collider for ray-mesh collisions. (alongside bsp collider tunable via configure switch ala how opcode was done). Wont be turned on by default until 0.5.3
* '''[OPEN]''' (''klauss'') More shader fixes, texture updates/additions.
* '''[OPEN]''' (''safemode'') Make tools and readers operate on a Proper XML format , this could be switchable via special comment at top of xml input. This is for backwards compat with non proper xml files in mods. To be made default in 0.5.5
* '''[OPEN]''' (''klauss'') sound refactoring Phase II would add mixer channels (a feature to get seamless blending with music, comm chatter and sfx)
* '''[OPEN]''' (''klauss'') put gfxlib into a class, or at the _very_least_ a namespace
* '''[ONGOING]''' (''chuck_starchaser'') CineMut shader family - v0.5
* '''[OPEN]''' (''strook'') Make VegaOgre Engine using vegastrike engine to implement gameplay with vegaogre.
'''VS Data'''
* '''[ONGOING]''' (''pyramid'') Extensions renaming and standardization (.image, .texture, .sprite).
* '''[OPEN]''' ''(pyramid)'' Revision of planet types
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 0.5
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine

== 0.5.3 ==
'''VS Engine'''
* '''[OPEN]''' ''(safemode)'' Ray collider turned on, BSP stuff removed.
* '''[OPEN]''' ''(klauss)'' XGUI support for scripts
* '''[OPEN]''' ''(klauss)'' More shader fixes (should be pretty good by now), texture updates/additions
* '''[OPEN]''' ''(safemode)'' Continue to work on proper XML parsing in engine
* '''[OPEN]''' ''(safemode)'' update xml files in VS to be proper mode
* '''[OPEN]''' ''(safemode)'' setup tool
* '''[OPEN]''' (''chuck_starchaser'') CineMut shader family - v1.0

'''VS Data'''
* '''[OPEN]''' ''(pyramid)'' Create custom systems with Homeworlds for races and factions
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 1.0

== 0.5.4 ==
'''VS Engine'''
* '''[ONGOING SPECIFICATION]''' (''klauss, darkmage'') content creation tools: end user tools for helping with content creation. These should be a part of vegastrike code-base, to keep things in sync and reduce maintenance.
* make proper xml mode default, remove code to parse obsolete xml-ish code.
* Get codebase stabilized in prep for refactoring graphics code.
* '''[OPEN]''' ''(safemode)'' new wormhole effects
* '''[OPEN]''' ''(safemode)'' improved ship AI
* '''[OPEN]''' ''(klauss)'' cleaning up unused mesh legacy formats (mesh_bin.cpp, ...)

'''VS Data'''

== 0.5.5 ==
'''VS Engine'''
* Refactor graphics code.
* ['''OPEN'''] (''ace123'') Make jump points be drawn on HUD only.

'''VS Data'''

== 0.5.6 ==
'''VS Engine'''
* Bug fixes.
* Texture additions/ etc
* Document refactored graphics and sound code.

'''VS Data'''

== 0.5.7 ==
'''VS Engine'''
* Thread graphics code and sound code with boost threads.
* Bug Fixing.

'''VS Data'''

== 0.5.9 ==
'''VS Engine'''
* sound refactoring Phase III would add environmental effects
* Bug Fixing.
* Documentation
* Credits

'''VS Data'''

== 0.6.0 ==
'''VS Engine'''
* Minor bug fixes from previous revision
* Packaging

'''VS Data'''
* documentation

[[Category:Roadmaps]]

Vegastrike:Project

2011-04-30T00:59:27Z

Pyramid: /* On The Web */

Project Information

=About=
Vega Strike is an Open Source 3d Space Simulator. Work is proceeding on both the Vega Strike game engine and a Vega Strike Universe game data set. Both, engine and data, are in a playable state, but under continuous development.

The Vega Strike engine serves as the foundation for the Parallel Universe, Privateer Gemini Gold, Privateer Remake, Vega Trek, and Pi Armada projects, whose websites can be reached via the sidebar to the right on the project web page.

= Vision =

We enjoy the futuristic genre, and we enjoy creating content for this genre in an interesting, vast, and profoundly complex but believable universe with endless expansion and enhancement possibilities.

We want to create a generic, open, and free space simulator game of outstanding quality, both in technology and content.

We want to be the vehicle for the creation and recreation of other space games and provide the possibility for users to create their own stories.

= Mission =

We have three development drivers:
* The Vega Strike Game
* The Modding capability
* The Engine that enables both

VS (the engine) is a vehicle for groups of people to produce content in a set of genres that they enjoy creating and playing.

The particular universe (VS game) that the Minister of Information (jackS) has been working on for some time now should be the target game, to help focus and separate required features from nice features. We also want to create an entangling, profound, and believable space game whose story is set in the Vega Strike Universe.

We want to maintain close relationship with and provide to the freedom loving community a moddable open source space simulation engine that can be used to create other independent space games.

We develop feature sets for the underlying content that requires those features: a campaign, a story, a well defined economy model, well defined game play mechanics, modding requirements.

Our approach is not myopic because of a particular perception as to what resources/technology will be available.

Users can write their own stories for the universe and share them around - and if they're good we can include them as well. Think of it as universe supporting easy-to-make fan-fiction (which can include mod-based fiction).

Factions are given the ability to make their own decisions ... God's (campaign) commands are suggestions ... the campaign evolves as the players force it, and the goals need to be written to handle that.

Shortly, Vega Strike will become a space combat/simulator game and engine with fully dynamic universe creation, scriptable ai responses with dynamic decision ability, completely non-determinant campaigns, fully functional economic system that responds to the real-time gameplay state of
the universe, shader-fied openGL graphics with nifty special effects.

"One universe, infinite possibilities"

= Features =

See [[Vegastrike:Features]]

= Active Development Team =

== Project Leads and Lead Developers ==
* Daniel R Horn aka ''hellcatv'',''danielrh'' (overall coordination, lead programming, ...)
* Patrick Horn aka ''ace123'' (lead development, multiplayer, python, forum support)
* Jack Sampson aka ''jackS'' (Minister of Information, VS Universe development, art directing)

== Programmers and Developers ==
* Claudio Freire aka ''klauss'', ''klausfreire'' (engine and python development)
* Ed Sweetman aka ''safemode'' (engine development)
* aka ''pyramid'', ''pyramid3d'' (art development, python scripting, documentation)

== Developers and Contributors ==

There are also developers that have in the past but do not contribute actively at this moment. Those are listed in the credits.

Besides the developers, there is a large number of contributors from the community, be it for the engine or art and other content type for VS game.

And not to forget the modders, who give significant direction and contribution to engine development.

See: [[Vegastrike:Credits]]

= Artistic Organization =
This is the artistic organization for unit model (ships, bases) development in Vega Strike - Upon The Coldest Sea.

'''Art Director''' - provides the design briefs, gives the model final approval before it goes into the game.
* jackS

'''Art Administrator''' - knows what models go where, organizes the wiki, prioritizes development
* pyramid

'''Technical Liaison''' - tells artists what to do with regard to technical stuff
* chuck_starchaser

'''Concept Artists''' - come up with concept art
* Fendorin

'''Modeling Artists''' - model the ships and other assets
* Fendorin - senior modeling artists
* Deus Siddis
* rivalin

'''Texture Artists''' - texture the ships and stations
* Fendorin - senior texture artists

'''Voice Artists''' - provide speech voices
* [[User:Turbo|Turbo]] (tutorial quest voice, alien speech audio)
* CLoneWolf (andolian speech audio)

'''Data Integrators''' - contributors that integrate the models into the game data, fill in missing simple textures and placeholders, do file format conversions
* jackS
* esgaroth
* pyramid

'''Front End Artist''' - does overlays, wallpapers, screen savers, renders, runs the ModDB page, a deviantart page, conceptart.org thread, Game-Artist.net thread
* rivalin

= Project Setup =

== Open Source Principles ==

We often hear the complaint that features don't get implemented for a long time though they are being requested over and over again.

Being an open source community, most developers or contributors have their day-time jobs or commitments. Time is a scarce resource for those people and naturally they tend to prioritize their work on things that they are personally most interested in. Active developers do not dictate what gets contributed and what doesn't. The dictate is solely coming from contributions.

The really best way to see a particular feature implemented quickly is to pull up your sleeves and start implementing them, first integrating with your local VS copy, and when a particular feature is working satisfactory, submit it to one of the active developers for inclusion. Bear in mind that only, and only working code will get committed fast. If code or data needs additional work it will most certainly have to wait either for developer time or interest.

In this way, contributors who submit a lot will become developers.

Don't know how and what to contribute? Have a look at the [[HowTo:Contribute]] page for a starter.

== Communication Structure ==

Developers communicate between themselves on a need basis via forum personal messages, email, and irc. In addition there are frequent project meetings scheduled to discuss online ongoing developments.

In addition, we communicate with the community primarily through the forum, the web page, the dev blogs, the wiki, and equally through pm's and irc.

= History =

I read it somewhere but can't find the text right now.

In any case, it was ''hellcatv'' who started it all. The first news entry on the project page is from March 1, 1998 with news about flight engine completion, basic AI functionality, and 4 available ships. This suggests that development was going on already before that time.

= On The Web =

* [http://en.wikipedia.org/wiki/Vega_Strike Vega Strike] Wikipedia entry.
* [http://www.youtube.com/results?search_query=Vega+Strike&aq=f VS on YouTube].
* [http://www.facebook.com/pages/Vega-Strike/112577708757768 Vega Strike] on facebook.
* [http://www.linuxlinks.com/article/20080523214626193/VegaStrike.html Vega Strike] on linuxlinks.com.
* [http://www.onlylinuxgames.com/vega-strike/ Vega Strike] on OnlyLinuxGames.
* 2010: [http://www.makeuseof.com/tag/space-adventures-vega-strike/ Go On Space Adventures With Vega Strike] in makeuseof.
2010: [http://www.dodownload.com/games/simulator/vega+strike.html Vega Strike 0.5] on dodownload.
* 2009: [http://blog.eracc.com/2009/09/24/gnulinux-gaming-vega-strike-for-all/ GNU/Linux Gaming – Vega Strike for All] on The ERACC Web Log.
* 2009: [http://www.webupd8.org/2009/10/free-open-source-space-simulation-game.html Vega Strike: Free, Open Source Space Simulation Game for Windows, Linux and Mac OSX].
* 2009 (DE): [http://www.linux-community.de/Internal/Artikel/Online-Artikel/Das-Spiel-zum-Wochenende-Vega-Strike Das Spiel zum Wochenende: Vega Strike ] on linux-community.
* 2007: [http://www.freesoftwaremagazine.com/articles/vegastrike Vega Strike - My kind of fun] in the [http://www.freesoftwaremagazine.com/ Free Software Magazine]
* 2003: [http://www.insidemacgames.com/news/story.php?ArticleID=6826 Vega Strike Released for Mac OS X] on insidemacgames.
* [http://tvtropes.org/pmwiki/pmwiki.php/Main/VegaStrike Vega Strike] on tvtropes.
* [http://linux.about.com/od/softgame/fr/fr_VegaS.htm Linux Game: Vega Strike] on About.com.
* [http://www.reloaded.org/download/Vega-Strike/40/ Vega Strike] on reloaded.org.
* [http://www.absoluteastronomy.com/topics/Vega_Strike Vega Strike] on absoluteastronomy.

= Roadmap =
See [[Development:Roadmap]]

Vegastrike:Project

2011-04-30T00:18:43Z

Pyramid: /* On The Web */

Project Information

=About=
Vega Strike is an Open Source 3d Space Simulator. Work is proceeding on both the Vega Strike game engine and a Vega Strike Universe game data set. Both, engine and data, are in a playable state, but under continuous development.

The Vega Strike engine serves as the foundation for the Parallel Universe, Privateer Gemini Gold, Privateer Remake, Vega Trek, and Pi Armada projects, whose websites can be reached via the sidebar to the right on the project web page.

= Vision =

We enjoy the futuristic genre, and we enjoy creating content for this genre in an interesting, vast, and profoundly complex but believable universe with endless expansion and enhancement possibilities.

We want to create a generic, open, and free space simulator game of outstanding quality, both in technology and content.

We want to be the vehicle for the creation and recreation of other space games and provide the possibility for users to create their own stories.

= Mission =

We have three development drivers:
* The Vega Strike Game
* The Modding capability
* The Engine that enables both

VS (the engine) is a vehicle for groups of people to produce content in a set of genres that they enjoy creating and playing.

The particular universe (VS game) that the Minister of Information (jackS) has been working on for some time now should be the target game, to help focus and separate required features from nice features. We also want to create an entangling, profound, and believable space game whose story is set in the Vega Strike Universe.

We want to maintain close relationship with and provide to the freedom loving community a moddable open source space simulation engine that can be used to create other independent space games.

We develop feature sets for the underlying content that requires those features: a campaign, a story, a well defined economy model, well defined game play mechanics, modding requirements.

Our approach is not myopic because of a particular perception as to what resources/technology will be available.

Users can write their own stories for the universe and share them around - and if they're good we can include them as well. Think of it as universe supporting easy-to-make fan-fiction (which can include mod-based fiction).

Factions are given the ability to make their own decisions ... God's (campaign) commands are suggestions ... the campaign evolves as the players force it, and the goals need to be written to handle that.

Shortly, Vega Strike will become a space combat/simulator game and engine with fully dynamic universe creation, scriptable ai responses with dynamic decision ability, completely non-determinant campaigns, fully functional economic system that responds to the real-time gameplay state of
the universe, shader-fied openGL graphics with nifty special effects.

"One universe, infinite possibilities"

= Features =

See [[Vegastrike:Features]]

= Active Development Team =

== Project Leads and Lead Developers ==
* Daniel R Horn aka ''hellcatv'',''danielrh'' (overall coordination, lead programming, ...)
* Patrick Horn aka ''ace123'' (lead development, multiplayer, python, forum support)
* Jack Sampson aka ''jackS'' (Minister of Information, VS Universe development, art directing)

== Programmers and Developers ==
* Claudio Freire aka ''klauss'', ''klausfreire'' (engine and python development)
* Ed Sweetman aka ''safemode'' (engine development)
* aka ''pyramid'', ''pyramid3d'' (art development, python scripting, documentation)

== Developers and Contributors ==

There are also developers that have in the past but do not contribute actively at this moment. Those are listed in the credits.

Besides the developers, there is a large number of contributors from the community, be it for the engine or art and other content type for VS game.

And not to forget the modders, who give significant direction and contribution to engine development.

See: [[Vegastrike:Credits]]

= Artistic Organization =
This is the artistic organization for unit model (ships, bases) development in Vega Strike - Upon The Coldest Sea.

'''Art Director''' - provides the design briefs, gives the model final approval before it goes into the game.
* jackS

'''Art Administrator''' - knows what models go where, organizes the wiki, prioritizes development
* pyramid

'''Technical Liaison''' - tells artists what to do with regard to technical stuff
* chuck_starchaser

'''Concept Artists''' - come up with concept art
* Fendorin

'''Modeling Artists''' - model the ships and other assets
* Fendorin - senior modeling artists
* Deus Siddis
* rivalin

'''Texture Artists''' - texture the ships and stations
* Fendorin - senior texture artists

'''Voice Artists''' - provide speech voices
* [[User:Turbo|Turbo]] (tutorial quest voice, alien speech audio)
* CLoneWolf (andolian speech audio)

'''Data Integrators''' - contributors that integrate the models into the game data, fill in missing simple textures and placeholders, do file format conversions
* jackS
* esgaroth
* pyramid

'''Front End Artist''' - does overlays, wallpapers, screen savers, renders, runs the ModDB page, a deviantart page, conceptart.org thread, Game-Artist.net thread
* rivalin

= Project Setup =

== Open Source Principles ==

We often hear the complaint that features don't get implemented for a long time though they are being requested over and over again.

Being an open source community, most developers or contributors have their day-time jobs or commitments. Time is a scarce resource for those people and naturally they tend to prioritize their work on things that they are personally most interested in. Active developers do not dictate what gets contributed and what doesn't. The dictate is solely coming from contributions.

The really best way to see a particular feature implemented quickly is to pull up your sleeves and start implementing them, first integrating with your local VS copy, and when a particular feature is working satisfactory, submit it to one of the active developers for inclusion. Bear in mind that only, and only working code will get committed fast. If code or data needs additional work it will most certainly have to wait either for developer time or interest.

In this way, contributors who submit a lot will become developers.

Don't know how and what to contribute? Have a look at the [[HowTo:Contribute]] page for a starter.

== Communication Structure ==

Developers communicate between themselves on a need basis via forum personal messages, email, and irc. In addition there are frequent project meetings scheduled to discuss online ongoing developments.

In addition, we communicate with the community primarily through the forum, the web page, the dev blogs, the wiki, and equally through pm's and irc.

= History =

I read it somewhere but can't find the text right now.

In any case, it was ''hellcatv'' who started it all. The first news entry on the project page is from March 1, 1998 with news about flight engine completion, basic AI functionality, and 4 available ships. This suggests that development was going on already before that time.

= On The Web =

* [http://en.wikipedia.org/wiki/Vega_Strike Vega Strike] Wikipedia entry.
* [http://www.youtube.com/results?search_query=Vega+Strike&aq=f VS on YouTube].
* [http://www.facebook.com/pages/Vega-Strike/112577708757768 Vega Strike] on facebook.
* [http://www.linuxlinks.com/article/20080523214626193/VegaStrike.html Vega Strike] on linuxlinks.com.
* 2010: [http://www.makeuseof.com/tag/space-adventures-vega-strike/ Go On Space Adventures With Vega Strike] in makeuseof.
* 2007: [http://www.freesoftwaremagazine.com/articles/vegastrike Vega Strike - My kind of fun] in the [http://www.freesoftwaremagazine.com/ Free Software Magazine]
* [http://tvtropes.org/pmwiki/pmwiki.php/Main/VegaStrike Vega Strike] on tvtropes.
* [http://linux.about.com/od/softgame/fr/fr_VegaS.htm Linux Game: Vega Strike] on About.com.
* [http://www.reloaded.org/download/Vega-Strike/40/ Vega Strike] on reloaded.org.

= Roadmap =
See [[Development:Roadmap]]

Vegastrike:Project

2011-04-30T00:10:10Z

Pyramid: /* On The Web */

Project Information

=About=
Vega Strike is an Open Source 3d Space Simulator. Work is proceeding on both the Vega Strike game engine and a Vega Strike Universe game data set. Both, engine and data, are in a playable state, but under continuous development.

The Vega Strike engine serves as the foundation for the Parallel Universe, Privateer Gemini Gold, Privateer Remake, Vega Trek, and Pi Armada projects, whose websites can be reached via the sidebar to the right on the project web page.

= Vision =

We enjoy the futuristic genre, and we enjoy creating content for this genre in an interesting, vast, and profoundly complex but believable universe with endless expansion and enhancement possibilities.

We want to create a generic, open, and free space simulator game of outstanding quality, both in technology and content.

We want to be the vehicle for the creation and recreation of other space games and provide the possibility for users to create their own stories.

= Mission =

We have three development drivers:
* The Vega Strike Game
* The Modding capability
* The Engine that enables both

VS (the engine) is a vehicle for groups of people to produce content in a set of genres that they enjoy creating and playing.

The particular universe (VS game) that the Minister of Information (jackS) has been working on for some time now should be the target game, to help focus and separate required features from nice features. We also want to create an entangling, profound, and believable space game whose story is set in the Vega Strike Universe.

We want to maintain close relationship with and provide to the freedom loving community a moddable open source space simulation engine that can be used to create other independent space games.

We develop feature sets for the underlying content that requires those features: a campaign, a story, a well defined economy model, well defined game play mechanics, modding requirements.

Our approach is not myopic because of a particular perception as to what resources/technology will be available.

Users can write their own stories for the universe and share them around - and if they're good we can include them as well. Think of it as universe supporting easy-to-make fan-fiction (which can include mod-based fiction).

Factions are given the ability to make their own decisions ... God's (campaign) commands are suggestions ... the campaign evolves as the players force it, and the goals need to be written to handle that.

Shortly, Vega Strike will become a space combat/simulator game and engine with fully dynamic universe creation, scriptable ai responses with dynamic decision ability, completely non-determinant campaigns, fully functional economic system that responds to the real-time gameplay state of
the universe, shader-fied openGL graphics with nifty special effects.

"One universe, infinite possibilities"

= Features =

See [[Vegastrike:Features]]

= Active Development Team =

== Project Leads and Lead Developers ==
* Daniel R Horn aka ''hellcatv'',''danielrh'' (overall coordination, lead programming, ...)
* Patrick Horn aka ''ace123'' (lead development, multiplayer, python, forum support)
* Jack Sampson aka ''jackS'' (Minister of Information, VS Universe development, art directing)

== Programmers and Developers ==
* Claudio Freire aka ''klauss'', ''klausfreire'' (engine and python development)
* Ed Sweetman aka ''safemode'' (engine development)
* aka ''pyramid'', ''pyramid3d'' (art development, python scripting, documentation)

== Developers and Contributors ==

There are also developers that have in the past but do not contribute actively at this moment. Those are listed in the credits.

Besides the developers, there is a large number of contributors from the community, be it for the engine or art and other content type for VS game.

And not to forget the modders, who give significant direction and contribution to engine development.

See: [[Vegastrike:Credits]]

= Artistic Organization =
This is the artistic organization for unit model (ships, bases) development in Vega Strike - Upon The Coldest Sea.

'''Art Director''' - provides the design briefs, gives the model final approval before it goes into the game.
* jackS

'''Art Administrator''' - knows what models go where, organizes the wiki, prioritizes development
* pyramid

'''Technical Liaison''' - tells artists what to do with regard to technical stuff
* chuck_starchaser

'''Concept Artists''' - come up with concept art
* Fendorin

'''Modeling Artists''' - model the ships and other assets
* Fendorin - senior modeling artists
* Deus Siddis
* rivalin

'''Texture Artists''' - texture the ships and stations
* Fendorin - senior texture artists

'''Voice Artists''' - provide speech voices
* [[User:Turbo|Turbo]] (tutorial quest voice, alien speech audio)
* CLoneWolf (andolian speech audio)

'''Data Integrators''' - contributors that integrate the models into the game data, fill in missing simple textures and placeholders, do file format conversions
* jackS
* esgaroth
* pyramid

'''Front End Artist''' - does overlays, wallpapers, screen savers, renders, runs the ModDB page, a deviantart page, conceptart.org thread, Game-Artist.net thread
* rivalin

= Project Setup =

== Open Source Principles ==

We often hear the complaint that features don't get implemented for a long time though they are being requested over and over again.

Being an open source community, most developers or contributors have their day-time jobs or commitments. Time is a scarce resource for those people and naturally they tend to prioritize their work on things that they are personally most interested in. Active developers do not dictate what gets contributed and what doesn't. The dictate is solely coming from contributions.

The really best way to see a particular feature implemented quickly is to pull up your sleeves and start implementing them, first integrating with your local VS copy, and when a particular feature is working satisfactory, submit it to one of the active developers for inclusion. Bear in mind that only, and only working code will get committed fast. If code or data needs additional work it will most certainly have to wait either for developer time or interest.

In this way, contributors who submit a lot will become developers.

Don't know how and what to contribute? Have a look at the [[HowTo:Contribute]] page for a starter.

== Communication Structure ==

Developers communicate between themselves on a need basis via forum personal messages, email, and irc. In addition there are frequent project meetings scheduled to discuss online ongoing developments.

In addition, we communicate with the community primarily through the forum, the web page, the dev blogs, the wiki, and equally through pm's and irc.

= History =

I read it somewhere but can't find the text right now.

In any case, it was ''hellcatv'' who started it all. The first news entry on the project page is from March 1, 1998 with news about flight engine completion, basic AI functionality, and 4 available ships. This suggests that development was going on already before that time.

= On The Web =

* [http://en.wikipedia.org/wiki/Vega_Strike Vega Strike] Wikipedia entry.
* [http://www.facebook.com/pages/Vega-Strike/112577708757768 Vega Strike] on facebook.
* [http://www.linuxlinks.com/article/20080523214626193/VegaStrike.html Vega Strike] on linuxlinks.com.
* 2010: [http://www.makeuseof.com/tag/space-adventures-vega-strike/ Go On Space Adventures With Vega Strike] in makeuseof.
* 2007: [http://www.freesoftwaremagazine.com/articles/vegastrike Vega Strike - My kind of fun] in the [http://www.freesoftwaremagazine.com/ Free Software Magazine]

= Roadmap =
See [[Development:Roadmap]]

Vegastrike:Project

2011-04-29T23:59:52Z

Pyramid: /* On The Web */

Project Information

=About=
Vega Strike is an Open Source 3d Space Simulator. Work is proceeding on both the Vega Strike game engine and a Vega Strike Universe game data set. Both, engine and data, are in a playable state, but under continuous development.

The Vega Strike engine serves as the foundation for the Parallel Universe, Privateer Gemini Gold, Privateer Remake, Vega Trek, and Pi Armada projects, whose websites can be reached via the sidebar to the right on the project web page.

= Vision =

We enjoy the futuristic genre, and we enjoy creating content for this genre in an interesting, vast, and profoundly complex but believable universe with endless expansion and enhancement possibilities.

We want to create a generic, open, and free space simulator game of outstanding quality, both in technology and content.

We want to be the vehicle for the creation and recreation of other space games and provide the possibility for users to create their own stories.

= Mission =

We have three development drivers:
* The Vega Strike Game
* The Modding capability
* The Engine that enables both

VS (the engine) is a vehicle for groups of people to produce content in a set of genres that they enjoy creating and playing.

The particular universe (VS game) that the Minister of Information (jackS) has been working on for some time now should be the target game, to help focus and separate required features from nice features. We also want to create an entangling, profound, and believable space game whose story is set in the Vega Strike Universe.

We want to maintain close relationship with and provide to the freedom loving community a moddable open source space simulation engine that can be used to create other independent space games.

We develop feature sets for the underlying content that requires those features: a campaign, a story, a well defined economy model, well defined game play mechanics, modding requirements.

Our approach is not myopic because of a particular perception as to what resources/technology will be available.

Users can write their own stories for the universe and share them around - and if they're good we can include them as well. Think of it as universe supporting easy-to-make fan-fiction (which can include mod-based fiction).

Factions are given the ability to make their own decisions ... God's (campaign) commands are suggestions ... the campaign evolves as the players force it, and the goals need to be written to handle that.

Shortly, Vega Strike will become a space combat/simulator game and engine with fully dynamic universe creation, scriptable ai responses with dynamic decision ability, completely non-determinant campaigns, fully functional economic system that responds to the real-time gameplay state of
the universe, shader-fied openGL graphics with nifty special effects.

"One universe, infinite possibilities"

= Features =

See [[Vegastrike:Features]]

= Active Development Team =

== Project Leads and Lead Developers ==
* Daniel R Horn aka ''hellcatv'',''danielrh'' (overall coordination, lead programming, ...)
* Patrick Horn aka ''ace123'' (lead development, multiplayer, python, forum support)
* Jack Sampson aka ''jackS'' (Minister of Information, VS Universe development, art directing)

== Programmers and Developers ==
* Claudio Freire aka ''klauss'', ''klausfreire'' (engine and python development)
* Ed Sweetman aka ''safemode'' (engine development)
* aka ''pyramid'', ''pyramid3d'' (art development, python scripting, documentation)

== Developers and Contributors ==

There are also developers that have in the past but do not contribute actively at this moment. Those are listed in the credits.

Besides the developers, there is a large number of contributors from the community, be it for the engine or art and other content type for VS game.

And not to forget the modders, who give significant direction and contribution to engine development.

See: [[Vegastrike:Credits]]

= Artistic Organization =
This is the artistic organization for unit model (ships, bases) development in Vega Strike - Upon The Coldest Sea.

'''Art Director''' - provides the design briefs, gives the model final approval before it goes into the game.
* jackS

'''Art Administrator''' - knows what models go where, organizes the wiki, prioritizes development
* pyramid

'''Technical Liaison''' - tells artists what to do with regard to technical stuff
* chuck_starchaser

'''Concept Artists''' - come up with concept art
* Fendorin

'''Modeling Artists''' - model the ships and other assets
* Fendorin - senior modeling artists
* Deus Siddis
* rivalin

'''Texture Artists''' - texture the ships and stations
* Fendorin - senior texture artists

'''Voice Artists''' - provide speech voices
* [[User:Turbo|Turbo]] (tutorial quest voice, alien speech audio)
* CLoneWolf (andolian speech audio)

'''Data Integrators''' - contributors that integrate the models into the game data, fill in missing simple textures and placeholders, do file format conversions
* jackS
* esgaroth
* pyramid

'''Front End Artist''' - does overlays, wallpapers, screen savers, renders, runs the ModDB page, a deviantart page, conceptart.org thread, Game-Artist.net thread
* rivalin

= Project Setup =

== Open Source Principles ==

We often hear the complaint that features don't get implemented for a long time though they are being requested over and over again.

Being an open source community, most developers or contributors have their day-time jobs or commitments. Time is a scarce resource for those people and naturally they tend to prioritize their work on things that they are personally most interested in. Active developers do not dictate what gets contributed and what doesn't. The dictate is solely coming from contributions.

The really best way to see a particular feature implemented quickly is to pull up your sleeves and start implementing them, first integrating with your local VS copy, and when a particular feature is working satisfactory, submit it to one of the active developers for inclusion. Bear in mind that only, and only working code will get committed fast. If code or data needs additional work it will most certainly have to wait either for developer time or interest.

In this way, contributors who submit a lot will become developers.

Don't know how and what to contribute? Have a look at the [[HowTo:Contribute]] page for a starter.

== Communication Structure ==

Developers communicate between themselves on a need basis via forum personal messages, email, and irc. In addition there are frequent project meetings scheduled to discuss online ongoing developments.

In addition, we communicate with the community primarily through the forum, the web page, the dev blogs, the wiki, and equally through pm's and irc.

= History =

I read it somewhere but can't find the text right now.

In any case, it was ''hellcatv'' who started it all. The first news entry on the project page is from March 1, 1998 with news about flight engine completion, basic AI functionality, and 4 available ships. This suggests that development was going on already before that time.

= On The Web =

* 2011: [http://en.wikipedia.org/wiki/Vega_Strike Vega Strike] Wikipedia entry.
* 2010: [http://www.makeuseof.com/tag/space-adventures-vega-strike/ Go On Space Adventures With Vega Strike] in makeuseof.
* 2007: [http://www.freesoftwaremagazine.com/articles/vegastrike Vega Strike - My kind of fun] in the [http://www.freesoftwaremagazine.com/ Free Software Magazine]

= Roadmap =
See [[Development:Roadmap]]

Vegastrike:Project

2011-04-29T23:55:34Z

Pyramid: /* In The News */

Project Information

=About=
Vega Strike is an Open Source 3d Space Simulator. Work is proceeding on both the Vega Strike game engine and a Vega Strike Universe game data set. Both, engine and data, are in a playable state, but under continuous development.

The Vega Strike engine serves as the foundation for the Parallel Universe, Privateer Gemini Gold, Privateer Remake, Vega Trek, and Pi Armada projects, whose websites can be reached via the sidebar to the right on the project web page.

= Vision =

We enjoy the futuristic genre, and we enjoy creating content for this genre in an interesting, vast, and profoundly complex but believable universe with endless expansion and enhancement possibilities.

We want to create a generic, open, and free space simulator game of outstanding quality, both in technology and content.

We want to be the vehicle for the creation and recreation of other space games and provide the possibility for users to create their own stories.

= Mission =

We have three development drivers:
* The Vega Strike Game
* The Modding capability
* The Engine that enables both

VS (the engine) is a vehicle for groups of people to produce content in a set of genres that they enjoy creating and playing.

The particular universe (VS game) that the Minister of Information (jackS) has been working on for some time now should be the target game, to help focus and separate required features from nice features. We also want to create an entangling, profound, and believable space game whose story is set in the Vega Strike Universe.

We want to maintain close relationship with and provide to the freedom loving community a moddable open source space simulation engine that can be used to create other independent space games.

We develop feature sets for the underlying content that requires those features: a campaign, a story, a well defined economy model, well defined game play mechanics, modding requirements.

Our approach is not myopic because of a particular perception as to what resources/technology will be available.

Users can write their own stories for the universe and share them around - and if they're good we can include them as well. Think of it as universe supporting easy-to-make fan-fiction (which can include mod-based fiction).

Factions are given the ability to make their own decisions ... God's (campaign) commands are suggestions ... the campaign evolves as the players force it, and the goals need to be written to handle that.

Shortly, Vega Strike will become a space combat/simulator game and engine with fully dynamic universe creation, scriptable ai responses with dynamic decision ability, completely non-determinant campaigns, fully functional economic system that responds to the real-time gameplay state of
the universe, shader-fied openGL graphics with nifty special effects.

"One universe, infinite possibilities"

= Features =

See [[Vegastrike:Features]]

= Active Development Team =

== Project Leads and Lead Developers ==
* Daniel R Horn aka ''hellcatv'',''danielrh'' (overall coordination, lead programming, ...)
* Patrick Horn aka ''ace123'' (lead development, multiplayer, python, forum support)
* Jack Sampson aka ''jackS'' (Minister of Information, VS Universe development, art directing)

== Programmers and Developers ==
* Claudio Freire aka ''klauss'', ''klausfreire'' (engine and python development)
* Ed Sweetman aka ''safemode'' (engine development)
* aka ''pyramid'', ''pyramid3d'' (art development, python scripting, documentation)

== Developers and Contributors ==

There are also developers that have in the past but do not contribute actively at this moment. Those are listed in the credits.

Besides the developers, there is a large number of contributors from the community, be it for the engine or art and other content type for VS game.

And not to forget the modders, who give significant direction and contribution to engine development.

See: [[Vegastrike:Credits]]

= Artistic Organization =
This is the artistic organization for unit model (ships, bases) development in Vega Strike - Upon The Coldest Sea.

'''Art Director''' - provides the design briefs, gives the model final approval before it goes into the game.
* jackS

'''Art Administrator''' - knows what models go where, organizes the wiki, prioritizes development
* pyramid

'''Technical Liaison''' - tells artists what to do with regard to technical stuff
* chuck_starchaser

'''Concept Artists''' - come up with concept art
* Fendorin

'''Modeling Artists''' - model the ships and other assets
* Fendorin - senior modeling artists
* Deus Siddis
* rivalin

'''Texture Artists''' - texture the ships and stations
* Fendorin - senior texture artists

'''Voice Artists''' - provide speech voices
* [[User:Turbo|Turbo]] (tutorial quest voice, alien speech audio)
* CLoneWolf (andolian speech audio)

'''Data Integrators''' - contributors that integrate the models into the game data, fill in missing simple textures and placeholders, do file format conversions
* jackS
* esgaroth
* pyramid

'''Front End Artist''' - does overlays, wallpapers, screen savers, renders, runs the ModDB page, a deviantart page, conceptart.org thread, Game-Artist.net thread
* rivalin

= Project Setup =

== Open Source Principles ==

We often hear the complaint that features don't get implemented for a long time though they are being requested over and over again.

Being an open source community, most developers or contributors have their day-time jobs or commitments. Time is a scarce resource for those people and naturally they tend to prioritize their work on things that they are personally most interested in. Active developers do not dictate what gets contributed and what doesn't. The dictate is solely coming from contributions.

The really best way to see a particular feature implemented quickly is to pull up your sleeves and start implementing them, first integrating with your local VS copy, and when a particular feature is working satisfactory, submit it to one of the active developers for inclusion. Bear in mind that only, and only working code will get committed fast. If code or data needs additional work it will most certainly have to wait either for developer time or interest.

In this way, contributors who submit a lot will become developers.

Don't know how and what to contribute? Have a look at the [[HowTo:Contribute]] page for a starter.

== Communication Structure ==

Developers communicate between themselves on a need basis via forum personal messages, email, and irc. In addition there are frequent project meetings scheduled to discuss online ongoing developments.

In addition, we communicate with the community primarily through the forum, the web page, the dev blogs, the wiki, and equally through pm's and irc.

= History =

I read it somewhere but can't find the text right now.

In any case, it was ''hellcatv'' who started it all. The first news entry on the project page is from March 1, 1998 with news about flight engine completion, basic AI functionality, and 4 available ships. This suggests that development was going on already before that time.

= On The Web =

* [http://www.freesoftwaremagazine.com/articles/vegastrike Vega Strike - My kind of fun] in the [http://www.freesoftwaremagazine.com/ Free Software Magazine]
* [http://en.wikipedia.org/wiki/Vega_Strike Vega Strike] Wikipedia entry.

= Roadmap =
See [[Development:Roadmap]]

Vegastrike:Project

2011-04-29T21:52:04Z

Pyramid: /* History */

Project Information

=About=
Vega Strike is an Open Source 3d Space Simulator. Work is proceeding on both the Vega Strike game engine and a Vega Strike Universe game data set. Both, engine and data, are in a playable state, but under continuous development.

The Vega Strike engine serves as the foundation for the Parallel Universe, Privateer Gemini Gold, Privateer Remake, Vega Trek, and Pi Armada projects, whose websites can be reached via the sidebar to the right on the project web page.

= Vision =

We enjoy the futuristic genre, and we enjoy creating content for this genre in an interesting, vast, and profoundly complex but believable universe with endless expansion and enhancement possibilities.

We want to create a generic, open, and free space simulator game of outstanding quality, both in technology and content.

We want to be the vehicle for the creation and recreation of other space games and provide the possibility for users to create their own stories.

= Mission =

We have three development drivers:
* The Vega Strike Game
* The Modding capability
* The Engine that enables both

VS (the engine) is a vehicle for groups of people to produce content in a set of genres that they enjoy creating and playing.

The particular universe (VS game) that the Minister of Information (jackS) has been working on for some time now should be the target game, to help focus and separate required features from nice features. We also want to create an entangling, profound, and believable space game whose story is set in the Vega Strike Universe.

We want to maintain close relationship with and provide to the freedom loving community a moddable open source space simulation engine that can be used to create other independent space games.

We develop feature sets for the underlying content that requires those features: a campaign, a story, a well defined economy model, well defined game play mechanics, modding requirements.

Our approach is not myopic because of a particular perception as to what resources/technology will be available.

Users can write their own stories for the universe and share them around - and if they're good we can include them as well. Think of it as universe supporting easy-to-make fan-fiction (which can include mod-based fiction).

Factions are given the ability to make their own decisions ... God's (campaign) commands are suggestions ... the campaign evolves as the players force it, and the goals need to be written to handle that.

Shortly, Vega Strike will become a space combat/simulator game and engine with fully dynamic universe creation, scriptable ai responses with dynamic decision ability, completely non-determinant campaigns, fully functional economic system that responds to the real-time gameplay state of
the universe, shader-fied openGL graphics with nifty special effects.

"One universe, infinite possibilities"

= Features =

See [[Vegastrike:Features]]

= Active Development Team =

== Project Leads and Lead Developers ==
* Daniel R Horn aka ''hellcatv'',''danielrh'' (overall coordination, lead programming, ...)
* Patrick Horn aka ''ace123'' (lead development, multiplayer, python, forum support)
* Jack Sampson aka ''jackS'' (Minister of Information, VS Universe development, art directing)

== Programmers and Developers ==
* Claudio Freire aka ''klauss'', ''klausfreire'' (engine and python development)
* Ed Sweetman aka ''safemode'' (engine development)
* aka ''pyramid'', ''pyramid3d'' (art development, python scripting, documentation)

== Developers and Contributors ==

There are also developers that have in the past but do not contribute actively at this moment. Those are listed in the credits.

Besides the developers, there is a large number of contributors from the community, be it for the engine or art and other content type for VS game.

And not to forget the modders, who give significant direction and contribution to engine development.

See: [[Vegastrike:Credits]]

= Artistic Organization =
This is the artistic organization for unit model (ships, bases) development in Vega Strike - Upon The Coldest Sea.

'''Art Director''' - provides the design briefs, gives the model final approval before it goes into the game.
* jackS

'''Art Administrator''' - knows what models go where, organizes the wiki, prioritizes development
* pyramid

'''Technical Liaison''' - tells artists what to do with regard to technical stuff
* chuck_starchaser

'''Concept Artists''' - come up with concept art
* Fendorin

'''Modeling Artists''' - model the ships and other assets
* Fendorin - senior modeling artists
* Deus Siddis
* rivalin

'''Texture Artists''' - texture the ships and stations
* Fendorin - senior texture artists

'''Voice Artists''' - provide speech voices
* [[User:Turbo|Turbo]] (tutorial quest voice, alien speech audio)
* CLoneWolf (andolian speech audio)

'''Data Integrators''' - contributors that integrate the models into the game data, fill in missing simple textures and placeholders, do file format conversions
* jackS
* esgaroth
* pyramid

'''Front End Artist''' - does overlays, wallpapers, screen savers, renders, runs the ModDB page, a deviantart page, conceptart.org thread, Game-Artist.net thread
* rivalin

= Project Setup =

== Open Source Principles ==

We often hear the complaint that features don't get implemented for a long time though they are being requested over and over again.

Being an open source community, most developers or contributors have their day-time jobs or commitments. Time is a scarce resource for those people and naturally they tend to prioritize their work on things that they are personally most interested in. Active developers do not dictate what gets contributed and what doesn't. The dictate is solely coming from contributions.

The really best way to see a particular feature implemented quickly is to pull up your sleeves and start implementing them, first integrating with your local VS copy, and when a particular feature is working satisfactory, submit it to one of the active developers for inclusion. Bear in mind that only, and only working code will get committed fast. If code or data needs additional work it will most certainly have to wait either for developer time or interest.

In this way, contributors who submit a lot will become developers.

Don't know how and what to contribute? Have a look at the [[HowTo:Contribute]] page for a starter.

== Communication Structure ==

Developers communicate between themselves on a need basis via forum personal messages, email, and irc. In addition there are frequent project meetings scheduled to discuss online ongoing developments.

In addition, we communicate with the community primarily through the forum, the web page, the dev blogs, the wiki, and equally through pm's and irc.

= History =

I read it somewhere but can't find the text right now.

In any case, it was ''hellcatv'' who started it all. The first news entry on the project page is from March 1, 1998 with news about flight engine completion, basic AI functionality, and 4 available ships. This suggests that development was going on already before that time.

= In The News =

* [http://www.freesoftwaremagazine.com/articles/vegastrike Vega Strike - My kind of fun] in the [http://www.freesoftwaremagazine.com/ Free Software Magazine]

= Roadmap =
See [[Development:Roadmap]]

Development

2011-04-18T21:10:23Z

Pyramid: /* 3D Models */

{{Wiki_Nav_Index}}

=Development & Modding=

==Developer information pages==
General information on contribution:
* [[HowTo:Contribute|The Vega Strike Contributor's Guide]]
* [[Database:GPUs|GPU information database]]
* [[HowTo:MOD|How to create MODs]]
* [[Development:File_Structure|File and Directory Structure]]

==Status/task list pages==
* [[Development:3D_Models|3D Models]] - Organisation and contribution information.
* [[Development:2D_Images|2D Images]] - Organisation and contribution information.
* [[Development:Roadmap|Roadmap]] - The Vega Strike development roadmap.
* [[Development:Compatibility]] - Making sure the game works on all hardware
* [[Development:Rebalance]] - Information and task list for the Rebalance.
* [[Development:Performance]] - Goals to achieve required performance
* [[Development:AI Navigation]] - Overhauling the ships' navigation routines
* [[Development:Misc Engine Work]] - Various engine and backend work information.
* [[Development:Ogre]] - Information on the OGRE port.

= Artistic Contribution =

===Art Guidelines===
Please read this '''[[Development:Graphics_Requirements]]''' page first before continuing to the specific requirements.
See also: [[Links:Graphic_Applications]] and [[Links:3D_Applications]] for applications listings.

Further, the [[Artstyle_guides|Art Style Guides]] might prove useful during your creationist endeavors.

===Audio===
There are also guidelines for sound and music creation available in '''[[Development:Audio]]'''.

===3D Models===
The modeling related information is just being restructured.
* [[Development:Model Guidelines|'''Guidelines Portal for Creating 3D Models''']] is the main page for complete guidance on developing ship and installation models for Vega Strike
** [[Development:3D_Models|3D models list and status]]

=== Space Scapes ===
* [[Development:Orbital Planet Surfaces|Orbital Planet Surfaces]] - General guidance for development of planet surfaces visible from orbit.
* [[Development:System_Backgrounds|Generating star system backgrounds]]
* [[Development:Base_Backgrounds|Creating and adding backgrounds for bases, planets, or capital ships]]

=== Cargo ===
* [[Development:Cargo (graphics)|Creating Cargo Graphics]] - Images to be displayed in the trading interface for cargo items.
** [[Cargo]] - Detailed descriptions of cargo items, listed by category.
* [[Development:Balancing|Faction Balancing]] - General guidelines to keep in mind when play balancing the Vega Strike factions.

=== Other Graphics ===
* [[Development:Logos & Signage|Logos & Signage]]

= Python Scripting =

=== Quests & Campaigns ===
* [[Development:Quests_&_Campaigns|Quests & Campaigns]] Reference portal for creation of campaigns, missions, quests & adventures.
** [[Development:Quests|Quests]] Creating quests and adventures
** [[Development:Missions|Developing Missions]] Creation of missions
** [[Development:AIScripts|Developing AI Behaviors]] Customizing AI combat reactions
** [[Development:Campaigns]] Making campaigns

=== Other Scripts ===
* [[HowTo:Edit News|Editing News]]
* [[HowTo:Add Conversations|Adding Conversations]]
* [[Development:Base_Backgrounds|Changing Base Backgrounds and Base Computer GUI]]

= Data Modding =

=== Game Assets ===
* [[HowTo:Edit_units.csv| Editing units.csv]]
* [[HowTo:Make Weapons|Adding new weapons to the game]]
* [[HowTo:Add Cargo|Adding new cargo to the game]]
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
**[[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]
* [[HowTo:Edit Systems|Creating or editing star systems]]
* [[HowTo:Make Splash Screens|Making splash screens that display at startup]]
* [[HowTo:Edit faction relationships|Edit the relationships between the existing factions]] (the <code>factions.xml</code> file)
* [[HowTo:Add Upgrades|Adding new upgrades to the game]]
* [[HowTo:Nav Computer Interface|Edit the navigation computer interface]]
* [[HowTo:Create_Cockpit_in_Wings3d|Creating a 3D cockpit for your ship]]
* [[HowTo:Edit_HUDs|Editing HUDs, placing radars]]

=== Events ===
* [[HowTo:Add Conversations|Adding more conversation lines to the game]]
* [[HowTo:Edit News|Creating or editing news events]]
* [[HowTo:Edit AI|Creating or editing Ship AI's]]

===Configuration ===
* [[Manual:Config:Advanced:Variables|Configuration Variables]]
* [[CONFVAR|CONFVAR - Complete Variable Listing]]

===Internationalization/Localisation-related===
* [[Development:Translations|Translation projects]]

=== Modding Tools ===
* [[Development:Scripts & Tools|Scripts & Tools]] - to make your life easier
** [[Development:Tools:UnitConverter|Unit Converter Manual]] - tool to convert Wavefront obj files to bfxm format including texture conversion, units stats editor, and visualization with Vega Strike.
** [[Development:Script:obj2obj converter|obj2obj converter]] (Perl, commandline) - Converts obj files to cockpit files. or extracts tag-data from the models. (''At least that's what is planned, Testing under Win32/Linux. [[User:pontiac|Pontiac]]'')
* [[OOG_Tools|Out-Of-Game Player Tools]]

=== Front End ===
* [[HowTo:Take Screenshots|Taking really awesome screenshots]]

= Vega Strike The Game Mechanisms =
* [[Development:Realism vs Believability|Realism vs Believability]]
* [[Development:Economy|Economy]] - How ingame economy should work.
* [[Development:Political system|Political system]]

= Code-related Development =
* [[Development:Dependencies|Dependencies]] - A guide to system dependencies, broken down by subsystem.
* [[Development:SVN Tree|SVN Tree]] - A guide to the layout of the Subversion tree.
* [[Development:Code style|Code style]] - A guide/manual to write code for Vegastrike that fits in and is readable.
* [[Development:Network|Network]] - Everything network related goes in here.
** [[Development:Network:Packet format|Packet format]] - A description of the packet format that had been implemented a few years ago.
** [[Development:Network:Todo|Todo]] - What still needs to be done.
** [[Development:Network:Testing|Testing]] - Testing the network code.
* [[Development:Keyboard layout|Keyboard layout]] - Discuss and display new keyboard layouts here.

=See also=
* [[HowTos]]
* [[FAQ:Feature_Requests|Feature Requests]]
* [[Development:Audio#Voice_Acting]]

[[Category:Development]]

Development

2011-04-14T17:59:52Z

Pyramid: /* Game Assets */

{{Wiki_Nav_Index}}

=Development & Modding=

==Developer information pages==
General information on contribution:
* [[HowTo:Contribute|The Vega Strike Contributor's Guide]]
* [[Database:GPUs|GPU information database]]
* [[HowTo:MOD|How to create MODs]]
* [[Development:File_Structure|File and Directory Structure]]

==Status/task list pages==
* [[Development:3D_Models|3D Models]] - Organisation and contribution information.
* [[Development:2D_Images|2D Images]] - Organisation and contribution information.
* [[Development:Roadmap|Roadmap]] - The Vega Strike development roadmap.
* [[Development:Compatibility]] - Making sure the game works on all hardware
* [[Development:Rebalance]] - Information and task list for the Rebalance.
* [[Development:Performance]] - Goals to achieve required performance
* [[Development:AI Navigation]] - Overhauling the ships' navigation routines
* [[Development:Misc Engine Work]] - Various engine and backend work information.
* [[Development:Ogre]] - Information on the OGRE port.

= Artistic Contribution =

===Art Guidelines===
Please read this '''[[Development:Graphics_Requirements]]''' page first before continuing to the specific requirements.
See also: [[Links:Graphic_Applications]] and [[Links:3D_Applications]] for applications listings.

Further, the [[Artstyle_guides|Art Style Guides]] might prove useful during your creationist endeavors.

===Audio===
There are also guidelines for sound and music creation available in '''[[Development:Audio]]'''.

===3D Models===
The modeling related information is just being restructured.
* [[Development:Model Guidelines|Guidelines Portal for Creating 3D Models]] is the main page for complete guidance on developing ship and installation models for Vega Strike
** [[Development:3D_Models|3D models list and status]]

=== Space Scapes ===
* [[Development:Orbital Planet Surfaces|Orbital Planet Surfaces]] - General guidance for development of planet surfaces visible from orbit.
* [[Development:System_Backgrounds|Generating star system backgrounds]]
* [[Development:Base_Backgrounds|Creating and adding backgrounds for bases, planets, or capital ships]]

=== Cargo ===
* [[Development:Cargo (graphics)|Creating Cargo Graphics]] - Images to be displayed in the trading interface for cargo items.
** [[Cargo]] - Detailed descriptions of cargo items, listed by category.
* [[Development:Balancing|Faction Balancing]] - General guidelines to keep in mind when play balancing the Vega Strike factions.

=== Other Graphics ===
* [[Development:Logos & Signage|Logos & Signage]]

= Python Scripting =

=== Quests & Campaigns ===
* [[Development:Quests_&_Campaigns|Quests & Campaigns]] Reference portal for creation of campaigns, missions, quests & adventures.
** [[Development:Quests|Quests]] Creating quests and adventures
** [[Development:Missions|Developing Missions]] Creation of missions
** [[Development:AIScripts|Developing AI Behaviors]] Customizing AI combat reactions
** [[Development:Campaigns]] Making campaigns

=== Other Scripts ===
* [[HowTo:Edit News|Editing News]]
* [[HowTo:Add Conversations|Adding Conversations]]
* [[Development:Base_Backgrounds|Changing Base Backgrounds and Base Computer GUI]]

= Data Modding =

=== Game Assets ===
* [[HowTo:Edit_units.csv| Editing units.csv]]
* [[HowTo:Make Weapons|Adding new weapons to the game]]
* [[HowTo:Add Cargo|Adding new cargo to the game]]
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
**[[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]
* [[HowTo:Edit Systems|Creating or editing star systems]]
* [[HowTo:Make Splash Screens|Making splash screens that display at startup]]
* [[HowTo:Edit faction relationships|Edit the relationships between the existing factions]] (the <code>factions.xml</code> file)
* [[HowTo:Add Upgrades|Adding new upgrades to the game]]
* [[HowTo:Nav Computer Interface|Edit the navigation computer interface]]
* [[HowTo:Create_Cockpit_in_Wings3d|Creating a 3D cockpit for your ship]]
* [[HowTo:Edit_HUDs|Editing HUDs, placing radars]]

=== Events ===
* [[HowTo:Add Conversations|Adding more conversation lines to the game]]
* [[HowTo:Edit News|Creating or editing news events]]
* [[HowTo:Edit AI|Creating or editing Ship AI's]]

===Configuration ===
* [[Manual:Config:Advanced:Variables|Configuration Variables]]
* [[CONFVAR|CONFVAR - Complete Variable Listing]]

===Internationalization/Localisation-related===
* [[Development:Translations|Translation projects]]

=== Modding Tools ===
* [[Development:Scripts & Tools|Scripts & Tools]] - to make your life easier
** [[Development:Tools:UnitConverter|Unit Converter Manual]] - tool to convert Wavefront obj files to bfxm format including texture conversion, units stats editor, and visualization with Vega Strike.
** [[Development:Script:obj2obj converter|obj2obj converter]] (Perl, commandline) - Converts obj files to cockpit files. or extracts tag-data from the models. (''At least that's what is planned, Testing under Win32/Linux. [[User:pontiac|Pontiac]]'')
* [[OOG_Tools|Out-Of-Game Player Tools]]

=== Front End ===
* [[HowTo:Take Screenshots|Taking really awesome screenshots]]

= Vega Strike The Game Mechanisms =
* [[Development:Realism vs Believability|Realism vs Believability]]
* [[Development:Economy|Economy]] - How ingame economy should work.
* [[Development:Political system|Political system]]

= Code-related Development =
* [[Development:Dependencies|Dependencies]] - A guide to system dependencies, broken down by subsystem.
* [[Development:SVN Tree|SVN Tree]] - A guide to the layout of the Subversion tree.
* [[Development:Code style|Code style]] - A guide/manual to write code for Vegastrike that fits in and is readable.
* [[Development:Network|Network]] - Everything network related goes in here.
** [[Development:Network:Packet format|Packet format]] - A description of the packet format that had been implemented a few years ago.
** [[Development:Network:Todo|Todo]] - What still needs to be done.
** [[Development:Network:Testing|Testing]] - Testing the network code.
* [[Development:Keyboard layout|Keyboard layout]] - Discuss and display new keyboard layouts here.

=See also=
* [[HowTos]]
* [[FAQ:Feature_Requests|Feature Requests]]
* [[Development:Audio#Voice_Acting]]

[[Category:Development]]

Vessel:Ox

2011-04-10T22:52:57Z

Pyramid:

{{Description:Vessel|
|IMAGE=vessels/Ox/ox-hud.png
|CAPTION=http://vegastrike.sourceforge.net/albums/wiki_manual/Ship-Profiles/Ox_profile.jpg
|NAME=Ox
|PRODUCER=Merchants
|MORE PRODUCERS=(Interstellar Shipping and Mercantile Guild)
|ROLE_SUMMARY=External Container transport
|COMBAT BEHAVIOR=Lightly, and defensively armed. May engage pirates if flight is not an option, will otherwise flee or surrender.
|VARIANTS=Base chassis is constant, but containers are interchangeable
|TENURE=
|USERS=Merchants
|ROLE_VERBOSE=
|COMMENTS=
|MASS=30M
|LENGTH=908
}}

[[Category:Vessels:Civilian|Ox]][[Category:Vessels:Cargo|Ox]] [[Category:Used By:Merchants|Ox]]

Template:Description:Vessel

2011-04-10T22:52:39Z

Pyramid:

[[Category:Database]] [[Category:VS Tech]] [[Category:Vessels|{{{NAME}}}]]
[[Category:Produced By:{{{PRODUCER}}}|{{{NAME}}}]]
{{parent_link|parent=[[Vessels & Installations]]}}
----
{| valign="top" width="100%"
{| valign="top" width="100%"
| width ="40%" | http://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/masters/units/{{{IMAGE}}}
{{{CAPTION}}}
| valign="top" width ="25%" |
{| class="toccolours" style="margin-left: 1em; width: 100%"
|+ style="font-size:larger;" | '''Performance Statistics'''
|-
! colspan="3" style="background: #9D9CF2; color: #0000FF; text-align:center;" | '''{{{NAME}}}'''
|-
| '''Mass''' (empty)
| {{{MASS}}}
| ''metric tons''
|-
| '''Length'''
| {{{LENGTH}}}
| ''meters''
|}

| valign="top" width="35%"|
{| class="toccolours" style="margin-left: 1em; width: 100%"
|+ style="font-size:larger;" | '''Manufacturing Details'''
|-
! colspan="3" style="background: #9D9CF2; color: #0000FF; text-align:center;" | '''{{{NAME}}}'''
|-
|-
|'''Manufacturing Faction:'''
|{{{PRODUCER}}} {{{MORE PRODUCERS}}}
|-
|'''Known Major Variants:'''
|{{{VARIANTS}}}
|-
|'''Tenure of Service:'''
| {{{TENURE}}}
|-
|'''Utilization:'''
| {{{USERS}}}
|}
|}
 
{| valign="top" width="100%"
|+ style="font-size:larger;" | '''Role Details'''
|-
| width="10%" |'''Role Summary:'''
|{{{ROLE_SUMMARY}}}
|-
| 
| 
|-
| valign="top" | '''Role Details:'''
|{{{ROLE_VERBOSE}}}
|-
| 
| 
|-
| valign="top" | '''Combat Behavior:'''
|{{{COMBAT BEHAVIOR}}}
|-
| 
| 
|-
| valign="top" | '''Comments:'''
|{{{COMMENTS}}}
|}
|}

----

Development:3D Models

2011-04-10T22:31:43Z

Pyramid: /* M-O */

{{parent_link|parent=[[Development]]}}
----

=Introduction=
This is meant to become a '''task/status list''' for all 3d models in [[Vegastrike]].

= Vessels =

== Abbreviations ==

The following to do list for vessels is divided into smaller sections to simplify updating and handling of the list in the wiki editor. The new tables have been expanded and atomized in their content. The columns are:
;Name: name of the vessel and link to wiki page with description and concept art or ship profile id card with in-game render
;Type: vessel type
;Species: manufacturing species
;Faction: manufacturing faction
;Style: link to artstyle guide
;Thread: link(s) to thread(s) with discussion of any of the vessel aspects, from artstyle to screen shots
;Concept: link to thread or image of the concept art on forums, wiki, or gallery
;Mesh: information if the mesh(es) was(were) received AND stored in masters
:* <tt>Un</tt> - Unit/vessel mesh with submeshes
:* <tt>Sh</tt> - custom shield mesh
:* <tt>LoD</tt> - LOD meshes
;Textures: lists required texture types and the availability thereof (green=available, red=unavailable) including masters, for the sake of abbreviation, textures are using the following acronyms:
:* <tt>Di</tt> - Diffuse
:* <tt>Sp</tt> - Specular
:* <tt>Dm</tt> - Damage
:* <tt>Gl</tt> - Glow
:* <tt>No</tt> - Normal
;Data: Data integration, including mesh conversion to bfxm, textures conversion and compression, update of units.csv, spawning update, hud image
:* <tt>Un</tt> - Unit/vessel integration
:* <tt>Hud</tt> - HUD image integration
:* <tt>St</tt> - Unit stats
:* <tt>LoD</tt> - LOD meshes
:* <tt>En</tt> - Engine glow
;Frontend: availability of frontend data:
:* <tt>Wi</tt> - Vessel ID image in the [http://vegastrike.sourceforge.net/wiki/Vessels_%26_Installations vessels catalog] linked either from the [http://vegastrike.sourceforge.net/forums/cpg/thumbnails.php?album=3 ship profile gallery] or [http://vegastrike.sourceforge.net/forums/cpg/thumbnails.php?album=6 concept profile gallery] (resolution 512x384)
:* <tt>Sc</tt> - screen shots in [http://vegastrike.sourceforge.net/forums/cpg/thumbnails.php?album=11 screenshot gallery]
:* <tt>Wa</tt> - wall paper(s) in [http://vegastrike.sourceforge.net/forums/cpg/thumbnails.php?album=16 wallpaper gallery] (optional)
:* <tt>Ex</tt> - external art pages ([http://www.deviantart.com DeviantART], [http://www.conceptart.org ConceptArt.org]) (optional)
;To do: brief description of open things as far as not fitting into previous categories
;Artist(s): artists that have been contributing to the model
;Status: Use the following status types
:* {{open|OPEN}} - any of the listed items is not completed and waiting for assignment
:* {{assg|ASSIGNED}} (name) - somebody is knowingly working on the item noted in "To do"
:* {{done|DONE}} - model included in game including stats and frontend stuff

== A-C ==
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| [[Vessel:Acrotatus|Acrotatus]]
| Small Passenger Craft
| [[Species:Aera|Aera]]
| Multiple
| [[Artstyle guide:Aeran#Civilian|Aeran Civilian]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=6513 1]
| {{assg|A}}
| {{assg|Y}}
|
|
|
| concept improvement
| Link
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Admonisher|Admonisher]]
| Light Assault/Interdiction Craft
| [[Species:Humanity|Humanity]]
| [[Faction:Homeland Security|Homeland Security]]
| [[Artstyle guide:Homeland Security|Homeland Security]]
| -
|
|
|
|
|
| Additional (Bump, etc) maps
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:Agasicles|Agasicles]] (formerly 'Vark')
| Destroyer, venerable
| [[Species:Aera|Aera]]
| [[Species:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=2681 1], [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=4177 2]
| {{assg|Y}}
| {{open|N}}
|
|
|
| improve concept, create new model
| [[User:F1gm3nt3d|F1gm3nt3d]]
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Agesipolis|Agesipolis]] (formerly 'Vitik')
| Fleet Carrier, Venerable
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=5509 1]
| {{assg|A}}
| {{open|N}}
|
|
|
| concept approval, new model
| chuck_starchaser
| {{assg|ASSIGNED}} (jackS)
|- valign="top"
| [[Vessel:Agis|Agis]]
| Aera Assault Corvette
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=3808 1]
| {{done|Y}}
| {{open|N}}
|
|
|
| needs model
| Major (concept)
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Aidi|Aidi]]
| Civilian
| [[Species:Rlaan|Rlaan]]
| Multiple
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=13181 1]
|
|
|
|
|
| concept design & approval
| Fendorin
| {{assg|ASSIGNED}} (Fendorin) (jackS)
|- valign="top"
| [[Vessel:Ancestor|Ancestor]]
| Aerospace Frame
| [[Species:Humanity|Humanity]]
| [[Faction:Shaper|Shapers]]
| [[Artstyle guide:Shaper|Shaper]]
| -
|
|
|
|
|
| Additional (Bump, etc) maps
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:Archimedes|Archimedes]]
| Heavy Cruiser
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]]
| [[Artstyle guide:Andolian|Andolian]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=10205 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{open|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{done|En}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| shield mesh. needs stats, turrets.
| [[User:Fendorin|Fendorin]]
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Areus|Areus]]
| Fighter/Bomber
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| -
|
|
|
|
|
| Touchups of geometric imperfections. Canon related nudging. Shield Mesh.
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:Ariston|Ariston]]
| Heavy (Escort/Superiority) Fighter
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=13251 1]
| {{assg|Y}}
|
|
|
|
| new concept approval
| Nozmajner, Howard E. Day
| {{assg|ASSIGNED}} (jackS) (Nozmajner)
|- valign="top"
| [[Vessel:Baron|Baron]]
| Uln Patrol Craft
| [[Species:Uln|Uln]]
| Uln Constabulary
| [[Artstyle guide:Uln(Non-Fleet)|Uln Constabulary]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=10918 1]
| {{open|N}}
|
|
|
|
| concept improvement
| [[User:Fendorin|Fendorin]]
| {{assg|ASSIGNED}} (Fendorin)
|- valign="top"
| [[Vessel:Baronet|Baronet]]
| Uln Fighter
| [[Species:Uln|Uln]]
| Multiple
| [[Artstyle guide:Uln(Royal Ingatwa Fleet)|Uln Fleet]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=12089 1]
| {{assg|A}}
|
|
|
|
| approve concept
| Nózmájner
| {{assg|ASSIGNED}} (jackS)
|- valign="top"
| [[Vessel:Bell|Bell]]
| Andolian Communications Vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]]
| [[Artstyle guide:Andolian|Andolian]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=10917 1]
| {{done|Y}}
| {{done|Un}} {{done|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{done|En}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| stats review, screen shot, wallpaper
| [[User:Fendorin|Fendorin]]
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Camus|Camus]]
| Klk'k system patrol frigate
| [[Species:Klk'k|Klk'k]]
| [[Faction:Klk'k|Klk'k]] & [[Faction:Andolian Protectorate|Andolian Protectorate]]
| [[Artstyle guide:Klk'k|Klk'k]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7580 1]
| {{assg|Y}}
| {{open|N}}
|
|
|
| concept improvement
| [[User:light_gemini|light_gemini]]
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Capybara|Capybara]]
| LIHW Public mass interplanetary transit
| [[Species:Humanity|Humanity]]
| [[Faction:League of Independent Human Worlds|LIHW]]
| [[Artstyle guide:LIHW|LIHW]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11819 1]
| {{assg|A}}
| {{open|N}}
|
|
|
| concept refinement and approval
| Fendorin
| {{assg|ASSIGNED}} (Fendorin)(jackS)
|- valign="top"
| [[Vessel:Catfish|Catfish]]
| Utility Mass Transport
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=1980 1], [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=2636 2]
| {{assg|A}}
| {{assg|Y}}
|
|
|
| recover original concept [2]
| [[User:Pontiac|Pontiac]] Oblivion
| {{assg|ASSIGNED}} (pyramid)
|- valign="top"
| [[Vessel:Charillus|Charillus]]
| Aera Mining Craft
| [[Species:Aera|Aera]]
| [[Faction:Aeran Merchant Marine|Aeran Merchant Marine]]
| [[Artstyle guide:Aeran#Civilian|Aeran "Civilian"]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=9068 1]
| {{done|Y}}
| {{done|Y}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{done|Dm}} {{open|No}}
| {{done|Y}}
| {{open|N}}
| needs to be redone to look more Aeran; texture packing
| Fendorin
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Cleombrotus|Cleombrotus]]
| Aera Cargo Mover
| [[Species:Aera|Aera]]
| [[Faction:Aeran Merchant Marine|Aeran Merchant Marine]]
| [[Artstyle guide:Aeran#Civilian|Aeran Civilian]]
| previously assigned to pontiac, thread?
| {{open|N}}
|
|
|
|
| need concept art
|
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Clydesdale|Clydesdale]]
| Cruiser
| [[Species:Humanity|Humanity]]
| Member states of the [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Interstellar Shipping and Mercantile Guild|Interstellar Shipping and Mercantile Guild]]
| x
|
|
|
|
|
| Texture is too small for ship this large. Needs texture touchup + detail textures + bumpmaps. (needs redress for closeup inspections)
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:Convolution|Convolution]]
| Assault (Fighter)
| [[Species:Humanity|Humanity]]
| [[Faction:Unadorned|Unadorned]]
| [[Artstyle guide:Unadorned|Unadorned]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=4043 1]
| {{done|Y}}
| {{assg|Y}}
| {{open|N}}
|
|
| clean mesh. nees textures
| [[User:Etheral walker|Etheral walker]]
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Cultivator|Cultivator]]
| Shaper mining/resource gathering vessel
| [[Species:Humanity|Human]]
| [[Faction:Shaper|Shaper]]
| [[Artstyle guide:Shaper|Shaper]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=9531 1]
| {{done|Y}}
| {{done|Y}}
| {{done|Di}} {{done|Gl}} {{open|Sp}} {{open|Dm}} {{open|No}}
| {{done|Y}}
| {{done|Wi}} {{open|Sc}} [http://vegastrike.sourceforge.net/gallery2/main.php?g2_view=core.ShowItem&g2_itemId=8265 {{done|Wa}}] {{open|Ex}}
| frontend
| Fendorin
| {{done|DONE}}
|}

== D-F ==
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| [[Vessel:Derivative|Derivative]]
| Interceptor
| [[Species:Humanity|Humanity]]
| [[Faction:Unadorned|Unadorned]]
| [[Artstyle guide:Unadorned|Unadorned]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11270 1]
| {{done|Y}}
| {{done|Y}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{done|No}}
| {{assg|Y}}
| {{assg|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| current model: stats, mesh orientation/size/detail, improve textures, engine exhaust. or new model.
| [[User:Deus Siddis|Deus Siddis]] [[User:Nózmájner|Nózmájner]]
| {{assg|ASSIGNED}} (Deus Siddis) (Nózmájner)
|- valign="top"
| [[Vessel:Determinant|Determinant]]
| Fighter
| [[Species:Humanity|Humanity]]
| [[Faction:Unadorned|Unadorned]]
| [[Artstyle guide:Unadorned|Unadorned]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=4401 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{open|Di}} {{open|Gl}} {{open|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{open|Hud}} {{open|St}} {{open|LoD}} {{open|En}}
| {{open|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| needs artstyle guide for texturing. needs texturing.
| [[User:Etheral walker|Etheral walker]] [[User:Nózmájner|Nózmájner]]
| {{assg|ASSIGNED}} (jackS) (Fendorin)
|- valign="top"
| [[Vessel:Diligence|Diligence]]
| Mining Craft
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist|Purist]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=8575 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{open|Gl}} {{open|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{done|En}} | {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| needs shield mesh
| [[User:Fendorin|Fendorin]]
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Dirge|Dirge]]
| Insystem Utility Fighter
| [[Species:Shmrn|Shmrn]]
| [[Faction:Shmrn|Shmrn]]
| [[Artstyle guide:Shmrn|Shmrn]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=2984 1]
|
|
|
|
|
| Finish tweaking cockpit ugliness, figure out what to do with cockpit interior. Add middle LOD, tweak LOD distances. Shield Mesh? Additional (Bump, etc) maps.
| [[User:Strangelet|Strangelet]]
| {{done|DONE}}
|- valign="top"
| [[Vessel:Dodo|Dodo]] Working name is Skate.
| Cargo Tug
| [[Species:Dgn|Dgn]]
| [[Faction:Dgn|Dgn]]
| [[Artstyle guide:Dgn|Dgn]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=5976 1] [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=6851 2] [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=6895 3]
|
|
|
|
|
| Needs Texture (ingame with temp texture)
| [[User:Oblivion|Oblivion]]
| {{done|DONE}}
|- valign="top"
| [[Vessel:Dostoevsky|Dostoevsky]]
| Mass Production Fighter
| [[Species:Klk'k|Klk'k]] & [[Species:Humanity|Humanity]]
| [[Faction:Klk'k|Klk'k]] & [[Faction:Andolian Protectorate|Andolian Protectorate]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| x
|
|
|
|
|
| Shield Mesh? Additional (Bump, Lighting, etc) maps. Minor Touchups at some later date
| [[User:Major|Major]]
| {{done|DONE}}
|- valign="top"
| [[Vessel:Duelist|Duelist]]
| Heavy Fighter constructed by High-Born Luxury Transport Conglomerate under contract from the Hunter’s Guild
| [[Species:Humanity|Humanity]]
| [[Faction:Hunter|Hunter]]
| [[Artstyle guide:Hunter's Guild|Hunter's Guild]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=12007 1]
| {{open|N}}
|
|
|
|
| concept required
| -
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Duke|Duke]]
| Uln Missile Barge
| [[Species:Uln|Uln]]
| [[Faction:Uln|Uln]]
| [[Artstyle guide:Uln(Royal Ingatwa Fleet)|Uln(Royal Ingatwa Fleet)]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7690 1]
| {{done|Y}}
| {{open|Un}} {{open|Sh}} {{open|LoD}}
|
|
|
| needs model. needs textures
| Oblivion
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Duzong|Duzong]]
| Rlaan Occupation Vessel
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan Enforcers|Rlaan Enforcers]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=6181 1]
| {{assg|Y}}
| {{assg|N}}
|
|
|
| needs concept improvement and mesh
| concept:Ares
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Elephant|Elephant]]
| Merchant Mega-Hauler
| [[Species:Humanity|Humanity]]
| [[Faction:Interstellar Shipping and Mercantile Guild|Interstellar Shipping and Mercantile Guild]]
| [[Artstyle guide:Interstellar Shipping and Mercantile Guild|Interstellar Shipping and Mercantile Guild]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=13248 1]
| {{assg|Y}}
|
|
|
|
| concept approval
| programmerandrew
| {{assg|ASSIGNED}} (jackS)
|- valign="top"
| [[Vessel:Ellison|Ellison]]
| Private yacht
| [[Species:Humanity|Humanity]]
| [[Faction:Highborn|Highborn]]
| [[Artstyle guide:Highborn|Highborn]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=4423 1]
| {{done|Y}}
| {{done|Y}}
| {{open|Di}} {{open|Gl}} {{open|Sp}} {{open|Dm}} {{open|No}}
| {{open|N}}
| {{open|N}}
| both concepts are vialble; textures
| [[User:tiny paintings|tiny paintings]]
| {{assg|ASSIGNED}} (chuck_starchaser)
|- valign="top"
| [[Vessel:Emu|Emu]]
| Planetary Lift Vehicle
| [[Species:Dgn|Dgn]]
| [[Faction:Dgn|Dgn]]
| [[Artstyle guide:Dgn|Dgn]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=9125 1]
| {{done|Y}}
| {{done|Y}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{done|Dm}} {{open|No}}
| {{assg|Y}}
| {{open|N}}
| needs stats
| Fendorin
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Entourage|Entourage]]
| Luxury Personal Transportation
| [[Species:Humanity|Humanity]]
| [[Faction:Luxury Travel Conglomerate|Luxury Travel Conglomerate]]
| [[Artstyle guide:Luxury Travel Conglomerate|Luxury Travel Conglomerate]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=9074 1]
| {{done|Y}}
| {{done|Un}} {{done|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{done|En}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| stats review. needs frontend.
| Fendorin
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Eurypon|Eurypon]]
| Aeran Exploration/Science Vessel
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?p=101500 1]
| {{assg|A}}
|
|
|
|
| improve concept
| Fendorin
| {{assg|ASSIGNED}} (Fendorin)
|}

== G-I ==
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| [[Vessel:Galahad|Galahad]]
| High-Born multi-purpose corvette
| [[Species:Humanity|Humanity]]
| [[Faction:Highborn|High-Born]]
| [[Artstyle guide:Highborn|Highborn]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?p=101500 1]
| {{done|Y}}
| {{open|Un}} {{open|Sh}} {{open|LoD}}
| {{open|Di}} {{open|Gl}} {{open|Sp}} {{open|Dm}} {{open|No}}
| {{open|Un}} {{open|Hud}} {{open|St}} {{open|LoD}} {{open|En}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| model ship
| Fendorin
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Gaozong|Gaozong]]
| Mobile Sensor Drone
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7315 1]
|
|
|
|
|
| Needs in-game testing - custom shield meshes, etc? Needs stats, currently dummy stats.
| Oblivion
| {{done|DONE}}
|- valign="top"
| [[Vessel:Gawain|Gawain]]
| Highborn Interceptor
| [[Species:Humanity|Humanity]]
| [[Faction:Highborn|Highborn]]
| [[Artstyle guide:Highborn|Highborn]]
| -
|
|
|
|
|
| Custom shield mesh? (can't recall). Factional textures (like everything else).
| Howard E. Day (Additional factional textures by Oblivion)
| {{done|DONE}}
|- valign="top"
| [[Vessel:Gleaner|Gleaner]] (Ishmael Cruiser/Voidfish model)
| Freighter.
| [[Species:Uln|Uln]]
| [[Faction:Uln|Uln]]
| [[Artstyle guide:Uln(Non-Fleet)|Uln(Non-Fleet)]]
| x
|
|
|
|
|
| Clean up masts and engines (assigned to [[User:Halleck|Halleck]]), Minor touchups
| [[User:Strangelet|Strangelet]]
| {{done|DONE}}
|- valign="top"
| [[Vessel:Goddard|Goddard]]
| Bomber, recent
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]]
| [[Artstyle guide:Andolian|Andolian]]
| -
|
|
|
|
|
| needs custom turrets. shield mesh. canon-redressing.
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:GTIO|GTIO]]
| "Sports/Muscleship" civilian vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist#Civilian|Purist Civilian]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=2984 1]
|
|
|
|
|
| Custom shield mesh, additional textures. unit has dummy stats. Needs hud pic.
| Strangelet (submitted as Inachiel)
| {{done|DONE}}
|- valign="top"
| [[Vessel:H496|H496]]
| Limousine for the starfaring crowd
| [[Species:Humanity|Humanity]]
| [[Faction:Luxury Travel Conglomerate|Luxury Travel Conglomerate]]
| [[Artstyle guide:Luxury Travel Conglomerate|Luxury Travel Conglomerate]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=9024 1]
| {{done|Y}}
| {{done|Un}} {{done|Sh}}
'''LoD'''
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{done|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{assg|St}} {{open|LoD}} {{done|En}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| stats tweaking
| [[User:Fendorin|Fendorin]]
| {{done|DONE}}
|- valign="top"
| [[Vessel:Hammer|Hammer]]
| LIHW Heavy fighter (aka "Toad")
| [[Species:Humanity|Humanity]]
| [[Faction:League of Independent Human Worlds|LIHW]], [[Faction:Interstellar Socialist Organization|ISO]]
| [[Artstyle guide:LIHW|LIHW]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=4708 1]
| {{done|Y}}
| {{done|Y}}
| {{assg|A}}
| {{open|N}}
| {{open|N}}
| model review and textures
| [[User:tiny paintings|tiny paintings]]
| {{assg|ASSIGNED}} (chuck_starchaser)
|- valign="top"
| [[Vessel:Hawking|Hawking]]
| Anti-Capital Energy-based Cruiser
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]]
| [[Artstyle guide:Andolian|Andolian]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=8928 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{done|No}}
| {{done|Un}} {{done|Hud}} {{done|St}} {{open|LoD}} {{done|En}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| needs shield mesh.
| Oblivion
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Hidalgo|Hidalgo]]
| Luxury yacht
| [[Species:Humanity|Humanity]]
| Highborn, Pirates
| [[Artstyle guide:Highborn#Luxury Travel Conglomerate|Higborn Luxury Travel Conglomerate]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=1688 1]
|
|
|
|
|
| new textures. model to be replaced.
| Ares (model) Oblivion (textures)
| {{done|DONE}}
|- valign="top"
| [[Vessel:Hyena|Hyena]]
| Heavy "fighter" design.
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]] & various pirate groups and civvies.
| [[Artstyle guide:Forsaken|Forsaken]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=1955 1] [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=9636 2]
|
|
|
|
|
| Custom shield mesh? Additional textures.
| Howard E. Day (Additional textures by Oblivion)
| {{done|DONE}}
|}

== J-L ==
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| [[Vessel:Jackal|Jackal]]
| Forsaken Interceptor, newer than Hyena.
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7413 1] [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=12023 2]
| {{assg|Y}}
| {{open|N}}
| {{open|N}}
| {{open|N}}
| {{open|N}}
| needs remodeling
| Oblivion
| {{assg|ASSIGNED}} (Phlogios)
|- valign="top"
| [[Vessel:Kafka|Kafka]]
| Unarmed light cargo shuttle
| [[Species:Klk'k|Klk'k]]
| [[Faction:Klk'k|Klk'k]] (actually used throughout Protectorate)
| [[Artstyle guide:Klk'k|Klk'k]]
| -
|
|
|
|
|
| More texturing. Eventual retouch. Custom shield mesh. Needs re-stat
| PeteyG?
| {{done|DONE}}
|- valign="top"
| [[Vessel:Kahan|Kahan]]
| Modern, but aging Andolian destroyer
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]] (& Protectorate, and Confed Fleet)
| [[Artstyle guide:Andolian|Andolian]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=10205 1] [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11851 2]
| {{done|Y}}
| {{done|Un}} {{done|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{done|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{open|En}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| screen shot. wallpaper.
| [[User:Fendorin|Fendorin]]
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Kierkegaard|Kierkegaard]]
| Torpedo Boat
| [[Species:Klk'k|Klk'k]]
| [[Faction:Klk'k|Klk'k]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=2117 1]
|
|
|
|
|
| More textures, custom shield meshes, custom turrets. could really use some custom turret art. Unit needs re-stat
| Major
| {{done|DONE}}
|- valign="top"
| [[Vessel:Knight|Knight]]
| Uln Interceptor
| [[Species:Uln|Uln]]
| [[Faction:Uln|Uln]]
| [[Artstyle guide:Uln(Royal Ingatwa Fleet)|Uln(Royal Ingatwa Fleet)]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11884 1]
| {{done|Y}}
| {{done|Un}} {{done|Sh}} '''LoD'''
| {{done|Di}} {{done|Sp}} {{open|Dm}} {{done|Gl}} {{done|No}}
| {{done|Un}} {{done|Hud}} {{open|St}}
| {{done|Wi}} [http://vegastrike.sourceforge.net/gallery2/main.php?g2_view=core.DownloadItem&g2_itemId=9809&g2_serialNumber=2 {{done|Sc}}] {{open|Wa}} {{open|Ex}}
| stats. wallpaper.
| Fendorin
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Koala|Koala]]
| LIHW Space Taxi.
| [[Species:Humanity|Humanity]]
| [[Faction:League of Independent Human Worlds|LIHW]]
| LIHW
| -
|
|
|
|
|
| Add blinking lights (blink.ani), touch-ups later
| Strangelet
| {{done|DONE}}
|- valign="top"
| [[Vessel:Lancelot|Lancelot]]
| Extremely capable, but questionably cost-effective, superiority fighter
| [[Species:Humanity|Humanity]]
| [[Faction:Highborn|Highborn]]
| [[Artstyle guide:Highborn|Highborn]]
| x
|
|
|
|
|
| Factional textures.
| Howard E.Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:Lemma|Lemma]]
| Corvette
| [[Species:Humanity|Humanity]]
| [[Faction:Unadorned|Unadorned]]
| [[Artstyle guide:Unadorned|Unadorned]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=12019 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{assg|A}}
| {{open|N}}
| {{open|N}}
| model needs cleaning. shield and LOD meshes. needs texturing.
| [[User:Nózmájner|Nózmájner]]
| {{assg|ASSIGNED}} (Nózmájner)
|- valign="top"
| [[Vessel:Llama|Llama]]
| LIHW light mixed-cargo shuttle
| [[Species:Humanity|Humanity]]
| [[Faction:League of Independent Human Worlds|LIHW]]
| [[Artstyle guide:LIHW|LIHW]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=2018 1]
|
|
|
|
|
| Custom shield mesh, factional textures. face lift at some later point in time
| PeteyG
| {{done|DONE}}
|}

== M-O ==
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| [[Vessel:MacGyver|MacGyver]]
| Maintenance and Construction Flyer
| [[Species:Humanity|Human]]
| [[Faction:Spaceborn|Spaceborn]]
| [[Artstyle guide:Spaceborn|Spaceborn]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=9474 1]
| {{done|Y}}
| {{done|Un}} {{done|Sh}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{done|No}}
| {{done|Un}} {{done|Hud}} {{done|En}} {{open|St}}
| {{done|Wi}} {{open|Sc}} [http://vegastrike.sourceforge.net/gallery2/main.php?g2_view=core.ShowItem&g2_itemId=10214 {{done|Wa}}] [http://vegastrike.sourceforge.net/gallery2/main.php?g2_view=core.ShowItem&g2_itemId=10216 {{done|WWa2}}] {{open|Ex}}
| screenshot. stats.
| Fendorin
| {{done|DONE}}
|- valign="top"
| [[Vessel:Midwife|Midwife]]
| Shaper Auxiliary Carrier
| [[Species:Humanity|Humanity]]
| [[Faction:Shaper|Shaper]]
| [[Artstyle guide:Shaper|Shaper]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=8395 1]
| {{assg|A}}
| {{done|Y}}
| {{done|Y}}
| {{assg|A}}
| {{open|N}}
| Improve new concept.
| [[User:Fendorin|Fendorin]]
| {{assg|ASSIGNED}} (Fendorin)
|- valign="top"

| [[Vessel:Battle Cruiser Mk. 32|Mk. 32 Battle Cruiser]]
| Battle Cruiser constructed by [[Faction:Mechanist|Mechanists]] under Confed contract. Recent
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Mechanist|Mechanist]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=8377 1] [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=12001 2]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} | {{done|Di}} {{done|Gl}} {{done|Sp}} {{done|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|En}} {{open|St}}
| {{done|Wi}} [http://vegastrike.sourceforge.net/forums/cpg/displayimage.php?pid=1140&fullsize=1 {{done|Sc}}] {{open|Wa}} {{open|Ex}}
| stats.
| [[User:Fendorin|Fendorin]]
| {{done|DONE}}
|- valign="top"

| [[Vessel:Interceptor Mk. 212|Mk. 212 Interceptor]]
| Mechanist Interceptor (Missile based)
| [[Species:Humanity|Humanity]]
| [[Faction:Mechanist|Mechanist]]
| [[Artstyle guide:Mechanist|Mechanist]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7496 1]
| {{done|Y}}
| {{assg|A}}
| {{open|N}}
| {{open|N}}
| {{open|N}}
| recover model
| Oblivion
| {{assg|ASSIGNED}} (Oblivion)
|- valign="top"
| [[Vessel:Mule|Mule]]
| Logistical Support Rapid Resupply vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Interstellar Shipping and Mercantile Guild|Merchant]]
| [[Artstyle guide:Interstellar Shipping and Mercantile Guild|Merchant]]
| -

|
|
|
|
|
| Factional texture touchups, custom turrets.
| Howard E. Day
| {{done|DONE}}
|- valign="top"

| [[Vessel:Nicander|Nicander]]
| Interceptor
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=13251 1]
| {{assg|Y}}
|
|
|
|
| new concept approval
| Nozmajner, Howard E. Day
| {{assg|ASSIGNED}} (jackS) (Nozmajner)
|- valign="top"
| [[Vessel:Nietzsche|Nietzsche]]
| Capital Escort (Destroyer)
| [[Species:Humanity|Humanity]], [[Species:Klk'k|Klk'k]]
| [[Faction:Andolian Protectorate|Andolian Protectorate]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11168 1] [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=12123 2]
| {{done|Y}}
| {{assg|Y}}
| {{open|N}}
| {{open|N}}
| {{open|N}}
| model detailing. textures.
| [[User:Etheral Walker|Etheral Walker]], [[User:CubOfJudahsLion|CoJL]], [[User:bgaskey|bgaskey]]
| {{open|OPEN}}
|- valign="top"

| [[Vessel:Ox|Ox]]
| Container transport
| [[Species:Humanity|Humanity]]
| [[Faction:Interstellar Shipping and Mercantile Guild|Merchant]]
| [[Artstyle guide:Interstellar Shipping and Mercantile Guild|Interstellar Shipping and Mercantile Guild]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=13481 1]
|
|
|
|
|
| Needs integration
| Pincushionman
| {{assg|ASSIGNED}} (pyramid)
|}

== P-R ==
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| [[Vessel:Pacifier|Pacifier]]
| Aging Fighter-Bomber
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist|Purist]]
| -
|
|
|
|
|
| Shield mesh? Factional textures.
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:Patterson|Patterson]]
| Andolian Escort Frigate
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]]
| [[Artstyle guide:Andolian|Andolian]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7967 1]
| {{done|N}}
| {{assg|N}}
|
|
|
| improve concept
| [[User:Phlogios|Phlogios]]
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Pavlov|Pavlov]]
| Andolian Bomber and Interceptor Drone.
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian Protectorate|Andolian Protectorate]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11883 1]
| {{done|Y}}
| {{open|Un}} {{open|Sh}} {{open|LoD}}
|
|
|
| needs mesh
| Fendorin
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Plowshare|Plowshare]]
| Cargo Shuttle
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist|Purist]]
| -
|
|
|
|
|
| Factional Texturing
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:Polydectes|Polydectes]]
| Aeran Escort Corvette
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7413 1] [http://vegastrike.sourceforge.net/forums/viewtopic.php?p=101736 2]
| {{assg|A}}
|
|
|
|
| improve concept
| Oblivion
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Progenitor|Progenitor]]
| Shaper Terraforming Ship
| [[Species:Humanity|Humanity]]
| [[Faction:Shaper|Shaper]]
| [[Artstyle guide:Shaper|Shaper]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=8377 1]
| {{assg|N}}
|
|
|
|
| concept required
| Fendorin
| {{assg|ASSIGNED}} (Fendorin)
|- valign="top"
| [[Vessel:Progeny|Progeny]]
| Light Interceptor
| [[Species:Humanity|Humanity]]
| [[Faction:Shaper|Shaper]]
| [[Artstyle guide:Shaper|Shaper]]
| x
|
|
|
|
|
| Factional textures, eventual canon related redress. good model, but DO NOT, IN ANY WAY use as basis for Shaper art.
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:Prytanis|Prytanis]]
| Unarmed Aeran Shuttle
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7413 1] [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=13251 2]
| {{assg|Y}}
| {{open|N}}
| {{open|N}}
| {{open|N}}
| {{open|N}}
| concept approval
| Nozmajner, Oblivion (concept)
| {{assg|ASSIGNED}} (jackS) (Nozmajner)
|- valign="top"
| [[Vessel:Quicksilver|Quicksilver]]
| Courier Ship
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| -
|
|
|
|
|
| Factional Texturing, Shield Mesh. Minor Touchups Desired
| Major
| {{done|DONE}}
|- valign="top"
| [[Vessel:Raven|Raven]]
| Most recent Forsaken superiority fighter.
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=12007 1]
| {{assg|A}}
|
|
|
|
| concept improvement
| Fendorin
| {{assg|ASSIGNED}} (Fendorin)
|- valign="top"
| [[Vessel:Redeemer|Redeemer]]
| Fighter
| [[Species:Humanity|Humanity]]
| [[Faction:Interstellar Church of True Form's Return|Luddites]]
| [[Artstyle guide:Interstellar Church of True Form's Return|Interstellar Church of True Form's Return]]
| -
|
|
|
|
|
| Shield Mesh, touchup work? Missing engine pontoons.
| Etheral Walker
| {{done|DONE}}
|- valign="top"
| [[Vessel:Regret|Regret]]
| Shmrn Insystem Superiority Fighter
| [[Species:Shmrn|Shmrn]]
| [[Faction:Shmrn|Shmrn]]
| [[Artstyle guide:Shmrn|Shmrn]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=9729 1]
| {{done|Y}}
| {{done|Un}} {{done|Sh}} '''LoD'''
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{done|No}}
| {{done|Un}} {{done|Hud}} {{done|En}} {{open|St}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| stats. frontend.
| Fendorin
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Reindeer|Reindeer]]
| Merchant cargo transfer shuttle.
| [[Species:Humanity|Humanity]]
| [[Faction:Interstellar Shipping and Mercantile Guild|Merchants]]
| [[Artstyle guide:Interstellar Shipping and Mercantile Guild|Interstellar Shipping and Mercantile Guild]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7528 1]
| {{assg|Y}}
|
|
|
|
| improve and finalize concept.
| Phlogios
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Robin|Robin]]
| Venerable LIHW multi-role fighter craft
| [[Species:Humanity|Humanity]]
| [[Faction:League of Independent Human Worlds|LIHW]]
| [[Artstyle guide:LIHW|LIHW]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11605 1]
| {{done|Y}}
| {{assg|A}}
| {{assg|A}}
| {{open|N}}
| {{open|N}}
| new model and textures
| [[User:Terazilla|Terazilla]]
| {{assg|ASSIGNED}} (Terazilla)
|- valign="top"
| [[Vessel:Ruizong|Ruizong]]
| Destroyer
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| -
| {{done|Y}}
| {{done|Un}} {{done|Sh}} {{open|LoD}}
| {{done|Di}} {{open|Gl}} {{done|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} '''En'''
| {{open|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| stats. wiki profile.
| Howard E. Day
| {{assg|ASSIGNED}} (pyramid)
|}

== S-U ==
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| [[Vessel:Sartre|Sartre]]
| Shuttle
| [[Species:Klk'k|Klk'k]] and [[Species:Humanity|Humanity]]
| [[Faction:Klk'k|Klk'k]], [[Faction:Purth|Purth]], and [[Faction:Andolian|Andolian]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=1376 1]
|
|
|
|
|
| Texture touchups, shield mesh, factionalizations.
| Major
| {{done|DONE}}
|- valign="top"
| [[Vessel:Schroedinger|Schroedinger]]
| Scout craft
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]]
| [[Artstyle guide:Andolian|Andolian]] current model is non-canon.
| -
|
|
|
|
|
| Factional textures? Shield Mesh?
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:SeaxBane|SeaxBane]]
| Station security drone
| [[Species:Humanity|Humanity]]
| [[Faction:Highborn|Highborn]]
| [[Artstyle guide:Highborn|Highborn]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=8627 1]
| {{done|Y}}
| {{done|Y}}
| {{done|Y}}
| {{done|Y}}
| {{open|N}}
| wiki description, screen shots
| Oblivion
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Shenzong|Shenzong]]
| Cargo Shuttle
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan Civilian]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7352 1]
|
|
|
|
|
| ALL
| Oblivion
| {{done|DONE}}
|- valign="top"
| [[Vessel:Shizong|Shizong]]
| Light, rapid response craft
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan_Enforcers|Rlaan Enforcers]]
| [[Artstyle guide:Rlaan_Enforcers|Rlaan Enforcers]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=9601 1]
|
|
|
|
|
| ALL
| Oblivion
| {{done|DONE}}
|- valign="top"
| [[Vessel:Shizu|Shizu]]
| Rlaan Scout ship
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| -
|
|
|
|
|
| shield mesh?
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:Shundi|Shundi]] (aka 'lodur')
| Rlaan Cruiser
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| -
|
|
|
|
|
| x
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:Sickle|Sickle]]
| Interceptor
| [[Species:Humanity|Humanity]]
| [[Faction:ISO|ISO]], [[Faction:League of Independent Human Worlds|LIHW]], and [[Faction:Hunter|Hunter]]
| [[Artstyle guide:LIHW|LIHW]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=10875 1]
[http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11697 2]
| {{assg|Y}}
| {{open|N}}
| {{open|N}}
| {{open|N}}
| {{open|N}}
| concept improvement
| Dunkelheit
| {{assg|ASSIGNED}} (Dunkelheit)
|- valign="top"
| [[Vessel:Squire|Squire]]
| Uln Flight Tender
| [[Species:Uln|Uln]]
| [[Faction:Uln|Uln]]
| [[Artstyle guide:Uln(Royal Ingatwa Fleet)|Uln(Royal Ingatwa Fleet)]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=8615 1]
| {{open|N}}
|
|
|
|
| concept required
|
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Taizong|Taizong]]
| Assault Craft (Fighter/Bomber)
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| -
|
|
|
|
|
| Shield mesh.
| Howard E. Day
| {{done|DONE}}
|- valign="top"
| [[Vessel:Thales|Thales]]
| Corvette
| [[Species:Humanity|Humanity]] / Various
| original of [[Faction:Andolian|Andolian]] manufacture
| [[Artstyle guide:Andolian|Andolian]]
| -
|
|
|
|
|
| Shield meshes, factional textures. Minor Touchups warranted.
| Etheral Walker
| {{done|DONE}}
|- valign="top"
| [[Vessel:Tridacna|Tridacna]]
| Forsaken FTL Colony Ship
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=8633 1]
| {{done|Y}}
| {{done|Un}} {{done|Sh}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{done|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{done|En}}
| {{done|Wi}} {{open|Sc}} [http://vegastrike.sourceforge.net/gallery2/main.php?g2_view=core.ShowItem&g2_itemId=9488 {{done|Wa}}] {{open|Ex}}
| screenshot. needs stats.
| [[User:Fendorin|Fendorin]]
| {{open|OPEN}}
|}

== V-Z ==
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| [[Vessel:Vendetta|Vendetta]]
| Light Fighter
| [[Species:Humanity|Humanity]]
| [[Faction:Hunter|Hunter]]
| [[Artstyle guide:Hunter's Guild|Hunter's Guild]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7784 1]
|
|
|
|
|
| * LODs(?) If absolutely needed, the polycount is quite low. * No shield mesh. * More factional textures? * Additional lights animation might be nice. * Needs better/more engine placements.
| Oblivion
| {{done|DONE}}
|- valign="top"
| [[Vessel:Vigilance|Vigilance]]
| Purist Corvette
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist|Purist]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=8377 1] [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=8400 2]
| {{done|Y}}
| {{done|Un}} {{open|Sh}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{done|Dm}} {{done|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|En}}
| {{done|Wi}} {{open|Sc}} [http://vegastrike.sourceforge.net/gallery2/main.php?g2_view=core.ShowItem&g2_itemId=10222 {{done|Wa}}] {{open|Ex}}
| frontend
| Fendorin
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Vulture|Vulture]]
| Forsaken Corvette
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=4658 1]
| {{assg|Y}}
|
|
|
|
| improve concept
| tiny paintings
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Watson|Watson]]
| Flight Tender & Auxiliary Carrier
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]] and allied groups
| [[Artstyle guide:Andolian|Andolian]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=10205 1]
|
|
|
|
|
| Punch it in, figure out what to do with variants
| Fendorin
| {{done|DONE}}
|- valign="top"
| [[Vessel:Xuanzong|Xuanzong]]
| Rlaan Gas Miner
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=10167 1]
| {{done|Y}}
| {{done|Y}}
| {{done|Di}} {{open|Gl}} {{open|Sp}} {{open|Sh}} {{open|Dm}} {{open|Ao}} {{open|De}} {{open|No}} {{open|Dt}}
| {{done|Y}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| frontend
| [[User:Fendorin|Fendorin]]
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Yeoman|Yeoman]] ("Stoic" model)
| Container freighter.
| [[Species:Uln|Uln]]
| [[Faction:Uln|Uln]]
| [[Artstyle guide:Uln(Non-Fleet)|Uln(Non-Fleet)]]
| -
|
|
|
|
|
| ?
| [[User:Strangelet|Strangelet]]
| {{done|DONE}}
|- valign="top"
| [[Vessel:Zhuangzong|Zhuangzong]]
| Fighter
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| x
|
|
|
|
|
| Shield meshes? Touchups?
| Howard E. Day
| {{done|DONE}}
|}

== Unassigned and Private Vessels ==
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| Atlantia (codename)
| ?
| ?
| ?
| ?
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=6475 1]
| {{assg|Y}}
|
|
|
|
|
| chrisdn
| {{open|OPEN}}
|- valign="top"
| CT1000
| LIHW
| LIHW
| LIHW
| [[Artstyle guide:LIHW|LIHW]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=12134 1]
| {{done|Y}}
| {{done|Y}}
| {{open|N}}
|
|
| needs textures
| rivalin
| {{open|OPEN}}
|- valign="top"
| CT2000
| LIHW Corporate Shuttle manufactured by Wake Industries
| LIHW
| LIHW
| [[Artstyle guide:LIHW|LIHW]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11630 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|En}} {{open|St}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| needs improved textures. shield mesh. engine glow.
| rivalin
| {{open|OPEN}}
|- valign="top"
| CT3000
| LIHW
| LIHW
| LIHW
| [[Artstyle guide:LIHW|LIHW]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=12134 1]
| {{done|Y}}
| {{done|Y}}
| {{open|N}}
|
|
| needs textures
| rivalin
| {{open|OPEN}}
|- valign="top"
| Dragan
| Super Cargo Vessel
| [[Species:Humanity|Humanity]]
| Member states of the [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Interstellar Shipping and Mercantile Guild|Interstellar Shipping and Mercantile Guild]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11820 1]
| {{assg|Y}}
|
|
|
|
|
| rivalin
| {{assg|ASSIGNED}} (rivalin)
|- valign="top"
| Private Assault Ship
|
| Humanity
| Used by private security forces and obscure organizations
| Highborn
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=7390 1]
| {{open|Y}}
|
|
|
|
| improve existing concept
| Oblivion
| {{open|OPEN}}
|- valign="top"
| Science Vessel
| Highborn Science Ship
| Humanity
| [[Artstyle guide:Highborn|Highborn]]
| -
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=4303 1]
| {{done|A}}
|
|
|
|
| continue modeling
| Ares
| {{open|OPEN}}
|- valign="top"
| Transporter
| Uln Transporter
| [[Species:Uln|Uln]]
| [[Faction:Uln|Uln]]
| [[Artstyle guide:Uln|Uln]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11946 1]
| {{done|A}}
|
|
|
|
| concept improvement
| Sindwiller
| {{assg|ASSIGNED}} (Sindwiller)
|- valign="top"
| Unknown Vessel
| -
| -
| -
| -
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11949 1]
| {{assg|A}}
|
|
|
|
| concept development
| Ares
| {{assg|ASSIGNED}} (Ares)
|}

==Concept Art Requested==
* Models in this category are unclaimed by any artist and work on them has not commenced.

{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| [[Vessel:Agesilaus|Agesilaus]]
| Diplomatic Transport
| [[Species:Aera|Aera]]
|
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Alcmenes|Alcmenes]]
| Dropship
| [[Species:Aera|Aera]]
|
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Anaxander|Anaxander]]
| Cruiser, Old
| [[Species:Aera|Aera]]
|
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Anaxandridas|Anaxandridas]]
| Battle Cruiser
| [[Species:Aera|Aera]]
|
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Anaxidamus|Anaxidamus]] (formerly 'Yrilan')
| Heavy Cruiser, Recent
| [[Species:Aera|Aera]]
|
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ''needs new model+texture''
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Andi|Andi]]
| Orbital Cargo Transport
| [[Species:Rlaan|Rlaan]]
|
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Assault Shuttle Mk. 85|Mk. 85]]
| Assault Shuttle/Boarding craft
| [[Species:Humanity|Humanity]]
| [[Faction:Mechanist|Mechanist]]
| [[Artstyle guide:Mechanist|Mechanist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Baird|Baird]]
| Aged System Patrol Boat
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]]
| [[Artstyle guide:Andolian|Andolian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Beauvoir|Beauvoir]]
| Primarily Klk'k operated (mixed Klk'k & Human crew) Mixed Transport vessel, used throughout [[Faction:Andolian Protectorate|Andolian Protectorate]] space.
| [[Species:Klk'k|Klk'k]] & [[Species:Humanity|Humanity]]
| Multiple
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Beholder|Beholder]]
| Drone ship
| [[Species:Ancients|Ancients]]
|
| [[Artstyle guide:Ancients|Ancients]]
| x
|
|
|
|
|
| ''deserves new texture, deserves new model''
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Bomber Mk. 37|Mk. 37]]
| Bomber
| [[Species:Humanity|Humanity]]
| [[Faction:Mechanist|Mechanists]]
| [[Artstyle guide:Mechanist|Mechanist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:CARD|CARD]] Confederation Atmosphere Reprocessing Drone
| Atmosphere Reprocessing Drone made for the Confederation by the Andolians
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian Protectorate|Andolian Protectorate]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:CHARM|CHARM]]
| Confederation Homing Advanced Reconnaissance Motile
| [[Species:Humanity|Humanity]]
| [[Faction:Unadorned|Unadorned]]
| [[Artstyle guide:Unadorned|Unadorned]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Chengdi|Chengdi]]
| Lander
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Chengzong|Chengzong]]
| Refuse & Salvage Scow
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Chongdi|Chongdi]]
| Cargo Shuttle
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Chudi|Chudi]]
| Resupply ship
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:CILiA|CILiA]]
| Confederation Initial Lifeform Applicator. Secondary Terraforming Vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confed]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Cleomenes|Cleomenes]]
| Mobile Sensor Platform
| [[Species:Aera|Aera]]
| Multiple
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:COMB|COMB]]
| Confederation Osmotic Mining Boat (Gas Miner)
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Condor|Condor]]
| Frigate
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Continuity|Continuity]]
| Colonization Vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist|Purist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Consequence|Consequence]]
| Interceptor
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist|Purist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:CoTTON|CoTTON]]
| Confederation Total Terraforming Operations Nexus. Primary Confed Terraforming vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Crayfish|Crayfish]]
| Gunboat, Recent
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:CUSP|CUSP]]
| Confederation Universal Scientific Platform. Confed Science/Exploration vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Daizong|Daizong]]
| Flight Tender (Methane)
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Demaratus|Demaratus]]
| "Aenethformer" Auxiliary
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Dependent|Dependent]]
| Assault Shuttle
| [[Species:Humanity|Humanity]]
| [[Faction:Shaper|Shaper]]
| [[Artstyle guide:Shaper|Shaper]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Dezong|Dezong]]
| Battleship
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Dorissus|Dorissus]]
| Flight Tender
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Dropship Mk. 302|Mk. 302]]
| Drop Ship
| [[Species:Humanity|Humanity]]
| [[Faction:Mechanist|Mechanist]]
| [[Artstyle guide:Mechanist|Mechanist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Duanzong|Duanzong]]
| Orbital Sniper Ship, Recent
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} Priority: Medium
|- valign="top"
| [[Vessel:Echestratus|Echestratus]]
| Scout Frigate
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Edison|Edison]]
| Drone manager
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian Protectorate|Andolian Protectorate]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Eurycratides|Eurycratides]]
| Communications Vessel
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Faraday|Faraday]]
| Shock Trooper Support Craft
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian Protectorate|Andolian Protectorate]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Feidi|Feidi]]
| Dropship (Orbit-Ground Assault landing/supply)
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Forebear|Forebear]]
| Colonization Vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Shaper|Shaper]]
| [[Artstyle guide:Shaper|Shaper]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Fortitude|Fortitude]]
| Planetary Landing Craft
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist|Purist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Franklin|Franklin]]
| Diplomatic transport
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]]
| [[Artstyle guide:Andolian|Andolian]]
| x
|
|
|
|
|
| needs new texture, deserves new model+texture
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Gaodi|Gaodi]]
| Forcible Compliance Planetary Drone Craft
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Gaozu|Gaozu]]
| Chlorine (for Saahasayaay) Flight Tender
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Gondi|Gondi]]
| Colonization ship
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Gongti|Gongti]]
| (Oxygen-breathing) client colonization ship
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Guangzong|Guangzong]]
| Repair/Maintenance craft
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Hagfish|Hagfish]]
| Space-Marine Boarding Unit
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Han|Han]]
| Exploration Ship
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Humility|Humility]]
| Refuse and Salvage Scow
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist|Purist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Interceptor Mk. 273|Mk. 273]]
| Interceptor (Spinal Mount based)
| [[Species:Humanity|Humanity]]
| [[Faction:Mechanist|Mechanist]]
| [[Artstyle guide:Mechanist|Mechanist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Janissary|Janissary]]
| Rlaan constructed Fighter/Assault
| [[Species:Saahasayaay|Saahasayaay]]
| [[Faction:Saahasayaay|Saahasayaay]]
| [[Artstyle guide:Saahasayaay|Saahasayaay]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Jouppi|Jouppi]]
| Multi-species capable colonization vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian Protectorate|Andolian Protectorate]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Kindred|Kindred]]
| Mini Troop ship
| [[Species:Humanity|Humanity]]
| [[Faction:Shaper|Shaper]]
| [[Artstyle guide:Shaper|Shaper]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Kiwi|Kiwi]]
| Cargo container mover
| [[Species:Dgn|Dgn]]
| [[Faction:Dgn|Dgn]]
| [[Artstyle guide:Dgn|Dgn]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Lament|Lament]]
| Passenger Transport
| [[Species:Shmrn|Shmrn]]
| [[Faction:Shmrn|Shmrn]]
| [[Artstyle guide:Shmrn|Shmrn]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Lander Mk. 159|Mk. 159]]
| Planetary Lander
| [[Species:Humanity|Humanity]]
| [[Faction:Mechanist|Mechanist]]
| [[Artstyle guide:Mechanist|Mechanist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Leon|Leon]]
| Resupply Vessel
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Leonidas|Leonidas]] (formerly 'Yavok')
| Newly introduced Dreadnaught
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| Needs new model and texture (ALL)
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Mach|Mach]]
| Dropship
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian Protectorate|Andolian Protectorate]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Maxwell|Maxwell]]
| Orbital Troop Insertion Vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian Protectorate|Andolian Protectorate]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:MESS|MESS]]
| Mishtali Experimental Slingshot Ship
| [[Species:Mishtali|Mishtali]]
| [[Faction:Mishtali|Mishtali]]
| [[Artstyle guide:Mishtali|Mishtali]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Miner Mk. 351|Mk. 351]]
| Mining craft
| [[Species:Humanity|Humanity]]
| [[Faction:Mechanist|Mechanist]]
| [[Artstyle guide:Mechanist|Mechanist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Monaco|Monaco]]
| Luxury Mega-Cruiseship
| [[Species:Humanity|Humanity]]
| [[Faction:Luxury Travel Conglomerate|Luxury Travel Conglomerate]]
| [[Artstyle guide:Luxury Travel Conglomerate|Luxury Travel Conglomerate]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Niniane|Niniane]]
| Auxiliary Carrier
| [[Species:Humanity|Humanity]]
| [[Faction:Highborn|Highborn]]
| [[Artstyle guide:Highborn|Highborn]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Otto-Maddox|Otto-Maddox]]
| Salvage vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Spaceborn|Spaceborn]]
| [[Artstyle guide:Spaceborn|Spaceborn]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Pacific|Pacific]]
| Personal Transport
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist|Purist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Patience|Patience]]
| Commuter Passenger Spacecraft
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist|Purist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Patrol Boat Mk. 460|Mk. 460]]
| System Patrol Craft
| [[Species:Humanity|Humanity]]
| [[Faction:Mechanist|Mechanist]]
| [[Artstyle guide:Mechanist|Mechanist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Pausanias|Pausanias]]
| Gas Miner
| [[Species:Aera|Aera]]
| [[Faction:Aeran Merchant Marine|Aeran Merchant Marine]]
| [[Artstyle guide:Aeran Merchant Marine|Aeran Merchant Marine]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Pelleus|Pelleus]]
| Newest High-Born Interceptor
| [[Species:Humanity|Humanity]]
| [[Faction:Highborn|Highborn]]
| [[Artstyle guide:Highborn|Highborn]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Penitence|Penitence]]
| Prisoner Transport
| [[Species:Humanity|Humanity]]
| [[Faction:Homeland Security|Homeland Security]]
| [[Artstyle guide:Homeland Security|Homeland Security]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:People-Mover Mk. 78|Mk. 78]]
| Passenger Hauler
| [[Species:Humanity|Humanity]]
| [[Faction:Mechanist|Mechanist]]
| [[Artstyle guide:Mechanist|Mechanist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Percival|Percival]]
| Fleet Tender
| [[Species:Humanity|Humanity]]
| [[Faction:Highborn|Highborn]]
| [[Artstyle guide:Highborn|Highborn]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Pleistarchus|Pleistarchus]]
| Probe/Surveillance craft
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Pleistoanax|Pleistoanax]]
| Repair and Maintenance craft
| [[Species:Aera|Aera]]
| [[Faction:Aeran Merchant Marine|Aeran Merchant Marine]]
| [[Artstyle guide:Aeran Merchant Marine|Aeran Merchant Marine]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Polydorus|Polydorus]]
| Assault Shuttle
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Procles|Procles]]
| Colonization Ship
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Prudence|Prudence]]
| Orbital Cargo transport
| [[Species:Humanity|Humanity]]
| [[Faction:Purist|Purist]]
| [[Artstyle guide:Purist|Purist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:PSC-U Mk. 29|PSC-U Mk. 29]]
| Ultra-Light Planetary Superiority Craft
| [[Species:Humanity|Humanity]]
| [[Faction:Mechanist|Mechanist]]
| [[Artstyle guide:Mechanist|Mechanist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Reeve|Reeve]]
| Colonization Vessel
| [[Species:Uln|Uln]]
| [[Faction:Uln|Uln]]
| [[Artstyle guide:Uln(Royal Ingatwa Fleet)|Uln(Royal Ingatwa Fleet)]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Resupply and Refuel Mk. 451|Mk. 451]]
| Resupply and Refuel Fleet Tender
| [[Species:Humanity|Humanity]]
| [[Faction:Mechanist|Mechanist]]
| [[Artstyle guide:Mechanist|Mechanist]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Rhincodon|Rhincodon]]
| Jump Ferry
| [[Species:Humanity|Humanity]]
| [[Faction:League of Independent Human Worlds|LIHW]]
| [[Artstyle guide:LIHW|LIHW]]
|
|
|
|
|
|
| concept
| -
| {{open|OPEN}}
|- valign="top"
| [[Vessel:Scarab|Scarab]]
| Multi-use shuttle chassis, used for both civilian and military applications within Forsaken space. Often associated with the [[Vessel:Catfish|Catfish]].
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Shangdi|Shangdi]]
| Bulk Transport. This massive cargo vessel, abundant in Rlaan space, is the backbone of their interstellar movement of goods.
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan Merchants]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian(Merchant)]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Sobriety|Sobriety]]
| Craft impound vessel
| [[Species:Humanity|Humanity]]
| [[Faction:Homeland Security|Homeland Security]]
| [[Artstyle guide:Homeland Security|Homeland Security]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Sofono|Sofono]]
| Battle Cruiser
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]]
| [[Artstyle guide:Andolian|Andolian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Soos|Soos]]
| Refuse and Salvage Scow
| [[Species:Aera|Aera]]
| [[Faction:Aeran Merchant Marine|Aeran Merchant Marine]]
| [[Artstyle guide:Aeran Merchant Marine|Aeran Merchant Marine]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Sorrow|Sorrow]]
| Interceptor. Has both insystem and outsystem variants, the interstellar variant being armed for long, dogged pursuits rather than the interdictory form of interception.
| [[Species:Shmrn|Shmrn]]
| [[Faction:Shmrn|Shmrn]]
| [[Artstyle guide:Shmrn|Shmrn]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Taizu|Taizu]]
| Methane Breather Heavy Cargo Shuttle
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Teleclus|Teleclus]]
| Troopship
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Tesla|Tesla]]
| Anti-capital cruiser. Highly specialized, and oriented around spinal mounted weaponry, this vessel is as much "artillery" as cruiser.
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian|Andolian]]
| [[Artstyle guide:Andolian|Andolian]]
| x
|
|
|
|
|
| Deserves new model/texture to correspond more closely to the role of the craft. The re-envisioning will preserve some stylistic features of the low-polygon original.
| Not Recorded - Find out
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Theopompus|Theopompus]]
| Aenethformer (terraforming analog) main craft
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Tsiolkovsky|Tsiolkovsky]]
| Interceptor
| [[Species:Humanity|Humanity]]
| [[Faction:Andolian Protectorate|Andolian Protectorate]]
| [[Artstyle guide:Andolian Protectorate|Andolian Protectorate]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Vanderbilt|Vanderbilt]]
| Luxury Racer
| [[Species:Humanity|Humanity]]
| [[Faction:Luxury Travel Conglomerate|Luxury Travel Conglomerate]]
| [[Artstyle guide:Luxury Travel Conglomerate|Luxury Travel Conglomerate]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Wendi|Wendi]]
| Prisoner Transport
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan Enforcers|Rlaan Enforcers]]
| [[Artstyle guide:Rlaan Enforcers|Rlaan Enforcers]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Wudi|Wudi]]
| Ship Impound Transport
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan Enforcers|Rlaan Enforcers]]
| [[Artstyle guide:Rlaan Enforcers|Rlaan Enforcers]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Xianzong|Xianzong]]
| Mining Craft
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Xiaozong|Xiaozong]]
| Patrol Craft
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Xizong|Xizong]]
| Oxygen Breather Heavy Cargo Shuttle
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Xuande|Xuande]]
| Light Passenger Transport
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Yindi|Yindi]]
| Extermination Craft
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan Enforcers|Rlaan Enforcers]]
| [[Artstyle guide:Rlaan Enforcers|Rlaan Enforcers]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Zeuxidamus|Zeuxidamus]]
| Mass Cargo Hauler
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran Merchant Marine|Aeran Merchant Marine]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Zhaozong|Zhaozong]]
| Heavy Enforcer Ship
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan Enforcers|Rlaan Enforcers]]
| [[Artstyle guide:Rlaan Enforcers|Rlaan Enforcers]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|- valign="top"
| [[Vessel:Zhezong|Zhezong]]
| Mass passenger liner
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| ALL
| x
| {{open|OPEN}} 
|}

=Installations=

The sorting of the following table is alphabetical ascending by Installation '''Type'''.

{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Forum Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| Confed Agricultural Station
| Agricultural Station
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| -
| [[User:Strangelet|Strangelet]]
| {{done|DONE}}
|- valign="top"
| [[Installation:Aeran Anti-matter Refinery|Aeran Anti-matter Refinery]]
| Antimatter Refinery
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
| {{open|N}}
|
|
|
|
| concept required
| -
| {{open|OPEN}}
|- valign="top"
| [[Installation:Confederation Anti-matter Refinery|Confederation Anti-matter Refinery]]
| Antimatter Refinery
| [[Species:Humanity|Humanity]]
| Various
| [[Artstyle guide:Confederation|Confederation]]
| x
| {{open|N}}
|
|
|
|
| concept required
| -
| {{open|OPEN}}
|- valign="top"
| [[Installation:Rlaan Anti-matter Refinery|Rlaan Anti-matter Refinery]]
| Antimatter Refinery
| [[Species:Rlaan|Rlaan]]
| Various
| [[Artstyle guide:Rlaan|Rlaan]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=11301 1]
| {{done|Y}}
| {{assg|Y}}
|
|
|
| mesh rework.
| concept:Link mesh: chuck_starchaser
| {{assg|ASSIGNED}} (chuck_starchaser)
|- valign="top"
| [[Installation:Shmrn Area Fortifications|Shmrn Area Fortifications]]
| Area Fortifications
| [[Species:Shmrn|Shmrn]]
| [[Faction:Shmrn|Shmrn]]
| [[Artstyle guide:Shmrn|Shmrn]]
| x
| {{open|N}}
|
|
|
|
| concept required
| -
| {{open|OPEN}}
|- valign="top"
| [[Installation:Aeran Asteroid Fighter-Base|Aeran Asteroid Fighter-Base]]
| Asteroid Fighter-Base
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| x
|
|
|
|
|
| dummy base exists. Needs serious work to scale and set up subunits/turrets
| Ryder P. Moses
| {{open|OPEN}}
|- valign="top"
| [[Installation:Confederation Asteroid Fighter-Base|Confederation Asteroid Fighter-Base]]
| Asteroid Fighter-Base
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| -
| [[User:Strangelet|Strangelet]]
| {{done|DONE}}
|- valign="top"
| [[Installation:Rlaan Asteroid Fighter-Base|Rlaan Asteroid Fighter-Base]]
| Asteroid Fighter-Base
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| x
|
|
|
|
|
| ''deserves new model+texture''
| x
| {{open|OPEN}}
|- valign="top"
| [[Installation:Uln Asteroid Refinery|Uln Asteroid Refinery]]
| Asteroid Refinery
| [[Species:Uln|Uln]]
| [[Faction:Uln|Uln]]
| [[Artstyle guide:Uln|Uln]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=7126 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{done|Do}}
| {{open|Wi}} {{done|Sc}} {{open|Wa}} {{open|Ex}}
| stats. frontend.
| Oblivion Fendorin
| {{done|DONE}}
|- valign="top"
| [[Installation:Civilian Asteroid Shipyard|Civilian Asteroid Shipyard]]
| Asteroid Shipyard
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=11586 1]
| {{done|Y}}
| {{done|Y}}
| {{done|Y}}
| {{assg|Y}}
| {{open|Wi}} [http://vegastrike.sourceforge.net/forums/cpg/displayimage.php?album=13&pos=0 {{done|Sc}}] {{open|Wa}} {{open|Ex}}
| -
| [[User:Fendorin|Fendorin]]
| {{done|DONE}}
|- valign="top"
| [[Installation:Shaper Bio-Adaptation Station|Shaper Bio-Adaptation Station]]
| Bio-Adaptation and Isolation Station
| [[Species:Humanity|Humanity]]
| [[Faction:Shaper|Shaper]]
| [[Artstyle guide:Shaper|Shaper]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=9539 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{done|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{done|Do}}
| {{open|Wi}} {{done|Sc}} {{open|Wa}} {{open|Ex}}
| wiki profile, wallpaper
| Fendorin
| {{done|DONE}}
|- valign="top"
| [[Installation:Rlaan-Briin Bio-Mod Research Station|Rlaan Briin Bio-Mod Research Station]]
| Bio-Modification Research Station
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan Briin|Rlaan Briin]]
| [[Artstyle guide:Rlaan Briin|Rlaan Briin]]
| x
|
|
|
|
|
| * ALL
| x
| {{open|OPEN}}
|- valign="top"
| [[Installation:Rlaan Civilian Population Defense Redoubt|Rlaan Civilian Population Defense Redoubt]]
| Civilian Population Defense Redoubt
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan#Civilian|Rlaan Civilian]]
| x
|
|
|
|
|
| * ALL
| x
| {{open|OPEN}}
|- valign="top"
| [[Installation:Confederation Commerce Center|Confederation Commerce Center]]
| Commerce Center (Design Licensed From an ISMG Controlled Entity)
| [[Species:Humanity|Humanity]]
| Member states of the [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Interstellar Shipping and Mercantile Guild|Interstellar Shipping and Mercantile Guild]]
| x
|
|
|
|
|
| * Additional (Bump, etc) maps
| [[User:Strangelet|Strangelet]]
| {{done|DONE}}
|- valign="top"
| Rlaan Commerce Center
| Commerce Center
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=11973 1]
| {{done|Y}}
| {{done|Y}}
| {{done|Y}}
| {{done|Y}}
| {{open|N}}
| -
| Fendorin
| {{done|DONE}}
|- valign="top"
| Uln Commerce Center
| Commerce Center
| [[Species:Uln|Uln]]
| [[Faction:Uln|Uln]]
| [[Artstyle guide:Uln|Uln]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=7126 1]
| {{done|Y}}
| {{done|Y}}
| {{done|Y}}
| {{done|Y}}
| {{open|N}}
| -
| Oblivion Fendorin
| {{done|DONE}}
|- valign="top"
| Diplomatic Center
| Diplomatic Center
| Uln?
| Uln?
| x
| x
| {{done|Y}}
| {{done|Y}}
| {{done|Y}}
| {{assg|Y}}
| {{open|N}}
| -
| [[User:Strangelet|Strangelet]]
| {{done|DONE}}
|- valign="top"
| Confed Factory
| Factory
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| -
| artist?
| {{done|DONE}}
|- valign="top"
| Confed Fighter Barracks
| Fighter Barracks
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| -
| artist unknown
| {{done|DONE}}
|- valign="top"
| Rlaan Fighter Barracks
| Fighter Barracks
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=11973 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{done|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{done|Do}}
| {{open|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| wiki profile
| [[User:Fendorin|Fendorin]]
| {{done|DONE}}
|- valign="top"
| Confed Gas Mine
| Gas Mine
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| -
| [[User:Strangelet|Strangelet]]
| {{done|DONE}}
|- valign="top"
| Aeran Medical Station
| Medical Station
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=28&t=8925 1]
|
|
|
|
|
| improve model + texture
| Fendorin
| {{assg|ASSIGNED}} (Fendorin)
|- valign="top"
| Confed Medical Station
| Medical Station
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confed]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| ?
|
| {{done|DONE}}
|- valign="top"
| Rlaan Medical Station
| Medical Station
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=11973 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{done|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}}
| {{open|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| wiki profile. screen shot.
| Fendorin
| {{done|DONE}}
|- valign="top"
| Mining Base
| Mining Base
| -
| -
| -
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=11159 1]
|
|
|
|
|
| integrate improved Base model
| [[User:chuck_starchaser|chuck_starchaser]]
| {{open|OPEN}}
|- valign="top"
| Aera Mining Base
| Mining Base
| [[Species:Aera|Aera]]
| [[Faction:Aera|Aera]]
| [[Artstyle guide:Aeran|Aeran]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=2822 1]
|
|
|
|
|
| needs mesh cleaning
| kark88
| {{open|OPEN}}
|- valign="top"
| Pirate Mining Base
| Mining Base
| [[Species:Humanity|Human]]
| [[Faction:Pirates|Pirates]]
| [[Artstyle guide:Pirates|Pirates]]
| Supplementary glowmap made by Halleck
|
|
|
|
|
| * Update HUD Image * Lighten up materials? * Mounts + docking points
| [[User:Fendorin|Fendorin]]
| {{done|DONE}}
|- valign="top"
| Rlaan Mining Base
| Mining Base
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=9755 1] [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=11973 2]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{done|Do}}
| {{open|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| wiki profile
| Fendorin
| {{done|DONE}}
|- valign="top"
| Confederation Outpost
| Outpost
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confed]] + [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Confederation|Confederation]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=6397&st=0&sk=t&sd=a&start=120 1]
|
|
|
|
|
| -
| Kangaroo?
| {{done|DONE}}
|- valign="top"
| Rlaan Outpost
| Outpost
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=11973 1]
|
|
|
|
|
| improve model
| Fendorin
| {{assg|ASSIGNED}} (Fendorin)
|- valign="top"
| Confed Refinery
| Refinery
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confed]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| ?
|
| {{done|DONE}}
|- valign="top"
| Uln Refinery
| Refinery
| [[Species:Uln|Uln]]
| [[Faction:Uln|Uln]]
| [[Artstyle guide:Uln|Uln]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=7126 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{done|Do}}
| {{open|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
| stats. frontend.
| Oblivion Fendorin
| {{done|DONE}}
|- valign="top"
| Confed Relay Station
| Relay Station
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confed]]
| [[Artstyle guide:Confederation|Confederation]]
| -
|
|
|
|
|
| -
| ?
| {{done|DONE}}
|- valign="top"
| Forsaken Relay Station
| Relay Station
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=12130 1]
|
|
|
|
|
| provide model
| Fendorin
| {{assg|ASSIGNED}} (Fendorin)
|- valign="top"
| Confed Research Station
| Research Station
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| x
|
|
|
|
|
| -
| ?
| {{done|DONE}}
|- valign="top"
| Forsaken Shipyard
| Shipyard
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=28&t=8761 1]
|
|
|
|
|
| provide model
| [[User:Fendorin|Fendorin]]
| {{assg|ASSIGNED}} (Fendorin)
|- valign="top"
| Space Colony
| Space Colony
| [[Species:Humanity|Humanity]]
| [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Forsaken|Forsaken]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=6397 1]
| {{done|Y}}
| {{done|Y}}
| {{open|N}}
| {{open|N}}
| {{open|N}}
| texturing required
| chuck_starchaser
| {{open|OPEN}}
|- valign="top"
| [[Installation:Confederation_Star_Fortress|Confederation Star Fortress]]
| Star Fortress
| [[Species:Humanity|Humanity]]
| Member states of the [[Faction:Confederation of Inhabited Worlds|Confederation]]
| [[Artstyle guide:Confederation|Confederation]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=2432 1]
|
|
|
|
|
| x
| ?
| {{done|DONE}}
|- valign="top"
| [[Installation:Rlaan_Star_Fortress|Rlaan Star Fortress]]
| Star Fortress
| [[Species:Rlaan|Rlaan]]
| [[Faction:Rlaan|Rlaan]]
| [[Artstyle guide:Rlaan|Rlaan]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=11973 1]
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{done|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{done|Do}}
| {{open|Wi}} {{done|Sc}} {{open|Wa}} {{open|Ex}}
| stats. frontend.
| Fendorin
| {{done|DONE}}
|}

=Turrets and Subunits=

{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| Mechanical Arm
| Mechanical Arm
| any
| -
| -
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=3182 1]
| -
|
|
|
|
| -
| [[User:Pontiac|Pontiac]]
| {{open|OPEN}}
|}

=Cockpits=
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Species / Faction / Type'''
|'''Style / Concept art'''
|'''Comments & Criticisms'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
|Bomber Cockpit
|?
|?
|?
|?
|?
|{{open|OPEN}}
|- valign="top"
|Heavy Cockpit
|?
|?
|?
|?
|?
|{{open|OPEN}}
|- valign="top"
|Light Cockpit
|?
|?
|?
|?
|Strangelet
|{{done|DONE}}
|- valign="top"
|Medium Cockpit
|?
|?
|?
|?
|?
|{{open|OPEN}}
|- valign="top"
|Rlaan Cockpit
|?
|?
|?
|?
|who's the artist?
|{{done|DONE}}
|}

=Cargo=
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Species / Faction / Type'''
|'''Style / Concept art'''
|'''Comments & Criticisms'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|}

=Equipment=

{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
| Mobile Battery Platform
| Mobile Battery Platform
| ?
| ?
| x
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=4&t=6925 1]
| {{done|Y}}
| {{done|Y}}
| {{done|Y}}
| {{open|N}}
|
| check status
| Oblivion
| {{open|OPEN}}
|- valign="top"
| Nav & Comm Buoy
| Navigation and Communication Buoy
| [[Species:Humanity|Humanity]]
| [[Faction:Confederation of Inhabited Worlds|Confed]] + [[Faction:Forsaken|Forsaken]]
| [[Artstyle guide:Confederation]], [[Artstyle guide:ISO|Confederation]], [[Artstyle guide:ISO]]
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=2636 1]
|
|
|
|
|
| * pending for inclusion - waiting on code that uses zones of control
| [[User:Pontiac|Pontiac]]
| {{open|OPEN}}
|- valign="top"
| Relay Satellite
| Relay Satellite
| ?
| ?
| x
| x
| {{done|Y}}
| {{done|Y}}
| {{done|Y}}
| {{open|N}}
|
| spawning?
| ?
| {{open|OPEN}}
|}

=Table Template=
Use and leave this as template.
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
|?
|?
| [[Species:|Species:]]
| [[Faction:|Faction:]]
| [[Artstyle guide:|Artstyle guide:]]
|?
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{open|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{done|En}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
|?
| [[User:|User:]]
| {{done|DONE}} {{assg|ASSIGNED}} (username) {{open|OPEN}}
|}
<pre>
{|border="1" rules="rows" frame="void" style="width:100%;" cellspacing="0" cellpadding="2"
|'''Name'''
|'''Type'''
|'''Species'''
|'''Faction'''
|'''Style'''
|'''Thread'''
|'''Concept'''
|'''Mesh'''
|'''Textures'''
|'''Data'''
|'''Front -end'''
|'''To do'''
|'''Artist(s)'''
|'''Status'''
|- valign="top"
|?
|?
| [[Species:|Species:]]
| [[Faction:|Faction:]]
| [[Artstyle guide:|Artstyle guide:]]
|?
| {{done|Y}}
| {{done|Un}} {{open|Sh}} {{open|LoD}}
| {{done|Di}} {{done|Gl}} {{open|Sp}} {{open|Dm}} {{open|No}}
| {{done|Un}} {{done|Hud}} {{open|St}} {{open|LoD}} {{done|En}}
| {{done|Wi}} {{open|Sc}} {{open|Wa}} {{open|Ex}}
|?
| [[User:|User:]]
| {{done|DONE}} {{assg|ASSIGNED}} (username) {{open|OPEN}}
|}
</pre>

=See also=
* [[Vessels & Installations]]
* [[Artstyle guides|Artstyle guides]]
* [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=2491 Ships, installations, and model status]

[[Category:Development]]
[[Category:Graphics]]

Development:Model Guidelines

2011-04-10T22:22:56Z

Pyramid: /* Modeling Pipeline Overview */

{{parent_link|parent=[[Development]]}}
= Introduction =

The intention of this document is to give artists using the Vega Strike engine some suggested guidelines to follow in creating models. You may also wish to have a look at the corresponding [[Development:Texture_Guidelines|texturing guidelines]].

So you want to create a new ship for Vega Strike, do you? While virtually all models are welcome, well before you start cranking out wonderfully designed models we request that you first check what models are still required.

{{warning_text |
| text='''Note:''' If you wish to contribute a new or updated model (ship, installation, turret, cockpit, ..) to the game Vega Strike, please see the [[Development:3D_Models|'''3D Models''']] page for models requiring attention.}}

Alternatively, contact [[User:jackS|jackS]] or [[User:pyramid|pyramid]].

= Modeling Pipeline Overview =

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98ffb2" |
|'''Step
|'''Input
|'''Output
|'''Tools
|'''Requirements
|'''Tutorials
|-

| Model Selection
| -
| required model
| [[Development:3D_Models|model task list]]
| -
| -
|-

| Conceptualization
| selected model
| model concept
| pen & paper, artwork forum
| artstyle guide
| -
|-

| Modeling
| concept
| model mesh, obj files
| blender, forum
| many
| -
|-

| Texturing
| model mesh
| textures
| gimp, forum
| texture requirements
| -
|-

| Integration
| model + textures
| bfxm + dds textures
| mesher + UnitConverter
| -
| -
|-

| Testing
| bfxm model + dds textures
| visual + behavior
| vegastrike + modelview.mission
| pass or rework
| -
|-

| Submission
| blender file + obj, master textures, bfxm + dds textures
| archive or svn
| mail, svn client
| -
| -
|}

=Model Requirements=

==Requirements Checklist==

Considerations for a successful model submission:
* Model is in the requirements list [[Development:3D_Models|->]]
* Abides to faction visual guidelines
* Has approved concept
* Provides model source file (blender, Wings3D, ...)
* Provides OBJ file
* Has model mesh, shield mesh, LoD meshes, helper meshes
* Provides uncompressed textures in png format (and optionally faction textures)
* Provides texture source files (GIMP, ...)
* Provides HUD png image with correct orientation
* Provides units.csv file entry

==Model Requirements Details==

==Visual Guidelines==

For particular aesthetic guidelines, please see the [[Artstyle guides]] page. Please note that many of the existing models are used because of expedience, not because they fit well with VS canon (i.e. if you make something new look like what's there, it still might not be what we're looking for). If in doubt, please ask on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

To absolutely sure, for new models, please create a drawing of your proposed concept and let it be discussed and approved on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

See also [[Development:Texture Guidelines]]

==Model File Format==
The preferred format for submission (for public disbursement - whatever native format is used inside your favorite modeling suite is fortunately a non-issue) is currently Wavefront OBJ file format, as this is the most easily converted between manipulation (assorted modeling tools) and presentation (currently BFXM, later to be the OGRE .mesh format). Model "source" therefore, is, at present (Sep. 2008), most usefully uploaded as .OBJ.

Until such a time as a visual model editing tool is completed, conversion to a game-ready format will likely pass through the .xmesh format for insertion of LOD references into top level mesh(es), correction of coordinate "handedness" (if the ordering of the coordinate axes is incompatible, as appears to happen with the output of some modeling tools).

See [[HowTo:Add_Ships]] for information on using mesher to convert to a presentation format (such as BFXM). Note that an old utility, objconv, is '''not''' mesher, and should not be used for this task. Source files for the mesher utility are included along with VS source. Windows users may download updated mesher binaries from their SVN interface of choice (the binary will be in the \bin directory).

==Polygon/Vertex Count==
In broadest terms, the desired polygon count for a particular model is dependent on three major factors:
*The amount of screen real-estate that the model is likely to be viewed at the majority of time that a user will be seeing it (i.e. a 2 meter long rocket doesn't deserve the same order of magnitude of attention to detail as a large base or vessel unless the rocket is expected to be mounted in front of a camera. Likewise, even at the same level of attention in terms of polygons per square meter, it would have far fewer total polygons.)
*The intrinsic surface complexity of the model. If one is modeling a box for freight cargo, one is not going to need as many polygons as if one needed to model one of the Vega Strike developers (not that we're necessarily model material ;-)). If you don't use enough polygons, no amount of texture magic can save a model from being ugly. That said, if you are modeling a cargo freight container and you use thousands of polygons, you're being negligent and wasteful of resources.
*Engine limitations. Engine limitations is a bit of a misnomer, as the performance of the graphical engine is more hardware dependent than anything else, but it's a good heading for lumping any non-artistic hurdles under. This is the most complicated of the three major factors, because it represents a moving target. Suffice it to say that in order to preserve playability on a broad range of systems, there is a premium placed on making a model aesthetically appropriate with the minimum number of polygons.

Rough guideline:
*Fighter: 15k triangles
*Corvette: 30k tris
*Cruiserer: 60k
*Carrier: 120k
*Space station: 250k

However, significant discression, and the possibility for using large numbers of polygons to prettify an object remain with the artist, provided they make appropriate use of [[Terminology:LODs|LODs]]. The primary focus needs to be on making a model aesthetically appropriate, for an intended common viewing distance, and then catering to the needs of the engine by introducing lower LODs (if necessary) and catering to artistic desires by introducing higher LODs (if appropriate). There is also an element of minor future proofing that occurs with providing a robust range of LOD poly counts - namely, multiple versions of the data set can be constructed targeted at different hardware points by shifting up or down along the LOD set (although this currently isn't bothered with, if and when we develop a true source repository for models and textures, this will likely become more common, as postprocessing of submitted art will become tenable).

One more point to consider before attempting to set a polygon goal for a model is what the likely total contribution from all instances on screen of a given model will be - if the model represents something particularly rare, then it is likely that a few more polygons can easily be spared on its model than for more common objects of otherwise similar size, complexity, etc.

Above all, use common sense - if it's visually hideous because it doesn't have enough polygons, it's not your top level model, and if it's in the 5 digit range for polygon count, it's not your lowest level LOD. Take into consideration how much screen real estate, based on the intended in-game size of the model (and if you don't have any idea how big it's supposed to be - you're doing something wrong already) the model will be taking up at various distances, and calibrate detail appropriately (this will become a much easier task once there is a visual modeling tool from the VS side) - to belabor the obvious, the difference between 500 polygons and 5000 gets somewhat obscured when the object is only drawn using 64 pixels. Note therefore that larger objects will often necessitate higher polygon counts merely because there's more of them to see.

(Note that there is no need to continue adding LODs beyond a point of "diminishing artistic returns" - if adding more detail won't help, don't bother. If adding detail helps, but is too expensive to be practical, then it may still be worthwhile for later inclusion as hardware resources increase.)

For small to moderate craft and installations, something along the lines of either of the following is not inappropriate:

(Exponential Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4000
*LOD 3 <= 8000
*LOD 4 <= 16000
*LOD 5 >16000

(Quadratic Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4500
*LOD 3 <= 8000
*LOD 4 <= 12500
*LOD 5 <= 18000
*LOD 6 >18000

Larger models, such as capital vessels and large installations will likely follow a similar curve, but at a higher offset, due to increased size. Truly massive models should be partitioned into multiple meshes, each with its own set of LODs such that nearer portions of the model can be independently represented at higher LOD than more distant ones. Partitioning into multiple meshes may be preferable even for merely "largish" models so as to preserve reasonable correspondence between single pixels and the size of represented features when texturing.

==Textures==

Texture maps should also be made accordingly, although clearly artistic integrity trivially trumps the following rough guideline (if you need more pixels, use them) and the appropriate texture size may depend greatly upon the size of the model.

*LOD 1 128x128
*LOD 2 256x256
*LOD 3 512x512
*LOD 4 1024x1024
*LOD 5 and up having multiple 1024x1024 textures

Be careful with ''texture lodding abuse''. Each LOD that uses its own texture will require more memory (video memory), and breaks batching between instances (slows down rendering of many instances of this model). Even so, texture lodding actually frees up memory most of the time, since only lesser versions are used in the distance. A general rule of thumb is to never have more than two or at most three versions of the same texture. Also take any opportunity to convert textures to greyscale when the color loss is not quite noticeable (most commonly with glow maps and specular maps).

Likewise, for larger models, do not neglect the potential addition of detail textures.

See also [[Development:Texture Guidelines]] and [[Development:Graphics_Requirements]].

===Faction Textures===

To include and successfully test faction textures in your data, you need to:
* set the corresponding vegastrike.config variable (<code>var name="faction_dependant_textures" value="1"</code>).
* prefix default textures with the faction name, e.g. when your default texture is called "tex_000.texture", to enable the faction texture for "pirates" you'll need to add the texture "pirates_tex_000.texture".
* change configuration to one of the 2 highest computer modes (512M+1GB or 1024MB).

==Shield and Collision Meshes==
Separate shield meshes are highly desirable. Shield meshes should also be done using LODs, although shield meshes should remain simple - that is, their top level meshes should not contain odious numbers of polygons for something that is only infrequently displayed.

Collision meshes need not (and cannot) have LODs. For complex models, it is wise to provide a dumbed-down version of the model that reasonably approximates its shape - minor features and greebles can be safely removed, for instance - to improve performance on the physics engine. Polycount should be kept to a minimum, '''without sacrificing any major features''' of the top-level LOD. Very small vessels (or appropriately shaped ones) may opt to not specify a collision mesh, which will make the physics layer treat this mesh as a spherical object (most efficient).

==HUD Image==

Provides perspective view of the model oriented with the nose towards the left-bottom corner of the image.
The master image resolution should start at 256x256 pixels with transparency around the vessel.

==See also==
For an example of an entity that is composed of multiple meshes, uses LODs, and shield meshes, examine the Clydesdale. (Note that shield and collision meshes are specified in the units.csv file, not by the model.)

=Model Creation=

The first (and most enjoyable) job is to design and draw your model (the geometrical object) within your program.

Feel free to use any modeling program, but it must be able to export models in either (Wavefront) .OBJ or (Vega Strike) .xmesh format. If you don't know where to start, see [[Links:3D Applications]] for a list of modeling software. [http://www.wings3d.com/ Wings 3D] is recommended for modeling beginners. [http://www.blender.org/ '''Blender'''] is the tool of choice for VS artistic community.

==Orientation==
First off, do yourself a favor and line your model up correctly before you begin. For the purposes of Vega Strike, Z+ is forwards and Y+ is up. The model's nose should be pointing forward along the Z+ axis (so that the Z+ axis would theoretically be visible from the cockpit). The mesh should also be properly centered.
Summing up:
* Z+ -> Forward direction
* Y+ -> Up direction
* Centered

== Tutorials==

{{warning_text |
| text='''Note:''' The tutorials overview is not complete. Many of the available tutorials have not yet been integrated into this page. Refer also to the [[HowTos|'''How-Tos Tutorials''']] page for additional tutorials.}}

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98b2ee" |
|'''Modeling Step
|'''Blender
|'''Wings3D
|-
| Create mesh
| -
| [[HowTo:Create Ships in Wings3D|Creating a 3D-model]]
|-
| Smoothing
| [[HowTo:Smooth Groups|Smoothing]] [[HowTo:Weld|Smooth Welding]]
| -
|-
| Mesh cleanup
| [[HowTo:Bevel|Beveling]]
| -
|-
| Unwrapping
| [[HowTo:Unwrap_in_Blender|Unwrapping 1]] [[HowTo:Unwrap|Unwrapping 2]] [[HowTo:FullUnwrapBlender|Ship unwrap]]
| -
|-
| Radiosity Baking
| [[HowTo:Radiosity baking in Blender|Radiosity baking]]
| -
|-
| Exporting
| -
| -
|}

This articles are WIP, means still need to be reviewed and decided how to restructure them:
* [[HowTo:Create Cockpit in Wings3d|Creating a 3D cockpit for your ship.]]
* [[HowTo:Add LODs|Adding Levels of Detail]]
* [[HowTo:Add Ships|Adding your ship to Vega Strike]] - An overview of how to create and add ships to the game
* [[HowTo:Create Models]] - Links to forum discussions. Page will become generic model creation tutorial.
* Modeling Tutorials: [[HowTos#Modeling]]

===Blender Basics===
* [[HowTo:Basic Blender Tutorial|A basic Blender3D tutorial]]: [http://www.cdschools.org/54223045235521/blank/browse.asp?A=383&BMDRN=2000&BCOB=0&C=55205 Blender Basics - 3rd Edition] - not specific to ships, though...

===Wings3D Basics===

===Other Software Basics===

* [[HowTo:Model a Ship|Brad Mick's video tutorial on ship modeling]] - using Lightwave, but the concept is general: ''Rapid Prototyping''

=Texture Creation=

==Unwrapping==

Please make non-overlapping UV unwraps for all future models. You can't bake a proper AO with overlapping islands.

==Unsorted==

(general guidelines, tips, best practices, app specific tutorials, ...)

* [http://netzwelt.gaming-hut.de/vegatexturing/ WIP VegaStrike texturing page by Major]
* [http://edice.netfirms.com/tuts/texturetut.htm Texturing tutorial by Duality]

For the time being, you may wish to have a look at the corresponding [[Development:Texture_Guidelines|Texturing Guidelines]].

* [[Development:Texture Guidelines|Guidelines for creating ship materials]]

* [[HowTo:Add Per Pixel Lighting|Adding per-pixel lighting to your 3D model]]
* [[HowTo:IntroToShaders|Introduction to shaders, and what they mean for you]] --Bumpmaps, Normalmaps, Shininess maps ...

* [[HowTo:Texture|Creating your own textures]] - A summary on how to make texture maps
* [[HowTo:Texture in Wings3d|Texturing your model in Wings 3d]]
* [[HowTo:SuperrealisticTexturing|Tips for realistic-looking textures]]
* [[HowTo:Make Animated Textures|Using animated textures on a model]]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/texturing_noodle LaGrande Noodle]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/ao_and_prt_bakes AO and PRT bakes, using Blender and xNormal]

=Integration and Testing=

Using UnitConverter to convert all files and edit the model stats for Vega Strike:
[[Development:Tools:UnitConverter]]

===Object Marker===
In order to automatically create turret mounts, gun mounts, and engine thrusters placements in units.csv, please use the following marker:

http://deeplayer.com/cinemut/gunmountmarker.jpg

The shape is 1 units wide in X, 2 units tall in Y, 4 units long in Z. Four vertices in total. The center between the two vertices on X is the origin; the vertex on Z marks the forward direction; the vertex on Y marks the up direction.
The exported object names are ready and the forward and up directions are calculated from the marker dimensions. Thus, we don't need to worry about mesh rotations; we can deduce mesh rotation from the marker.

The dock marker for docking ports is an exception, since the docking square in game is always rendered facing the player, so the orientation doesn't really matter and only the center matters for the docking port position.

[author:chuck_starchaser]
* Here's the marker blend file (you could load and save as the default blender start):
** [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/modtools/UnitConverter/helper/mount_helper.blend?view=log ''modtools/UnitConverter/helper/mount_helper.blend'']
* Starts with a marker smack in the middle.
* You can move it to another layer, later duplicate it as needed to place copies at key locations.
* You can also import the marker into another blend file:
** Open whatever.blend, go to File -> Append Or Link
** Navigate to where UnitConverter/helper/mount_helper.blend is.
* Go to the "Objects" folder, and click on the "Marker" object.
* To duplicate an object, in object mode, select and shift-D.
* To rename your duplicated object, hit F9 and, towards the left, where it says OB:Marker click in the middle of it and then type "turret_heavy_0" or whatever.
* copy all markers to layer 2
* select layer 2
* select all markers with the A key
* export to obj using Edges, Objects

http://vegastrike.sourceforge.net/albums/WIPs-and-Concept-Art/mounts_20080911.jpg

The above image shows the markers set as the centers of engine thrusts.

It is advisable to group the marker objects into a group called "marker". You are required to export all the markers into one obj file that needs to contain the name "marker" in it (letter case is unimportant, it can be "marker", or "Marker").

Object Helper naming convention: ''type_subtype_identifier''

with type:
* pilot (currently unused)
* mount (currently unused)
* turret
* subunit
* engine
* dock

and subtype being optional (convention tbd),
and identifier being either a number or a description and optional.

You may define for example:
* dock
* dock_auto_20
* mount_lightmedium_0
* turret_capmissile_frontleft
* subunit_1
* engine_retro_left

===Exporting to OBJ===

===Updating Stats===
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
* [[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]

=Submission and Vetting=

=Technical Reference=

==Technical Specifications==

* [[HowTo:Edit BFXM files|Editing BFXM files (format spec)]]
* [[HowTo:Edit XMESH files|Editing the xmesh file of a ship]]
* [[HowTo:Edit units.csv|Editing units.csv]]
* [[HowTo:Add Engine Glow|Adding an engine glow to your 3D model]]

==Scripts and Tools==

See [[Development:Scripts_%26_Tools|Scripts & Tools]]
* [[HowTo:Add_Ships#New_method|mesher converter obj <-> bfxm <-> xmesh]]
* [[Development:Tools:UnitConverter|UnitConverter]]

=References=

* [http://wcpedia.com/dw/doku.php/wc_info/modding/index WCpedia Modeling Page]

[[Category:Development|Model Guidelines]]
[[Category:Modeling|Model Guidelines]]

Development:Model Guidelines

2011-04-06T22:10:37Z

Pyramid: /* Object Marker */

{{parent_link|parent=[[Development]]}}
= Introduction =

The intention of this document is to give artists using the Vega Strike engine some suggested guidelines to follow in creating models. You may also wish to have a look at the corresponding [[Development:Texture_Guidelines|texturing guidelines]].

So you want to create a new ship for Vega Strike, do you? While virtually all models are welcome, well before you start cranking out wonderfully designed models we request that you first check what models are still required.

{{warning_text |
| text='''Note:''' If you wish to contribute a new or updated model (ship, installation, turret, cockpit, ..) to the game Vega Strike, please see the [[Development:3D_Models|'''3D Models''']] page for models requiring attention.}}

Alternatively, contact [[User:jackS|jackS]] or [[User:pyramid|pyramid]].

= Modeling Pipeline Overview =

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98ffb2" |
|'''Step
|'''Input
|'''Output
|'''Tools
|'''Requirements
|'''Tutorials
|-

| Model Selection
| -
| required model
| model task list
| -
| -
|-

| Conceptualization
| selected model
| model concept
| pen & paper, artwork forum
| artstyle guide
| -
|-

| Modeling
| concept
| model mesh, obj files
| blender, forum
| many
| -
|-

| Texturing
| model mesh
| textures
| gimp, forum
| texture requirements
| -
|-

| Integration
| model + textures
| bfxm + dds textures
| mesher + UnitConverter
| -
| -
|-

| Testing
| bfxm model + dds textures
| visual + behavior
| vegastrike + modelview.mission
| pass or rework
| -
|-

| Submission
| blender file + obj, master textures, bfxm + dds textures
| archive or svn
| mail, svn client
| -
| -
|}

=Model Requirements=

==Requirements Checklist==

Considerations for a successful model submission:
* Model is in the requirements list [[Development:3D_Models|->]]
* Abides to faction visual guidelines
* Has approved concept
* Provides model source file (blender, Wings3D, ...)
* Provides OBJ file
* Has model mesh, shield mesh, LoD meshes, helper meshes
* Provides uncompressed textures in png format (and optionally faction textures)
* Provides texture source files (GIMP, ...)
* Provides HUD png image with correct orientation
* Provides units.csv file entry

==Model Requirements Details==

==Visual Guidelines==

For particular aesthetic guidelines, please see the [[Artstyle guides]] page. Please note that many of the existing models are used because of expedience, not because they fit well with VS canon (i.e. if you make something new look like what's there, it still might not be what we're looking for). If in doubt, please ask on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

To absolutely sure, for new models, please create a drawing of your proposed concept and let it be discussed and approved on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

See also [[Development:Texture Guidelines]]

==Model File Format==
The preferred format for submission (for public disbursement - whatever native format is used inside your favorite modeling suite is fortunately a non-issue) is currently Wavefront OBJ file format, as this is the most easily converted between manipulation (assorted modeling tools) and presentation (currently BFXM, later to be the OGRE .mesh format). Model "source" therefore, is, at present (Sep. 2008), most usefully uploaded as .OBJ.

Until such a time as a visual model editing tool is completed, conversion to a game-ready format will likely pass through the .xmesh format for insertion of LOD references into top level mesh(es), correction of coordinate "handedness" (if the ordering of the coordinate axes is incompatible, as appears to happen with the output of some modeling tools).

See [[HowTo:Add_Ships]] for information on using mesher to convert to a presentation format (such as BFXM). Note that an old utility, objconv, is '''not''' mesher, and should not be used for this task. Source files for the mesher utility are included along with VS source. Windows users may download updated mesher binaries from their SVN interface of choice (the binary will be in the \bin directory).

==Polygon/Vertex Count==
In broadest terms, the desired polygon count for a particular model is dependent on three major factors:
*The amount of screen real-estate that the model is likely to be viewed at the majority of time that a user will be seeing it (i.e. a 2 meter long rocket doesn't deserve the same order of magnitude of attention to detail as a large base or vessel unless the rocket is expected to be mounted in front of a camera. Likewise, even at the same level of attention in terms of polygons per square meter, it would have far fewer total polygons.)
*The intrinsic surface complexity of the model. If one is modeling a box for freight cargo, one is not going to need as many polygons as if one needed to model one of the Vega Strike developers (not that we're necessarily model material ;-)). If you don't use enough polygons, no amount of texture magic can save a model from being ugly. That said, if you are modeling a cargo freight container and you use thousands of polygons, you're being negligent and wasteful of resources.
*Engine limitations. Engine limitations is a bit of a misnomer, as the performance of the graphical engine is more hardware dependent than anything else, but it's a good heading for lumping any non-artistic hurdles under. This is the most complicated of the three major factors, because it represents a moving target. Suffice it to say that in order to preserve playability on a broad range of systems, there is a premium placed on making a model aesthetically appropriate with the minimum number of polygons.

Rough guideline:
*Fighter: 15k triangles
*Corvette: 30k tris
*Cruiserer: 60k
*Carrier: 120k
*Space station: 250k

However, significant discression, and the possibility for using large numbers of polygons to prettify an object remain with the artist, provided they make appropriate use of [[Terminology:LODs|LODs]]. The primary focus needs to be on making a model aesthetically appropriate, for an intended common viewing distance, and then catering to the needs of the engine by introducing lower LODs (if necessary) and catering to artistic desires by introducing higher LODs (if appropriate). There is also an element of minor future proofing that occurs with providing a robust range of LOD poly counts - namely, multiple versions of the data set can be constructed targeted at different hardware points by shifting up or down along the LOD set (although this currently isn't bothered with, if and when we develop a true source repository for models and textures, this will likely become more common, as postprocessing of submitted art will become tenable).

One more point to consider before attempting to set a polygon goal for a model is what the likely total contribution from all instances on screen of a given model will be - if the model represents something particularly rare, then it is likely that a few more polygons can easily be spared on its model than for more common objects of otherwise similar size, complexity, etc.

Above all, use common sense - if it's visually hideous because it doesn't have enough polygons, it's not your top level model, and if it's in the 5 digit range for polygon count, it's not your lowest level LOD. Take into consideration how much screen real estate, based on the intended in-game size of the model (and if you don't have any idea how big it's supposed to be - you're doing something wrong already) the model will be taking up at various distances, and calibrate detail appropriately (this will become a much easier task once there is a visual modeling tool from the VS side) - to belabor the obvious, the difference between 500 polygons and 5000 gets somewhat obscured when the object is only drawn using 64 pixels. Note therefore that larger objects will often necessitate higher polygon counts merely because there's more of them to see.

(Note that there is no need to continue adding LODs beyond a point of "diminishing artistic returns" - if adding more detail won't help, don't bother. If adding detail helps, but is too expensive to be practical, then it may still be worthwhile for later inclusion as hardware resources increase.)

For small to moderate craft and installations, something along the lines of either of the following is not inappropriate:

(Exponential Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4000
*LOD 3 <= 8000
*LOD 4 <= 16000
*LOD 5 >16000

(Quadratic Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4500
*LOD 3 <= 8000
*LOD 4 <= 12500
*LOD 5 <= 18000
*LOD 6 >18000

Larger models, such as capital vessels and large installations will likely follow a similar curve, but at a higher offset, due to increased size. Truly massive models should be partitioned into multiple meshes, each with its own set of LODs such that nearer portions of the model can be independently represented at higher LOD than more distant ones. Partitioning into multiple meshes may be preferable even for merely "largish" models so as to preserve reasonable correspondence between single pixels and the size of represented features when texturing.

==Textures==

Texture maps should also be made accordingly, although clearly artistic integrity trivially trumps the following rough guideline (if you need more pixels, use them) and the appropriate texture size may depend greatly upon the size of the model.

*LOD 1 128x128
*LOD 2 256x256
*LOD 3 512x512
*LOD 4 1024x1024
*LOD 5 and up having multiple 1024x1024 textures

Be careful with ''texture lodding abuse''. Each LOD that uses its own texture will require more memory (video memory), and breaks batching between instances (slows down rendering of many instances of this model). Even so, texture lodding actually frees up memory most of the time, since only lesser versions are used in the distance. A general rule of thumb is to never have more than two or at most three versions of the same texture. Also take any opportunity to convert textures to greyscale when the color loss is not quite noticeable (most commonly with glow maps and specular maps).

Likewise, for larger models, do not neglect the potential addition of detail textures.

See also [[Development:Texture Guidelines]] and [[Development:Graphics_Requirements]].

===Faction Textures===

To include and successfully test faction textures in your data, you need to:
* set the corresponding vegastrike.config variable (<code>var name="faction_dependant_textures" value="1"</code>).
* prefix default textures with the faction name, e.g. when your default texture is called "tex_000.texture", to enable the faction texture for "pirates" you'll need to add the texture "pirates_tex_000.texture".
* change configuration to one of the 2 highest computer modes (512M+1GB or 1024MB).

==Shield and Collision Meshes==
Separate shield meshes are highly desirable. Shield meshes should also be done using LODs, although shield meshes should remain simple - that is, their top level meshes should not contain odious numbers of polygons for something that is only infrequently displayed.

Collision meshes need not (and cannot) have LODs. For complex models, it is wise to provide a dumbed-down version of the model that reasonably approximates its shape - minor features and greebles can be safely removed, for instance - to improve performance on the physics engine. Polycount should be kept to a minimum, '''without sacrificing any major features''' of the top-level LOD. Very small vessels (or appropriately shaped ones) may opt to not specify a collision mesh, which will make the physics layer treat this mesh as a spherical object (most efficient).

==HUD Image==

Provides perspective view of the model oriented with the nose towards the left-bottom corner of the image.
The master image resolution should start at 256x256 pixels with transparency around the vessel.

==See also==
For an example of an entity that is composed of multiple meshes, uses LODs, and shield meshes, examine the Clydesdale. (Note that shield and collision meshes are specified in the units.csv file, not by the model.)

=Model Creation=

The first (and most enjoyable) job is to design and draw your model (the geometrical object) within your program.

Feel free to use any modeling program, but it must be able to export models in either (Wavefront) .OBJ or (Vega Strike) .xmesh format. If you don't know where to start, see [[Links:3D Applications]] for a list of modeling software. [http://www.wings3d.com/ Wings 3D] is recommended for modeling beginners. [http://www.blender.org/ '''Blender'''] is the tool of choice for VS artistic community.

==Orientation==
First off, do yourself a favor and line your model up correctly before you begin. For the purposes of Vega Strike, Z+ is forwards and Y+ is up. The model's nose should be pointing forward along the Z+ axis (so that the Z+ axis would theoretically be visible from the cockpit). The mesh should also be properly centered.
Summing up:
* Z+ -> Forward direction
* Y+ -> Up direction
* Centered

== Tutorials==

{{warning_text |
| text='''Note:''' The tutorials overview is not complete. Many of the available tutorials have not yet been integrated into this page. Refer also to the [[HowTos|'''How-Tos Tutorials''']] page for additional tutorials.}}

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98b2ee" |
|'''Modeling Step
|'''Blender
|'''Wings3D
|-
| Create mesh
| -
| [[HowTo:Create Ships in Wings3D|Creating a 3D-model]]
|-
| Smoothing
| [[HowTo:Smooth Groups|Smoothing]] [[HowTo:Weld|Smooth Welding]]
| -
|-
| Mesh cleanup
| [[HowTo:Bevel|Beveling]]
| -
|-
| Unwrapping
| [[HowTo:Unwrap_in_Blender|Unwrapping 1]] [[HowTo:Unwrap|Unwrapping 2]] [[HowTo:FullUnwrapBlender|Ship unwrap]]
| -
|-
| Radiosity Baking
| [[HowTo:Radiosity baking in Blender|Radiosity baking]]
| -
|-
| Exporting
| -
| -
|}

This articles are WIP, means still need to be reviewed and decided how to restructure them:
* [[HowTo:Create Cockpit in Wings3d|Creating a 3D cockpit for your ship.]]
* [[HowTo:Add LODs|Adding Levels of Detail]]
* [[HowTo:Add Ships|Adding your ship to Vega Strike]] - An overview of how to create and add ships to the game
* [[HowTo:Create Models]] - Links to forum discussions. Page will become generic model creation tutorial.
* Modeling Tutorials: [[HowTos#Modeling]]

===Blender Basics===
* [[HowTo:Basic Blender Tutorial|A basic Blender3D tutorial]]: [http://www.cdschools.org/54223045235521/blank/browse.asp?A=383&BMDRN=2000&BCOB=0&C=55205 Blender Basics - 3rd Edition] - not specific to ships, though...

===Wings3D Basics===

===Other Software Basics===

* [[HowTo:Model a Ship|Brad Mick's video tutorial on ship modeling]] - using Lightwave, but the concept is general: ''Rapid Prototyping''

=Texture Creation=

==Unwrapping==

Please make non-overlapping UV unwraps for all future models. You can't bake a proper AO with overlapping islands.

==Unsorted==

(general guidelines, tips, best practices, app specific tutorials, ...)

* [http://netzwelt.gaming-hut.de/vegatexturing/ WIP VegaStrike texturing page by Major]
* [http://edice.netfirms.com/tuts/texturetut.htm Texturing tutorial by Duality]

For the time being, you may wish to have a look at the corresponding [[Development:Texture_Guidelines|Texturing Guidelines]].

* [[Development:Texture Guidelines|Guidelines for creating ship materials]]

* [[HowTo:Add Per Pixel Lighting|Adding per-pixel lighting to your 3D model]]
* [[HowTo:IntroToShaders|Introduction to shaders, and what they mean for you]] --Bumpmaps, Normalmaps, Shininess maps ...

* [[HowTo:Texture|Creating your own textures]] - A summary on how to make texture maps
* [[HowTo:Texture in Wings3d|Texturing your model in Wings 3d]]
* [[HowTo:SuperrealisticTexturing|Tips for realistic-looking textures]]
* [[HowTo:Make Animated Textures|Using animated textures on a model]]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/texturing_noodle LaGrande Noodle]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/ao_and_prt_bakes AO and PRT bakes, using Blender and xNormal]

=Integration and Testing=

Using UnitConverter to convert all files and edit the model stats for Vega Strike:
[[Development:Tools:UnitConverter]]

===Object Marker===
In order to automatically create turret mounts, gun mounts, and engine thrusters placements in units.csv, please use the following marker:

http://deeplayer.com/cinemut/gunmountmarker.jpg

The shape is 1 units wide in X, 2 units tall in Y, 4 units long in Z. Four vertices in total. The center between the two vertices on X is the origin; the vertex on Z marks the forward direction; the vertex on Y marks the up direction.
The exported object names are ready and the forward and up directions are calculated from the marker dimensions. Thus, we don't need to worry about mesh rotations; we can deduce mesh rotation from the marker.

The dock marker for docking ports is an exception, since the docking square in game is always rendered facing the player, so the orientation doesn't really matter and only the center matters for the docking port position.

[author:chuck_starchaser]
* Here's the marker blend file (you could load and save as the default blender start):
** [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/modtools/UnitConverter/helper/mount_helper.blend?view=log ''modtools/UnitConverter/helper/mount_helper.blend'']
* Starts with a marker smack in the middle.
* You can move it to another layer, later duplicate it as needed to place copies at key locations.
* You can also import the marker into another blend file:
** Open whatever.blend, go to File -> Append Or Link
** Navigate to where UnitConverter/helper/mount_helper.blend is.
* Go to the "Objects" folder, and click on the "Marker" object.
* To duplicate an object, in object mode, select and shift-D.
* To rename your duplicated object, hit F9 and, towards the left, where it says OB:Marker click in the middle of it and then type "turret_heavy_0" or whatever.
* copy all markers to layer 2
* select layer 2
* select all markers with the A key
* export to obj using Edges, Objects

http://vegastrike.sourceforge.net/albums/WIPs-and-Concept-Art/mounts_20080911.jpg

The above image shows the markers set as the centers of engine thrusts.

It is advisable to group the marker objects into a group called "marker". You are required to export all the markers into one obj file that needs to contain the name "marker" in it (letter case is unimportant, it can be "marker", or "Marker").

Object Helper naming convention: ''type_subtype_identifier''

with type:
* pilot (currently unused)
* mount (currently unused)
* turret
* subunit
* engine
* dock

and subtype being optional (convention tbd),
and identifier being either a number or a description and optional.

You may define for example:
* dock
* dock_auto_20
* mount_lightmedium_0
* turret_capmissile_frontleft
* subunit_1
* engine_retro_left

===Exporting to OBJ===

===Updating Stats===
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
* [[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]

=Submission and Vetting=

=Technical Reference=

==Technical Specifications==

* [[HowTo:Edit BFXM files|Editing BFXM files (format spec)]]
* [[HowTo:Edit XMESH files|Editing the xmesh file of a ship]]
* [[HowTo:Edit units.csv|Editing units.csv]]
* [[HowTo:Add Engine Glow|Adding an engine glow to your 3D model]]

==Scripts and Tools==

See [[Development:Scripts_%26_Tools|Scripts & Tools]]
* [[HowTo:Add_Ships#New_method|mesher converter obj <-> bfxm <-> xmesh]]
* [[Development:Tools:UnitConverter|UnitConverter]]

=References=

* [http://wcpedia.com/dw/doku.php/wc_info/modding/index WCpedia Modeling Page]

[[Category:Development|Model Guidelines]]
[[Category:Modeling|Model Guidelines]]

FAQ:Bugs

2011-04-06T09:13:38Z

Pyramid: /* I'm on a Mac, running OSX.1.5. When I launch the game I end up in a dock or whatever and the graphics are all scrambled. I have like a horizon-like view of my ship going back from the bottom of the screen to the top. I cannot READ anything. Whats

{{Languages|En|FAQ:Bugs}}
{{NAV_Manual |
| previous=[[FAQ:Installing]]
| up=[[FAQ]]
| next=[[FAQ:Modding]]
}}
----
= My game has crashed. What do i do? =

* First step would be to find stdout.txt and stderr.txt and see if there are any errors or warnings.
* You may also run vegastrike --debug=3 with a more comprehensive debug level. Submit stdout.txt and stderr.txt.
* Finally, you could run vegastrike in a debugger and submit the debug output. Here are instructions for [[HowTo:Use_GDB|Linux]] and [[HowTo:Use_Dr_Watson|Windows]].

= I have run the debug as indicated above, but don't understand the gibberish. What now? =

Please submit the text files with the debug output including the VS engine version you are playing, your operating system (Linux/OSX/WIndows/32bit/64bit), your graphics card make and model. Ideally it would help to know what you were doing when the game crashed (docking, launching, loading, saving, viewing the map, ...), and if the crash is reproducible with the same circumstances.

== I'm on a Mac, running OSX.1.5. When I launch the game I end up in a dock or whatever and the graphics are all scrambled. I have like a horizon-like view of my ship going back from the bottom of the screen to the top. I cannot READ anything. Whats that about? ==

A: This problem has been carefully documented and annoyed about.

There's nothing we can do about this problem.

It's an ATI Rage Mac problem, and an ATI linux problem...

It doesn't occur on the same hardware in windows..and it doesn't occur on any other hardware period.
So the best thing I can advise is use the right mouse button (or if you have one control click) to cycle through the options at the bases if you want to see what the bases SHOULD look like you can open up the jpeg files in the view contents section of the VegaStrike0.3.0.app (see the bugs-forum for more detail)

WORKAROUND (used successfully on an iBook with ATI card):

The problem seems to occur when the texture sizes overwhelm the available texture memory on the graphic card. This can be alleviated by lowering the resolution (and therefore the graphics memory usage).

In other words, try running at 512x384 by editing the vegastrike.config file, if that works keep increasing the resolution until you find one that works you can comfortably play at.

-- Aegidian

== When i run Vegastrike under linux i get an error similar with that below, what should i do? ==
<pre>
vegastrike WARNING: no section/variable/color named drawNavSymbol Fatal signal: Segmentation Fault (SDL Parachute Deployed)
</pre>

A:
* run Vegastrike in gdb:
<pre>
gdb ./vegastrike
run
</pre>
* when Vegastrike dies type: <code>backtrace full</code>
* post the results in the Bug Triage Forum at the Vegastrike Homepage

More about the usage of gdb is under [[HowTo:Use GDB]]

== What should I do if in Windows XP, the game crashes immediately, or works only if it is on "Music Only" or "No Sound" modes in Setup? ==

A: It is very easy:
* Go to your Vega Strike folder (If you are really lost and can't find the vegastrike folder, find the Vegastrike Setup program in the start menu, right click on it and go to properties. Then click on the "Find Target" button.)
* Double-click on the <code>OpenALwEAX.exe</code> program (The icon has an orange diamond with a blue ball inside it).
* Go through the steps by clicking the Next button.
* Play Vega Strike.

Sometimes you have to delete the openal32.dll (an old one)from your vegastrike/bin directory to prevent VS from crashing. There shouldn't be one (only VS0.4.0 has them with it, but you never know).

== When docked i don't have a mouse pointer. Why is that? ==

A: see [[#I.27m_on_a_Mac.2C_running_OSX.1.5._When_I_launch_the_game_I_end_up_in_a_dock_or_whatever_and_the_graphics_are_all_scrambled._I_have_like_a_horizon-like_view_of_my_ship_going_back_from_the_bottom_of_the_screen_to_the_top._I_cannot_READ_anything._Whats_that_about.3F|Q1]] above

You may want to change to the "Hardware Cursor" option in the "MousePointer" list in the Setup/Options menu.

== Moving around at all with SPEC on makes the game segfault immediately, what's wrong? ==

A: This is a problem with the ATi Linux drivers, which currently crash if you ask them to draw a line. The fix is to use the DRI project's drivers if possible, the best known workaround is to change
<pre><var name="star_streaks" value="true"/></pre>
into
<pre><var name="star_streaks" value="false"/></pre>
in <code>vegastrike.config</code>.

== In Linux, whenever VS is in fullscreen the image is crappy: it looks like an old DOS game that used interlaced settings (one line printed, one line blank) that is pretty much impossible to read on. How do I fix it? ==

A: This is a problem with X or the SDL... outside control of VegaStrike. But there is a workaround:
Find, in <code>vegastrike.config</code>:
<pre>#cat Resolution 1600x1200 1280x1024 1024x768 800x600 640x480 512x384</pre>
Add to the list of resolutions the exact resolution of your desktop, if it isn't there.
Next, find:
<pre>
</pre>
Create another copy of it to accommodate your newly created setting, like this:
<pre>

</pre>
Now start vssetup, and select that resolution. It should now work.
Alternatively, if vssetup doesn't work for you, just edit the active entry (the one not commented out - where
you see <pre></pre> instead of <pre><!-- #800x600</pre>

== In linux, with an nVidia graphics card, I see weird things over some planets. ==

Weird, as in [[http://space3d.no.sapo.pt/vegastrike/screens/PUShader_atmosphere.jpg here]].
Check you drivers. Anything between version 169 and 173 (inclusive) has a known bug when loading the DXT5 textures used by VS.
Upgrade your drivers to at least 174 and it should be fixed.

----
{{NAV_Manual |
| previous=[[FAQ:Installing]]
| up=[[FAQ]]
| next=[[FAQ:Modding]]
}}

[[Category:FAQ]]

Development:Model Guidelines

2011-04-05T23:22:53Z

Pyramid: /* Exporting to OBJ+MTL */

{{parent_link|parent=[[Development]]}}
= Introduction =

The intention of this document is to give artists using the Vega Strike engine some suggested guidelines to follow in creating models. You may also wish to have a look at the corresponding [[Development:Texture_Guidelines|texturing guidelines]].

So you want to create a new ship for Vega Strike, do you? While virtually all models are welcome, well before you start cranking out wonderfully designed models we request that you first check what models are still required.

{{warning_text |
| text='''Note:''' If you wish to contribute a new or updated model (ship, installation, turret, cockpit, ..) to the game Vega Strike, please see the [[Development:3D_Models|'''3D Models''']] page for models requiring attention.}}

Alternatively, contact [[User:jackS|jackS]] or [[User:pyramid|pyramid]].

= Modeling Pipeline Overview =

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98ffb2" |
|'''Step
|'''Input
|'''Output
|'''Tools
|'''Requirements
|'''Tutorials
|-

| Model Selection
| -
| required model
| model task list
| -
| -
|-

| Conceptualization
| selected model
| model concept
| pen & paper, artwork forum
| artstyle guide
| -
|-

| Modeling
| concept
| model mesh, obj files
| blender, forum
| many
| -
|-

| Texturing
| model mesh
| textures
| gimp, forum
| texture requirements
| -
|-

| Integration
| model + textures
| bfxm + dds textures
| mesher + UnitConverter
| -
| -
|-

| Testing
| bfxm model + dds textures
| visual + behavior
| vegastrike + modelview.mission
| pass or rework
| -
|-

| Submission
| blender file + obj, master textures, bfxm + dds textures
| archive or svn
| mail, svn client
| -
| -
|}

=Model Requirements=

==Requirements Checklist==

Considerations for a successful model submission:
* Model is in the requirements list [[Development:3D_Models|->]]
* Abides to faction visual guidelines
* Has approved concept
* Provides model source file (blender, Wings3D, ...)
* Provides OBJ file
* Has model mesh, shield mesh, LoD meshes, helper meshes
* Provides uncompressed textures in png format (and optionally faction textures)
* Provides texture source files (GIMP, ...)
* Provides HUD png image with correct orientation
* Provides units.csv file entry

==Model Requirements Details==

==Visual Guidelines==

For particular aesthetic guidelines, please see the [[Artstyle guides]] page. Please note that many of the existing models are used because of expedience, not because they fit well with VS canon (i.e. if you make something new look like what's there, it still might not be what we're looking for). If in doubt, please ask on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

To absolutely sure, for new models, please create a drawing of your proposed concept and let it be discussed and approved on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

See also [[Development:Texture Guidelines]]

==Model File Format==
The preferred format for submission (for public disbursement - whatever native format is used inside your favorite modeling suite is fortunately a non-issue) is currently Wavefront OBJ file format, as this is the most easily converted between manipulation (assorted modeling tools) and presentation (currently BFXM, later to be the OGRE .mesh format). Model "source" therefore, is, at present (Sep. 2008), most usefully uploaded as .OBJ.

Until such a time as a visual model editing tool is completed, conversion to a game-ready format will likely pass through the .xmesh format for insertion of LOD references into top level mesh(es), correction of coordinate "handedness" (if the ordering of the coordinate axes is incompatible, as appears to happen with the output of some modeling tools).

See [[HowTo:Add_Ships]] for information on using mesher to convert to a presentation format (such as BFXM). Note that an old utility, objconv, is '''not''' mesher, and should not be used for this task. Source files for the mesher utility are included along with VS source. Windows users may download updated mesher binaries from their SVN interface of choice (the binary will be in the \bin directory).

==Polygon/Vertex Count==
In broadest terms, the desired polygon count for a particular model is dependent on three major factors:
*The amount of screen real-estate that the model is likely to be viewed at the majority of time that a user will be seeing it (i.e. a 2 meter long rocket doesn't deserve the same order of magnitude of attention to detail as a large base or vessel unless the rocket is expected to be mounted in front of a camera. Likewise, even at the same level of attention in terms of polygons per square meter, it would have far fewer total polygons.)
*The intrinsic surface complexity of the model. If one is modeling a box for freight cargo, one is not going to need as many polygons as if one needed to model one of the Vega Strike developers (not that we're necessarily model material ;-)). If you don't use enough polygons, no amount of texture magic can save a model from being ugly. That said, if you are modeling a cargo freight container and you use thousands of polygons, you're being negligent and wasteful of resources.
*Engine limitations. Engine limitations is a bit of a misnomer, as the performance of the graphical engine is more hardware dependent than anything else, but it's a good heading for lumping any non-artistic hurdles under. This is the most complicated of the three major factors, because it represents a moving target. Suffice it to say that in order to preserve playability on a broad range of systems, there is a premium placed on making a model aesthetically appropriate with the minimum number of polygons.

Rough guideline:
*Fighter: 15k triangles
*Corvette: 30k tris
*Cruiserer: 60k
*Carrier: 120k
*Space station: 250k

However, significant discression, and the possibility for using large numbers of polygons to prettify an object remain with the artist, provided they make appropriate use of [[Terminology:LODs|LODs]]. The primary focus needs to be on making a model aesthetically appropriate, for an intended common viewing distance, and then catering to the needs of the engine by introducing lower LODs (if necessary) and catering to artistic desires by introducing higher LODs (if appropriate). There is also an element of minor future proofing that occurs with providing a robust range of LOD poly counts - namely, multiple versions of the data set can be constructed targeted at different hardware points by shifting up or down along the LOD set (although this currently isn't bothered with, if and when we develop a true source repository for models and textures, this will likely become more common, as postprocessing of submitted art will become tenable).

One more point to consider before attempting to set a polygon goal for a model is what the likely total contribution from all instances on screen of a given model will be - if the model represents something particularly rare, then it is likely that a few more polygons can easily be spared on its model than for more common objects of otherwise similar size, complexity, etc.

Above all, use common sense - if it's visually hideous because it doesn't have enough polygons, it's not your top level model, and if it's in the 5 digit range for polygon count, it's not your lowest level LOD. Take into consideration how much screen real estate, based on the intended in-game size of the model (and if you don't have any idea how big it's supposed to be - you're doing something wrong already) the model will be taking up at various distances, and calibrate detail appropriately (this will become a much easier task once there is a visual modeling tool from the VS side) - to belabor the obvious, the difference between 500 polygons and 5000 gets somewhat obscured when the object is only drawn using 64 pixels. Note therefore that larger objects will often necessitate higher polygon counts merely because there's more of them to see.

(Note that there is no need to continue adding LODs beyond a point of "diminishing artistic returns" - if adding more detail won't help, don't bother. If adding detail helps, but is too expensive to be practical, then it may still be worthwhile for later inclusion as hardware resources increase.)

For small to moderate craft and installations, something along the lines of either of the following is not inappropriate:

(Exponential Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4000
*LOD 3 <= 8000
*LOD 4 <= 16000
*LOD 5 >16000

(Quadratic Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4500
*LOD 3 <= 8000
*LOD 4 <= 12500
*LOD 5 <= 18000
*LOD 6 >18000

Larger models, such as capital vessels and large installations will likely follow a similar curve, but at a higher offset, due to increased size. Truly massive models should be partitioned into multiple meshes, each with its own set of LODs such that nearer portions of the model can be independently represented at higher LOD than more distant ones. Partitioning into multiple meshes may be preferable even for merely "largish" models so as to preserve reasonable correspondence between single pixels and the size of represented features when texturing.

==Textures==

Texture maps should also be made accordingly, although clearly artistic integrity trivially trumps the following rough guideline (if you need more pixels, use them) and the appropriate texture size may depend greatly upon the size of the model.

*LOD 1 128x128
*LOD 2 256x256
*LOD 3 512x512
*LOD 4 1024x1024
*LOD 5 and up having multiple 1024x1024 textures

Be careful with ''texture lodding abuse''. Each LOD that uses its own texture will require more memory (video memory), and breaks batching between instances (slows down rendering of many instances of this model). Even so, texture lodding actually frees up memory most of the time, since only lesser versions are used in the distance. A general rule of thumb is to never have more than two or at most three versions of the same texture. Also take any opportunity to convert textures to greyscale when the color loss is not quite noticeable (most commonly with glow maps and specular maps).

Likewise, for larger models, do not neglect the potential addition of detail textures.

See also [[Development:Texture Guidelines]] and [[Development:Graphics_Requirements]].

===Faction Textures===

To include and successfully test faction textures in your data, you need to:
* set the corresponding vegastrike.config variable (<code>var name="faction_dependant_textures" value="1"</code>).
* prefix default textures with the faction name, e.g. when your default texture is called "tex_000.texture", to enable the faction texture for "pirates" you'll need to add the texture "pirates_tex_000.texture".
* change configuration to one of the 2 highest computer modes (512M+1GB or 1024MB).

==Shield and Collision Meshes==
Separate shield meshes are highly desirable. Shield meshes should also be done using LODs, although shield meshes should remain simple - that is, their top level meshes should not contain odious numbers of polygons for something that is only infrequently displayed.

Collision meshes need not (and cannot) have LODs. For complex models, it is wise to provide a dumbed-down version of the model that reasonably approximates its shape - minor features and greebles can be safely removed, for instance - to improve performance on the physics engine. Polycount should be kept to a minimum, '''without sacrificing any major features''' of the top-level LOD. Very small vessels (or appropriately shaped ones) may opt to not specify a collision mesh, which will make the physics layer treat this mesh as a spherical object (most efficient).

==HUD Image==

Provides perspective view of the model oriented with the nose towards the left-bottom corner of the image.
The master image resolution should start at 256x256 pixels with transparency around the vessel.

==See also==
For an example of an entity that is composed of multiple meshes, uses LODs, and shield meshes, examine the Clydesdale. (Note that shield and collision meshes are specified in the units.csv file, not by the model.)

=Model Creation=

The first (and most enjoyable) job is to design and draw your model (the geometrical object) within your program.

Feel free to use any modeling program, but it must be able to export models in either (Wavefront) .OBJ or (Vega Strike) .xmesh format. If you don't know where to start, see [[Links:3D Applications]] for a list of modeling software. [http://www.wings3d.com/ Wings 3D] is recommended for modeling beginners. [http://www.blender.org/ '''Blender'''] is the tool of choice for VS artistic community.

==Orientation==
First off, do yourself a favor and line your model up correctly before you begin. For the purposes of Vega Strike, Z+ is forwards and Y+ is up. The model's nose should be pointing forward along the Z+ axis (so that the Z+ axis would theoretically be visible from the cockpit). The mesh should also be properly centered.
Summing up:
* Z+ -> Forward direction
* Y+ -> Up direction
* Centered

== Tutorials==

{{warning_text |
| text='''Note:''' The tutorials overview is not complete. Many of the available tutorials have not yet been integrated into this page. Refer also to the [[HowTos|'''How-Tos Tutorials''']] page for additional tutorials.}}

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98b2ee" |
|'''Modeling Step
|'''Blender
|'''Wings3D
|-
| Create mesh
| -
| [[HowTo:Create Ships in Wings3D|Creating a 3D-model]]
|-
| Smoothing
| [[HowTo:Smooth Groups|Smoothing]] [[HowTo:Weld|Smooth Welding]]
| -
|-
| Mesh cleanup
| [[HowTo:Bevel|Beveling]]
| -
|-
| Unwrapping
| [[HowTo:Unwrap_in_Blender|Unwrapping 1]] [[HowTo:Unwrap|Unwrapping 2]] [[HowTo:FullUnwrapBlender|Ship unwrap]]
| -
|-
| Radiosity Baking
| [[HowTo:Radiosity baking in Blender|Radiosity baking]]
| -
|-
| Exporting
| -
| -
|}

This articles are WIP, means still need to be reviewed and decided how to restructure them:
* [[HowTo:Create Cockpit in Wings3d|Creating a 3D cockpit for your ship.]]
* [[HowTo:Add LODs|Adding Levels of Detail]]
* [[HowTo:Add Ships|Adding your ship to Vega Strike]] - An overview of how to create and add ships to the game
* [[HowTo:Create Models]] - Links to forum discussions. Page will become generic model creation tutorial.
* Modeling Tutorials: [[HowTos#Modeling]]

===Blender Basics===
* [[HowTo:Basic Blender Tutorial|A basic Blender3D tutorial]]: [http://www.cdschools.org/54223045235521/blank/browse.asp?A=383&BMDRN=2000&BCOB=0&C=55205 Blender Basics - 3rd Edition] - not specific to ships, though...

===Wings3D Basics===

===Other Software Basics===

* [[HowTo:Model a Ship|Brad Mick's video tutorial on ship modeling]] - using Lightwave, but the concept is general: ''Rapid Prototyping''

=Texture Creation=

==Unwrapping==

Please make non-overlapping UV unwraps for all future models. You can't bake a proper AO with overlapping islands.

==Unsorted==

(general guidelines, tips, best practices, app specific tutorials, ...)

* [http://netzwelt.gaming-hut.de/vegatexturing/ WIP VegaStrike texturing page by Major]
* [http://edice.netfirms.com/tuts/texturetut.htm Texturing tutorial by Duality]

For the time being, you may wish to have a look at the corresponding [[Development:Texture_Guidelines|Texturing Guidelines]].

* [[Development:Texture Guidelines|Guidelines for creating ship materials]]

* [[HowTo:Add Per Pixel Lighting|Adding per-pixel lighting to your 3D model]]
* [[HowTo:IntroToShaders|Introduction to shaders, and what they mean for you]] --Bumpmaps, Normalmaps, Shininess maps ...

* [[HowTo:Texture|Creating your own textures]] - A summary on how to make texture maps
* [[HowTo:Texture in Wings3d|Texturing your model in Wings 3d]]
* [[HowTo:SuperrealisticTexturing|Tips for realistic-looking textures]]
* [[HowTo:Make Animated Textures|Using animated textures on a model]]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/texturing_noodle LaGrande Noodle]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/ao_and_prt_bakes AO and PRT bakes, using Blender and xNormal]

=Integration and Testing=

Using UnitConverter to convert all files and edit the model stats for Vega Strike:
[[Development:Tools:UnitConverter]]

===Object Marker===
In order to automatically create turret mounts, gun mounts, and engine thrusters placements in units.csv, please use the following marker:

http://deeplayer.com/cinemut/gunmountmarker.jpg

The shape is 1 units wide in X, 2 units tall in Y, 4 units long in Z. Four vertices in total. The center between the two vertices on X is the origin; the vertex on Z marks the forward direction; the vertex on Y marks the up direction.
The exported object names are ready and the forward and up directions are calculated from the marker dimensions. Thus, we don't need to worry about mesh rotations; we can deduce mesh rotation from the marker.

[author:chuck_starchaser]
* Here's the marker blend file (you could load and save as the default blender start):
** [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/modtools/UnitConverter/helper/mount_helper.blend?view=log ''modtools/UnitConverter/helper/mount_helper.blend'']
* Starts with a marker smack in the middle.
* You can move it to another layer, later duplicate it as needed to place copies at key locations.
* You can also import the marker into another blend file:
** Open whatever.blend, go to File -> Append Or Link
** Navigate to where UnitConverter/helper/mount_helper.blend is.
* Go to the "Objects" folder, and click on the "Marker" object.
* To duplicate an object, in object mode, select and shift-D.
* To rename your duplicated object, hit F9 and, towards the left, where it says OB:Marker click in the middle of it and then type "gunmount_0_light_medium" or whatever.

http://vegastrike.sourceforge.net/albums/WIPs-and-Concept-Art/mounts_20080911.jpg

The above image shows the markers set as the centers of engine thrusts.

It is advisable to group the marker objects into a group called "marker". You are required to export all the markers into one obj file that needs to contain the name "marker" in it (letter case is unimportant, it can be "marker", or "Marker").

Object Helper naming convention: ''type_subtype_identifier''

with type:
* pilot (currently unused)
* mount (currently unused)
* turret
* subunit
* engine
* dock

and subtype being optional (convention tbd),
and identifier being either a number or a description and optional.

You may define for example:
* pilot
* pilot_john
* mount_lightmedium_0
* turret_capmissile_frontleft
* subunit_1
* engine_retro_left

===Exporting to OBJ===

===Updating Stats===
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
* [[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]

=Submission and Vetting=

=Technical Reference=

==Technical Specifications==

* [[HowTo:Edit BFXM files|Editing BFXM files (format spec)]]
* [[HowTo:Edit XMESH files|Editing the xmesh file of a ship]]
* [[HowTo:Edit units.csv|Editing units.csv]]
* [[HowTo:Add Engine Glow|Adding an engine glow to your 3D model]]

==Scripts and Tools==

See [[Development:Scripts_%26_Tools|Scripts & Tools]]
* [[HowTo:Add_Ships#New_method|mesher converter obj <-> bfxm <-> xmesh]]
* [[Development:Tools:UnitConverter|UnitConverter]]

=References=

* [http://wcpedia.com/dw/doku.php/wc_info/modding/index WCpedia Modeling Page]

[[Category:Development|Model Guidelines]]
[[Category:Modeling|Model Guidelines]]

Development:Model Guidelines

2011-04-05T23:22:13Z

Pyramid: /* Modeling Pipeline Overview */

{{parent_link|parent=[[Development]]}}
= Introduction =

The intention of this document is to give artists using the Vega Strike engine some suggested guidelines to follow in creating models. You may also wish to have a look at the corresponding [[Development:Texture_Guidelines|texturing guidelines]].

So you want to create a new ship for Vega Strike, do you? While virtually all models are welcome, well before you start cranking out wonderfully designed models we request that you first check what models are still required.

{{warning_text |
| text='''Note:''' If you wish to contribute a new or updated model (ship, installation, turret, cockpit, ..) to the game Vega Strike, please see the [[Development:3D_Models|'''3D Models''']] page for models requiring attention.}}

Alternatively, contact [[User:jackS|jackS]] or [[User:pyramid|pyramid]].

= Modeling Pipeline Overview =

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98ffb2" |
|'''Step
|'''Input
|'''Output
|'''Tools
|'''Requirements
|'''Tutorials
|-

| Model Selection
| -
| required model
| model task list
| -
| -
|-

| Conceptualization
| selected model
| model concept
| pen & paper, artwork forum
| artstyle guide
| -
|-

| Modeling
| concept
| model mesh, obj files
| blender, forum
| many
| -
|-

| Texturing
| model mesh
| textures
| gimp, forum
| texture requirements
| -
|-

| Integration
| model + textures
| bfxm + dds textures
| mesher + UnitConverter
| -
| -
|-

| Testing
| bfxm model + dds textures
| visual + behavior
| vegastrike + modelview.mission
| pass or rework
| -
|-

| Submission
| blender file + obj, master textures, bfxm + dds textures
| archive or svn
| mail, svn client
| -
| -
|}

=Model Requirements=

==Requirements Checklist==

Considerations for a successful model submission:
* Model is in the requirements list [[Development:3D_Models|->]]
* Abides to faction visual guidelines
* Has approved concept
* Provides model source file (blender, Wings3D, ...)
* Provides OBJ file
* Has model mesh, shield mesh, LoD meshes, helper meshes
* Provides uncompressed textures in png format (and optionally faction textures)
* Provides texture source files (GIMP, ...)
* Provides HUD png image with correct orientation
* Provides units.csv file entry

==Model Requirements Details==

==Visual Guidelines==

For particular aesthetic guidelines, please see the [[Artstyle guides]] page. Please note that many of the existing models are used because of expedience, not because they fit well with VS canon (i.e. if you make something new look like what's there, it still might not be what we're looking for). If in doubt, please ask on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

To absolutely sure, for new models, please create a drawing of your proposed concept and let it be discussed and approved on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

See also [[Development:Texture Guidelines]]

==Model File Format==
The preferred format for submission (for public disbursement - whatever native format is used inside your favorite modeling suite is fortunately a non-issue) is currently Wavefront OBJ file format, as this is the most easily converted between manipulation (assorted modeling tools) and presentation (currently BFXM, later to be the OGRE .mesh format). Model "source" therefore, is, at present (Sep. 2008), most usefully uploaded as .OBJ.

Until such a time as a visual model editing tool is completed, conversion to a game-ready format will likely pass through the .xmesh format for insertion of LOD references into top level mesh(es), correction of coordinate "handedness" (if the ordering of the coordinate axes is incompatible, as appears to happen with the output of some modeling tools).

See [[HowTo:Add_Ships]] for information on using mesher to convert to a presentation format (such as BFXM). Note that an old utility, objconv, is '''not''' mesher, and should not be used for this task. Source files for the mesher utility are included along with VS source. Windows users may download updated mesher binaries from their SVN interface of choice (the binary will be in the \bin directory).

==Polygon/Vertex Count==
In broadest terms, the desired polygon count for a particular model is dependent on three major factors:
*The amount of screen real-estate that the model is likely to be viewed at the majority of time that a user will be seeing it (i.e. a 2 meter long rocket doesn't deserve the same order of magnitude of attention to detail as a large base or vessel unless the rocket is expected to be mounted in front of a camera. Likewise, even at the same level of attention in terms of polygons per square meter, it would have far fewer total polygons.)
*The intrinsic surface complexity of the model. If one is modeling a box for freight cargo, one is not going to need as many polygons as if one needed to model one of the Vega Strike developers (not that we're necessarily model material ;-)). If you don't use enough polygons, no amount of texture magic can save a model from being ugly. That said, if you are modeling a cargo freight container and you use thousands of polygons, you're being negligent and wasteful of resources.
*Engine limitations. Engine limitations is a bit of a misnomer, as the performance of the graphical engine is more hardware dependent than anything else, but it's a good heading for lumping any non-artistic hurdles under. This is the most complicated of the three major factors, because it represents a moving target. Suffice it to say that in order to preserve playability on a broad range of systems, there is a premium placed on making a model aesthetically appropriate with the minimum number of polygons.

Rough guideline:
*Fighter: 15k triangles
*Corvette: 30k tris
*Cruiserer: 60k
*Carrier: 120k
*Space station: 250k

However, significant discression, and the possibility for using large numbers of polygons to prettify an object remain with the artist, provided they make appropriate use of [[Terminology:LODs|LODs]]. The primary focus needs to be on making a model aesthetically appropriate, for an intended common viewing distance, and then catering to the needs of the engine by introducing lower LODs (if necessary) and catering to artistic desires by introducing higher LODs (if appropriate). There is also an element of minor future proofing that occurs with providing a robust range of LOD poly counts - namely, multiple versions of the data set can be constructed targeted at different hardware points by shifting up or down along the LOD set (although this currently isn't bothered with, if and when we develop a true source repository for models and textures, this will likely become more common, as postprocessing of submitted art will become tenable).

One more point to consider before attempting to set a polygon goal for a model is what the likely total contribution from all instances on screen of a given model will be - if the model represents something particularly rare, then it is likely that a few more polygons can easily be spared on its model than for more common objects of otherwise similar size, complexity, etc.

Above all, use common sense - if it's visually hideous because it doesn't have enough polygons, it's not your top level model, and if it's in the 5 digit range for polygon count, it's not your lowest level LOD. Take into consideration how much screen real estate, based on the intended in-game size of the model (and if you don't have any idea how big it's supposed to be - you're doing something wrong already) the model will be taking up at various distances, and calibrate detail appropriately (this will become a much easier task once there is a visual modeling tool from the VS side) - to belabor the obvious, the difference between 500 polygons and 5000 gets somewhat obscured when the object is only drawn using 64 pixels. Note therefore that larger objects will often necessitate higher polygon counts merely because there's more of them to see.

(Note that there is no need to continue adding LODs beyond a point of "diminishing artistic returns" - if adding more detail won't help, don't bother. If adding detail helps, but is too expensive to be practical, then it may still be worthwhile for later inclusion as hardware resources increase.)

For small to moderate craft and installations, something along the lines of either of the following is not inappropriate:

(Exponential Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4000
*LOD 3 <= 8000
*LOD 4 <= 16000
*LOD 5 >16000

(Quadratic Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4500
*LOD 3 <= 8000
*LOD 4 <= 12500
*LOD 5 <= 18000
*LOD 6 >18000

Larger models, such as capital vessels and large installations will likely follow a similar curve, but at a higher offset, due to increased size. Truly massive models should be partitioned into multiple meshes, each with its own set of LODs such that nearer portions of the model can be independently represented at higher LOD than more distant ones. Partitioning into multiple meshes may be preferable even for merely "largish" models so as to preserve reasonable correspondence between single pixels and the size of represented features when texturing.

==Textures==

Texture maps should also be made accordingly, although clearly artistic integrity trivially trumps the following rough guideline (if you need more pixels, use them) and the appropriate texture size may depend greatly upon the size of the model.

*LOD 1 128x128
*LOD 2 256x256
*LOD 3 512x512
*LOD 4 1024x1024
*LOD 5 and up having multiple 1024x1024 textures

Be careful with ''texture lodding abuse''. Each LOD that uses its own texture will require more memory (video memory), and breaks batching between instances (slows down rendering of many instances of this model). Even so, texture lodding actually frees up memory most of the time, since only lesser versions are used in the distance. A general rule of thumb is to never have more than two or at most three versions of the same texture. Also take any opportunity to convert textures to greyscale when the color loss is not quite noticeable (most commonly with glow maps and specular maps).

Likewise, for larger models, do not neglect the potential addition of detail textures.

See also [[Development:Texture Guidelines]] and [[Development:Graphics_Requirements]].

===Faction Textures===

To include and successfully test faction textures in your data, you need to:
* set the corresponding vegastrike.config variable (<code>var name="faction_dependant_textures" value="1"</code>).
* prefix default textures with the faction name, e.g. when your default texture is called "tex_000.texture", to enable the faction texture for "pirates" you'll need to add the texture "pirates_tex_000.texture".
* change configuration to one of the 2 highest computer modes (512M+1GB or 1024MB).

==Shield and Collision Meshes==
Separate shield meshes are highly desirable. Shield meshes should also be done using LODs, although shield meshes should remain simple - that is, their top level meshes should not contain odious numbers of polygons for something that is only infrequently displayed.

Collision meshes need not (and cannot) have LODs. For complex models, it is wise to provide a dumbed-down version of the model that reasonably approximates its shape - minor features and greebles can be safely removed, for instance - to improve performance on the physics engine. Polycount should be kept to a minimum, '''without sacrificing any major features''' of the top-level LOD. Very small vessels (or appropriately shaped ones) may opt to not specify a collision mesh, which will make the physics layer treat this mesh as a spherical object (most efficient).

==HUD Image==

Provides perspective view of the model oriented with the nose towards the left-bottom corner of the image.
The master image resolution should start at 256x256 pixels with transparency around the vessel.

==See also==
For an example of an entity that is composed of multiple meshes, uses LODs, and shield meshes, examine the Clydesdale. (Note that shield and collision meshes are specified in the units.csv file, not by the model.)

=Model Creation=

The first (and most enjoyable) job is to design and draw your model (the geometrical object) within your program.

Feel free to use any modeling program, but it must be able to export models in either (Wavefront) .OBJ or (Vega Strike) .xmesh format. If you don't know where to start, see [[Links:3D Applications]] for a list of modeling software. [http://www.wings3d.com/ Wings 3D] is recommended for modeling beginners. [http://www.blender.org/ '''Blender'''] is the tool of choice for VS artistic community.

==Orientation==
First off, do yourself a favor and line your model up correctly before you begin. For the purposes of Vega Strike, Z+ is forwards and Y+ is up. The model's nose should be pointing forward along the Z+ axis (so that the Z+ axis would theoretically be visible from the cockpit). The mesh should also be properly centered.
Summing up:
* Z+ -> Forward direction
* Y+ -> Up direction
* Centered

== Tutorials==

{{warning_text |
| text='''Note:''' The tutorials overview is not complete. Many of the available tutorials have not yet been integrated into this page. Refer also to the [[HowTos|'''How-Tos Tutorials''']] page for additional tutorials.}}

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98b2ee" |
|'''Modeling Step
|'''Blender
|'''Wings3D
|-
| Create mesh
| -
| [[HowTo:Create Ships in Wings3D|Creating a 3D-model]]
|-
| Smoothing
| [[HowTo:Smooth Groups|Smoothing]] [[HowTo:Weld|Smooth Welding]]
| -
|-
| Mesh cleanup
| [[HowTo:Bevel|Beveling]]
| -
|-
| Unwrapping
| [[HowTo:Unwrap_in_Blender|Unwrapping 1]] [[HowTo:Unwrap|Unwrapping 2]] [[HowTo:FullUnwrapBlender|Ship unwrap]]
| -
|-
| Radiosity Baking
| [[HowTo:Radiosity baking in Blender|Radiosity baking]]
| -
|-
| Exporting
| -
| -
|}

This articles are WIP, means still need to be reviewed and decided how to restructure them:
* [[HowTo:Create Cockpit in Wings3d|Creating a 3D cockpit for your ship.]]
* [[HowTo:Add LODs|Adding Levels of Detail]]
* [[HowTo:Add Ships|Adding your ship to Vega Strike]] - An overview of how to create and add ships to the game
* [[HowTo:Create Models]] - Links to forum discussions. Page will become generic model creation tutorial.
* Modeling Tutorials: [[HowTos#Modeling]]

===Blender Basics===
* [[HowTo:Basic Blender Tutorial|A basic Blender3D tutorial]]: [http://www.cdschools.org/54223045235521/blank/browse.asp?A=383&BMDRN=2000&BCOB=0&C=55205 Blender Basics - 3rd Edition] - not specific to ships, though...

===Wings3D Basics===

===Other Software Basics===

* [[HowTo:Model a Ship|Brad Mick's video tutorial on ship modeling]] - using Lightwave, but the concept is general: ''Rapid Prototyping''

=Texture Creation=

==Unwrapping==

Please make non-overlapping UV unwraps for all future models. You can't bake a proper AO with overlapping islands.

==Unsorted==

(general guidelines, tips, best practices, app specific tutorials, ...)

* [http://netzwelt.gaming-hut.de/vegatexturing/ WIP VegaStrike texturing page by Major]
* [http://edice.netfirms.com/tuts/texturetut.htm Texturing tutorial by Duality]

For the time being, you may wish to have a look at the corresponding [[Development:Texture_Guidelines|Texturing Guidelines]].

* [[Development:Texture Guidelines|Guidelines for creating ship materials]]

* [[HowTo:Add Per Pixel Lighting|Adding per-pixel lighting to your 3D model]]
* [[HowTo:IntroToShaders|Introduction to shaders, and what they mean for you]] --Bumpmaps, Normalmaps, Shininess maps ...

* [[HowTo:Texture|Creating your own textures]] - A summary on how to make texture maps
* [[HowTo:Texture in Wings3d|Texturing your model in Wings 3d]]
* [[HowTo:SuperrealisticTexturing|Tips for realistic-looking textures]]
* [[HowTo:Make Animated Textures|Using animated textures on a model]]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/texturing_noodle LaGrande Noodle]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/ao_and_prt_bakes AO and PRT bakes, using Blender and xNormal]

=Integration and Testing=

Using UnitConverter to convert all files and edit the model stats for Vega Strike:
[[Development:Tools:UnitConverter]]

===Object Marker===
In order to automatically create turret mounts, gun mounts, and engine thrusters placements in units.csv, please use the following marker:

http://deeplayer.com/cinemut/gunmountmarker.jpg

The shape is 1 units wide in X, 2 units tall in Y, 4 units long in Z. Four vertices in total. The center between the two vertices on X is the origin; the vertex on Z marks the forward direction; the vertex on Y marks the up direction.
The exported object names are ready and the forward and up directions are calculated from the marker dimensions. Thus, we don't need to worry about mesh rotations; we can deduce mesh rotation from the marker.

[author:chuck_starchaser]
* Here's the marker blend file (you could load and save as the default blender start):
** [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/modtools/UnitConverter/helper/mount_helper.blend?view=log ''modtools/UnitConverter/helper/mount_helper.blend'']
* Starts with a marker smack in the middle.
* You can move it to another layer, later duplicate it as needed to place copies at key locations.
* You can also import the marker into another blend file:
** Open whatever.blend, go to File -> Append Or Link
** Navigate to where UnitConverter/helper/mount_helper.blend is.
* Go to the "Objects" folder, and click on the "Marker" object.
* To duplicate an object, in object mode, select and shift-D.
* To rename your duplicated object, hit F9 and, towards the left, where it says OB:Marker click in the middle of it and then type "gunmount_0_light_medium" or whatever.

http://vegastrike.sourceforge.net/albums/WIPs-and-Concept-Art/mounts_20080911.jpg

The above image shows the markers set as the centers of engine thrusts.

It is advisable to group the marker objects into a group called "marker". You are required to export all the markers into one obj file that needs to contain the name "marker" in it (letter case is unimportant, it can be "marker", or "Marker").

Object Helper naming convention: ''type_subtype_identifier''

with type:
* pilot (currently unused)
* mount (currently unused)
* turret
* subunit
* engine
* dock

and subtype being optional (convention tbd),
and identifier being either a number or a description and optional.

You may define for example:
* pilot
* pilot_john
* mount_lightmedium_0
* turret_capmissile_frontleft
* subunit_1
* engine_retro_left

===Exporting to OBJ+MTL===

===Updating Stats===
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
* [[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]

=Submission and Vetting=

=Technical Reference=

==Technical Specifications==

* [[HowTo:Edit BFXM files|Editing BFXM files (format spec)]]
* [[HowTo:Edit XMESH files|Editing the xmesh file of a ship]]
* [[HowTo:Edit units.csv|Editing units.csv]]
* [[HowTo:Add Engine Glow|Adding an engine glow to your 3D model]]

==Scripts and Tools==

See [[Development:Scripts_%26_Tools|Scripts & Tools]]
* [[HowTo:Add_Ships#New_method|mesher converter obj <-> bfxm <-> xmesh]]
* [[Development:Tools:UnitConverter|UnitConverter]]

=References=

* [http://wcpedia.com/dw/doku.php/wc_info/modding/index WCpedia Modeling Page]

[[Category:Development|Model Guidelines]]
[[Category:Modeling|Model Guidelines]]

Development:Tools:UnitConverter

2011-04-05T22:27:46Z

Pyramid: /* Requirements */

=Introduction=

Raising from the stone age of workflows, in which every task, from texture conversion to editing of unit stats, had to be accomplished manually and only by quite knowledgeable magistrates who knew the alchemy of units.csv columns, xmesh files, and had a magic with meshers. Now, UnitConverter shines upon us, still in the distance, but unmovable like a beacon on solid rock, to be the church of the artists, to accommodate the apostles of Blender, CineMut, and LaGrande, to bring the holy spirit of salvation to this compassionate universe of ours.

Some of the main Unit Converter features:
* bi-directionally converts meshes between obj and bfxm files
* assign textures to (sub)models
* convert model and shield meshes
* compress default and faction input textures to dds output textures
* saves the complete workspace in portable config files
* change model techniques and blend mode
* checks and corrects invalid obj files, recreates mtl files
* creates a model directory if none exists and copies all required files
* compresses hud image and creates a .sprite file
* units.csv entry editor and creator (with default unit stats for new units)
* displays model using VS
* reads mesh dimensions from obj file
* placement of thrusters, turrets, mounts, docks, and blink lights from marker obj file
* on-screen instructions for each workflow module
* production tested

==Important Note==
{{warning_text |
|text=Due to the way ''mesher'' handles command line options (separates different inputs by spaces), it will not allow to use folders or file names with spaces (as common on Windows).
Should you be getting runtime errors during the conversion, you should rename your folder to something like "UnitName" or "Unit_Name_working_folder", i.e. substitute spaces with underscores "_". Do the same for the input files, i.e. "Unit_Name.obj".}}

=Requirements=

In order to run UnitConverter on your system is to have Python 2.5 or 2.6 installed on your system. Python 3.x has different syntax and UnitConveter will not work as long as it hasn't been ported to Python 3. Tkinter library is required to run UnitConverter, however it comes installed with most python distributions. Some Linux distributions require a separate installation of Tkinter.

A requirement for the '''model obj files''' is that no mtl file is provided. UnitConverter will generate its own texture information based on the input given under the '''Model''' panel.
The best way for exporting files from blender is to use the following three options *only*: '''Edges''', '''UVs''', '''Objects'''. You may also enable Normals, and Groups. However the '''Materials''' export option should be explicitly disabled.

Especially when reworking existing units, it is recommended that the model '''obj''' file is named the same way as the unit in ''units.csv'', in particular what concerns the letter case, usually following the CamelCase convention.

You will further require master textures for the object, which must be on the '''png''' file format and [[Development:Graphics_Requirements#Image_dimensions|Power-Of-Two]].
Master textures for factions should have the faction name prefixed to the texture name, e.g. "confed_hull.png".

Optionally, an '''obj''' file with markers can be supplied and must contain the name "marker" in the file name.

Optionally, a shield '''obj''' file can be supplied, containing the name "shield" in the file name.

=Quick Start Guide=

==Configuration==
You must first configure the paths under Config including the application in the path:
* ''path\data'' (to edit unit stats and view model in Vega Strike)
* ''path\mesher.exe'' (to convert model to bfxm) - [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/win32/bin/ get mesher]
* ''path\nvcompress'' (to compress textures) - [[Links:Graphic_Applications#nVidia_Texture_Tools|see here for instructions on nvcompress]]
(There is no need to set the working dir, as this field is purely informational)

==Integrating Models==
Assuming you have exported:
* ship mesh to ''Ship.obj''
* shield to ''Ship-Shield.obj''
* helpers to ''Ship-Mounts.obj
''
... the steps to convert your model are:
* In UnitConverter, under "Model" add all three obj files to workspace.
* Then select the main Ship model in the drop down.
* Under "Textures" you add the ones you have provided.
* Press "Save and Convert"
* Press "Convert Textures"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

This will call vegastrike and the modelview.mission with your new unit enabled.

==Converting Hud Image==
Under "HUDImage":
* Open the "''Ship-hud.png''" image using the "..." button
* Press "Convert Image"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

==Using Uncompressed Images==
* Under "Config" check the "Bypass compression" option.
* Under "Textures" press "Save and Convert"
* Press "Copy Data"
* Under "View" press "View"

==Adding Thruster, Docks, Mounts==
* Under "Model" press "Add Model"
* Select the "''Ship-Mounts.obj''" file with your mount markers.
* Under "Unit" and "Unit2" review the stats
* Under "Unit" press "Save"
* Under "View" press "View"

==Editing Stats==
* Under "Unit", in "Unit name" write the units.csv key (e.g. ''Llama.begin'')
* Press "Load"
* Edit fields under "Unit" and "Unit2"
* Under "Unit" press "Save"

==Comparing Units==
* Under '''Unit''' tab, in '''Unit name''' write the units.csv key (e.g. ''Llama.begin'')
* Press '''Load'''
* Use '''<''' and '''>''' to browse backward and forward.
* After editing a parameter make sure to press '''Save'''

==Getting Help==
In case of problems, please report to the [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=20&t=11885 Unit Converter thread].

=UnitConverter Tool=

==Installation and Starting==

You can download the latest version of UnitConverter from the Vega Strike svn repository:
* View repo [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/modtools/UnitConverter/ trunk/modtools/UnitConverter].
* Download with
<code><pre>svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/modtools/UnitConverter</pre></code>

To install, copy all files to a directory of your choice.

To run UnitConverter, open command line/shell, change to the installation directory, and depending your operating system type (without the ">" which denotes the command line prompt:

Windows: <code><pre>> uc</pre></code>

Linux: <code><pre>> ./uc</pre></code>

Other: <code><pre>> python unitconverter.py</pre></code>

First thing you'll need to do is to configure the paths for Vega Strike data directory, mesher and nvcompress.

{{warning_text |
| text='''Important:''' To be fully able utilize UnitConverter functionality, please configure the paths under [[Development:Tools:UnitConverter#Configuration_2|'''Config''']].}}

==Models Workspace==
Models Workspace Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f1_workspace.jpg

The following operations are available:
* '''Clear Workspace''' - to start a new model integration
* '''Add Model''' - to add a new model to workspace. The following files are accepted:
** ''.obj'' file containing the model mesh
** ''?-Shield.obj'' file containing the shield mesh
** ''?-Marker.obj'' file containing the marker objects as described in the [[Development:Model_Guidelines#Object_Marker|objects marker modeling section]]
** ''.bfxm'' files to backward convert meshes to obj files
* '''Clear Model''' - to remove the selected model from the workspace
* '''Load Workspace''' - to load an ''.ini'' configuration file of the workspace
* '''Active Model''' - change active model on the dropdown to edit its textures

It is important that your first model in workspace should be the main model, as further information like directory name and units.csv entry name will be derived from the main model name.

Under '''Model/Files''' the ''.obj'' and ''.mtl'' files for the active model will be displayed.
Under '''Material Info''' you can find information on the ''.obj'' file's material library and material names.

To edit texture assignments, proceed to the '''Textures''' tab on the left.

==Textures==
Textures Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f2_textures.jpg

In this tab you can assign textures to model submeshes:
* Under '''Submodels''' select the submesh you'd like to assign textures to. By default the first submesh is selected when the model is activated.
* Add the available '''Textures 0-5''' by pressing the '''...''' buttons between the '''Input Texture''' and '''Output Texture''' columns and browse to the appropriate file. The output texture name will be set (naming convention: '''tex_'''''model'''''_'''''submodel'''''_'''''texture'''''.texture''')
* Select the appropriate '''Technique''', i.e. leave it empty for conventional shading approach or choose e.g. ''cinemut_opaque'' if your input textures are provided with CineMut shader family compatible packing.
* Select '''Blend mode'''.
** For main meshes leave it at ''ONE ZERO''
** For shield mesh and blink light submeshes choose ''ONE ONE''

Once you have assigned textures to all your submeshes, you can now start the conversion:
* Press '''Save and Convert''' to save the texture assignment information and convert your model to Vega Strike compatible ''bfxm'' format.
* You may '''Compress Textures''' using nvcompress if you have configured the command path previously
* Finally, '''Copy Data'' will copy textures and ''bfxm'' files to the unit directory

To add the HUD image, proceed to the '''HUDImage''' tab on the left.

===Advanced Usage - Converting faction textures===

Faction textures must follow the naming of the default textures with prefixed faction name.
When your default diffuse texture is ''dif.png'' and ''tex_000.texture'', the faction input and output textures for the Uln faction will be ''uln_dif.png'' and ''uln_tex_000.texture'' and so on for all the other textures and factions.

Unit converter can assist you with DDS conversion of the input textures provided the naming convention is followed. To convert a faction texture:
* Select the '''Faction''' from the drop down, then
* '''Compress Textures''', and when done
* '''Copy Data''' to put the faction textures into the unit data directory

==HUD Image==
HUD Image Screen

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f3_hud.jpg

Adding a HUD image to the data is fairly easy, simply:
* Browse for the image using the '''...''' button. The appropriate entry will also be created in the '''Unit''' editor.
* '''Compress Image''' to make it DDS, and
* '''Copy Data''' to the unit data directory. This button evokes the same command as the one on the '''Textures''' tab. This means, the ''image'', ''sprite'', ''bfxm'', and ''texture'' files will be copied together.

To edit the unit properties and parameters, proceed to the '''Unit''' tab on the left.

==Unit Editor==

The Unit Editor provides facilities for editing your most important parameters of the unit:
* '''Load''' - loads the unit parameters
* '''Save''' - saves the edited parameters
* '''Reset''' - reloads unit parameters for active model without previously saving changes

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f4_unit.jpg

The most critical parameters for successful integration of the unit are:
* '''Unit description''' - the text that will be displayed in-game about the unit
* '''Unit type''' and '''Unit role''' - used in-game and to correctly view vessels and installations as such
* Under '''Unit dimensions''' you will find the
** '''Dimensions''' as derived from the ''obj'' mesh file.
** To bring the model up to the expected scale, you'll need to set the '''Scale''' parameter. The final size of the model in-game will be the multiplication result of dimensions and the scale.

The remaining entries will be created from your marker object:
* '''Engine Thruster''' will be derived from markers named ''engine_*''. You may '''Update''' the '''Thruster type''' to a different than the default one (''supernova.bmp.bfxm'').
* '''Turrets & Subunits''' will be derived from markers named ''turret_*'' or ''subunit_*''. You may browse the '''Subunit nr.''' (number) by using the '''<''' and '''>''' buttons and change the turret type from the '''Subunit type''' dropdown and confirmation by '''Update'''.
* '''Docking Ports''' will be derived from markers named ''dock_*''

To continue editing unit parameters, proceed to the '''Unit 2''' tab on the left.

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f5_unit2.jpg

To add upgrades, under '''Upgrades''' select the '''Upgrade class''' and '''Upgrade type''' and then '''Add Upgrade'' to the unit.
To delete an upgrade, simply remove the entries between (and including) the {} brackets.

All other parameters on this tab and the following '''Unit 3''' tab can be manually edited

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f6_unit3.jpg

Don't forget to actually '''Save''' your changes before proceeding to '''View''' the unit in-game.

===Advanced Usage - Independent Unit Editor===
You can use built-in Unit editor of the '''Unit Converter''' to edit units without having to load the mesh files. To do so:
* On the '''Model''' tab do '''Clear Workspace'''
* On the '''Unit''' tab, manually write the unit key under '''Unit name'''
* '''Load''' the unit parameters

You can also browse the units.csv file by using the '''<''' and '''>''' buttons on the sides of the '''Unit name''' to row-wise move back and fore between the entries. Browse, '''Load'''/'''Save''' buttons are also available on '''Unit 2''' and '''Unit 3''' tabs.

==View==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f7_view.jpg

By pressing '''View''' Vega Strike can be loaded and you can test your unit in-game.

To test faction textures (if provided) you may previously select the '''Faction''' from the drop down, otherwise leave it at ''privateer'' to use default textures.

Testing of units will happen in two different ways:
* For vessels, using a special mission, the ''modelview.mission'' that spawns the unit as a ship.
** Use the '''F6''' key to view your own unit.
** Use the '''T''' key to target a second unit of the same type and then press the '''D''' key to stop it from SPECing away, then turn around to it to verify the docking ports. Repeat pressing '''D''' every 10 seconds to prevent it from flying away suddenly.
* Use the '''N''' key to target the nearest station, fly to it and start shooting while switching to '''F6''' view to test your shield mesh.
* For installations, the ''Modelview.system'' will be equipped with the edited station.
** Use the '''N''' key to target the station, then '''D''' to see the docking ports.

==Configuration==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f8_config.jpg

The '''Config''' tab defines presets to supports some of the functionality of the '''Unit Converter''':
* '''Vega Strike directory''' - is the directory where ''Version.txt'' and all data subdirectories reside (''ai'', ''animations'', ...)
** Use the '''Browse''' button to locate it
* '''Path to mesher''':
** Click the '''Browse''' button on the right to locate ''mesher''
** Find the ''mesher(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix.
* '''Path to nvcompress''':
** Click the '''Browse''' button on the right to locate ''nvcompress''
** Find the ''nvcompress(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** You will not require to install ''nvcompress'' if you just want to test your models. In this case please make sure you enable the '''Bypass compression''' option further below.
** Techno-talk: The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix. (If nvcompress is in your search path, you may only provide the command.)

===Advanced Configuration===

You may also change defaults that will be used anytime you reopen the Unit Converter:
* '''Current Technique''' - set the default technique you will be working with so that you don't need to remember adjusting it when editing textures.
* '''Use unit class directory''' - used to calculate target for copying model and texture files.
** when checked will store vessels in ''data/units/vessels/unitname'' directory and installations in ''data/units/installations/unitname'' directory. This is the default behavior for Vega Strike Upon The Coldest Sea game.
** If your mod is using a flat directory structure, you can uncheck the option and all your units will be stored in ''data/units/unitname'' directory.
* '''Bypass compression''' - when checked the input texture will be used as output texture. This is useful when editing and testing textures without the need to reconvert the model to bfxm.
* '''Backup obj/mtl files''' - when checked will copy original ''obj'' and ''mtl'' files to ''obj~'' and ''mtl~'' before writing new information.
* '''Create xmesh file''' - though the xmesh format is obsolete, when converting from ''obj'' to ''bfxm'', it might be useful to also create ''xmesh'' files to test the conversion process.
* Under '''Admin''' you can '''Standard Sort units.csv''' file. Though it is standard sorted by default, you might want to make sure it is after a manual editing of the file.

==About==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f9_about.jpg

What's that about?

=Code Reference=

==Python Modules==

Admittedly, the structure of the program could be more modular.

Unit Converter is written in Python using only ''Tkinter'' UI building functionality. On Windows Tkinter is distributed with Python, on Linux, it's available for download in all repositories. No further additional modules are required to run Unit Converter.

Source modules for Unit Converter:
* ''unitconverter.py'' - main module containing the complete program
* ''appwindow.py'' - frame creator for the different tabs
* ''objparse.py'' - ''.obj'' and ''.mtl'' file reader, parser, and writer
* ''vsunitcsv.py'' - ''units.csv'' file reader, parser, and writer
* ''vsmission.py'' - ''.mission'' file reader, parser, and writer
* ''vssystem.py'' - ''.system'' file reader, parser, and writer
* ''vector.py'' - mathematical vector functions
* ''png.py'' - ''.png'' file format reader

Other files:
* ''unitconverter.ini'' - Unit Converter configuration file. Not distributed. Will be created upon first start.
* ''unitconverter.ico'' - Windows icon file.
* ''uc'' - Linux shell script for starting Unit Converter
* ''uc.bat'' - Windows batch file (shell script) for starting Unit Converter
* ''uc_releasenotes.txt'' - Unit Converter release notes
* ''UnitWorkingDir/UnitName.ini'' - Unit workspace configuration file

==Program Flow==

The GUI building section starts with:
<code><pre> def __init__(self, master):</pre></code>

The code is visually separated into:
* variable initialization
* GUI building sections
* program execution, start-up, and shutdown

The GUI building section for each tab contains elements that have event triggers which call other functions within the first part of the ''unitconverter.py'' code.

Further, there a unique watch function that supervises the change of some of the contents of GUI element variables for elements that, in Tkinter, do not come with an event handler (option drop downs, text variables, option check boxes):
<code><pre> def processEvents(self):</pre></code>

==Data Elements==

There is a lot of data being handled within the Unit Converter. The main data elements shall be explained here:
* ''workspace[modelnr][submodelnr][parameternr]'' - array containing the complete workspace information, where
** modelnr is the index from ''models[modelnr]'' which stores the model names in workspace
** submodelnr comes from the list ''submodelsListBox''
** ''PARAMS'' - array holding the parameter names for ''workspace''
* ''textures[submodelnr][counter]'' - holds the textures for the active model only prepared for the mtl export in the array form ''["map_0","tex_000.texture"]''
* ''unit*'' - variables holding the unit editor values
* ''textureN'' - with N = 0-5, holds the output texture screen name
* ''texmasterN'' - holds the input texture name
* ''activemodel'' - name of the active (selected) model in workspace
* ''unitname'' - name of the key from units.csv
* ''vegastrike'' - Vega Strike installation directory root
* ''workdir'' - working directory

Most of the variables are commented within the code.

Development:Tools:UnitConverter

2011-04-05T22:27:19Z

Pyramid: /* Quick Start Guide */

=Introduction=

Raising from the stone age of workflows, in which every task, from texture conversion to editing of unit stats, had to be accomplished manually and only by quite knowledgeable magistrates who knew the alchemy of units.csv columns, xmesh files, and had a magic with meshers. Now, UnitConverter shines upon us, still in the distance, but unmovable like a beacon on solid rock, to be the church of the artists, to accommodate the apostles of Blender, CineMut, and LaGrande, to bring the holy spirit of salvation to this compassionate universe of ours.

Some of the main Unit Converter features:
* bi-directionally converts meshes between obj and bfxm files
* assign textures to (sub)models
* convert model and shield meshes
* compress default and faction input textures to dds output textures
* saves the complete workspace in portable config files
* change model techniques and blend mode
* checks and corrects invalid obj files, recreates mtl files
* creates a model directory if none exists and copies all required files
* compresses hud image and creates a .sprite file
* units.csv entry editor and creator (with default unit stats for new units)
* displays model using VS
* reads mesh dimensions from obj file
* placement of thrusters, turrets, mounts, docks, and blink lights from marker obj file
* on-screen instructions for each workflow module
* production tested

==Important Note==
{{warning_text |
|text=Due to the way ''mesher'' handles command line options (separates different inputs by spaces), it will not allow to use folders or file names with spaces (as common on Windows).
Should you be getting runtime errors during the conversion, you should rename your folder to something like "UnitName" or "Unit_Name_working_folder", i.e. substitute spaces with underscores "_". Do the same for the input files, i.e. "Unit_Name.obj".}}

=Requirements=

In order to run UnitConverter on your system is to have Python 2.5 or 2.6 installed on your system. Python 3.x has different syntax and UnitConveter will not work as long as it hasn't been ported to Python 3. Tkinter library is required to run UnitConverter, however it comes installed with most python distributions. Some Linux distributions require a separate installation of Tkinter.

A requirement for the '''model obj files''' is that no mtl file is provided. UnitConverter will generate its own texture information based on the input given under the '''Model''' panel.
The best way for exporting files from blender is to use the following three options *only*: '''Edges''', '''UVs''', '''Objects'''. You may also enable Normals, and Groups. However the '''Materials''' export option should be explicitly disabled.

Especially when reworking existing units, it is recommended that the model '''obj''' file is named the same way as the unit in ''units.csv'', in particular what concerns the letter case, usually following the CamelCase convention.

You will further require master textures for the object, which must be on the '''png''' file format and [[Development:Graphics_Requirements#Image_dimensions|Power-Of-Two]].
Master textures for factions should have the faction name prefixed to the texture name, e.g. "confed_hull.png".

Optionally, an '''obj''' file with markers can be supplied and must contain the name "marker" in the file name.

Optionally, a shield '''obj''' file can be supplied, containing the name "shield" in the file name.

=Quick Start Guide=

==Configuration==
You must first configure the paths under Config including the application in the path:
* ''path\data'' (to edit unit stats and view model in Vega Strike)
* ''path\mesher.exe'' (to convert model to bfxm) - [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/win32/bin/ get mesher]
* ''path\nvcompress'' (to compress textures) - [[Links:Graphic_Applications#nVidia_Texture_Tools|see here for instructions on nvcompress]]
(There is no need to set the working dir, as this field is purely informational)

==Integrating Models==
Assuming you have exported:
* ship mesh to ''Ship.obj''
* shield to ''Ship-Shield.obj''
* helpers to ''Ship-Mounts.obj
''
... the steps to convert your model are:
* In UnitConverter, under "Model" add all three obj files to workspace.
* Then select the main Ship model in the drop down.
* Under "Textures" you add the ones you have provided.
* Press "Save and Convert"
* Press "Convert Textures"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

This will call vegastrike and the modelview.mission with your new unit enabled.

==Converting Hud Image==
Under "HUDImage":
* Open the "''Ship-hud.png''" image using the "..." button
* Press "Convert Image"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

==Using Uncompressed Images==
* Under "Config" check the "Bypass compression" option.
* Under "Textures" press "Save and Convert"
* Press "Copy Data"
* Under "View" press "View"

==Adding Thruster, Docks, Mounts==
* Under "Model" press "Add Model"
* Select the "''Ship-Mounts.obj''" file with your mount markers.
* Under "Unit" and "Unit2" review the stats
* Under "Unit" press "Save"
* Under "View" press "View"

==Editing Stats==
* Under "Unit", in "Unit name" write the units.csv key (e.g. ''Llama.begin'')
* Press "Load"
* Edit fields under "Unit" and "Unit2"
* Under "Unit" press "Save"

==Comparing Units==
* Under '''Unit''' tab, in '''Unit name''' write the units.csv key (e.g. ''Llama.begin'')
* Press '''Load'''
* Use '''<''' and '''>''' to browse backward and forward.
* After editing a parameter make sure to press '''Save'''

==Getting Help==
In case of problems, please report to the [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=20&t=11885 Unit Converter thread].

=UnitConverter Tool=

==Requirements==

The only requirement to run UnitConverter on your system is to have Python 2.5 or 2.6 installed on your system. Python 3.x has different syntax and will not work. No additional libraries are required.

A requirement for the '''model obj files''' is that no mtl file is provided. UnitConverter will generate its own texture information based on the input given under model.
The best way for exporting files from blender is to use the following three options *only*: '''Edges''', '''UVs''', '''Objects'''. You may also enable Normals, and Groups. However the '''Materials''' export option should be explicitly disabled.

==Installation and Starting==

You can download the latest version of UnitConverter from the Vega Strike svn repository:
* View repo [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/modtools/UnitConverter/ trunk/modtools/UnitConverter].
* Download with
<code><pre>svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/modtools/UnitConverter</pre></code>

To install, copy all files to a directory of your choice.

To run UnitConverter, open command line/shell, change to the installation directory, and depending your operating system type (without the ">" which denotes the command line prompt:

Windows: <code><pre>> uc</pre></code>

Linux: <code><pre>> ./uc</pre></code>

Other: <code><pre>> python unitconverter.py</pre></code>

First thing you'll need to do is to configure the paths for Vega Strike data directory, mesher and nvcompress.

{{warning_text |
| text='''Important:''' To be fully able utilize UnitConverter functionality, please configure the paths under [[Development:Tools:UnitConverter#Configuration_2|'''Config''']].}}

==Models Workspace==
Models Workspace Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f1_workspace.jpg

The following operations are available:
* '''Clear Workspace''' - to start a new model integration
* '''Add Model''' - to add a new model to workspace. The following files are accepted:
** ''.obj'' file containing the model mesh
** ''?-Shield.obj'' file containing the shield mesh
** ''?-Marker.obj'' file containing the marker objects as described in the [[Development:Model_Guidelines#Object_Marker|objects marker modeling section]]
** ''.bfxm'' files to backward convert meshes to obj files
* '''Clear Model''' - to remove the selected model from the workspace
* '''Load Workspace''' - to load an ''.ini'' configuration file of the workspace
* '''Active Model''' - change active model on the dropdown to edit its textures

It is important that your first model in workspace should be the main model, as further information like directory name and units.csv entry name will be derived from the main model name.

Under '''Model/Files''' the ''.obj'' and ''.mtl'' files for the active model will be displayed.
Under '''Material Info''' you can find information on the ''.obj'' file's material library and material names.

To edit texture assignments, proceed to the '''Textures''' tab on the left.

==Textures==
Textures Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f2_textures.jpg

In this tab you can assign textures to model submeshes:
* Under '''Submodels''' select the submesh you'd like to assign textures to. By default the first submesh is selected when the model is activated.
* Add the available '''Textures 0-5''' by pressing the '''...''' buttons between the '''Input Texture''' and '''Output Texture''' columns and browse to the appropriate file. The output texture name will be set (naming convention: '''tex_'''''model'''''_'''''submodel'''''_'''''texture'''''.texture''')
* Select the appropriate '''Technique''', i.e. leave it empty for conventional shading approach or choose e.g. ''cinemut_opaque'' if your input textures are provided with CineMut shader family compatible packing.
* Select '''Blend mode'''.
** For main meshes leave it at ''ONE ZERO''
** For shield mesh and blink light submeshes choose ''ONE ONE''

Once you have assigned textures to all your submeshes, you can now start the conversion:
* Press '''Save and Convert''' to save the texture assignment information and convert your model to Vega Strike compatible ''bfxm'' format.
* You may '''Compress Textures''' using nvcompress if you have configured the command path previously
* Finally, '''Copy Data'' will copy textures and ''bfxm'' files to the unit directory

To add the HUD image, proceed to the '''HUDImage''' tab on the left.

===Advanced Usage - Converting faction textures===

Faction textures must follow the naming of the default textures with prefixed faction name.
When your default diffuse texture is ''dif.png'' and ''tex_000.texture'', the faction input and output textures for the Uln faction will be ''uln_dif.png'' and ''uln_tex_000.texture'' and so on for all the other textures and factions.

Unit converter can assist you with DDS conversion of the input textures provided the naming convention is followed. To convert a faction texture:
* Select the '''Faction''' from the drop down, then
* '''Compress Textures''', and when done
* '''Copy Data''' to put the faction textures into the unit data directory

==HUD Image==
HUD Image Screen

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f3_hud.jpg

Adding a HUD image to the data is fairly easy, simply:
* Browse for the image using the '''...''' button. The appropriate entry will also be created in the '''Unit''' editor.
* '''Compress Image''' to make it DDS, and
* '''Copy Data''' to the unit data directory. This button evokes the same command as the one on the '''Textures''' tab. This means, the ''image'', ''sprite'', ''bfxm'', and ''texture'' files will be copied together.

To edit the unit properties and parameters, proceed to the '''Unit''' tab on the left.

==Unit Editor==

The Unit Editor provides facilities for editing your most important parameters of the unit:
* '''Load''' - loads the unit parameters
* '''Save''' - saves the edited parameters
* '''Reset''' - reloads unit parameters for active model without previously saving changes

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f4_unit.jpg

The most critical parameters for successful integration of the unit are:
* '''Unit description''' - the text that will be displayed in-game about the unit
* '''Unit type''' and '''Unit role''' - used in-game and to correctly view vessels and installations as such
* Under '''Unit dimensions''' you will find the
** '''Dimensions''' as derived from the ''obj'' mesh file.
** To bring the model up to the expected scale, you'll need to set the '''Scale''' parameter. The final size of the model in-game will be the multiplication result of dimensions and the scale.

The remaining entries will be created from your marker object:
* '''Engine Thruster''' will be derived from markers named ''engine_*''. You may '''Update''' the '''Thruster type''' to a different than the default one (''supernova.bmp.bfxm'').
* '''Turrets & Subunits''' will be derived from markers named ''turret_*'' or ''subunit_*''. You may browse the '''Subunit nr.''' (number) by using the '''<''' and '''>''' buttons and change the turret type from the '''Subunit type''' dropdown and confirmation by '''Update'''.
* '''Docking Ports''' will be derived from markers named ''dock_*''

To continue editing unit parameters, proceed to the '''Unit 2''' tab on the left.

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f5_unit2.jpg

To add upgrades, under '''Upgrades''' select the '''Upgrade class''' and '''Upgrade type''' and then '''Add Upgrade'' to the unit.
To delete an upgrade, simply remove the entries between (and including) the {} brackets.

All other parameters on this tab and the following '''Unit 3''' tab can be manually edited

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f6_unit3.jpg

Don't forget to actually '''Save''' your changes before proceeding to '''View''' the unit in-game.

===Advanced Usage - Independent Unit Editor===
You can use built-in Unit editor of the '''Unit Converter''' to edit units without having to load the mesh files. To do so:
* On the '''Model''' tab do '''Clear Workspace'''
* On the '''Unit''' tab, manually write the unit key under '''Unit name'''
* '''Load''' the unit parameters

You can also browse the units.csv file by using the '''<''' and '''>''' buttons on the sides of the '''Unit name''' to row-wise move back and fore between the entries. Browse, '''Load'''/'''Save''' buttons are also available on '''Unit 2''' and '''Unit 3''' tabs.

==View==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f7_view.jpg

By pressing '''View''' Vega Strike can be loaded and you can test your unit in-game.

To test faction textures (if provided) you may previously select the '''Faction''' from the drop down, otherwise leave it at ''privateer'' to use default textures.

Testing of units will happen in two different ways:
* For vessels, using a special mission, the ''modelview.mission'' that spawns the unit as a ship.
** Use the '''F6''' key to view your own unit.
** Use the '''T''' key to target a second unit of the same type and then press the '''D''' key to stop it from SPECing away, then turn around to it to verify the docking ports. Repeat pressing '''D''' every 10 seconds to prevent it from flying away suddenly.
* Use the '''N''' key to target the nearest station, fly to it and start shooting while switching to '''F6''' view to test your shield mesh.
* For installations, the ''Modelview.system'' will be equipped with the edited station.
** Use the '''N''' key to target the station, then '''D''' to see the docking ports.

==Configuration==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f8_config.jpg

The '''Config''' tab defines presets to supports some of the functionality of the '''Unit Converter''':
* '''Vega Strike directory''' - is the directory where ''Version.txt'' and all data subdirectories reside (''ai'', ''animations'', ...)
** Use the '''Browse''' button to locate it
* '''Path to mesher''':
** Click the '''Browse''' button on the right to locate ''mesher''
** Find the ''mesher(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix.
* '''Path to nvcompress''':
** Click the '''Browse''' button on the right to locate ''nvcompress''
** Find the ''nvcompress(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** You will not require to install ''nvcompress'' if you just want to test your models. In this case please make sure you enable the '''Bypass compression''' option further below.
** Techno-talk: The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix. (If nvcompress is in your search path, you may only provide the command.)

===Advanced Configuration===

You may also change defaults that will be used anytime you reopen the Unit Converter:
* '''Current Technique''' - set the default technique you will be working with so that you don't need to remember adjusting it when editing textures.
* '''Use unit class directory''' - used to calculate target for copying model and texture files.
** when checked will store vessels in ''data/units/vessels/unitname'' directory and installations in ''data/units/installations/unitname'' directory. This is the default behavior for Vega Strike Upon The Coldest Sea game.
** If your mod is using a flat directory structure, you can uncheck the option and all your units will be stored in ''data/units/unitname'' directory.
* '''Bypass compression''' - when checked the input texture will be used as output texture. This is useful when editing and testing textures without the need to reconvert the model to bfxm.
* '''Backup obj/mtl files''' - when checked will copy original ''obj'' and ''mtl'' files to ''obj~'' and ''mtl~'' before writing new information.
* '''Create xmesh file''' - though the xmesh format is obsolete, when converting from ''obj'' to ''bfxm'', it might be useful to also create ''xmesh'' files to test the conversion process.
* Under '''Admin''' you can '''Standard Sort units.csv''' file. Though it is standard sorted by default, you might want to make sure it is after a manual editing of the file.

==About==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f9_about.jpg

What's that about?

=Code Reference=

==Python Modules==

Admittedly, the structure of the program could be more modular.

Unit Converter is written in Python using only ''Tkinter'' UI building functionality. On Windows Tkinter is distributed with Python, on Linux, it's available for download in all repositories. No further additional modules are required to run Unit Converter.

Source modules for Unit Converter:
* ''unitconverter.py'' - main module containing the complete program
* ''appwindow.py'' - frame creator for the different tabs
* ''objparse.py'' - ''.obj'' and ''.mtl'' file reader, parser, and writer
* ''vsunitcsv.py'' - ''units.csv'' file reader, parser, and writer
* ''vsmission.py'' - ''.mission'' file reader, parser, and writer
* ''vssystem.py'' - ''.system'' file reader, parser, and writer
* ''vector.py'' - mathematical vector functions
* ''png.py'' - ''.png'' file format reader

Other files:
* ''unitconverter.ini'' - Unit Converter configuration file. Not distributed. Will be created upon first start.
* ''unitconverter.ico'' - Windows icon file.
* ''uc'' - Linux shell script for starting Unit Converter
* ''uc.bat'' - Windows batch file (shell script) for starting Unit Converter
* ''uc_releasenotes.txt'' - Unit Converter release notes
* ''UnitWorkingDir/UnitName.ini'' - Unit workspace configuration file

==Program Flow==

The GUI building section starts with:
<code><pre> def __init__(self, master):</pre></code>

The code is visually separated into:
* variable initialization
* GUI building sections
* program execution, start-up, and shutdown

The GUI building section for each tab contains elements that have event triggers which call other functions within the first part of the ''unitconverter.py'' code.

Further, there a unique watch function that supervises the change of some of the contents of GUI element variables for elements that, in Tkinter, do not come with an event handler (option drop downs, text variables, option check boxes):
<code><pre> def processEvents(self):</pre></code>

==Data Elements==

There is a lot of data being handled within the Unit Converter. The main data elements shall be explained here:
* ''workspace[modelnr][submodelnr][parameternr]'' - array containing the complete workspace information, where
** modelnr is the index from ''models[modelnr]'' which stores the model names in workspace
** submodelnr comes from the list ''submodelsListBox''
** ''PARAMS'' - array holding the parameter names for ''workspace''
* ''textures[submodelnr][counter]'' - holds the textures for the active model only prepared for the mtl export in the array form ''["map_0","tex_000.texture"]''
* ''unit*'' - variables holding the unit editor values
* ''textureN'' - with N = 0-5, holds the output texture screen name
* ''texmasterN'' - holds the input texture name
* ''activemodel'' - name of the active (selected) model in workspace
* ''unitname'' - name of the key from units.csv
* ''vegastrike'' - Vega Strike installation directory root
* ''workdir'' - working directory

Most of the variables are commented within the code.

Development:Model Guidelines

2011-04-05T21:34:13Z

Pyramid: /* Object Marker */

{{parent_link|parent=[[Development]]}}
= Introduction =

The intention of this document is to give artists using the Vega Strike engine some suggested guidelines to follow in creating models. You may also wish to have a look at the corresponding [[Development:Texture_Guidelines|texturing guidelines]].

So you want to create a new ship for Vega Strike, do you? While virtually all models are welcome, well before you start cranking out wonderfully designed models we request that you first check what models are still required.

{{warning_text |
| text='''Note:''' If you wish to contribute a new or updated model (ship, installation, turret, cockpit, ..) to the game Vega Strike, please see the [[Development:3D_Models|'''3D Models''']] page for models requiring attention.}}

Alternatively, contact [[User:jackS|jackS]] or [[User:pyramid|pyramid]].

= Modeling Pipeline Overview =

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98ffb2" |
|'''Step
|'''Input
|'''Output
|'''Tools
|'''Requirements
|'''Tutorials
|-

| Model Selection
| -
| required model
| model task list
| -
| -
|-

| Conceptualization
| selected model
| model concept
| pen & paper, artwork forum
| artstyle guide
| -
|-

| Modeling
| concept
| model mesh, obj + mtl files
| blender, forum
| many
| -
|-

| Texturing
| model mesh
| textures
| gimp, forum
| texture requirements
| -
|-

| Integration
| model + textures
| bfxm + dds textures
| mesher + UnitConverter
| -
| -
|-

| Testing
| bfxm model + dds textures
| bfxm + dds textures
| vegastrike + modelview.mission
| pass or rework
| -
|-

| Submission
| blender file (obj + mtl), master textures, bfxm + dds textures
| archive or svn
| mail, svn client
| -
| -
|}

=Model Requirements=

==Requirements Checklist==

Considerations for a successful model submission:
* Model is in the requirements list [[Development:3D_Models|->]]
* Abides to faction visual guidelines
* Has approved concept
* Provides model source file (blender, Wings3D, ...)
* Provides OBJ file
* Has model mesh, shield mesh, LoD meshes, helper meshes
* Provides uncompressed textures in png format (and optionally faction textures)
* Provides texture source files (GIMP, ...)
* Provides HUD png image with correct orientation
* Provides units.csv file entry

==Model Requirements Details==

==Visual Guidelines==

For particular aesthetic guidelines, please see the [[Artstyle guides]] page. Please note that many of the existing models are used because of expedience, not because they fit well with VS canon (i.e. if you make something new look like what's there, it still might not be what we're looking for). If in doubt, please ask on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

To absolutely sure, for new models, please create a drawing of your proposed concept and let it be discussed and approved on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

See also [[Development:Texture Guidelines]]

==Model File Format==
The preferred format for submission (for public disbursement - whatever native format is used inside your favorite modeling suite is fortunately a non-issue) is currently Wavefront OBJ file format, as this is the most easily converted between manipulation (assorted modeling tools) and presentation (currently BFXM, later to be the OGRE .mesh format). Model "source" therefore, is, at present (Sep. 2008), most usefully uploaded as .OBJ.

Until such a time as a visual model editing tool is completed, conversion to a game-ready format will likely pass through the .xmesh format for insertion of LOD references into top level mesh(es), correction of coordinate "handedness" (if the ordering of the coordinate axes is incompatible, as appears to happen with the output of some modeling tools).

See [[HowTo:Add_Ships]] for information on using mesher to convert to a presentation format (such as BFXM). Note that an old utility, objconv, is '''not''' mesher, and should not be used for this task. Source files for the mesher utility are included along with VS source. Windows users may download updated mesher binaries from their SVN interface of choice (the binary will be in the \bin directory).

==Polygon/Vertex Count==
In broadest terms, the desired polygon count for a particular model is dependent on three major factors:
*The amount of screen real-estate that the model is likely to be viewed at the majority of time that a user will be seeing it (i.e. a 2 meter long rocket doesn't deserve the same order of magnitude of attention to detail as a large base or vessel unless the rocket is expected to be mounted in front of a camera. Likewise, even at the same level of attention in terms of polygons per square meter, it would have far fewer total polygons.)
*The intrinsic surface complexity of the model. If one is modeling a box for freight cargo, one is not going to need as many polygons as if one needed to model one of the Vega Strike developers (not that we're necessarily model material ;-)). If you don't use enough polygons, no amount of texture magic can save a model from being ugly. That said, if you are modeling a cargo freight container and you use thousands of polygons, you're being negligent and wasteful of resources.
*Engine limitations. Engine limitations is a bit of a misnomer, as the performance of the graphical engine is more hardware dependent than anything else, but it's a good heading for lumping any non-artistic hurdles under. This is the most complicated of the three major factors, because it represents a moving target. Suffice it to say that in order to preserve playability on a broad range of systems, there is a premium placed on making a model aesthetically appropriate with the minimum number of polygons.

Rough guideline:
*Fighter: 15k triangles
*Corvette: 30k tris
*Cruiserer: 60k
*Carrier: 120k
*Space station: 250k

However, significant discression, and the possibility for using large numbers of polygons to prettify an object remain with the artist, provided they make appropriate use of [[Terminology:LODs|LODs]]. The primary focus needs to be on making a model aesthetically appropriate, for an intended common viewing distance, and then catering to the needs of the engine by introducing lower LODs (if necessary) and catering to artistic desires by introducing higher LODs (if appropriate). There is also an element of minor future proofing that occurs with providing a robust range of LOD poly counts - namely, multiple versions of the data set can be constructed targeted at different hardware points by shifting up or down along the LOD set (although this currently isn't bothered with, if and when we develop a true source repository for models and textures, this will likely become more common, as postprocessing of submitted art will become tenable).

One more point to consider before attempting to set a polygon goal for a model is what the likely total contribution from all instances on screen of a given model will be - if the model represents something particularly rare, then it is likely that a few more polygons can easily be spared on its model than for more common objects of otherwise similar size, complexity, etc.

Above all, use common sense - if it's visually hideous because it doesn't have enough polygons, it's not your top level model, and if it's in the 5 digit range for polygon count, it's not your lowest level LOD. Take into consideration how much screen real estate, based on the intended in-game size of the model (and if you don't have any idea how big it's supposed to be - you're doing something wrong already) the model will be taking up at various distances, and calibrate detail appropriately (this will become a much easier task once there is a visual modeling tool from the VS side) - to belabor the obvious, the difference between 500 polygons and 5000 gets somewhat obscured when the object is only drawn using 64 pixels. Note therefore that larger objects will often necessitate higher polygon counts merely because there's more of them to see.

(Note that there is no need to continue adding LODs beyond a point of "diminishing artistic returns" - if adding more detail won't help, don't bother. If adding detail helps, but is too expensive to be practical, then it may still be worthwhile for later inclusion as hardware resources increase.)

For small to moderate craft and installations, something along the lines of either of the following is not inappropriate:

(Exponential Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4000
*LOD 3 <= 8000
*LOD 4 <= 16000
*LOD 5 >16000

(Quadratic Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4500
*LOD 3 <= 8000
*LOD 4 <= 12500
*LOD 5 <= 18000
*LOD 6 >18000

Larger models, such as capital vessels and large installations will likely follow a similar curve, but at a higher offset, due to increased size. Truly massive models should be partitioned into multiple meshes, each with its own set of LODs such that nearer portions of the model can be independently represented at higher LOD than more distant ones. Partitioning into multiple meshes may be preferable even for merely "largish" models so as to preserve reasonable correspondence between single pixels and the size of represented features when texturing.

==Textures==

Texture maps should also be made accordingly, although clearly artistic integrity trivially trumps the following rough guideline (if you need more pixels, use them) and the appropriate texture size may depend greatly upon the size of the model.

*LOD 1 128x128
*LOD 2 256x256
*LOD 3 512x512
*LOD 4 1024x1024
*LOD 5 and up having multiple 1024x1024 textures

Be careful with ''texture lodding abuse''. Each LOD that uses its own texture will require more memory (video memory), and breaks batching between instances (slows down rendering of many instances of this model). Even so, texture lodding actually frees up memory most of the time, since only lesser versions are used in the distance. A general rule of thumb is to never have more than two or at most three versions of the same texture. Also take any opportunity to convert textures to greyscale when the color loss is not quite noticeable (most commonly with glow maps and specular maps).

Likewise, for larger models, do not neglect the potential addition of detail textures.

See also [[Development:Texture Guidelines]] and [[Development:Graphics_Requirements]].

===Faction Textures===

To include and successfully test faction textures in your data, you need to:
* set the corresponding vegastrike.config variable (<code>var name="faction_dependant_textures" value="1"</code>).
* prefix default textures with the faction name, e.g. when your default texture is called "tex_000.texture", to enable the faction texture for "pirates" you'll need to add the texture "pirates_tex_000.texture".
* change configuration to one of the 2 highest computer modes (512M+1GB or 1024MB).

==Shield and Collision Meshes==
Separate shield meshes are highly desirable. Shield meshes should also be done using LODs, although shield meshes should remain simple - that is, their top level meshes should not contain odious numbers of polygons for something that is only infrequently displayed.

Collision meshes need not (and cannot) have LODs. For complex models, it is wise to provide a dumbed-down version of the model that reasonably approximates its shape - minor features and greebles can be safely removed, for instance - to improve performance on the physics engine. Polycount should be kept to a minimum, '''without sacrificing any major features''' of the top-level LOD. Very small vessels (or appropriately shaped ones) may opt to not specify a collision mesh, which will make the physics layer treat this mesh as a spherical object (most efficient).

==HUD Image==

Provides perspective view of the model oriented with the nose towards the left-bottom corner of the image.
The master image resolution should start at 256x256 pixels with transparency around the vessel.

==See also==
For an example of an entity that is composed of multiple meshes, uses LODs, and shield meshes, examine the Clydesdale. (Note that shield and collision meshes are specified in the units.csv file, not by the model.)

=Model Creation=

The first (and most enjoyable) job is to design and draw your model (the geometrical object) within your program.

Feel free to use any modeling program, but it must be able to export models in either (Wavefront) .OBJ or (Vega Strike) .xmesh format. If you don't know where to start, see [[Links:3D Applications]] for a list of modeling software. [http://www.wings3d.com/ Wings 3D] is recommended for modeling beginners. [http://www.blender.org/ '''Blender'''] is the tool of choice for VS artistic community.

==Orientation==
First off, do yourself a favor and line your model up correctly before you begin. For the purposes of Vega Strike, Z+ is forwards and Y+ is up. The model's nose should be pointing forward along the Z+ axis (so that the Z+ axis would theoretically be visible from the cockpit). The mesh should also be properly centered.
Summing up:
* Z+ -> Forward direction
* Y+ -> Up direction
* Centered

== Tutorials==

{{warning_text |
| text='''Note:''' The tutorials overview is not complete. Many of the available tutorials have not yet been integrated into this page. Refer also to the [[HowTos|'''How-Tos Tutorials''']] page for additional tutorials.}}

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98b2ee" |
|'''Modeling Step
|'''Blender
|'''Wings3D
|-
| Create mesh
| -
| [[HowTo:Create Ships in Wings3D|Creating a 3D-model]]
|-
| Smoothing
| [[HowTo:Smooth Groups|Smoothing]] [[HowTo:Weld|Smooth Welding]]
| -
|-
| Mesh cleanup
| [[HowTo:Bevel|Beveling]]
| -
|-
| Unwrapping
| [[HowTo:Unwrap_in_Blender|Unwrapping 1]] [[HowTo:Unwrap|Unwrapping 2]] [[HowTo:FullUnwrapBlender|Ship unwrap]]
| -
|-
| Radiosity Baking
| [[HowTo:Radiosity baking in Blender|Radiosity baking]]
| -
|-
| Exporting
| -
| -
|}

This articles are WIP, means still need to be reviewed and decided how to restructure them:
* [[HowTo:Create Cockpit in Wings3d|Creating a 3D cockpit for your ship.]]
* [[HowTo:Add LODs|Adding Levels of Detail]]
* [[HowTo:Add Ships|Adding your ship to Vega Strike]] - An overview of how to create and add ships to the game
* [[HowTo:Create Models]] - Links to forum discussions. Page will become generic model creation tutorial.
* Modeling Tutorials: [[HowTos#Modeling]]

===Blender Basics===
* [[HowTo:Basic Blender Tutorial|A basic Blender3D tutorial]]: [http://www.cdschools.org/54223045235521/blank/browse.asp?A=383&BMDRN=2000&BCOB=0&C=55205 Blender Basics - 3rd Edition] - not specific to ships, though...

===Wings3D Basics===

===Other Software Basics===

* [[HowTo:Model a Ship|Brad Mick's video tutorial on ship modeling]] - using Lightwave, but the concept is general: ''Rapid Prototyping''

=Texture Creation=

==Unwrapping==

Please make non-overlapping UV unwraps for all future models. You can't bake a proper AO with overlapping islands.

==Unsorted==

(general guidelines, tips, best practices, app specific tutorials, ...)

* [http://netzwelt.gaming-hut.de/vegatexturing/ WIP VegaStrike texturing page by Major]
* [http://edice.netfirms.com/tuts/texturetut.htm Texturing tutorial by Duality]

For the time being, you may wish to have a look at the corresponding [[Development:Texture_Guidelines|Texturing Guidelines]].

* [[Development:Texture Guidelines|Guidelines for creating ship materials]]

* [[HowTo:Add Per Pixel Lighting|Adding per-pixel lighting to your 3D model]]
* [[HowTo:IntroToShaders|Introduction to shaders, and what they mean for you]] --Bumpmaps, Normalmaps, Shininess maps ...

* [[HowTo:Texture|Creating your own textures]] - A summary on how to make texture maps
* [[HowTo:Texture in Wings3d|Texturing your model in Wings 3d]]
* [[HowTo:SuperrealisticTexturing|Tips for realistic-looking textures]]
* [[HowTo:Make Animated Textures|Using animated textures on a model]]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/texturing_noodle LaGrande Noodle]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/ao_and_prt_bakes AO and PRT bakes, using Blender and xNormal]

=Integration and Testing=

Using UnitConverter to convert all files and edit the model stats for Vega Strike:
[[Development:Tools:UnitConverter]]

===Object Marker===
In order to automatically create turret mounts, gun mounts, and engine thrusters placements in units.csv, please use the following marker:

http://deeplayer.com/cinemut/gunmountmarker.jpg

The shape is 1 units wide in X, 2 units tall in Y, 4 units long in Z. Four vertices in total. The center between the two vertices on X is the origin; the vertex on Z marks the forward direction; the vertex on Y marks the up direction.
The exported object names are ready and the forward and up directions are calculated from the marker dimensions. Thus, we don't need to worry about mesh rotations; we can deduce mesh rotation from the marker.

[author:chuck_starchaser]
* Here's the marker blend file (you could load and save as the default blender start):
** [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/modtools/UnitConverter/helper/mount_helper.blend?view=log ''modtools/UnitConverter/helper/mount_helper.blend'']
* Starts with a marker smack in the middle.
* You can move it to another layer, later duplicate it as needed to place copies at key locations.
* You can also import the marker into another blend file:
** Open whatever.blend, go to File -> Append Or Link
** Navigate to where UnitConverter/helper/mount_helper.blend is.
* Go to the "Objects" folder, and click on the "Marker" object.
* To duplicate an object, in object mode, select and shift-D.
* To rename your duplicated object, hit F9 and, towards the left, where it says OB:Marker click in the middle of it and then type "gunmount_0_light_medium" or whatever.

http://vegastrike.sourceforge.net/albums/WIPs-and-Concept-Art/mounts_20080911.jpg

The above image shows the markers set as the centers of engine thrusts.

It is advisable to group the marker objects into a group called "marker". You are required to export all the markers into one obj file that needs to contain the name "marker" in it (letter case is unimportant, it can be "marker", or "Marker").

Object Helper naming convention: ''type_subtype_identifier''

with type:
* pilot (currently unused)
* mount (currently unused)
* turret
* subunit
* engine
* dock

and subtype being optional (convention tbd),
and identifier being either a number or a description and optional.

You may define for example:
* pilot
* pilot_john
* mount_lightmedium_0
* turret_capmissile_frontleft
* subunit_1
* engine_retro_left

===Exporting to OBJ+MTL===

===Updating Stats===
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
* [[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]

=Submission and Vetting=

=Technical Reference=

==Technical Specifications==

* [[HowTo:Edit BFXM files|Editing BFXM files (format spec)]]
* [[HowTo:Edit XMESH files|Editing the xmesh file of a ship]]
* [[HowTo:Edit units.csv|Editing units.csv]]
* [[HowTo:Add Engine Glow|Adding an engine glow to your 3D model]]

==Scripts and Tools==

See [[Development:Scripts_%26_Tools|Scripts & Tools]]
* [[HowTo:Add_Ships#New_method|mesher converter obj <-> bfxm <-> xmesh]]
* [[Development:Tools:UnitConverter|UnitConverter]]

=References=

* [http://wcpedia.com/dw/doku.php/wc_info/modding/index WCpedia Modeling Page]

[[Category:Development|Model Guidelines]]
[[Category:Modeling|Model Guidelines]]

Development:Model Guidelines

2011-04-05T20:33:58Z

Pyramid: /* Scripts and Tools */

{{parent_link|parent=[[Development]]}}
= Introduction =

The intention of this document is to give artists using the Vega Strike engine some suggested guidelines to follow in creating models. You may also wish to have a look at the corresponding [[Development:Texture_Guidelines|texturing guidelines]].

So you want to create a new ship for Vega Strike, do you? While virtually all models are welcome, well before you start cranking out wonderfully designed models we request that you first check what models are still required.

{{warning_text |
| text='''Note:''' If you wish to contribute a new or updated model (ship, installation, turret, cockpit, ..) to the game Vega Strike, please see the [[Development:3D_Models|'''3D Models''']] page for models requiring attention.}}

Alternatively, contact [[User:jackS|jackS]] or [[User:pyramid|pyramid]].

= Modeling Pipeline Overview =

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98ffb2" |
|'''Step
|'''Input
|'''Output
|'''Tools
|'''Requirements
|'''Tutorials
|-

| Model Selection
| -
| required model
| model task list
| -
| -
|-

| Conceptualization
| selected model
| model concept
| pen & paper, artwork forum
| artstyle guide
| -
|-

| Modeling
| concept
| model mesh, obj + mtl files
| blender, forum
| many
| -
|-

| Texturing
| model mesh
| textures
| gimp, forum
| texture requirements
| -
|-

| Integration
| model + textures
| bfxm + dds textures
| mesher + UnitConverter
| -
| -
|-

| Testing
| bfxm model + dds textures
| bfxm + dds textures
| vegastrike + modelview.mission
| pass or rework
| -
|-

| Submission
| blender file (obj + mtl), master textures, bfxm + dds textures
| archive or svn
| mail, svn client
| -
| -
|}

=Model Requirements=

==Requirements Checklist==

Considerations for a successful model submission:
* Model is in the requirements list [[Development:3D_Models|->]]
* Abides to faction visual guidelines
* Has approved concept
* Provides model source file (blender, Wings3D, ...)
* Provides OBJ file
* Has model mesh, shield mesh, LoD meshes, helper meshes
* Provides uncompressed textures in png format (and optionally faction textures)
* Provides texture source files (GIMP, ...)
* Provides HUD png image with correct orientation
* Provides units.csv file entry

==Model Requirements Details==

==Visual Guidelines==

For particular aesthetic guidelines, please see the [[Artstyle guides]] page. Please note that many of the existing models are used because of expedience, not because they fit well with VS canon (i.e. if you make something new look like what's there, it still might not be what we're looking for). If in doubt, please ask on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

To absolutely sure, for new models, please create a drawing of your proposed concept and let it be discussed and approved on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

See also [[Development:Texture Guidelines]]

==Model File Format==
The preferred format for submission (for public disbursement - whatever native format is used inside your favorite modeling suite is fortunately a non-issue) is currently Wavefront OBJ file format, as this is the most easily converted between manipulation (assorted modeling tools) and presentation (currently BFXM, later to be the OGRE .mesh format). Model "source" therefore, is, at present (Sep. 2008), most usefully uploaded as .OBJ.

Until such a time as a visual model editing tool is completed, conversion to a game-ready format will likely pass through the .xmesh format for insertion of LOD references into top level mesh(es), correction of coordinate "handedness" (if the ordering of the coordinate axes is incompatible, as appears to happen with the output of some modeling tools).

See [[HowTo:Add_Ships]] for information on using mesher to convert to a presentation format (such as BFXM). Note that an old utility, objconv, is '''not''' mesher, and should not be used for this task. Source files for the mesher utility are included along with VS source. Windows users may download updated mesher binaries from their SVN interface of choice (the binary will be in the \bin directory).

==Polygon/Vertex Count==
In broadest terms, the desired polygon count for a particular model is dependent on three major factors:
*The amount of screen real-estate that the model is likely to be viewed at the majority of time that a user will be seeing it (i.e. a 2 meter long rocket doesn't deserve the same order of magnitude of attention to detail as a large base or vessel unless the rocket is expected to be mounted in front of a camera. Likewise, even at the same level of attention in terms of polygons per square meter, it would have far fewer total polygons.)
*The intrinsic surface complexity of the model. If one is modeling a box for freight cargo, one is not going to need as many polygons as if one needed to model one of the Vega Strike developers (not that we're necessarily model material ;-)). If you don't use enough polygons, no amount of texture magic can save a model from being ugly. That said, if you are modeling a cargo freight container and you use thousands of polygons, you're being negligent and wasteful of resources.
*Engine limitations. Engine limitations is a bit of a misnomer, as the performance of the graphical engine is more hardware dependent than anything else, but it's a good heading for lumping any non-artistic hurdles under. This is the most complicated of the three major factors, because it represents a moving target. Suffice it to say that in order to preserve playability on a broad range of systems, there is a premium placed on making a model aesthetically appropriate with the minimum number of polygons.

Rough guideline:
*Fighter: 15k triangles
*Corvette: 30k tris
*Cruiserer: 60k
*Carrier: 120k
*Space station: 250k

However, significant discression, and the possibility for using large numbers of polygons to prettify an object remain with the artist, provided they make appropriate use of [[Terminology:LODs|LODs]]. The primary focus needs to be on making a model aesthetically appropriate, for an intended common viewing distance, and then catering to the needs of the engine by introducing lower LODs (if necessary) and catering to artistic desires by introducing higher LODs (if appropriate). There is also an element of minor future proofing that occurs with providing a robust range of LOD poly counts - namely, multiple versions of the data set can be constructed targeted at different hardware points by shifting up or down along the LOD set (although this currently isn't bothered with, if and when we develop a true source repository for models and textures, this will likely become more common, as postprocessing of submitted art will become tenable).

One more point to consider before attempting to set a polygon goal for a model is what the likely total contribution from all instances on screen of a given model will be - if the model represents something particularly rare, then it is likely that a few more polygons can easily be spared on its model than for more common objects of otherwise similar size, complexity, etc.

Above all, use common sense - if it's visually hideous because it doesn't have enough polygons, it's not your top level model, and if it's in the 5 digit range for polygon count, it's not your lowest level LOD. Take into consideration how much screen real estate, based on the intended in-game size of the model (and if you don't have any idea how big it's supposed to be - you're doing something wrong already) the model will be taking up at various distances, and calibrate detail appropriately (this will become a much easier task once there is a visual modeling tool from the VS side) - to belabor the obvious, the difference between 500 polygons and 5000 gets somewhat obscured when the object is only drawn using 64 pixels. Note therefore that larger objects will often necessitate higher polygon counts merely because there's more of them to see.

(Note that there is no need to continue adding LODs beyond a point of "diminishing artistic returns" - if adding more detail won't help, don't bother. If adding detail helps, but is too expensive to be practical, then it may still be worthwhile for later inclusion as hardware resources increase.)

For small to moderate craft and installations, something along the lines of either of the following is not inappropriate:

(Exponential Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4000
*LOD 3 <= 8000
*LOD 4 <= 16000
*LOD 5 >16000

(Quadratic Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4500
*LOD 3 <= 8000
*LOD 4 <= 12500
*LOD 5 <= 18000
*LOD 6 >18000

Larger models, such as capital vessels and large installations will likely follow a similar curve, but at a higher offset, due to increased size. Truly massive models should be partitioned into multiple meshes, each with its own set of LODs such that nearer portions of the model can be independently represented at higher LOD than more distant ones. Partitioning into multiple meshes may be preferable even for merely "largish" models so as to preserve reasonable correspondence between single pixels and the size of represented features when texturing.

==Textures==

Texture maps should also be made accordingly, although clearly artistic integrity trivially trumps the following rough guideline (if you need more pixels, use them) and the appropriate texture size may depend greatly upon the size of the model.

*LOD 1 128x128
*LOD 2 256x256
*LOD 3 512x512
*LOD 4 1024x1024
*LOD 5 and up having multiple 1024x1024 textures

Be careful with ''texture lodding abuse''. Each LOD that uses its own texture will require more memory (video memory), and breaks batching between instances (slows down rendering of many instances of this model). Even so, texture lodding actually frees up memory most of the time, since only lesser versions are used in the distance. A general rule of thumb is to never have more than two or at most three versions of the same texture. Also take any opportunity to convert textures to greyscale when the color loss is not quite noticeable (most commonly with glow maps and specular maps).

Likewise, for larger models, do not neglect the potential addition of detail textures.

See also [[Development:Texture Guidelines]] and [[Development:Graphics_Requirements]].

===Faction Textures===

To include and successfully test faction textures in your data, you need to:
* set the corresponding vegastrike.config variable (<code>var name="faction_dependant_textures" value="1"</code>).
* prefix default textures with the faction name, e.g. when your default texture is called "tex_000.texture", to enable the faction texture for "pirates" you'll need to add the texture "pirates_tex_000.texture".
* change configuration to one of the 2 highest computer modes (512M+1GB or 1024MB).

==Shield and Collision Meshes==
Separate shield meshes are highly desirable. Shield meshes should also be done using LODs, although shield meshes should remain simple - that is, their top level meshes should not contain odious numbers of polygons for something that is only infrequently displayed.

Collision meshes need not (and cannot) have LODs. For complex models, it is wise to provide a dumbed-down version of the model that reasonably approximates its shape - minor features and greebles can be safely removed, for instance - to improve performance on the physics engine. Polycount should be kept to a minimum, '''without sacrificing any major features''' of the top-level LOD. Very small vessels (or appropriately shaped ones) may opt to not specify a collision mesh, which will make the physics layer treat this mesh as a spherical object (most efficient).

==HUD Image==

Provides perspective view of the model oriented with the nose towards the left-bottom corner of the image.
The master image resolution should start at 256x256 pixels with transparency around the vessel.

==See also==
For an example of an entity that is composed of multiple meshes, uses LODs, and shield meshes, examine the Clydesdale. (Note that shield and collision meshes are specified in the units.csv file, not by the model.)

=Model Creation=

The first (and most enjoyable) job is to design and draw your model (the geometrical object) within your program.

Feel free to use any modeling program, but it must be able to export models in either (Wavefront) .OBJ or (Vega Strike) .xmesh format. If you don't know where to start, see [[Links:3D Applications]] for a list of modeling software. [http://www.wings3d.com/ Wings 3D] is recommended for modeling beginners. [http://www.blender.org/ '''Blender'''] is the tool of choice for VS artistic community.

==Orientation==
First off, do yourself a favor and line your model up correctly before you begin. For the purposes of Vega Strike, Z+ is forwards and Y+ is up. The model's nose should be pointing forward along the Z+ axis (so that the Z+ axis would theoretically be visible from the cockpit). The mesh should also be properly centered.
Summing up:
* Z+ -> Forward direction
* Y+ -> Up direction
* Centered

== Tutorials==

{{warning_text |
| text='''Note:''' The tutorials overview is not complete. Many of the available tutorials have not yet been integrated into this page. Refer also to the [[HowTos|'''How-Tos Tutorials''']] page for additional tutorials.}}

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98b2ee" |
|'''Modeling Step
|'''Blender
|'''Wings3D
|-
| Create mesh
| -
| [[HowTo:Create Ships in Wings3D|Creating a 3D-model]]
|-
| Smoothing
| [[HowTo:Smooth Groups|Smoothing]] [[HowTo:Weld|Smooth Welding]]
| -
|-
| Mesh cleanup
| [[HowTo:Bevel|Beveling]]
| -
|-
| Unwrapping
| [[HowTo:Unwrap_in_Blender|Unwrapping 1]] [[HowTo:Unwrap|Unwrapping 2]] [[HowTo:FullUnwrapBlender|Ship unwrap]]
| -
|-
| Radiosity Baking
| [[HowTo:Radiosity baking in Blender|Radiosity baking]]
| -
|-
| Exporting
| -
| -
|}

This articles are WIP, means still need to be reviewed and decided how to restructure them:
* [[HowTo:Create Cockpit in Wings3d|Creating a 3D cockpit for your ship.]]
* [[HowTo:Add LODs|Adding Levels of Detail]]
* [[HowTo:Add Ships|Adding your ship to Vega Strike]] - An overview of how to create and add ships to the game
* [[HowTo:Create Models]] - Links to forum discussions. Page will become generic model creation tutorial.
* Modeling Tutorials: [[HowTos#Modeling]]

===Blender Basics===
* [[HowTo:Basic Blender Tutorial|A basic Blender3D tutorial]]: [http://www.cdschools.org/54223045235521/blank/browse.asp?A=383&BMDRN=2000&BCOB=0&C=55205 Blender Basics - 3rd Edition] - not specific to ships, though...

===Wings3D Basics===

===Other Software Basics===

* [[HowTo:Model a Ship|Brad Mick's video tutorial on ship modeling]] - using Lightwave, but the concept is general: ''Rapid Prototyping''

=Texture Creation=

==Unwrapping==

Please make non-overlapping UV unwraps for all future models. You can't bake a proper AO with overlapping islands.

==Unsorted==

(general guidelines, tips, best practices, app specific tutorials, ...)

* [http://netzwelt.gaming-hut.de/vegatexturing/ WIP VegaStrike texturing page by Major]
* [http://edice.netfirms.com/tuts/texturetut.htm Texturing tutorial by Duality]

For the time being, you may wish to have a look at the corresponding [[Development:Texture_Guidelines|Texturing Guidelines]].

* [[Development:Texture Guidelines|Guidelines for creating ship materials]]

* [[HowTo:Add Per Pixel Lighting|Adding per-pixel lighting to your 3D model]]
* [[HowTo:IntroToShaders|Introduction to shaders, and what they mean for you]] --Bumpmaps, Normalmaps, Shininess maps ...

* [[HowTo:Texture|Creating your own textures]] - A summary on how to make texture maps
* [[HowTo:Texture in Wings3d|Texturing your model in Wings 3d]]
* [[HowTo:SuperrealisticTexturing|Tips for realistic-looking textures]]
* [[HowTo:Make Animated Textures|Using animated textures on a model]]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/texturing_noodle LaGrande Noodle]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/ao_and_prt_bakes AO and PRT bakes, using Blender and xNormal]

=Integration and Testing=

Using UnitConverter to convert all files and edit the model stats for Vega Strike:
[[Development:Tools:UnitConverter]]

===Object Marker===
In order to automatically create turret mounts, gun mounts, and engine thrusters placements in units.csv, please use the following marker:

[author:chuck_starchaser] Here's a blend file people could load and save as the default blender start.
Starts with a marker smack in the middle.
You can move it to another layer, later duplicate it as needed to place copies at key locations.
http://wcjunction.com/temp_images/cinemut/goodstart.blend
You can also import the marker into another blend file:
Open whatever.blend, go to File -> Append Or Link
Navigate to where goodstart.blend is.
Go to the Objects folder, and click on the "marker" object.
To duplicate an object, in object mode, select and shift-D.
To rename your duplicated object, hit F9 and, towards the left,
where it says OB:Marker click in the middle of it and then
type "gunmount_0_light_medium" or whatever.

It is advisable to group the marker objects into a group called "marker". You are required to export all the markers into one obj file that needs to contain the name "marker" in it (letter case is unimportant, it can be "marker", or "Marker").

Object Helper naming convention: ''type_subtype_identifier''

with type:
* pilot (currently unused)
* mount (currently unused)
* turret
* subunit
* engine
* dock

and subtype being optional (convention tbd),
and identifier being either a number or a description and optional.

You may define for example:
* pilot
* pilot_john
* mount_lightmedium_0
* turret_capmissile_frontleft
* subunit_1
* engine_retro_left

===Exporting to OBJ+MTL===

===Updating Stats===
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
* [[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]

=Submission and Vetting=

=Technical Reference=

==Technical Specifications==

* [[HowTo:Edit BFXM files|Editing BFXM files (format spec)]]
* [[HowTo:Edit XMESH files|Editing the xmesh file of a ship]]
* [[HowTo:Edit units.csv|Editing units.csv]]
* [[HowTo:Add Engine Glow|Adding an engine glow to your 3D model]]

==Scripts and Tools==

See [[Development:Scripts_%26_Tools|Scripts & Tools]]
* [[HowTo:Add_Ships#New_method|mesher converter obj <-> bfxm <-> xmesh]]
* [[Development:Tools:UnitConverter|UnitConverter]]

=References=

* [http://wcpedia.com/dw/doku.php/wc_info/modding/index WCpedia Modeling Page]

[[Category:Development|Model Guidelines]]
[[Category:Modeling|Model Guidelines]]

Development:Tools:UnitConverter

2011-04-04T21:58:25Z

Pyramid: /* Requirements */

=Introduction=

Raising from the stone age of workflows, in which every task, from texture conversion to editing of unit stats, had to be accomplished manually and only by quite knowledgeable magistrates who knew the alchemy of units.csv columns, xmesh files, and had a magic with meshers. Now, UnitConverter shines upon us, still in the distance, but unmovable like a beacon on solid rock, to be the church of the artists, to accommodate the apostles of Blender, CineMut, and LaGrande, to bring the holy spirit of salvation to this compassionate universe of ours.

Some of the main Unit Converter features:
* bi-directionally converts meshes between obj and bfxm files
* assign textures to (sub)models
* convert model and shield meshes
* compress default and faction input textures to dds output textures
* saves the complete workspace in portable config files
* change model techniques and blend mode
* checks and corrects invalid obj files, recreates mtl files
* creates a model directory if none exists and copies all required files
* compresses hud image and creates a .sprite file
* units.csv entry editor and creator (with default unit stats for new units)
* displays model using VS
* reads mesh dimensions from obj file
* placement of thrusters, turrets, mounts, docks, and blink lights from marker obj file
* on-screen instructions for each workflow module
* production tested

==Important Note==
{{warning_text |
|text=Due to the way ''mesher'' handles command line options (separates different inputs by spaces), it will not allow to use folders or file names with spaces (as common on Windows).
Should you be getting runtime errors during the conversion, you should rename your folder to something like "UnitName" or "Unit_Name_working_folder", i.e. substitute spaces with underscores "_". Do the same for the input files, i.e. "Unit_Name.obj".}}

=Quick Start Guide=

==Configuration==
You must first configure the paths under Config including the application in the path:
* ''path\data'' (to edit unit stats and view model in Vega Strike)
* ''path\mesher.exe'' (to convert model to bfxm) - [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/win32/bin/ get mesher]
* ''path\nvcompress'' (to compress textures) - [[Links:Graphic_Applications#nVidia_Texture_Tools|see here for instructions on nvcompress]]
(There is no need to set the working dir, as this field is purely informational)

==Integrating Models==
Assuming you have exported:
* ship mesh to ''Ship.obj''
* shield to ''Ship-Shield.obj''
* helpers to ''Ship-Mounts.obj
''
... the steps to convert your model are:
* In UnitConverter, under "Model" add all three obj files to workspace.
* Then select the main Ship model in the drop down.
* Under "Textures" you add the ones you have provided.
* Press "Save and Convert"
* Press "Convert Textures"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

This will call vegastrike and the modelview.mission with your new unit enabled.

==Converting Hud Image==
Under "HUDImage":
* Open the "''Ship-hud.png''" image using the "..." button
* Press "Convert Image"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

==Using Uncompressed Images==
* Under "Config" check the "Bypass compression" option.
* Under "Textures" press "Save and Convert"
* Press "Copy Data"
* Under "View" press "View"

==Adding Thruster, Docks, Mounts==
* Under "Model" press "Add Model"
* Select the "''Ship-Mounts.obj''" file with your mount markers.
* Under "Unit" and "Unit2" review the stats
* Under "Unit" press "Save"
* Under "View" press "View"

==Editing Stats==
* Under "Unit", in "Unit name" write the units.csv key (e.g. ''Llama.begin'')
* Press "Load"
* Edit fields under "Unit" and "Unit2"
* Under "Unit" press "Save"

==Comparing Units==
* Under '''Unit''' tab, in '''Unit name''' write the units.csv key (e.g. ''Llama.begin'')
* Press '''Load'''
* Use '''<''' and '''>''' to browse backward and forward.
* After editing a parameter make sure to press '''Save'''

==Getting Help==
In case of problems, please report to the [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=20&t=11885 Unit Converter thread].

=UnitConverter Tool=

==Requirements==

The only requirement to run UnitConverter on your system is to have Python 2.5 or 2.6 installed on your system. Python 3.x has different syntax and will not work. No additional libraries are required.

A requirement for the '''model obj files''' is that no mtl file is provided. UnitConverter will generate its own texture information based on the input given under model.
The best way for exporting files from blender is to use the following three options *only*: '''Edges''', '''UVs''', '''Objects'''. You may also enable Normals, and Groups. However the '''Materials''' export option should be explicitly disabled.

==Installation and Starting==

You can download the latest version of UnitConverter from the Vega Strike svn repository:
* View repo [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/modtools/UnitConverter/ trunk/modtools/UnitConverter].
* Download with
<code><pre>svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/modtools/UnitConverter</pre></code>

To install, copy all files to a directory of your choice.

To run UnitConverter, open command line/shell, change to the installation directory, and depending your operating system type (without the ">" which denotes the command line prompt:

Windows: <code><pre>> uc</pre></code>

Linux: <code><pre>> ./uc</pre></code>

Other: <code><pre>> python unitconverter.py</pre></code>

First thing you'll need to do is to configure the paths for Vega Strike data directory, mesher and nvcompress.

{{warning_text |
| text='''Important:''' To be fully able utilize UnitConverter functionality, please configure the paths under [[Development:Tools:UnitConverter#Configuration_2|'''Config''']].}}

==Models Workspace==
Models Workspace Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f1_workspace.jpg

The following operations are available:
* '''Clear Workspace''' - to start a new model integration
* '''Add Model''' - to add a new model to workspace. The following files are accepted:
** ''.obj'' file containing the model mesh
** ''?-Shield.obj'' file containing the shield mesh
** ''?-Marker.obj'' file containing the marker objects as described in the [[Development:Model_Guidelines#Object_Marker|objects marker modeling section]]
** ''.bfxm'' files to backward convert meshes to obj files
* '''Clear Model''' - to remove the selected model from the workspace
* '''Load Workspace''' - to load an ''.ini'' configuration file of the workspace
* '''Active Model''' - change active model on the dropdown to edit its textures

It is important that your first model in workspace should be the main model, as further information like directory name and units.csv entry name will be derived from the main model name.

Under '''Model/Files''' the ''.obj'' and ''.mtl'' files for the active model will be displayed.
Under '''Material Info''' you can find information on the ''.obj'' file's material library and material names.

To edit texture assignments, proceed to the '''Textures''' tab on the left.

==Textures==
Textures Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f2_textures.jpg

In this tab you can assign textures to model submeshes:
* Under '''Submodels''' select the submesh you'd like to assign textures to. By default the first submesh is selected when the model is activated.
* Add the available '''Textures 0-5''' by pressing the '''...''' buttons between the '''Input Texture''' and '''Output Texture''' columns and browse to the appropriate file. The output texture name will be set (naming convention: '''tex_'''''model'''''_'''''submodel'''''_'''''texture'''''.texture''')
* Select the appropriate '''Technique''', i.e. leave it empty for conventional shading approach or choose e.g. ''cinemut_opaque'' if your input textures are provided with CineMut shader family compatible packing.
* Select '''Blend mode'''.
** For main meshes leave it at ''ONE ZERO''
** For shield mesh and blink light submeshes choose ''ONE ONE''

Once you have assigned textures to all your submeshes, you can now start the conversion:
* Press '''Save and Convert''' to save the texture assignment information and convert your model to Vega Strike compatible ''bfxm'' format.
* You may '''Compress Textures''' using nvcompress if you have configured the command path previously
* Finally, '''Copy Data'' will copy textures and ''bfxm'' files to the unit directory

To add the HUD image, proceed to the '''HUDImage''' tab on the left.

===Advanced Usage - Converting faction textures===

Faction textures must follow the naming of the default textures with prefixed faction name.
When your default diffuse texture is ''dif.png'' and ''tex_000.texture'', the faction input and output textures for the Uln faction will be ''uln_dif.png'' and ''uln_tex_000.texture'' and so on for all the other textures and factions.

Unit converter can assist you with DDS conversion of the input textures provided the naming convention is followed. To convert a faction texture:
* Select the '''Faction''' from the drop down, then
* '''Compress Textures''', and when done
* '''Copy Data''' to put the faction textures into the unit data directory

==HUD Image==
HUD Image Screen

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f3_hud.jpg

Adding a HUD image to the data is fairly easy, simply:
* Browse for the image using the '''...''' button. The appropriate entry will also be created in the '''Unit''' editor.
* '''Compress Image''' to make it DDS, and
* '''Copy Data''' to the unit data directory. This button evokes the same command as the one on the '''Textures''' tab. This means, the ''image'', ''sprite'', ''bfxm'', and ''texture'' files will be copied together.

To edit the unit properties and parameters, proceed to the '''Unit''' tab on the left.

==Unit Editor==

The Unit Editor provides facilities for editing your most important parameters of the unit:
* '''Load''' - loads the unit parameters
* '''Save''' - saves the edited parameters
* '''Reset''' - reloads unit parameters for active model without previously saving changes

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f4_unit.jpg

The most critical parameters for successful integration of the unit are:
* '''Unit description''' - the text that will be displayed in-game about the unit
* '''Unit type''' and '''Unit role''' - used in-game and to correctly view vessels and installations as such
* Under '''Unit dimensions''' you will find the
** '''Dimensions''' as derived from the ''obj'' mesh file.
** To bring the model up to the expected scale, you'll need to set the '''Scale''' parameter. The final size of the model in-game will be the multiplication result of dimensions and the scale.

The remaining entries will be created from your marker object:
* '''Engine Thruster''' will be derived from markers named ''engine_*''. You may '''Update''' the '''Thruster type''' to a different than the default one (''supernova.bmp.bfxm'').
* '''Turrets & Subunits''' will be derived from markers named ''turret_*'' or ''subunit_*''. You may browse the '''Subunit nr.''' (number) by using the '''<''' and '''>''' buttons and change the turret type from the '''Subunit type''' dropdown and confirmation by '''Update'''.
* '''Docking Ports''' will be derived from markers named ''dock_*''

To continue editing unit parameters, proceed to the '''Unit 2''' tab on the left.

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f5_unit2.jpg

To add upgrades, under '''Upgrades''' select the '''Upgrade class''' and '''Upgrade type''' and then '''Add Upgrade'' to the unit.
To delete an upgrade, simply remove the entries between (and including) the {} brackets.

All other parameters on this tab and the following '''Unit 3''' tab can be manually edited

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f6_unit3.jpg

Don't forget to actually '''Save''' your changes before proceeding to '''View''' the unit in-game.

===Advanced Usage - Independent Unit Editor===
You can use built-in Unit editor of the '''Unit Converter''' to edit units without having to load the mesh files. To do so:
* On the '''Model''' tab do '''Clear Workspace'''
* On the '''Unit''' tab, manually write the unit key under '''Unit name'''
* '''Load''' the unit parameters

You can also browse the units.csv file by using the '''<''' and '''>''' buttons on the sides of the '''Unit name''' to row-wise move back and fore between the entries. Browse, '''Load'''/'''Save''' buttons are also available on '''Unit 2''' and '''Unit 3''' tabs.

==View==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f7_view.jpg

By pressing '''View''' Vega Strike can be loaded and you can test your unit in-game.

To test faction textures (if provided) you may previously select the '''Faction''' from the drop down, otherwise leave it at ''privateer'' to use default textures.

Testing of units will happen in two different ways:
* For vessels, using a special mission, the ''modelview.mission'' that spawns the unit as a ship.
** Use the '''F6''' key to view your own unit.
** Use the '''T''' key to target a second unit of the same type and then press the '''D''' key to stop it from SPECing away, then turn around to it to verify the docking ports. Repeat pressing '''D''' every 10 seconds to prevent it from flying away suddenly.
* Use the '''N''' key to target the nearest station, fly to it and start shooting while switching to '''F6''' view to test your shield mesh.
* For installations, the ''Modelview.system'' will be equipped with the edited station.
** Use the '''N''' key to target the station, then '''D''' to see the docking ports.

==Configuration==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f8_config.jpg

The '''Config''' tab defines presets to supports some of the functionality of the '''Unit Converter''':
* '''Vega Strike directory''' - is the directory where ''Version.txt'' and all data subdirectories reside (''ai'', ''animations'', ...)
** Use the '''Browse''' button to locate it
* '''Path to mesher''':
** Click the '''Browse''' button on the right to locate ''mesher''
** Find the ''mesher(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix.
* '''Path to nvcompress''':
** Click the '''Browse''' button on the right to locate ''nvcompress''
** Find the ''nvcompress(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** You will not require to install ''nvcompress'' if you just want to test your models. In this case please make sure you enable the '''Bypass compression''' option further below.
** Techno-talk: The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix. (If nvcompress is in your search path, you may only provide the command.)

===Advanced Configuration===

You may also change defaults that will be used anytime you reopen the Unit Converter:
* '''Current Technique''' - set the default technique you will be working with so that you don't need to remember adjusting it when editing textures.
* '''Use unit class directory''' - used to calculate target for copying model and texture files.
** when checked will store vessels in ''data/units/vessels/unitname'' directory and installations in ''data/units/installations/unitname'' directory. This is the default behavior for Vega Strike Upon The Coldest Sea game.
** If your mod is using a flat directory structure, you can uncheck the option and all your units will be stored in ''data/units/unitname'' directory.
* '''Bypass compression''' - when checked the input texture will be used as output texture. This is useful when editing and testing textures without the need to reconvert the model to bfxm.
* '''Backup obj/mtl files''' - when checked will copy original ''obj'' and ''mtl'' files to ''obj~'' and ''mtl~'' before writing new information.
* '''Create xmesh file''' - though the xmesh format is obsolete, when converting from ''obj'' to ''bfxm'', it might be useful to also create ''xmesh'' files to test the conversion process.
* Under '''Admin''' you can '''Standard Sort units.csv''' file. Though it is standard sorted by default, you might want to make sure it is after a manual editing of the file.

==About==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f9_about.jpg

What's that about?

=Code Reference=

==Python Modules==

Admittedly, the structure of the program could be more modular.

Unit Converter is written in Python using only ''Tkinter'' UI building functionality. On Windows Tkinter is distributed with Python, on Linux, it's available for download in all repositories. No further additional modules are required to run Unit Converter.

Source modules for Unit Converter:
* ''unitconverter.py'' - main module containing the complete program
* ''appwindow.py'' - frame creator for the different tabs
* ''objparse.py'' - ''.obj'' and ''.mtl'' file reader, parser, and writer
* ''vsunitcsv.py'' - ''units.csv'' file reader, parser, and writer
* ''vsmission.py'' - ''.mission'' file reader, parser, and writer
* ''vssystem.py'' - ''.system'' file reader, parser, and writer
* ''vector.py'' - mathematical vector functions
* ''png.py'' - ''.png'' file format reader

Other files:
* ''unitconverter.ini'' - Unit Converter configuration file. Not distributed. Will be created upon first start.
* ''unitconverter.ico'' - Windows icon file.
* ''uc'' - Linux shell script for starting Unit Converter
* ''uc.bat'' - Windows batch file (shell script) for starting Unit Converter
* ''uc_releasenotes.txt'' - Unit Converter release notes
* ''UnitWorkingDir/UnitName.ini'' - Unit workspace configuration file

==Program Flow==

The GUI building section starts with:
<code><pre> def __init__(self, master):</pre></code>

The code is visually separated into:
* variable initialization
* GUI building sections
* program execution, start-up, and shutdown

The GUI building section for each tab contains elements that have event triggers which call other functions within the first part of the ''unitconverter.py'' code.

Further, there a unique watch function that supervises the change of some of the contents of GUI element variables for elements that, in Tkinter, do not come with an event handler (option drop downs, text variables, option check boxes):
<code><pre> def processEvents(self):</pre></code>

==Data Elements==

There is a lot of data being handled within the Unit Converter. The main data elements shall be explained here:
* ''workspace[modelnr][submodelnr][parameternr]'' - array containing the complete workspace information, where
** modelnr is the index from ''models[modelnr]'' which stores the model names in workspace
** submodelnr comes from the list ''submodelsListBox''
** ''PARAMS'' - array holding the parameter names for ''workspace''
* ''textures[submodelnr][counter]'' - holds the textures for the active model only prepared for the mtl export in the array form ''["map_0","tex_000.texture"]''
* ''unit*'' - variables holding the unit editor values
* ''textureN'' - with N = 0-5, holds the output texture screen name
* ''texmasterN'' - holds the input texture name
* ''activemodel'' - name of the active (selected) model in workspace
* ''unitname'' - name of the key from units.csv
* ''vegastrike'' - Vega Strike installation directory root
* ''workdir'' - working directory

Most of the variables are commented within the code.

Development:Tools:UnitConverter

2011-04-04T21:51:44Z

Pyramid: /* Requirements, Installation and Starting */

=Introduction=

Raising from the stone age of workflows, in which every task, from texture conversion to editing of unit stats, had to be accomplished manually and only by quite knowledgeable magistrates who knew the alchemy of units.csv columns, xmesh files, and had a magic with meshers. Now, UnitConverter shines upon us, still in the distance, but unmovable like a beacon on solid rock, to be the church of the artists, to accommodate the apostles of Blender, CineMut, and LaGrande, to bring the holy spirit of salvation to this compassionate universe of ours.

Some of the main Unit Converter features:
* bi-directionally converts meshes between obj and bfxm files
* assign textures to (sub)models
* convert model and shield meshes
* compress default and faction input textures to dds output textures
* saves the complete workspace in portable config files
* change model techniques and blend mode
* checks and corrects invalid obj files, recreates mtl files
* creates a model directory if none exists and copies all required files
* compresses hud image and creates a .sprite file
* units.csv entry editor and creator (with default unit stats for new units)
* displays model using VS
* reads mesh dimensions from obj file
* placement of thrusters, turrets, mounts, docks, and blink lights from marker obj file
* on-screen instructions for each workflow module
* production tested

==Important Note==
{{warning_text |
|text=Due to the way ''mesher'' handles command line options (separates different inputs by spaces), it will not allow to use folders or file names with spaces (as common on Windows).
Should you be getting runtime errors during the conversion, you should rename your folder to something like "UnitName" or "Unit_Name_working_folder", i.e. substitute spaces with underscores "_". Do the same for the input files, i.e. "Unit_Name.obj".}}

=Quick Start Guide=

==Configuration==
You must first configure the paths under Config including the application in the path:
* ''path\data'' (to edit unit stats and view model in Vega Strike)
* ''path\mesher.exe'' (to convert model to bfxm) - [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/win32/bin/ get mesher]
* ''path\nvcompress'' (to compress textures) - [[Links:Graphic_Applications#nVidia_Texture_Tools|see here for instructions on nvcompress]]
(There is no need to set the working dir, as this field is purely informational)

==Integrating Models==
Assuming you have exported:
* ship mesh to ''Ship.obj''
* shield to ''Ship-Shield.obj''
* helpers to ''Ship-Mounts.obj
''
... the steps to convert your model are:
* In UnitConverter, under "Model" add all three obj files to workspace.
* Then select the main Ship model in the drop down.
* Under "Textures" you add the ones you have provided.
* Press "Save and Convert"
* Press "Convert Textures"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

This will call vegastrike and the modelview.mission with your new unit enabled.

==Converting Hud Image==
Under "HUDImage":
* Open the "''Ship-hud.png''" image using the "..." button
* Press "Convert Image"
* Press "Copy Data"
* Under "Unit" press "Save"
* Under "View" press "View"

==Using Uncompressed Images==
* Under "Config" check the "Bypass compression" option.
* Under "Textures" press "Save and Convert"
* Press "Copy Data"
* Under "View" press "View"

==Adding Thruster, Docks, Mounts==
* Under "Model" press "Add Model"
* Select the "''Ship-Mounts.obj''" file with your mount markers.
* Under "Unit" and "Unit2" review the stats
* Under "Unit" press "Save"
* Under "View" press "View"

==Editing Stats==
* Under "Unit", in "Unit name" write the units.csv key (e.g. ''Llama.begin'')
* Press "Load"
* Edit fields under "Unit" and "Unit2"
* Under "Unit" press "Save"

==Comparing Units==
* Under '''Unit''' tab, in '''Unit name''' write the units.csv key (e.g. ''Llama.begin'')
* Press '''Load'''
* Use '''<''' and '''>''' to browse backward and forward.
* After editing a parameter make sure to press '''Save'''

==Getting Help==
In case of problems, please report to the [http://vegastrike.sourceforge.net/forums/viewtopic.php?f=20&t=11885 Unit Converter thread].

=UnitConverter Tool=

==Requirements==

The only requirement to run UnitConverter on your system is to have Python 2.5 or 2.6 installed on your system. Python 3.x has different syntax and will not work. No additional libraries are required.

A requirement for the '''model obj files''' is that no mtl file is provided. UnitConverter will generate its own texture information based on the input given under model.
The best way for exporting files from blender is to use the following three options *only*: '''Edges''', '''UVs''', '''Objects'''. All other options should be disabled.

==Installation and Starting==

You can download the latest version of UnitConverter from the Vega Strike svn repository:
* View repo [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/modtools/UnitConverter/ trunk/modtools/UnitConverter].
* Download with
<code><pre>svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/modtools/UnitConverter</pre></code>

To install, copy all files to a directory of your choice.

To run UnitConverter, open command line/shell, change to the installation directory, and depending your operating system type (without the ">" which denotes the command line prompt:

Windows: <code><pre>> uc</pre></code>

Linux: <code><pre>> ./uc</pre></code>

Other: <code><pre>> python unitconverter.py</pre></code>

First thing you'll need to do is to configure the paths for Vega Strike data directory, mesher and nvcompress.

{{warning_text |
| text='''Important:''' To be fully able utilize UnitConverter functionality, please configure the paths under [[Development:Tools:UnitConverter#Configuration_2|'''Config''']].}}

==Models Workspace==
Models Workspace Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f1_workspace.jpg

The following operations are available:
* '''Clear Workspace''' - to start a new model integration
* '''Add Model''' - to add a new model to workspace. The following files are accepted:
** ''.obj'' file containing the model mesh
** ''?-Shield.obj'' file containing the shield mesh
** ''?-Marker.obj'' file containing the marker objects as described in the [[Development:Model_Guidelines#Object_Marker|objects marker modeling section]]
** ''.bfxm'' files to backward convert meshes to obj files
* '''Clear Model''' - to remove the selected model from the workspace
* '''Load Workspace''' - to load an ''.ini'' configuration file of the workspace
* '''Active Model''' - change active model on the dropdown to edit its textures

It is important that your first model in workspace should be the main model, as further information like directory name and units.csv entry name will be derived from the main model name.

Under '''Model/Files''' the ''.obj'' and ''.mtl'' files for the active model will be displayed.
Under '''Material Info''' you can find information on the ''.obj'' file's material library and material names.

To edit texture assignments, proceed to the '''Textures''' tab on the left.

==Textures==
Textures Screen:

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f2_textures.jpg

In this tab you can assign textures to model submeshes:
* Under '''Submodels''' select the submesh you'd like to assign textures to. By default the first submesh is selected when the model is activated.
* Add the available '''Textures 0-5''' by pressing the '''...''' buttons between the '''Input Texture''' and '''Output Texture''' columns and browse to the appropriate file. The output texture name will be set (naming convention: '''tex_'''''model'''''_'''''submodel'''''_'''''texture'''''.texture''')
* Select the appropriate '''Technique''', i.e. leave it empty for conventional shading approach or choose e.g. ''cinemut_opaque'' if your input textures are provided with CineMut shader family compatible packing.
* Select '''Blend mode'''.
** For main meshes leave it at ''ONE ZERO''
** For shield mesh and blink light submeshes choose ''ONE ONE''

Once you have assigned textures to all your submeshes, you can now start the conversion:
* Press '''Save and Convert''' to save the texture assignment information and convert your model to Vega Strike compatible ''bfxm'' format.
* You may '''Compress Textures''' using nvcompress if you have configured the command path previously
* Finally, '''Copy Data'' will copy textures and ''bfxm'' files to the unit directory

To add the HUD image, proceed to the '''HUDImage''' tab on the left.

===Advanced Usage - Converting faction textures===

Faction textures must follow the naming of the default textures with prefixed faction name.
When your default diffuse texture is ''dif.png'' and ''tex_000.texture'', the faction input and output textures for the Uln faction will be ''uln_dif.png'' and ''uln_tex_000.texture'' and so on for all the other textures and factions.

Unit converter can assist you with DDS conversion of the input textures provided the naming convention is followed. To convert a faction texture:
* Select the '''Faction''' from the drop down, then
* '''Compress Textures''', and when done
* '''Copy Data''' to put the faction textures into the unit data directory

==HUD Image==
HUD Image Screen

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f3_hud.jpg

Adding a HUD image to the data is fairly easy, simply:
* Browse for the image using the '''...''' button. The appropriate entry will also be created in the '''Unit''' editor.
* '''Compress Image''' to make it DDS, and
* '''Copy Data''' to the unit data directory. This button evokes the same command as the one on the '''Textures''' tab. This means, the ''image'', ''sprite'', ''bfxm'', and ''texture'' files will be copied together.

To edit the unit properties and parameters, proceed to the '''Unit''' tab on the left.

==Unit Editor==

The Unit Editor provides facilities for editing your most important parameters of the unit:
* '''Load''' - loads the unit parameters
* '''Save''' - saves the edited parameters
* '''Reset''' - reloads unit parameters for active model without previously saving changes

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f4_unit.jpg

The most critical parameters for successful integration of the unit are:
* '''Unit description''' - the text that will be displayed in-game about the unit
* '''Unit type''' and '''Unit role''' - used in-game and to correctly view vessels and installations as such
* Under '''Unit dimensions''' you will find the
** '''Dimensions''' as derived from the ''obj'' mesh file.
** To bring the model up to the expected scale, you'll need to set the '''Scale''' parameter. The final size of the model in-game will be the multiplication result of dimensions and the scale.

The remaining entries will be created from your marker object:
* '''Engine Thruster''' will be derived from markers named ''engine_*''. You may '''Update''' the '''Thruster type''' to a different than the default one (''supernova.bmp.bfxm'').
* '''Turrets & Subunits''' will be derived from markers named ''turret_*'' or ''subunit_*''. You may browse the '''Subunit nr.''' (number) by using the '''<''' and '''>''' buttons and change the turret type from the '''Subunit type''' dropdown and confirmation by '''Update'''.
* '''Docking Ports''' will be derived from markers named ''dock_*''

To continue editing unit parameters, proceed to the '''Unit 2''' tab on the left.

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f5_unit2.jpg

To add upgrades, under '''Upgrades''' select the '''Upgrade class''' and '''Upgrade type''' and then '''Add Upgrade'' to the unit.
To delete an upgrade, simply remove the entries between (and including) the {} brackets.

All other parameters on this tab and the following '''Unit 3''' tab can be manually edited

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f6_unit3.jpg

Don't forget to actually '''Save''' your changes before proceeding to '''View''' the unit in-game.

===Advanced Usage - Independent Unit Editor===
You can use built-in Unit editor of the '''Unit Converter''' to edit units without having to load the mesh files. To do so:
* On the '''Model''' tab do '''Clear Workspace'''
* On the '''Unit''' tab, manually write the unit key under '''Unit name'''
* '''Load''' the unit parameters

You can also browse the units.csv file by using the '''<''' and '''>''' buttons on the sides of the '''Unit name''' to row-wise move back and fore between the entries. Browse, '''Load'''/'''Save''' buttons are also available on '''Unit 2''' and '''Unit 3''' tabs.

==View==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f7_view.jpg

By pressing '''View''' Vega Strike can be loaded and you can test your unit in-game.

To test faction textures (if provided) you may previously select the '''Faction''' from the drop down, otherwise leave it at ''privateer'' to use default textures.

Testing of units will happen in two different ways:
* For vessels, using a special mission, the ''modelview.mission'' that spawns the unit as a ship.
** Use the '''F6''' key to view your own unit.
** Use the '''T''' key to target a second unit of the same type and then press the '''D''' key to stop it from SPECing away, then turn around to it to verify the docking ports. Repeat pressing '''D''' every 10 seconds to prevent it from flying away suddenly.
* Use the '''N''' key to target the nearest station, fly to it and start shooting while switching to '''F6''' view to test your shield mesh.
* For installations, the ''Modelview.system'' will be equipped with the edited station.
** Use the '''N''' key to target the station, then '''D''' to see the docking ports.

==Configuration==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f8_config.jpg

The '''Config''' tab defines presets to supports some of the functionality of the '''Unit Converter''':
* '''Vega Strike directory''' - is the directory where ''Version.txt'' and all data subdirectories reside (''ai'', ''animations'', ...)
** Use the '''Browse''' button to locate it
* '''Path to mesher''':
** Click the '''Browse''' button on the right to locate ''mesher''
** Find the ''mesher(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix.
* '''Path to nvcompress''':
** Click the '''Browse''' button on the right to locate ''nvcompress''
** Find the ''nvcompress(.exe)'' file on your system, select the file and confirm with '''Open'''. The configuration will be saved so that you need to do it only once.
** You will not require to install ''nvcompress'' if you just want to test your models. In this case please make sure you enable the '''Bypass compression''' option further below.
** Techno-talk: The path must be the complete address (directory path + executable) in the same way you would evoke it from command line / console. On windows it may or may not include the ''.exe'' extension suffix. (If nvcompress is in your search path, you may only provide the command.)

===Advanced Configuration===

You may also change defaults that will be used anytime you reopen the Unit Converter:
* '''Current Technique''' - set the default technique you will be working with so that you don't need to remember adjusting it when editing textures.
* '''Use unit class directory''' - used to calculate target for copying model and texture files.
** when checked will store vessels in ''data/units/vessels/unitname'' directory and installations in ''data/units/installations/unitname'' directory. This is the default behavior for Vega Strike Upon The Coldest Sea game.
** If your mod is using a flat directory structure, you can uncheck the option and all your units will be stored in ''data/units/unitname'' directory.
* '''Bypass compression''' - when checked the input texture will be used as output texture. This is useful when editing and testing textures without the need to reconvert the model to bfxm.
* '''Backup obj/mtl files''' - when checked will copy original ''obj'' and ''mtl'' files to ''obj~'' and ''mtl~'' before writing new information.
* '''Create xmesh file''' - though the xmesh format is obsolete, when converting from ''obj'' to ''bfxm'', it might be useful to also create ''xmesh'' files to test the conversion process.
* Under '''Admin''' you can '''Standard Sort units.csv''' file. Though it is standard sorted by default, you might want to make sure it is after a manual editing of the file.

==About==

http://vegastrike.sourceforge.net/forums/cpg/albums/userpics/1011733/UnitConverter_f9_about.jpg

What's that about?

=Code Reference=

==Python Modules==

Admittedly, the structure of the program could be more modular.

Unit Converter is written in Python using only ''Tkinter'' UI building functionality. On Windows Tkinter is distributed with Python, on Linux, it's available for download in all repositories. No further additional modules are required to run Unit Converter.

Source modules for Unit Converter:
* ''unitconverter.py'' - main module containing the complete program
* ''appwindow.py'' - frame creator for the different tabs
* ''objparse.py'' - ''.obj'' and ''.mtl'' file reader, parser, and writer
* ''vsunitcsv.py'' - ''units.csv'' file reader, parser, and writer
* ''vsmission.py'' - ''.mission'' file reader, parser, and writer
* ''vssystem.py'' - ''.system'' file reader, parser, and writer
* ''vector.py'' - mathematical vector functions
* ''png.py'' - ''.png'' file format reader

Other files:
* ''unitconverter.ini'' - Unit Converter configuration file. Not distributed. Will be created upon first start.
* ''unitconverter.ico'' - Windows icon file.
* ''uc'' - Linux shell script for starting Unit Converter
* ''uc.bat'' - Windows batch file (shell script) for starting Unit Converter
* ''uc_releasenotes.txt'' - Unit Converter release notes
* ''UnitWorkingDir/UnitName.ini'' - Unit workspace configuration file

==Program Flow==

The GUI building section starts with:
<code><pre> def __init__(self, master):</pre></code>

The code is visually separated into:
* variable initialization
* GUI building sections
* program execution, start-up, and shutdown

The GUI building section for each tab contains elements that have event triggers which call other functions within the first part of the ''unitconverter.py'' code.

Further, there a unique watch function that supervises the change of some of the contents of GUI element variables for elements that, in Tkinter, do not come with an event handler (option drop downs, text variables, option check boxes):
<code><pre> def processEvents(self):</pre></code>

==Data Elements==

There is a lot of data being handled within the Unit Converter. The main data elements shall be explained here:
* ''workspace[modelnr][submodelnr][parameternr]'' - array containing the complete workspace information, where
** modelnr is the index from ''models[modelnr]'' which stores the model names in workspace
** submodelnr comes from the list ''submodelsListBox''
** ''PARAMS'' - array holding the parameter names for ''workspace''
* ''textures[submodelnr][counter]'' - holds the textures for the active model only prepared for the mtl export in the array form ''["map_0","tex_000.texture"]''
* ''unit*'' - variables holding the unit editor values
* ''textureN'' - with N = 0-5, holds the output texture screen name
* ''texmasterN'' - holds the input texture name
* ''activemodel'' - name of the active (selected) model in workspace
* ''unitname'' - name of the key from units.csv
* ''vegastrike'' - Vega Strike installation directory root
* ''workdir'' - working directory

Most of the variables are commented within the code.

Development:Model Guidelines

2011-04-04T18:12:22Z

Pyramid: /* Object Marker */

{{parent_link|parent=[[Development]]}}
= Introduction =

The intention of this document is to give artists using the Vega Strike engine some suggested guidelines to follow in creating models. You may also wish to have a look at the corresponding [[Development:Texture_Guidelines|texturing guidelines]].

So you want to create a new ship for Vega Strike, do you? While virtually all models are welcome, well before you start cranking out wonderfully designed models we request that you first check what models are still required.

{{warning_text |
| text='''Note:''' If you wish to contribute a new or updated model (ship, installation, turret, cockpit, ..) to the game Vega Strike, please see the [[Development:3D_Models|'''3D Models''']] page for models requiring attention.}}

Alternatively, contact [[User:jackS|jackS]] or [[User:pyramid|pyramid]].

= Modeling Pipeline Overview =

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98ffb2" |
|'''Step
|'''Input
|'''Output
|'''Tools
|'''Requirements
|'''Tutorials
|-

| Model Selection
| -
| required model
| model task list
| -
| -
|-

| Conceptualization
| selected model
| model concept
| pen & paper, artwork forum
| artstyle guide
| -
|-

| Modeling
| concept
| model mesh, obj + mtl files
| blender, forum
| many
| -
|-

| Texturing
| model mesh
| textures
| gimp, forum
| texture requirements
| -
|-

| Integration
| model + textures
| bfxm + dds textures
| mesher + UnitConverter
| -
| -
|-

| Testing
| bfxm model + dds textures
| bfxm + dds textures
| vegastrike + modelview.mission
| pass or rework
| -
|-

| Submission
| blender file (obj + mtl), master textures, bfxm + dds textures
| archive or svn
| mail, svn client
| -
| -
|}

=Model Requirements=

==Requirements Checklist==

Considerations for a successful model submission:
* Model is in the requirements list [[Development:3D_Models|->]]
* Abides to faction visual guidelines
* Has approved concept
* Provides model source file (blender, Wings3D, ...)
* Provides OBJ file
* Has model mesh, shield mesh, LoD meshes, helper meshes
* Provides uncompressed textures in png format (and optionally faction textures)
* Provides texture source files (GIMP, ...)
* Provides HUD png image with correct orientation
* Provides units.csv file entry

==Model Requirements Details==

==Visual Guidelines==

For particular aesthetic guidelines, please see the [[Artstyle guides]] page. Please note that many of the existing models are used because of expedience, not because they fit well with VS canon (i.e. if you make something new look like what's there, it still might not be what we're looking for). If in doubt, please ask on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

To absolutely sure, for new models, please create a drawing of your proposed concept and let it be discussed and approved on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

See also [[Development:Texture Guidelines]]

==Model File Format==
The preferred format for submission (for public disbursement - whatever native format is used inside your favorite modeling suite is fortunately a non-issue) is currently Wavefront OBJ file format, as this is the most easily converted between manipulation (assorted modeling tools) and presentation (currently BFXM, later to be the OGRE .mesh format). Model "source" therefore, is, at present (Sep. 2008), most usefully uploaded as .OBJ.

Until such a time as a visual model editing tool is completed, conversion to a game-ready format will likely pass through the .xmesh format for insertion of LOD references into top level mesh(es), correction of coordinate "handedness" (if the ordering of the coordinate axes is incompatible, as appears to happen with the output of some modeling tools).

See [[HowTo:Add_Ships]] for information on using mesher to convert to a presentation format (such as BFXM). Note that an old utility, objconv, is '''not''' mesher, and should not be used for this task. Source files for the mesher utility are included along with VS source. Windows users may download updated mesher binaries from their SVN interface of choice (the binary will be in the \bin directory).

==Polygon/Vertex Count==
In broadest terms, the desired polygon count for a particular model is dependent on three major factors:
*The amount of screen real-estate that the model is likely to be viewed at the majority of time that a user will be seeing it (i.e. a 2 meter long rocket doesn't deserve the same order of magnitude of attention to detail as a large base or vessel unless the rocket is expected to be mounted in front of a camera. Likewise, even at the same level of attention in terms of polygons per square meter, it would have far fewer total polygons.)
*The intrinsic surface complexity of the model. If one is modeling a box for freight cargo, one is not going to need as many polygons as if one needed to model one of the Vega Strike developers (not that we're necessarily model material ;-)). If you don't use enough polygons, no amount of texture magic can save a model from being ugly. That said, if you are modeling a cargo freight container and you use thousands of polygons, you're being negligent and wasteful of resources.
*Engine limitations. Engine limitations is a bit of a misnomer, as the performance of the graphical engine is more hardware dependent than anything else, but it's a good heading for lumping any non-artistic hurdles under. This is the most complicated of the three major factors, because it represents a moving target. Suffice it to say that in order to preserve playability on a broad range of systems, there is a premium placed on making a model aesthetically appropriate with the minimum number of polygons.

Rough guideline:
*Fighter: 15k triangles
*Corvette: 30k tris
*Cruiserer: 60k
*Carrier: 120k
*Space station: 250k

However, significant discression, and the possibility for using large numbers of polygons to prettify an object remain with the artist, provided they make appropriate use of [[Terminology:LODs|LODs]]. The primary focus needs to be on making a model aesthetically appropriate, for an intended common viewing distance, and then catering to the needs of the engine by introducing lower LODs (if necessary) and catering to artistic desires by introducing higher LODs (if appropriate). There is also an element of minor future proofing that occurs with providing a robust range of LOD poly counts - namely, multiple versions of the data set can be constructed targeted at different hardware points by shifting up or down along the LOD set (although this currently isn't bothered with, if and when we develop a true source repository for models and textures, this will likely become more common, as postprocessing of submitted art will become tenable).

One more point to consider before attempting to set a polygon goal for a model is what the likely total contribution from all instances on screen of a given model will be - if the model represents something particularly rare, then it is likely that a few more polygons can easily be spared on its model than for more common objects of otherwise similar size, complexity, etc.

Above all, use common sense - if it's visually hideous because it doesn't have enough polygons, it's not your top level model, and if it's in the 5 digit range for polygon count, it's not your lowest level LOD. Take into consideration how much screen real estate, based on the intended in-game size of the model (and if you don't have any idea how big it's supposed to be - you're doing something wrong already) the model will be taking up at various distances, and calibrate detail appropriately (this will become a much easier task once there is a visual modeling tool from the VS side) - to belabor the obvious, the difference between 500 polygons and 5000 gets somewhat obscured when the object is only drawn using 64 pixels. Note therefore that larger objects will often necessitate higher polygon counts merely because there's more of them to see.

(Note that there is no need to continue adding LODs beyond a point of "diminishing artistic returns" - if adding more detail won't help, don't bother. If adding detail helps, but is too expensive to be practical, then it may still be worthwhile for later inclusion as hardware resources increase.)

For small to moderate craft and installations, something along the lines of either of the following is not inappropriate:

(Exponential Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4000
*LOD 3 <= 8000
*LOD 4 <= 16000
*LOD 5 >16000

(Quadratic Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4500
*LOD 3 <= 8000
*LOD 4 <= 12500
*LOD 5 <= 18000
*LOD 6 >18000

Larger models, such as capital vessels and large installations will likely follow a similar curve, but at a higher offset, due to increased size. Truly massive models should be partitioned into multiple meshes, each with its own set of LODs such that nearer portions of the model can be independently represented at higher LOD than more distant ones. Partitioning into multiple meshes may be preferable even for merely "largish" models so as to preserve reasonable correspondence between single pixels and the size of represented features when texturing.

==Textures==

Texture maps should also be made accordingly, although clearly artistic integrity trivially trumps the following rough guideline (if you need more pixels, use them) and the appropriate texture size may depend greatly upon the size of the model.

*LOD 1 128x128
*LOD 2 256x256
*LOD 3 512x512
*LOD 4 1024x1024
*LOD 5 and up having multiple 1024x1024 textures

Be careful with ''texture lodding abuse''. Each LOD that uses its own texture will require more memory (video memory), and breaks batching between instances (slows down rendering of many instances of this model). Even so, texture lodding actually frees up memory most of the time, since only lesser versions are used in the distance. A general rule of thumb is to never have more than two or at most three versions of the same texture. Also take any opportunity to convert textures to greyscale when the color loss is not quite noticeable (most commonly with glow maps and specular maps).

Likewise, for larger models, do not neglect the potential addition of detail textures.

See also [[Development:Texture Guidelines]] and [[Development:Graphics_Requirements]].

===Faction Textures===

To include and successfully test faction textures in your data, you need to:
* set the corresponding vegastrike.config variable (<code>var name="faction_dependant_textures" value="1"</code>).
* prefix default textures with the faction name, e.g. when your default texture is called "tex_000.texture", to enable the faction texture for "pirates" you'll need to add the texture "pirates_tex_000.texture".
* change configuration to one of the 2 highest computer modes (512M+1GB or 1024MB).

==Shield and Collision Meshes==
Separate shield meshes are highly desirable. Shield meshes should also be done using LODs, although shield meshes should remain simple - that is, their top level meshes should not contain odious numbers of polygons for something that is only infrequently displayed.

Collision meshes need not (and cannot) have LODs. For complex models, it is wise to provide a dumbed-down version of the model that reasonably approximates its shape - minor features and greebles can be safely removed, for instance - to improve performance on the physics engine. Polycount should be kept to a minimum, '''without sacrificing any major features''' of the top-level LOD. Very small vessels (or appropriately shaped ones) may opt to not specify a collision mesh, which will make the physics layer treat this mesh as a spherical object (most efficient).

==HUD Image==

Provides perspective view of the model oriented with the nose towards the left-bottom corner of the image.
The master image resolution should start at 256x256 pixels with transparency around the vessel.

==See also==
For an example of an entity that is composed of multiple meshes, uses LODs, and shield meshes, examine the Clydesdale. (Note that shield and collision meshes are specified in the units.csv file, not by the model.)

=Model Creation=

The first (and most enjoyable) job is to design and draw your model (the geometrical object) within your program.

Feel free to use any modeling program, but it must be able to export models in either (Wavefront) .OBJ or (Vega Strike) .xmesh format. If you don't know where to start, see [[Links:3D Applications]] for a list of modeling software. [http://www.wings3d.com/ Wings 3D] is recommended for modeling beginners. [http://www.blender.org/ '''Blender'''] is the tool of choice for VS artistic community.

==Orientation==
First off, do yourself a favor and line your model up correctly before you begin. For the purposes of Vega Strike, Z+ is forwards and Y+ is up. The model's nose should be pointing forward along the Z+ axis (so that the Z+ axis would theoretically be visible from the cockpit). The mesh should also be properly centered.
Summing up:
* Z+ -> Forward direction
* Y+ -> Up direction
* Centered

== Tutorials==

{{warning_text |
| text='''Note:''' The tutorials overview is not complete. Many of the available tutorials have not yet been integrated into this page. Refer also to the [[HowTos|'''How-Tos Tutorials''']] page for additional tutorials.}}

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98b2ee" |
|'''Modeling Step
|'''Blender
|'''Wings3D
|-
| Create mesh
| -
| [[HowTo:Create Ships in Wings3D|Creating a 3D-model]]
|-
| Smoothing
| [[HowTo:Smooth Groups|Smoothing]] [[HowTo:Weld|Smooth Welding]]
| -
|-
| Mesh cleanup
| [[HowTo:Bevel|Beveling]]
| -
|-
| Unwrapping
| [[HowTo:Unwrap_in_Blender|Unwrapping 1]] [[HowTo:Unwrap|Unwrapping 2]] [[HowTo:FullUnwrapBlender|Ship unwrap]]
| -
|-
| Radiosity Baking
| [[HowTo:Radiosity baking in Blender|Radiosity baking]]
| -
|-
| Exporting
| -
| -
|}

This articles are WIP, means still need to be reviewed and decided how to restructure them:
* [[HowTo:Create Cockpit in Wings3d|Creating a 3D cockpit for your ship.]]
* [[HowTo:Add LODs|Adding Levels of Detail]]
* [[HowTo:Add Ships|Adding your ship to Vega Strike]] - An overview of how to create and add ships to the game
* [[HowTo:Create Models]] - Links to forum discussions. Page will become generic model creation tutorial.
* Modeling Tutorials: [[HowTos#Modeling]]

===Blender Basics===
* [[HowTo:Basic Blender Tutorial|A basic Blender3D tutorial]]: [http://www.cdschools.org/54223045235521/blank/browse.asp?A=383&BMDRN=2000&BCOB=0&C=55205 Blender Basics - 3rd Edition] - not specific to ships, though...

===Wings3D Basics===

===Other Software Basics===

* [[HowTo:Model a Ship|Brad Mick's video tutorial on ship modeling]] - using Lightwave, but the concept is general: ''Rapid Prototyping''

=Texture Creation=

==Unwrapping==

Please make non-overlapping UV unwraps for all future models. You can't bake a proper AO with overlapping islands.

==Unsorted==

(general guidelines, tips, best practices, app specific tutorials, ...)

* [http://netzwelt.gaming-hut.de/vegatexturing/ WIP VegaStrike texturing page by Major]
* [http://edice.netfirms.com/tuts/texturetut.htm Texturing tutorial by Duality]

For the time being, you may wish to have a look at the corresponding [[Development:Texture_Guidelines|Texturing Guidelines]].

* [[Development:Texture Guidelines|Guidelines for creating ship materials]]

* [[HowTo:Add Per Pixel Lighting|Adding per-pixel lighting to your 3D model]]
* [[HowTo:IntroToShaders|Introduction to shaders, and what they mean for you]] --Bumpmaps, Normalmaps, Shininess maps ...

* [[HowTo:Texture|Creating your own textures]] - A summary on how to make texture maps
* [[HowTo:Texture in Wings3d|Texturing your model in Wings 3d]]
* [[HowTo:SuperrealisticTexturing|Tips for realistic-looking textures]]
* [[HowTo:Make Animated Textures|Using animated textures on a model]]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/texturing_noodle LaGrande Noodle]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/ao_and_prt_bakes AO and PRT bakes, using Blender and xNormal]

=Integration and Testing=

Using UnitConverter to convert all files and edit the model stats for Vega Strike:
[[Development:Tools:UnitConverter]]

===Object Marker===
In order to automatically create turret mounts, gun mounts, and engine thrusters placements in units.csv, please use the following marker:

[author:chuck_starchaser] Here's a blend file people could load and save as the default blender start.
Starts with a marker smack in the middle.
You can move it to another layer, later duplicate it as needed to place copies at key locations.
http://wcjunction.com/temp_images/cinemut/goodstart.blend
You can also import the marker into another blend file:
Open whatever.blend, go to File -> Append Or Link
Navigate to where goodstart.blend is.
Go to the Objects folder, and click on the "marker" object.
To duplicate an object, in object mode, select and shift-D.
To rename your duplicated object, hit F9 and, towards the left,
where it says OB:Marker click in the middle of it and then
type "gunmount_0_light_medium" or whatever.

It is advisable to group the marker objects into a group called "marker". You are required to export all the markers into one obj file that needs to contain the name "marker" in it (letter case is unimportant, it can be "marker", or "Marker").

Object Helper naming convention: ''type_subtype_identifier''

with type:
* pilot (currently unused)
* mount (currently unused)
* turret
* subunit
* engine
* dock

and subtype being optional (convention tbd),
and identifier being either a number or a description and optional.

You may define for example:
* pilot
* pilot_john
* mount_lightmedium_0
* turret_capmissile_frontleft
* subunit_1
* engine_retro_left

===Exporting to OBJ+MTL===

===Updating Stats===
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
* [[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]

=Submission and Vetting=

=Technical Reference=

==Technical Specifications==

* [[HowTo:Edit BFXM files|Editing BFXM files (format spec)]]
* [[HowTo:Edit XMESH files|Editing the xmesh file of a ship]]
* [[HowTo:Edit units.csv|Editing units.csv]]
* [[HowTo:Add Engine Glow|Adding an engine glow to your 3D model]]

==Scripts and Tools==

See [[Development:Scripts_%26_Tools|Scripts & Tools]]
* [[HowTo:Add_Ships#New_method|mesher converter obj <-> bfxm <-> xmesh]]

=References=

* [http://wcpedia.com/dw/doku.php/wc_info/modding/index WCpedia Modeling Page]

[[Category:Development|Model Guidelines]]
[[Category:Modeling|Model Guidelines]]

Development:Model Guidelines

2011-04-04T08:43:31Z

Pyramid: /* Tutorials */

{{parent_link|parent=[[Development]]}}
= Introduction =

The intention of this document is to give artists using the Vega Strike engine some suggested guidelines to follow in creating models. You may also wish to have a look at the corresponding [[Development:Texture_Guidelines|texturing guidelines]].

So you want to create a new ship for Vega Strike, do you? While virtually all models are welcome, well before you start cranking out wonderfully designed models we request that you first check what models are still required.

{{warning_text |
| text='''Note:''' If you wish to contribute a new or updated model (ship, installation, turret, cockpit, ..) to the game Vega Strike, please see the [[Development:3D_Models|'''3D Models''']] page for models requiring attention.}}

Alternatively, contact [[User:jackS|jackS]] or [[User:pyramid|pyramid]].

= Modeling Pipeline Overview =

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98ffb2" |
|'''Step
|'''Input
|'''Output
|'''Tools
|'''Requirements
|'''Tutorials
|-

| Model Selection
| -
| required model
| model task list
| -
| -
|-

| Conceptualization
| selected model
| model concept
| pen & paper, artwork forum
| artstyle guide
| -
|-

| Modeling
| concept
| model mesh, obj + mtl files
| blender, forum
| many
| -
|-

| Texturing
| model mesh
| textures
| gimp, forum
| texture requirements
| -
|-

| Integration
| model + textures
| bfxm + dds textures
| mesher + UnitConverter
| -
| -
|-

| Testing
| bfxm model + dds textures
| bfxm + dds textures
| vegastrike + modelview.mission
| pass or rework
| -
|-

| Submission
| blender file (obj + mtl), master textures, bfxm + dds textures
| archive or svn
| mail, svn client
| -
| -
|}

=Model Requirements=

==Requirements Checklist==

Considerations for a successful model submission:
* Model is in the requirements list [[Development:3D_Models|->]]
* Abides to faction visual guidelines
* Has approved concept
* Provides model source file (blender, Wings3D, ...)
* Provides OBJ file
* Has model mesh, shield mesh, LoD meshes, helper meshes
* Provides uncompressed textures in png format (and optionally faction textures)
* Provides texture source files (GIMP, ...)
* Provides HUD png image with correct orientation
* Provides units.csv file entry

==Model Requirements Details==

==Visual Guidelines==

For particular aesthetic guidelines, please see the [[Artstyle guides]] page. Please note that many of the existing models are used because of expedience, not because they fit well with VS canon (i.e. if you make something new look like what's there, it still might not be what we're looking for). If in doubt, please ask on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

To absolutely sure, for new models, please create a drawing of your proposed concept and let it be discussed and approved on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

See also [[Development:Texture Guidelines]]

==Model File Format==
The preferred format for submission (for public disbursement - whatever native format is used inside your favorite modeling suite is fortunately a non-issue) is currently Wavefront OBJ file format, as this is the most easily converted between manipulation (assorted modeling tools) and presentation (currently BFXM, later to be the OGRE .mesh format). Model "source" therefore, is, at present (Sep. 2008), most usefully uploaded as .OBJ.

Until such a time as a visual model editing tool is completed, conversion to a game-ready format will likely pass through the .xmesh format for insertion of LOD references into top level mesh(es), correction of coordinate "handedness" (if the ordering of the coordinate axes is incompatible, as appears to happen with the output of some modeling tools).

See [[HowTo:Add_Ships]] for information on using mesher to convert to a presentation format (such as BFXM). Note that an old utility, objconv, is '''not''' mesher, and should not be used for this task. Source files for the mesher utility are included along with VS source. Windows users may download updated mesher binaries from their SVN interface of choice (the binary will be in the \bin directory).

==Polygon/Vertex Count==
In broadest terms, the desired polygon count for a particular model is dependent on three major factors:
*The amount of screen real-estate that the model is likely to be viewed at the majority of time that a user will be seeing it (i.e. a 2 meter long rocket doesn't deserve the same order of magnitude of attention to detail as a large base or vessel unless the rocket is expected to be mounted in front of a camera. Likewise, even at the same level of attention in terms of polygons per square meter, it would have far fewer total polygons.)
*The intrinsic surface complexity of the model. If one is modeling a box for freight cargo, one is not going to need as many polygons as if one needed to model one of the Vega Strike developers (not that we're necessarily model material ;-)). If you don't use enough polygons, no amount of texture magic can save a model from being ugly. That said, if you are modeling a cargo freight container and you use thousands of polygons, you're being negligent and wasteful of resources.
*Engine limitations. Engine limitations is a bit of a misnomer, as the performance of the graphical engine is more hardware dependent than anything else, but it's a good heading for lumping any non-artistic hurdles under. This is the most complicated of the three major factors, because it represents a moving target. Suffice it to say that in order to preserve playability on a broad range of systems, there is a premium placed on making a model aesthetically appropriate with the minimum number of polygons.

Rough guideline:
*Fighter: 15k triangles
*Corvette: 30k tris
*Cruiserer: 60k
*Carrier: 120k
*Space station: 250k

However, significant discression, and the possibility for using large numbers of polygons to prettify an object remain with the artist, provided they make appropriate use of [[Terminology:LODs|LODs]]. The primary focus needs to be on making a model aesthetically appropriate, for an intended common viewing distance, and then catering to the needs of the engine by introducing lower LODs (if necessary) and catering to artistic desires by introducing higher LODs (if appropriate). There is also an element of minor future proofing that occurs with providing a robust range of LOD poly counts - namely, multiple versions of the data set can be constructed targeted at different hardware points by shifting up or down along the LOD set (although this currently isn't bothered with, if and when we develop a true source repository for models and textures, this will likely become more common, as postprocessing of submitted art will become tenable).

One more point to consider before attempting to set a polygon goal for a model is what the likely total contribution from all instances on screen of a given model will be - if the model represents something particularly rare, then it is likely that a few more polygons can easily be spared on its model than for more common objects of otherwise similar size, complexity, etc.

Above all, use common sense - if it's visually hideous because it doesn't have enough polygons, it's not your top level model, and if it's in the 5 digit range for polygon count, it's not your lowest level LOD. Take into consideration how much screen real estate, based on the intended in-game size of the model (and if you don't have any idea how big it's supposed to be - you're doing something wrong already) the model will be taking up at various distances, and calibrate detail appropriately (this will become a much easier task once there is a visual modeling tool from the VS side) - to belabor the obvious, the difference between 500 polygons and 5000 gets somewhat obscured when the object is only drawn using 64 pixels. Note therefore that larger objects will often necessitate higher polygon counts merely because there's more of them to see.

(Note that there is no need to continue adding LODs beyond a point of "diminishing artistic returns" - if adding more detail won't help, don't bother. If adding detail helps, but is too expensive to be practical, then it may still be worthwhile for later inclusion as hardware resources increase.)

For small to moderate craft and installations, something along the lines of either of the following is not inappropriate:

(Exponential Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4000
*LOD 3 <= 8000
*LOD 4 <= 16000
*LOD 5 >16000

(Quadratic Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4500
*LOD 3 <= 8000
*LOD 4 <= 12500
*LOD 5 <= 18000
*LOD 6 >18000

Larger models, such as capital vessels and large installations will likely follow a similar curve, but at a higher offset, due to increased size. Truly massive models should be partitioned into multiple meshes, each with its own set of LODs such that nearer portions of the model can be independently represented at higher LOD than more distant ones. Partitioning into multiple meshes may be preferable even for merely "largish" models so as to preserve reasonable correspondence between single pixels and the size of represented features when texturing.

==Textures==

Texture maps should also be made accordingly, although clearly artistic integrity trivially trumps the following rough guideline (if you need more pixels, use them) and the appropriate texture size may depend greatly upon the size of the model.

*LOD 1 128x128
*LOD 2 256x256
*LOD 3 512x512
*LOD 4 1024x1024
*LOD 5 and up having multiple 1024x1024 textures

Be careful with ''texture lodding abuse''. Each LOD that uses its own texture will require more memory (video memory), and breaks batching between instances (slows down rendering of many instances of this model). Even so, texture lodding actually frees up memory most of the time, since only lesser versions are used in the distance. A general rule of thumb is to never have more than two or at most three versions of the same texture. Also take any opportunity to convert textures to greyscale when the color loss is not quite noticeable (most commonly with glow maps and specular maps).

Likewise, for larger models, do not neglect the potential addition of detail textures.

See also [[Development:Texture Guidelines]] and [[Development:Graphics_Requirements]].

===Faction Textures===

To include and successfully test faction textures in your data, you need to:
* set the corresponding vegastrike.config variable (<code>var name="faction_dependant_textures" value="1"</code>).
* prefix default textures with the faction name, e.g. when your default texture is called "tex_000.texture", to enable the faction texture for "pirates" you'll need to add the texture "pirates_tex_000.texture".
* change configuration to one of the 2 highest computer modes (512M+1GB or 1024MB).

==Shield and Collision Meshes==
Separate shield meshes are highly desirable. Shield meshes should also be done using LODs, although shield meshes should remain simple - that is, their top level meshes should not contain odious numbers of polygons for something that is only infrequently displayed.

Collision meshes need not (and cannot) have LODs. For complex models, it is wise to provide a dumbed-down version of the model that reasonably approximates its shape - minor features and greebles can be safely removed, for instance - to improve performance on the physics engine. Polycount should be kept to a minimum, '''without sacrificing any major features''' of the top-level LOD. Very small vessels (or appropriately shaped ones) may opt to not specify a collision mesh, which will make the physics layer treat this mesh as a spherical object (most efficient).

==HUD Image==

Provides perspective view of the model oriented with the nose towards the left-bottom corner of the image.
The master image resolution should start at 256x256 pixels with transparency around the vessel.

==See also==
For an example of an entity that is composed of multiple meshes, uses LODs, and shield meshes, examine the Clydesdale. (Note that shield and collision meshes are specified in the units.csv file, not by the model.)

=Model Creation=

The first (and most enjoyable) job is to design and draw your model (the geometrical object) within your program.

Feel free to use any modeling program, but it must be able to export models in either (Wavefront) .OBJ or (Vega Strike) .xmesh format. If you don't know where to start, see [[Links:3D Applications]] for a list of modeling software. [http://www.wings3d.com/ Wings 3D] is recommended for modeling beginners. [http://www.blender.org/ '''Blender'''] is the tool of choice for VS artistic community.

==Orientation==
First off, do yourself a favor and line your model up correctly before you begin. For the purposes of Vega Strike, Z+ is forwards and Y+ is up. The model's nose should be pointing forward along the Z+ axis (so that the Z+ axis would theoretically be visible from the cockpit). The mesh should also be properly centered.
Summing up:
* Z+ -> Forward direction
* Y+ -> Up direction
* Centered

== Tutorials==

{{warning_text |
| text='''Note:''' The tutorials overview is not complete. Many of the available tutorials have not yet been integrated into this page. Refer also to the [[HowTos|'''How-Tos Tutorials''']] page for additional tutorials.}}

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98b2ee" |
|'''Modeling Step
|'''Blender
|'''Wings3D
|-
| Create mesh
| -
| [[HowTo:Create Ships in Wings3D|Creating a 3D-model]]
|-
| Smoothing
| [[HowTo:Smooth Groups|Smoothing]] [[HowTo:Weld|Smooth Welding]]
| -
|-
| Mesh cleanup
| [[HowTo:Bevel|Beveling]]
| -
|-
| Unwrapping
| [[HowTo:Unwrap_in_Blender|Unwrapping 1]] [[HowTo:Unwrap|Unwrapping 2]] [[HowTo:FullUnwrapBlender|Ship unwrap]]
| -
|-
| Radiosity Baking
| [[HowTo:Radiosity baking in Blender|Radiosity baking]]
| -
|-
| Exporting
| -
| -
|}

This articles are WIP, means still need to be reviewed and decided how to restructure them:
* [[HowTo:Create Cockpit in Wings3d|Creating a 3D cockpit for your ship.]]
* [[HowTo:Add LODs|Adding Levels of Detail]]
* [[HowTo:Add Ships|Adding your ship to Vega Strike]] - An overview of how to create and add ships to the game
* [[HowTo:Create Models]] - Links to forum discussions. Page will become generic model creation tutorial.
* Modeling Tutorials: [[HowTos#Modeling]]

===Blender Basics===
* [[HowTo:Basic Blender Tutorial|A basic Blender3D tutorial]]: [http://www.cdschools.org/54223045235521/blank/browse.asp?A=383&BMDRN=2000&BCOB=0&C=55205 Blender Basics - 3rd Edition] - not specific to ships, though...

===Wings3D Basics===

===Other Software Basics===

* [[HowTo:Model a Ship|Brad Mick's video tutorial on ship modeling]] - using Lightwave, but the concept is general: ''Rapid Prototyping''

=Texture Creation=

==Unwrapping==

Please make non-overlapping UV unwraps for all future models. You can't bake a proper AO with overlapping islands.

==Unsorted==

(general guidelines, tips, best practices, app specific tutorials, ...)

* [http://netzwelt.gaming-hut.de/vegatexturing/ WIP VegaStrike texturing page by Major]
* [http://edice.netfirms.com/tuts/texturetut.htm Texturing tutorial by Duality]

For the time being, you may wish to have a look at the corresponding [[Development:Texture_Guidelines|Texturing Guidelines]].

* [[Development:Texture Guidelines|Guidelines for creating ship materials]]

* [[HowTo:Add Per Pixel Lighting|Adding per-pixel lighting to your 3D model]]
* [[HowTo:IntroToShaders|Introduction to shaders, and what they mean for you]] --Bumpmaps, Normalmaps, Shininess maps ...

* [[HowTo:Texture|Creating your own textures]] - A summary on how to make texture maps
* [[HowTo:Texture in Wings3d|Texturing your model in Wings 3d]]
* [[HowTo:SuperrealisticTexturing|Tips for realistic-looking textures]]
* [[HowTo:Make Animated Textures|Using animated textures on a model]]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/texturing_noodle LaGrande Noodle]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/ao_and_prt_bakes AO and PRT bakes, using Blender and xNormal]

=Integration and Testing=

Using UnitConverter to convert all files and edit the model stats for Vega Strike:
[[Development:Tools:UnitConverter]]

===Object Marker===
In order to automatically create turret mounts, gun mounts, and engine thrusters placements in units.csv, please use the following marker:

[author:chuck_starchaser] Here's a blend file people could load and save as the default blender start.
Starts with a marker smack in the middle.
You can move it to another layer, later duplicate it as needed to place copies at key locations.
http://wcjunction.com/temp_images/cinemut/goodstart.blend
You can also import the marker into another blend file:
Open whatever.blend, go to File -> Append Or Link
Navigate to where goodstart.blend is.
Go to the Objects folder, and click on the "marker" object.
To duplicate an object, in object mode, select and shift-D.
To rename your duplicated object, hit F9 and, towards the left,
where it says OB:Marker click in the middle of it and then
type "gunmount_0_light_medium" or whatever.

It is advisable to group the marker objects into a group called "marker". You are required to export all the markers into one obj file that needs to contain the name "marker" in it (letter case is unimportant, it can be "marker", or "Marker").

Object Helper naming convention: ''type_subtype_identifier''

with type:
* pilot (currently unused)
* mount (currently unused)
* turret
* subunit
* engine
* dock

and subtype being optional (convention tbd),
and identifier being either a number or a description and optional.

You may define for example:
* pilot
* pilot_john
* mount_lightmedium_0
* turret_capmissile_frontleft
* subunit_1
* engine_retro_left

===Updating Stats===
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
* [[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]

=Submission and Vetting=

=Technical Reference=

==Technical Specifications==

* [[HowTo:Edit BFXM files|Editing BFXM files (format spec)]]
* [[HowTo:Edit XMESH files|Editing the xmesh file of a ship]]
* [[HowTo:Edit units.csv|Editing units.csv]]
* [[HowTo:Add Engine Glow|Adding an engine glow to your 3D model]]

==Scripts and Tools==

See [[Development:Scripts_%26_Tools|Scripts & Tools]]
* [[HowTo:Add_Ships#New_method|mesher converter obj <-> bfxm <-> xmesh]]

=References=

* [http://wcpedia.com/dw/doku.php/wc_info/modding/index WCpedia Modeling Page]

[[Category:Development|Model Guidelines]]
[[Category:Modeling|Model Guidelines]]

Development

2011-04-03T15:13:49Z

Pyramid: /* Game Assets */

{{Wiki_Nav_Index}}

=Development & Modding=

==Developer information pages==
General information on contribution:
* [[HowTo:Contribute|The Vega Strike Contributor's Guide]]
* [[Database:GPUs|GPU information database]]
* [[HowTo:MOD|How to create MODs]]
* [[Development:File_Structure|File and Directory Structure]]

==Status/task list pages==
* [[Development:3D_Models|3D Models]] - Organisation and contribution information.
* [[Development:2D_Images|2D Images]] - Organisation and contribution information.
* [[Development:Roadmap|Roadmap]] - The Vega Strike development roadmap.
* [[Development:Compatibility]] - Making sure the game works on all hardware
* [[Development:Rebalance]] - Information and task list for the Rebalance.
* [[Development:Performance]] - Goals to achieve required performance
* [[Development:AI Navigation]] - Overhauling the ships' navigation routines
* [[Development:Misc Engine Work]] - Various engine and backend work information.
* [[Development:Ogre]] - Information on the OGRE port.

= Artistic Contribution =

===Art Guidelines===
Please read this '''[[Development:Graphics_Requirements]]''' page first before continuing to the specific requirements.
See also: [[Links:Graphic_Applications]] and [[Links:3D_Applications]] for applications listings.

Further, the [[Artstyle_guides|Art Style Guides]] might prove useful during your creationist endeavors.

===Audio===
There are also guidelines for sound and music creation available in '''[[Development:Audio]]'''.

===3D Models===
The modeling related information is just being restructured.
* [[Development:Model Guidelines|Guidelines Portal for Creating 3D Models]] is the main page for complete guidance on developing ship and installation models for Vega Strike
** [[Development:3D_Models|3D models list and status]]

=== Space Scapes ===
* [[Development:Orbital Planet Surfaces|Orbital Planet Surfaces]] - General guidance for development of planet surfaces visible from orbit.
* [[Development:System_Backgrounds|Generating star system backgrounds]]
* [[Development:Base_Backgrounds|Creating and adding backgrounds for bases, planets, or capital ships]]

=== Cargo ===
* [[Development:Cargo (graphics)|Creating Cargo Graphics]] - Images to be displayed in the trading interface for cargo items.
** [[Cargo]] - Detailed descriptions of cargo items, listed by category.
* [[Development:Balancing|Faction Balancing]] - General guidelines to keep in mind when play balancing the Vega Strike factions.

=== Other Graphics ===
* [[Development:Logos & Signage|Logos & Signage]]

= Python Scripting =

=== Quests & Campaigns ===
* [[Development:Quests_&_Campaigns|Quests & Campaigns]] Reference portal for creation of campaigns, missions, quests & adventures.
** [[Development:Quests|Quests]] Creating quests and adventures
** [[Development:Missions|Developing Missions]] Creation of missions
** [[Development:AIScripts|Developing AI Behaviors]] Customizing AI combat reactions
** [[Development:Campaigns]] Making campaigns

=== Other Scripts ===
* [[HowTo:Edit News|Editing News]]
* [[HowTo:Add Conversations|Adding Conversations]]
* [[Development:Base_Backgrounds|Changing Base Backgrounds and Base Computer GUI]]

= Data Modding =

=== Game Assets ===
* [[HowTo:Edit_units.csv| Editing units.csv]]
* [[HowTo:Make Weapons|Adding new weapons to the game]]
* [[HowTo:Add Cargo|Adding new cargo to the game]]
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
**[[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]
* [[HowTo:Edit Systems|Creating or editing star systems]]
* [[HowTo:Make Splash Screens|Making splash screens that display at startup]]
* [[HowTo:Edit faction relationships|Edit the relationships between the existing factions]] (the <code>factions.xml</code> file)
* [[HowTo:Add Upgrades|Adding new upgrades to the game]]
* [[HowTo:Nav Computer Interface|Edit the navigation computer interface]]

=== Events ===
* [[HowTo:Add Conversations|Adding more conversation lines to the game]]
* [[HowTo:Edit News|Creating or editing news events]]
* [[HowTo:Edit AI|Creating or editing Ship AI's]]

===Configuration ===
* [[Manual:Config:Advanced:Variables|Configuration Variables]]
* [[CONFVAR|CONFVAR - Complete Variable Listing]]

===Internationalization/Localisation-related===
* [[Development:Translations|Translation projects]]

=== Modding Tools ===
* [[Development:Scripts & Tools|Scripts & Tools]] - to make your life easier
** [[Development:Tools:UnitConverter|Unit Converter Manual]] - tool to convert Wavefront obj files to bfxm format including texture conversion, units stats editor, and visualization with Vega Strike.
** [[Development:Script:obj2obj converter|obj2obj converter]] (Perl, commandline) - Converts obj files to cockpit files. or extracts tag-data from the models. (''At least that's what is planned, Testing under Win32/Linux. [[User:pontiac|Pontiac]]'')
* [[OOG_Tools|Out-Of-Game Player Tools]]

=== Front End ===
* [[HowTo:Take Screenshots|Taking really awesome screenshots]]

= Vega Strike The Game Mechanisms =
* [[Development:Realism vs Believability|Realism vs Believability]]
* [[Development:Economy|Economy]] - How ingame economy should work.
* [[Development:Political system|Political system]]

= Code-related Development =
* [[Development:Dependencies|Dependencies]] - A guide to system dependencies, broken down by subsystem.
* [[Development:SVN Tree|SVN Tree]] - A guide to the layout of the Subversion tree.
* [[Development:Code style|Code style]] - A guide/manual to write code for Vegastrike that fits in and is readable.
* [[Development:Network|Network]] - Everything network related goes in here.
** [[Development:Network:Packet format|Packet format]] - A description of the packet format that had been implemented a few years ago.
** [[Development:Network:Todo|Todo]] - What still needs to be done.
** [[Development:Network:Testing|Testing]] - Testing the network code.
* [[Development:Keyboard layout|Keyboard layout]] - Discuss and display new keyboard layouts here.

=See also=
* [[HowTos]]
* [[FAQ:Feature_Requests|Feature Requests]]
* [[Development:Audio#Voice_Acting]]

[[Category:Development]]

Development:Campaigns

2011-04-03T14:42:54Z

Pyramid: /* Nodes */

{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}
----
=Editing Campaigns=

'''''Note:''' The information contained here is useful only to those willing to learn a minimal amount of python code (the language does not need to be learned, only the formatting restrictions imposed). A GUI based campaign editor is in development, but work has stalled due to lack of time on the developer's part. If anyone wishes to assist, please contact [[User:dandandaman|dandandaman]].''

An example campaign can be found under the following [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/modules/campaigns.py?view=markup link]

To write a campaign, you'll require missions. The mission system is what is used by both the mission bbs, and the campaign. As a start, it is good to plan to use only the mission types available, as writing your own can be a pain, and requires a degree of proficiency with python and vegastrike which you may not have for a little while. If you are developing a campaign and do require something specific that isn't available, just ask, and we'll see what can be done.

Since you are then limited to the missions we have, you'll want a nice reference about what each of the variables for each mission are ... and what they do. We don't actually have one ;-) but we have something that is almost as good: verify_missions.py At the bottom of this file is a list of the mission types, and slightly more descriptive labels for the arguments (their meanings should be relatively easy to glean from that info, but ask if you're unsure :-) ).

That is unfortunately the easy part. The harder part (easy once you understand it) is then writing the campaign. The campaign for Vega Strike is stored in campaigns.py.

Before we proceed I think it's best if you look at this stuff and try to understand a little bit yourself. At the top of campaigns.py is a whole bunch of text, the dialog and strings used by all the various campaign 'nodes.'

A 'node' is a branch of a campaign, it is where fixers get created and the decision to accept or deny a mission occurs, or where the campaign is branched automatically (depending on some conditions that you might want to specify. I.e. you might have a branching storyline depending on whether a flight group still exists or not).

Typically, each node contains a mission ... Cargo missions are a special case, they have a special type of node wrapper, and are probably the easiest to start with. Anyway, get yourself a text editor with syntax highlighting for python, and have a look at the nodes in the function ''LoadTestCampaign'' (this is a short test campaign that I made to demonstrate a bug).

There was more documentation somewhere, but it appears to have been vanquished. So, ask the inevitable questions!

=Campaign Structure=

==Campaign Integration==

You will need to create a new campaign python file (e.g. ''campaign_mycamp.py''), which then will be integrated into the ''campaigns.py'' with the following additions:
<code><pre>
import campaign_mycampaign

campaignsloaders = [ ...
lambda:campaign_mycamp.LoadMyCampaign()
]
</pre></code>

The basic structure of your new ''campaign_mycamp.py'' file will then be:

<code><pre>
import universe
import campaign_lib
from campaign_lib import *

### define node dialogs
...

### define fixer sprites
...

def LoadMyCampaign():

### define nodes
...

# savegame_variable (can't contain spaces)
vs = Campaign("campaign_mycamp")
# the starting node.
vs.Init(FirstNode)

### define node missions
...

# finalize campaign definition
return vs
</pre></code>

= Campaign Missions =

==Nodes==

There are 2 types of nodes:
* ''CampaignClickNode(args)'' - here you have to talk to a fixer and accept or reject the proposed mission.
* ''CampaignNode(args)'' - creates an action, like adding reward or adjusting a faction relation, without fixer intervention.
* ''CampaignChoiceNode(args)''

Nodes must be initialized first:

<code><pre>
ThisNode = CampaignClickNode() # initialize the node
ActionNode = CampaignNode()
</pre></code>

The nodes are then connected with the last four arguments in the ''MakeMission'' function:
<code><pre>MakeMission(vs, ...
RejectNode, # If you reject the mission twice. "None" means that he continues asking you forever until you accept
LoseNode, # Node if you lose the mission
WinNode, # Node if you win the mission
ThisNode) # The node for this mission
</pre></code>

The complete mission statement and the different types of mission nodes that can be created are described in the following section. Further down, you will find the singular structure of the arguments.

==MakeMission Node==
<code><pre>MakeMission(savegame_variable, fixer_sprite, start_location, end_location, click_script,
mission_script, mission_arguments, completion_script, dialog_dictionary, reject_node, lose_node,
win_node, this_node)</pre></code>

==MakeCargoMission Node==
<code><pre>MakeCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==MakeNoFailureCargoMission Node==
<code><pre>MakeNoFailureCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==Init Node==
<code><pre>NodeName.Init(savegame_variable, start_location, dialog_dictionary, fixer_sprite,
subnode_script, completion_script, next_node)</pre></code>

==Mission Arguments==

* '''savegame_variable''' - usually ''vs''
* '''fixer_sprite''' - sprite file for the fixer in the form (sprite_path, display_name, full_screen_sprite), e.g. ''("campaign/captain.sprite","Talk_To_The_Captain","campaign/heads/captain.sprite")''
* '''start_location''' - a command for location checking containing a tuple with (sector/system, base), e.g. ''[InSystemCondition("Crucible/Cephid_17","Serenity")]''
* '''end_location''' - same format as start_location
* '''click_script''' - script to be run as you click on the fixer. A common use is to ''AddCredits()'' for the previous mission.
* '''mission_script''' - script to be run to start the mission (usually ''None'' if you don't have a script, but ambush is also common.)
* '''mission_arguments''' - depend on the mission. E.g. for cargo mission you will give the loaded cargo as arguments: ''("Recycled_Plastics",50,False)''
* '''completion_script''' - script to be set on completion (-1=Failure, 0=Not Accepted, 1=Succeed, 2=In progress), often just ''vs.name+"_mission"''
* '''dialog_dictionary''' - the lines that the fixer says: a dictionary with {dialog_type, dialog_lines_list}, see structure description further down
* '''reject_node''' - name of the node if you reject the mission twice. "None" means that fixer continues asking you forever until you accept
* '''lose_node''' - next node if you are unsuccessful in the mission
* '''win_node''' - next node if you successfully complete the mission
* '''this_node''' - name of the node for this mission, e.g. ''FirstNode''

= Subnodes =

* TrueSubnode
* GoToSubnode
* GoToSubnodeIfTrue
* TrueBackwardsSubnode

= Conditions =

* SaveVariableCondition
* HaveCredits
* InSystemCondition
* HasUndocked
* CargoSpaceCondition
* AtMostActiveMissionsCondition
* AtLeastActiveMissionsCondition
* OrCondition
* AndCondition
* InvertCondition

= Scripts =

Scripts and script arguments can be seen in ''data/modules/campaign_lib.py''.
The usual arguments are: (scriptarguments, nextscript), where the next script can be omitted and is nested as the last script argument.

* AddCredits(numcreds,nextscript)
* AddCargo(name,num,missionflag,nextscript)
* RemoveCargo(name,num,missionflag,nextscript)
* SetSaveVariable(varname,varvalue,nextscript)
* IncSaveVariable(varname,nextscript)
* AddTechnology(technology,nextscript)
* AdjustRelation(us,them,change,nextscript)
* ClearFactionRecord(fac,newrelation,nextscript)
* ClearRecord(nextscript)
* PushRelation(faction,nextscript)
* PopRelation(faction,nextscript)
* LaunchWingmen(faction,shiptype,num,nextscript)
* ChangeSystemOwner(system,faction,nextscript)
* SaveVariableGreaterScript(var,val,nextscript)
* DisplayTextIfTrueScript(text,nextscript)
* RemoveCredits(numcreds,nextscript)
* SetCredits(numcreds,nextscript)
* PushCredits(nextscript)
* PopCredits(nextscript)
* PushNews(story,nextscript)
* LoadMission(name,missionname,missionargs,nextscript=None,briefing='',briefing_done='',vars=None,vars_done=None)
* AddSprite(name,sprite,pos,nextscript)
* AddPythonSprite(name,sprite,center_position,widthheight,text,python,nextscript)
* AddRemovingSprite
* AddConversationStoppingSprite
* GoToSubnodeIfTrue
* TrueSubnode
* TrueBackwardsSubnode
* GoToSubnode

Remarks:
* relation is saved as two bidirectional values ranging from -0.5 to 1.0 in a variable "Relation_to_''factionname''" with two float values appended. One is the players relation to that faction, the second is the faction relation to the player.

= Dialogs =

The structure for the ''dialog_dictionary'' is as follows:

<code><pre>
dialog_dictionary = {
"intro": [conversation],
"reject1": [conversation],
"reconsider":[conversation],
"reject2": [conversation],
"accept": [conversation],
"accept2": [conversation],
"reminder": [conversation],
"failure": [conversation],
}

with:
conversation = (speaker1, line1, ...), (speaker2, line1, ...), ..., soundfile
</pre></code>

For Init Nodes you will supply only one ''[conversation]''.

= Examples =

==The first major campaign written (Jenek)==

See also the [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=3246 forum thread] (comments & feedback) when this mission was first put into SVN.
{{Fixme}} Improve/expand it?

==Ending Node with AddCredits and AdjustRelation==

<code><pre>
FinalNode.Init(vs, # savegame variable
[], #start location
[], #dialog
None, # fixer sprite
TrueSubnode(AddCredits(100000,AdjustRelation("privateer","pirates",0.01))), # subnode script
None, # completion script
[CampaignEndNode(vs)]) # continue with next mission
</pre></code>

=See Also=
* [[Development:Missions|Editing Missions]]
* [[HowTo:Add_Conversations|Adding Conversations]]

----
{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}

[[Category:HowTos|Edit Campaigns]]
[[Category:Development|Edit Campaigns]]

Development:Campaigns

2011-04-03T14:35:37Z

Pyramid: /* Conditions */

{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}
----
=Editing Campaigns=

'''''Note:''' The information contained here is useful only to those willing to learn a minimal amount of python code (the language does not need to be learned, only the formatting restrictions imposed). A GUI based campaign editor is in development, but work has stalled due to lack of time on the developer's part. If anyone wishes to assist, please contact [[User:dandandaman|dandandaman]].''

An example campaign can be found under the following [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/modules/campaigns.py?view=markup link]

To write a campaign, you'll require missions. The mission system is what is used by both the mission bbs, and the campaign. As a start, it is good to plan to use only the mission types available, as writing your own can be a pain, and requires a degree of proficiency with python and vegastrike which you may not have for a little while. If you are developing a campaign and do require something specific that isn't available, just ask, and we'll see what can be done.

Since you are then limited to the missions we have, you'll want a nice reference about what each of the variables for each mission are ... and what they do. We don't actually have one ;-) but we have something that is almost as good: verify_missions.py At the bottom of this file is a list of the mission types, and slightly more descriptive labels for the arguments (their meanings should be relatively easy to glean from that info, but ask if you're unsure :-) ).

That is unfortunately the easy part. The harder part (easy once you understand it) is then writing the campaign. The campaign for Vega Strike is stored in campaigns.py.

Before we proceed I think it's best if you look at this stuff and try to understand a little bit yourself. At the top of campaigns.py is a whole bunch of text, the dialog and strings used by all the various campaign 'nodes.'

A 'node' is a branch of a campaign, it is where fixers get created and the decision to accept or deny a mission occurs, or where the campaign is branched automatically (depending on some conditions that you might want to specify. I.e. you might have a branching storyline depending on whether a flight group still exists or not).

Typically, each node contains a mission ... Cargo missions are a special case, they have a special type of node wrapper, and are probably the easiest to start with. Anyway, get yourself a text editor with syntax highlighting for python, and have a look at the nodes in the function ''LoadTestCampaign'' (this is a short test campaign that I made to demonstrate a bug).

There was more documentation somewhere, but it appears to have been vanquished. So, ask the inevitable questions!

=Campaign Structure=

==Campaign Integration==

You will need to create a new campaign python file (e.g. ''campaign_mycamp.py''), which then will be integrated into the ''campaigns.py'' with the following additions:
<code><pre>
import campaign_mycampaign

campaignsloaders = [ ...
lambda:campaign_mycamp.LoadMyCampaign()
]
</pre></code>

The basic structure of your new ''campaign_mycamp.py'' file will then be:

<code><pre>
import universe
import campaign_lib
from campaign_lib import *

### define node dialogs
...

### define fixer sprites
...

def LoadMyCampaign():

### define nodes
...

# savegame_variable (can't contain spaces)
vs = Campaign("campaign_mycamp")
# the starting node.
vs.Init(FirstNode)

### define node missions
...

# finalize campaign definition
return vs
</pre></code>

= Campaign Missions =

==Nodes==

There are 2 types of nodes:
* ''CampaignClickNode()'' - here you have to talk to a fixer and accept or reject the proposed mission.
* ''CampaignNode()'' - creates an action, like adding reward or adjusting a faction relation, without fixer intervention.

Nodes must be initialized first:

<code><pre>
ThisNode = CampaignClickNode() # initialize the node
ActionNode = CampaignNode()
</pre></code>

The nodes are then connected with the last four arguments in the ''MakeMission'' function:
<code><pre>MakeMission(vs, ...
RejectNode, # If you reject the mission twice. "None" means that he continues asking you forever until you accept
LoseNode, # Node if you lose the mission
WinNode, # Node if you win the mission
ThisNode) # The node for this mission
</pre></code>

The complete mission statement and the different types of mission nodes that can be created are described in the following section. Further down, you will find the singular structure of the arguments.

==MakeMission Node==
<code><pre>MakeMission(savegame_variable, fixer_sprite, start_location, end_location, click_script,
mission_script, mission_arguments, completion_script, dialog_dictionary, reject_node, lose_node,
win_node, this_node)</pre></code>

==MakeCargoMission Node==
<code><pre>MakeCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==MakeNoFailureCargoMission Node==
<code><pre>MakeNoFailureCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==Init Node==
<code><pre>NodeName.Init(savegame_variable, start_location, dialog_dictionary, fixer_sprite,
subnode_script, completion_script, next_node)</pre></code>

==Mission Arguments==

* '''savegame_variable''' - usually ''vs''
* '''fixer_sprite''' - sprite file for the fixer in the form (sprite_path, display_name, full_screen_sprite), e.g. ''("campaign/captain.sprite","Talk_To_The_Captain","campaign/heads/captain.sprite")''
* '''start_location''' - a command for location checking containing a tuple with (sector/system, base), e.g. ''[InSystemCondition("Crucible/Cephid_17","Serenity")]''
* '''end_location''' - same format as start_location
* '''click_script''' - script to be run as you click on the fixer. A common use is to ''AddCredits()'' for the previous mission.
* '''mission_script''' - script to be run to start the mission (usually ''None'' if you don't have a script, but ambush is also common.)
* '''mission_arguments''' - depend on the mission. E.g. for cargo mission you will give the loaded cargo as arguments: ''("Recycled_Plastics",50,False)''
* '''completion_script''' - script to be set on completion (-1=Failure, 0=Not Accepted, 1=Succeed, 2=In progress), often just ''vs.name+"_mission"''
* '''dialog_dictionary''' - the lines that the fixer says: a dictionary with {dialog_type, dialog_lines_list}, see structure description further down
* '''reject_node''' - name of the node if you reject the mission twice. "None" means that fixer continues asking you forever until you accept
* '''lose_node''' - next node if you are unsuccessful in the mission
* '''win_node''' - next node if you successfully complete the mission
* '''this_node''' - name of the node for this mission, e.g. ''FirstNode''

= Subnodes =

* TrueSubnode
* GoToSubnode
* GoToSubnodeIfTrue
* TrueBackwardsSubnode

= Conditions =

* SaveVariableCondition
* HaveCredits
* InSystemCondition
* HasUndocked
* CargoSpaceCondition
* AtMostActiveMissionsCondition
* AtLeastActiveMissionsCondition
* OrCondition
* AndCondition
* InvertCondition

= Scripts =

Scripts and script arguments can be seen in ''data/modules/campaign_lib.py''.
The usual arguments are: (scriptarguments, nextscript), where the next script can be omitted and is nested as the last script argument.

* AddCredits(numcreds,nextscript)
* AddCargo(name,num,missionflag,nextscript)
* RemoveCargo(name,num,missionflag,nextscript)
* SetSaveVariable(varname,varvalue,nextscript)
* IncSaveVariable(varname,nextscript)
* AddTechnology(technology,nextscript)
* AdjustRelation(us,them,change,nextscript)
* ClearFactionRecord(fac,newrelation,nextscript)
* ClearRecord(nextscript)
* PushRelation(faction,nextscript)
* PopRelation(faction,nextscript)
* LaunchWingmen(faction,shiptype,num,nextscript)
* ChangeSystemOwner(system,faction,nextscript)
* SaveVariableGreaterScript(var,val,nextscript)
* DisplayTextIfTrueScript(text,nextscript)
* RemoveCredits(numcreds,nextscript)
* SetCredits(numcreds,nextscript)
* PushCredits(nextscript)
* PopCredits(nextscript)
* PushNews(story,nextscript)
* LoadMission(name,missionname,missionargs,nextscript=None,briefing='',briefing_done='',vars=None,vars_done=None)
* AddSprite(name,sprite,pos,nextscript)
* AddPythonSprite(name,sprite,center_position,widthheight,text,python,nextscript)
* AddRemovingSprite
* AddConversationStoppingSprite
* GoToSubnodeIfTrue
* TrueSubnode
* TrueBackwardsSubnode
* GoToSubnode

Remarks:
* relation is saved as two bidirectional values ranging from -0.5 to 1.0 in a variable "Relation_to_''factionname''" with two float values appended. One is the players relation to that faction, the second is the faction relation to the player.

= Dialogs =

The structure for the ''dialog_dictionary'' is as follows:

<code><pre>
dialog_dictionary = {
"intro": [conversation],
"reject1": [conversation],
"reconsider":[conversation],
"reject2": [conversation],
"accept": [conversation],
"accept2": [conversation],
"reminder": [conversation],
"failure": [conversation],
}

with:
conversation = (speaker1, line1, ...), (speaker2, line1, ...), ..., soundfile
</pre></code>

For Init Nodes you will supply only one ''[conversation]''.

= Examples =

==The first major campaign written (Jenek)==

See also the [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=3246 forum thread] (comments & feedback) when this mission was first put into SVN.
{{Fixme}} Improve/expand it?

==Ending Node with AddCredits and AdjustRelation==

<code><pre>
FinalNode.Init(vs, # savegame variable
[], #start location
[], #dialog
None, # fixer sprite
TrueSubnode(AddCredits(100000,AdjustRelation("privateer","pirates",0.01))), # subnode script
None, # completion script
[CampaignEndNode(vs)]) # continue with next mission
</pre></code>

=See Also=
* [[Development:Missions|Editing Missions]]
* [[HowTo:Add_Conversations|Adding Conversations]]

----
{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}

[[Category:HowTos|Edit Campaigns]]
[[Category:Development|Edit Campaigns]]

Development:Campaigns

2011-04-03T14:32:45Z

Pyramid: /* Nodes */

{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}
----
=Editing Campaigns=

'''''Note:''' The information contained here is useful only to those willing to learn a minimal amount of python code (the language does not need to be learned, only the formatting restrictions imposed). A GUI based campaign editor is in development, but work has stalled due to lack of time on the developer's part. If anyone wishes to assist, please contact [[User:dandandaman|dandandaman]].''

An example campaign can be found under the following [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/modules/campaigns.py?view=markup link]

To write a campaign, you'll require missions. The mission system is what is used by both the mission bbs, and the campaign. As a start, it is good to plan to use only the mission types available, as writing your own can be a pain, and requires a degree of proficiency with python and vegastrike which you may not have for a little while. If you are developing a campaign and do require something specific that isn't available, just ask, and we'll see what can be done.

Since you are then limited to the missions we have, you'll want a nice reference about what each of the variables for each mission are ... and what they do. We don't actually have one ;-) but we have something that is almost as good: verify_missions.py At the bottom of this file is a list of the mission types, and slightly more descriptive labels for the arguments (their meanings should be relatively easy to glean from that info, but ask if you're unsure :-) ).

That is unfortunately the easy part. The harder part (easy once you understand it) is then writing the campaign. The campaign for Vega Strike is stored in campaigns.py.

Before we proceed I think it's best if you look at this stuff and try to understand a little bit yourself. At the top of campaigns.py is a whole bunch of text, the dialog and strings used by all the various campaign 'nodes.'

A 'node' is a branch of a campaign, it is where fixers get created and the decision to accept or deny a mission occurs, or where the campaign is branched automatically (depending on some conditions that you might want to specify. I.e. you might have a branching storyline depending on whether a flight group still exists or not).

Typically, each node contains a mission ... Cargo missions are a special case, they have a special type of node wrapper, and are probably the easiest to start with. Anyway, get yourself a text editor with syntax highlighting for python, and have a look at the nodes in the function ''LoadTestCampaign'' (this is a short test campaign that I made to demonstrate a bug).

There was more documentation somewhere, but it appears to have been vanquished. So, ask the inevitable questions!

=Campaign Structure=

==Campaign Integration==

You will need to create a new campaign python file (e.g. ''campaign_mycamp.py''), which then will be integrated into the ''campaigns.py'' with the following additions:
<code><pre>
import campaign_mycampaign

campaignsloaders = [ ...
lambda:campaign_mycamp.LoadMyCampaign()
]
</pre></code>

The basic structure of your new ''campaign_mycamp.py'' file will then be:

<code><pre>
import universe
import campaign_lib
from campaign_lib import *

### define node dialogs
...

### define fixer sprites
...

def LoadMyCampaign():

### define nodes
...

# savegame_variable (can't contain spaces)
vs = Campaign("campaign_mycamp")
# the starting node.
vs.Init(FirstNode)

### define node missions
...

# finalize campaign definition
return vs
</pre></code>

= Campaign Missions =

==Nodes==

There are 2 types of nodes:
* ''CampaignClickNode()'' - here you have to talk to a fixer and accept or reject the proposed mission.
* ''CampaignNode()'' - creates an action, like adding reward or adjusting a faction relation, without fixer intervention.

Nodes must be initialized first:

<code><pre>
ThisNode = CampaignClickNode() # initialize the node
ActionNode = CampaignNode()
</pre></code>

The nodes are then connected with the last four arguments in the ''MakeMission'' function:
<code><pre>MakeMission(vs, ...
RejectNode, # If you reject the mission twice. "None" means that he continues asking you forever until you accept
LoseNode, # Node if you lose the mission
WinNode, # Node if you win the mission
ThisNode) # The node for this mission
</pre></code>

The complete mission statement and the different types of mission nodes that can be created are described in the following section. Further down, you will find the singular structure of the arguments.

==MakeMission Node==
<code><pre>MakeMission(savegame_variable, fixer_sprite, start_location, end_location, click_script,
mission_script, mission_arguments, completion_script, dialog_dictionary, reject_node, lose_node,
win_node, this_node)</pre></code>

==MakeCargoMission Node==
<code><pre>MakeCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==MakeNoFailureCargoMission Node==
<code><pre>MakeNoFailureCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==Init Node==
<code><pre>NodeName.Init(savegame_variable, start_location, dialog_dictionary, fixer_sprite,
subnode_script, completion_script, next_node)</pre></code>

==Mission Arguments==

* '''savegame_variable''' - usually ''vs''
* '''fixer_sprite''' - sprite file for the fixer in the form (sprite_path, display_name, full_screen_sprite), e.g. ''("campaign/captain.sprite","Talk_To_The_Captain","campaign/heads/captain.sprite")''
* '''start_location''' - a command for location checking containing a tuple with (sector/system, base), e.g. ''[InSystemCondition("Crucible/Cephid_17","Serenity")]''
* '''end_location''' - same format as start_location
* '''click_script''' - script to be run as you click on the fixer. A common use is to ''AddCredits()'' for the previous mission.
* '''mission_script''' - script to be run to start the mission (usually ''None'' if you don't have a script, but ambush is also common.)
* '''mission_arguments''' - depend on the mission. E.g. for cargo mission you will give the loaded cargo as arguments: ''("Recycled_Plastics",50,False)''
* '''completion_script''' - script to be set on completion (-1=Failure, 0=Not Accepted, 1=Succeed, 2=In progress), often just ''vs.name+"_mission"''
* '''dialog_dictionary''' - the lines that the fixer says: a dictionary with {dialog_type, dialog_lines_list}, see structure description further down
* '''reject_node''' - name of the node if you reject the mission twice. "None" means that fixer continues asking you forever until you accept
* '''lose_node''' - next node if you are unsuccessful in the mission
* '''win_node''' - next node if you successfully complete the mission
* '''this_node''' - name of the node for this mission, e.g. ''FirstNode''

= Subnodes =

* TrueSubnode
* GoToSubnode
* GoToSubnodeIfTrue
* TrueBackwardsSubnode

= Conditions =

= Scripts =

Scripts and script arguments can be seen in ''data/modules/campaign_lib.py''.
The usual arguments are: (scriptarguments, nextscript), where the next script can be omitted and is nested as the last script argument.

* AddCredits(numcreds,nextscript)
* AddCargo(name,num,missionflag,nextscript)
* RemoveCargo(name,num,missionflag,nextscript)
* SetSaveVariable(varname,varvalue,nextscript)
* IncSaveVariable(varname,nextscript)
* AddTechnology(technology,nextscript)
* AdjustRelation(us,them,change,nextscript)
* ClearFactionRecord(fac,newrelation,nextscript)
* ClearRecord(nextscript)
* PushRelation(faction,nextscript)
* PopRelation(faction,nextscript)
* LaunchWingmen(faction,shiptype,num,nextscript)
* ChangeSystemOwner(system,faction,nextscript)
* SaveVariableGreaterScript(var,val,nextscript)
* DisplayTextIfTrueScript(text,nextscript)
* RemoveCredits(numcreds,nextscript)
* SetCredits(numcreds,nextscript)
* PushCredits(nextscript)
* PopCredits(nextscript)
* PushNews(story,nextscript)
* LoadMission(name,missionname,missionargs,nextscript=None,briefing='',briefing_done='',vars=None,vars_done=None)
* AddSprite(name,sprite,pos,nextscript)
* AddPythonSprite(name,sprite,center_position,widthheight,text,python,nextscript)
* AddRemovingSprite
* AddConversationStoppingSprite
* GoToSubnodeIfTrue
* TrueSubnode
* TrueBackwardsSubnode
* GoToSubnode

Remarks:
* relation is saved as two bidirectional values ranging from -0.5 to 1.0 in a variable "Relation_to_''factionname''" with two float values appended. One is the players relation to that faction, the second is the faction relation to the player.

= Dialogs =

The structure for the ''dialog_dictionary'' is as follows:

<code><pre>
dialog_dictionary = {
"intro": [conversation],
"reject1": [conversation],
"reconsider":[conversation],
"reject2": [conversation],
"accept": [conversation],
"accept2": [conversation],
"reminder": [conversation],
"failure": [conversation],
}

with:
conversation = (speaker1, line1, ...), (speaker2, line1, ...), ..., soundfile
</pre></code>

For Init Nodes you will supply only one ''[conversation]''.

= Examples =

==The first major campaign written (Jenek)==

See also the [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=3246 forum thread] (comments & feedback) when this mission was first put into SVN.
{{Fixme}} Improve/expand it?

==Ending Node with AddCredits and AdjustRelation==

<code><pre>
FinalNode.Init(vs, # savegame variable
[], #start location
[], #dialog
None, # fixer sprite
TrueSubnode(AddCredits(100000,AdjustRelation("privateer","pirates",0.01))), # subnode script
None, # completion script
[CampaignEndNode(vs)]) # continue with next mission
</pre></code>

=See Also=
* [[Development:Missions|Editing Missions]]
* [[HowTo:Add_Conversations|Adding Conversations]]

----
{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}

[[Category:HowTos|Edit Campaigns]]
[[Category:Development|Edit Campaigns]]

Development:Campaigns

2011-04-03T14:23:26Z

Pyramid: /* Example Campaigns */

{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}
----
=Editing Campaigns=

'''''Note:''' The information contained here is useful only to those willing to learn a minimal amount of python code (the language does not need to be learned, only the formatting restrictions imposed). A GUI based campaign editor is in development, but work has stalled due to lack of time on the developer's part. If anyone wishes to assist, please contact [[User:dandandaman|dandandaman]].''

An example campaign can be found under the following [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/modules/campaigns.py?view=markup link]

To write a campaign, you'll require missions. The mission system is what is used by both the mission bbs, and the campaign. As a start, it is good to plan to use only the mission types available, as writing your own can be a pain, and requires a degree of proficiency with python and vegastrike which you may not have for a little while. If you are developing a campaign and do require something specific that isn't available, just ask, and we'll see what can be done.

Since you are then limited to the missions we have, you'll want a nice reference about what each of the variables for each mission are ... and what they do. We don't actually have one ;-) but we have something that is almost as good: verify_missions.py At the bottom of this file is a list of the mission types, and slightly more descriptive labels for the arguments (their meanings should be relatively easy to glean from that info, but ask if you're unsure :-) ).

That is unfortunately the easy part. The harder part (easy once you understand it) is then writing the campaign. The campaign for Vega Strike is stored in campaigns.py.

Before we proceed I think it's best if you look at this stuff and try to understand a little bit yourself. At the top of campaigns.py is a whole bunch of text, the dialog and strings used by all the various campaign 'nodes.'

A 'node' is a branch of a campaign, it is where fixers get created and the decision to accept or deny a mission occurs, or where the campaign is branched automatically (depending on some conditions that you might want to specify. I.e. you might have a branching storyline depending on whether a flight group still exists or not).

Typically, each node contains a mission ... Cargo missions are a special case, they have a special type of node wrapper, and are probably the easiest to start with. Anyway, get yourself a text editor with syntax highlighting for python, and have a look at the nodes in the function ''LoadTestCampaign'' (this is a short test campaign that I made to demonstrate a bug).

There was more documentation somewhere, but it appears to have been vanquished. So, ask the inevitable questions!

=Campaign Structure=

==Campaign Integration==

You will need to create a new campaign python file (e.g. ''campaign_mycamp.py''), which then will be integrated into the ''campaigns.py'' with the following additions:
<code><pre>
import campaign_mycampaign

campaignsloaders = [ ...
lambda:campaign_mycamp.LoadMyCampaign()
]
</pre></code>

The basic structure of your new ''campaign_mycamp.py'' file will then be:

<code><pre>
import universe
import campaign_lib
from campaign_lib import *

### define node dialogs
...

### define fixer sprites
...

def LoadMyCampaign():

### define nodes
...

# savegame_variable (can't contain spaces)
vs = Campaign("campaign_mycamp")
# the starting node.
vs.Init(FirstNode)

### define node missions
...

# finalize campaign definition
return vs
</pre></code>

= Campaign Missions =

==Nodes==

There are 2 types of nodes:
* ''CampaignClickNode()'' - here you have to accept or reject the proposed mission
* ''CampaignNode()'' - creates an action like adding reward

The nodes are then connected with the last four arguments in the ''MakeMission'' function:
<code><pre>MakeMission(vs, ...
RejectNode, # If you reject the mission twice. "None" means that he continues asking you forever until you accept
LoseNode, # Node if you lose the mission
WinNode, # Node if you win the mission
ThisNode) # The node for this mission
</pre></code>

The complete mission statement is described in the following section.

The different types of mission nodes that can be created are described here. Further down, you will find the singular structure of the arguments.

==MakeMission Node==
<code><pre>MakeMission(savegame_variable, fixer_sprite, start_location, end_location, click_script,
mission_script, mission_arguments, completion_script, dialog_dictionary, reject_node, lose_node,
win_node, this_node)</pre></code>

==MakeCargoMission Node==
<code><pre>MakeCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==MakeNoFailureCargoMission Node==
<code><pre>MakeNoFailureCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==Init Node==
<code><pre>NodeName.Init(savegame_variable, start_location, dialog_dictionary, fixer_sprite,
subnode_script, completion_script, next_node)</pre></code>

==Mission Arguments==

* '''savegame_variable''' - usually ''vs''
* '''fixer_sprite''' - sprite file for the fixer in the form (sprite_path, display_name, full_screen_sprite), e.g. ''("campaign/captain.sprite","Talk_To_The_Captain","campaign/heads/captain.sprite")''
* '''start_location''' - a command for location checking containing a tuple with (sector/system, base), e.g. ''[InSystemCondition("Crucible/Cephid_17","Serenity")]''
* '''end_location''' - same format as start_location
* '''click_script''' - script to be run as you click on the fixer. A common use is to ''AddCredits()'' for the previous mission.
* '''mission_script''' - script to be run to start the mission (usually ''None'' if you don't have a script, but ambush is also common.)
* '''mission_arguments''' - depend on the mission. E.g. for cargo mission you will give the loaded cargo as arguments: ''("Recycled_Plastics",50,False)''
* '''completion_script''' - script to be set on completion (-1=Failure, 0=Not Accepted, 1=Succeed, 2=In progress), often just ''vs.name+"_mission"''
* '''dialog_dictionary''' - the lines that the fixer says: a dictionary with {dialog_type, dialog_lines_list}, see structure description further down
* '''reject_node''' - name of the node if you reject the mission twice. "None" means that fixer continues asking you forever until you accept
* '''lose_node''' - next node if you are unsuccessful in the mission
* '''win_node''' - next node if you successfully complete the mission
* '''this_node''' - name of the node for this mission, e.g. ''FirstNode''

= Subnodes =

* TrueSubnode
* GoToSubnode
* GoToSubnodeIfTrue
* TrueBackwardsSubnode

= Conditions =

= Scripts =

Scripts and script arguments can be seen in ''data/modules/campaign_lib.py''.
The usual arguments are: (scriptarguments, nextscript), where the next script can be omitted and is nested as the last script argument.

* AddCredits(numcreds,nextscript)
* AddCargo(name,num,missionflag,nextscript)
* RemoveCargo(name,num,missionflag,nextscript)
* SetSaveVariable(varname,varvalue,nextscript)
* IncSaveVariable(varname,nextscript)
* AddTechnology(technology,nextscript)
* AdjustRelation(us,them,change,nextscript)
* ClearFactionRecord(fac,newrelation,nextscript)
* ClearRecord(nextscript)
* PushRelation(faction,nextscript)
* PopRelation(faction,nextscript)
* LaunchWingmen(faction,shiptype,num,nextscript)
* ChangeSystemOwner(system,faction,nextscript)
* SaveVariableGreaterScript(var,val,nextscript)
* DisplayTextIfTrueScript(text,nextscript)
* RemoveCredits(numcreds,nextscript)
* SetCredits(numcreds,nextscript)
* PushCredits(nextscript)
* PopCredits(nextscript)
* PushNews(story,nextscript)
* LoadMission(name,missionname,missionargs,nextscript=None,briefing='',briefing_done='',vars=None,vars_done=None)
* AddSprite(name,sprite,pos,nextscript)
* AddPythonSprite(name,sprite,center_position,widthheight,text,python,nextscript)
* AddRemovingSprite
* AddConversationStoppingSprite
* GoToSubnodeIfTrue
* TrueSubnode
* TrueBackwardsSubnode
* GoToSubnode

Remarks:
* relation is saved as two bidirectional values ranging from -0.5 to 1.0 in a variable "Relation_to_''factionname''" with two float values appended. One is the players relation to that faction, the second is the faction relation to the player.

= Dialogs =

The structure for the ''dialog_dictionary'' is as follows:

<code><pre>
dialog_dictionary = {
"intro": [conversation],
"reject1": [conversation],
"reconsider":[conversation],
"reject2": [conversation],
"accept": [conversation],
"accept2": [conversation],
"reminder": [conversation],
"failure": [conversation],
}

with:
conversation = (speaker1, line1, ...), (speaker2, line1, ...), ..., soundfile
</pre></code>

For Init Nodes you will supply only one ''[conversation]''.

= Examples =

==The first major campaign written (Jenek)==

See also the [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=3246 forum thread] (comments & feedback) when this mission was first put into SVN.
{{Fixme}} Improve/expand it?

==Ending Node with AddCredits and AdjustRelation==

<code><pre>
FinalNode.Init(vs, # savegame variable
[], #start location
[], #dialog
None, # fixer sprite
TrueSubnode(AddCredits(100000,AdjustRelation("privateer","pirates",0.01))), # subnode script
None, # completion script
[CampaignEndNode(vs)]) # continue with next mission
</pre></code>

=See Also=
* [[Development:Missions|Editing Missions]]
* [[HowTo:Add_Conversations|Adding Conversations]]

----
{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}

[[Category:HowTos|Edit Campaigns]]
[[Category:Development|Edit Campaigns]]

Development:Campaigns

2011-04-03T14:15:18Z

Pyramid: /* Subnodes */

{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}
----
=Editing Campaigns=

'''''Note:''' The information contained here is useful only to those willing to learn a minimal amount of python code (the language does not need to be learned, only the formatting restrictions imposed). A GUI based campaign editor is in development, but work has stalled due to lack of time on the developer's part. If anyone wishes to assist, please contact [[User:dandandaman|dandandaman]].''

An example campaign can be found under the following [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/modules/campaigns.py?view=markup link]

To write a campaign, you'll require missions. The mission system is what is used by both the mission bbs, and the campaign. As a start, it is good to plan to use only the mission types available, as writing your own can be a pain, and requires a degree of proficiency with python and vegastrike which you may not have for a little while. If you are developing a campaign and do require something specific that isn't available, just ask, and we'll see what can be done.

Since you are then limited to the missions we have, you'll want a nice reference about what each of the variables for each mission are ... and what they do. We don't actually have one ;-) but we have something that is almost as good: verify_missions.py At the bottom of this file is a list of the mission types, and slightly more descriptive labels for the arguments (their meanings should be relatively easy to glean from that info, but ask if you're unsure :-) ).

That is unfortunately the easy part. The harder part (easy once you understand it) is then writing the campaign. The campaign for Vega Strike is stored in campaigns.py.

Before we proceed I think it's best if you look at this stuff and try to understand a little bit yourself. At the top of campaigns.py is a whole bunch of text, the dialog and strings used by all the various campaign 'nodes.'

A 'node' is a branch of a campaign, it is where fixers get created and the decision to accept or deny a mission occurs, or where the campaign is branched automatically (depending on some conditions that you might want to specify. I.e. you might have a branching storyline depending on whether a flight group still exists or not).

Typically, each node contains a mission ... Cargo missions are a special case, they have a special type of node wrapper, and are probably the easiest to start with. Anyway, get yourself a text editor with syntax highlighting for python, and have a look at the nodes in the function ''LoadTestCampaign'' (this is a short test campaign that I made to demonstrate a bug).

There was more documentation somewhere, but it appears to have been vanquished. So, ask the inevitable questions!

=Campaign Structure=

==Campaign Integration==

You will need to create a new campaign python file (e.g. ''campaign_mycamp.py''), which then will be integrated into the ''campaigns.py'' with the following additions:
<code><pre>
import campaign_mycampaign

campaignsloaders = [ ...
lambda:campaign_mycamp.LoadMyCampaign()
]
</pre></code>

The basic structure of your new ''campaign_mycamp.py'' file will then be:

<code><pre>
import universe
import campaign_lib
from campaign_lib import *

### define node dialogs
...

### define fixer sprites
...

def LoadMyCampaign():

### define nodes
...

# savegame_variable (can't contain spaces)
vs = Campaign("campaign_mycamp")
# the starting node.
vs.Init(FirstNode)

### define node missions
...

# finalize campaign definition
return vs
</pre></code>

= Campaign Missions =

==Nodes==

There are 2 types of nodes:
* ''CampaignClickNode()'' - here you have to accept or reject the proposed mission
* ''CampaignNode()'' - creates an action like adding reward

The nodes are then connected with the last four arguments in the ''MakeMission'' function:
<code><pre>MakeMission(vs, ...
RejectNode, # If you reject the mission twice. "None" means that he continues asking you forever until you accept
LoseNode, # Node if you lose the mission
WinNode, # Node if you win the mission
ThisNode) # The node for this mission
</pre></code>

The complete mission statement is described in the following section.

The different types of mission nodes that can be created are described here. Further down, you will find the singular structure of the arguments.

==MakeMission Node==
<code><pre>MakeMission(savegame_variable, fixer_sprite, start_location, end_location, click_script,
mission_script, mission_arguments, completion_script, dialog_dictionary, reject_node, lose_node,
win_node, this_node)</pre></code>

==MakeCargoMission Node==
<code><pre>MakeCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==MakeNoFailureCargoMission Node==
<code><pre>MakeNoFailureCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==Init Node==
<code><pre>NodeName.Init(savegame_variable, start_location, dialog_dictionary, fixer_sprite,
subnode_script, completion_script, next_node)</pre></code>

==Mission Arguments==

* '''savegame_variable''' - usually ''vs''
* '''fixer_sprite''' - sprite file for the fixer in the form (sprite_path, display_name, full_screen_sprite), e.g. ''("campaign/captain.sprite","Talk_To_The_Captain","campaign/heads/captain.sprite")''
* '''start_location''' - a command for location checking containing a tuple with (sector/system, base), e.g. ''[InSystemCondition("Crucible/Cephid_17","Serenity")]''
* '''end_location''' - same format as start_location
* '''click_script''' - script to be run as you click on the fixer. A common use is to ''AddCredits()'' for the previous mission.
* '''mission_script''' - script to be run to start the mission (usually ''None'' if you don't have a script, but ambush is also common.)
* '''mission_arguments''' - depend on the mission. E.g. for cargo mission you will give the loaded cargo as arguments: ''("Recycled_Plastics",50,False)''
* '''completion_script''' - script to be set on completion (-1=Failure, 0=Not Accepted, 1=Succeed, 2=In progress), often just ''vs.name+"_mission"''
* '''dialog_dictionary''' - the lines that the fixer says: a dictionary with {dialog_type, dialog_lines_list}, see structure description further down
* '''reject_node''' - name of the node if you reject the mission twice. "None" means that fixer continues asking you forever until you accept
* '''lose_node''' - next node if you are unsuccessful in the mission
* '''win_node''' - next node if you successfully complete the mission
* '''this_node''' - name of the node for this mission, e.g. ''FirstNode''

= Subnodes =

* TrueSubnode
* GoToSubnode
* GoToSubnodeIfTrue
* TrueBackwardsSubnode

= Conditions =

= Scripts =

Scripts and script arguments can be seen in ''data/modules/campaign_lib.py''.
The usual arguments are: (scriptarguments, nextscript), where the next script can be omitted and is nested as the last script argument.

* AddCredits(numcreds,nextscript)
* AddCargo(name,num,missionflag,nextscript)
* RemoveCargo(name,num,missionflag,nextscript)
* SetSaveVariable(varname,varvalue,nextscript)
* IncSaveVariable(varname,nextscript)
* AddTechnology(technology,nextscript)
* AdjustRelation(us,them,change,nextscript)
* ClearFactionRecord(fac,newrelation,nextscript)
* ClearRecord(nextscript)
* PushRelation(faction,nextscript)
* PopRelation(faction,nextscript)
* LaunchWingmen(faction,shiptype,num,nextscript)
* ChangeSystemOwner(system,faction,nextscript)
* SaveVariableGreaterScript(var,val,nextscript)
* DisplayTextIfTrueScript(text,nextscript)
* RemoveCredits(numcreds,nextscript)
* SetCredits(numcreds,nextscript)
* PushCredits(nextscript)
* PopCredits(nextscript)
* PushNews(story,nextscript)
* LoadMission(name,missionname,missionargs,nextscript=None,briefing='',briefing_done='',vars=None,vars_done=None)
* AddSprite(name,sprite,pos,nextscript)
* AddPythonSprite(name,sprite,center_position,widthheight,text,python,nextscript)
* AddRemovingSprite
* AddConversationStoppingSprite
* GoToSubnodeIfTrue
* TrueSubnode
* TrueBackwardsSubnode
* GoToSubnode

Remarks:
* relation is saved as two bidirectional values ranging from -0.5 to 1.0 in a variable "Relation_to_''factionname''" with two float values appended. One is the players relation to that faction, the second is the faction relation to the player.

= Dialogs =

The structure for the ''dialog_dictionary'' is as follows:

<code><pre>
dialog_dictionary = {
"intro": [conversation],
"reject1": [conversation],
"reconsider":[conversation],
"reject2": [conversation],
"accept": [conversation],
"accept2": [conversation],
"reminder": [conversation],
"failure": [conversation],
}

with:
conversation = (speaker1, line1, ...), (speaker2, line1, ...), ..., soundfile
</pre></code>

For Init Nodes you will supply only one ''[conversation]''.

= Example Campaigns =

==The first major campaign written (Jenek)==

See also the [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=3246 forum thread] (comments & feedback) when this mission was first put into SVN.
{{Fixme}} Improve/expand it?

=See Also=
* [[Development:Missions|Editing Missions]]
* [[HowTo:Add_Conversations|Adding Conversations]]

----
{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}

[[Category:HowTos|Edit Campaigns]]
[[Category:Development|Edit Campaigns]]

HowTo:Add Upgrades

2011-04-03T14:09:56Z

Pyramid:

{{NAV_Manual |
| previous=[[HowTo:Make Weapons|Make Weapons]]
| up=[[HowTos]]
| next=[[HowTo:Add Cargo|Add Cargo]]
}}
----
=Adding Upgrades=

{{FIXME}} ''This description is incomplete, please expand it as necessary!''

==Required Files==

{{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.}}

The following file must be edited with a text editor:
* [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/units/units.csv?revision=HEAD&view=markup '''units.csv'''] where a unit identifier with postfix "__upgrades", and some parameters are entered.
* [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/master_part_list.csv?revision=HEAD&view=markup '''master_part_list.csv'''], where a [[HowTo:Add_Descriptions|description and item image are edited]].
* [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/modules/ship_upgrades.py?revision=HEAD&view=markup '''ship_upgrades.py'''] if you are adding or altering upgrade categories.

To make upgrades available on planets and stations, the correct upgrade category must be added in the planet's ''units.csv'' entry.

Not only the unit names for upgrades must be aligned, but also the categories.

Development:Campaigns

2011-04-03T14:07:18Z

Pyramid:

{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}
----
=Editing Campaigns=

'''''Note:''' The information contained here is useful only to those willing to learn a minimal amount of python code (the language does not need to be learned, only the formatting restrictions imposed). A GUI based campaign editor is in development, but work has stalled due to lack of time on the developer's part. If anyone wishes to assist, please contact [[User:dandandaman|dandandaman]].''

An example campaign can be found under the following [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/modules/campaigns.py?view=markup link]

To write a campaign, you'll require missions. The mission system is what is used by both the mission bbs, and the campaign. As a start, it is good to plan to use only the mission types available, as writing your own can be a pain, and requires a degree of proficiency with python and vegastrike which you may not have for a little while. If you are developing a campaign and do require something specific that isn't available, just ask, and we'll see what can be done.

Since you are then limited to the missions we have, you'll want a nice reference about what each of the variables for each mission are ... and what they do. We don't actually have one ;-) but we have something that is almost as good: verify_missions.py At the bottom of this file is a list of the mission types, and slightly more descriptive labels for the arguments (their meanings should be relatively easy to glean from that info, but ask if you're unsure :-) ).

That is unfortunately the easy part. The harder part (easy once you understand it) is then writing the campaign. The campaign for Vega Strike is stored in campaigns.py.

Before we proceed I think it's best if you look at this stuff and try to understand a little bit yourself. At the top of campaigns.py is a whole bunch of text, the dialog and strings used by all the various campaign 'nodes.'

A 'node' is a branch of a campaign, it is where fixers get created and the decision to accept or deny a mission occurs, or where the campaign is branched automatically (depending on some conditions that you might want to specify. I.e. you might have a branching storyline depending on whether a flight group still exists or not).

Typically, each node contains a mission ... Cargo missions are a special case, they have a special type of node wrapper, and are probably the easiest to start with. Anyway, get yourself a text editor with syntax highlighting for python, and have a look at the nodes in the function ''LoadTestCampaign'' (this is a short test campaign that I made to demonstrate a bug).

There was more documentation somewhere, but it appears to have been vanquished. So, ask the inevitable questions!

=Campaign Structure=

==Campaign Integration==

You will need to create a new campaign python file (e.g. ''campaign_mycamp.py''), which then will be integrated into the ''campaigns.py'' with the following additions:
<code><pre>
import campaign_mycampaign

campaignsloaders = [ ...
lambda:campaign_mycamp.LoadMyCampaign()
]
</pre></code>

The basic structure of your new ''campaign_mycamp.py'' file will then be:

<code><pre>
import universe
import campaign_lib
from campaign_lib import *

### define node dialogs
...

### define fixer sprites
...

def LoadMyCampaign():

### define nodes
...

# savegame_variable (can't contain spaces)
vs = Campaign("campaign_mycamp")
# the starting node.
vs.Init(FirstNode)

### define node missions
...

# finalize campaign definition
return vs
</pre></code>

= Campaign Missions =

==Nodes==

There are 2 types of nodes:
* ''CampaignClickNode()'' - here you have to accept or reject the proposed mission
* ''CampaignNode()'' - creates an action like adding reward

The nodes are then connected with the last four arguments in the ''MakeMission'' function:
<code><pre>MakeMission(vs, ...
RejectNode, # If you reject the mission twice. "None" means that he continues asking you forever until you accept
LoseNode, # Node if you lose the mission
WinNode, # Node if you win the mission
ThisNode) # The node for this mission
</pre></code>

The complete mission statement is described in the following section.

The different types of mission nodes that can be created are described here. Further down, you will find the singular structure of the arguments.

==MakeMission Node==
<code><pre>MakeMission(savegame_variable, fixer_sprite, start_location, end_location, click_script,
mission_script, mission_arguments, completion_script, dialog_dictionary, reject_node, lose_node,
win_node, this_node)</pre></code>

==MakeCargoMission Node==
<code><pre>MakeCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==MakeNoFailureCargoMission Node==
<code><pre>MakeNoFailureCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

==Init Node==
<code><pre>NodeName.Init(savegame_variable, start_location, dialog_dictionary, fixer_sprite,
subnode_script, completion_script, next_node)</pre></code>

==Mission Arguments==

* '''savegame_variable''' - usually ''vs''
* '''fixer_sprite''' - sprite file for the fixer in the form (sprite_path, display_name, full_screen_sprite), e.g. ''("campaign/captain.sprite","Talk_To_The_Captain","campaign/heads/captain.sprite")''
* '''start_location''' - a command for location checking containing a tuple with (sector/system, base), e.g. ''[InSystemCondition("Crucible/Cephid_17","Serenity")]''
* '''end_location''' - same format as start_location
* '''click_script''' - script to be run as you click on the fixer. A common use is to ''AddCredits()'' for the previous mission.
* '''mission_script''' - script to be run to start the mission (usually ''None'' if you don't have a script, but ambush is also common.)
* '''mission_arguments''' - depend on the mission. E.g. for cargo mission you will give the loaded cargo as arguments: ''("Recycled_Plastics",50,False)''
* '''completion_script''' - script to be set on completion (-1=Failure, 0=Not Accepted, 1=Succeed, 2=In progress), often just ''vs.name+"_mission"''
* '''dialog_dictionary''' - the lines that the fixer says: a dictionary with {dialog_type, dialog_lines_list}, see structure description further down
* '''reject_node''' - name of the node if you reject the mission twice. "None" means that fixer continues asking you forever until you accept
* '''lose_node''' - next node if you are unsuccessful in the mission
* '''win_node''' - next node if you successfully complete the mission
* '''this_node''' - name of the node for this mission, e.g. ''FirstNode''

= Subnodes =

= Conditions =

= Scripts =

Scripts and script arguments can be seen in ''data/modules/campaign_lib.py''.
The usual arguments are: (scriptarguments, nextscript), where the next script can be omitted and is nested as the last script argument.

* AddCredits(numcreds,nextscript)
* AddCargo(name,num,missionflag,nextscript)
* RemoveCargo(name,num,missionflag,nextscript)
* SetSaveVariable(varname,varvalue,nextscript)
* IncSaveVariable(varname,nextscript)
* AddTechnology(technology,nextscript)
* AdjustRelation(us,them,change,nextscript)
* ClearFactionRecord(fac,newrelation,nextscript)
* ClearRecord(nextscript)
* PushRelation(faction,nextscript)
* PopRelation(faction,nextscript)
* LaunchWingmen(faction,shiptype,num,nextscript)
* ChangeSystemOwner(system,faction,nextscript)
* SaveVariableGreaterScript(var,val,nextscript)
* DisplayTextIfTrueScript(text,nextscript)
* RemoveCredits(numcreds,nextscript)
* SetCredits(numcreds,nextscript)
* PushCredits(nextscript)
* PopCredits(nextscript)
* PushNews(story,nextscript)
* LoadMission(name,missionname,missionargs,nextscript=None,briefing='',briefing_done='',vars=None,vars_done=None)
* AddSprite(name,sprite,pos,nextscript)
* AddPythonSprite(name,sprite,center_position,widthheight,text,python,nextscript)
* AddRemovingSprite
* AddConversationStoppingSprite
* GoToSubnodeIfTrue
* TrueSubnode
* TrueBackwardsSubnode
* GoToSubnode

Remarks:
* relation is saved as two bidirectional values ranging from -0.5 to 1.0 in a variable "Relation_to_''factionname''" with two float values appended. One is the players relation to that faction, the second is the faction relation to the player.

= Dialogs =

The structure for the ''dialog_dictionary'' is as follows:

<code><pre>
dialog_dictionary = {
"intro": [conversation],
"reject1": [conversation],
"reconsider":[conversation],
"reject2": [conversation],
"accept": [conversation],
"accept2": [conversation],
"reminder": [conversation],
"failure": [conversation],
}

with:
conversation = (speaker1, line1, ...), (speaker2, line1, ...), ..., soundfile
</pre></code>

For Init Nodes you will supply only one ''[conversation]''.

= Example Campaigns =

==The first major campaign written (Jenek)==

See also the [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=3246 forum thread] (comments & feedback) when this mission was first put into SVN.
{{Fixme}} Improve/expand it?

=See Also=
* [[Development:Missions|Editing Missions]]
* [[HowTo:Add_Conversations|Adding Conversations]]

----
{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}

[[Category:HowTos|Edit Campaigns]]
[[Category:Development|Edit Campaigns]]

Development:Campaigns

2011-04-02T23:34:49Z

Pyramid: /* Scripts */

{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}
----
=Editing Campaigns=

'''''Note:''' The information contained here is useful only to those willing to learn a minimal amount of python code (the language does not need to be learned, only the formatting restrictions imposed). A GUI based campaign editor is in development, but work has stalled due to lack of time on the developer's part. If anyone wishes to assist, please contact [[User:dandandaman|dandandaman]].''

An example campaign can be found under the following [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/modules/campaigns.py?view=markup link]

To write a campaign, you'll require missions. The mission system is what is used by both the mission bbs, and the campaign. As a start, it is good to plan to use only the mission types available, as writing your own can be a pain, and requires a degree of proficiency with python and vegastrike which you may not have for a little while. If you are developing a campaign and do require something specific that isn't available, just ask, and we'll see what can be done.

Since you are then limited to the missions we have, you'll want a nice reference about what each of the variables for each mission are ... and what they do. We don't actually have one ;-) but we have something that is almost as good: verify_missions.py At the bottom of this file is a list of the mission types, and slightly more descriptive labels for the arguments (their meanings should be relatively easy to glean from that info, but ask if you're unsure :-) ).

That is unfortunately the easy part. The harder part (easy once you understand it) is then writing the campaign. The campaign for Vega Strike is stored in campaigns.py.

Before we proceed I think it's best if you look at this stuff and try to understand a little bit yourself. At the top of campaigns.py is a whole bunch of text, the dialog and strings used by all the various campaign 'nodes.'

A 'node' is a branch of a campaign, it is where fixers get created and the decision to accept or deny a mission occurs, or where the campaign is branched automatically (depending on some conditions that you might want to specify. I.e. you might have a branching storyline depending on whether a flight group still exists or not).

Typically, each node contains a mission ... Cargo missions are a special case, they have a special type of node wrapper, and are probably the easiest to start with. Anyway, get yourself a text editor with syntax highlighting for python, and have a look at the nodes in the function ''LoadTestCampaign'' (this is a short test campaign that I made to demonstrate a bug).

There was more documentation somewhere, but it appears to have been vanquished. So, ask the inevitable questions!

=Campaign Structure=

==Campaign Integration==

You will need to create a new campaign python file (e.g. ''campaign_mycamp.py''), which then will be integrated into the ''campaigns.py'' with the following additions:
<code><pre>
import campaign_mycampaign

campaignsloaders = [ ...
lambda:campaign_mycamp.LoadMyCampaign()
]
</pre></code>

The basic structure of your new ''campaign_mycamp.py'' file will then be:

<code><pre>
import universe
import campaign_lib
from campaign_lib import *

### define node dialogs
...

### define fixer sprites
...

def LoadMyCampaign():

### define nodes
...

# savegame_variable (can't contain spaces)
vs = Campaign("campaign_mycamp")
# the starting node.
vs.Init(FirstNode)

### define node missions
...

# finalize campaign definition
return vs
</pre></code>

==Nodes==

There are 2 types of nodes:
* ''CampaignClickNode()'' - here you have to accept or reject the proposed mission
* ''CampaignNode()'' - creates an action like adding reward

The nodes are then connected with the last four arguments in the ''MakeMission'' function:
<code><pre>MakeMission(vs, ...
RejectNode, # If you reject the mission twice. "None" means that he continues asking you forever until you accept
LoseNode, # Node if you lose the mission
WinNode, # Node if you win the mission
ThisNode) # The node for this mission
</pre></code>

The complete mission statement is described in the following section.

==Campaign Missions==

The different types of mission nodes that can be created are described here. Further down, you will find the singular structure of the arguments.

===MakeMission Node===
<code><pre>MakeMission(savegame_variable, fixer_sprite, start_location, end_location, click_script,
mission_script, mission_arguments, completion_script, dialog_dictionary, reject_node, lose_node,
win_node, this_node)</pre></code>

===MakeCargoMission Node===
<code><pre>MakeCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

===MakeNoFailureCargoMission Node===
<code><pre>MakeNoFailureCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

===Init Node===
<code><pre>NodeName.Init(savegame_variable, start_location, dialog_dictionary, fixer_sprite,
subnode_script, completion_script, next_node)</pre></code>

===Mission Arguments===

* '''savegame_variable''' - usually ''vs''
* '''fixer_sprite''' - sprite file for the fixer in the form (sprite_path, display_name, full_screen_sprite), e.g. ''("campaign/captain.sprite","Talk_To_The_Captain","campaign/heads/captain.sprite")''
* '''start_location''' - a command for location checking containing a tuple with (sector/system, base), e.g. ''[InSystemCondition("Crucible/Cephid_17","Serenity")]''
* '''end_location''' - same format as start_location
* '''click_script''' - script to be run as you click on the fixer. A common use is to ''AddCredits()'' for the previous mission.
* '''mission_script''' - script to be run to start the mission (usually ''None'' if you don't have a script, but ambush is also common.)
* '''mission_arguments''' - depend on the mission. E.g. for cargo mission you will give the loaded cargo as arguments: ''("Recycled_Plastics",50,False)''
* '''completion_script''' - script to be set on completion (-1=Failure, 0=Not Accepted, 1=Succeed, 2=In progress), often just ''vs.name+"_mission"''
* '''dialog_dictionary''' - the lines that the fixer says: a dictionary with {dialog_type, dialog_lines_list}, see structure description further down
* '''reject_node''' - name of the node if you reject the mission twice. "None" means that fixer continues asking you forever until you accept
* '''lose_node''' - next node if you are unsuccessful in the mission
* '''win_node''' - next node if you successfully complete the mission
* '''this_node''' - name of the node for this mission, e.g. ''FirstNode''

===Conditions===

===Scripts===

Scripts and script arguments can be seen in ''data/modules/campaign_lib.py''.
The usual arguments are: (scriptarguments, nextscript), where the next script can be omitted and is nested as the last script argument.

* AddCredits(numcreds,nextscript)
* AddCargo(name,num,missionflag,nextscript)
* RemoveCargo(name,num,missionflag,nextscript)
* SetSaveVariable(varname,varvalue,nextscript)
* IncSaveVariable(varname,nextscript)
* AddTechnology(technology,nextscript)
* AdjustRelation(us,them,change,nextscript)
* ClearFactionRecord(fac,newrelation,nextscript)
* ClearRecord(nextscript)
* PushRelation(faction,nextscript)
* PopRelation(faction,nextscript)
* LaunchWingmen(faction,shiptype,num,nextscript)
* ChangeSystemOwner(system,faction,nextscript)
* SaveVariableGreaterScript(var,val,nextscript)
* DisplayTextIfTrueScript(text,nextscript)
* RemoveCredits(numcreds,nextscript)
* SetCredits(numcreds,nextscript)
* PushCredits(nextscript)
* PopCredits(nextscript)
* PushNews(story,nextscript)
* LoadMission(name,missionname,missionargs,nextscript=None,briefing='',briefing_done='',vars=None,vars_done=None)
* AddSprite(name,sprite,pos,nextscript)
* AddPythonSprite(name,sprite,center_position,widthheight,text,python,nextscript)
* AddRemovingSprite
* AddConversationStoppingSprite
* GoToSubnodeIfTrue
* TrueSubnode
* TrueBackwardsSubnode
* GoToSubnode

Remarks:
* relation is saved as two bidirectional values ranging from -0.5 to 0.5 in a variable "Relation_to_''factionname''" with two float values appended. One is the players relation to that faction, the second is the faction relation to the player.

==Dialogs==

The structure for the ''dialog_dictionary'' is as follows:

<code><pre>
dialog_dictionary = {
"intro": [conversation],
"reject1": [conversation],
"reconsider":[conversation],
"reject2": [conversation],
"accept": [conversation],
"accept2": [conversation],
"reminder": [conversation],
"failure": [conversation],
}

with:
conversation = (speaker1, line1, ...), (speaker2, line1, ...), ..., soundfile
</pre></code>

For Init Nodes you will supply only one ''[conversation]''.

=Campaigns=

==The first major campaign written (Jenek)==

See also the [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=3246 forum thread] (comments & feedback) when this mission was first put into SVN.
{{Fixme}} Improve/expand it?

=See Also=
* [[Development:Missions|Editing Missions]]
* [[HowTo:Add_Conversations|Adding Conversations]]

----
{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}

[[Category:HowTos|Edit Campaigns]]
[[Category:Development|Edit Campaigns]]

Development:Campaigns

2011-04-02T23:16:52Z

Pyramid: /* Mission Arguments */

{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}
----
=Editing Campaigns=

'''''Note:''' The information contained here is useful only to those willing to learn a minimal amount of python code (the language does not need to be learned, only the formatting restrictions imposed). A GUI based campaign editor is in development, but work has stalled due to lack of time on the developer's part. If anyone wishes to assist, please contact [[User:dandandaman|dandandaman]].''

An example campaign can be found under the following [http://vegastrike.svn.sourceforge.net/viewvc/vegastrike/trunk/data/modules/campaigns.py?view=markup link]

To write a campaign, you'll require missions. The mission system is what is used by both the mission bbs, and the campaign. As a start, it is good to plan to use only the mission types available, as writing your own can be a pain, and requires a degree of proficiency with python and vegastrike which you may not have for a little while. If you are developing a campaign and do require something specific that isn't available, just ask, and we'll see what can be done.

Since you are then limited to the missions we have, you'll want a nice reference about what each of the variables for each mission are ... and what they do. We don't actually have one ;-) but we have something that is almost as good: verify_missions.py At the bottom of this file is a list of the mission types, and slightly more descriptive labels for the arguments (their meanings should be relatively easy to glean from that info, but ask if you're unsure :-) ).

That is unfortunately the easy part. The harder part (easy once you understand it) is then writing the campaign. The campaign for Vega Strike is stored in campaigns.py.

Before we proceed I think it's best if you look at this stuff and try to understand a little bit yourself. At the top of campaigns.py is a whole bunch of text, the dialog and strings used by all the various campaign 'nodes.'

A 'node' is a branch of a campaign, it is where fixers get created and the decision to accept or deny a mission occurs, or where the campaign is branched automatically (depending on some conditions that you might want to specify. I.e. you might have a branching storyline depending on whether a flight group still exists or not).

Typically, each node contains a mission ... Cargo missions are a special case, they have a special type of node wrapper, and are probably the easiest to start with. Anyway, get yourself a text editor with syntax highlighting for python, and have a look at the nodes in the function ''LoadTestCampaign'' (this is a short test campaign that I made to demonstrate a bug).

There was more documentation somewhere, but it appears to have been vanquished. So, ask the inevitable questions!

=Campaign Structure=

==Campaign Integration==

You will need to create a new campaign python file (e.g. ''campaign_mycamp.py''), which then will be integrated into the ''campaigns.py'' with the following additions:
<code><pre>
import campaign_mycampaign

campaignsloaders = [ ...
lambda:campaign_mycamp.LoadMyCampaign()
]
</pre></code>

The basic structure of your new ''campaign_mycamp.py'' file will then be:

<code><pre>
import universe
import campaign_lib
from campaign_lib import *

### define node dialogs
...

### define fixer sprites
...

def LoadMyCampaign():

### define nodes
...

# savegame_variable (can't contain spaces)
vs = Campaign("campaign_mycamp")
# the starting node.
vs.Init(FirstNode)

### define node missions
...

# finalize campaign definition
return vs
</pre></code>

==Nodes==

There are 2 types of nodes:
* ''CampaignClickNode()'' - here you have to accept or reject the proposed mission
* ''CampaignNode()'' - creates an action like adding reward

The nodes are then connected with the last four arguments in the ''MakeMission'' function:
<code><pre>MakeMission(vs, ...
RejectNode, # If you reject the mission twice. "None" means that he continues asking you forever until you accept
LoseNode, # Node if you lose the mission
WinNode, # Node if you win the mission
ThisNode) # The node for this mission
</pre></code>

The complete mission statement is described in the following section.

==Campaign Missions==

The different types of mission nodes that can be created are described here. Further down, you will find the singular structure of the arguments.

===MakeMission Node===
<code><pre>MakeMission(savegame_variable, fixer_sprite, start_location, end_location, click_script,
mission_script, mission_arguments, completion_script, dialog_dictionary, reject_node, lose_node,
win_node, this_node)</pre></code>

===MakeCargoMission Node===
<code><pre>MakeCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

===MakeNoFailureCargoMission Node===
<code><pre>MakeNoFailureCargoMission(savegame_variable, fixer_sprite, start_location, end_location,
click_script, mission_script, mission_arguments, completion_script, dialog_dictionary,
reject_node, lose_node, win_node, this_node)</pre></code>

===Init Node===
<code><pre>NodeName.Init(savegame_variable, start_location, dialog_dictionary, fixer_sprite,
subnode_script, completion_script, next_node)</pre></code>

===Mission Arguments===

* '''savegame_variable''' - usually ''vs''
* '''fixer_sprite''' - sprite file for the fixer in the form (sprite_path, display_name, full_screen_sprite), e.g. ''("campaign/captain.sprite","Talk_To_The_Captain","campaign/heads/captain.sprite")''
* '''start_location''' - a command for location checking containing a tuple with (sector/system, base), e.g. ''[InSystemCondition("Crucible/Cephid_17","Serenity")]''
* '''end_location''' - same format as start_location
* '''click_script''' - script to be run as you click on the fixer. A common use is to ''AddCredits()'' for the previous mission.
* '''mission_script''' - script to be run to start the mission (usually ''None'' if you don't have a script, but ambush is also common.)
* '''mission_arguments''' - depend on the mission. E.g. for cargo mission you will give the loaded cargo as arguments: ''("Recycled_Plastics",50,False)''
* '''completion_script''' - script to be set on completion (-1=Failure, 0=Not Accepted, 1=Succeed, 2=In progress), often just ''vs.name+"_mission"''
* '''dialog_dictionary''' - the lines that the fixer says: a dictionary with {dialog_type, dialog_lines_list}, see structure description further down
* '''reject_node''' - name of the node if you reject the mission twice. "None" means that fixer continues asking you forever until you accept
* '''lose_node''' - next node if you are unsuccessful in the mission
* '''win_node''' - next node if you successfully complete the mission
* '''this_node''' - name of the node for this mission, e.g. ''FirstNode''

===Conditions===

===Scripts===

Scripts and script arguments can be seen in ''data/modules/campaign_lib.py''.
The usual arguments are: (scriptarguments, nextscript), where the next script can be omitted and is nested as the last script argument.

* AddCredits(numcreds,nextscript)
* AddCargo(name,num,missionflag,nextscript)
* RemoveCargo(name,num,missionflag,nextscript)
* SetSaveVariable(varname,varvalue,nextscript)
* IncSaveVariable(varname,nextscript)
* AddTechnology(technology,nextscript)
* AdjustRelation(us,them,change,nextscript)
* ClearFactionRecord(fac,newrelation,nextscript)
* ClearRecord(nextscript)
* PushRelation(faction,nextscript)
* PopRelation(faction,nextscript)
* LaunchWingmen(faction,shiptype,num,nextscript)
* ChangeSystemOwner(system,faction,nextscript)
* SaveVariableGreaterScript(var,val,nextscript)
* DisplayTextIfTrueScript(text,nextscript)
* RemoveCredits(numcreds,nextscript)
* SetCredits(numcreds,nextscript)
* PushCredits(nextscript)
* PopCredits(nextscript)
* PushNews(story,nextscript)
* LoadMission(name,missionname,missionargs,nextscript=None,briefing='',briefing_done='',vars=None,vars_done=None)
* AddSprite(name,sprite,pos,nextscript)
* AddPythonSprite(name,sprite,center_position,widthheight,text,python,nextscript)
* AddRemovingSprite
* AddConversationStoppingSprite
* GoToSubnodeIfTrue
* TrueSubnode
* TrueBackwardsSubnode
* GoToSubnode

==Dialogs==

The structure for the ''dialog_dictionary'' is as follows:

<code><pre>
dialog_dictionary = {
"intro": [conversation],
"reject1": [conversation],
"reconsider":[conversation],
"reject2": [conversation],
"accept": [conversation],
"accept2": [conversation],
"reminder": [conversation],
"failure": [conversation],
}

with:
conversation = (speaker1, line1, ...), (speaker2, line1, ...), ..., soundfile
</pre></code>

For Init Nodes you will supply only one ''[conversation]''.

=Campaigns=

==The first major campaign written (Jenek)==

See also the [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=3246 forum thread] (comments & feedback) when this mission was first put into SVN.
{{Fixme}} Improve/expand it?

=See Also=
* [[Development:Missions|Editing Missions]]
* [[HowTo:Add_Conversations|Adding Conversations]]

----
{{NAV_Manual |
| previous=[[HowTo:Edit faction relationships|Edit faction relationships]]
| up=[[HowTos]]
| next=[[Development:Missions|Edit Missions]]
}}

[[Category:HowTos|Edit Campaigns]]
[[Category:Development|Edit Campaigns]]

Development:Scripts & Tools

2011-04-01T23:24:21Z

Pyramid:

{{parent_link|
|parent=[[Development]]
}}
----

= Introduction =
These handy scripts and tools are here to make your life easier.
Please note that the official standard for support tools is:
* C++, or
* Python using [http://wiki.python.org/moin/TkInter Tkinter]

{| style="width: 100%; text-align: center; background-color:#9090FF" cellpadding="2" cellspacing="1"
|-style="background-color:#606060;"
! Tool !! Author !! License !! Platforms !! Engine version !! Features !! User Manual
|-valign="top" style="background-color:#909090;"


|-style="background-color:#9090FF;"
| Mesher
| klauss
| GPL || Posix, Win || -
| CLI converter obj <-> bfxm <-> xmesh
| [[HowTo:Add_Ships|Mesher HowTo]]
|-


|-style="background-color:#9090FF;"
| [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=11885 UnitConverter OBJ->BFXM]
| [[User:pyramid|pyramid]]
| GPL || all with Python 2.5 || -
| * convert obj to bfxm *add and compress textures * edit unit info
| [[Development:Tools:UnitConverter|UnitConverter User Manual]]
|-


| CampaignEditor
| Daniel Aleksandrow
| GPL || all with Java SE 6 || -
| create and edit campaigns
| -

|}

= Internal tools =
Tools developed for Vega Strike
* Mesher utility: Converts from/to Wavefront .obj+.mtl, xmesh(es), and BFXM file formats.
* ucsv.py: (Python) Conversion script for turning .xunit files into rows in units.csv format
* 3ds2xml: (Perl) script for converting .3ds files into .xmesh format. Doesn't appear to do axis translation properly, known to be somewhat flaky.
*[WIP] [[Development:Script:obj2obj converter|obj2obj converter]] (Perl, commandline) - Converts obj files to cockpit files. or extracts tag-data from the models. (''At least that's what is planned, Testing under Win32/Linux. [[User:pontiac|Pontiac]]'')
* Configuration Parser (file: objconv/configparser.py in vegastrike CVS, Python) - Goes through the source tree and produces a config file (pygrep.config at present) containing every variable *used* in game, every possible command to bind to keys, and every colour definition that can be specified. Still under development.
*[WIP] OBJ to Vega Strike cockpit converter ([http://vegastrike.sourceforge.net/users/pontiac/scripts/obj2vs_cockpit_obj/ obj2vs_cockpit_obj], Perl)

= External tools =
Plugins and scripts for external programs
*[http://members.chello.at/stefbuer/vegastrike.html XMESH import/export plugin for Wings3D]
*[http://www.talisiorder.ca/template.php?T=Vegastrike%20Addons&P=vegastrike/vegastrike.html XMESH converter for lightwave]
*[WIP] [http://www.geocities.com/cubofjudahslion/VS/xmesh.zip XMESH import script for Blender]

* [http://registry.gimp.org/node/70 DDS plugin for the GIMP]
* [http://en.wikipedia.org/wiki/IrfanView Irfanview] (freeware for Windows) supports the DDS image file format.
* [http://en.wikipedia.org/wiki/Kde KDE]'s image libraries (version >= 3.3.0) support reading the DDS file format, so e.g. gwenview, kview and konqueror can view texture files.
* See [[Development:Orbital_Planet_Surfaces]] for info on NVidia's DDS compressor software.

= See also =
* [[OOG_Tools|Out-Of-Game Player Tools]]
* [http://vegastrike.sourceforge.net/forums/viewtopic.php?t=2902 List of VS object conversion scripts and tools] forums thread

[[Category:Development]]

Development:Model Guidelines

2011-04-01T19:53:53Z

Pyramid: /* Textures */

{{parent_link|parent=[[Development]]}}
= Introduction =

The intention of this document is to give artists using the Vega Strike engine some suggested guidelines to follow in creating models. You may also wish to have a look at the corresponding [[Development:Texture_Guidelines|texturing guidelines]].

So you want to create a new ship for Vega Strike, do you? While virtually all models are welcome, well before you start cranking out wonderfully designed models we request that you first check what models are still required.

{{warning_text |
| text='''Note:''' If you wish to contribute a new or updated model (ship, installation, turret, cockpit, ..) to the game Vega Strike, please see the [[Development:3D_Models|'''3D Models''']] page for models requiring attention.}}

Alternatively, contact [[User:jackS|jackS]] or [[User:pyramid|pyramid]].

= Modeling Pipeline Overview =

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98ffb2" |
|'''Step
|'''Input
|'''Output
|'''Tools
|'''Requirements
|'''Tutorials
|-

| Model Selection
| -
| required model
| model task list
| -
| -
|-

| Conceptualization
| selected model
| model concept
| pen & paper, artwork forum
| artstyle guide
| -
|-

| Modeling
| concept
| model mesh, obj + mtl files
| blender, forum
| many
| -
|-

| Texturing
| model mesh
| textures
| gimp, forum
| texture requirements
| -
|-

| Integration
| model + textures
| bfxm + dds textures
| mesher + UnitConverter
| -
| -
|-

| Testing
| bfxm model + dds textures
| bfxm + dds textures
| vegastrike + modelview.mission
| pass or rework
| -
|-

| Submission
| blender file (obj + mtl), master textures, bfxm + dds textures
| archive or svn
| mail, svn client
| -
| -
|}

=Model Requirements=

==Requirements Checklist==

Considerations for a successful model submission:
* Model is in the requirements list [[Development:3D_Models|->]]
* Abides to faction visual guidelines
* Has approved concept
* Provides model source file (blender, Wings3D, ...)
* Provides OBJ file
* Has model mesh, shield mesh, LoD meshes, helper meshes
* Provides uncompressed textures in png format (and optionally faction textures)
* Provides texture source files (GIMP, ...)
* Provides HUD png image with correct orientation
* Provides units.csv file entry

==Model Requirements Details==

==Visual Guidelines==

For particular aesthetic guidelines, please see the [[Artstyle guides]] page. Please note that many of the existing models are used because of expedience, not because they fit well with VS canon (i.e. if you make something new look like what's there, it still might not be what we're looking for). If in doubt, please ask on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

To absolutely sure, for new models, please create a drawing of your proposed concept and let it be discussed and approved on the [http://vegastrike.sourceforge.net/forums/viewforum.php?f=4 Artwork & Content Vetting forum].

See also [[Development:Texture Guidelines]]

==Model File Format==
The preferred format for submission (for public disbursement - whatever native format is used inside your favorite modeling suite is fortunately a non-issue) is currently Wavefront OBJ file format, as this is the most easily converted between manipulation (assorted modeling tools) and presentation (currently BFXM, later to be the OGRE .mesh format). Model "source" therefore, is, at present (Sep. 2008), most usefully uploaded as .OBJ.

Until such a time as a visual model editing tool is completed, conversion to a game-ready format will likely pass through the .xmesh format for insertion of LOD references into top level mesh(es), correction of coordinate "handedness" (if the ordering of the coordinate axes is incompatible, as appears to happen with the output of some modeling tools).

See [[HowTo:Add_Ships]] for information on using mesher to convert to a presentation format (such as BFXM). Note that an old utility, objconv, is '''not''' mesher, and should not be used for this task. Source files for the mesher utility are included along with VS source. Windows users may download updated mesher binaries from their SVN interface of choice (the binary will be in the \bin directory).

==Polygon/Vertex Count==
In broadest terms, the desired polygon count for a particular model is dependent on three major factors:
*The amount of screen real-estate that the model is likely to be viewed at the majority of time that a user will be seeing it (i.e. a 2 meter long rocket doesn't deserve the same order of magnitude of attention to detail as a large base or vessel unless the rocket is expected to be mounted in front of a camera. Likewise, even at the same level of attention in terms of polygons per square meter, it would have far fewer total polygons.)
*The intrinsic surface complexity of the model. If one is modeling a box for freight cargo, one is not going to need as many polygons as if one needed to model one of the Vega Strike developers (not that we're necessarily model material ;-)). If you don't use enough polygons, no amount of texture magic can save a model from being ugly. That said, if you are modeling a cargo freight container and you use thousands of polygons, you're being negligent and wasteful of resources.
*Engine limitations. Engine limitations is a bit of a misnomer, as the performance of the graphical engine is more hardware dependent than anything else, but it's a good heading for lumping any non-artistic hurdles under. This is the most complicated of the three major factors, because it represents a moving target. Suffice it to say that in order to preserve playability on a broad range of systems, there is a premium placed on making a model aesthetically appropriate with the minimum number of polygons.

Rough guideline:
*Fighter: 15k triangles
*Corvette: 30k tris
*Cruiserer: 60k
*Carrier: 120k
*Space station: 250k

However, significant discression, and the possibility for using large numbers of polygons to prettify an object remain with the artist, provided they make appropriate use of [[Terminology:LODs|LODs]]. The primary focus needs to be on making a model aesthetically appropriate, for an intended common viewing distance, and then catering to the needs of the engine by introducing lower LODs (if necessary) and catering to artistic desires by introducing higher LODs (if appropriate). There is also an element of minor future proofing that occurs with providing a robust range of LOD poly counts - namely, multiple versions of the data set can be constructed targeted at different hardware points by shifting up or down along the LOD set (although this currently isn't bothered with, if and when we develop a true source repository for models and textures, this will likely become more common, as postprocessing of submitted art will become tenable).

One more point to consider before attempting to set a polygon goal for a model is what the likely total contribution from all instances on screen of a given model will be - if the model represents something particularly rare, then it is likely that a few more polygons can easily be spared on its model than for more common objects of otherwise similar size, complexity, etc.

Above all, use common sense - if it's visually hideous because it doesn't have enough polygons, it's not your top level model, and if it's in the 5 digit range for polygon count, it's not your lowest level LOD. Take into consideration how much screen real estate, based on the intended in-game size of the model (and if you don't have any idea how big it's supposed to be - you're doing something wrong already) the model will be taking up at various distances, and calibrate detail appropriately (this will become a much easier task once there is a visual modeling tool from the VS side) - to belabor the obvious, the difference between 500 polygons and 5000 gets somewhat obscured when the object is only drawn using 64 pixels. Note therefore that larger objects will often necessitate higher polygon counts merely because there's more of them to see.

(Note that there is no need to continue adding LODs beyond a point of "diminishing artistic returns" - if adding more detail won't help, don't bother. If adding detail helps, but is too expensive to be practical, then it may still be worthwhile for later inclusion as hardware resources increase.)

For small to moderate craft and installations, something along the lines of either of the following is not inappropriate:

(Exponential Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4000
*LOD 3 <= 8000
*LOD 4 <= 16000
*LOD 5 >16000

(Quadratic Scaling)
*LOD 0 <= 500 tri's.
*LOD 1 <= 2000
*LOD 2 <= 4500
*LOD 3 <= 8000
*LOD 4 <= 12500
*LOD 5 <= 18000
*LOD 6 >18000

Larger models, such as capital vessels and large installations will likely follow a similar curve, but at a higher offset, due to increased size. Truly massive models should be partitioned into multiple meshes, each with its own set of LODs such that nearer portions of the model can be independently represented at higher LOD than more distant ones. Partitioning into multiple meshes may be preferable even for merely "largish" models so as to preserve reasonable correspondence between single pixels and the size of represented features when texturing.

==Textures==

Texture maps should also be made accordingly, although clearly artistic integrity trivially trumps the following rough guideline (if you need more pixels, use them) and the appropriate texture size may depend greatly upon the size of the model.

*LOD 1 128x128
*LOD 2 256x256
*LOD 3 512x512
*LOD 4 1024x1024
*LOD 5 and up having multiple 1024x1024 textures

Be careful with ''texture lodding abuse''. Each LOD that uses its own texture will require more memory (video memory), and breaks batching between instances (slows down rendering of many instances of this model). Even so, texture lodding actually frees up memory most of the time, since only lesser versions are used in the distance. A general rule of thumb is to never have more than two or at most three versions of the same texture. Also take any opportunity to convert textures to greyscale when the color loss is not quite noticeable (most commonly with glow maps and specular maps).

Likewise, for larger models, do not neglect the potential addition of detail textures.

See also [[Development:Texture Guidelines]] and [[Development:Graphics_Requirements]].

===Faction Textures===

To include and successfully test faction textures in your data, you need to:
* set the corresponding vegastrike.config variable (<code>var name="faction_dependant_textures" value="1"</code>).
* prefix default textures with the faction name, e.g. when your default texture is called "tex_000.texture", to enable the faction texture for "pirates" you'll need to add the texture "pirates_tex_000.texture".
* change configuration to one of the 2 highest computer modes (512M+1GB or 1024MB).

==Shield and Collision Meshes==
Separate shield meshes are highly desirable. Shield meshes should also be done using LODs, although shield meshes should remain simple - that is, their top level meshes should not contain odious numbers of polygons for something that is only infrequently displayed.

Collision meshes need not (and cannot) have LODs. For complex models, it is wise to provide a dumbed-down version of the model that reasonably approximates its shape - minor features and greebles can be safely removed, for instance - to improve performance on the physics engine. Polycount should be kept to a minimum, '''without sacrificing any major features''' of the top-level LOD. Very small vessels (or appropriately shaped ones) may opt to not specify a collision mesh, which will make the physics layer treat this mesh as a spherical object (most efficient).

==HUD Image==

Provides perspective view of the model oriented with the nose towards the left-bottom corner of the image.
The master image resolution should start at 256x256 pixels with transparency around the vessel.

==See also==
For an example of an entity that is composed of multiple meshes, uses LODs, and shield meshes, examine the Clydesdale. (Note that shield and collision meshes are specified in the units.csv file, not by the model.)

=Model Creation=

The first (and most enjoyable) job is to design and draw your model (the geometrical object) within your program.

Feel free to use any modeling program, but it must be able to export models in either (Wavefront) .OBJ or (Vega Strike) .xmesh format. If you don't know where to start, see [[Links:3D Applications]] for a list of modeling software. [http://www.wings3d.com/ Wings 3D] is recommended for modeling beginners. [http://www.blender.org/ '''Blender'''] is the tool of choice for VS artistic community.

==Orientation==
First off, do yourself a favor and line your model up correctly before you begin. For the purposes of Vega Strike, Z+ is forwards and Y+ is up. The model's nose should be pointing forward along the Z+ axis (so that the Z+ axis would theoretically be visible from the cockpit). The mesh should also be properly centered.
Summing up:
* Z+ -> Forward direction
* Y+ -> Up direction
* Centered

== Tutorials==

{{warning_text |
| text='''Note:''' The tutorials overview is not complete, Many of the available tutorials have not yet been integrated into this page. Refer also to the [[HowTos|'''Game HowTos''']] page for additional tutorials.}}

{|border="2" rules="rows" cellpadding="5" cellspacing="1" style="width:100%; text-align:center; background-color:#98b2ee" |
|'''Modeling Step
|'''Blender
|'''Wings3D
|-
| Create mesh
| -
| [[HowTo:Create Ships in Wings3D|Creating a 3D-model]]
|-
| Smoothing
| [[HowTo:Smooth Groups|Smoothing]] [[HowTo:Weld|Smooth Welding]]
| -
|-
| Mesh cleanup
| [[HowTo:Bevel|Beveling]]
| -
|-
| Unwrapping
| [[HowTo:Unwrap_in_Blender|Unwrapping 1]] [[HowTo:Unwrap|Unwrapping 2]] [[HowTo:FullUnwrapBlender|Ship unwrap]]
| -
|-
| Radiosity Baking
| [[HowTo:Radiosity baking in Blender|Radiosity baking]]
| -
|-
| Exporting
| -
| -
|}

This articles are WIP, means still need to be reviewed and decided how to restructure them:
* [[HowTo:Create Cockpit in Wings3d|Creating a 3D cockpit for your ship.]]
* [[HowTo:Add LODs|Adding Levels of Detail]]
* [[HowTo:Add Ships|Adding your ship to Vega Strike]] - An overview of how to create and add ships to the game
* [[HowTo:Create Models]] - Links to forum discussions. Page will become generic model creation tutorial.
* Modeling Tutorials: [[HowTos#Modeling]]

===Blender Basics===
* [[HowTo:Basic Blender Tutorial|A basic Blender3D tutorial]]: [http://www.cdschools.org/54223045235521/blank/browse.asp?A=383&BMDRN=2000&BCOB=0&C=55205 Blender Basics - 3rd Edition] - not specific to ships, though...

===Wings3D Basics===

===Other Software Basics===

* [[HowTo:Model a Ship|Brad Mick's video tutorial on ship modeling]] - using Lightwave, but the concept is general: ''Rapid Prototyping''

=Texture Creation=

==Unwrapping==

Please make non-overlapping UV unwraps for all future models. You can't bake a proper AO with overlapping islands.

==Unsorted==

(general guidelines, tips, best practices, app specific tutorials, ...)

* [http://netzwelt.gaming-hut.de/vegatexturing/ WIP VegaStrike texturing page by Major]
* [http://edice.netfirms.com/tuts/texturetut.htm Texturing tutorial by Duality]

For the time being, you may wish to have a look at the corresponding [[Development:Texture_Guidelines|Texturing Guidelines]].

* [[Development:Texture Guidelines|Guidelines for creating ship materials]]

* [[HowTo:Add Per Pixel Lighting|Adding per-pixel lighting to your 3D model]]
* [[HowTo:IntroToShaders|Introduction to shaders, and what they mean for you]] --Bumpmaps, Normalmaps, Shininess maps ...

* [[HowTo:Texture|Creating your own textures]] - A summary on how to make texture maps
* [[HowTo:Texture in Wings3d|Texturing your model in Wings 3d]]
* [[HowTo:SuperrealisticTexturing|Tips for realistic-looking textures]]
* [[HowTo:Make Animated Textures|Using animated textures on a model]]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/texturing_noodle LaGrande Noodle]
* [http://wcpedia.com/dw/doku.php/wc_info/modding/ao_and_prt_bakes AO and PRT bakes, using Blender and xNormal]

=Integration and Testing=

Using UnitConverter to convert all files and edit the model stats for Vega Strike:
[[Development:Tools:UnitConverter]]

===Object Marker===
In order to automatically create turret mounts, gun mounts, and engine thrusters placements in units.csv, please use the following marker:

[author:chuck_starchaser] Here's a blend file people could load and save as the default blender start.
Starts with a marker smack in the middle.
You can move it to another layer, later duplicate it as needed to place copies at key locations.
http://wcjunction.com/temp_images/cinemut/goodstart.blend
You can also import the marker into another blend file:
Open whatever.blend, go to File -> Append Or Link
Navigate to where goodstart.blend is.
Go to the Objects folder, and click on the "marker" object.
To duplicate an object, in object mode, select and shift-D.
To rename your duplicated object, hit F9 and, towards the left,
where it says OB:Marker click in the middle of it and then
type "gunmount_0_light_medium" or whatever.

It is advisable to group the marker objects into a group called "marker". You are required to export all the markers into one obj file that needs to contain the name "marker" in it (letter case is unimportant, it can be "marker", or "Marker").

Object Helper naming convention: ''type_subtype_identifier''

with type:
* pilot (currently unused)
* mount (currently unused)
* turret
* subunit
* engine
* dock

and subtype being optional (convention tbd),
and identifier being either a number or a description and optional.

You may define for example:
* pilot
* pilot_john
* mount_lightmedium_0
* turret_capmissile_frontleft
* subunit_1
* engine_retro_left

===Updating Stats===
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
* [[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]

=Submission and Vetting=

=Technical Reference=

==Technical Specifications==

* [[HowTo:Edit BFXM files|Editing BFXM files (format spec)]]
* [[HowTo:Edit XMESH files|Editing the xmesh file of a ship]]
* [[HowTo:Edit units.csv|Editing units.csv]]
* [[HowTo:Add Engine Glow|Adding an engine glow to your 3D model]]

==Scripts and Tools==

See [[Development:Scripts_%26_Tools|Scripts & Tools]]
* [[HowTo:Add_Ships#New_method|mesher converter obj <-> bfxm <-> xmesh]]

=References=

* [http://wcpedia.com/dw/doku.php/wc_info/modding/index WCpedia Modeling Page]

[[Category:Development|Model Guidelines]]
[[Category:Modeling|Model Guidelines]]