assimp/Readme.md

125 lines
4.3 KiB
Markdown
Raw Normal View History

2013-01-19 16:07:23 +00:00
Open Asset Import Library (assimp)
========
2014-05-22 15:49:02 +00:00
Open Asset Import Library is a Open Source library designed to load various __3d file formats and convert them into a shared, in-memory format__. It supports more than __30 file formats__ for import and a growing selection of file formats for export. Additionally, assimp features various __post processing tools__ to refine the imported data: _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.
2013-04-08 16:49:19 +00:00
This is the development trunk of assimp containing the latest features and bugfixes. For productive use though, we recommend one of the stable releases available from [assimp.sf.net](http://assimp.sf.net) or from *nix package repositories. According to [Travis-CI] (https://travis-ci.org/), the current build status of the trunk is [![Build Status](https://travis-ci.org/assimp/assimp.png)](https://travis-ci.org/assimp/assimp)
2014-06-19 19:09:38 +00:00
[open3mod](https://github.com/acgessler/open3mod) is an Open Source 3D model viewer based off Assimp's import and export abilities.
2013-10-16 19:43:54 +00:00
#### Supported file formats ####
The library provides importers for a lot of file formats, including:
- 3DS
2013-01-20 01:50:51 +00:00
- BLEND (Blender 3D)
2013-10-09 00:46:40 +00:00
- DAE/Collada
2013-01-20 01:50:51 +00:00
- FBX
- IFC-STEP
- ASE
- DXF
- HMP
- MD2
- MD3
- MD5
- MDC
- MDL
- NFF
- PLY
- STL
- X
- OBJ
- SMD
- LWO
- LXO
2013-01-20 21:52:17 +00:00
- LWS
- TER
- AC3D
- MS3D
2013-01-20 21:52:17 +00:00
- COB
- Q3BSP
- XGL
- CSM
- BVH
- B3D
- NDO
2014-05-22 16:00:02 +00:00
- Ogre Binary
2013-01-20 21:52:17 +00:00
- Ogre XML
- Q3D
Additionally, the following formats are also supported, but not part of the core library as they depend on proprietary libraries.
- C4D (https://github.com/acgessler/assimp-cinema4d)
Exporters include:
- DAE (Collada)
- STL
- OBJ
2013-01-20 21:52:17 +00:00
- PLY
2014-07-24 01:02:43 +00:00
- X
- 3DS
2014-05-22 15:49:02 +00:00
- JSON (for WebGl, via https://github.com/acgessler/assimp2json)
See [the full list here](http://assimp.sourceforge.net/main_features_formats.html).
2013-10-09 00:46:40 +00:00
#### Repository structure ####
Open Asset Import Library is implemented in C++ (but provides both a C and a
C++ish interface). The directory structure is:
/bin Folder for binaries, only used on Windows
/code Source code
/contrib Third-party libraries
/doc Documentation (doxysource and pre-compiled docs)
2013-10-09 00:46:40 +00:00
/include Public header C and C++ header files
/lib Static library location for Windows
/obj Object file location for Windows
/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
2014-06-19 19:09:38 +00:00
/tools Tools (old assimp viewer, command line `assimp`)
/samples A small number of samples to illustrate possible
2013-10-09 00:46:40 +00:00
use cases for Assimp
/workspaces Build enviroments for vc,xcode,... (deprecated,
CMake has superseeded all legacy build options!)
2013-10-09 00:46:40 +00:00
### Building ###
2013-12-05 21:53:14 +00:00
Take a look into the `INSTALL` file. Our build system is CMake, if you already used CMake before there is a good chance you know what to do.
2013-10-09 00:46:40 +00:00
### Where to get help ###
For more information, visit [our website](http://assimp.sourceforge.net/). 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).
2013-10-09 00:46:40 +00:00
If the documentation doesn't solve your problems,
[try our forums at SF.net](http://sourceforge.net/p/assimp/discussion/817654) or ask on
[StackOverflow](http://stackoverflow.com/questions/tagged/assimp?sort=newest).
2013-10-09 00:46:40 +00:00
For development discussions, there is also a mailing list, _assimp-discussions_
[(subscribe here)]( https://lists.sourceforge.net/lists/listinfo/assimp-discussions)
2013-10-09 00:46:40 +00:00
### 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.
2013-10-09 00:46:40 +00:00
### License ###
2013-10-09 00:46:40 +00:00
Our license is based on the modified, __3-clause BSD__-License, which is very liberal.
2013-10-09 00:46:40 +00:00
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.