View source for GameMenu.res

{{path|game or mod/resource/GameMenu[[.res]]}} is the file that controls the menu buttons that will appear in the in-game menu. Mods can use this for adding new [[convar|command]] buttons to their main menu. 

They are simply a text document saved with a .res extension. 

== Example ==
{{Example}} from {{HL2|4}}:
{{pre|"GameMenu"
{
	"1"
	{
		"label" "#GameUI_GameMenu_ResumeGame"
		"InGameOrder" "10"
		"OnlyInGame" "1"
	}
	"2"
	{
		"label" "#GameUI_GameMenu_Disconnect"
		"command" "Disconnect"
		"OnlyInGame" "1"
		"notsingle" "1"
	}
//	"3"	[$WIN32] // from portal
//	{
//		"label" "#GameUI_GameMenu_BonusMaps"
//		"command" "OpenBonusMapsDialog"
//		"InGameOrder" "50"
//		"notmulti" "1"
//	}
	"3"

	{
		"label" "#GameUI_GameMenu_PlayerList"
		"command" "OpenPlayerListDialog"
		"OnlyInGame" "1"
		"notsingle" "1"
	}
	"4"     //devider
	{
		"label" ""
		"command" ""
		"OnlyInGame" "1"
	}
	"5"
	{
		"label" "#GameUI_GameMenu_NewGame"
		"command" "OpenNewGameDialog"
		"notmulti" "1"  //nomulti will make this button not appear when in MP mode
	}
	"6"
	{
		"label" "#GameUI_GameMenu_LoadGame"
		"command" "OpenLoadGameDialog"
		"notmulti" "1"
	}
	"7"
	{
		"label" "#GameUI_GameMenu_SaveGame"
		"command" "OpenSaveGameDialog"
		"notmulti" "1"
		"OnlyInGame" "1"
	}
	"8"
	{
		"label" "#GameUI_GameMenu_Achievements"
		"command" "OpenAchievementsDialog"
		"InGameOrder" "70"
	}
//         "8" 
//	{
//		"label" "#GameUI_Controller"
//		"command" "OpenControllerDialog"
//		"InGameOrder" "80"
//		"ConsoleOnly" "1"
//	}
	"9"
	{
		"label" ""
		"command" ""
		"notmulti" "1"
	}
	"10"
	{
		"label" "#GameUI_GameMenu_FindServers"
		"command" "OpenServerBrowser"
		"notsingle" "1"
	}
	"11"
	{
		"label" "#GameUI_GameMenu_CreateServer"
		"command" "OpenCreateMultiplayerGameDialog"
		"notsingle" "1"
	}
	"12"
	{
		"label" "#GameUI_GameMenu_Friends"
		"command" "OpenFriendsDialog"
	}
//	"13"  // not needed
//	{
//		"name" "LoadDemo"
//		"label" "#GameUI_GameMenu_PlayDemo"
//		"command" "OpenLoadDemoDialog"
//	}
	"14"
	{
		"label" ""
		"command" ""
		"notsingle" "1"
	}
	"15"
	{
		"label" "#GameUI_GameMenu_Options"
		"command" "OpenOptionsDialog"
	}
	"16"
	{
		"label" "#GameUI_GameMenu_Quit"
		"command" "Quit"
	}
}
}}

== File format ==
=== Parameters ===
{| class="wikitable"
|-
! Parameter !! Purpose
|-
| name ||
|-
| label || The display text of the button. If appended with a pound symbol, it will correspond to the corresponding key-value pair in gameui_<LANGUAGE>.txt.
|-
| command || The command to run when the button is clicked, not to be confused with a [[console command]] (although console commands can be run using <code>engine <command></code>). See [[#List of commands|List of commands]] for a list.
|-
| notsingle || If set to "1", will not display in singleplayer.
|-
| notmulti || If set to "1", will not display in multiplayer.
|-
| InGameOrder ||
|-
| OnlyInGame || If set to "1", will only display if the user is currently ingame.
|-
| ConsoleOnly || If set to "1", will only display on consoles, such as the Xbox 360.
|}

=== Commands ===
This is the list of commands that can be assigned to a GameMenu button. You can try these in the console with <code>gamemenucommand</code>. Some of these only work on multiplayer mods, some command can't be issued in the main menu and some only works on the Xbox 360 platform.
There are several undocumented commands and those are not shown here.
{| class="wikitable"
|-
! Command !! What it does !! Notes
|-
| OpenPlayerListDialog || Players can mute other players here || Non-functional on singleplayer branch
|-
| OpenNewGameDialog || Shows the chapter selection window ||
|-
| OpenLoadGameDialog || Shows the load game window || X360 has a different dialog.
|-
| OpenSaveGameDialog || Shows the save game window || X360 has a different dialog.
|-
| OpenBonusMapsDialog || Shows the "[[Bonus Maps]]" dialog ||
|-
| OpenOptionsDialog || Shows the options dialog|| X360 has a different dialog.
|-
| OpenControllerDialog || Shows controller settings || Only works on console UI.
|-
| OpenBenchmarkDialog || Opens the Lost Coast benchmark dialog || 
|-
| OpenServerBrowser || Shows a list of game servers || Also opens on singleplayer.
|-
| OpenFriendsDialog || Shows a list of Steam friends || Non-functional.
|-
| OpenLoadDemoDialog || Does nothing (maybe it's supposed to show demoui) ||
|-
| OpenCreateMultiplayerGameDialog || Shows the listen server creation dialog || First page works on singleplayer.
|-
| OpenChangeGameDialog || Non-functional, players can load other games/mods here || (Leftover from GoldSrc?)
|-
| OpenLoadCommentaryDialog || Shows a dialog with a list of commentaries || This is for multiplayer games
|-
| OpenLoadSingleplayerCommentaryDialog || Shows the new game dialog, but this one starts the game in commentary mode || This is for singleplayer games
|-
| OpenMatchmakingBasePanel || Unknown, maybe used for [[Team Fortress 2]] || On Source 2013 this opens an transparent panel covering the whole screen, effectively making the menu unusable
|-
| OpenAchievementsDialog || Shows the achievements dialog || Shows a message if the player is not using Steam or is logged off. On X360 the native dialog is shown.
|-
| Quit || Shows the quit confirmation dialog ||
|-
| QuitNoConfirm || Closes the game without confirmation ||
|-
| ResumeGame || Hides the menu when in-game || 
|-
| Disconnect || Disconnects from the game || Shows a confirmation dialog on X360
|-
| DisconnectNoConfirm || Disconnects from the game without confirmation || Also closes all dialogs if the Matchmaking Base Panel is open
|-
| engine <concommand> || Executes console command <concommand>. Some creative examples include engine [[connect]].<sup>2341</sup> ||
|-
| RestartWithNewLanguage || Closes the game and makes it start in a new language next time. || Only works on PC. Used when the spoken language is modified in the Audio options. Works by setting a string value called a "Relaunch URL" in regedit with value <code>steam://run/<appid>/<language></code>. This makes Steam execute this URL after the current game exits. (doesn't work with mods)
|}

== Files ==
Inside the {{path|game or mod/resource}} folder.

== References ==
GameMenu.res by massivegod https://gamebanana.com/scripts/2341

[[Category:Source]]

[[Category:Plain text formats]]
[[Category:Plain text files]]

{{cleanup|1. Sections are more useful than tables here because they are easier to link.}}