diff options
Diffstat (limited to 'src/3rdparty/assimp/Readme.md')
| -rw-r--r-- | src/3rdparty/assimp/Readme.md | 119 |
1 files changed, 69 insertions, 50 deletions
diff --git a/src/3rdparty/assimp/Readme.md b/src/3rdparty/assimp/Readme.md index 214417798..e4fe07b02 100644 --- a/src/3rdparty/assimp/Readme.md +++ b/src/3rdparty/assimp/Readme.md @@ -1,39 +1,54 @@ -Open Asset Import Library (assimp) -======== +Open Asset Import Library (assimp) +================================== -Open Asset Import Library is a Open Source library designed to load various __3d file formats and convert them into a shared, in-memory format__. It supports more than __30 file formats__ for import and a growing selection of file formats for export. Additionally, assimp features various __post processing tools__ to refine the imported data: _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. +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. -This is the development trunk of assimp 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. According to [Travis-CI] (https://travis-ci.org/), the current build status of the trunk is [](https://travis-ci.org/assimp/assimp) +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: + +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.__ #### Supported file formats #### -The library provides importers for a lot of file formats, including: +A full list [is here](http://assimp.sourceforge.net/main_features_formats.html). +__Importers__: - 3DS -- BLEND (Blender 3D) +- BLEND (Blender) - DAE/Collada - FBX -- IFC-STEP +- IFC-STEP - ASE - DXF - HMP - MD2 -- MD3 +- MD3 - MD5 - MDC - MDL - NFF - PLY - STL -- X -- OBJ +- X +- OBJ +- OpenGEX - SMD -- LWO -- LXO +- LWO +- LXO - LWS -- TER -- AC3D -- MS3D +- TER +- AC3D +- MS3D - COB - Q3BSP - XGL @@ -44,77 +59,81 @@ The library provides importers for a lot of file formats, including: - Ogre Binary - Ogre XML - Q3D - -Additionally, the following formats are also supported, but not part of the core library as they depend on proprietary libraries. +- ASSBIN (Assimp custom format) +- glTF (partial) +- 3MF + +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) -Exporters include: +__Exporters__: - DAE (Collada) - STL - OBJ - PLY +- X +- 3DS - JSON (for WebGl, via https://github.com/acgessler/assimp2json) - -See [the full list here](http://assimp.sourceforge.net/main_features_formats.html). +- ASSBIN +- STEP +- glTF (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. +### Ports ### +* [Android](port/AndroidJNI/README.md) +* [Python](port/PyAssimp/README.md) +* [.NET](port/AssimpNET/Readme.md) +* [Pascal](port/AssimpPascal/Readme.md) #### Repository structure #### +Open Asset Import Library is implemented in C++. The directory structure is: - -Open Asset Import Library is implemented in C++ (but provides both a C and a -C++ish interface). The directory structure is: - - /bin Folder for binaries, only used on Windows /code Source code /contrib Third-party libraries /doc Documentation (doxysource and pre-compiled docs) /include Public header C and C++ header files - /lib Static library location for Windows - /obj Object file location for Windows /scripts Scripts used to generate the loading code for some formats /port Ports to other languages and scripts to maintain those. /test Unit- and regression tests, test suite of models - /tools Tools (viewer, command line `assimp`) - /samples A small number of samples to illustrate possible + /tools Tools (old assimp viewer, command line `assimp`) + /samples A small number of samples to illustrate possible use cases for Assimp - /workspaces Build enviroments for vc,xcode,... (deprecated, + /workspaces Build environments for vc,xcode,... (deprecated, CMake has superseeded all legacy build options!) - -### Building ### - - -Take a look into the `INSTALL` file. Our build system is CMake, if you already used CMake before there is a good chance you know what to do. - - ### 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. (CHMs for Windows are included in some release packages and should be located right here in the root folder). -If the documentation doesn't solve your problems, -[try our forums at SF.net](http://sourceforge.net/p/assimp/discussion/817654) or ask on -[StackOverflow](http://stackoverflow.com/questions/tagged/assimp?sort=newest). +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. -For development discussions, there is also a mailing list, _assimp-discussions_ - [(subscribe here)]( https://lists.sourceforge.net/lists/listinfo/assimp-discussions) +For development discussions, there is also a (very low-volume) mailing list, _assimp-discussions_ + [(subscribe here)]( https://lists.sourceforge.net/lists/listinfo/assimp-discussions) -### Contributing ### +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 -Contributions to assimp are highly appreciated. The easiest way to get involved is to submit +### 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. -Our license is based on the modified, __3-clause BSD__-License, which is very liberal. - -An _informal_ summary is: do whatever you want, but include Assimp's license text with your product - +An _informal_ summary is: do whatever you want, but include Assimp's license text with your product - and don't sue us if our code doesn't work. Note that, unlike LGPLed code, you may link statically to Assimp. -For the legal details, see the `LICENSE` file. +For the legal details, see the `LICENSE` file. +### Why this name ### +Sorry, we're germans :-), no english native speakers ... |