Differential D1381 Diff 7503 source/tools/entity/readme.md

Changeset View

Standalone View

source/tools/entity/readme.md

				# Checkrefs.pl

				## 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

				- Perl interpreter installed
				ItmsUnsubmitted Done Inline Actions Are those `<a>` something that your Markdown editor adds? Semantically, it's terribly ugly to create anchors like that. Anchors should be created automatically with standard titles. Itms: Are those `<a>` something that your Markdown editor adds? Semantically, it's terribly ugly to…
				StanAuthorUnsubmitted Done Inline Actions Can't have anchors with 1. In their names. Removed the TOC then. Stan: Can't have anchors with 1. In their names. Removed the TOC then.
				- Dependencies:
				- XML::Parser
				ItmsUnsubmitted Done Inline Actions script* Itms: script*
				- XML::Simple
				- Getopt::Long
				- File::Find
				- Data::Dumper
				- JSON

				## Usage

				- cd in source/tools/entity and run the script.

				```
				Usage: perl checkrefs.pl [OPTION]...
				Checks the game files for missing dependencies, unused files, and for file integrity.
				--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.
				--check-map-xml check maps for missing actor and templates.
				--validate-templates run the validate.pl script to check if the xml files match their (.rng) grammar file. This currently only works for the public mod.
				--mod-to-check=mods specify which mods to check. 'mods' should be a list of mods separated by '\|'. Default value: 'public\|mod'.
				```
				ItmsUnsubmitted Done Inline Actions Please state that this currently yields false positives. Itms: Please state that this currently yields false positives.
				ItmsUnsubmitted Done Inline Actions the option descriptions are not consistent (sometimes it's an infinitive, sometimes a 3rd person, and the last one describes the syntax instead of the aim) Itms: the option descriptions are not consistent (sometimes it's an infinitive, sometimes a 3rd…
				ItmsUnsubmitted Done Inline Actions Please give the default value. Itms: Please give the default value.
				ItmsUnsubmitted Not Done Inline Actions this sentence has been rewritten too many times ? Replace `mod` by `mods` in the option syntax. `specify which mods to check. 'mods' should be a list of mods separated by '\|'. Default value: 'public\|mod'.` Itms: this sentence has been rewritten too many times ? Replace `mod` by `mods` in the option…