Student: Vladimir Sukhoy (buddy)
Mentor: Michael Reimpell (reimpell)
Status: Ongoing development in ogreaddons/RmOgreExporter
The project has two major parts:
- Extend and reimplement existing RenderMonkey -> Ogre material exporter (RmOgreExporter (v2)).
- Create separate .fx -> ogre material converter (the initial proposal was modified on OGRE community request, original plan was to create an exporter tool for FXComposer) (FxOgreExporter).
Existing RmOgreExporter codebase will be used to enhance the tool to a newer level of usability. A better level of integration between existing major
shader/material designer software and OGRE engine is a major goal.
Latest version installer:
this is RM1.62 Python 2.4 compatible version, as you can probably guess from the filename.
You will need to install Python and pywin32 separately!.
- [pylogic] rewrite exporter logic in Python and bundle interpreter code with the software, so that users will be able to contribute and tweak the exporter for their tasks (this one is really time-consuming, since rmsdk python wrapper must be created).
- [import] add import capabilities to the plugin, so that people can edit their existing OGRE materials in shader designers (RenderMonkey) and then export the result back into OGRE.
- [scripting] add scripting capabilities for "batch" export.
- [previewer] add optional preview capability to the tool.
- [doc] document the code being developed and come up with "User's Manual".
- [rmogl] support OpenGL branch of RenderMonkey (it is not supported in RmOgreExporter v1).
- [exflex] - more flexibility to export scripts (different directories, different material names...)
- [persistence] - make export/import options persistent in the workspace file.
- [zipbackend] - implement zip backend for export/import.
- [improv] - Improve tool intelligence to deal with inherent differences in shader designer's material model and OGRE material framework.
- [idefiles] - More makefiles/project files/solutions for more IDEs (e.g. MSVS .NET 2005, and MinGW support)
- [meshimport] - Import OGRE's mesh geometry files (.mesh) into Shader Designers.
- [varsup] - More variables supported by OGRE: (camera in world space, ambient light color, ...)
- [installer] - Package the tool and provide installer.
- rmsdk was wrapped into python (via boost::python). I estimate "integration" level of rmsdk (e.g. what you can do in Python over what you can do in C++) at 90-95% for "Core" functionality (some minor stuff like XML manager or Undo/Redo stuff is missing). That means that one can freely manipulate workspace nodes, use appliÑation singleton etc. It seems that rmsdk wrapper may (and probably should) be released as a standalone library, as it may be useful for anyone who wants to develop python plugins for RenderMonkey. As the amount of source in rmsdk was hmm... serious, I had to develop some kind of toolset on top of boost::python to simplify a lot of things. But still there are many kilobytes involved, no magic here .
- As RenderMonkey uses .dll binary interface to talk with plugins, a gateway plugin was required that "translates" rendermonkey calls to python module and invokes appropriate python functionality. This gateway plugin is essential to use rmsdk wrapper.
- Native Ogre material serializer framework is used to store materials. There is one minor issue though: there is no easy way to store "useful" comments inside the material script with this approach, however it is still preferred to doing everything manually as it was in RmOgreExporter (v1).
- pyogre folks forgot to wrap MaterialSerializer class, so a tiny wrapper "ogre_mini" was created via boost::python. The wrapper exports some functionality to support native serializing from python. Nevertheless I plan to use their code for preview.
- Python source which implements (partially, for now) exporting plugin functionality similar to RmOgreExporter (v1), and uses rmsdk wrapper is developed.
In version 2.01
- Compatibility with RenderMonkey 1.62, thanks to sebarnolds!
- Ability to export glsl shaders (preview non-functional), again thanks to sebarnolds!
The work seems to be mostly complete, so the version number is now 1.0 . The name of the executable is "fxogretool".
Note that the tool is no silver bullet - so expect some polishing to be done on the output. Sometimes matrices have to be transposed, normals flipped etc. It usually depends on what you are trying to visualize with exported material and what was expected to be visualized by FX file designer. Also do not expect it to handle everything you can do with FX _semantically_. But usually it produces output that is close.
By the way, usually .fx file can be fed to HLSL compiler (and to OGRE) with no problems, so no need to extract HLSL pieces from .fx code. FX is actually HLSL or vice versa).
Current version (in addons/RmOgreExporter see fxogretool project) supports following:
- Direct3D 9 .fx BNF parser (tested against most of examples in DirectX9 SDK directory - no parse errors, total of 101 file tested).
- Can build parse and abstract syntax trees from .fx script.
- Can dump these trees to xml, so that they can be used for debugging or for any other purpose (syntax representation of .fx file in XML can be useful for anyone messing with .fx files). Parse tree is more appropriate for something comprehensive, AST is smaller, however often more convenient to analyze.
- The source code has an FX grammar parser and lexical analyzer grammars exposed in boost::spirit format (C++ code which looks like (and is used to build) BNF grammar).
- Regular expressions are used to setup automatic variables (which can be supplied via command line and alternatively via config file).
- Variable definitions from FX file are used to setup variables in material script.
- Techniques, passes and states from FX file are translated to OGRE techniques, passes and states (if possible).
The executable depends on OGRE (material serializer stuff), boost (spirit, regex etc.). There is no dependency on DirectX - everything related to FX is homegrown.
The basic usage:
fxogretool source.fx result.material
A number of options are available. To request the list of them use
Important options are:
Specifies fx file to parse (Uses first argument if not supplied explicitly, like above).
Specifies material file to create (Uses second argument if not supplied explicitly).
Store parse tree in XML.
Store AST tree in XML.
Use config.txt to get regular expressions for automatic variables. regexps may be also supplied via command line. The config file is expected to look like (like anything that ends with "World" will be param_named_auto name world_matrix etc.)
world_matrix=^.+World$ view_matrix=^.+View$ ....
- Tree building is relatively slow (several seconds, up to 10-15 on my machine for fat enough .fx file).
- Relatively slow compilation.
- To keep ogre from complaining (it is DirectX parser who complains, actually) the tool should walk over respective vertex/pixel shader code and eliminate unused variable references.
- Support DirectX 10 FX files (they actually extended the grammar and semantics quite a bit).
- Support #define
- Support #include (although OGRE does not support those).
- Much of the above actualy requires some sort of semantics to be implemented. Nice semantics is time consuming and is almost equivalent to the actual compiler (to some extent). But in the end given semantics support it is actually possible to map HLSL to GLSL or Cg, as those are loosely close. On the contrary there is no good docs (at least I could not find those) on HLSL semantics, no standard document or anything close. Even grammar itself is given pretty much AS IS. So no cakewalk there.
See the builtin help on command line options.
THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
- "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
- "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
- "Licensor" means the individual or entity that offers the Work under the terms of this License.
- "Original Author" means the individual or entity who created the Work.
- "Work" means the copyrightable work of authorship offered under the terms of this License.
- "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
- "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.
Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.
Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:
- to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
- to create and reproduce Derivative Works;
- to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
- to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
- For the avoidance of doubt, where the work is a musical composition:
- Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
- Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
- Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).
The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.
The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:
- You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
- You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
- If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.
UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
- This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
- Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.
- Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
- Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
- If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
- No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
- This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.