2022-04-26 11:56:24 -05:00
Open Asset Import Library (assimp)
==================================
2024-12-09 20:22:47 +00:00
Open Asset Import Library is a library that loads 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.
### Current project status ###
2022-04-26 11:56:24 -05:00
[](https://www.codacy.com/gh/assimp/assimp/dashboard?utm_source=github.com& utm_medium=referral& utm_content=assimp/assimp& utm_campaign=Badge_Grade)
2024-12-09 20:22:47 +00:00
[](https://sonarcloud.io/summary/new_code?id=assimp_assimp)
2022-04-26 11:56:24 -05:00
[](http://isitmaintained.com/project/assimp/assimp "Average time to resolve an issue")
2022-10-02 19:02:49 +01:00
[](http://isitmaintained.com/project/assimp/assimp "Percentage of issues still open")
2024-12-09 20:22:47 +00:00
[](https://gurubase.io/g/assimp)
[](https://opencollective.com/assimp)
2022-04-26 11:56:24 -05:00
< br >
2024-12-09 20:22:47 +00:00
APIs are provided for C and C++. Various bindings exist 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.
2022-04-26 11:56:24 -05:00
2024-12-09 20:22:47 +00:00
## Project activity ##
2022-04-26 11:56:24 -05:00
2024-12-09 20:22:47 +00:00
### Documentation ###
Read [our latest documentation ](https://assimp-docs.readthedocs.io/en/latest/ ).
### Pre-built binaries ###
Download binaries from [our Itchi Projectspace ](https://kimkulling.itch.io/the-asset-importer-lib ).
2022-04-26 11:56:24 -05:00
2024-12-09 20:22:47 +00:00
### Test data ###
Clone [our model database ](https://github.com/assimp/assimp-mdb ).
### Communities ###
- Ask questions at [the Assimp Discussion Board ](https://github.com/assimp/assimp/discussions ).
- Find us on [https://discord.gg/s9KJfaem ](https://discord.gg/kKazXMXDy2 )
- Ask [the Assimp community on Reddit ](https://www.reddit.com/r/Assimp/ ).
- Ask on [StackOverflow with the assimp-tag ](http://stackoverflow.com/questions/tagged/assimp?sort=newest ).
- Nothing has worked? File a question or an issue report at [The Assimp-Issue Tracker ](https://github.com/assimp/assimp/issues )
2022-04-26 11:56:24 -05:00
#### Supported file formats ####
2024-12-09 20:22:47 +00:00
See [the complete list of supported formats ](https://github.com/assimp/assimp/blob/master/doc/Fileformats.md ).
2022-04-26 11:56:24 -05:00
### Building ###
2024-12-09 20:22:47 +00:00
Start by reading [our build instructions ](https://github.com/assimp/assimp/blob/master/Build.md ). 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.
2022-04-26 11:56:24 -05:00
### Ports ###
* [Android ](port/AndroidJNI/README.md )
* [Python ](port/PyAssimp/README.md )
* [.NET ](https://bitbucket.org/Starnick/assimpnet/src/master/ )
* [Pascal ](port/AssimpPascal/Readme.md )
* [Javascript (Alpha) ](https://github.com/makc/assimp2json )
* [Javascript/Node.js Interface ](https://github.com/kovacsv/assimpjs )
* [Unity 3d Plugin ](https://ricardoreis.net/trilib-2/ )
* [Unreal Engine Plugin ](https://github.com/irajsb/UE4_Assimp/ )
2024-12-09 20:22:47 +00:00
* [JVM ](https://github.com/kotlin-graphics/assimp ) Full JVM port (current [status ](https://github.com/kotlin-graphics/assimp/wiki/Status ))
2022-04-26 11:56:24 -05:00
* [HAXE-Port ](https://github.com/longde123/assimp-haxe ) The Assimp-HAXE-port.
* [Rust ](https://github.com/jkvargas/russimp )
### Other tools ###
[open3mod ](https://github.com/acgessler/open3mod ) is a powerful 3D model viewer based on Assimp's import and export abilities.
2024-12-09 20:22:47 +00:00
[Assimp-Viewer ](https://github.com/assimp/assimp_view ) is an experimental implementation for an Asset-Viewer based on ImGUI and Assimp (experimental).
2022-04-26 11:56:24 -05:00
#### Repository structure ####
2024-12-09 20:22:47 +00:00
Open Asset Import Library is implemented in C++. The directory structure looks like this:
2022-04-26 11:56:24 -05:00
/code Source code
/contrib Third-party libraries
2024-12-09 20:22:47 +00:00
/doc Documentation (Doxygen source and pre-compiled docs)
/fuzz Contains the test code for the Google Fuzzer project
2022-04-26 11:56:24 -05:00
/include Public header C and C++ header files
2024-12-09 20:22:47 +00:00
/scripts Scripts are used to generate the loading code for some formats
2022-04-26 11:56:24 -05:00
/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` )
2024-12-09 20:22:47 +00:00
/samples A small number of samples to illustrate possible use cases for Assimp
2022-04-26 11:56:24 -05:00
The source code is organized in the following way:
code/Common The base implementation for importers and the infrastructure
2024-12-09 20:22:47 +00:00
code/CApi Special implementations which are only used for the C-API
code/Geometry A collection of geometry tools
code/Material The material system
code/PBR An exporter for physical-based models
2022-04-26 11:56:24 -05:00
code/PostProcessing The post-processing steps
2024-12-09 20:22:47 +00:00
code/AssetLib/< FormatName > Implementation for import and export of the format
2022-04-26 11:56:24 -05:00
### Contributing ###
2024-12-09 20:22:47 +00:00
I would greatly appreciate contributing to assimp. The easiest way to get involved is to submit
2022-04-26 11:56:24 -05:00
a pull request with your changes against the main repository's `master` branch.
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute. [[Contribute ](CONTRIBUTING.md )].
< a href = "https://github.com/assimp/assimp/graphs/contributors" > < img src = "https://opencollective.com/assimp/contributors.svg?width=890&button=false" / > < / a >
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute ](https://opencollective.com/assimp/contribute )]
#### Individuals
< a href = "https://opencollective.com/assimp" > < img src = "https://opencollective.com/assimp/individuals.svg?width=890" > < / a >
#### Organizations
2024-12-09 20:22:47 +00:00
You can support the project with your organization. Your logo will show up here with a link to your website. [[Contribute ](https://opencollective.com/assimp/contribute )]
2022-04-26 11:56:24 -05:00
< a href = "https://opencollective.com/assimp/organization/0/website" > < img src = "https://opencollective.com/assimp/organization/0/avatar.svg" > < / a >
### 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.
