namespace AcDream.Launcher.Core.Profiles;

/// <summary>
/// Per-character launch behaviour (Campaign LA spec §5). Stored on each
/// <see cref="CharacterProfile"/> and read by
/// <see cref="AcDream.Launcher.Core.Launching.SessionConfigComposer"/> to
/// decide the shape of the composed session-config document.
///
/// <para>
/// Serialized as camelCase text (<c>"gui"</c>/<c>"guiSelect"</c>/
/// <c>"headless"</c>) via the explicit
/// <c>new JsonStringEnumConverter(JsonNamingPolicy.CamelCase, ...)</c>
/// registered in <see cref="LauncherProfileStore"/>'s serializer options
/// — deliberately NOT a per-type <c>[JsonConverter]</c> attribute, which
/// uses exact member-name casing (<c>"Gui"</c>) regardless of the
/// ambient <c>PropertyNamingPolicy</c>.
/// </para>
/// </summary>
public enum LaunchMode
{
    /// <summary>Launch the graphical client straight into the world as
    /// this character.</summary>
    Gui,

    /// <summary>Launch the graphical client but stop at the retail
    /// character-select screen — no character selector is sent. This is
    /// the default for a character that has never had its launch mode set
    /// explicitly.</summary>
    GuiSelect,

    /// <summary>Launch the no-window host running the <c>idle</c> bot
    /// policy (enter world, run plugins/login commands, stay until
    /// stopped).</summary>
    Headless,
}