Liblist.gam: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
Line 10: Line 10:
===Options===
===Options===
Keys that affect what tabs and options that show up in the Options panel. Also see [[Customizing Options: Keyboard]].
Keys that affect what tabs and options that show up in the Options panel. Also see [[Customizing Options: Keyboard]].
{{KV|type|string|This keyvalue is either {{mono|singleplayer_only}}, {{mono|multiplayer_only}}, or omitted.}}
{{KV|type|intn=0|string|This keyvalue is either {{mono|singleplayer_only}}, {{mono|multiplayer_only}}, or omitted.}}
{{KV|nomodels|boolean|Hides option to select a multiplayer model{{confirm}}?}}
{{KV|nomodels|intn=0|boolean|Hides option to select a multiplayer model{{confirm}}?}}
{{KV|nohimodels|boolean|Hides option to enable HD models in video settings menu.}}
{{KV|nohimodels|intn=0|boolean|Hides option to enable HD models in video settings menu.}}
{{KV|detailed_textures|boolean|Show option to enable detail textures in video settings menu. This option will be greyed out if the client GPU does not report support for {{mono|GL_ARB_multitexture}}.}}
{{KV|detailed_textures|intn=0|boolean|Show option to enable detail textures in video settings menu. This option will be greyed out if the client GPU does not report support for {{mono|GL_ARB_multitexture}}.}}


