Addoninfo.txt: Difference between revisions
m (→Keys: moved the "Obsolete" tempolate in the list in front of the title. For aestetics) |
(refurbished the *whole* page. Changes cannot be summarized specifically for this) |
||
Line 1: | Line 1: | ||
In {{ | In {{game name|l4d|name=Left 4 Dead}} and {{game name|l4d2|name=Left 4 Dead 2}}, addons use <code>addoninfo.txt</code> to setup the proper metadata in the addons menu, or for the server browser. Without this, addons will not be visible in the menu. However in {{l4d2}}, loading addons from the Steam Workshop (requires being online) will automatically build metadata, which also overrides the <code>addoninfo.txt</code> file. | ||
{{warning| | {{warning|Even in {{l4d2}}, you should ''still'' build a <code>addoninfo.txt</code> file for Steam Workshop addons, as users '''do'' convert the addons into a 'local addon' (addons not tied to subscriptions, and don't need internet).}} | ||
{{ | {{warning|In {{l4d}}, addons don't reload until you relaunch the game.}} | ||
== Keys == | == Keys == | ||
Any text that looks like <del>this</del> means that its either obsolete, or deprecated. | |||
{| class=wikitable | |||
=== Metadata === | |||
These keys setup the general, but still important metadata of mods. Usually they're used for the addons menu. | |||
{| class=wikitable style="width:95%; margin: auto auto;" | |||
! Key !! Description | ! Key !! Description | ||
|- | |- | ||
| | | addonTitle || Title of the addon. Mind that the default addon menu can't show long titles in full. | ||
|- | |- | ||
| | | addonAuthor || Name of the author. | ||
|- | |- | ||
| | | addonURL0 || Home page of addon with a download link. Used for server browsers, or joining a lobby without the necessities downloaded. (e.g. Mutations) | ||
|- | |- | ||
| | | 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>addonVersion</del> || Version number of the addon; defaults to 1.0. Only <code>addoninstaller.exe</code> uses this. | ||
|} | |||
=== Content Tagging === | |||
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. | |||
The add-on menu has limits to tags, but its different in each game: | |||
* {{l4d}} - Appends <code>'..'</code> to the addon's tags. Needs 4+ tags in {{l4d}}'s default menu UI before this happens. | |||
* {{l4d2}} - Cuts off the tag's names. The limit before it happens is 30 characters for the default menu UI. | |||
{| class=wikitable style="width:95%; margin: auto auto;" | |||
! Key !! {{game name|l4d|name=Left 4 Dead}}'s effects !! {{game name|l4d2|name=Left 4 Dead 2}}'s effects | |||
|- | |- | ||
| | | 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. | ||
|- | |- | ||
| | | 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. | ||
|- | |- | ||
| | | addonContent_Survivor || Adds the ''<code>Survivor Models</code>'' tag. || Adds the ''<code>Survivors</code>'' tag. A single "string" can be used instead if needed. (e.g. "Coach")<br>{{todo|What does that do?}} | ||
|- | |- | ||
| | | addonContent_Skin || Adds the ''<code>Skins</code>'' tag. || Adds the ''<code>Skins</code>'' tag. Using a single string instead is possible. {{todo|What does that do?}} | ||
|- | |- | ||
| | | addonContent_BossInfected || Adds the ''<code>Boss Models</code>'' tag. || Adds the ''<code>Infected</code>'' tag. | ||
|- | |- | ||
| | | addonContent_CommonInfected || Adds the ''<code>Common Models</code>'' tag. || Adds the ''<code>Infected</code>'' tag. | ||
|- | |- | ||
| | | addonContent_Music || Adds the ''<code>Music</code>'' tag. || Adds the ''<code>Sounds</code>'' tag. | ||
|- | |- | ||
| | | addonContent_Sound || Adds the ''<code>Sounds</code>'' tag. || Adds the ''<code>Sounds</code>'' tag. | ||
|- | |- | ||
| | | addonContent_Prop || Adds the ''<code>Prop Models</code>'' tag. || Adds the ''<code>Items</code>'' tag. | ||
|- | |- | ||
| | | addonContent_Weapon || Adds the ''<code>Weapon Models</code>'' tag. || Adds the ''<code>Weapons</code>'' tag. | ||
|- | |- | ||
| | | addonContent_Script || Adds the ''<code>Scripts</code>'' tag. || Adds the ''<code>Scripts</code>'' tag. | ||
|} | |||
=== Doesn't exist === | |||
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;" | |||
! Key !! Description | |||
|- | |- | ||
| | | <del>addonTagline</del> || A "wrap-up short description". How this was going to be implemented is unknown. | ||
|- | |- | ||
| | | <del>addonAuthorSteamID</del> || Supposed to setup a link that goes to the author's page. | ||
|- | |- | ||
| | | <del>addonSteamGroupName</del> ||Supposed to setup a link that goes to a Steam Group's page. | ||
|- | |- | ||
| | | <del>addonContent_Survival</del>, <del>addonContent_Versus</del>, <del>addonContent_Scavenge</del> {{only|{{l4d2}}}} || Likely meant for maps. | ||
|- | |- | ||
| | | <del>addonContent_Prefab</del> || Prefabs refer to Hammer VMF prefabs. This doesn't alter the menu tags in anyway. | ||
|- | |- | ||
| | | <del>addonContent_Spray</del> || This doesn't alter the menu tags in anyway. | ||
|- | |- | ||
| | | <del>addonContent_BackgroundMovie</del> || 'BackgroundMovie' likely refers to the menu video. | ||
|- | |- | ||
| | | <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. | ||
|- | |- | ||
| | | <del>Content_WeaponModel</del> || 'WeaponModel' points to mods that changes the looks of weapons. | ||
|- | |- | ||
| | | <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. e.g.<code>addonDescription_FR</code> for French). All of the documented ones are: | ||
{{ExpandBox| | |||
* _DA - Danish | * _DA - Danish | ||
* _NL - Dutch | * _NL - Dutch | ||
Line 72: | Line 92: | ||
* _JA - Japanese | * _JA - Japanese | ||
* _KO - Korean | * _KO - Korean | ||
* _NO - Norwegian | * _NO - Norwegian | ||
* _PL - | * _PL - Portuguese | ||
* _RU - Russian | * _RU - Russian | ||
* _ZH - Chinese | * _ZH - Chinese | ||
* _ES - Spanish | * _ES - Spanish | ||
* _SV - Sweden | * _SV - Sweden}} | ||
|} | |} | ||
== File Samples == | == File Samples == | ||
You'll find the addoninfo metadata files from the sample Deadline campaign, displayed here. | |||
Downloads to the sample campaign are below: | |||
* {{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] | ||
{{ExpandBox| | {| style="margin: auto auto;" | ||
<pre> | |- style="vertical-align:top;" | ||
|{{ExpandBox|<pre> | |||
"AddonInfo" | "AddonInfo" | ||
{ | { | ||
Line 98: | Line 118: | ||
"addonAuthor" "Valve" | "addonAuthor" "Valve" | ||
"addonAuthorSteamID" "MikeDurand" | "addonAuthorSteamID" "MikeDurand" | ||
"addonSteamGroupName" " | "addonSteamGroupName" "deadlineaddon" | ||
"addonURL0" "http://media.steampowered.com/apps/513/deadline.html" | "addonURL0" "http://media.steampowered.com/apps/513/deadline.html" | ||
"addonContent_Campaign" "1" | "addonContent_Campaign" "1" | ||
"addonContent_Survival" "0" | "addonContent_Survival" "0" | ||
Line 106: | Line 126: | ||
"addonContent_Versus" "0" | "addonContent_Versus" "0" | ||
"addonContent_Map" "0" | "addonContent_Map" "0" | ||
"addonContent_Survivor" "0" | "addonContent_Survivor" "0" | ||
"addonContent_Skin" "0" | "addonContent_Skin" "0" | ||
"addonContent_BossInfected" "0" | "addonContent_BossInfected" "0" | ||
"addonContent_CommonInfected" "0" | "addonContent_CommonInfected" "0" | ||
Line 119: | Line 139: | ||
"addonContent_Script" "0" | "addonContent_Script" "0" | ||
"addonContent_BackgroundMovie" "0" | "addonContent_BackgroundMovie" "0" | ||
"Content_Weapon" "0" | "Content_Weapon" "0" | ||
"Content_WeaponModel" "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" "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_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." | ||
Line 140: | Line 160: | ||
"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 {{l4d}}}} | ||
|{{ExpandBox|<pre> | |||
{{ExpandBox| | |||
<pre> | |||
"AddonInfo" | "AddonInfo" | ||
{ | { | ||
Line 153: | Line 170: | ||
"addonAuthor" "Valve" | "addonAuthor" "Valve" | ||
"addonAuthorSteamID" "YasserMalaika" | "addonAuthorSteamID" "YasserMalaika" | ||
"addonSteamGroupName" " | "addonSteamGroupName" "deadlineaddon" | ||
"addonURL0" "http://media.steampowered.com/apps/513/deadline2.html" | "addonURL0" "http://media.steampowered.com/apps/513/deadline2.html" | ||
"addonContent_Campaign" "1" | "addonContent_Campaign" "1" | ||
"addonContent_Survival" "0" | "addonContent_Survival" "0" | ||
Line 161: | Line 178: | ||
"addonContent_Versus" "0" | "addonContent_Versus" "0" | ||
"addonContent_Map" "0" | "addonContent_Map" "0" | ||
"addonContent_Survivor" "0" | "addonContent_Survivor" "0" | ||
"addonContent_Skin" "0" | "addonContent_Skin" "0" | ||
"addonContent_BossInfected" "0" | "addonContent_BossInfected" "0" | ||
"addonContent_CommonInfected" "0" | "addonContent_CommonInfected" "0" | ||
Line 174: | Line 191: | ||
"addonContent_Script" "0" | "addonContent_Script" "0" | ||
"addonContent_BackgroundMovie" "0" | "addonContent_BackgroundMovie" "0" | ||
"Content_Weapon" "0" | "Content_Weapon" "0" | ||
"Content_WeaponModel" "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" "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_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." | ||
Line 195: | Line 212: | ||
"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}}}} | ||
|} | |||
== See also == | == See also == |
Revision as of 22:01, 29 October 2021
In Template:Game name and Template:Game name, addons use addoninfo.txt
to setup the proper metadata in the addons menu, or for the server browser. Without this, addons will not be visible in the menu. However in , loading addons from the Steam Workshop (requires being online) will automatically build metadata, which also overrides the
addoninfo.txt
file.


addoninfo.txt
file for Steam Workshop addons, as users 'do convert the addons into a 'local addon' (addons not tied to subscriptions, and don't need internet).Keys
Any text that looks like this means that its either obsolete, or deprecated.
Metadata
These keys setup the general, but still important metadata of mods. Usually they're used for the addons menu.
Content Tagging
Add-ons can be given certain tags, which is displayed next to an add-on's name, and helps quickly describes an addon. In however, tags are only visible when an addon is selected, but its possible to filter addons by tag.
The add-on menu has limits to tags, but its different in each game:
- Appends
'..'
to the addon's tags. Needs 4+ tags in's default menu UI before this happens.
- Cuts off the tag's names. The limit before it happens is 30 characters for the default menu UI.
Key | Template:Game name's effects | Template:Game name's effects |
---|---|---|
addonContent_Campaign | Adds the Campaign tag. |
Loads all assets within the addon only for the maps in the campaign's mission file; adds the Campaigns tag.
|
addonContent_Map | If addonContent_Campaign isn't used, adds the Maps tag. |
If addonContent_Campaign isn't used, adds the Campaigns tag.
|
addonContent_Survivor | Adds the Survivor Models tag. |
Adds the Survivors tag. A single "string" can be used instead if needed. (e.g. "Coach")Todo: What does that do?
|
addonContent_Skin | Adds the Skins tag. |
Adds the Skins tag. Using a single string instead is possible. Todo: What does that do?
|
addonContent_BossInfected | Adds the Boss Models tag. |
Adds the Infected tag.
|
addonContent_CommonInfected | Adds the Common Models tag. |
Adds the Infected tag.
|
addonContent_Music | Adds the Music tag. |
Adds the Sounds tag.
|
addonContent_Sound | Adds the Sounds tag. |
Adds the Sounds tag.
|
addonContent_Prop | Adds the Prop Models tag. |
Adds the Items tag.
|
addonContent_Weapon | Adds the Weapon Models tag. |
Adds the Weapons tag.
|
addonContent_Script | Adds the Scripts tag. |
Adds the Scripts tag.
|
Doesn't exist
These keys are found in the example addoninfo.txt
from the Deadline example campaign, but does nothing when used.
File Samples
You'll find the addoninfo metadata files from the sample Deadline campaign, displayed here.
Downloads to the sample campaign are below: