190 lines
8.3 KiB
Markdown
190 lines
8.3 KiB
Markdown
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 project 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)
|
|
[](http://isitmaintained.com/project/assimp/assimp "Average time to resolve an issue")
|
|
[](https://www.codacy.com/app/kimkulling/assimp?utm_source=github.com&utm_medium=referral&utm_content=assimp/assimp&utm_campaign=Badge_Grade)
|
|
[](https://lgtm.com/projects/g/assimp/assimp/alerts/)
|
|
<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.
|
|
|
|
[Check the latest doc](https://assimp-docs.readthedocs.io/en/latest/).
|
|
|
|
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 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)
|
|
|
|
<br>
|
|
|
|
Please check our Wiki as well: https://github.com/assimp/assimp/wiki
|
|
|
|
If you want to check our Model-Database, use the following repo: https://github.com/assimp/assimp-mdb
|
|
|
|
#### Supported file formats ####
|
|
|
|
__Importers__:
|
|
|
|
- 3D
|
|
- [3DS](https://en.wikipedia.org/wiki/.3ds)
|
|
- [3MF](https://en.wikipedia.org/wiki/3D_Manufacturing_Format)
|
|
- AC
|
|
- [AC3D](https://en.wikipedia.org/wiki/AC3D)
|
|
- ACC
|
|
- AMJ
|
|
- ASE
|
|
- ASK
|
|
- B3D
|
|
- [BLEND](https://en.wikipedia.org/wiki/.blend_(file_format))
|
|
- [BVH](https://en.wikipedia.org/wiki/Biovision_Hierarchy)
|
|
- CMS
|
|
- COB
|
|
- [DAE/Collada](https://en.wikipedia.org/wiki/COLLADA)
|
|
- [DXF](https://en.wikipedia.org/wiki/AutoCAD_DXF)
|
|
- ENFF
|
|
- [FBX](https://en.wikipedia.org/wiki/FBX)
|
|
- [glTF 1.0](https://en.wikipedia.org/wiki/GlTF#glTF_1.0) + GLB
|
|
- [glTF 2.0](https://en.wikipedia.org/wiki/GlTF#glTF_2.0):
|
|
At the moment for glTF2.0 the following extensions are supported:
|
|
+ KHR_lights_punctual ( 5.0 )
|
|
+ KHR_materials_pbrSpecularGlossiness ( 5.0 )
|
|
+ KHR_materials_unlit ( 5.0 )
|
|
+ KHR_texture_transform ( 5.1 under test )
|
|
- HMB
|
|
- IFC-STEP
|
|
- IRR / IRRMESH
|
|
- [LWO](https://en.wikipedia.org/wiki/LightWave_3D)
|
|
- LWS
|
|
- LXO
|
|
- [M3D](https://bztsrc.gitlab.io/model3d)
|
|
- MD2
|
|
- MD3
|
|
- MD5
|
|
- MDC
|
|
- MDL
|
|
- MESH / MESH.XML
|
|
- MOT
|
|
- MS3D
|
|
- NDO
|
|
- NFF
|
|
- [OBJ](https://en.wikipedia.org/wiki/Wavefront_.obj_file)
|
|
- [OFF](https://en.wikipedia.org/wiki/OFF_(file_format))
|
|
- [OGEX](https://en.wikipedia.org/wiki/Open_Game_Engine_Exchange)
|
|
- [PLY](https://en.wikipedia.org/wiki/PLY_(file_format))
|
|
- PMX
|
|
- PRJ
|
|
- Q3O
|
|
- Q3S
|
|
- RAW
|
|
- SCN
|
|
- SIB
|
|
- SMD
|
|
- [STP](https://en.wikipedia.org/wiki/ISO_10303-21)
|
|
- [STL](https://en.wikipedia.org/wiki/STL_(file_format))
|
|
- TER
|
|
- UC
|
|
- VTA
|
|
- X
|
|
- [X3D](https://en.wikipedia.org/wiki/X3D)
|
|
- XGL
|
|
- ZGL
|
|
|
|
Additionally, some formats are supported by dependency on non-free code or external SDKs (not built by default):
|
|
|
|
- [C4D](https://en.wikipedia.org/wiki/Cinema_4D) (https://github.com/assimp/assimp/wiki/Cinema4D-&-Melange) IMporting geometry + node hierarchy are currently supported
|
|
|
|
__Exporters__:
|
|
|
|
- DAE (Collada)
|
|
- STL
|
|
- OBJ
|
|
- PLY
|
|
- X
|
|
- 3DS
|
|
- JSON (for WebGl, via https://github.com/acgessler/assimp2json)
|
|
- ASSBIN
|
|
- STEP
|
|
- glTF 1.0 (partial)
|
|
- glTF 2.0 (partial)
|
|
- 3MF ( experimental )
|
|
- FBX ( experimental )
|
|
|
|
### Building ###
|
|
Take a look into the https://github.com/assimp/assimp/blob/master/Build.md file. We are available in vcpkg, and 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](https://github.com/assimp/assimp-net)
|
|
* [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 (current [status](https://github.com/kotlin-graphics/assimp/wiki/Status))
|
|
* [HAXE-Port](https://github.com/longde123/assimp-haxe) The Assimp-HAXE-port.
|
|
|
|
### 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 looks like:
|
|
|
|
/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
|
|
|
|
The source code is organized in the following way:
|
|
|
|
code/Common The base implementation for importers and the infrastructure
|
|
code/PostProcessing The post-processing steps
|
|
code/<FormatName> Implementation for import and export for the format
|
|
|
|
### Where to get help ###
|
|
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.
|
|
|
|
For development discussions, there is also a (very low-volume) mailing list, _assimp-discussions_
|
|
[(subscribe here)]( https://lists.sourceforge.net/lists/listinfo/assimp-discussions)
|
|
|
|
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 [](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.
|
|
|
|
### 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 ...
|