===Steam games list===
===Steam games list===
Keys that affect how your game or mod shows up in the Steam Library page.
Keys that affect how your game or mod shows up in the Steam Library page.
{{KV|icon|string|Relative path to 16×16 24-bit {{mono|.tga}} file.
{{KV|icon|intn=0|string|Relative path to 16×16 24-bit {{mono|.tga}} file.
{{note|The icon can also be a PNG, but it must have a {{mono|.tga}} file extension!}}
{{note|The icon can also be a PNG, but it must have a {{mono|.tga}} file extension!}}
}}
}}
{{KV|developer|string|The developer of the mod. Usually either the Mod Team’s name, or a single person’s name. Doesn’t work on current Steam version. Also works on the WON version.|deprecated=1}}
{{KV|developer|intn=0|string|The developer of the mod. Usually either the Mod Team’s name, or a single person’s name. Doesn’t work on current Steam version. Also works on the WON version.|deprecated=1}}
{{KV|developer_url|string|Your or the mod’s URL. Must start with {{mono|<nowiki>http://</nowiki>}}. Doesn’t work on current Steam version. Also works on the WON version.|deprecated=1}}
{{KV|developer_url|intn=0|string|Your or the mod’s URL. Must start with {{mono|<nowiki>http://</nowiki>}}. Doesn’t work on current Steam version. Also works on the WON version.|deprecated=1}}
{{KV|manual|string|Relative path to digital game manual. Doesn’t work on current Steam version. Also works on the WON version.|deprecated=1}}
{{KV|manual|intn=0|string|Relative path to digital game manual. Doesn’t work on current Steam version. Also works on the WON version.|deprecated=1}}


===WON/Retail version only===
===WON/Retail version only===
These are the keys that only works with the original version of the game (retroactively called as '''Retail/WON''' version)
These are the keys that only works with the original version of the game (retroactively called as '''Retail/WON''' version)
{{KV|url_info|string|Same as {{code|developer_url}}. Displayed on the Custom Game list.}}
{{KV|url_info|intn=0|string|Same as {{code|developer_url}}. Displayed on the Custom Game list.}}
{{KV|size|string|Game size in bytes. Displayed on the Custom Game list.}}
{{KV|size|intn=0|string|Game size in bytes. Displayed on the Custom Game list.}}


===Engine and tools===
===Engine and tools===
Keys that affect how the engine/tools runs and some options for the tools themselves.
Keys that affect how the engine/tools runs and some options for the tools themselves.
{{KV|gamedll|string|This keyvalue refers to the game DLL file relative to the mod's root folder. Path separators should be {{mono|\}}.}}
{{KV|gamedll|intn=0|string|This keyvalue refers to the game DLL file relative to the mod's root folder. Path separators should be {{mono|\}}.}}
{{KV|gamedll_linux|string|This keyvalue refers to the game SO file relative to the mod's root folder. Path separators should be {{mono|/}}.}}
{{KV|gamedll_linux|intn=0|string|This keyvalue refers to the game SO file relative to the mod's root folder. Path separators should be {{mono|/}}.}}
{{KV|gamedll_osx|string|This keyvalue refers to the game DYLIB file relative to the mod's root folder. Path separators should be {{mono|/}}.}}
{{KV|gamedll_osx|intn=0|string|This keyvalue refers to the game DYLIB file relative to the mod's root folder. Path separators should be {{mono|/}}.}}
{{KV|secure|string|Allow VAC secure server.}}
{{KV|secure|intn=0|string|Allow VAC secure server.}}
{{KV|svonly|boolean|Is this a server only mod?}}
{{KV|svonly|boolean|Is this a server only mod?}}
{{KV|cldll|boolean|}}
{{KV|cldll|intn=0|boolean|}}
{{KV|edicts|int|Change maximum number of [[edicts]]; Default {{mono|1200}}, max {{mono|2048}}.}}
{{KV|edicts|intn=0|int|Change maximum number of [[edicts]]; Default {{mono|1200}}, max {{mono|2048}}.}}


===Maps===
===Maps===
Keys that affect what are the available maps to play.
Keys that affect what are the available maps to play.
{{KV|startmap|map|Which map to load upon starting a new game on the menu.}}
{{KV|startmap|intn=0|map|Which map to load upon starting a new game on the menu.}}
{{KV|trainmap|map|Which map to load upon selecting training course on the New Game menu.}}
{{KV|trainmap|intn=0|map|Which map to load upon selecting training course on the New Game menu.}}
{{KV|mpentity|entity|{{obs}} This keyvalue is WON only. Use mpfilter instead.}}
{{KV|mpentity|intn=0|entity|{{obs}} This keyvalue is WON only. Use mpfilter instead.}}
{{KV|mpfilter|string|Do not show maps with names containing this string in Create Server dialogue.}}
{{KV|mpfilter|intn=0|string|Do not show maps with names containing this string in Create Server dialogue.}}
{{KV|fallback_dir|string|This keyvalue specifies a mod directory (i.e., {{mono|cstrike}}, {{mono|NS}}, etc.…) for the filesystem to mount. This will only mount mods installed to {{mono|steamapps\common\half-life\}} and ''Half-Life'' itself.}}
{{KV|fallback_dir|intn=0|string|This keyvalue specifies a mod directory (i.e., {{mono|cstrike}}, {{mono|NS}}, etc.…) for the filesystem to mount. This will only mount mods installed to {{mono|steamapps\common\half-life\}} and ''Half-Life'' itself.}}
{{KV|fallback_maps|boolean|Used by GameUI to determine whether maps should be loaded from the {{mono|"GAME_FALLBACK"}} [[IFileSystemV009#Path_IDs|search path ID]]. Defaults to true. If the game is "Half-Life", all search paths are checked for maps. Otherwise, GameUI will load maps from the {{mono|"GAME"}} path ID as well as {{mono|"GAMEDOWNLOAD"}}. If this setting is not false, the fallback path ID is also checked.}}
{{KV|fallback_maps|intn=0|boolean|Used by GameUI to determine whether maps should be loaded from the {{mono|"GAME_FALLBACK"}} [[IFileSystemV009#Path_IDs|search path ID]]. Defaults to true. If the game is "Half-Life", all search paths are checked for maps. Otherwise, GameUI will load maps from the {{mono|"GAME"}} path ID as well as {{mono|"GAMEDOWNLOAD"}}. If this setting is not false, the fallback path ID is also checked.}}


==Example==
==Example==

Revision as of 21:10, 29 May 2024

English (en)Русский (ru)Translate (Translate)

Stub

This article or section is a stub. You can help by expanding it.

Settings

Name

Keys that affect the menu and window title.

game ([todo internal name (i)]) <string>
The string specified under game appears as the title for the window when the mod is running; it is also used in My Games List

Options

Keys that affect what tabs and options that show up in the Options panel. Also see Customizing Options: Keyboard.

type <string>
This keyvalue is either singleplayer_only, multiplayer_only, or omitted.
nomodels <boolean>
Hides option to select a multiplayer model[confirm]?
nohimodels <boolean>
Hides option to enable HD models in video settings menu.
detailed_textures <boolean>
Show option to enable detail textures in video settings menu. This option will be greyed out if the client GPU does not report support for GL_ARB_multitexture.

Steam games list

Keys that affect how your game or mod shows up in the Steam Library page.

icon <string>
Relative path to 16×16 24-bit .tga file.
Note.pngNote:The icon can also be a PNG, but it must have a .tga file extension!
developer <string> Obsolete
Deprecated.
The developer of the mod. Usually either the Mod Team’s name, or a single person’s name. Doesn’t work on current Steam version. Also works on the WON version.
developer_url <string> Obsolete
Deprecated.
Your or the mod’s URL. Must start with http://. Doesn’t work on current Steam version. Also works on the WON version.
manual <string> Obsolete
Deprecated.
Relative path to digital game manual. Doesn’t work on current Steam version. Also works on the WON version.

WON/Retail version only

These are the keys that only works with the original version of the game (retroactively called as Retail/WON version)

url_info <string>
Same as developer_url. Displayed on the Custom Game list.
size <string>
Game size in bytes. Displayed on the Custom Game list.

Engine and tools

Keys that affect how the engine/tools runs and some options for the tools themselves.

gamedll <string>
This keyvalue refers to the game DLL file relative to the mod's root folder. Path separators should be \.
gamedll_linux <string>
This keyvalue refers to the game SO file relative to the mod's root folder. Path separators should be /.
gamedll_osx <string>
This keyvalue refers to the game DYLIB file relative to the mod's root folder. Path separators should be /.
secure <string>
Allow VAC secure server.
svonly ([todo internal name (i)]) <boolean>
Is this a server only mod?
cldll <boolean>
edicts <integer>
Change maximum number of edicts; Default 1200, max 2048.

Maps

Keys that affect what are the available maps to play.

startmap <map>
Which map to load upon starting a new game on the menu.
trainmap <map>
Which map to load upon selecting training course on the New Game menu.
mpentity <entity>
Obsolete This keyvalue is WON only. Use mpfilter instead.
mpfilter <string>
Do not show maps with names containing this string in Create Server dialogue.
fallback_dir <string>
This keyvalue specifies a mod directory (i.e., cstrike, NS, etc.…) for the filesystem to mount. This will only mount mods installed to steamapps\common\half-life\ and Half-Life itself.
fallback_maps <boolean>
Used by GameUI to determine whether maps should be loaded from the "GAME_FALLBACK" search path ID. Defaults to true. If the game is "Half-Life", all search paths are checked for maps. Otherwise, GameUI will load maps from the "GAME" path ID as well as "GAMEDOWNLOAD". If this setting is not false, the fallback path ID is also checked.

Example

A full working liblist.gam ready for a GoldSrc GoldSrc game. Originally from Half-Life Half-Life (post 25th anniversary update), with some modifications.

valve\liblist.gam
LIBLIST.GAM
// Valve Game Info file // These are key/value pairs. Certain mods will use different settings. // game "Your Game/Mod Title here" startmap "c0a0" trainmap "t0a0" mpentity "info_player_deathmatch" gamedll "dlls\hl.dll" gamedll_linux "dlls/hl.so" gamedll_osx "dlls/hl.dylib" secure "1" type "singleplayer_only" // Only in 25th anniversary update: animated_title "1" hd_background "1"

Utilities

XBLAH's Modding Tool XBLAH's Modding Tool

  • The mod information can be edited with XBLAH's Modding Tool through a comprehensive UI without requiring the modder to mess with text files.

External links

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Liblist.gam&oldid=404419"