diff options
Diffstat (limited to 'src/3rdparty/assimp/Readme.md')
| -rw-r--r-- | src/3rdparty/assimp/Readme.md | 121 |
1 files changed, 76 insertions, 45 deletions
diff --git a/src/3rdparty/assimp/Readme.md b/src/3rdparty/assimp/Readme.md index e4fe07b02..1f6c4118f 100644 --- a/src/3rdparty/assimp/Readme.md +++ b/src/3rdparty/assimp/Readme.md @@ -1,71 +1,100 @@ Open Asset Import Library (assimp) ================================== +A library to import and export various 3d-model-formats including scene-post-processing to generate missing render data. +### Current build status ### +[](https://travis-ci.org/assimp/assimp) +[](https://ci.appveyor.com/project/kimkulling/assimp) +<a href="https://scan.coverity.com/projects/5607"> + <img alt="Coverity Scan Build Status" + src="https://scan.coverity.com/projects/5607/badge.svg"/> +</a> +[](https://coveralls.io/github/assimp/assimp?branch=master) +[](https://gitter.im/assimp/assimp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +<br> APIs are provided for C and C++. There are various bindings to other languages (C#, Java, Python, Delphi, D). Assimp also runs on Android and iOS. Additionally, assimp features various __mesh post processing tools__: normals and tangent space generation, triangulation, vertex cache locality optimization, removal of degenerate primitives and duplicate vertices, sorting by primitive type, merging of redundant materials and many more. -This is the development trunk containing the latest features and bugfixes. For productive use though, we recommend one of the stable releases available from [assimp.sf.net](http://assimp.sf.net) or from *nix package repositories. -The current build status is: +This is the development repo containing the latest features and bugfixes. For productive use though, we recommend one of the stable releases available from [Github Assimp Releases](https://github.com/assimp/assimp/releases). + +Monthly donations via Patreon: +<br>[](http://www.patreon.com/assimp) + +<br> + +One-off donations via PayPal: +<br>[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4JRJVPXC4QJM4) -Linux [](https://travis-ci.org/assimp/assimp) -Windows [](https://ci.appveyor.com/project/kimkulling/assimp) -Coverity<a href="https://scan.coverity.com/projects/5607"> - <img alt="Coverity Scan Build Status" - src="https://scan.coverity.com/projects/5607/badge.svg"/> -</a> -Gitter [](https://gitter.im/assimp/assimp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) <br> -__[open3mod](https://github.com/acgessler/open3mod) is a powerful 3D model viewer based on Assimp's import and export abilities.__ + +Please check our Wiki as well: https://github.com/assimp/assimp/wiki #### Supported file formats #### -A full list [is here](http://assimp.sourceforge.net/main_features_formats.html). +A full list [is here](http://assimp.org/main_features_formats.html). __Importers__: - +- 3D - 3DS +- 3MF +- AC +- AC3D +- ACC +- AMJ +- ASE +- ASK +- B3D; - BLEND (Blender) +- BVH +- COB +- CMS - DAE/Collada +- DXF +- ENFF - FBX +- glTF 1.0 + GLB +- glTF 2.0 +- HMB - IFC-STEP -- ASE -- DXF -- HMP +- IRR / IRRMESH +- LWO +- LWS +- LXO - MD2 - MD3 - MD5 - MDC - MDL +- MESH / MESH.XML +- MOT +- MS3D +- NDO - NFF -- PLY -- STL -- X - OBJ -- OpenGEX +- OFF +- OGEX +- PLY +- PMX +- PRJ +- Q3O +- Q3S +- RAW +- SCN +- SIB - SMD -- LWO -- LXO -- LWS +- STL +- STP - TER -- AC3D -- MS3D -- COB -- Q3BSP +- UC +- VTA +- X +- X3D - XGL -- CSM -- BVH -- B3D -- NDO -- Ogre Binary -- Ogre XML -- Q3D -- ASSBIN (Assimp custom format) -- glTF (partial) -- 3MF +- ZGL Additionally, some formats are supported by dependency on non-free code or external SDKs (not built by default): -- C4D (https://github.com/acgessler/assimp-cinema4d) +- C4D (https://github.com/assimp/assimp/wiki/Cinema4D-&-Melange) __Exporters__: @@ -78,7 +107,8 @@ __Exporters__: - JSON (for WebGl, via https://github.com/acgessler/assimp2json) - ASSBIN - STEP -- glTF (partial) +- glTF 1.0 (partial) +- glTF 2.0 (partial) ### Building ### Take a look into the `INSTALL` file. Our build system is CMake, if you used CMake before there is a good chance you know what to do. @@ -88,6 +118,12 @@ Take a look into the `INSTALL` file. Our build system is CMake, if you used CMak * [Python](port/PyAssimp/README.md) * [.NET](port/AssimpNET/Readme.md) * [Pascal](port/AssimpPascal/Readme.md) +* [Javascript (Alpha)](https://github.com/makc/assimp2json) +* [Unity 3d Plugin](https://www.assetstore.unity3d.com/en/#!/content/91777) +* [JVM](https://github.com/kotlin-graphics/assimp) Full jvm port (currently supported obj, ply, stl, collada, md2) + +### Other tools ### +[open3mod](https://github.com/acgessler/open3mod) is a powerful 3D model viewer based on Assimp's import and export abilities. #### Repository structure #### Open Asset Import Library is implemented in C++. The directory structure is: @@ -107,7 +143,7 @@ Open Asset Import Library is implemented in C++. The directory structure is: ### Where to get help ### -For more information, visit [our website](http://assimp.sourceforge.net/). Or check out the `./doc`- folder, which contains the official documentation in HTML format. +For more information, visit [our website](http://assimp.org/). Or check out the `./doc`- folder, which contains the official documentation in HTML format. (CHMs for Windows are included in some release packages and should be located right here in the root folder). If the docs don't solve your problem, ask on [StackOverflow](http://stackoverflow.com/questions/tagged/assimp?sort=newest). If you think you found a bug, please open an issue on Github. @@ -117,17 +153,12 @@ For development discussions, there is also a (very low-volume) mailing list, _as Open Asset Import Library is a library to load various 3d file formats into a shared, in-memory format. It supports more than __40 file formats__ for import and a growing selection of file formats for export. -And we also have an IRC-channel at freenode: #assetimporterlib . You can easily join us via: [KiwiIRC/freenote](https://kiwiirc.com/client/irc.freenode.net), choose your nickname and type -> /join #assetimporterlib +And we also have a Gitter-channel:Gitter [](https://gitter.im/assimp/assimp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)<br> ### Contributing ### Contributions to assimp are highly appreciated. The easiest way to get involved is to submit a pull request with your changes against the main repository's `master` branch. -### Donate ### -If you like assimp, consider buying us a beer (or two): -[Donate](http://sourceforge.net/donate/index.php?group_id=226462) - ### License ### Our license is based on the modified, __3-clause BSD__-License. |