Readme.md

Open Asset Import Library (assimp)

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

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.

Project activity

Documentation

Read our latest documentation.

Pre-built binaries

Download binaries from our Itchi Projectspace.

Test data

Clone our model database.

Communities

• Ask questions at the Assimp Discussion Board.
• Find us on https://discord.gg/s9KJfaem
• Ask the Assimp community on Reddit.
• Ask on StackOverflow with the assimp-tag.
• Nothing has worked? File a question or an issue report at The Assimp-Issue Tracker

Supported file formats

See the complete list of supported formats.

Building

Start by reading our build instructions. 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
• Python
• .NET
• Pascal
• Javascript (Alpha)
• Javascript/Node.js Interface
• Unity 3d Plugin
• Unreal Engine Plugin
• JVM Full JVM port (current status)
• HAXE-Port The Assimp-HAXE-port.
• Rust

Other tools

open3mod is a powerful 3D model viewer based on Assimp's import and export abilities. Assimp-Viewer is an experimental implementation for an Asset-Viewer based on ImGUI and Assimp (experimental).

Repository structure

Open Asset Import Library is implemented in C++. The directory structure looks like this:

/code		Source code
/contrib	Third-party libraries
/doc		Documentation (Doxygen source and pre-compiled docs)
/fuzz           Contains the test code for the Google Fuzzer project
/include	Public header C and C++ header files
/scripts 	Scripts are 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/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
code/PostProcessing		The post-processing steps
code/AssetLib/<FormatName>	Implementation for import and export of the format

Contributing

I would greatly appreciate contributing to assimp. The easiest way to get involved is to submit 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].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

You can support the project with your organization. Your logo will show up here with a link to your website. [Contribute]

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.