assimp README

The project's README from github.com/assimp/assimp. As one markdown file: 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

C/C++ CI Codacy Badge Quality Gate Status Average time to resolve an issue Percentage of issues still open Gurubase Financial Contributors on Open Collective

Star History

Star History Chart 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

Alt

Developer quickstart

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

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

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:

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].

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.

assimp (assimp/assimp)

Searching Database…

13.3K ·GitHub
What is this?Open Asset Import Library (assimp) - a C++ library that loads 40+ 3D file formats into one shared in-memory data structure, with post-processing tools that clean up the meshes on the way in.
Is it a library I link into my code, or a ready-made model viewer?A library, not an app: it exposes C and C++ APIs you call from your own program. The viewers you may have heard of (Qt5-ModelViewer, Assimp-Viewer) are separate projects built on top of it.
How do I get it and hook it into my project?Build it with its CMake build system or pull it in through vcpkg; pre-built binaries are also downloadable from the project's Itch page.
Can it write 3D files back out, or only read them?It reads more than 40 formats but writes only a smaller, growing selection, so saving back to the format you loaded from is not guaranteed.
Do I need to be building my own engine to get value out of it?Mostly it serves game and 3D-application developers who would otherwise hand-parse FBX, glTF or Collada themselves; Unity and Unreal plugins and standalone viewers cover people using ready-made engines.
Will it run on my phone, or is this desktop-only?The README says assimp also runs on Android and iOS, in addition to the desktop targets you build with CMake.
Can I ship it inside a closed-source commercial game?Yes. The modified 3-clause BSD license lets you do whatever you want as long as you include Assimp's license text with your product, and static linking is explicitly allowed.
I am not a C++ developer - can I still use it?Yes. Beyond the native C and C++ APIs there are bindings for C#, Java, Python, Delphi and D, plus ports and plugins: Rust, a full JVM port, Node.js (alpha), and Unity 3D and Unreal Engine plugins.
Does it just parse files, or does it fix the models up too?It ships post-processing steps: normals and tangent-space generation, triangulation, vertex cache locality optimization, removal of degenerate primitives and duplicate vertices, and merging of redundant materials.
Which 3D formats does it actually support?More than 40 for import - FBX, Collada, glTF 2, STL, 3MF and IFC among them - with a smaller, growing list of export formats.
Is there test data I can try it against?Yes, the project maintains a separate model database repository of test files you can clone to exercise the importer on real assets.
Creator
assimp
Size
271.7 MB
Stars
13.3K
Age
16y
Commits · 90 Days