The official Open-Asset-Importer-Library Repository. Loads 40+ 3D-file-formats into one unified and clean data structure.
 
 
 
 
 
 
Go to file
kimmi 007dae433f Update : Boost lookup uses now additional versions ( thanks to Jonathan from zfx ).
git-svn-id: https://assimp.svn.sourceforge.net/svnroot/assimp/trunk@1123 67173fc5-114c-0410-ac8e-9d2fd5bffc1f
2012-01-25 18:33:46 +00:00
cmake-modules - update cmake build environment, now includes targets to build debian packages for Assimp. 2011-05-09 19:34:21 +00:00
code # Ifc: re-introduce the previous triangulation code algorithm, but use Clipper to clip to the outer contour line and poly2tri as fallback. 2012-01-17 17:40:15 +00:00
contrib # poly2tri: add missing <stdexcept> 2012-01-17 01:37:46 +00:00
doc - doc: clarify wording in bone section. 2011-12-18 20:54:50 +00:00
include - Redesign the C interface to allow per-import settings. 2012-01-13 14:07:58 +00:00
packaging # fix critical bug in the zip release script that caused the lib files in the debug folders to be the release versions. This bug affects the last release and possibly 1.1 as well. 2010-12-18 20:08:16 +00:00
port merge git://github.com/gellule/assimp.git 2012-01-11 00:27:49 +00:00
samples - update cmake build environment, now includes targets to build debian packages for Assimp. 2011-05-09 19:34:21 +00:00
scripts [3393728] [PATCH 1/2] ommit->omit and splitted->split 2011-08-20 22:00:33 +00:00
test # fix unit tests, although static linkage to Assimp is a requirement or symbols will be missing. This involves declaring some members of certain pp step classes public to give the tests access to them. Those are harmless and completely safe to use from outside, though. 2011-11-29 13:53:24 +00:00
tools - Redesign the C interface to allow per-import settings. 2012-01-13 14:07:58 +00:00
workspaces # fix vc9 pch settings 2012-01-17 02:06:12 +00:00
CHANGES - update docs. 2010-11-21 15:15:19 +00:00
CMakeLists.txt Update : Boost lookup uses now additional versions ( thanks to Jonathan from zfx ). 2012-01-25 18:33:46 +00:00
CREDITS - add gellule to CREDITS. 2011-12-12 12:29:50 +00:00
INSTALL - update README and INSTALL, slight doc fixes. 2011-07-17 21:25:23 +00:00
LICENSE Move test models with problematic license restrictions to test/models-nonbsd and update the test suites accordingly. 2010-10-13 17:57:06 +00:00
ProjectHome.url + add .URL website shortcuts to root folder 2011-05-02 17:38:59 +00:00
README - update README. 2012-01-13 17:49:18 +00:00
Website.url + add .URL website shortcuts to root folder 2011-05-02 17:38:59 +00:00
assimp.pc.in - update cmake build environment, now includes targets to build debian packages for Assimp. 2011-05-09 19:34:21 +00:00
revision.h - update revision number in header 2011-07-16 21:16:25 +00:00

README

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.


========================================================================
Open Asset Import Library (assimp) README
========================================================================


Table of Contents

	1.		Overview
	 1.1		Supported file formats
	 1.2		File structure
	2.		Build the library
	3. 		Where to get help
	4.		License


------------------------------
1.	Overview
------------------------------

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 (basically, it is like DevIL for 3D models). It also 
supports exporting, but the number of export formats is lower.

Its short name is 'assimp', which is an unintended joke (the abbreviation is
derived from 'Asset Importer'). 

Note: this README refers to the file structure used by release packages, which
differs in some points from the development trunk.

----------------
 1.1	Supported file formats
----------------

The library provides importers for a lot of file formats, including:
	- 3DS
	- BLEND 
	- DAE (Collada)
	- IFC-STEP 
	- ASE
	- DXF
	- HMP
	- MD2
 	- MD3 
	- MD5
	- MDC
	- MDL
	- NFF
 	- PLY
	- STL
	- X 
	- OBJ 
	- SMD
	- LWO 
        - LXO 
        - LWS 
	- XML 
        - TER 
        - AC3D 
        - MS3D 

Exporters include:
        - DAE (Collada)
        - STL
        - OBJ
	
 .. See http://assimp.sourceforge.net/main_features_formats.html for
 a more exhaustive list.


----------------
1.2 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)
	/include	Public header C and C++ header files.
	/lib		Static library location for Windows.
	/obj		Object file location for Windows.
	/port		Ports to other languages and scripts to maintain those. 
	/test		Unit- and regression tests, test suite of models.
	/tools		Tools (viewer, command line `assimp`).
	/samples	A small number of samples to illustrate possible 
                        use cases for Assimp.
	/workspaces	Build enviroments for vc,xcode,... (deprecated,
			CMake has superseeded all legacy build options!)


------------------------------
2. Build the library
------------------------------

Take a look into the INSTALL file.


------------------------------
3. Where to get help
------------------------------

For more information, visit http://assimp.sourceforge.net/. Or have a look into
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 documentation doesn't solve your problems, try our forums at SF.net 
> Open Discussion: http://sourceforge.net/projects/assimp/forums/forum/817653) 
> General Help: http://sourceforge.net/projects/assimp/forums/forum/817654

For development stuff, there is also a mailing list, assimp-discussions 
  subscribe: https://lists.sourceforge.net/lists/listinfo/assimp-discussions 


------------------------------
4. License
------------------------------

The license of the Asset Import Library is based on the modified, 3-clause BSD-
License, which is a very liberal 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 formal details, see the LICENSE file.