List tools in alphabetical order in the documentation; fixed outdated information.

This commit is contained in:
Lasse Öörni 2013-09-02 21:11:28 +00:00
Родитель 76161aaecf
Коммит c9865078ad
2 изменённых файлов: 26 добавлений и 29 удалений

Просмотреть файл

@ -148,7 +148,7 @@ Urho3D <scriptfilename> [options]
The scripting language supported by default is AngelScript (http://www.angelcode.com/angelscript); the script files have .as extension and need to be placed under either the Bin/Data or Bin/CoreData subdirectories so that Urho3D can find them. An application script is required to have the function void Start(), which will be executed before starting the engine main loop. It is this function's responsibility to initialize the application and to hook up to any necessary \ref Events "events", such as the update that happens every frame.
Lua language support can be alternatively be built in, see \ref Build_Options "Build options".
Lua language support can optionally be built in, see \ref Build_Options "Build options".
On Android and iOS the command line can not be entered, so it is instead read from the file Bin/Data/CommandLine.txt. By default the NinjaSnowWar example will be run.

Просмотреть файл

@ -1564,6 +1564,16 @@ The material list is a text file, one material per line, saved alongside the Urh
In model or scene mode, the AssetImporter utility will also automatically save non-skeletal node animations into the output file directory.
\section Tools_DocConverter DocConverter
Automatically converts the Urho3D Doxygen pages to Google Code wiki format.
Usage:
\verbatim
DocConverter <dox input path> <wiki output path> <mainpage name>
\endverbatim
\section Tools_OgreImporter OgreImporter
Loads OGRE .mesh.xml and .skeleton.xml files and saves them as Urho3D .mdl (model) and .ani (animation) files. For other 3D formats and whole scene importing, see AssetImporter instead. However that tool does not handle the OGRE formats as completely as this.
@ -1613,7 +1623,21 @@ RampGenerator <output file> <width> <power> [dimensions]
The output is saved in PNG format. The power parameter is fed into the pow() function to determine ramp shape; higher value gives more brightness and more abrupt fade at the edge.
The texconv tool from the DirectX SDK needs to be available through the system PATH.
\section Tools_ScriptCompiler ScriptCompiler
Compiles AngelScript file(s) to binary bytecode for faster loading. Can also dump the %Script API in Doxygen format.
Usage:
\verbatim
ScriptCompiler <input file> [resource path for includes]
ScriptCompiler -dumpapi [output file]
\endverbatim
The output files are saved with the extension .asc (compiled AngelScript.) Binary files are not automatically loaded instead of the text format (.as) script files, instead resource requests and resource references in objects need to point to the compiled files. In a final build of an application it may be convenient to simply replace the text format script files with the compiled scripts.
The script API dump mode can be used to replace the 'ScriptAPI.dox' file in the 'Docs' directory. If the output file name is not provided then the script API would be dumped to standard output (console) instead.
\section Tools_ShaderCompiler ShaderCompiler
@ -1641,33 +1665,6 @@ The D3DX library from the DirectX runtime or SDK needs to be installed. Note tha
Note that GLSL shaders in the Bin/CoreData/Shaders/GLSL directory also use similar XML definition files, but no precompiling tool exists for them; they are always compiled during runtime.
\section Tools_ScriptCompiler ScriptCompiler
Compiles AngelScript file(s) to binary bytecode for faster loading. Can also dump the %Script API in Doxygen format.
Usage:
\verbatim
ScriptCompiler <input file> [resource path for includes]
ScriptCompiler -dumpapi [output file]
\endverbatim
The output files are saved with the extension .asc (compiled AngelScript.) Binary files are not automatically loaded instead of the text format (.as) script files, instead resource requests and resource references in objects need to point to the compiled files. In a final build of an application it may be convenient to simply replace the text format script files with the compiled scripts.
The script API dump mode can be used to replace the 'ScriptAPI.dox' file in the 'Docs' directory. If the output file name is not provided then the script API would be dumped to standard output (console) instead.
\section Tools_DocConverter DocConverter
Automatically converts the Urho3D Doxygen pages to Google Code wiki format.
Usage:
\verbatim
DocConverter <dox input path> <wiki output path> <mainpage name>
\endverbatim
\page Unicode Unicode support
The String class supports UTF-8 encoding. However, by default strings are treated as a sequence of bytes without regard to the encoding. There is a separate