Difference between revisions of "SCP Additions"

From FreeSpace Wiki
Jump to: navigation, search
(→‎Posting Rules)
m (minor edits to the intro)
 
(51 intermediate revisions by 9 users not shown)
Line 1: Line 1:
−
<font color=yellow>'''WARNING: THIS PAGE IS BEING DESIGNED'''</font>
+
{{note|There's a noticeable gap between 3.6.9 (2010) and 21.0.0 (2021). If you can help us fill the gap, please do so.}}
 +
==Introduction==
  
−
This section is just now being built and designed. Please wait a little before real posting inside it or its linked pages and subsections.
+
The main purpose of the Source Code Project is enhancing the game with new features. And this has been done in such successfully way that maybe ''nobody'' knows them all. So this success can actually become a major flaw in the project because:
 +
# Coders are sometimes unmotivated because they see that a lot of the effort they spend upgrading the engine is scarcely used.
 +
# Modders could build better campaigns and mods if they knew all the available extra stuff.
  
−
==Introduction==
+
This page is intended as an enormous log where coders can make public all their huge and great work:
  
−
The main thing the Source Code Project do is adding features to the retail game engine. BLA, BLA, BLA
+
#'''Main objective:''' From now on (July 2007) coders will have an '''only''' place where ''easily'' (more or less) post all their additions sorted by date. In this way, you will be able to check what you've missed in the last two weeks you've been on holidays without needing to dig through all HLP forum threads.
 +
#Secondary objective: With time and effort, we will be able to start compiling here all the outstanding features already present. Although a bit more difficult (digging through this page, using the search function of your web browser), you can learn a lot of ''hidden'' things you didn't know about fs_open.
  
−
'''''[[SCP Additions: List by Date]]'''''
+
This list of features is indeed two lists because, more or less since version 3.6.9., the game source code was split in two branches. ''([[Getting_the_Source|Here]] you've got info about getting the source code in both branches).''
  
−
'''''[[SCP Additions: List by Category]]'''''
+
*'''[[SCP_Additions#HEAD_Branch_.28CVS.29_-_Experimental.2C_non-canon_features|HEAD branch]]'''. It contains all unstable or experimental new features. Builds based on this branch should be used only for testing and only by experimented users. They can easily crash, have bugs, corrupt pilot files or have any other undesired effect.
 +
*'''[[SCP_Additions#Stable_Branch|Stable branch]]'''. This branch has more tested features and, although bugs can always appear, they are supposed to be allot more stable than the ''HEAD branch''. This branch of the code is the one used for ''official releases'' like 3.6.9. As a general rule, ''HEAD branch'' has all the ''Stable branch'' features, but ''Stable branch'' doesn't have all the ''HEAD branch'' capabilities.
  
−
==Posting Rules==
+
== Posting Rules ==
 +
{{Warning|<b>Please follow these rules.</b>
  
−
<font color=red>Please follow the rules. Even if you don't agree with some of them, follow them. This section can grow huge and it can become a damn hell. So we need one and only set of rules. And we all must follow it.
+
Even if you don't agree with some of them, follow them. This section can grow huge and it can become a damn hell. So we need one, and only one, set of rules. And we all must follow it.
  
−
No discussion here, please.</font>
+
No discussion here, please. If you want any of them changed, post it to discussion in [http://www.hard-light.net/forums/index.php/topic,44892.0.html this HLP forum thread] or [[:{{NAMESPACE}} talk:{{PAGENAME}}|discuss it]].}}
  
  
−
# '''1st. GOLDEN RULE: Be extremely brief.'''
+
# <font color=yellow>'''1st Golden Rule: Be Extremely Brief.'''</font>
 
#* Do not make long explanations within the lists.
 
#* Do not make long explanations within the lists.
−
#* In each entry '''Description''' section write a brief explanation.
+
#* In each entry ''Description'' section write a brief explanation.
−
#* If you need a deeper explanation for that feature put a link, (or links), in '''See''' section. Even create new pages if needed.
+
#* If you need to be more descriptive, create a link(s) in the ''See'' section. Even create new pages if needed.
−
# '''2nd. GOLDEN RULE: Be extremely tidy.'''
+
# <font color=yellow>'''2nd Golden Rule: Be Extremely Tidy.'''</font>
 
#* As you can imagine, this Wiki section can become a mess quite easily.
 
#* As you can imagine, this Wiki section can become a mess quite easily.
−
#* Always put each new feature in both lists [[SCP Additions: List by Date]] and [[SCP Additions: List by Category]].
+
#* Always check that all the links work.
−
#* Always check that each entry in [[SCP Additions: List by Date]] has a working link to [[SCP Additions: List by Category]] entry.
+
# As they should be quite intuitive, please follow any other example you find already posted.
−
#* Always check that all the links in [[SCP Additions: List by Category]] work.
+
# '''Be sure you know''' if the feature must go to '''HEAD Branch''' or '''Stable Branch'''. And please, if your feature is ''upgraded'' from the HEAD to the stable branch, '''update the lists and dates'''.
−
# '''[[SCP Additions: List by Date]] posting rules.'''
+
# '''Be tidy in the place and date you post'''. The lists, both HEAD and stable, should always be kept sorted in descending order by date (the most recent additions should go in the upper part of each section).
−
## As they should be quite intuitive, please follow any other example you find here.
+
# If the CVS date for your feature doesn't exist, create a new one.
−
## This list is actually two lists:
+
# Always use the [http://en.wikipedia.org/wiki/ISO_8601#Dates ISO-8601 date format]. So January 27th in 2007 should be 2007-01-27.
−
##* Features that belong only to HEAD experimental builds.
+
# Each new date should be a list item, ie. start it with *
−
##* Features that belong also to stable builds. This kind of features are also present in HEAD builds. These builds are the seed for ''official'' SCP releases (like 3.6.9).
+
## Each new feature in a given date should be a sublist item, ie. start it with **
−
## Be sure you know if the feature must go to '''HEAD Branch''' or '''Stable Branch'''.
+
## Each new feature has four sections. These subsections are sub-sublist items, ie. start them with ***:
−
## '''Be extremely tidy in the place and date you post'''. The list should be always kept sorted in descending date order (the most recent additions should go in the upper part of each section).
+
##*''Description:'' A brief description of the feature.
−
## If the CVS date for your feature doesn't exist, create a new one. '''Use Japanese YYYY-MM-DD format'''. So January 27th in 2007 should be 2007-01-27. (In this way the ''number'' of the date always grows when a day advances).
+
##*''Category:'' The game category this feature falls in. It can be useful for people that want to look for just new "Sound" features for example. '''Please check the spelling and do not invent new categories'''. If you type "suond" or if we have one thousand different categories, this field is useless. <br>You can assign several categories if you feel the feature you are posting about can fall in several areas. <br>The ''official'' categories are:
−
## Once you have located or created your date, post the feature as a sublist entry on that date:
+
##**''Mission features''. All the new stuff you can add to missions through FRED, ie. new sexps, backgrounds, new mission options, ...
−
##* Always start it with the link to the [[SCP Additions: List by Category]] entry.
+
##**''FRED interface''. Any other FRED improvements, like Voice Acting Manager, which don't fall in the previous one.
−
##* If you want, you can also add a brief description to the entry.
+
##**''Graphics''. All the extra graphical capabilities added like OGL support, shine, glow, env or normal mapping...
−
# If your feature is ''upgraded'' from the HEAD to the stable branch, '''please move it to that section, update the dates and also update [[SCP Additions: List by Category]] added date'''.
+
##**''Sound''. Just the same with sound and music (ogg support as example).
−
# '''[[SCP Additions: List by Category]] posting rules.'''
+
##**''Game interface''. All the game enhancements in the game mainhall and screens. Examples: F3 Lab, showing models in loadout screen, showing ship info in hud, extended hud capabilities...
−
## Please follow any other example you find here.
+
##**''Models''. Everything that has to do with ship models like higher poly limits, glow points...
−
## Each feature here is a sub-sub-sub section. Ie., each new feature entry goes between ==== and ==== to make it appear in the '''Contents''' box at the top of the page.
+
##**''Tables and modding''. Everything that allows modders to customize FS2 and it is not directly set in FRED as a mission feature. Examples: Data management (-MOD flag), extended texture format support, modular tables, "un-hardcoded" tables like iff_defs, 3D shockwaves, 3D warp effects...
−
## Each entry has four sections:
+
##**''Scripting''. All the scripting enhancements. You can get a lot of info about scripting in [[Scripting.tbl|Scripting.tbl table help]].
−
##* '''Description:''' A brief description of the feature.
+
##**''Multiplayer''. Enhancements in multi player rather than general single player ones.
−
##* '''Added in:''' Post the build or the date if known. If it is experimental write '''HEAD only'''. Examples:
+
##**''Coding''. Technical coder info which maybe is not directly seen in game but needs to be told. Like "I have changed all the arrays with pointers in this subroutine". (Sorry if I'm telling nonsenses but I'm no coder at all, I think you can imagine what I want to say).
−
##** '''Added in:''' 2006-12-28
+
##*''See:'' Put the links here to related pages with deeper info about that feature. If you want to post a lot of info about your feature, create your own page and put the link here.
−
##** '''Added in:''' 3.6.9.
+
##* ''Usage Tips:'' In the future, creating a tips page somewhere in the Wiki is intended. In this section you could explain useful tricks. Put here the links to the tips this feature is useful for here.<br>''If you feel like it, you can even start that tricks page. Some discussion can be found [http://www.hard-light.net/forums/index.php/topic,44892.0.html here].''
−
##** '''Added in:''' 2006-12-28 '''HEAD only'''
+
# Optionally, you can use the following color codes to tell the importance of the addition:
−
##* '''See:''' Put the links here to related pages with deeper info about that feature. If you want to post a lot of info about your feature, create your own page and put the link here.
+
#* <font color=red>'''Critical update'''</font>. (This would be an extremely important update over retail behaviour).
−
##* '''Usage Tips:''' In the future, creating a tips page somewhere in the Wiki is intended. In this section you could explain useful tricks. Put here the links to the tips this feature is useful for here.<br>''If you feel like it, you can even start that tricks page ;) . Some discussion can be found [http://www.hard-light.net/forums/index.php/topic,44892.0.html here].''
+
#** ''Description:'' Whatever...<br>...
−
## Please try to put every feature in the category you think that suits better. Even you can put it in two or more categories if you feel like it. But in this situation do the next steps:
+
#** ''Usage Tips:''
−
##* Only fill the four sections ('''Description, Added in, See and Usage Tips''') in one of them. This would be the main one.
+
#* '''Common update'''. (Normal updates).
−
##* In the others, you will use the same name with "(repeated)", "(repeated 2)" and so on. The main reason to do this is avoiding conflictive entries with the same name.
+
#** ''Description:'' Whatever...<br>...
−
##* In this secondary entries just put a '''See''' section with a link to the main entry.
+
#** ''Usage Tips:''
−
##* A "fake" example:
+
#* <font color=green>'''Just a tweak'''</font>. (This would be just a tweak over retail FreeSpace 2).
−
##** ''Mission features''<br>...
+
#** ''Description:'' Whatever...<br>...
−
##*** ''Feature AA''. (This would be the main one)
+
#** ''Usage Tips:''
−
##**** ''Description:'' Whatever...<br>...
+
#When a new official release appears, '''Stable > CVS''' subsection name is just changed to the new build denomination and a new '''Stable > CVS''' section is created.
−
##**** ''Usage Tips:''
+
 
−
##*** ''Feature BB''<br>...
+
==Feature list sorted by date==
−
##** ''Graphics''<br>...
+
===HEAD Branch (CVS) - Experimental features===
−
##*** ''Feature AA (repeated)''. (This would be the secondary one)
+
* '''2007-09-27'''
−
##**** ''See:'' Here you'd have a link to ''Feature AA''
+
**'''Disable Primary Linking'''
−
##*** ''Feature XX''.<br>...
+
***''Description:'' If a ship with the "no primary linking" flag cycles through primaries, it won't link them. This flag can be set both in ships.tbl for every ship of a class, or on a per-ship basis via SEXPs.
−
## If you want you can use the next colour code to tell the addition importance:
+
***''Category:'' Mission features.
−
##* <font color=red>'''Critical update'''</font>. (This would be an extremely important update over retail behaviour).
+
***''See:''
−
##** ''Description:'' Whatever...<br>...
+
***''Usage Tips:''
−
##** ''Usage Tips:''
+
 
−
##* '''Common update'''. (Normal updates).
+
* '''2007-08-01'''
−
##** ''Description:'' Whatever...<br>...
+
**<font color=green>'''GUI Mouse Speed'''</font>
−
##** ''Usage Tips:''
+
***''Description:'' Scales the mouse speed on the menu up correctly as the resolution goes up.
−
##* <font color=green>'''Just a tweak'''</font>. (This would be just a tweak over retail Freespace2).
+
***''Category:'' Game Interface.
−
##** ''Description:'' Whatever...<br>...
+
***''See:''
−
##** ''Usage Tips:''
+
***''Usage Tips:''
 +
 
 +
* '''2007-07-13'''
 +
**'''Training Weapons and Simulated Hull'''
 +
***''Description:'' If a weapon with the "training" flag hits a ship, it doesn't do any real or cosmetic damage, but instead hits an invisible Simulated Hull. FREDders can interact with the Simulated Hull through the same SEXPs as they use with the Hull.
 +
***''Category:'' Mission features.
 +
***''See:''
 +
***''Usage Tips:''
 +
 
 +
* '''2007-07-11'''
 +
**'''Ship Templates'''
 +
***''Description:'' Ship Templates allow a Modder to shorten (sometimes significantly) their ships.tbl by defining templates that hold attributes common to multiple ships.
 +
***''Category:'' Tables and modding.
 +
***''See:'' [[Ship Templates]]
 +
***''Usage Tips:''You can have ship templates use other ship templates, if needed.
 +
**'''Additive Weapon Velocity'''
 +
***''Description:'' If set, weapons will inherit their firing ship's velocity. A ship traveling quickly will fire weapons faster than a ship traveling slowly.
 +
***''Category:'' Tables and modding.
 +
***''See:'' [[Ai_profiles.tbl#.24use_additive_weapon_velocity:|ai_profiles.tbl]]
 +
***''Usage Tips:''
 +
 
 +
* '''2007-12-01'''
 +
**'''Laboratory'''
 +
***''Descrption:'' Modified techroom. Pressing F3 toggles advanced model-viewing options.
 +
***''Category:'' Interface
 +
***''See:'' [[Laboratory]] article
 +
***''Usage Tips:''
 +
 
 +
===Stable Branch===
 +
 
 +
====CVS====
 +
* '''YYYY-MM-DD'''. Unknown date:
 +
**<font color = red>'''AutoPilot/Nav Points'''</font>
 +
***''Description:'' Autopilot and nav points system reminiscent of wing commander.  Prior to july 2007 cinematics had to be done with creative sexping, starting mid july 2007 cinematics were hardcoded and enabled via mission flag or sexp (and can be disabled via sexp).  System includes ships needing linkup (jul 07+), messages (jul 07+), autopilot is not allowed near hostiles (5k), debris/asteroid fields (1k, jul07+), messages and linkup distance are defined via [[autopilot.tbl]].
 +
***''Category:'' Tables and modding, Mission features.
 +
***''See:'' [[autopilot.tbl]]
 +
***''Usage Tips:'' Make sure to set the mission flag to use cinematics
 +
**'''Voice Acting Manager'''
 +
***''Description:'' A very handy FRED utility which creates a systematic list of voice file names and links them to all the messages present in a mission (Command Briefing, Briefing, Debriefing and in game Messages). It also allows to create a log which contains all those messages and their assigned audio file names, (it's actually a true actor script ;) ).
 +
***''Category:'' FRED Interface
 +
***''See:'' [[FS2_Data_Structure#voice]] tells you where to put each kind of voice file.
 +
***''Usage Tips:''
 +
 
 +
====3.6.9. and former builds====
 +
* '''YYYY-MM-DD'''. Unknown date:
 +
**<font color=red>'''OpenGL support'''</font>
 +
***''Description:'' The game has been ported from original DirectX to OpenGL API. Moreover, DirectX is depreciated and can become unsupported in future versions.
 +
***''Category:'' Graphics.
 +
***''See:''
 +
***''Usage Tips:''
 +
**<font color=red>'''Modular Tables'''</font>
 +
***''Description:'' [[TBM|*.TBM]] modular tables allow partial modifications over [[TBL|*.TBL]] standard tables.
 +
***''Category:'' Tables and modding.
 +
***''See:'' [[Modular Tables]]
 +
***''Usage Tips:''
 +
**<font color=red>'''New ''un-hardcoded'' ai_profiles.tbl table'''</font>
 +
***''Description:'' This table allows modifying some aspects of the FS2 AI behaviour (ie. how non-player ships behave during the game).
 +
***''Category:'' Tables and modding.
 +
***''See:'' [[ai_profiles.tbl]], [[Tables#Hardcoded_table_files]]
 +
***''Usage Tips:''
 +
**<font color=red>'''New ''un-hardcoded'' iff_defs.tbl table'''</font>
 +
***''Description:'' This table allows modifying AND/OR adding teams to the default FS2 ones (friendly, hostile, neutral, traitor and unknown).
 +
***''Category:'' Tables and modding.
 +
***''See:'' [[iff_defs.tbl]], [[Tables#Hardcoded_table_files]]
 +
***''Usage Tips:''
 +
**<font color=red>'''New ''un-hardcoded'' species_defs.tbl table'''</font>
 +
***''Description:'' This table allows modifying AND/OR adding species to the default FS2 ones (Terran, Vasudan and Shivan).
 +
***''Category:'' Tables and modding.
 +
***''See:'' [[species_defs.tbl]], [[Tables#Hardcoded_table_files]]
 +
***''Usage Tips:''
 +
**'''New ''un-hardcoded'' Objecttypes.tbl table'''
 +
***''Description:'' This table allows modifying AND/OR adding ship classes, (like fighter, capital, bomber, etc.) and their behaviour over default FS2 ones.
 +
***''Category:'' Tables and modding.
 +
***''See:'' [[Objecttypes.tbl]], [[Tables#Hardcoded_table_files]]
 +
***''Usage Tips:''
 +
**'''Launcher flags'''
 +
***''Description:'' Some of the new fs2_open and FRED2_open features are switched on through command line parameters. They can also be set through Launcher utility.
 +
***''Category:'' Coding.
 +
***''See:'' [[Command-Line Reference]]
 +
***''Usage Tips:''
 +
**<font color=red>'''-MOD flag'''</font>
 +
***''Description:'' It allows the usage of extra game data folders inside FS2 main folder. It is mainly used to avoid undesired mod data cross-effects.
 +
***''Category:'' Tables and modding.
 +
***''See:'' [[Command-Line Reference#-mod]], [[FS2 Data Structure]]
 +
***''Usage Tips:''
 +
**'''Enhanced texture support'''
 +
***''Description:'' The game now supports [[Wikipedia:Truevision TGA|*.TGA]], [[Wikipedia:JPG|*.JPG]] and [[Wikipedia:DirectDraw Surface|*.DDS]] textures. There's also a new format for animated textures &mdash; [[EFF|*.EFF]].
 +
***''Category:'' Tables and modding, Graphics.
 +
***''See:'' [[Texturing]], [[Command-Line Reference#-jpgtga]]
 +
***''Usage Tips:''
 +
**<font color = red>'''Specular mapping'''</font>
 +
***''Description:'' Additional maps used to set the reflectiveness and its colour of real time lighting over the ships (light from suns, explosions, weapons, warps...). It allows a huge improvement in game looking.
 +
***''Category:'' Tables and modding, Graphics.
 +
***''See:'' [[Texturing]], [[Command-Line Reference#-spec]]
 +
***''Usage Tips:''
 +
**<font color = red>'''Glow mapping'''</font>
 +
***''Description:'' Additional maps used to set full intensity rendered details over the ship hulls. They are used to simulate lights. It allows a huge improvement in game looking. They support animated textures too.
 +
***''Category:'' Tables and modding, Graphics.
 +
***''See:'' [[Texturing]], [[Command-Line Reference#-glow]]
 +
***''Usage Tips:''
 +
**'''Environmental mapping'''
 +
***''Description:'' Ship hulls reflect background bitmaps. Additionally, alpha channel of specular maps can be used to set the reflection intensity.
 +
***''Category:'' Graphics.
 +
***''See:'' [[Command-Line_Reference#-env]], [[Command-Line_Reference#-alpha_env]], [[Texturing]], [[Command-Line_Reference#-spec]] 
 +
***''Usage Tips:''
 +
**<font color = red>'''The Laboratory'''</font>
 +
***''Description:'' In every place outside a running mission press F3 key to go to The Laboratory. Here you can check details, data and appearance of all the ships and weapons that campaign or mod can use. ''WARNING: Its usage can be a huge spoiler, so use it at your own criterion''.
 +
***''Category:'' Game interface.
 +
***''See:'' [[The F3 Laboratory]]
 +
***''Usage Tips:''
 +
**'''Background Skybox model'''
 +
***''Description:'' A 3D model (*.pof) can be used as a background model. I allows adding much more background details or stars to the mission sky. It works in a similar way as retail background models for subspace missions (subspace_small.pof and subspace_big.pof).
 +
***''Category:'' Mission Features, Graphics.
 +
***''See:'' [[Skybox]], FRED Background Editor.
 +
***''Usage Tips:'' You can see their effect comparing retail FS2 campaign background with Mediavps tweaked FS2 campaign.
 +
**'''Multiple docking points'''
 +
***''Description:'' Ships are allowed to have several other docked ships. In retail only one docking point per ship could be used at the same time.
 +
***''Category:'' Mission features.
 +
***''See:'' FRED Ship Editor > Initial Status
 +
***''Usage Tips:''
 +
**'''Texture Replacement'''
 +
***''Description:'' Any of the default textures of a model can be replaced by any other.
 +
***''Category:'' Mission features.
 +
***''See:'' [[Texture_Replacement]], FRED Ships Editor
 +
***''Usage Tips:'' Apart from freak artist uses, (ie. an Orion with a Vasudan skin), its main usage is changing the "invisible" ship nameplate by that particular ship nameplate.
 +
**'''Persistent Variables'''
 +
***''Description:'' Variables can maintain their values through missions or even campaigns. This allows to pass information from one mission to other (destroyed ships, ship status, etc.)
 +
***''Category:'' Mission features.
 +
***''See:'' [[Variables]], FRED Events Editor
 +
***''Usage Tips:'' See [[Variables]] article
 +
 
 +
====21.0.0. and later builds====
 +
* '''2021-02-??'''
 +
**'''Edit Comment'''
 +
***''Description:'' Allows you to add/modify/read developer notes to events, SEXPs, or their arguments.
 +
***''Category:'' FRED interface.
 +
***''See:''
 +
***''Usage Tips:'' There's no Ok or Cancel buttons. To save, just close the window by pressing X. You cannot use line breaks in your comments.
 +
**'''Edit Background Color'''
 +
***''Description:'' Allows you to highlight events, SEXPs, or their arguments with a background color.
 +
***''Category:'' FRED interface.
 +
***''See:''
 +
***''Usage Tips:''
 +
 
 +
[[Category:Source Code Project]]

Latest revision as of 03:09, 18 February 2021

Note: There's a noticeable gap between 3.6.9 (2010) and 21.0.0 (2021). If you can help us fill the gap, please do so.

Introduction

The main purpose of the Source Code Project is enhancing the game with new features. And this has been done in such successfully way that maybe nobody knows them all. So this success can actually become a major flaw in the project because:

  1. Coders are sometimes unmotivated because they see that a lot of the effort they spend upgrading the engine is scarcely used.
  2. Modders could build better campaigns and mods if they knew all the available extra stuff.

This page is intended as an enormous log where coders can make public all their huge and great work:

  1. Main objective: From now on (July 2007) coders will have an only place where easily (more or less) post all their additions sorted by date. In this way, you will be able to check what you've missed in the last two weeks you've been on holidays without needing to dig through all HLP forum threads.
  2. Secondary objective: With time and effort, we will be able to start compiling here all the outstanding features already present. Although a bit more difficult (digging through this page, using the search function of your web browser), you can learn a lot of hidden things you didn't know about fs_open.

This list of features is indeed two lists because, more or less since version 3.6.9., the game source code was split in two branches. (Here you've got info about getting the source code in both branches).

  • HEAD branch. It contains all unstable or experimental new features. Builds based on this branch should be used only for testing and only by experimented users. They can easily crash, have bugs, corrupt pilot files or have any other undesired effect.
  • Stable branch. This branch has more tested features and, although bugs can always appear, they are supposed to be allot more stable than the HEAD branch. This branch of the code is the one used for official releases like 3.6.9. As a general rule, HEAD branch has all the Stable branch features, but Stable branch doesn't have all the HEAD branch capabilities.

Posting Rules

Warning: Please follow these rules.

Even if you don't agree with some of them, follow them. This section can grow huge and it can become a damn hell. So we need one, and only one, set of rules. And we all must follow it.

No discussion here, please. If you want any of them changed, post it to discussion in this HLP forum thread or discuss it.


  1. 1st Golden Rule: Be Extremely Brief.
    • Do not make long explanations within the lists.
    • In each entry Description section write a brief explanation.
    • If you need to be more descriptive, create a link(s) in the See section. Even create new pages if needed.
  2. 2nd Golden Rule: Be Extremely Tidy.
    • As you can imagine, this Wiki section can become a mess quite easily.
    • Always check that all the links work.
  3. As they should be quite intuitive, please follow any other example you find already posted.
  4. Be sure you know if the feature must go to HEAD Branch or Stable Branch. And please, if your feature is upgraded from the HEAD to the stable branch, update the lists and dates.
  5. Be tidy in the place and date you post. The lists, both HEAD and stable, should always be kept sorted in descending order by date (the most recent additions should go in the upper part of each section).
  6. If the CVS date for your feature doesn't exist, create a new one.
  7. Always use the ISO-8601 date format. So January 27th in 2007 should be 2007-01-27.
  8. Each new date should be a list item, ie. start it with *
    1. Each new feature in a given date should be a sublist item, ie. start it with **
    2. Each new feature has four sections. These subsections are sub-sublist items, ie. start them with ***:
      • Description: A brief description of the feature.
      • Category: The game category this feature falls in. It can be useful for people that want to look for just new "Sound" features for example. Please check the spelling and do not invent new categories. If you type "suond" or if we have one thousand different categories, this field is useless.
        You can assign several categories if you feel the feature you are posting about can fall in several areas.
        The official categories are:
        • Mission features. All the new stuff you can add to missions through FRED, ie. new sexps, backgrounds, new mission options, ...
        • FRED interface. Any other FRED improvements, like Voice Acting Manager, which don't fall in the previous one.
        • Graphics. All the extra graphical capabilities added like OGL support, shine, glow, env or normal mapping...
        • Sound. Just the same with sound and music (ogg support as example).
        • Game interface. All the game enhancements in the game mainhall and screens. Examples: F3 Lab, showing models in loadout screen, showing ship info in hud, extended hud capabilities...
        • Models. Everything that has to do with ship models like higher poly limits, glow points...
        • Tables and modding. Everything that allows modders to customize FS2 and it is not directly set in FRED as a mission feature. Examples: Data management (-MOD flag), extended texture format support, modular tables, "un-hardcoded" tables like iff_defs, 3D shockwaves, 3D warp effects...
        • Scripting. All the scripting enhancements. You can get a lot of info about scripting in Scripting.tbl table help.
        • Multiplayer. Enhancements in multi player rather than general single player ones.
        • Coding. Technical coder info which maybe is not directly seen in game but needs to be told. Like "I have changed all the arrays with pointers in this subroutine". (Sorry if I'm telling nonsenses but I'm no coder at all, I think you can imagine what I want to say).
      • See: Put the links here to related pages with deeper info about that feature. If you want to post a lot of info about your feature, create your own page and put the link here.
      • Usage Tips: In the future, creating a tips page somewhere in the Wiki is intended. In this section you could explain useful tricks. Put here the links to the tips this feature is useful for here.
        If you feel like it, you can even start that tricks page. Some discussion can be found here.
  9. Optionally, you can use the following color codes to tell the importance of the addition:
    • Critical update. (This would be an extremely important update over retail behaviour).
      • Description: Whatever...
        ...
      • Usage Tips:
    • Common update. (Normal updates).
      • Description: Whatever...
        ...
      • Usage Tips:
    • Just a tweak. (This would be just a tweak over retail FreeSpace 2).
      • Description: Whatever...
        ...
      • Usage Tips:
  10. When a new official release appears, Stable > CVS subsection name is just changed to the new build denomination and a new Stable > CVS section is created.

Feature list sorted by date

HEAD Branch (CVS) - Experimental features

  • 2007-09-27
    • Disable Primary Linking
      • Description: If a ship with the "no primary linking" flag cycles through primaries, it won't link them. This flag can be set both in ships.tbl for every ship of a class, or on a per-ship basis via SEXPs.
      • Category: Mission features.
      • See:
      • Usage Tips:
  • 2007-08-01
    • GUI Mouse Speed
      • Description: Scales the mouse speed on the menu up correctly as the resolution goes up.
      • Category: Game Interface.
      • See:
      • Usage Tips:
  • 2007-07-13
    • Training Weapons and Simulated Hull
      • Description: If a weapon with the "training" flag hits a ship, it doesn't do any real or cosmetic damage, but instead hits an invisible Simulated Hull. FREDders can interact with the Simulated Hull through the same SEXPs as they use with the Hull.
      • Category: Mission features.
      • See:
      • Usage Tips:
  • 2007-07-11
    • Ship Templates
      • Description: Ship Templates allow a Modder to shorten (sometimes significantly) their ships.tbl by defining templates that hold attributes common to multiple ships.
      • Category: Tables and modding.
      • See: Ship Templates
      • Usage Tips:You can have ship templates use other ship templates, if needed.
    • Additive Weapon Velocity
      • Description: If set, weapons will inherit their firing ship's velocity. A ship traveling quickly will fire weapons faster than a ship traveling slowly.
      • Category: Tables and modding.
      • See: ai_profiles.tbl
      • Usage Tips:
  • 2007-12-01
    • Laboratory
      • Descrption: Modified techroom. Pressing F3 toggles advanced model-viewing options.
      • Category: Interface
      • See: Laboratory article
      • Usage Tips:

Stable Branch

CVS

  • YYYY-MM-DD. Unknown date:
    • AutoPilot/Nav Points
      • Description: Autopilot and nav points system reminiscent of wing commander. Prior to july 2007 cinematics had to be done with creative sexping, starting mid july 2007 cinematics were hardcoded and enabled via mission flag or sexp (and can be disabled via sexp). System includes ships needing linkup (jul 07+), messages (jul 07+), autopilot is not allowed near hostiles (5k), debris/asteroid fields (1k, jul07+), messages and linkup distance are defined via autopilot.tbl.
      • Category: Tables and modding, Mission features.
      • See: autopilot.tbl
      • Usage Tips: Make sure to set the mission flag to use cinematics
    • Voice Acting Manager
      • Description: A very handy FRED utility which creates a systematic list of voice file names and links them to all the messages present in a mission (Command Briefing, Briefing, Debriefing and in game Messages). It also allows to create a log which contains all those messages and their assigned audio file names, (it's actually a true actor script ;) ).
      • Category: FRED Interface
      • See: FS2_Data_Structure#voice tells you where to put each kind of voice file.
      • Usage Tips:

3.6.9. and former builds

  • YYYY-MM-DD. Unknown date:
    • OpenGL support
      • Description: The game has been ported from original DirectX to OpenGL API. Moreover, DirectX is depreciated and can become unsupported in future versions.
      • Category: Graphics.
      • See:
      • Usage Tips:
    • Modular Tables
      • Description: *.TBM modular tables allow partial modifications over *.TBL standard tables.
      • Category: Tables and modding.
      • See: Modular Tables
      • Usage Tips:
    • New un-hardcoded ai_profiles.tbl table
      • Description: This table allows modifying some aspects of the FS2 AI behaviour (ie. how non-player ships behave during the game).
      • Category: Tables and modding.
      • See: ai_profiles.tbl, Tables#Hardcoded_table_files
      • Usage Tips:
    • New un-hardcoded iff_defs.tbl table
      • Description: This table allows modifying AND/OR adding teams to the default FS2 ones (friendly, hostile, neutral, traitor and unknown).
      • Category: Tables and modding.
      • See: iff_defs.tbl, Tables#Hardcoded_table_files
      • Usage Tips:
    • New un-hardcoded species_defs.tbl table
    • New un-hardcoded Objecttypes.tbl table
      • Description: This table allows modifying AND/OR adding ship classes, (like fighter, capital, bomber, etc.) and their behaviour over default FS2 ones.
      • Category: Tables and modding.
      • See: Objecttypes.tbl, Tables#Hardcoded_table_files
      • Usage Tips:
    • Launcher flags
      • Description: Some of the new fs2_open and FRED2_open features are switched on through command line parameters. They can also be set through Launcher utility.
      • Category: Coding.
      • See: Command-Line Reference
      • Usage Tips:
    • -MOD flag
      • Description: It allows the usage of extra game data folders inside FS2 main folder. It is mainly used to avoid undesired mod data cross-effects.
      • Category: Tables and modding.
      • See: Command-Line Reference#-mod, FS2 Data Structure
      • Usage Tips:
    • Enhanced texture support
    • Specular mapping
      • Description: Additional maps used to set the reflectiveness and its colour of real time lighting over the ships (light from suns, explosions, weapons, warps...). It allows a huge improvement in game looking.
      • Category: Tables and modding, Graphics.
      • See: Texturing, Command-Line Reference#-spec
      • Usage Tips:
    • Glow mapping
      • Description: Additional maps used to set full intensity rendered details over the ship hulls. They are used to simulate lights. It allows a huge improvement in game looking. They support animated textures too.
      • Category: Tables and modding, Graphics.
      • See: Texturing, Command-Line Reference#-glow
      • Usage Tips:
    • Environmental mapping
    • The Laboratory
      • Description: In every place outside a running mission press F3 key to go to The Laboratory. Here you can check details, data and appearance of all the ships and weapons that campaign or mod can use. WARNING: Its usage can be a huge spoiler, so use it at your own criterion.
      • Category: Game interface.
      • See: The F3 Laboratory
      • Usage Tips:
    • Background Skybox model
      • Description: A 3D model (*.pof) can be used as a background model. I allows adding much more background details or stars to the mission sky. It works in a similar way as retail background models for subspace missions (subspace_small.pof and subspace_big.pof).
      • Category: Mission Features, Graphics.
      • See: Skybox, FRED Background Editor.
      • Usage Tips: You can see their effect comparing retail FS2 campaign background with Mediavps tweaked FS2 campaign.
    • Multiple docking points
      • Description: Ships are allowed to have several other docked ships. In retail only one docking point per ship could be used at the same time.
      • Category: Mission features.
      • See: FRED Ship Editor > Initial Status
      • Usage Tips:
    • Texture Replacement
      • Description: Any of the default textures of a model can be replaced by any other.
      • Category: Mission features.
      • See: Texture_Replacement, FRED Ships Editor
      • Usage Tips: Apart from freak artist uses, (ie. an Orion with a Vasudan skin), its main usage is changing the "invisible" ship nameplate by that particular ship nameplate.
    • Persistent Variables
      • Description: Variables can maintain their values through missions or even campaigns. This allows to pass information from one mission to other (destroyed ships, ship status, etc.)
      • Category: Mission features.
      • See: Variables, FRED Events Editor
      • Usage Tips: See Variables article

21.0.0. and later builds

  • 2021-02-??
    • Edit Comment
      • Description: Allows you to add/modify/read developer notes to events, SEXPs, or their arguments.
      • Category: FRED interface.
      • See:
      • Usage Tips: There's no Ok or Cancel buttons. To save, just close the window by pressing X. You cannot use line breaks in your comments.
    • Edit Background Color
      • Description: Allows you to highlight events, SEXPs, or their arguments with a background color.
      • Category: FRED interface.
      • See:
      • Usage Tips:
Retrieved from "https://wiki.hard-light.net/index.php?title=SCP_Additions&oldid=63173"