TDM Material Batch Conversion - Revision history

Nbohr1more at 16:37, 9 May 2017

2017-05-09T16:37:58Z

← Older revision		Revision as of 16:37, 9 May 2017
Line 1:		Line 1:
			'''OBSOLETE INFO AS OF TDM 2.0 ENHANCED AMBIENT STAGES ARE NO LONGER NEEDED IN MATERIALS'''

	=Introduction=		=Introduction=

Stifu: Minor cosmetic fix

2011-06-01T08:51:54Z

Minor cosmetic fix

← Older revision		Revision as of 08:51, 1 June 2011
Line 64:		Line 64:


	=I followed the above instructions but still ran into malloc errors=		==I followed the above instructions but still ran into malloc errors==
	It may occur that you run into malloc errors, although the first executions of the command were successful. This is due to the fact that some materials are more complex than others and require more RAM for that reason. Remember the last ''StartIndex'' and re-execute the command with that index, but a decreased ''nMaterials''. Say for example, you received a malloc error after executing "tdm_batchConvertMaterials 4000 1000". You would now go ahead and do the following:		It may occur that you run into malloc errors, although the first executions of the command were successful. This is due to the fact that some materials are more complex than others and require more RAM for that reason. Remember the last ''StartIndex'' and re-execute the command with that index, but a decreased ''nMaterials''. Say for example, you received a malloc error after executing "tdm_batchConvertMaterials 4000 1000". You would now go ahead and do the following:
	tdm_batchConvertMaterials 4000 <b>500</b>		tdm_batchConvertMaterials 4000 <b>500</b>
