Changeset View
Changeset View
Standalone View
Standalone View
source/tools/entity/readme.md
# Checkrefs.pl | |||||
## Summary | |||||
* 1. [Description](#Description) | |||||
* 2. [Requirements](#Requirements) | |||||
* 3. [Usage](#Usage) | |||||
## 1. <a name='Description'></a>Description | |||||
Itms: Are those `<a>` something that your Markdown editor adds? Semantically, it's terribly ugly to… | |||||
StanAuthorUnsubmitted Done Inline ActionsCan'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. | |||||
This scripts 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. | |||||
ItmsUnsubmitted Done Inline Actionsscript* Itms: script* | |||||
## 2. <a name='Requirements'></a>Requirements | |||||
- Perl interpreter installed | |||||
- Dependencies: | |||||
- XML::Parser | |||||
- XML::Simple | |||||
- Getopt::Long | |||||
- File::Find | |||||
- Data::Dumper | |||||
- JSON | |||||
## 3. <a name='Usage'></a>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. | |||||
ItmsUnsubmitted Done Inline Actionsthe 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… | |||||
Not Done Inline Actionsthis 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… | |||||
--check-unused check for all the unused files in the given mods and their dependencies. Implies --check-map-xml | |||||
ItmsUnsubmitted Done Inline ActionsPlease state that this currently yields false positives. Itms: Please state that this currently yields false positives. | |||||
--check-map-xml check maps for missing actor and templates. | |||||
--validate-templates runs 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=mod the list of mods to check separated by '|' | |||||
ItmsUnsubmitted Done Inline ActionsPlease give the default value. Itms: Please give the default value. | |||||
``` |
Wildfire Games · Phabricator
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.