module Lapis::Docs::I_ARCHITECTURE_AND_EXTENSIONS::D_GODOT_VERSION_UPGRADE

Overview

Godot Engine Version Upgrade Guide

Step-by-step engineering runbook for upgrading Lapis to target a new Godot engine release, dumping API schemas, and updating the Crystal binding generator.

Executive Summary & Key Topics

Topic Method / Anchor Description
The Upgrade Workflow .topic_00_upgrade_steps Sequential steps to upgrade the targeted Godot engine version across Lapis.
Dumping Godot Extension API .topic_01_dumping_api Extracting the JSON machine-readable API definition from Godot.

Related Guides & Source References

Defined in:

libgodot/docs/i_architecture_and_extensions/d_godot_version_upgrade.cr

Class Method Summary

Class Method Detail

def self.topic_00_upgrade_steps : Nil #

The Upgrade Workflow: Sequential steps to upgrade the targeted Godot engine version across Lapis.

Key Topics & Information

    1. Update godot-version.yml with target version string and download URLs
    1. Run lapis setup engine to acquire the new engine binary
    1. Dump extension_api.json via godot.exe --dump-extension-api
    1. Regenerate Crystal class bindings via make generate
    1. Run make all to recompile bridge, test suites, and examples

def self.topic_01_dumping_api : Nil #

Dumping Godot Extension API: Extracting the JSON machine-readable API definition from Godot.

# 1. Update version in godot-version.yml
# 2. Acquire new engine binary:
lapis setup engine

# 3. Dump fresh extension API:
./godot.exe --dump-extension-api

# 4. Regenerate Crystal bindings:
make generate