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
(→‎Basic settings: add edicts modifier)
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)?}}


==Basic settings==
==Settings==


===Name===
===Name===
Keys that affect the menu and window title.
Keys that affect the menu and window title.
{{KV|game|string|The string specified under {{mono|game}} appears as the title for the window when the mod is running; it is also used in My Games List}}
{{KV|game|string|The string specified under {{mono|game}} appears as the title for the window when the mod is running; it is also used in My Games List}}


===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|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|boolean|Hides option to select a multiplayer model{{confirm}}?}}
Line 19: Line 17:
===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|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!}}
Line 34: Line 31:
===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|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|string|This keyvalue refers to the game SO file relative to the mod's root folder. Path separators should be {{mono|/}}.}}
Line 41: Line 37:
{{KV|svonly|boolean|Is this a server only mod?}}
{{KV|svonly|boolean|Is this a server only mod?}}
{{KV|cldll|boolean|}}
{{KV|cldll|boolean|}}
{{KV|edicts|int|Change maximum number of [[edicts]]; Default {{mono|900}}, 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|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|map|Which map to load upon selecting training course on the New Game menu.}}

Revision as of 09:06, 30 May 2023

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 ([todo internal name (i)]) <string>
This keyvalue is either singleplayer_only, multiplayer_only, or omitted.
nomodels ([todo internal name (i)]) <boolean>
Hides option to select a multiplayer model[confirm]?
nohimodels ([todo internal name (i)]) <boolean>
Hides 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.
Note.pngNote:The icon can also be a PNG, but it must have a .tga file extension!
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. Also works on the WON 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. Also works on the WON version.
manual ([todo internal name (i)]) <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 ([todo internal name (i)]) <string>
Same as developer_url. Displayed on the Custom Game list.
size ([todo internal name (i)]) <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 ([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>
edicts ([todo internal name (i)]) <integer>
Change maximum number of edicts; Default 900, max 2048.

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 on the menu.
trainmap ([todo internal name (i)]) <map>
Which map to load upon selecting training course on the New Game menu.
mpentity ([todo internal name (i)]) <entity>
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 liblist.gam ready for a GoldSrc GoldSrc game. Originally from Half-Life Half-Life.

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"

Editing the game info with XBLAH’s Modding Tool

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

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.

External links