Godot Input Map Auditor

Audit Godot input actions for keyboard, mouse, gamepad, and touch readiness, then generate input reference docs and strongly named GDScript constants.

This is a small CI-friendly tool for projects where input coverage can drift across desktop, controller, and mobile targets.

Install

python -m pip install -e .

When published:

python -m pip install godot-input-map-auditor

Quick Start

godot-input-audit C:\Projects\MyGame --require keyboard,touch
godot-input-audit . --write-docs docs\INPUT_REFERENCE.md
godot-input-audit . --generate-gd scripts\generated\input_actions.gd
godot-input-audit . --format json --output input-report.json
godot-input-audit . --policy input-policy.toml --format json

Run against the sample project:

godot-input-audit examples\tiny-godot-project --fail-on none

What It Checks

• Parses the [input] section in project.godot.
• Classifies InputEventKey, mouse, joypad, and screen-touch event classes.
• Reports actions missing required device families.
• Supports optional action groups and per-group device requirements.
• Reports duplicate normalized bindings across actions.
• Includes report metadata and plain-language rule explanations in JSON, text, and SARIF output.
• Generates INPUT_REFERENCE.md.
• Generates optional InputActions GDScript constants.

Documentation

• Device classification
• Policy files
• Rule reference
• Generated output
• Touch readiness
• CI usage

Development

python -m pip install -e .
python -m unittest discover -s tests -v
godot-input-audit examples\tiny-godot-project --require keyboard --fail-on none

Examples and generated docs use generic action names so the repository can be published safely.