0ad/source/tools/entity
joeybadz 77a53121e0
Some checks failed
checkrefs / lfscheck (push) Has been cancelled
checkrefs / checkrefs (push) Has been cancelled
lint / cppcheck (push) Has been cancelled
lint / copyright (push) Has been cancelled
lint / jenkinsfiles (push) Has been cancelled
pre-commit / build (push) Has been cancelled
Handle module attributes in checkrefs
Prevents GUI modules from being incorrectly reported as unused files

Fixes #8147
2026-04-20 21:09:25 +02:00
..
scriptlib Improve find_files implementation 2025-05-27 07:32:51 +02:00
checkrefs.py Handle module attributes in checkrefs 2026-04-20 21:09:25 +02:00
entvalidate.py Improve find_files implementation 2025-05-27 07:32:51 +02:00
readme.md Add a markdownlint pre-commit hook 2024-08-27 10:06:31 +02:00
requirements.txt Improve performance and output of entvalidate.py 2025-03-18 12:57:01 +01:00
validate_dae.py Refactor validate_dae.py for more speed 2025-05-27 08:05:13 +02:00
validate_grammar.py Move xmlvalidator code to entity directory 2025-03-03 17:45:08 +01:00
validator.py Move xmlvalidator code to entity directory 2025-03-03 17:45:08 +01:00

Checkrefs.py

Description

This script checks the game files for missing dependencies, unused files, and for file integrity. If mods are specified, all their dependencies are also checked recursively. This script is particularly useful to detect broken actors or templates.

Requirements

  • Python 3.6+ interpreter installed
  • lxml for the -a option.

Usage

  • cd in source/tools/entity and run the script.
usage: checkrefs.py [-h] [-u] [-x] [-a] [-t] [-m MOD [MOD ...]]

Checks the game files for missing dependencies, unused files, and for file integrity.

options:
  -h, --help            show this help message and exit
  -u, --check-unused    check for all the unused files in the given mods and their dependencies.
                        Implies --check-map-xml. Currently yields a lot of false positives.
  -x, --check-map-xml   check maps for missing actor and templates.
  -a, --validate-actors
                        run the validator.py script to check if the actors files have extra or
                        missing textures.
  -t, --validate-templates
                        run the validator.py script to check if the xml files match their (.rng)
                        grammar file.
  -m MOD [MOD ...], --mods MOD [MOD ...]
                        specify which mods to check. Default to public.