e4f05064df
Current documentation lacks a proper directory handling and switch for Unix like systems. The option BUILD_DOCS are added as disable by default, even so the Doxyfile file is generated for a manual build. Option HTML_OUTPUT are made cached to be properly replaced, as usually done by some Linux distributions Microsoft CHM option is enabled if MSVC is detected. |
||
|---|---|---|
| cmake-modules | ||
| code | ||
| contrib | ||
| doc | ||
| include/assimp | ||
| packaging | ||
| port | ||
| samples | ||
| scripts | ||
| test | ||
| tools | ||
| .coveralls.yml | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.sh | ||
| .travis.yml | ||
| AssimpBuildTreeSettings.cmake.in | ||
| AssimpConfig.cmake.in | ||
| AssimpConfigVersion.cmake.in | ||
| CHANGES | ||
| CMakeLists.txt | ||
| CREDITS | ||
| CodeConventions.md | ||
| INSTALL | ||
| LICENSE | ||
| README | ||
| Readme.md | ||
| appveyor.yml | ||
| assimp-config-version.cmake.in | ||
| assimp-config.cmake.in | ||
| assimp.pc.in | ||
| revision.h.in | ||
Readme.md
Open Asset Import Library (assimp)
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 or from *nix package repositories. The current build status is:
Gitter chat: 
And we also have an IRC-channel at freenode: #assetimporterlib . You can easily join us via: KiwiIRC/freenote, choose your nickname and type
/join #assetimporterlib
__[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. Importers:
- 3DS
- BLEND (Blender)
- DAE/Collada
- FBX
- IFC-STEP
- ASE
- DXF
- HMP
- MD2
- MD3
- MD5
- MDC
- MDL
- NFF
- PLY
- STL
- X
- OBJ
- OpenGEX
- SMD
- LWO
- LXO
- LWS
- TER
- AC3D
- MS3D
- COB
- Q3BSP
- XGL
- CSM
- BVH
- B3D
- NDO
- Ogre Binary
- Ogre XML
- Q3D
- 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):
Exporters:
- DAE (Collada)
- STL
- OBJ
- PLY
- X
- 3DS
- JSON (for WebGl, via https://github.com/acgessler/assimp2json)
- 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
Repository structure
Open Asset Import Library is implemented in C++. The directory structure is:
/code Source code
/contrib Third-party libraries
/doc Documentation (doxysource and pre-compiled docs)
/include Public header C and C++ header files
/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 (old assimp viewer, command line `assimp`)
/samples A small number of samples to illustrate possible
use cases for Assimp
/workspaces Build environments for vc,xcode,... (deprecated,
CMake has superseeded all legacy build options!)
Where to get help
For more information, visit our website. 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. If you think you found a bug, please open an issue on Github.
For development discussions, there is also a (very low-volume) mailing list, assimp-discussions (subscribe here)
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 a Gitter-channel:Gitter
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
You can get a patron of Asset-Importer-Lib: Become a Patron!
License
Our license is based on the modified, 3-clause BSD-License.
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.
Why this name
Sorry, we're germans :-), no english native speakers ...