This article's documentation is for the "GoldSrc" engine. Click here for more information.

Liblist.gam: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Add TWHL link)
No edit summary
Line 2: Line 2:
{{stub|Several items have no description. Several other items can be found in vanilla LIBLIST.GAMs, such as url_info, url_dl, version, size, and hlversion; do these do anything (or did they on WON)?}}
{{stub|Several items have no description. Several other items can be found in vanilla LIBLIST.GAMs, such as url_info, url_dl, version, size, and hlversion; do these do anything (or did they on WON)?}}


game "string"
==Basic settings==
icon "string"
developer "string"
developer_url "string"
manual "string"
gamedll "string"
gamedll_linux "string"
gamedll_osx "string"
secure "{{boolean}}"
svonly "{{boolean}}"
cldll "{{boolean}}"
type "..."
startmap "<map>"
trainmap "<map>"
mpentity "<ent>"
mpfilter "string"
fallback_dir "string"
fallback_maps "{{boolean}}"
nomodels "{{boolean}}"
nohimodels "{{boolean}}"
detailed_textures "{{boolean}}"


;<code>game</code>
===Name===
:The string specified under <code>game</code> appears as the title for the window when the mod is running; it is also used in My Games List.
Keys that affect the menu and window title.


;<code>icon</code>
{{KV|game|string|The string specified under <code>game</code> appears as the title for the window when the mod is running; it is also used in My Games List}}
:Relative path to 16×16 24-bit <code>.tga</code> file.


;<code>developer</code>
===Options===
:
Keys that affect what tabs and options that show up in the Options panel. Also see [[Customizing Options: Keyboard]].


;<code>developer_url</code>
{{KV|type|string|This keyvalue is either <code>singleplayer_only</code>, <code>multiplayer_only</code>, or omitted.}}
:
{{KV|nomodels|boolean|Unknown function.}}
{{KV|nohimodels|boolean|Show 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 <code>GL_ARB_multitexture</code>.}}


;<code>manual</code>
===Steam games list===
:Relative path to digial game manual.
Keys that affect how your game or mod shows up in the Steam Library page.


