TimMenu

Download Latest

Terminator's Immediate-Mode Menu for Lmaobox

A GUI library for Lmaobox scripts, offering a convenient immediate-mode style API built on a retained-mode foundation. It's designed for light usage and rapid construction of in-game menus.

2025-05-14_22-17-08.mp4

Installation

To install, download the latest release using the badge at the top of this page, then:

1. Unzip or extract the downloaded package.
2. Copy TimMenu.lua into your Lmaobox scripts folder (e.g., %localappdata%\Scripts).

Standalone API Guide

TimMenu is now a fully standalone library. It does not require LNXlib or other external dependencies.

Core Concepts

• Immediate Mode: You define the UI every frame. If you stop calling a widget function, it disappears.
• Layout: Widgets are placed left-to-right. Use NextLine() to move down.
• Volume Claim: The menu handles "Hit Testing" by treating the window and its popups as a single volume. If a dropdown sticks out, it still belongs to that window, preventing clicks from falling through to background elements.

---

API Reference

Window Management

• Begin: bool = TimMenu.Begin(title, [visible, [id]])
• Starts a new window context. Returns true if the window is expanded.

Layout Controls

Function	Usage	Description
NextLine([spacing])	TimMenu.NextLine(5)	Moves the cursor to the next row.
Spacing(amount)	TimMenu.Spacing(10)	Adds horizontal or vertical blank space.
Separator([label])	TimMenu.Separator("Settings")	Draws a horizontal line with an optional label.
BeginSector(label)	TimMenu.BeginSector("Main")	Starts a bordered group/panel.
EndSector()	TimMenu.EndSector()	Closes the current group/panel.

Basic Widgets

All widgets use simplified single-return APIs:

• Text: TimMenu.Text(text)
• Button: clicked = TimMenu.Button(label)
• Checkbox: checked = TimMenu.Checkbox(label, checked)
• TextInput: text = TimMenu.TextInput(label, text)
• Slider: value = TimMenu.Slider(label, value, min, max, step)
• Selector: selectedIndex = TimMenu.Selector(label, index, options)
• Dropdown: selectedIndex = TimMenu.Dropdown(label, index, options)
• Combo: selectedItems = TimMenu.Combo(label, selectedTable, options)
• TabControl: selectedTab = TimMenu.TabControl(id, tabs, selectedTab)
• Keybind: keyCode = TimMenu.Keybind(label, keyCode)
• ColorPicker: color = TimMenu.ColorPicker(label, color)

Customization

-- Global style tweaks via the Globals module
TimMenu.Globals.Colors.Window = {40, 40, 40, 255}
TimMenu.Globals.Style.ItemPadding = 8

---

Usage Examples

Simple Window Logic

local TimMenu = require("TimMenu")

local isChecked = false
local sliderValue = 50

local function OnDraw()
    if TimMenu.Begin("Example Window") then
        isChecked = TimMenu.Checkbox("Enable Feature", isChecked)
        TimMenu.NextLine()

        if TimMenu.Button("Reset Value") then
            sliderValue = 50
        end
        TimMenu.NextLine()

        sliderValue = TimMenu.Slider("Value", sliderValue, 0, 100, 1)
    end
end

callbacks.Register("Draw", "ExampleDraw", OnDraw)

Grouping with Sectors

if TimMenu.Begin("Settings") then
    TimMenu.BeginSector("Audio")
        local vol = TimMenu.Slider("Volume", 50, 0, 100, 1)
    TimMenu.EndSector()
end

Tips

• Sectors can be nested; backgrounds lighten automatically as depth increases.
• All widgets return their current value - no need to track "changed" flags manually.
• The volume hit-testing ensures that popups sticking out of windows correctly capture focus.

License

MIT License. See LICENSE for details.