Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/ogre/Tools/Common/setup/Readme.txt @ 11

Last change on this file since 11 was 6, checked in by anonymous, 17 years ago

=…

File size: 5.7 KB
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: OgreXMLConverter [options] sourcefile [destfile]
16
17Available options:
18-i             = interactive mode - prompt for options
19(The next 4 options are only applicable when converting XML to Mesh)
20-l lodlevels   = number of LOD levels
21-d loddist     = distance increment to reduce LOD
22-p lodpercent  = Percentage triangle reduction amount per LOD
23-f lodnumtris  = Fixed vertex reduction per LOD
24-e             = DON'T generate edge lists (for stencil shadows)
25-r             = DON'T reorganise vertex buffers to OGRE recommended format.
26-t             = Generate tangents (for normal mapping)
27-o             = DON'T optimise out redundant tracks & keyframes
28-d3d           = Prefer D3D packed colour formats (default on Windows)
29-gl            = Prefer GL packed colour formats (default on non-Windows)
30-E endian      = Set endian mode 'big' 'little' or 'native' (default)
31-q             = Quiet mode, less output
32-log filename  = name of the log file (default: 'OgreXMLConverter.log')
33sourcefile     = name of file to convert
34destfile       = optional name of file to write to. If you don't
35                 specify this OGRE works it out through the extension
36                 and the XML contents if the source is XML. For example
37                 test.mesh becomes test.xml, test.xml becomes test.mesh
38                 if the XML document root is <mesh> etc.
39
40Because the default behaviour is to convert binary to XML and vice versa, you
41can simply drag files onto this converter and it will convert between the 2
42formats, although you will not be able to use it to generate LOD levels this
43way.
44
45OgreMeshUpgrade
46---------------
47
48This tool upgrades a .mesh file from any previous version of OGRE to the latest
49version. You will be advised in Ogre.log if your meshes are of an old version;
50OGRE can still load old versions but performance may not be as good as it would
51be with the latest version. You are advised to upgrade your meshes whenever you
52update to another major version of OGRE.
53
54Usage: OgreMeshUpgrader [options] sourcefile [destfile]
55-i             = Interactive mode, prompt for options
56-l lodlevels   = number of LOD levels
57-d loddist     = distance increment to reduce LOD
58-p lodpercent  = Percentage triangle reduction amount per LOD
59-f lodnumtris  = Fixed vertex reduction per LOD
60-e         = DON'T generate edge lists (for stencil shadows)
61-t         = Generate tangents (for normal mapping)
62-r         = DON'T reorganise buffers to recommended format
63-d3d       = Convert to D3D colour formats
64-gl        = Convert to GL colour formats
65-srcd3d    = Interpret ambiguous colours as D3D style
66-srcgl     = Interpret ambiguous colours as GL style
67-E endian  = Set endian mode 'big' 'little' or 'native' (default)
68sourcefile = name of file to convert
69destfile   = optional name of file to write to. If you don't
70             specify this OGRE overwrites the existing file.
71
72Again you can drag files onto this tool, so long as you don't mind it
73overwriting the file in place. If you'd prefer to keep a backup, make a copy or
74use the command line to upgrade to a different file.
75
76Reorganising vertex buffers: this tool now allows you to restructure the vertex
77buffers in your mesh. If you are upgrading from a version prior to 0.15.0, then
78you should answer 'y' when asked if you want to reorganise the buffers, since
790.15.0 and later allows more efficient structures in the binary mesh. You will
80then be shown the buffer structures for each of the geometry sections; you can
81either reorganise the buffers yourself, or use 'automatic' mode, which is
82recommended unless you know what you're doing.
83
84OgreMaterialUpgrade
85-------------------
86Upgrades a .material script from any previous version of OGRE to the new
87.material format. Note that upgraded scripts do not use any new features of the
88material, and you may find that some attributes are re-written as their
89'complex' variants rather than their simplified versions (e.g. "scene_blend add"
90will be written as "scene_blend one one" because this is what 'add' maps down
91to.
92
93You only need to run this tool if you have .material scripts from a version of
94OGRE older than 0.13.0. Material scripts written for 0.13.0 onwards do not
95need upgrading.
96
97Usage:
98
99OgreMaterialUpgrade sourcefile [destfile]
100sourcefile = name of file to convert
101destfile   = optional name of file to write to. If you don't
102             specify this OGRE overwrites the existing file.
103
104Again you can drag files onto this tool, so long as you don't mind it
105overwriting the file in place. If you'd prefer to keep a backup, make a copy or
106use the command line to upgrade to a different file.
107
108MeshMagick
109----------
110Copyright 2007 by Daniel Wickert
111
112Command-line tool for performing operations on meshes and skeletons.
113
114Usage:
115
116MeshMagick [global_options] toolname [tool_options] infile(s) -- [outfile(s)]
117
118Available Tools:
119
120info - print information about the mesh.
121meshmerge - Merge multiple submeshes into a single mesh.
122optimise - Optimise meshes and skeletons.
123rename - Rename different elements of meshes and skeletons.
124transform - Scale, rotate or otherwise transform a mesh.
125
126See MeshMagick -help=toolname for more detailed information.
127
128
129
130Copyright 2004-7 The OGRE Team
Note: See TracBrowser for help on using the repository browser.