Addoninfo.txt: Difference between revisions
m (Orinuse moved page Deadline AddonInfo File to L4D AddonInfo Authoring: the page got reworked, doesn't fit as just "Deadline AddonInfo File". Especially since this page uses {{DISPLAYTITLE}} to change the page name to "addoninfo.txt") |
(category tags are now given descriptions of what they do in L4D1 and L4D2; Renamed two sections; Revised the introduction to also include l4d1 and l4d2 only info) |
||
Line 1: | Line 1: | ||
{{DISPLAYTITLE:Addoninfo.txt}} | {{DISPLAYTITLE:Addoninfo.txt}} | ||
{{l4ds}} | In {{l4ds}}, add-ons require metadata setup to appear in the add-ons menu with the proper descriptions, be categorizable by the tags sorting system, or load assets at only the appropiate moment. This is all done with the<code>addoninfo.txt</code>file. In {{l4d2}}, add-ons attained from workshop subscription uses the Steam Workshop to build metadata, so<code>addoninfo.txt</code>file is either only for locally installed add-ons, or workshop add-ons converted into a local add-on. | ||
{{warning|Add-ons without<code>addoninfo.txt</code>will not be accessible in the menu when installed locally! Even in {{l4d2}}, you should build a<code>addoninfo.txt</code>file for add-ons submitted to the Steam Workshop, since users ''do'' convert the add-ons locally.}} | |||
{{note|In {{l4d}}, add-ons don't reload until you relaunch the game, whereas in {{l4d2}}, add-ons reload everytime you enter and exit the add-ons menu, but are locked from being replaced while its active.}} | |||
{ | |||
== Keys == | == Keys == | ||
Some of the keys present are for the add-ons menu's tag filter | Some of the keys present are for the add-ons menu's tag system only.<code>'..'</code> will be appended if the add-on has 4+ tags for {{l4d}}'s default menu UI, while for {{l4d2}}'s default menu UI, its a 30 character limited. In {{l4d2}}, add-ons will be filtered to appear for the respective tag filter settings. | ||
{| class=wikitable | | {| class=wikitable | | ||
! Key !! Description | ! Key !! Description | ||
Line 37: | Line 26: | ||
| addonURL0 || Home page of addon with a download link. Appears only in the menu when trying to join games, or joining a lobby eith a content you don't have downloaded. (e.g. Mutations) {{note|Some websites allow you to create a page for your addon before you publish it. Copy that "Unpublished" addon link into this field.}} | | addonURL0 || Home page of addon with a download link. Appears only in the menu when trying to join games, or joining a lobby eith a content you don't have downloaded. (e.g. Mutations) {{note|Some websites allow you to create a page for your addon before you publish it. Copy that "Unpublished" addon link into this field.}} | ||
|- | |- | ||
| addonContent_Campaign || | | addonContent_Campaign || {{l4ds}} Modifies add-on assets to only load when the maps set in the mission file are loaded. <br>Also marks add-on with''<code>Campaign</code>''tag in {{l4d}}, while the''<code>Campaigns</code>''tag in {{l4d2}}. {{confirm|Is the first sentence's statement true for {{l4d}}?}} | ||
|- | |- | ||
| addonContent_Survival || | | addonContent_Survival || {{todo|Exact function unknown.}} | ||
|- | |- | ||
| addonContent_Scavenge || | | addonContent_Scavenge {{only|{{l4d2}}}} || {{todo|Exact function unknown.}} | ||
|- | |- | ||
| addonContent_Versus || | | addonContent_Versus || {{todo|Exact function unknown.}} | ||
|- | |- | ||
| addonContent_Map || | | addonContent_Map || In {{l4d}}, marks add-on with''<code>Maps</code>''tag. In {{l4d2}}, marks add-on with''<code>Campaigns</code>''tag. {{l4ds}} Doesn't get used if<code>addonContent_Campaign</code>is already used. | ||
|- | |- | ||
| addonContent_Survivor || | | addonContent_Survivor || In {{l4d}}, marks add-on with''<code>Survivor Models</code>''tag. In {{l4d2}}, marks add-on with''<code>Survivors</code>''tag. Use a single string in quotes if replaces specific single character, i.e. "Coach".<br>{{todo|Clarify the latter}} | ||
|- | |- | ||
| addonContent_Skin || | | addonContent_Skin || In {{l4ds}}, marks add-on with''<code>Skins</code>''tag. In {{l4d2}}, use a single string for single skin possible. {{todo|How is the single string set up, and what would happen if we do this?}} | ||
|- | |- | ||
| addonContent_BossInfected || | | addonContent_BossInfected || In {{l4d}}, marks add-on with''<code>Boss Models</code>''tag. In {{l4d2}}, marks add-on with''<code>Infected</code>''tag. Doesn't conflict with<code>addonContent_BossInfected</code>tag. | ||
|- | |- | ||
| addonContent_CommonInfected || | | addonContent_CommonInfected || In {{l4d}}, marks add-on with''<code>Common Models</code>''tag. In {{l4d2}}, marks add-on with''<code>Infected</code>''tag. Doesn't conflict with<code>addonContent_CommonInfected</code>tag. | ||
|- | |- | ||
| addonContent_Music || | | addonContent_Music || In {{l4d}}, marks add-on with''<code>Music</code>''tag. In {{l4d2}}, marks add-on with''<code>Sounds</code>''tag. | ||
|- | |- | ||
| addonContent_Sound || | | addonContent_Sound || In {{l4ds}}, marks add-on with''<code>Sounds</code>''tag. | ||
|- | |- | ||
| addonContent_Prop || | | addonContent_Prop || In {{l4d}}, marks add-on with''<code>Prop Models</code>''tag. In {{l4d2}}, marks add-on with''<code>Items</code>''tag. | ||
|- | |- | ||
| | | addonContent_Weapon || In {{l4d}}, marks add-on with''<code>Weapon Models</code>''tag. In {{l4d2}}, marks add-on with''<code>Weapons</code>''tag. | ||
|- | |- | ||
| | | addonContent_Script || In {{l4ds}}, marks add-on with''<code>Scripts</code>''tag. | ||
|- | |- | ||
| | | <del>addonContent_Prefab</del> {{obs}} || Deprecated. Prefabs refer to Hammer VMF prefabs. This doesn't alter the menu tags in anyway. | ||
|- | |- | ||
| | | <del>addonContent_Spray</del> {{obs}} || Deprecated. This doesn't alter the menu tags in anyway. | ||
|- | |- | ||
| | | <del>addonContent_BackgroundMovie</del> {{obs}} || Deprecated. This doesn't alter the menu tags in anyway. | ||
|- | |- | ||
| | | <del>Content_Weapon</del> {{obs}} || Deprecated. Meant to be used when the addon "provides a new weapon, i.e. guns, explosives, booby traps, hot tar, etc.". This might not be technically feasible in {{l4d}}, while too much effort required in {{l4d2}}. This doesn't alter the menu tags in anyway. | ||
|- | |- | ||
| addonDescription || Description of addon. In {{l4d2}}, Add-ons | | <del>Content_WeaponModel</del> {{obs}} || Deprecated. Meant to be used when the addon overrides a weapon skin (for existing weapons). This doesn't alter the menu tags in anyway. | ||
|- | |||
| addonDescription || Description of addon. In {{l4d2}}, Add-ons from subscription of Steam Workshop have a 499 characters limit for descriptions.<br>This tag has extra localization key variants (e.g.<code>addonDescription_DA</code>) meant to be accessed by appending certain characters at the right of this key; all of them being: | |||
* _DA - Danish | * _DA - Danish | ||
* _NL - Dutch | * _NL - Dutch | ||
Line 88: | Line 79: | ||
* _ES - Spanish | * _ES - Spanish | ||
* _SV - Sweden | * _SV - Sweden | ||
{{confirm|Are these localization tags defunct? | {{confirm|Are these localization tags defunct? In {{l4d2}}, reports of the workshop localization working only on the webpage, but don't transfer to the in-game menu, exists.}} | ||
|} | |} | ||
== | == File Samples == | ||
These are the addoninfo metadata files from the sample Deadline campaign in in both {{l4ds}}, which is meant to provide example material for custom [[Add-on|add-ons]].<br> | |||
The full add-on and source files can be downloaded off a website hosted by Steam: | The full add-on and source files can be downloaded off a website hosted by Steam: | ||
* {{l4d}} [http://media.steampowered.com/apps/513/deadline.html Dead Line] | * {{l4d}} [http://media.steampowered.com/apps/513/deadline.html Dead Line] | ||
* {{l4d2}} [http://media.steampowered.com/apps/513/deadline2.html Dead Line 2] | * {{l4d2}} [http://media.steampowered.com/apps/513/deadline2.html Dead Line 2] | ||
=== | === Dead Line {{l4d}} === | ||
{{ExpandBox|nostarterlinebreak=1| | |||
<pre> | <pre> | ||
"AddonInfo" | "AddonInfo" | ||
Line 148: | Line 140: | ||
"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." | "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> | </pre>}} | ||
=== | === Dead Line 2 {{l4d2}} === | ||
{{ExpandBox|nostarterlinebreak=1| | |||
<pre> | <pre> | ||
"AddonInfo" | "AddonInfo" | ||
Line 203: | Line 196: | ||
} | } | ||
</pre> | </pre> | ||
}} | |||
== See also == | == See also == |
Revision as of 05:32, 30 April 2021
In , add-ons require metadata setup to appear in the add-ons menu with the proper descriptions, be categorizable by the tags sorting system, or load assets at only the appropiate moment. This is all done with the
addoninfo.txt
file. In , add-ons attained from workshop subscription uses the Steam Workshop to build metadata, so
addoninfo.txt
file is either only for locally installed add-ons, or workshop add-ons converted into a local add-on.

addoninfo.txt
will not be accessible in the menu when installed locally! Even in 
addoninfo.txt
file for add-ons submitted to the Steam Workshop, since users do convert the add-ons locally.


Keys
Some of the keys present are for the add-ons menu's tag system only.'..'
will be appended if the add-on has 4+ tags for 's default menu UI, while for
's default menu UI, its a 30 character limited. In
, add-ons will be filtered to appear for the respective tag filter settings.
File Samples
These are the addoninfo metadata files from the sample Deadline campaign in in both , which is meant to provide example material for custom add-ons.
The full add-on and source files can be downloaded off a website hosted by Steam:
Dead Line 
"AddonInfo" { "addonSteamAppID" "500" "addonTitle" "Dead Line" "addonVersion" "1.0" "addonTagline" "Catch the last subway... out of hell." "addonAuthor" "Valve" "addonAuthorSteamID" "MikeDurand" "addonSteamGroupName" "deadlineadd-on" "addonURL0" "http://media.steampowered.com/apps/513/deadline.html" "addonContent_Campaign" "1" "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デッドオーサリングツールの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." }
Dead Line 2 
"AddonInfo" { "addonSteamAppID" "550" "addonTitle" "Dead Line 2" "addonVersion" "1.0" "addonTagline" "Catch the last subway... out of hell... Again!" "addonAuthor" "Valve" "addonAuthorSteamID" "YasserMalaika" "addonSteamGroupName" "deadlineadd-on" "addonURL0" "http://media.steampowered.com/apps/513/deadline2.html" "addonContent_Campaign" "1" "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." }