Clanker: Rework documentation for new users: illustrated steps, clear navigation, preserved technical references, and current 0.3.6 behavior

2026-09-13T21:22:04Z

Rework documentation for new users: illustrated steps, clear navigation, preserved technical references, and current 0.3.6 behavior

← Older revision		Revision as of 21:22, 13 September 2026
Line 1:		Line 1:
			{{Documentation navigation}}

	A '''Lua theme''' supplies colors and optional font settings for the SimTX Transmitter. Installed themes appear in the '''Theme''' list in the application footer.		A '''Lua theme''' supplies colors and optional font settings for the SimTX Transmitter. Installed themes appear in the '''Theme''' list in the application footer.


			== How to use this reference ==
			To use an existing theme, select it in the footer. To write one, create a package declaring types=theme, place the declaration below in its entry file, reload, and select the new theme. Start with the semantic colors and check text contrast; the optional Swing ui overrides are for finer adjustments.

	== Declaration ==		== Declaration ==

Clanker: Add and update user documentation for Lua extensions and the catalog

2026-08-06T09:12:27Z

Add and update user documentation for Lua extensions and the catalog

New page

A '''Lua theme''' supplies colors and optional font settings for the SimTX Transmitter. Installed themes appear in the '''Theme''' list in the application footer.

== Declaration ==
<syntaxhighlight lang="lua">
simtx.theme {
name = "Midnight",
description = "A high-contrast dark theme.",
colors = {
background = "#10161f",
surface = "#17212d",
surface_alt = "#202c3a",
foreground = "#e8f0fa",
muted = "#91a0b3",
accent = "#4ac8ff",
selection = "#24506a",
border = "#34475b",
success = "#58d68d",
warning = "#f2c33c",
danger = "#ff665c",
meter = "#4ac8ff",
},
font = {family = "SansSerif", size = 13},
ui = {
["Table.gridColor"] = "#233246",
["ToolTip.background"] = "#202c3a",
},
}
</syntaxhighlight>

== Fields ==
{| class="wikitable"
! Field !! Required !! Meaning
|-
| <code>name</code> || Yes || Name shown in the Theme list.
|-
| <code>description</code> || No || User-facing description.
|-
| <code>colors</code> || Yes || Table of semantic color roles.
|-
| <code>font</code> || No || Font family string, or a table containing <code>family</code> and non-negative <code>size</code>.
|-
| <code>ui</code> || No || Table of Swing UI property names to colors for details not covered by semantic roles.
|}

Supported semantic roles are <code>background</code>, <code>surface</code>, <code>surface_alt</code>, <code>foreground</code>, <code>muted</code>, <code>accent</code>, <code>selection</code>, <code>border</code>, <code>success</code>, <code>warning</code>, <code>danger</code>, and <code>meter</code>. Omitted roles retain a suitable application default.

Colors may use <code>#RGB</code>, <code>#RRGGBB</code>, or <code>#AARRGGBB</code>. The names <code>black</code>, <code>white</code>, <code>red</code>, <code>green</code>, <code>blue</code>, <code>gray</code>, <code>grey</code>, <code>orange</code>, and <code>yellow</code> are also accepted.

The <code>ui</code> table is optional and is applied after the semantic roles. It is intended for established Swing UI property names. A theme should remain usable when this table is omitted.

[[Category:Lua extensions]]

Lua theme API - Revision history

Clanker: Rework documentation for new users: illustrated steps, clear navigation, preserved technical references, and current 0.3.6 behavior

Clanker: Add and update user documentation for Lua extensions and the catalog