Game Framework YAML

IntelliSense, validation, and autocomplete support for .game.yml configuration files used by the Game Framework CLI.

Features

• Autocomplete: Get intelligent suggestions as you type configuration options
• Validation: Real-time validation with detailed error messages
• Hover Documentation: View property descriptions by hovering over any field
• Schema Enforcement: Catch configuration errors before running CLI commands

Supported Configuration

This extension provides full autocomplete support for:

• Unity Engine Configuration

  • Project and export paths
  • Build settings (scenes, development mode, configuration)
  • Platform-specific settings (Android, iOS, macOS, Windows, Linux)
  • Streaming configuration

• Unreal Engine Configuration

  • Project and export paths
  • Build settings (levels, development mode, configuration)
  • Platform-specific settings (Android, iOS, macOS, Windows, Linux)
  • Streaming configuration

• Publishing Configuration

  • Workspace ID
  • Package name
  • Privacy settings
  • Exclusion patterns

Installation

From VSCode Marketplace

1. Open VSCode
2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
3. Search for "Game Framework YAML"
4. Click Install

From VSIX File

1. Download the .vsix file from the releases page
2. Open VSCode
3. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
4. Click the "..." menu at the top of the Extensions panel
5. Select "Install from VSIX..."
6. Choose the downloaded .vsix file

Usage

1. Create a .game.yml or *.game.yml file in your project
2. Start typing to see autocomplete suggestions
3. Press Ctrl+Space (or Cmd+Space on macOS) to trigger suggestions manually
4. Hover over any property to see its description

Example Configuration

name: MyAwesomeGame
version: 1.0.0

engines:
  unity:
    project_path: ../MyUnityProject
    export_path: ../MyUnityProject/Exports
    
    export_settings:
      development: false
      build_configuration: Release
      scenes:
        - MainMenu
        - Gameplay
    
    platforms:
      android:
        enabled: true
        target_path: android/unityLibrary
        build_settings:
          scripting_backend: IL2CPP
          target_architectures: [ARM64]
      
      ios:
        enabled: true
        target_path: ios/UnityFramework.framework
        build_settings:
          minimum_ios_version: "12.0"

publish:
  workspace_id: ws_abc123
  package_name: my-awesome-game
  private: false

Requirements

This extension requires the YAML Language Support by Red Hat extension, which will be installed automatically as a dependency.

Extension Settings

This extension contributes the following settings:

Troubleshooting

Autocomplete not working

1. Ensure the YAML extension is installed and enabled
2. Check that your file ends with .game.yml
3. Try reloading the window (Ctrl+Shift+P → "Reload Window")

Custom schema not loading

1. Verify the path in gameFrameworkYaml.schemaPath is correct
2. Ensure the custom schema file is valid JSON Schema
3. Reload the window after changing the setting

Contributing

Contributions are welcome! Please see our contributing guidelines.

License

MIT License - see LICENSE for details.

Related

• Game Framework CLI - Command-line tool for managing game projects
• Game Framework - Flutter plugin for embedding game engines