|
1 | | - |
2 | | -======================================================================== |
3 | | -Open Asset Import Library (assimp) README |
4 | | -======================================================================== |
5 | | - |
6 | | - |
7 | | -Table of Contents |
8 | | - |
9 | | - 1. Overview |
10 | | - 1.1 Supported file formats |
11 | | - 1.2 File structure |
12 | | - 2. Build the library |
13 | | - 3. Where to get help |
14 | | - 4. License |
15 | | - |
16 | | - |
17 | | ------------------------------- |
18 | | -1. Overview |
19 | | ------------------------------- |
20 | | - |
21 | | -Open Asset Import Library is a Open Source library designed to load various 3d |
22 | | -file formats and convert them into a shared, in-memory format. It supports more |
23 | | -than 30 file formats (basically, it is like DevIL for 3D models). It also |
24 | | -supports exporting, but the number of export formats is lower. |
25 | | - |
26 | | -Its short name is 'assimp', which is an unintended joke (the abbreviation is |
27 | | -derived from 'Asset Importer'). |
28 | | - |
29 | | -Note: this README refers to the file structure used by release packages, which |
30 | | -differs in some points from the development trunk. |
31 | | - |
32 | | ----------------- |
33 | | - 1.1 Supported file formats |
34 | | ----------------- |
35 | | - |
36 | | -The library provides importers for a lot of file formats, including: |
37 | | - - 3DS |
38 | | - - BLEND |
39 | | - - DAE (Collada) |
40 | | - - IFC-STEP |
41 | | - - ASE |
42 | | - - DXF |
43 | | - - HMP |
44 | | - - MD2 |
45 | | - - MD3 |
46 | | - - MD5 |
47 | | - - MDC |
48 | | - - MDL |
49 | | - - NFF |
50 | | - - PLY |
51 | | - - STL |
52 | | - - X |
53 | | - - OBJ |
54 | | - - SMD |
55 | | - - LWO |
56 | | - - LXO |
57 | | - - LWS |
58 | | - - XML |
59 | | - - TER |
60 | | - - AC3D |
61 | | - - MS3D |
62 | | - |
63 | | -Exporters include: |
64 | | - - DAE (Collada) |
65 | | - - STL |
66 | | - - OBJ |
67 | | - |
68 | | - .. See http://assimp.sourceforge.net/main_features_formats.html for |
69 | | - a more exhaustive list. |
70 | | - |
71 | | - |
72 | | ----------------- |
73 | | -1.2 Repository structure |
74 | | ----------------- |
75 | | - |
76 | | -Open Asset Import Library is implemented in C++ (but provides both a C and a |
77 | | -C++ish interface). The directory structure is: |
78 | | - |
79 | | - /bin Folder for binaries, only used on Windows |
80 | | - /code Source code |
81 | | - /contrib Third-party libraries |
82 | | - /doc Documentation (doxysource and pre-compiled docs) |
83 | | - /include Public header C and C++ header files. |
84 | | - /lib Static library location for Windows. |
85 | | - /obj Object file location for Windows. |
86 | | - /port Ports to other languages and scripts to maintain those. |
87 | | - /test Unit- and regression tests, test suite of models. |
88 | | - /tools Tools (viewer, command line `assimp`). |
89 | | - /samples A small number of samples to illustrate possible |
90 | | - use cases for Assimp. |
91 | | - /workspaces Build enviroments for vc,xcode,... (deprecated, |
92 | | - CMake has superseeded all legacy build options!) |
93 | | - |
94 | | - |
95 | | ------------------------------- |
96 | | -2. Build the library |
97 | | ------------------------------- |
98 | | - |
99 | | -Take a look into the INSTALL file. |
100 | | - |
101 | | - |
102 | | ------------------------------- |
103 | | -3. Where to get help |
104 | | ------------------------------- |
105 | | - |
106 | | -For more information, visit http://assimp.sourceforge.net/. Or have a look into |
107 | | -the ./doc- folder, which contains the official documentation in HTML format. |
108 | | -(CHMs for Windows are included in some release packages and should be located |
109 | | -right here in the root folder). |
110 | | - |
111 | | -If the documentation doesn't solve your problems, try our forums at SF.net |
112 | | -> Open Discussion: http://sourceforge.net/projects/assimp/forums/forum/817653) |
113 | | -> General Help: http://sourceforge.net/projects/assimp/forums/forum/817654 |
114 | | - |
115 | | -For development stuff, there is also a mailing list, assimp-discussions |
116 | | - subscribe: https://lists.sourceforge.net/lists/listinfo/assimp-discussions |
117 | | - |
118 | | - |
119 | | ------------------------------- |
120 | | -4. License |
121 | | ------------------------------- |
122 | | - |
123 | | -The license of the Asset Import Library is based on the modified, 3-clause BSD- |
124 | | -License, which is a very liberal license. An _informal_ summary is: do whatever |
125 | | -you want, but include Assimp's license text with your product - and don't sue |
126 | | -us if our code doesn't work. |
127 | | - |
128 | | -Note that, unlike LGPLed code, you may link statically to Assimp. |
129 | | -For the formal details, see the LICENSE file. |
130 | | - |
| 1 | +See Readme.md |
0 commit comments