Skip to main content

Audit Godot input maps for device coverage, duplicate bindings, and generated references.

Project description

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

godot_input_map_auditor-0.1.3.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

godot_input_map_auditor-0.1.3-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file godot_input_map_auditor-0.1.3.tar.gz.

File metadata

  • Download URL: godot_input_map_auditor-0.1.3.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for godot_input_map_auditor-0.1.3.tar.gz
Algorithm Hash digest
SHA256 65c97f09037c5513ccf9358ffcfd42b02273ed0d46514b5039b3e8071244fd89
MD5 9674fa648d4dc69eea65fc560cce549c
BLAKE2b-256 3f62a46c01b826ab84cafe9a370b68f79ea0844142dc1dc74f5158252b8d75b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_input_map_auditor-0.1.3.tar.gz:

Publisher: publish-input-map-auditor.yml on NonniGB/godot-production-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file godot_input_map_auditor-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for godot_input_map_auditor-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6769dca405a44b42b46c04cbbb56f9667f3b09c3b0bbf41d87d826ee5a3820a6
MD5 f3483bc780b2c670d70776a507175317
BLAKE2b-256 0ed43664b155ebd2b8c2e9f3986f99c0c6bec14e5226dc14c753398874e44fb2

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_input_map_auditor-0.1.3-py3-none-any.whl:

Publisher: publish-input-map-auditor.yml on NonniGB/godot-production-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page