Creating Win32 Desktop Apps

preferenceStorage

Indicates where the app's custom preferences should be stored when accessed via the system.getPreference(), system.setPreferences(), and system.deletePreferences() functions using the "app" category.

settings =
{
    win32 =
    {
        preferenceStorage = "registry",
    }
}

This key can be set to one of the following:

• "sqlite" — This is the default setting and the most portable option. Preferences are stored to a CoronaPreferences.sqlite database file under the Windows user's hidden .\AppData\Local\<CompanyName>\<AppName>\.system directory.
• "registry" — Stores the app's preferences to the Windows registry under HKEY_CURRENT_USER\Software\<CompanyName>\<AppName>. This feature has portability issues, for example preference names are not case-sensitive when stored to the registry. Also, forward slashes (/) and backslashes (\) in a preference name will be regarded as registry key path separators and will be treated as the same characters.

singleInstance

Set this to true (the default setting) to allow only one instance of a Win32 desktop application to exist at a time. This means that attempting to launch a second instance will bring the first instance's window to the front of the desktop instead. If the second instance was given any command line arguments, those arguments are delivered to the first instance via an "applicationOpen" typed system event. Set this setting to false to support multiple application instances at the same time.

settings =
{
    win32 =
    {
        singleInstance = false,
    }
}

defaultMode

Sets how the window should be launched on startup. Supported values include "normal", "minimized", "maximized", or "fullscreen". Default is "normal". This can also be set programmatically via the native.setProperty() API.

settings =
{
    window =
    {
        defaultMode = "fullscreen",
    },  
}

defaultViewWidth

Sets the default launch width of the view/client area of the window. This is the region within the borders of the window to which Corona renders. Ideally, this should match or exceed your config.lua content area width.

settings =
{
    window =
    {
        defaultViewWidth = 640,
    },  
}

defaultViewHeight

Sets the default launch height of the view/client area of the window. This is the region within the borders of the window to which Corona renders. Ideally, this should match or exceed your config.lua content area height.

settings =
{
    window =
    {
        defaultViewHeight = 960,
    },
}

resizable

Set this to true to allow the end user to resize the window (the window is not resizable by default). Note that if true, you may need to handle Corona's resize event to re-layout your content.

settings =
{
    window =
    {
        resizable = true,
    },
}

minViewWidth

This setting only applies if resizable is set to true. Prevents the user from resizing the window to a width smaller than this value. Note that this represents the width of the region within the borders of the window. If resizable is set to true and this setting is not specified, the window can be resized down to whatever width the OS allows.

settings =
{
    window =
    {
        minViewWidth = 320,
    },
}

minViewHeight

This setting only applies if resizable is set to true. Prevents the user from resizing the window to a height smaller than this value. Note that this represents the height of the region within the borders of the window. If resizable is set to true and this setting is not specified, the window can be resized down to whatever height the OS allows.

settings =
{
    window =
    {
        minViewHeight = 480,
    },
}

enableCloseButton

Enables or disables the window's "close" button (enabled by default). If disabled, you must close the window in Lua via native.requestExit(). Note that Corona does not currently trigger an event when the "close" button is clicked.

settings =
{
    window =
    {
        enableCloseButton = true,
    },
}

enableMinimizeButton

Enables or disables the window's "minimize" button (enabled by default).

settings =
{
    window =
    {
        enableMinimizeButton = true,
    },
}

enableMaximizeButton

Enables or disables the window's "maximize" button (disabled by default). Note that the window will be resized when maximized/restored, so if this setting is true, you may need to handle Corona's resize event to re-layout your content.

settings =
{
    window =
    {
        enableMaximizeButton = true,
    },
}

suspendWhenMinimized

Tells the runtime to suspend when the window is minimized (disabled by default).

settings =
{
    window =
    {
        suspendWhenMinimized = true,
    },
}

titleText

Sets the window's title bar text to the specified string (no title bar text by default). Supports 2-letter ISO 639‐1 language codes and optional 2-letter ISO 3166‐1 country codes (neither case sensitive). The title text can also be set programmatically via the native.setProperty() API.

settings =
{
    window =
    {
        titleText = {
            -- The "default" text will be used if the system is using a language and/or
            -- country code not defined below. This serves as a fallback mechanism.
            default = "Window Title Test",
            -- This text is used on English language systems in the United States.
            -- Note that the country code must be separated by a dash (-).
            ["en‐us"] = "Window Title Test (English‐USA)",
            -- This text is used on English language systems in the United Kingdom.
            -- Note that the country code must be separated by a dash (-).
            ["en‐gb"] = "Window Title Test (English‐UK)",
            -- This text is used for all other English language systems.
            ["en"] = "Window Title Test (English)",
            -- This text is used for all French language systems.
            ["fr"] = "Window Title Test (French)",
            -- This text is used for all Spanish language systems.
            ["es"] = "Window Title Test (Spanish)",
        },
    },
}