Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tools to manage art/audio/text linkage (example: unused files, unused ART/AUDIO/TEXT tags, broken references) #418

Closed
raxo2222 opened this issue Feb 1, 2020 · 3 comments
Labels
art Related to art assets audio Sound effects, music, speech text Text or localization tool Related to tools or infrastructure, not the mod itself

Comments

@raxo2222
Copy link
Contributor

raxo2222 commented Feb 1, 2020

There may be unused art/audio files - no references to files in mod.
Unused art/audio/text defines - files (TXT_KEY being defined but not used by anything) being referenced, but no actual ingame use.
Items that reference sound/art/text entries, but those entries may be not existing or files not existing.

This tool should consider vanilla files when backtracking to source (thing may be not defined/existing in mod, but be located/defined in vanilla).

TEXT:
Text (TXT_KEY) is defined in text xml files.
Example: TXT_KEY_BUILDING_ANIMAL_MYTH_REQUIRE is defined in Animals_CIV4GameText and used by zAnimals_CIV4Building(Class)Infos xml.

ART:
Art (ART_DEF) is defined in artdefines xml files.
They also contain file path entries.
Example: ART_DEF_BONUS_BARLEY is defined in CIV4ArtDefines_Bonus and used by CIV4BonusInfos.xml It also references couple files. <NIF>Art/Terrain/Resources/Barley/Wheat.nif</NIF> <KFM>Art/Terrain/Resources/Barley/Wheat.kfm</KFM> <Button>,Art/blank.dds,Art/Interface/Buttons/AtlasMapBonus.dds,1,6</Button>

AUDIO:
Audio (no consistent tag) are defined in Audio folder.
Sound scripts are used in variety of places, and they use sound defines which then point to files.
Example: Some buildings use scriptID AS2D_BUILD_STABLE, which references soundID SND_BUILD_STABLE, which uses <Filename>Sounds/Buildings/Stable</Filename>

@raxo2222 raxo2222 added tool Related to tools or infrastructure, not the mod itself art Related to art assets text Text or localization audio Sound effects, music, speech labels Feb 1, 2020
@billw2012
Copy link
Member

Well we can't verify vanilla files on CI of course, so that would be optional depending on where you run it (unless we just build a database of all valid vanilla values to include).

@raxo2222
Copy link
Contributor Author

It could be simply tool in Tools folder, so you can check if you didn't remove that TXT KEY by accident or if you used art used somewhere else.
First it could search within mod, and then within vanilla assets.

@raxo2222
Copy link
Contributor Author

Seems like I reported it twice...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
art Related to art assets audio Sound effects, music, speech text Text or localization tool Related to tools or infrastructure, not the mod itself
Projects
None yet
Development

No branches or pull requests

2 participants