The official Open-Asset-Importer-Library Repository. Loads 40+ 3D-file-formats into one unified and clean data structure.
 
 
 
 
 
 
Go to file
aramis_acg 5f341dcf00 - update README and INSTALL, slight doc fixes.
git-svn-id: https://assimp.svn.sourceforge.net/svnroot/assimp/trunk@1050 67173fc5-114c-0410-ac8e-9d2fd5bffc1f
2011-07-17 21:25:23 +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 git-svn-id: https://assimp.svn.sourceforge.net/svnroot/assimp/trunk@1046 67173fc5-114c-0410-ac8e-9d2fd5bffc1f 2011-07-17 01:09:56 +00:00
contrib # when compiling with MSVC's C compiler, (void)param won't be accepted, omit it at all to avoid trouble. 2011-06-09 14:43:28 +00:00
doc - update README and INSTALL, slight doc fixes. 2011-07-17 21:25:23 +00:00
include # fix small flaw in the docs for the deboning process 2011-06-28 15:56:32 +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 - PyAssimp: move structsgen.py script away from /scripts and place it in a sub-folder of port/PyAssimp. This is consistent with the way how SWIG-dependent bindings handle such files. 2011-07-17 01:55:58 +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 - PyAssimp: move structsgen.py script away from /scripts and place it in a sub-folder of port/PyAssimp. This is consistent with the way how SWIG-dependent bindings handle such files. 2011-07-17 01:55:58 +00:00
test + add 3 test cubes to improve testing coverage of the x file format. The compressed cube is a test for the previous commit, r1012, which fixed a bug in the x loader. 2011-05-31 13:34:57 +00:00
tools merge with git://github.com/tonttu/assimp.git 2011-06-09 14:29:32 +00:00
workspaces git-svn-id: https://assimp.svn.sourceforge.net/svnroot/assimp/trunk@1046 67173fc5-114c-0410-ac8e-9d2fd5bffc1f 2011-07-17 01:09:56 +00:00
CHANGES - update docs. 2010-11-21 15:15:19 +00:00
CMakeLists.txt [3309083] Allow external unzip, and buildsys cleanup (many thanks to Rick Mattes for the patch). 2011-05-30 14:13:33 +00:00
CREDITS - update cmake build environment, now includes targets to build debian packages for Assimp. 2011-05-09 19:34:21 +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 and INSTALL, slight doc fixes. 2011-07-17 21:25:23 +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. 		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.

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


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

The library provides importers for a lot of file formats, including:
	- 3DS
	- BLEND
	- Collada
	- IFC-STEP
	- ASE
	- DXF
	- HMP
	- MD2
 	- MD3 
	- MD5
	- MDC
	- MDL
	- NFF
 	- PLY
	- STL
	- X
	- LWO
	- OBJ
	- SMD
	- LWO
	- Ogre XML
	
	
 .. plus many more, 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		Binaries, onyl used on Windows.
	/code		Source code.
	/contrib	Third-party-libraries used by the Asset Import Library.
	/doc		Documentation (doxygen generated and data structure draft)
	/include	Public headers for you to #include.
	/lib		Static library location for Windows.
	/obj		Object file location for Windows.
	/port		Ports to other languages and scripts therefor. 
	
	/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.
	/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. Help
------------------------------

For more information go to http://assimp.sourceforge.net/. Or have a look into the ./doc-
folder, which contains the Doxygen-generated documentation in HTML format (CHMs for
 Windows are also included in some distributions and should be located right here in
 the root folder).

If reading the documentation doesn't solve your problems, try our forums at SF.net 
  Open Discussion: http://sourceforge.net/projects/assimp/forums/forum/817653) 
  Help: http://sourceforge.net/projects/assimp/forums/forum/817654

or our  mailing list, assimp-discussions 
  archive: http://sourceforge.net/mailarchive/forum.php?forum_name=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 of the license is: do whatever 
you want, but include Assimp's license text with your product - and don't sue us
if it doesn't work.

For the formal details, see the LICENSE file.