;<code>gamedll</code>
{{KV|icon|string|Relative path to 16×16 24-bit <code>.tga</code> file}}
:This keyvalue refers to the game DLL file relative to the mod's root folder. Path separators should be <code>\</code>.
{{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.|deprecated=1}}
{{KV|developer_url|string|Your or the mod’s URL. Must start with <code><nowiki>http://</nowiki></code>. Doesn’t work on current Steam version.|deprecated=1}}
{{KV|manual|string|Relative path to digital game manual. Doesn’t work on current Steam version.|deprecated=1}}


;<code>gamedll_linux</code>
===Engine and tools===
:This keyvalue refers to the game SO file relative to the mod's root folder. Path separators should be <code>/</code>.
Keys that affect how the engine/tools runs and some options for the tools themselves.


;<code>gamedll_osx</code>
{{KV|gamedll|string|This keyvalue refers to the game DLL file relative to the mod's root folder. Path separators should be <code>\</code>.}}
:This keyvalue refers to the game DYLIB file relative to the mod's root folder. Path separators should be <code>/</code>.
{{KV|gamedll_linux|string|This keyvalue refers to the game SO file relative to the mod's root folder. Path separators should be <code>/</code>.}}
{{KV|gamedll_osx|string|This keyvalue refers to the game DYLIB file relative to the mod's root folder. Path separators should be <code>/</code>.}}
{{KV|secure|string|Allow VAC secure server.}}
{{KV|svonly|boolean|Is this a server only mod?}}
{{KV|cldll|boolean|}}


;<code>secure</code>
===Maps===
:Allow VAC secure server.
Keys that affect what are the available maps to play.


;<code>svonly</code>
{{KV|startmap|map|Which map to load upon starting a new game.}}
:Is this a server only mod?
{{KV|trainmap|map|Which map to load upon selecting training course.}}
{{KV|mpentity|ent|{{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|fallback_dir|string|This keyvalue specifies a mod directory (i.e., <code>cstrike</code>, <code>NS</code>, etc.…) for the filesystem to mount. This will only mount mods installed to <code>steamapps\common\half-life\</code> and ''Half-Life'' itself.}}
{{KV|fallback_maps|boolean|Used by GameUI to determine whether maps should be loaded from the <code>"GAME_FALLBACK"</code> [[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 <code>"GAME"</code> path ID as well as <code>"GAMEDOWNLOAD"</code>. If this setting is not false, the fallback path ID is also checked.}}


;<code>type</code>
==Example==
:This keyvalue is either <code>singleplayer_only</code>, <code>multiplayer_only</code>, or omitted.
A full working GameInfo.txt ready for a {{src13|4}} game.


;<code>startmap</code>
{{CodeBlock|<nowiki>// Valve Game Info file
:Which map to load upon starting a new game.
// These are key/value pairs.  Certain mods will use different settings.
//
game "Half-Life"
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"
</nowiki>}}


;<code>trainmap</code>
==Editing the game info with XBLAH’s Modding Tool==
:Which map to load upon selecting training course.
The mod information can be edited with {{Xblahmt|4}} through a comprehensive UI without requiring the modder to mess with text files. It includes all the major keys of {{gldsrc|3}}, more than enough for the majority of {{gldsrc|3}} modders.


;<code>mpentity</code>
<br/><span style="color:#FFF; font-weight:bold">Where to find it</span><br/>
:{{obs}} This keyvalue is WON only. Use mpfilter instead.
This can be accessed within the tool through '''Mod > Game info'''.


;<code>mpfilter</code>
<br/><span style="color:#FFF; font-weight:bold">How to use it</span><br/>
:Do not show maps with names containing this string in Create Server dialogue.


;<code>fallback_dir</code>
==== Steam Library ====
:This keyvalue specifies a mod directory (i.e., <code>cstrike</code>, <code>NS</code>, etc.…) for the filesystem to mount. This will only mount mods installed to <code>steamapps\common\half-life\</code> and ''Half-Life'' itself.
You can set the mod’s name and import an icon from common picture formats. It will not show on the Steam Library.


;<code>fallback_maps</code>
[[File:XBLAH's Modding Tool - Game Info (GoldSrc) v1.16.2.png]]
:Used by GameUI to determine whether maps should be loaded from the <code>"GAME_FALLBACK"</code> [[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 <code>"GAME"</code> path ID as well as <code>"GAMEDOWNLOAD"</code>. If this setting is not false, the fallback path ID is also checked.


;<code>nomodels</code>
:Unknown function.
;<code>nohimodels</code>
:Show option to enable HD models in video settings menu.
;<code>detailed_textures</code>
: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 <code>GL_ARB_multitexture</code>.


==External links==
==External links==

Revision as of 06:42, 14 May 2023

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

Stub

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

Basic 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 ([todo internal name (i)]) <string>
This keyvalue is either singleplayer_only, multiplayer_only, or omitted.
nomodels ([todo internal name (i)]) <boolean>
Unknown function.
nohimodels ([todo internal name (i)]) <boolean>
Show option to enable HD models in video settings menu.
detailed_textures ([todo internal name (i)]) <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 ([todo internal name (i)]) <string>
Relative path to 16×16 24-bit .tga file
developer ([todo internal name (i)]) <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.
developer_url ([todo internal name (i)]) <string> Obsolete
Deprecated.
Your or the mod’s URL. Must start with http://. Doesn’t work on current Steam version.
manual ([todo internal name (i)]) <string> Obsolete
Deprecated.
Relative path to digital game manual. Doesn’t work on current Steam version.

Engine and tools

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


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

Maps

Keys that affect what are the available maps to play.


startmap ([todo internal name (i)]) <map>
Which map to load upon starting a new game.
trainmap ([todo internal name (i)]) <map>
Which map to load upon selecting training course.
mpentity ([todo internal name (i)]) <ent>
Obsolete This keyvalue is WON only. Use mpfilter instead.
mpfilter ([todo internal name (i)]) <string>
Do not show maps with names containing this string in Create Server dialogue.
fallback_dir ([todo internal name (i)]) <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 ([todo internal name (i)]) <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 GameInfo.txt ready for a Source 2013 Source 2013 game.

// Valve Game Info file // These are key/value pairs. Certain mods will use different settings. // game "Half-Life" 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"

Editing the game info with XBLAH’s Modding Tool

The mod information can be edited with XBLAH's Modding Tool XBLAH's Modding Tool through a comprehensive UI without requiring the modder to mess with text files. It includes all the major keys of GoldSrc, more than enough for the majority of GoldSrc modders.


Where to find it
This can be accessed within the tool through Mod > Game info.


How to use it

Steam Library

You can set the mod’s name and import an icon from common picture formats. It will not show on the Steam Library.

XBLAH's Modding Tool - Game Info (GoldSrc) v1.16.2.png


External links