module Lapis::Docs::B_LAPIS_CLI_AND_TOOLCHAIN::B_DOCTOR

Overview

Doctor Diagnostic Checker

lapis doctor audits your system configuration and validates every dependency required for high-performance Crystal game development in Godot.

Executive Summary & Key Topics

Topic Method / Anchor Description
The 11 Diagnostic Checks .topic_00_diagnostic_checks Listing of all 11 system and project components validated by doctor.
Command Usage & Options .topic_01_running_doctor How to run doctor and interpret diagnostic markers.
Interpreting Diagnostic Output .topic_02_interpreting_results Understanding check markers [✓], [!], and [✗].
Resolving Doctor Failures .topic_03_troubleshooting_failures Step-by-step instructions for fixing common doctor diagnostic failures.

Related Guides & Source References

Defined in:

libgodot/docs/b_lapis_cli_and_toolchain/b_doctor.cr

Class Method Summary

Class Method Detail

def self.topic_00_diagnostic_checks : Nil #

The 11 Diagnostic Checks: Listing of all 11 system and project components validated by doctor.

Key Topics & Information

    1. Crystal Compiler: Version >= 1.20.0
    1. Godot Engine Executable: Target version 4.8-dev6
    1. C++ Bridge Compiler: MinGW-w64 g++, MSVC cl, or clang
    1. Native Debugger: radare2 executable
    1. Build System: GNU Make >= 4.4
    1. Version Control: Git executable
    1. Crystal Shards: Package manager
    1. Language Server: Crystalline LSP daemon
    1. Windows Packaging: Inno Setup compiler (ISCC.exe on Windows)
    1. Runtime Libraries: gc.dll, pcre2-8.dll, iconv-2.dll, libgodot.dll
    1. Project Configuration: project.godot GDExtension integration

def self.topic_01_running_doctor : Nil #

Command Usage & Options: How to run doctor and interpret diagnostic markers.

Run doctor at any time from your project root:

lapis doctor

Options:

  • autofix, -f, --fix: Automatically triage and remediate detectable warnings, missing tools & gaps.
  • -v, --verbose: Display extended diagnostic information.
  • -h, --help: Show help screen.

def self.topic_02_interpreting_results : Nil #

Interpreting Diagnostic Output: Understanding check markers [✓], [!], and [✗].

Marker Status Meaning Action Required
[✓] Passed Component verified and operational None
[!] Warning Optional component missing or outdated Install for enhanced features (e.g. Inno Setup)
[✗] Failure Required component missing or broken Must be resolved before building games

def self.topic_03_troubleshooting_failures : Nil #

Resolving Doctor Failures: Step-by-step instructions for fixing common doctor diagnostic failures.

1. Failure: Missing C++ Bridge Compiler

  • Cause: g++ is not present in your system PATH.
  • Solution: Install MinGW-w64 via Scoop (scoop install gcc) or MSYS2, then verify with g++ --version.

2. Failure: Missing Native Debugger (radare2)

  • Cause: radare2 is missing from PATH.
  • Solution: Install radare2 (scoop install radare2 or winget install radare2.radare2).

3. Warning: Inno Setup Compiler Missing

  • Cause: ISCC.exe not found.
  • Note: Only required if building the Windows standalone installer (lapis package installer). Standard game exports (lapis package game) do not require Inno Setup.