source: OGRE/trunk/ogrenew/Tools/CommandLineTools_Readme.txt @ 657

Revision 657, 4.2 KB checked in by mattausch, 19 years ago (diff)

added ogre dependencies and patched ogre sources

Line 
1OGRE COMMAND-LINE UTILITIES
2===========================
3
4This archive contains a few prebuilt command-line tools for manipulating your
5media. For further info, visit http://www.ogre3d.org
6
7OgreXMLConverter
8----------------
9Converts between the binary and XML formats for .mesh and .skeleton. Will also
10allow you to generate LOD information if you are converting to the binary
11format. This tool is necessary to convert from the XML to OGRE's native runtime
12format if your exporter produces XML. You can find the XML Schema for the .mesh
13and .skeleton formats in the Ogre source under Tools/XMLConverter/docs.
14
15Usage:
16
17OgreXMLConverter [-i] [-e] [-t] [-l lodlevels] [-d loddist]
18                [[-p lodpercent][-f lodnumtris]] sourcefile [destfile]
19-i             = interactive mode - prompt for options
20(The next 6 options are only applicable when converting XML to Mesh)
21-l lodlevels   = number of LOD levels
22-d loddist     = distance increment to reduce LOD
23-p lodpercent  = Percentage triangle reduction amount per LOD
24-f lodnumtris  = Fixed vertex reduction per LOD
25-e             = DO NOT generate edge lists, ie disable stencil shadows
26-t             = Generate tangent-space vectors (for normal mapping)
27sourcefile     = name of file to convert
28destfile       = optional name of file to write to. If you don't
29                 specify this OGRE works it out through the extension
30                 and the XML contents if the source is XML. For example
31                 test.mesh becomes test.xml, test.xml becomes test.mesh
32                 if the XML document root is <mesh> etc.
33
34Because the default behaviour is to convert binary to XML and vice versa, you
35can simply drag files onto this converter and it will convert between the 2
36formats, although you will not be able to use it to generate LOD levels this
37way.
38
39OgreMeshUpgrade
40---------------
41
42This tool upgrades a .mesh file from any previous version of OGRE to the latest
43version. You will be advised in Ogre.log if your meshes are of an old version;
44OGRE can still load old versions but performance may not be as good as it would
45be with the latest version. You are advised to upgrade your meshes whenever you
46update to another major version of OGRE.
47
48Usage:
49
50Usage: OgreMeshUpgrader [-e][-t] sourcefile [destfile]
51-e         = DON'T generate edge lists (for stencil shadows)
52-t         = Generate tangents (for normal mapping)
53sourcefile = name of file to convert
54destfile   = optional name of file to write to. If you don't
55             specify this OGRE overwrites the existing file.
56
57Again you can drag files onto this tool, so long as you don't mind it
58overwriting the file in place. If you'd prefer to keep a backup, make a copy or
59use the command line to upgrade to a different file.
60
61Reorganising vertex buffers: this tool now allows you to restructure the vertex
62buffers in your mesh. If you are upgrading from a version prior to 0.15.0, then
63you should answer 'y' when asked if you want to reorganise the buffers, since
640.15.0 and later allows more efficient structures in the binary mesh. You will
65then be shown the buffer structures for each of the geometry sections; you can
66either reorganise the buffers yourself, or use 'automatic' mode, which is
67recommended unless you know what you're doing.
68
69OgreMaterialUpgrade
70-------------------
71Upgrades a .material script from any previous version of OGRE to the new
72.material format. Note that upgraded scripts do not use any new features of the
73material, and you may find that some attributes are re-written as their
74'complex' variants rather than their simplified versions (e.g. "scene_blend add"
75will be written as "scene_blend one one" because this is what 'add' maps down
76to.
77
78You only need to run this tool if you have .material scripts from a version of
79OGRE older than 0.13.0. Material scripts written for 0.13.0 onwards do not
80need upgrading.
81
82Usage:
83
84OgreMaterialUpgrade sourcefile [destfile]
85sourcefile = name of file to convert
86destfile   = optional name of file to write to. If you don't
87             specify this OGRE overwrites the existing file.
88
89Again you can drag files onto this tool, so long as you don't mind it
90overwriting the file in place. If you'd prefer to keep a backup, make a copy or
91use the command line to upgrade to a different file.
92
93Copyright 2004 The OGRE Team
Note: See TracBrowser for help on using the repository browser.