| 1 | OGRE COMMAND-LINE UTILITIES |
|---|
| 2 | =========================== |
|---|
| 3 | |
|---|
| 4 | This archive contains a few prebuilt command-line tools for manipulating your |
|---|
| 5 | media. For further info, visit http://www.ogre3d.org |
|---|
| 6 | |
|---|
| 7 | OgreXMLConverter |
|---|
| 8 | ---------------- |
|---|
| 9 | Converts between the binary and XML formats for .mesh and .skeleton. Will also |
|---|
| 10 | allow you to generate LOD information if you are converting to the binary |
|---|
| 11 | format. This tool is necessary to convert from the XML to OGRE's native runtime |
|---|
| 12 | format if your exporter produces XML. You can find the XML Schema for the .mesh |
|---|
| 13 | and .skeleton formats in the Ogre source under Tools/XMLConverter/docs. |
|---|
| 14 | |
|---|
| 15 | Usage: |
|---|
| 16 | |
|---|
| 17 | OgreXMLConverter [-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) |
|---|
| 27 | sourcefile = name of file to convert |
|---|
| 28 | destfile = 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 | |
|---|
| 34 | Because the default behaviour is to convert binary to XML and vice versa, you |
|---|
| 35 | can simply drag files onto this converter and it will convert between the 2 |
|---|
| 36 | formats, although you will not be able to use it to generate LOD levels this |
|---|
| 37 | way. |
|---|
| 38 | |
|---|
| 39 | OgreMeshUpgrade |
|---|
| 40 | --------------- |
|---|
| 41 | |
|---|
| 42 | This tool upgrades a .mesh file from any previous version of OGRE to the latest |
|---|
| 43 | version. You will be advised in Ogre.log if your meshes are of an old version; |
|---|
| 44 | OGRE can still load old versions but performance may not be as good as it would |
|---|
| 45 | be with the latest version. You are advised to upgrade your meshes whenever you |
|---|
| 46 | update to another major version of OGRE. |
|---|
| 47 | |
|---|
| 48 | Usage: |
|---|
| 49 | |
|---|
| 50 | Usage: OgreMeshUpgrader [-e][-t] sourcefile [destfile] |
|---|
| 51 | -e = DON'T generate edge lists (for stencil shadows) |
|---|
| 52 | -t = Generate tangents (for normal mapping) |
|---|
| 53 | sourcefile = name of file to convert |
|---|
| 54 | destfile = optional name of file to write to. If you don't |
|---|
| 55 | specify this OGRE overwrites the existing file. |
|---|
| 56 | |
|---|
| 57 | Again you can drag files onto this tool, so long as you don't mind it |
|---|
| 58 | overwriting the file in place. If you'd prefer to keep a backup, make a copy or |
|---|
| 59 | use the command line to upgrade to a different file. |
|---|
| 60 | |
|---|
| 61 | Reorganising vertex buffers: this tool now allows you to restructure the vertex |
|---|
| 62 | buffers in your mesh. If you are upgrading from a version prior to 0.15.0, then |
|---|
| 63 | you should answer 'y' when asked if you want to reorganise the buffers, since |
|---|
| 64 | 0.15.0 and later allows more efficient structures in the binary mesh. You will |
|---|
| 65 | then be shown the buffer structures for each of the geometry sections; you can |
|---|
| 66 | either reorganise the buffers yourself, or use 'automatic' mode, which is |
|---|
| 67 | recommended unless you know what you're doing. |
|---|
| 68 | |
|---|
| 69 | OgreMaterialUpgrade |
|---|
| 70 | ------------------- |
|---|
| 71 | Upgrades 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 |
|---|
| 73 | material, 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" |
|---|
| 75 | will be written as "scene_blend one one" because this is what 'add' maps down |
|---|
| 76 | to. |
|---|
| 77 | |
|---|
| 78 | You only need to run this tool if you have .material scripts from a version of |
|---|
| 79 | OGRE older than 0.13.0. Material scripts written for 0.13.0 onwards do not |
|---|
| 80 | need upgrading. |
|---|
| 81 | |
|---|
| 82 | Usage: |
|---|
| 83 | |
|---|
| 84 | OgreMaterialUpgrade sourcefile [destfile] |
|---|
| 85 | sourcefile = name of file to convert |
|---|
| 86 | destfile = optional name of file to write to. If you don't |
|---|
| 87 | specify this OGRE overwrites the existing file. |
|---|
| 88 | |
|---|
| 89 | Again you can drag files onto this tool, so long as you don't mind it |
|---|
| 90 | overwriting the file in place. If you'd prefer to keep a backup, make a copy or |
|---|
| 91 | use the command line to upgrade to a different file. |
|---|
| 92 | |
|---|
| 93 | Copyright 2004 The OGRE Team |
|---|
