Skip to content
TerminalBy DarkEffekt

Class TerminalTheme

What a session draws with: font, colors, and cursor. Emulation ignores all of it. How each screen then shows the picture (filtering and the CRT or LCD effect) is a DarkEffekt.Terminal.Unity.TerminalScreenType on that screen.

The font fields are read when the session builds its renderer: a later font change applies through TerminalSession.RebuildRenderer, and the cell size changes per session through TerminalSession.SetFontSize, which leaves this asset alone. Colors and cursor take effect while it runs.

Assembly: DarkEffekt.Terminal
Section titled “Assembly: DarkEffekt.Terminal”
Declaration
[CreateAssetMenu(fileName = "TerminalTheme", menuName = "Terminal/Theme", order = 0)]
[Icon("Packages/com.darkeffekt.terminal/Editor/Icons/Assets/TerminalTheme.png")]
public sealed class TerminalTheme : ScriptableObject

Inheritance: System.Object -> UnityEngine.Object -> UnityEngine.ScriptableObject

Fields

Section titled “Fields”

MinFontSize

Section titled “MinFontSize”

The smallest cell size, in pixels.

Declaration
public const int MinFontSize = 6

MaxFontSize

Section titled “MaxFontSize”

The largest cell size, in pixels.

Declaration
public const int MaxFontSize = 96

font

Section titled “font”
Declaration
[Header("Font (read when the session starts)")]
[Tooltip("A monospace font asset. When empty, the OS fonts below are tried, then the bundled JetBrains Mono.")]
public Font font

osFontNames

Section titled “osFontNames”
Declaration
[Tooltip("Monospace OS font names to try in order when no font asset is set. Leave empty to use the bundled font on every platform.")]
public string[] osFontNames

fontSize

Section titled “fontSize”
Declaration
[Tooltip("The starting cell size in pixels. During play, call SetFontSize on the session.")]
[Range(6, 96)]
public int fontSize

foreground

Section titled “foreground”
Declaration
[Header("Colors (live)")]
public Color foreground

background

Section titled “background”
Declaration
public Color background

cursorColor

Section titled “cursorColor”
Declaration
public Color cursorColor

ansiOverride

Section titled “ansiOverride”
Declaration
[Tooltip("Overrides for palette entries 0..15. Leave empty for xterm defaults.")]
public Color[] ansiOverride

boldUsesBrightColors

Section titled “boldUsesBrightColors”
Declaration
[Tooltip("Bold text also uses the bright palette entry, the classic 16-color behavior.")]
public bool boldUsesBrightColors
Section titled “cursorBlink”
Declaration
[Header("Cursor (live)")]
public bool cursorBlink

cursorBlinkInterval

Section titled “cursorBlinkInterval”
Declaration
[Range(0.1, 2)]
public float cursorBlinkInterval