menu_example.cfg

// ----------------------------------------------------------------------------
// CUSTOM IMGUI MENU CONFIG EXAMPLE
// This file is both a working example and documentation for the menu format.
// Save as, for example: valve/menu_example.cfg
//
// Load in-game with:
//     exec_menu menu_example.cfg
//
// GLOBAL IMGUI STYLE (OPTIONAL)
//
// These commands (stylecolor/stylevar/stylevar2) must appear BEFORE the first
// 'window' directive. They override the built-in default style used by the
// code. You can remove this whole section if you like the default style.
// ----------------------------------------------------------------------------

// stylecolor <Name> R G B A -- all values are floats [0..1]
stylecolor Text 1.00 1.00 1.00 1.00
stylecolor WindowBg 0.06 0.06 0.06 0.94
stylecolor Button 0.26 0.59 0.98 0.40
stylecolor ButtonHovered 0.26 0.59 0.98 1.00
stylecolor ButtonActive  0.06 0.53 0.98 1.00

// stylevar <Name> value -- single float style variables
stylevar Alpha 1.0
stylevar WindowRounding  3.0

// stylevar2 <Name> X Y -- ImVec2 style variables
stylevar2 WindowPadding 8 8
stylevar2 ItemSpacing 8 4

// ----------------------------------------------------------------------------
// window "Title" { ... }
//
// - Title must be in quotes.
// - Everything inside { } are menu items or sub-blocks (submenu/tabbar/tab).
// ----------------------------------------------------------------------------
window "Example Menu"
{
    // ------------------------------------------------------------------------
    // text "Label"
    // - Draws a simple text label.
    // ------------------------------------------------------------------------
    text "Example custom ImGui menu built from cfg"

    // Blank line and separator line for readability
    separator

    // ------------------------------------------------------------------------
    // cvar_check "Label" "cvar"
    // - Displays the current value of a console variable (cvar).
    // - Automatically detects and shows:
    //     • int   (e.g. fps_max -> 101)
    //     • float (e.g. sensitivity -> 2.5)
    //     • string (e.g. name -> Player)
    // - Read-only: does NOT modify the cvar value.
    // - If the cvar does not exist, shows "<not found>".
    // ------------------------------------------------------------------------
    cvar_check "Sensitivity" "sensitivity"
    cvar_check "FPS limit" "fps_max"
    cvar_check "Player name" "name"
    separator

    // ------------------------------------------------------------------------
    // IMAGE
    //
    // image "texture_path" width height
    //
    // Supported image formats:
    //   bmp, jpg, tga, png
    // ------------------------------------------------------------------------
    image "gfx/env/2desertbk.tga" 125 125
    separator

    // ------------------------------------------------------------------------
    // IMAGE BUTTONS
    //
    // image_button "Label" "command" "texture_path" width height
    //
    // Supported image formats:
    //   bmp, jpg, tga, png
    // ------------------------------------------------------------------------
    image_button "null" "null" "gfx/env/2desertbk.tga" 64 64
    same_line
    image_button "null" "null" "gfx/env/2desertbk.tga" 64 64
    same_line
    image_button "null" "null" "gfx/env/2desertbk.tga" 64 64
    separator

    // ------------------------------------------------------------------------
    // BUTTONS
    // button "Label" "command"
    //
    // IMPORTANT: Label and command MUST be on the SAME LINE, both in quotes.
    // ------------------------------------------------------------------------
    button "Say: Hello" "say Hello from cfg menu!"
    same_line
    button "Rofl" "kill"
    separator

    // ------------------------------------------------------------------------
    // CHECKBOXES
    // checkbox "Label" "cvar_name"
    //
    // - The checkbox is bound to a cvar
    // ------------------------------------------------------------------------
    checkbox "HUD Visualization" "hud_vis"
    checkbox "Show FPS" "cl_showfps"
    checkbox "Show viewmodel" "r_drawviewmodel"
    separator

    // ------------------------------------------------------------------------
    // SUBMENUS
    // submenu "Title" { ... }
    //
    // - Collapsible section.
    // - You can nest submenus inside each other.
    // ------------------------------------------------------------------------
    submenu "HL1 Sounds"
    {
        text "Play Half-Life 1 sounds using the 'play' command"
        submenu "Weapons"
        {
            button "Glock fire" "play weapons/pl_gun3.wav"
            button "MP5 fire" "play weapons/hks1.wav"
            button "Shotgun fire" "play weapons/sbarrel1.wav"
            separator
            submenu "Explosions"
            {
                button "Grenade explode" "play weapons/explode3.wav"
                button "Satchel explode" "play weapons/explode4.wav"
                button "Big explosion" "play weapons/explode5.wav"
            }
        }
        submenu "NPC Voices"
        {
            button "Scientist pain" "play scientist/sci_pain4.wav"
            button "Barney: Need help" "play barney/c2a5_ba_helpme.wav"
            button "Hgrunt: bastard!" "play hgrunt/bastard!.wav"
        }
    }

    // ------------------------------------------------------------------------
    // TAB BARS
    // tabbar "BarName" { ... tabs ... }
    // tab "TabName" { ... items ... }
    //
    // - tabbar defines a group of tabs.
    // - Inside tabbar, you define multiple tab blocks.
    // - Each tab must have a body { ... } with content.
    // ------------------------------------------------------------------------
    tabbar "MainTabs"
    {
        tab "Gameplay"
        {
            text "Some (cheat) commands:"
            checkbox "Cheats" "sv_cheats"
            button "Noclip" "noclip"
            button "God mode" "god"
            button "Give all" "impulse 101"
        }

        tab "Maps"
        {
            text "Select a map:"
            button "Crossfire" "map crossfire"
            button "Anomalous Materials""map c1a0"
        }
    }
    separator

    // ------------------------------------------------------------------------
    // SLIDER_FLOAT
    // slider_float "Label" "cvar_name" min max
    // ------------------------------------------------------------------------
    text "Float slider:"
    slider_float "Gamma" "gamma" 0.0 3.0

    // ------------------------------------------------------------------------
    // SLIDER_INT
    // slider_int "Label" "cvar_name" min max
    // ------------------------------------------------------------------------
    text "Integer slider:"
    slider_int "Net graph" "net_graph" 0 2

    // ------------------------------------------------------------------------
    // COLOR_CVAR
    // color_cvar "Label" "cvar_name"
    // ------------------------------------------------------------------------
    text "CVar-based color:"
    color_cvar "HUD main color" "hud_color"

    // ------------------------------------------------------------------------
    // SPACE
    // space
    //
    // - Inserts a vertical empty gap between items.
    // - Unlike separator, it does NOT draw a line, only adds spacing.
    // ------------------------------------------------------------------------
    space
    separator

    // ------------------------------------------------------------------------
    // CONDITION
    //
    // condition "cvar" <operator> value { ... }
    //
    // Supported operators:
    //   ==   !=   >   >=   <   <=
    //
    // The block { ... } will be shown ONLY if the condition is true.
    // You can place ANY menu items inside the condition block:
    //   - text
    //   - button
    //   - checkbox
    //   - submenu
    //   - tab
    //   - tabbar
    // ------------------------------------------------------------------------
    condition "sv_cheats" != 1
    {
        text "Cheats are DISABLED"
        space
        button "Enable cheats" "sv_cheats 1"
    }
    condition "sv_cheats" >= 1
    {
       text "Cheats are ENABLED"
       space
       button "Disable cheats" "sv_cheats 0"
    }
    separator
    space

    // ------------------------------------------------------------------------
    // CLOSE MENU BUTTON
    // close_menu "Label"
    // ------------------------------------------------------------------------
    close_menu "Close"
}