Addoninfo.txt: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Changed the explanation to be more aligned with the intended wiki styling. Some keys have their "copy pasted" description stripped away, as it didn't fit.)
m (addonURL0)
Line 35: Line 35:
| addonSteamGroupName || (Optional) Steam group related to the add-on, which will be used to construct an URL to the group page. {{todo|How does this look like?}}
| addonSteamGroupName || (Optional) Steam group related to the add-on, which will be used to construct an URL to the group page. {{todo|How does this look like?}}
|-
|-
| addonURL0 || Home page of addon with a download link {{note|Only used for maps/campaigns, if they are '''not''' downloaded from the workshop. 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 || If the addon is a series of connected maps with a finale.
| addonContent_Campaign || If the addon is a series of connected maps with a finale.

Revision as of 11:09, 15 April 2021

Left 4 Dead seriesLeft 4 Dead seriesAddoninfo.txtcontains metadata for add-ons in the Left 4 Dead series. When its respective addon is installed outside of theaddons/workshopfolder, or locally, this file will fill the add-on with the necessary metadatas.

Warning.pngWarning:Addons withoutaddoninfo.txtwill not be accessible when installed locally. You should always include one, since users may choose to install the addons locally after downloading them from the Steam Workshop.

Template

A smalladdoninfo.txtfilled with the important keys. For details on the keys, refer below.

"AddonInfo"
{
     addonSteamAppID	"550"

     addonauthor	" "
     addonversion	"1"
     addontitle		" " 
     addonDescription	" " 
}

Keys

Some of the keys present are for the add-ons menu's tag filter sorting system.

Key Description
addonSteamAppID Steam App ID the add-on is for. Put 500 for Left 4 Dead and 550 for Left 4 Dead 2.
addonTitle Title of the add-on. Mind that the default add-on menu can't show long titles in full.
addonVersion Version number of the add-on. Used to determine if an user's add-on is mismatched to the lobby hoster's.
Confirm:It is best to keep the number as an integer, so no decimals.
addonTagline Tagline/wrap-up short description; for custom map add-ons only. In Left 4 Dead seriesLeft 4 Dead series, it appears only when selecting a custom map in the game setup menu.
Confirm:In Left 4 Dead, it is present when viewing the scoreboard in the custom map; right below the map's title.
addonAuthor Name of the author.
addonAuthorSteamID (Optional) Steam ID of author, which will be used to construct an URL to the author's page.
Todo: How does this look like?
addonSteamGroupName (Optional) Steam group related to the add-on, which will be used to construct an URL to the group page.
Todo: How does this look like?
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.pngNote: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 If the addon is a series of connected maps with a finale.
addonContent_Survival If the addon supports survival gamemode.
addonContent_Scavenge If the addon supports scavenge gamemode.
addonContent_Versus If the addon supports versus gamemode.
addonContent_Map If the addon is a standalone map.
addonContent_Survivor If the addon replaces a character model: 0=false, 1=true, String in quotes if replaces specific single character, i.e. "Coach".
addonContent_Skin If the addon provides a new skin: 0 for no new skin(s), 1 for multiple skins.
Left 4 Dead 2 String for single skin possible.
Todo: How is this string set up?
addonContent_BossInfected If the addon provides a new Tank or Witch model.
addonContent_CommonInfected If the addon provides new common infected models.
addonContent_Music If the addon has music replacements.
addonContent_Sound If the addon has sound replacements.
addonContent_Prop If the addon has props replacements.
addonContent_Prefab If the addon has custom prefabs. (E.g. Hammer VMF prefabs)
addonContent_Spray If the addon provides new sprays.
addonContent_Script If the addon has scripts.
addonContent_BackgroundMovie If the addon replaces the background movie.
Content_Weapon If the addon provides a new weapon, i.e. guns, explosives, booby traps, hot tar, etc.
Content_WeaponModel If the addon overrides a weapon skin (for existing weapons).
addonDescription Description of addon.
addonDescription_DA Danish description.
addonDescription_NL Dutch description.
addonDescription_FI Finnish description.
addonDescription_FR French description.
addonDescription_DE German description.
addonDescription_IT Italian description
addonDescription_JA Japanese description
addonDescription_KO Korean description
addonDescription_NO Norwegian description
addonDescription_PL Polish description
addonDescription_PT Portuguese description
addonDescription_RU Russian description
addonDescription_ZH Chinese description
addonDescription_ES Spanish description
addonDescription_SV Swedish description

Deadline 1 & 2

This is the addoninfo metadata file included with the sample Deadline campaign. Feel free to use this as a template for the metadata for your own custom addons.
The full add-on and source files can be downloaded off a website hosted by Steam:

Left 4 Dead

"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."
}

Left 4 Dead 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."
}

See also