Open Asset Import Library ORG

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

!C/C++ CI      

Star History

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


Developer quickstart

bash
git clone https://github.com/assimp/assimp
cd assimp
cmake -G Ninja -DASSIMP_BUILD_TESTS=off -DASSIMP_INSTALL=off -S . -B build
cd build
ninja

Documentation

Read our latest documentation.

Pre-built binaries

Download binaries from our Itch Projectspace.

Test data

Clone our model database for testing purposes.

Communities

• Ask questions at the Assimp Discussion Board.
• Find us on discord
• 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](port/AndroidJNI/README.md)
• [Python](port/PyAssimp/README.md)
• .NET
• [Pascal](port/AssimpPascal/Readme.md)
• 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

Qt5-ModelViewer is a powerful viewer based on Qt5 and 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:

txt
code				Source code
├── AssetLib/		The asset-importer and exporter lib
├── CApi/			C-API files
├── Common/			Common code used from all modules
├── Geometry/		Geometry utilities
├── Material/		Common materials
├── Pbrt/			Physical based materials
├── PostProcessing/	Post-processing steps
├── res				Resouce files
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
├── headercheck		Implements headerchecks
├── models-nonbsd	Non-BSP licensed headers
├── models			BSP-licensed models
├── unit			Unit tests
tools				Tools (old assimp viewer, command line `assimp`)
samples				Small number of samples to illustrate possible use cases for Assimp

Contributing

We would greatly appreciate for you to contribute 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](CONTRIBUTING.md)].

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.

Collapse