Guidelines for Tamriel_Data Deprecation

[This page is outdated! See instead the PTR wiki: https://wiki.project-tamriel.com/wiki/Tamriel_Data_Deprecation_Guidelines]

When deprecating an object from Tamriel_Data there are a few steps you need to take. Renaming the object to <deprecated> and assigning the cube are not enough to properly deprecate something. If you don't have time to do all of the steps, or you just don't want to, then open an issue on github with the object IDs needing deprecation. Cool people do their own deprecations though.

General:

1: Create a translation txt file to package with your asset. In this txt you must put a line for every placeable object being replaced. For example; T_De_FurnP_Chair_01:furn_de_p_chair_02

1a: If there will not be a direct replacement for the asset being removed, all usage in section files must be accounted for. You might have to manually go through the asset usage and remove/tidy up. Either by right clicking the ID in the Object window and looking at the info tab, or by cycling through the whole list with the Ctrl-F function.

2: For any creatures or lootable objects, please make sure to remove all instances of the object from leveled lists, containers and NPCs. Use the right click > Info feature to track these down.

For objects where the assets will be reused:

1: If you are changing the filename and/or filepath of the nif, this must be noted in the asset's translation txt. All old meshes, textures, icons etc. MUST be included with the asset in a deprecation folder, with all of the correct project subfolders, similar to how you would package SD and HD files.

2: Change the filepath of the object to meshes\td\td_help_deprec_01.nif

2a: If the object is lootable, make sure to set the icon to default.

3: If the object type has an option for names, change the name to <deprecated>

For objects where the assets will be removed:

1: All removed meshes, textures, icons etc. MUST be included with the asset in a deprecation folder, with all of the correct project subfolders, similar to how you would package SD and HD files. Including what file the object uses in a txt is not required, but will be useful for the (new) TD Graveyard plugin.

2: If you are deprecating armor make sure you are properly deprecating all body parts.

3: Change the filepath of the object to meshes\td\td_help_deprec_01.nif

3a: If the object is lootable, make sure to set the icon to default.

4: If the object type has an option for names, change the name to <deprecated>

Merging deprecated assets:

1: The deprecation folder from assets should be put in the TD DeprecatedAssets repo rather than the TD_Addon repo.

2: Prior to releasing a Tamriel_Data update the Tamriel_Data_Graveyard plugin should be updated to point to the old assets. These will be stored in a dump folder named "tdg" (not to be confused with transportation of dangerous goods) for ease of access. Objects where the mesh was not renamed and thus not added to the deprecated asset repo should point back to the folder they originally came from. This plugin will ensure compatibility with mods dependant on Tamriel_Data that are no longer being updated.