Line 73:		Line 73:

	=Known issues=		=Known issues=
	* ~~Can~~ result in malloc errors. See section [[#Proper Usage of the command\|Proper Usage of the command]].		* tdm_batchConvertMaterials can result in malloc errors. See section [[#Proper Usage of the command\|Proper Usage of the command]].
	* ~~Can~~ produce undesired results on [[DrVertexBlend (tutorial)\|vertex blended materials]], e.g. one of the old ambient stages is not removed. Please double check respective materials.		* The conversion can produce undesired results on [[DrVertexBlend (tutorial)\|vertex blended materials]], e.g. one of the old ambient stages is not removed. Please double check respective materials.

	{{textures}}		{{textures}}
	{{Texture Tutorials}}		{{Texture Tutorials}}

Fidcal: added new commands to handle single files and materials

2011-05-30T07:53:10Z

added new commands to handle single files and materials

@@ Line 1: / Line 1: @@
-Some of the ambient rendering methods available in TDM require ambient stages in all the material definitions (see [[Virtual Ambient Light Textures]]). Since TDM 1.03, there is a command that automatically converts materials to be compatible with all the ambient methods. This command is called '''tdm_batchConvertMaterials'''.
+=Introduction=
 The command ''tdm_batchConvertMaterials'' analyses a defined number of materials and alters them according to the requirements imposed by TDM 1.03. Its console explanation reads:
 <pre>
@@ Line 12: / Line 50: @@
 The results of the command are stored in the folder of the currently installed FM, e.g. ''.../Doom3/thiefs_den/materials'', or in ''.../Doom3/darkmod/materials'' if no FM is installed. And in case you wonder, the materials don't need to be extracted from the pk4 archives prior to processing.
-=Proper usage of the command=
+==Proper usage of the command==
 In order to run the command without running into malloc errors, one has to successively execute it on different partitions of the materials. If you choose ''nMaterials=1000'' (which appears to be a good value), you'll have to start the command multiple times while increasing the ''StartIndex'' and restarting TDM after each execution (in order to free the memory again). Here is an example:
@@ Line 25: / Line 63: @@
 Eventually the console will say "0 Materials processed and changed in total.", which means you're done.
-==I followed the above instructions but still ran into malloc errors==
 It may occur that you run into malloc errors, although the first executions of the command were successful. This is due to the fact that some materials are more complex than others and require more RAM for that reason. Remember the last ''StartIndex'' and re-execute the command with that index, but a decreased ''nMaterials''. Say for example, you received a malloc error after executing "tdm_batchConvertMaterials 4000 1000". You would now go ahead and do the following:
   tdm_batchConvertMaterials 4000 <b>500</b>

Stifu at 18:32, 28 December 2010

2010-12-28T18:32:16Z

← Older revision		Revision as of 18:32, 28 December 2010
Line 36:		Line 36:
	* Can result in malloc errors. See section [[#Proper Usage of the command\|Proper Usage of the command]].		* Can result in malloc errors. See section [[#Proper Usage of the command\|Proper Usage of the command]].
	* Can produce undesired results on [[DrVertexBlend (tutorial)\|vertex blended materials]], e.g. one of the old ambient stages is not removed. Please double check respective materials.		* Can produce undesired results on [[DrVertexBlend (tutorial)\|vertex blended materials]], e.g. one of the old ambient stages is not removed. Please double check respective materials.

			{{textures}}
			{{Texture Tutorials}}

Stifu: /* Explanation of the command */ - Added information about where the results of the command are stored.

2010-12-28T09:04:34Z

Explanation of the command: - Added information about where the results of the command are stored.

← Older revision		Revision as of 09:04, 28 December 2010
Line 9:		Line 9:

	If ''forceUpdateAll'' is also set, the command will update all materials, independent of the results of the analysis.		If ''forceUpdateAll'' is also set, the command will update all materials, independent of the results of the analysis.

			The results of the command are stored in the folder of the currently installed FM, e.g. ''.../Doom3/thiefs_den/materials'', or in ''.../Doom3/darkmod/materials'' if no FM is installed. And in case you wonder, the materials don't need to be extracted from the pk4 archives prior to processing.

	=Proper usage of the command=		=Proper usage of the command=

Stifu at 13:21, 27 December 2010

2010-12-27T13:21:49Z

← Older revision		Revision as of 13:21, 27 December 2010
Line 1:		Line 1:
	Some of the ambient rendering methods available in TDM require ambient stages in all the material definitions (see [[Virtual Ambient Light Textures]]). Since TDM 1.03 there is a command that automatically converts materials to be compatible with all the ambient methods. This command is called '''tdm_batchConvertMaterials'''.		Some of the ambient rendering methods available in TDM require ambient stages in all the material definitions (see [[Virtual Ambient Light Textures]]). Since TDM 1.03, there is a command that automatically converts materials to be compatible with all the ambient methods. This command is called '''tdm_batchConvertMaterials'''.

	=Explanation of the command=		=Explanation of the command=
Line 33:		Line 33:
	=Known issues=		=Known issues=
	* Can result in malloc errors. See section [[#Proper Usage of the command\|Proper Usage of the command]].		* Can result in malloc errors. See section [[#Proper Usage of the command\|Proper Usage of the command]].
	* Can produce undesired results on vertex blended materials, e.g. one of the old ambient stages is not removed. Please double check respective materials.		* Can produce undesired results on [[DrVertexBlend (tutorial)\|vertex blended materials]], e.g. one of the old ambient stages is not removed. Please double check respective materials.

Stifu: New page: Some of the ambient rendering methods available in TDM require ambient stages in all the material definitions (see Virtual Ambient Light Textures). Since TDM 1.03 there is a command th...

2010-12-27T13:19:25Z

New page: Some of the ambient rendering methods available in TDM require ambient stages in all the material definitions (see Virtual Ambient Light Textures). Since TDM 1.03 there is a command th...

New page

Some of the ambient rendering methods available in TDM require ambient stages in all the material definitions (see [[Virtual Ambient Light Textures]]). Since TDM 1.03 there is a command that automatically converts materials to be compatible with all the ambient methods. This command is called '''tdm_batchConvertMaterials'''.

=Explanation of the command=
The command ''tdm_batchConvertMaterials'' analyses a defined number of materials and alters them according to the requirements imposed by TDM 1.03. Its console explanation reads:
<pre>
Usage: tdm_batchConvertMaterials <StartIndex> <nMaterials> [forceUpdateAll]
</pre>
''StartIndex'' is a number that defines at what material the command is supposed to start processing and ''nMaterials'' defines how many successive materials should be processed. TDM currently consists of about 9000+ materials, so one would probably go ahead and just run the command with the parameters: tdm_batchConvertMaterials 0 10000. The problem is that all materials are parsed into RAM which will eventually lead to '''malloc errors, when the RAM is full'''.

If ''forceUpdateAll'' is also set, the command will update all materials, independent of the results of the analysis.

=Proper usage of the command=
In order to run the command without running into malloc errors, one has to successively execute it on different partitions of the materials. If you choose ''nMaterials=1000'' (which appears to be a good value), you'll have to start the command multiple times while increasing the ''StartIndex'' and restarting TDM after each execution (in order to free the memory again). Here is an example:

tdm_batchConvertMaterials 0 1000
*Wait for finish and restart TDM*
tdm_batchConvertMaterials 1000 1000
*Wait for finish and restart TDM*
tdm_batchConvertMaterials 2000 1000
...

Eventually the console will say "0 Materials processed and changed in total.", which means you're done.

==I followed the above instructions but still ran into malloc errors==
It may occur that you run into malloc errors, although the first executions of the command were successful. This is due to the fact that some materials are more complex than others and require more RAM for that reason. Remember the last ''StartIndex'' and re-execute the command with that index, but a decreased ''nMaterials''. Say for example, you received a malloc error after executing "tdm_batchConvertMaterials 4000 1000". You would now go ahead and do the following:
tdm_batchConvertMaterials 4000 500
*Wait for finish and restart TDM*
tdm_batchConvertMaterials 4500 500
...
After those two executions, you can actually try to raise ''nMaterials'' again to a higher value, in order to reduce the required user-input.

=Known issues=
* Can result in malloc errors. See section [[#Proper Usage of the command|Proper Usage of the command]].
* Can produce undesired results on vertex blended materials, e.g. one of the old ambient stages is not removed. Please double check respective materials.