Localization

Localized strings

Lawn separates structure from presentation. The YAML template defines behavior — variable sources, input types, health check commands, notice element types. A companion JSON file provides all user-facing strings — display names, descriptions, option labels, and notice titles.

This separation keeps YAML diffs clean, makes translations straightforward, and lets the UI layer own how strings are displayed.

File Location

Each template includes a locales/en.json file:

my-app/
├── manifest.yaml
├── locales/
│   └── en.json
└── lawn-compose/
    └── compose.yaml

JSON Structure

The JSON has two top-level keys: config for top-level config variables and services for per-service strings.

{
  "config": {
    "POSTGRES_PASSWORD": {
      "displayName": "Database Password",
      "description": "PostgreSQL password. Auto-generated during install."
    },
    "ADMIN_PASSWORD": {
      "displayName": "Admin Password",
      "description": "Password for the initial admin account."
    }
  },
  "services": {
    "app": {
      "environment": {
        "POSTGRES_HOST": {
          "description": "Hostname of the PostgreSQL database server.",
          "group": "Database"
        },
        "TZ": {
          "description": "Timezone for the application (e.g. America/New_York)."
        }
      },
      "healthChecks": {
        "web-ui": {
          "description": "Web UI is accessible and responding."
        }
      },
      "notices": {
        "login-credentials": {
          "title": "Login Credentials",
          "elements": {
            "username": { "label": "Username" },
            "password": { "label": "Password" },
            "setup-note": { "content": "Change these in **Settings > Security** after your first login." }
          }
        }
      }
    }
  }
}

Config variables

Each config variable key maps to an object with:

Config option labels

Variables with selectable options need a label for each option value. The keys must match the option keys in the YAML:

{
  "config": {
    "DIFFICULTY": {
      "displayName": "Difficulty",
      "description": "Controls how challenging the game is.",
      "options": {
        "peaceful": { "label": "Peaceful" },
        "easy": { "label": "Easy" },
        "normal": { "label": "Normal" },
        "hard": { "label": "Hard" }
      }
    }
  }
}

Boolean config variables must have exactly two option labels, keyed "true" and "false":

{
  "config": {
    "PVP": {
      "displayName": "PvP",
      "description": "Allow players to deal damage to each other.",
      "options": {
        "true": { "label": "On" },
        "false": { "label": "Off" }
      }
    }
  }
}

Services

Each service key maps to an object with optional environment, healthChecks, and notices sections.

Environment variables:

Health checks — keyed by the health check id from the YAML:

Notices — keyed by the notice id from the YAML:

Notice elements use label for field and variableAction types, and content (Markdown) for text types. Both static fields and fields with a source use type: field.

For a notice action, put the button label under its element ID:

{
  "services": {
    "app": {
      "notices": {
        "open-signups": {
          "title": "Signups are open",
          "elements": {
            "disable-signups": { "label": "Disable signups" }
          }
        }
      }
    }
  }
}

What Lives Where

Validation

Review localization alongside the YAML. Each localizable structure needs a matching JSON entry, and JSON keys must refer to existing structures. Check for:

• Missing displayName or description for config variables
• Missing label for config options
• Missing description for environment variables and health checks
• Missing title for notices and missing label/content for notice elements
• Dangling JSON keys that don't match any YAML structure
• Boolean config variables without exactly 2 option labels

Open the template in a local catalog test instance and inspect its settings, option labels, health check descriptions, and notices. Confirm that each string appears where expected.

lawn template validate is planned and is not available in the current release.