758116b083
This commit ignores the “contrib” folder in order to prevent merge conflicts in dependencies, should these be updated via git. |
||
|---|---|---|
| .github | ||
| cmake | ||
| cmake-modules | ||
| code | ||
| contrib | ||
| doc | ||
| fuzz | ||
| include/assimp | ||
| packaging | ||
| port | ||
| samples | ||
| scripts | ||
| test | ||
| tools | ||
| .clang-format | ||
| .coveralls.yml | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.sh | ||
| .travis.yml | ||
| BUILDBINARIES_EXAMPLE.bat | ||
| Build.md | ||
| CHANGES | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| CREDITS | ||
| CodeConventions.md | ||
| Dockerfile | ||
| INSTALL | ||
| LICENSE | ||
| README | ||
| Readme.md | ||
| assimp.pc.in | ||
| revision.h.in | ||
Readme.md
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
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. 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.
Latest Doc's
Please check the latest documents at Asset-Importer-Lib-Doc.
Get involved
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.
You find a bug in the docs? Use Doc-Repo.
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
You can find the complete list of supported file-formats here
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
- Python
- .NET
- Pascal
- Javascript (Alpha)
- Unity 3d 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.
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/AssetLib/<FormatName> Implementation for import and export for the format
Where to get help
For more information, visit our website. 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 with the assimp-tag. If you think you found a bug, please open an issue on Github.
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
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.
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
Support this 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.
Why this name
Sorry, we're germans :-), no english native speakers ...