Addoninfo.txt: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(→‎Keys: addonURL0 is unused)
m (→‎Non-existent or deprecated keys: They may still be useful as metainformation)
 
(23 intermediate revisions by 5 users not shown)
Line 1: Line 1:
In {{game name|l4d|name=Left 4 Dead}} and {{game name|l4d2|name=Left 4 Dead 2}}, a <code>addoninfo.txt</code> provides metadata for an addon, which is used by both the addons menu and the server browser. Its good practice to prepare a basic <code>addoninfo.txt</code> for your addons as otherwise it leads to bugs; addons with no metadata can't appear in the addons menu.
The AddonInfo.txt is a [[.txt|plain-text file]] which contains an [[VPK|addon]]’s metadata. It resides in the Root folder of addons. ''The folder containing "materials", "Models", "Sound", ect.''<br>
{{note|In {{l4d2}} when playing online, addons subscribed to the Steam Workshop takes metadata from the subscribed page, overriding the <code>addoninfo.txt</code> file.}}
This file and its functionality were introduced with the {{l4dbranch|4|nt=4}}, and is written in the ''[[KeyValues|KeyValues 1]]'' structure.<br>
{{warning|In {{l4d}}, addons don't reload until you relaunch the game.}}
In case you upload the addon to the Steam Workshop, the workshop submission's metadata (name, version, author, and description) will be used instead, but the AddonContent flags will still be read from the addoninfo.txt.<br>


== Keys ==
Both the {{Source|4|nt=1}} and the deprecated external application [[addoninstaller.exe]] will parse this file, though with significant differences.<br>
Any text that looks like <del>this</del> means that its either obsolete, or deprecated.
{{Source|4}} will parse this file from all addons listed in addonlist.txt when loading search paths from [[gameinfo.txt]] at startup and with subsequent calls to ''[[ConCommand]]'' {{Command|update_addon_paths}}.<br>
Addoninstaller.exe only parses addoninfo.txt when staging addons during user-initialized installation.<br>


=== Metadata ===
{{warning|Avoid using addoninstaller.exe to install addons. As of at least client version 2.2.2.6 of {{L4D2|4}}, the addoninstaller no longer functions as intended and actually breaks the addons that it is supposed to install.}}
These keys setup the general, but still important metadata of mods. Usually they're used for the addons menu.
{{warning|You should {{Em|always}} ship your addons with addoninfo.txt, {{Em|even if you distribute through the Steam Workshop}}. Otherwise, your users will encounter the following undesirable behavior:
* Your addon will load before all other addons specified in addonlist.txt.
* Your addon will never appear in the Addons menu, stopping you from enabling/disabling the addon. Although this only happens when the user takes the mod from the "Addons/Workshop" folder and installs it into "Addons".}}


{| class=wikitable style="width:95%; margin: auto auto;"
== Specification ==
! Key !! Description
AddonInfo.txt is a text files that determine the addon's name, version number, description and some content tags.<br>
|-
You can copy this template into a text file, edit the data according to what you need and save it as "Addoninfo.txt" in the Root folder of your addon. ''The folder containing "materials", "Models", "Sound", ect.''
| addonTitle || Title of the addon. Mind that the default addon menu can't show long titles in full.
|-
| addonAuthor || Name of the author.
|-
| addonDescription || Description of addon. In {{l4d2}}, Steam Workshop addons have a character limit of 499, regardless of UI mods.
|-
| <del>addonSteamAppID</del> || Steam App ID the addon is for. Only <code>addoninstaller.exe</code> uses this, but its still used for organization. {{tip|App ID for {{l4d}} is 500, while 550 for {{l4d2}}.}}
|-
| <del>addonURL0</del> || The addon’s homepage. Supposed to be for campaigns, but those use the key {{code|Website}} in the [[L4D2_Mission_Files|mission file]].
|-
| <del>addonTagLine</del> || Supposedly a short summary of the add-on, but no visible functionality seems to be present.
|-
| <del>addonVersion</del> || Version number of the addon; defaults to 1.0. Only <code>addoninstaller.exe</code> uses this.
|}


=== Content Tagging ===
<source>
Add-ons can be given certain tags, which is displayed next to an add-on's name, and helps quickly describes an addon. In {{l4d2}} however, tags are only visible when an addon is selected, but its possible to filter addons by tag.
"AddonInfo"
{
addonversion "1.0" //Max 31 characters. Allows decimals.
addontitle "Addon_Name_Here" //Max 127 characters.
addonauthor "Author_Name_Here" //Max 119 characters.
addonDescription "Description_Here" //Max 1023 characters.
// These booleans act as content descriptors, showing up as tags ingame.
// Users can filter addons by these tags and see what's inside without reading the description.
// Set to 1 where applicable. You can use multiple, such as "Weapons" and "skins".
addonContent_Campaign 0 //Has multiple maps that string into a campaign. Represented ingame as: Campaigns
addonContent_Map 0 //Has at least one map. Represented ingame as: Campaigns
addonContent_Skin 0 //Modifies an existing model or texture. Represented ingame as: Skins
addonContent_weapon 0 //Modifies a weapon in some way. (or adds melee weapons) Represented ingame as: Weapons
addonContent_BossInfected 0 //Modifies the Tank or the Witch. Represented ingame as: Infected
addonContent_CommonInfected 0 //Modifies CI . Represented ingame as: Infected
addonContent_Survivor 0 //Modifies Survivors. Represented ingame as: Survivors
addonContent_Sound 0 //Modifies a sound. (not for when a map is shipped with sounds) Represented ingame as: Sounds
addonContent_Music 0 //Modifies specifically music. Represented ingame as: Sounds
addonContent_Script 0 //Modifies a script. Represented ingame as: Scripts
addonContent_prop 0 //Modifies a prop Represented ingame as: Items
}</source>


{{bug|The [[Collision_mesh|Collision Mesh]] for the entire duration of the game's runtime is decided by which will be loaded first.<br>
=== Non-existent or deprecated keys ===
If you load a map with a custom prop and custom collision model, the custom one will be used on all maps until the game is restarted. If you load the original first, the original will be used on every map, including yours that would have a custom collision.<br>
''This was tested on the propane tank model.''}}


The following keys either used to exist at one point or were never properly implemented in the first place.<br>
Some of these can still be seen in the [[#“DEADLINE”|“DEADLINE”]] and [[#“DEADLINE 2”|“DEADLINE 2”]] AddonInfo.txt files, which were supposed to be an example, but they aren't used in-game.


The add-on menu has limits to tags, but its different in each game:
{| class="standard-table" style="width: 100%"
* {{l4d}} - Appends <code>'..'</code> to the addon's tags. Needs 4+ tags in {{l4d}}'s default menu UI before this happens.
! style="text-align: left" | Key  
* {{l4d2}} - Cuts off the tag's names. The limit before it happens is 30 characters for the default menu UI.
! style="text-align: left" | Description
 
|-
{| class=wikitable style="width:95%; margin: auto auto;"
| addonSteamAppID
! Key !! {{game name|l4d|name=Left 4 Dead}}'s effects !! {{game name|l4d2|name=Left 4 Dead 2}}'s effects
| The AppID of the addon’s target game. Only addoninstaller.exe uses this.
|-
|-
| addonContent_Campaign || Adds the ''<code>Campaign</code>'' tag. || Loads all assets within the addon only for the maps in the campaign's mission file; adds the ''<code>Campaigns</code>'' tag.
| addonTagline
| The addon’s subtitle or tagline. May have had a similar purpose to key poster/posterTagline in [[Mission Files|mission files]].
|-
|-
| addonContent_Map || If <code>addonContent_Campaign</code> isn't used, adds the ''<code>Maps</code>'' tag. || If <code>addonContent_Campaign</code> isn't used, adds the ''<code>Campaigns</code>'' tag.
| addonAuthorSteamID
| The addon author’s [[SteamID]]. Supposedly used to construct a URL to the author’s Steam profile page.
|-
|-
| addonContent_Survivor || Adds the ''<code>Survivor Models</code>'' tag. || Adds the ''<code>Survivors</code>'' tag.
| addonSteamGroupName
| The addon’s Steam group. Supposedly used to construct a URL to the addon’s Steam group page.
|-
|-
| addonContent_Skin || Adds the ''<code>Skins</code>'' tag. || Adds the ''<code>Skins</code>'' tag.
| addonURL0
| The addon’s homepage. May have had a similar purpose to key Website in [[Mission Files|mission files]].
|-
|-
| addonContent_BossInfected || Adds the ''<code>Boss Models</code>'' tag. || Adds the ''<code>Infected</code>'' tag.
| addonContent_Survival<br>addonContent_Versus<br>addonContent_Scavenge
| If the addon provides custom campaigns supporting the Survival, Versus, or Scavenge game modes. This functionality is provided by [[Mission Files|mission files]].
|-
|-
| addonContent_CommonInfected || Adds the ''<code>Common Models</code>'' tag. || Adds the ''<code>Infected</code>'' tag.
| addonContent_Prefab
| If the addon provides custom {{Hammer|4}} {{lc:[[Prefabs]]}}.
|-
|-
| addonContent_Music || Adds the ''<code>Music</code>'' tag. || Adds the ''<code>Sounds</code>'' tag.
| addonContent_Spray
| If the addon provides custom logos.
|-
|-
| addonContent_Sound || Adds the ''<code>Sounds</code>'' tag. || Adds the ''<code>Sounds</code>'' tag.
| addonContent_BackgroundMovie
| If the addon provides custom background movies.
|-
|-
| addonContent_Prop || Adds the ''<code>Prop Models</code>'' tag. || Adds the ''<code>Items</code>'' tag.
| Content_Weapon
| If the addon provides custom weapons (e.g., “…a new weapon, i.e. guns, explosives, booby traps, hot tar, etc.”).
|-
|-
| addonContent_Weapon || Adds the ''<code>Weapon Models</code>'' tag. || Adds the ''<code>Weapons</code>'' tag.
| Content_WeaponModel
| If the addon provides custom weapon model.
|-
|-
| addonContent_Script || Adds the ''<code>Scripts</code>'' tag. || Adds the ''<code>Scripts</code>'' tag.
| addonDescription_{{Var|locale}}
| The addon’s description localized for locale {{Var|locale}}, where {{Var|locale}} is an [[wp:List of ISO 639-1 codes|ISO 639-1 code]] in ALL CAPS.
|}
|}


=== Doesn't exist ===
== Content tag handling ==
These keys are found in the example <code>addoninfo.txt</code> from the Deadline example campaign, but does nothing when used.


{| class=wikitable style="width:95%; margin: auto auto;"
An addon’s addoninfo [[#kv-addoninfo-keys|content keys]] provide an abstraction over {{Source|4}}’s implementation-specific content tags.<br>
! Key !! Description
{{Source|4}} will convert all keys into an internal representation (typically, a bitfield).<br>
A content key {{Em|may}} correspond to its internal tag; some keys provide redundant meaning useful only to authors and distributors.<br>
{{Source|4}} will use these content tags to describe and filter addons in the [[CBaseModFrame]] Addons.<br>
 
 
=== In {{L4D|4}} and {{AS|4}} ===
 
{{L4D|4}} maintains a one-to-one correspondance between content keys and content tags. The handler closely resembles that found in the {{AS|4}} SDK.<br>
 
{{Source|4}} will generate the content label by concatenating the VGUI localization strings corresponding to the given content tag followed into an array of 60 wide characters.<br>
The right-most comma will always be replaced with a NULL terminator.<br>
The effective length of the label is 59 characters since the last character will always be a NULL terminator.<br>
 
 
 
=== In {{L4D2|4}} ===
 
{{L4D2|4}} stores the content keys for each addon as an [[integer|int16_t]] representing the following bitfield (assume little-endian):
<div style="overflow:auto">
{|class="standard-table mw-collapsible" style="overflow: auto"
|+ style="text-align: left" | {{L4D2|4}} content tag bitfield''
|-
|-
| <del>addonTagline</del> || A "wrap-up short description". How this was going to be implemented is unknown.
! style="text-align: right" scope="row" | Bit
| 15
| 14
| 13
| 12
| 11
| 10
| 9
| 8
| 7
| 6
| 5
| 4
| 3
| 2
| 1
| 0
|-
|-
| <del>addonAuthorSteamID</del> || Supposed to setup a link that goes to the author's page.
! style="text-align: right" scope="row" | Tag
| N/A
| N/A
| N/A
| N/A
| CONTENT_ITEM
| CONTENT_UI
| CONTENT_SCRIPT
| CONTENT_SOUND
| CONTENT_SURVIVOR
| CONTENT_INFECTED
| CONTENT_MUTATION
| CONTENT_WEAPON
| CONTENT_SKIN
| CONTENT_MISCELLANEOUS
| CONTENT_CAMPAIGN
| CONTENT_RESERVED
|-
|-
| <del>addonSteamGroupName</del> ||Supposed to setup a link that goes to a Steam Group's page.
! style="text-align: right" scope="row" | [[#kv-addoninfo-keys|Key]]
|-
| N/A
| <del>addonContent_Survival</del>, <del>addonContent_Versus</del>, <del>addonContent_Scavenge</del> {{only|{{l4d2}}}} || Likely meant for maps.
| N/A
|-
| N/A
| <del>addonContent_Prefab</del> || Prefabs refer to Hammer VMF prefabs. This doesn't alter the menu tags in anyway.
| N/A
|-
| addonContent_prop
| <del>addonContent_Spray</del> || This doesn't alter the menu tags in anyway.
| N/A
|-
| addonContent_Script
| <del>addonContent_BackgroundMovie</del> || 'BackgroundMovie' likely refers to the menu video.
| addonContent_Sound<br>addonContent_Music
|-
| addonContent_Survivor
| <del>Content_Weapon</del> || Supposedly for when the addon "provides a new weapon, i.e. guns, explosives, booby traps, hot tar, etc.". No such modding support exists.
| addonContent_BossInfected<br>addonContent_CommonInfected
|-
| N/A
| <del>Content_WeaponModel</del> || 'WeaponModel' points to mods that changes the looks of weapons.
| addonContent_Weapon
|-
| addonContent_Skin
| <del>addonDescription_XX</del> || Extra localization key variants for addon descriptions. The last two characters are the first two characters of the language (e.g. <code>addonDescription_FR</code> for French).
| N/A
{{Expand|
| addonContent_Campaign<br>addonContent_Map
* <code>_DA</code> - Danish
| N/A
* <code>_NL</code> - Dutch
* <code>_FI</code> - Finnish
* <code>_FR</code> - French
* <code>_DE</code> - German
* <code>_IT</code> - Italian
* <code>_JA</code> - Japanese
* <code>_KO</code> - Korean
* <code>_NO</code> - Norwegian
* <code>_PL</code> - Portuguese
* <code>_RU</code> - Russian
* <code>_ZH</code> - Chinese
* <code>_ES</code> - Spanish
* <code>_SV</code> - Sweden}}
|}
|}
</div>
The content tags CONTENT_MISCELLANEOUS, CONTENT_MUTATION, and CONTENT_UI can be set {{Em|only through the Steam Workshop}}.
{{Source|4}} will generate the content label by concatenating the VGUI localization strings corresponding to the given content tag followed into an array of 60 wide characters.
The right-most comma will always be replaced with a NULL terminator.
The effective length of the label is 59 characters since the last character will always be a NULL terminator.


== File Samples ==
== Examples ==
Below are the extensively-documented <code>addoninfo.txt</code> from the sample "Dead Line" campaign, which is the source of all keys mentioned in this page.
The following are outdated examples of old "Example campaigns". They hold now deprecated strings, but they're still useful as a basic example of what an addoninfo would look like.
Avoid using the [[#“DEADLINE”|“DEADLINE”]] or [[#“DEADLINE 2”|“DEADLINE 2”]] samples as templates. Use the one above.
=== “DEADLINE” ===


Downloads to the sample campaigns are below:
Download Valve’s “DEADLINE” campaign from [http://media.steampowered.com/apps/513/deadline.html here].
* {{l4d}} [http://media.steampowered.com/apps/513/deadline.html Dead Line]
The following snippet matches the original exactly as of April 30, 2023.
* {{l4d2}} [http://media.steampowered.com/apps/513/deadline2.html Dead Line 2]


{| style="margin: auto auto;"
<source>
|- style="vertical-align:top;"
// The addoninfo.txt file is a metadata file that is required by all Left 4 Dead Add-ons.
|{{ExpandBox|<pre>
"AddonInfo"
"AddonInfo"
{
{
"addonSteamAppID"                  "500"
addontitle "Dead Line"                                     // Add-on title that shows up in Add-ons list. ~20 chars max
"addonTitle"                      "Dead Line"
addonversion         1.3                                            // Add-on version.
"addonVersion"                    "1.0"
addontagline "Catch the last subway... out of hell."         // Add-on tagline or wrap-up- a short description. ~100 chars max
"addonTagline"                    "Catch the last subway... out of hell."
addonauthor "Valve"                                         // Name/alias of the author
"addonAuthor"                     "Valve"
addonauthorSteamID "http://steamcommunity.com/groups/Valve"       // Steam Profile URL of author or group
"addonAuthorSteamID"              "MikeDurand"
"addonSteamGroupName"              "deadlineaddon"
addonContent_Campaign 1                                 //This addon provides muliple connected maps with a finale
"addonURL0"                        "http://media.steampowered.com/apps/513/deadline.html"
 
addonURL0 "http://media.steampowered.com/apps/513/deadline.html" //An html home page for the add-on that includes a download link.
"addonContent_Campaign"            "1"
"addonContent_Survival"            "0"
// short description that appears in the Add-on list screen...
"addonContent_Scavenge"            "0"
addonDescription "Survivors must escape on a subway train in this short tutorial example campaign. Get source files and tools for creating your own campaigns by downloading the Left 4 Dead Authoring tools SDK, which is available under the 'Tools' tab in Steam."
"addonContent_Versus"              "0"
"addonContent_Map"                 "0"
// Authors can add localized descriptions here. (Not yet supported)
addonDescription_FR "Les survivants doivent s'échapper en métro dans cette carte du tutoriel. Obtenez les fichiers et les outils pour créer vos propres cartes en chargeant les outils de création SDK Left 4 Dead qui sont disponibles sous l'onglet "Outils" sur Steam."
}</source>


"addonContent_Survivor"            "0"
=== “DEADLINE 2” ===
"addonContent_Skin"                "0"


"addonContent_BossInfected"        "0"
Download Valve’s “DEADLINE 2” campaign from [http://media.steampowered.com/apps/513/deadline2.html here].
"addonContent_CommonInfected"      "0"
The following snippet matches the original exactly as of April 30, 2023.
"addonContent_Music"              "0"
"addonContent_Sound"              "0"
"addonContent_Prop"                "0"
"addonContent_Prefab"              "0"
"addonContent_Spray"              "0"
"addonContent_Script"              "0"
"addonContent_BackgroundMovie"    "0"


"Content_Weapon"                  "0"
<source>
"Content_WeaponModel"              "0"
// The addoninfo.txt file is a metadata file that is required by all Source Engine Add-ons.
 
"addonDescription"                "Survivors must escape on a subway train in this short tutorial example campaign. Get source files and tools for creating your own campaigns by downloading the Left 4 Dead 2 Authoring tools SDK, which is available under the 'Tools' tab in Steam."
"addonDescription_DA"              "Overlevende skal undslippe et S-tog i denne korte tutorial eksempel kampagne. Få kildefiler og værktøjer til at skabe dine egne kampagner ved at downloade Left 4 Dead 2 Authoring værktøjer SDK, som er tilgængelig under 'Funktioner' fanen i Steam."
"addonDescription_NL"              "Overlevenden moet ontsnappen op een metro in deze korte handleiding voorbeeld campagne. Krijg bronbestanden en tools voor het maken van uw eigen campagnes door het downloaden van de Left 4 Dead 2 Authoring gereedschappen SDK, die beschikbaar is op het tabblad 'Extra' in Steam."
"addonDescription_FI"              "Survivors on pelastautua metro tässä lyhyessä harjoitusesimerkit kampanja. Hanki lähdetiedostot ja työkalut luoda omia kampanjoita lataamalla Left 4 Dead 2 Authoring Tools SDK, joka on käytettävissä Työkalut-välilehti Steam."
"addonDescription_FR"              "Les survivants doivent s'échapper en métro dans cette carte du tutoriel. Obtenez les fichiers et les outils pour créer vos propres cartes en chargeant les outils de création SDK Left 4 Dead 2 qui sont disponibles sous l'onglet 'Outils' sur Steam."
"addonDescription_DE"              "Survivors muss auf einer U-Bahn in diesem kurzen Tutorial beispielsweise Kampagne entkommen. Holen Sie sich die Quelldateien und Werkzeuge für die Erstellung eigener Kampagnen, indem Sie die Left 4 Dead 2 Authoring Tools SDK, welches unter der Registerkarte 'Tools' in Steam."
"addonDescription_IT"              "I sopravvissuti devono sfuggire su un treno della metropolitana in questa breve campagna esempio tutorial. Ottenere file di origine e di strumenti per la creazione di campagne scaricando il Left 4 Dead 2 Authoring Tools SDK, che è disponibile sotto la scheda 'Strumenti' nel vapore."
"addonDescription_JA"              "生存者はこの短いチュートリアルの例のキャンペーンの地下鉄電車の中でエスケープする必要があります。スチームで[ツール]タブの下で利用可能ですレフト4デッドオーサリングツールのSDKをダウンロードすることにより、独自のキャンペーンを作成するためのソースファイルやツールを入手してください。"
"addonDescription_KO"              "생존자들은이 짧은 튜토리얼 예제 캠페인 지하철에서 탈출해야합니다. 증기의 '도구'탭에 따라 사용할 수 있습니다 레프트 4 데드 저작 도구 SDK를 다운로드하여 자신의 캠페인을 만들기위한 소스 파일과 도구를 얻을."
"addonDescription_NO"              "Overlevende må rømme på et tog i denne korte opplæringen eksempel kampanjen. Få kildefilene og verktøy for å lage dine egne kampanjer ved å laste ned Left 4 Dead 2 Authoring verktøy SDK, som er tilgjengelig under 'Verktøy'-fanen i Steam."
"addonDescription_PL"              "Ocaleni muszą uciekać na pociąg metra w tej krótkiej kampanii przykład samouczka. Pobierz pliki źródłowe i narzędzia do tworzenia własnych kampanii pobierając Left 4 Dead 2 Authoring narzędzi SDK, który jest dostępny w zakładce 'Narzędzia' w Steam."
"addonDescription_PT"              "Sobreviventes deve escapar em um trem do metrô nesta campanha exemplo curto tutorial. Obter arquivos de origem e ferramentas para criar suas próprias campanhas baixando o Left 4 Dead 2 Authoring ferramentas SDK, que está disponível na aba 'Ferramentas' no Steam."
"addonDescription_RU"              "Выжившие должны бежать на поезд метро, ​​в этой короткой кампании пример урока. Получить исходные файлы и инструменты для создания собственных кампаний, загрузив Left 4 Dead 2 Authoring инструментов SDK, который доступен на вкладке 'Инструменты' в Steam."
"addonDescription_ZH"              "在这个简短的示范性的战役中,生还者必须逃出地铁列车。通过下载求生之路2的专属工具(Left 4 Dead 2 Authoring tools SDK)----此SDK可以在steam平台的库中的工具一栏找到----来获取起源引擎的文件和工具以创建属于您自己的战役。"
"addonDescription_ES"              "Los sobrevivientes deben escapar en un tren subterráneo en esta corta campaña de ejemplo del tutorial. Obtenga los archivos de origen y las herramientas para crear sus propias campañas por descargar el Left 4 Dead 2 Authoring herramientas SDK, que está disponible en la pestaña 'Herramientas' en Steam."
"addonDescription_SV"              "Överlevande måste fly på ett tunnelbanetåg i denna korta handledning exempel kampanjen. Få källfiler och verktyg för att skapa dina egna kampanjer genom att ladda ner Left 4 Dead 2 Authoring Tools SDK, som är tillgänglig under 'Verktyg' fliken i Steam."
}
</pre>|Dead Line {{l4d}}}}
|{{ExpandBox|<pre>
"AddonInfo"
"AddonInfo"
{
{
"addonSteamAppID"                  "550"
addonSteamAppID         550                                                    // 500 is the app ID for Left 4 Dead, 550 for Left 4 Dead 2
"addonTitle"                      "Dead Line 2"
addontitle              "Dead Line 2"                                           // Add-on title that shows up in Add-ons list. ~20 chars max
"addonVersion"                    "1.0"
addonversion     1.0                                                     // Add-on version.
"addonTagline"                    "Catch the last subway... out of hell... Again!"
addontagline            "Catch the last subway... out of hell... Again!"     // Add-on tagline or wrap-up- a short description. ~100 chars max
"addonAuthor"                      "Valve"
addonauthor            "Valve"                                                 // Name/alias of the author
"addonAuthorSteamID"               "YasserMalaika"
addonSteamGroupName    "deadline2add-on"                                       // (Optional) Steam group related to the add-on. We use this to construct a URL to the group page.
"addonSteamGroupName"              "deadlineaddon"
addonauthorSteamID      "YasserMalaika"                                         // (Optional) Steam ID of author. We use this to construct a URL to the author's page.
"addonURL0"                        "http://media.steampowered.com/apps/513/deadline2.html"
addonContent_Campaign  1                                                     //This addon provides muliple connected maps with a finale
addonURL0               "http://media.steampowered.com/apps/513/deadline2.html" //An html home page for the add-on that includes a download link.
// short description that appears in the Add-on list screen...
addonDescription        "Survivors must escape on a subway train in this short tutorial example campaign. Get source files and tools for creating your own campaigns by downloading the Left 4 Dead 2 Authoring tools SDK, which is available under the 'Tools' tab in Steam."
// Authors can add localized descriptions here. (Not yet supported)
addonDescription_FR    "Les survivants doivent s'échapper en métro dans cette carte du tutoriel. Obtenez les fichiers et les outils pour créer vos propres cartes en chargeant les outils de création SDK Left 4 Dead 2 qui sont disponibles sous l'onglet "Outils" sur Steam."
}</source>


"addonContent_Campaign"            "1"
== See also ==
"addonContent_Survival"            "0"
"addonContent_Scavenge"            "0"
"addonContent_Versus"              "0"
"addonContent_Map"                "0"


"addonContent_Survivor"            "0"
"addonContent_Skin"                "0"
"addonContent_BossInfected"        "0"
"addonContent_CommonInfected"      "0"
"addonContent_Music"              "0"
"addonContent_Sound"              "0"
"addonContent_Prop"                "0"
"addonContent_Prefab"              "0"
"addonContent_Spray"              "0"
"addonContent_Script"              "0"
"addonContent_BackgroundMovie"    "0"
"Content_Weapon"                  "0"
"Content_WeaponModel"              "0"
"addonDescription"                "Survivors must escape on a subway train in this short tutorial example campaign. Get source files and tools for creating your own campaigns by downloading the Left 4 Dead 2 Authoring tools SDK, which is available under the 'Tools' tab in Steam."
"addonDescription_DA"              "Overlevende skal undslippe et S-tog i denne korte tutorial eksempel kampagne. Få kildefiler og værktøjer til at skabe dine egne kampagner ved at downloade Left 4 Dead 2 Authoring værktøjer SDK, som er tilgængelig under 'Funktioner' fanen i Steam."
"addonDescription_NL"              "Overlevenden moet ontsnappen op een metro in deze korte handleiding voorbeeld campagne. Krijg bronbestanden en tools voor het maken van uw eigen campagnes door het downloaden van de Left 4 Dead 2 Authoring gereedschappen SDK, die beschikbaar is op het tabblad 'Extra' in Steam."
"addonDescription_FI"              "Survivors on pelastautua metro tässä lyhyessä harjoitusesimerkit kampanja. Hanki lähdetiedostot ja työkalut luoda omia kampanjoita lataamalla Left 4 Dead 2 Authoring Tools SDK, joka on käytettävissä Työkalut-välilehti Steam."
"addonDescription_FR"              "Les survivants doivent s'échapper en métro dans cette carte du tutoriel. Obtenez les fichiers et les outils pour créer vos propres cartes en chargeant les outils de création SDK Left 4 Dead 2 qui sont disponibles sous l'onglet 'Outils' sur Steam."
"addonDescription_DE"              "Survivors muss auf einer U-Bahn in diesem kurzen Tutorial beispielsweise Kampagne entkommen. Holen Sie sich die Quelldateien und Werkzeuge für die Erstellung eigener Kampagnen, indem Sie die Left 4 Dead 2 Authoring Tools SDK, welches unter der Registerkarte 'Tools' in Steam."
"addonDescription_IT"              "I sopravvissuti devono sfuggire su un treno della metropolitana in questa breve campagna esempio tutorial. Ottenere file di origine e di strumenti per la creazione di campagne scaricando il Left 4 Dead 2 Authoring Tools SDK, che è disponibile sotto la scheda 'Strumenti' nel vapore."
"addonDescription_JA"              "生存者はこの短いチュートリアルの例のキャンペーンの地下鉄電車の中でエスケープする必要があります。スチームで[ツール]タブの下で利用可能ですレフト4デッド2オーサリングツールのSDKをダウンロードすることにより、独自のキャンペーンを作成するためのソースファイルやツールを入手してください。"
"addonDescription_KO"              "생존자들은이 짧은 튜토리얼 예제 캠페인 지하철에서 탈출해야합니다. 증기의 '도구'탭에 따라 사용할 수 있습니다 레프트 4 데드 2 제작 도구 SDK를 다운로드하여 자신의 캠페인을 만들기위한 소스 파일과 도구를 얻을."
"addonDescription_NO"              "Overlevende må rømme på et tog i denne korte opplæringen eksempel kampanjen. Få kildefilene og verktøy for å lage dine egne kampanjer ved å laste ned Left 4 Dead 2 Authoring verktøy SDK, som er tilgjengelig under 'Verktøy'-fanen i Steam."
"addonDescription_PL"              "Ocaleni muszą uciekać na pociąg metra w tej krótkiej kampanii przykład samouczka. Pobierz pliki źródłowe i narzędzia do tworzenia własnych kampanii pobierając Left 4 Dead 2 Authoring narzędzi SDK, który jest dostępny w zakładce 'Narzędzia' w Steam."
"addonDescription_PT"              "Sobreviventes deve escapar em um trem do metrô nesta campanha exemplo curto tutorial. Obter arquivos de origem e ferramentas para criar suas próprias campanhas baixando o Left 4 Dead 2 Authoring ferramentas SDK, que está disponível na aba 'Ferramentas' no Steam."
"addonDescription_RU"              "Выжившие должны бежать на поезд метро, ​​в этой короткой кампании пример урока. Получить исходные файлы и инструменты для создания собственных кампаний, загрузив Left 4 Dead 2 Authoring инструментов SDK, который доступен на вкладке 'Инструменты' в Steam."
"addonDescription_ZH"              "在这个简短的示范性的战役中,生还者必须逃出地铁列车。通过下载求生之路2的专属工具(Left 4 Dead 2 Authoring tools SDK)----此SDK可以在steam平台的库中的工具一栏找到----来获取起源引擎的文件和工具以创建属于您自己的战役。"
"addonDescription_ES"              "Los sobrevivientes deben escapar en un tren subterráneo en esta corta campaña de ejemplo del tutorial. Obtenga los archivos de origen y las herramientas para crear sus propias campañas por descargar el Left 4 Dead 2 Authoring herramientas SDK, que está disponible en la pestaña 'Herramientas' en Steam."
"addonDescription_SV"              "Överlevande måste fly på ett tunnelbanetåg i denna korta handledning exempel kampanjen. Få källfiler och verktyg för att skapa dina egna kampanjer genom att ladda ner Left 4 Dead 2 Authoring Tools SDK, som är tillgänglig under 'Verktyg' fliken i Steam."
}
</pre>|Dead Line 2 {{l4d2}}}}
|}
== See also ==
* [[L4D Campaign Add-on Tutorial]]
* [[L4D Campaign Add-on Tutorial]]
* [[L4D 2 Campaign Add-on Tutorial]]
* [[L4D 2 Campaign Add-on Tutorial]]
* [[Deadline Mission File]]
* [[Deadline Mission File]]


[[Category:Source]]
[[Category:Left 4 Dead]]
[[Category:Left 4 Dead]]
[[Category:Left 4 Dead 2]]
[[Category:Left 4 Dead 2]]
[[Category:Plain text files]]

Latest revision as of 14:15, 4 September 2025

The AddonInfo.txt is a plain-text file which contains an addon’s metadata. It resides in the Root folder of addons. The folder containing "materials", "Models", "Sound", ect.
This file and its functionality were introduced with the Left 4 Dead engine branch Left 4 Dead engine branch, and is written in the KeyValues 1 structure.
In case you upload the addon to the Steam Workshop, the workshop submission's metadata (name, version, author, and description) will be used instead, but the AddonContent flags will still be read from the addoninfo.txt.

Both the Source Source Engine and the deprecated external application addoninstaller.exe will parse this file, though with significant differences.
Source Source will parse this file from all addons listed in addonlist.txt when loading search paths from gameinfo.txt at startup and with subsequent calls to ConCommand update_addon_paths.
Addoninstaller.exe only parses addoninfo.txt when staging addons during user-initialized installation.

Warning.pngWarning:Avoid using addoninstaller.exe to install addons. As of at least client version 2.2.2.6 of Left 4 Dead 2 Left 4 Dead 2, the addoninstaller no longer functions as intended and actually breaks the addons that it is supposed to install.
Warning.pngWarning:You should always ship your addons with addoninfo.txt, even if you distribute through the Steam Workshop. Otherwise, your users will encounter the following undesirable behavior:
  • Your addon will load before all other addons specified in addonlist.txt.
  • Your addon will never appear in the Addons menu, stopping you from enabling/disabling the addon. Although this only happens when the user takes the mod from the "Addons/Workshop" folder and installs it into "Addons".

Specification

AddonInfo.txt is a text files that determine the addon's name, version number, description and some content tags.
You can copy this template into a text file, edit the data according to what you need and save it as "Addoninfo.txt" in the Root folder of your addon. The folder containing "materials", "Models", "Sound", ect.

"AddonInfo"
{
	addonversion		"1.0"				//Max 31 	characters. Allows decimals.
	addontitle			"Addon_Name_Here"	//Max 127 	characters.
	addonauthor			"Author_Name_Here"	//Max 119 	characters.
	addonDescription	"Description_Here"	//Max 1023 	characters.
	
	// These booleans act as content descriptors, showing up as tags ingame.
	// Users can filter addons by these tags and see what's inside without reading the description.
	// Set to 1 where applicable. You can use multiple, such as "Weapons" and "skins".
	addonContent_Campaign		0	//Has multiple maps that string into a campaign.				Represented ingame as: Campaigns
	addonContent_Map			0 	//Has at least one map.											Represented ingame as: Campaigns
	addonContent_Skin			0 	//Modifies an existing model or texture.						Represented ingame as: Skins
	addonContent_weapon			0 	//Modifies a weapon in some way. (or adds melee weapons)		Represented ingame as: Weapons
	addonContent_BossInfected	0 	//Modifies the Tank or the Witch.								Represented ingame as: Infected
	addonContent_CommonInfected	0 	//Modifies CI	.												Represented ingame as: Infected
	addonContent_Survivor		0 	//Modifies Survivors.											Represented ingame as: Survivors
	addonContent_Sound			0 	//Modifies a sound. (not for when a map is shipped with sounds)	Represented ingame as: Sounds
	addonContent_Music			0 	//Modifies specifically music.									Represented ingame as: Sounds
	addonContent_Script			0 	//Modifies a script.											Represented ingame as: Scripts
	addonContent_prop			0 	//Modifies a prop												Represented ingame as: Items
}

Non-existent or deprecated keys

The following keys either used to exist at one point or were never properly implemented in the first place.
Some of these can still be seen in the “DEADLINE” and “DEADLINE 2” AddonInfo.txt files, which were supposed to be an example, but they aren't used in-game.

Key Description
addonSteamAppID The AppID of the addon’s target game. Only addoninstaller.exe uses this.
addonTagline The addon’s subtitle or tagline. May have had a similar purpose to key poster/posterTagline in mission files.
addonAuthorSteamID The addon author’s SteamID. Supposedly used to construct a URL to the author’s Steam profile page.
addonSteamGroupName The addon’s Steam group. Supposedly used to construct a URL to the addon’s Steam group page.
addonURL0 The addon’s homepage. May have had a similar purpose to key Website in mission files.
addonContent_Survival
addonContent_Versus
addonContent_Scavenge
If the addon provides custom campaigns supporting the Survival, Versus, or Scavenge game modes. This functionality is provided by mission files.
addonContent_Prefab If the addon provides custom Hammer Hammer prefabs.
addonContent_Spray If the addon provides custom logos.
addonContent_BackgroundMovie If the addon provides custom background movies.
Content_Weapon If the addon provides custom weapons (e.g., “…a new weapon, i.e. guns, explosives, booby traps, hot tar, etc.”).
Content_WeaponModel If the addon provides custom weapon model.
addonDescription_locale The addon’s description localized for locale locale, where locale is an ISO 639-1 code in ALL CAPS.

Content tag handling

An addon’s addoninfo content keys provide an abstraction over Source Source’s implementation-specific content tags.
Source Source will convert all keys into an internal representation (typically, a bitfield).
A content key may correspond to its internal tag; some keys provide redundant meaning useful only to authors and distributors.
Source Source will use these content tags to describe and filter addons in the CBaseModFrame Addons.


In Left 4 Dead Left 4 Dead and Alien Swarm Alien Swarm

Left 4 Dead Left 4 Dead maintains a one-to-one correspondance between content keys and content tags. The handler closely resembles that found in the Alien Swarm Alien Swarm SDK.

Source Source will generate the content label by concatenating the VGUI localization strings corresponding to the given content tag followed into an array of 60 wide characters.
The right-most comma will always be replaced with a NULL terminator.
The effective length of the label is 59 characters since the last character will always be a NULL terminator.


In Left 4 Dead 2 Left 4 Dead 2

Left 4 Dead 2 Left 4 Dead 2 stores the content keys for each addon as an int16_t representing the following bitfield (assume little-endian):

Left 4 Dead 2 Left 4 Dead 2 content tag bitfield
Bit 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
Tag N/A N/A N/A N/A CONTENT_ITEM CONTENT_UI CONTENT_SCRIPT CONTENT_SOUND CONTENT_SURVIVOR CONTENT_INFECTED CONTENT_MUTATION CONTENT_WEAPON CONTENT_SKIN CONTENT_MISCELLANEOUS CONTENT_CAMPAIGN CONTENT_RESERVED
Key N/A N/A N/A N/A addonContent_prop N/A addonContent_Script addonContent_Sound
addonContent_Music
addonContent_Survivor addonContent_BossInfected
addonContent_CommonInfected
N/A addonContent_Weapon addonContent_Skin N/A addonContent_Campaign
addonContent_Map
N/A

The content tags CONTENT_MISCELLANEOUS, CONTENT_MUTATION, and CONTENT_UI can be set only through the Steam Workshop.

Source Source will generate the content label by concatenating the VGUI localization strings corresponding to the given content tag followed into an array of 60 wide characters. The right-most comma will always be replaced with a NULL terminator. The effective length of the label is 59 characters since the last character will always be a NULL terminator.

Examples

The following are outdated examples of old "Example campaigns". They hold now deprecated strings, but they're still useful as a basic example of what an addoninfo would look like. Avoid using the “DEADLINE” or “DEADLINE 2” samples as templates. Use the one above.

“DEADLINE”

Download Valve’s “DEADLINE” campaign from here. The following snippet matches the original exactly as of April 30, 2023.

// The addoninfo.txt file is a metadata file that is required by all Left 4 Dead Add-ons. 
"AddonInfo"
{
	addontitle		"Dead Line"                                     // Add-on title that shows up in Add-ons list. ~20 chars max
	addonversion	        1.3                                             // Add-on version.
	addontagline		"Catch the last subway... out of hell."	        // Add-on tagline or wrap-up- a short description. ~100 chars max
	addonauthor 		"Valve"                                         // Name/alias of the author
	addonauthorSteamID 	"http://steamcommunity.com/groups/Valve"        // Steam Profile URL of author or group
	
	addonContent_Campaign		1 	                                //This addon provides muliple connected maps with a finale
	
	addonURL0 "http://media.steampowered.com/apps/513/deadline.html"	//An html home page for the add-on that includes a download link.
	
	// short description that appears in the Add-on list screen...
	addonDescription "Survivors must escape on a subway train in this short tutorial example campaign. Get source files and tools for creating your own campaigns by downloading the Left 4 Dead Authoring tools SDK, which is available under the 'Tools' tab in Steam."
	
	// Authors can add localized descriptions here. (Not yet supported)
	addonDescription_FR "Les survivants doivent s'échapper en métro dans cette carte du tutoriel. Obtenez les fichiers et les outils pour créer vos propres cartes en chargeant les outils de création SDK Left 4 Dead qui sont disponibles sous l'onglet "Outils" sur Steam."	
}

“DEADLINE 2”

Download Valve’s “DEADLINE 2” campaign from here. The following snippet matches the original exactly as of April 30, 2023.

// The addoninfo.txt file is a metadata file that is required by all Source Engine Add-ons.
"AddonInfo"
{
	addonSteamAppID         550                                                     // 500 is the app ID for Left 4 Dead, 550 for Left 4 Dead 2
	addontitle              "Dead Line 2"                                           // Add-on title that shows up in Add-ons list. ~20 chars max
	addonversion	     1.0                                                     // Add-on version.
	addontagline            "Catch the last subway... out of hell... Again!"	     // Add-on tagline or wrap-up- a short description. ~100 chars max
	addonauthor             "Valve"                                                 // Name/alias of the author
	addonSteamGroupName     "deadline2add-on"                                       // (Optional) Steam group related to the add-on. We use this to construct a URL to the group page.
	addonauthorSteamID      "YasserMalaika"                                         // (Optional) Steam ID of author. We use this to construct a URL to the author's page.
	addonContent_Campaign   1 	                                                     //This addon provides muliple connected maps with a finale
	addonURL0               "http://media.steampowered.com/apps/513/deadline2.html" //An html home page for the add-on that includes a download link.
	
	// short description that appears in the Add-on list screen...
	addonDescription        "Survivors must escape on a subway train in this short tutorial example campaign. Get source files and tools for creating your own campaigns by downloading the Left 4 Dead 2 Authoring tools SDK, which is available under the 'Tools' tab in Steam."
	
	// Authors can add localized descriptions here. (Not yet supported)
	addonDescription_FR     "Les survivants doivent s'échapper en métro dans cette carte du tutoriel. Obtenez les fichiers et les outils pour créer vos propres cartes en chargeant les outils de création SDK Left 4 Dead 2 qui sont disponibles sous l'onglet "Outils" sur Steam."	
}

See also