README
1o-----------------------------------------------------------------------------o
2| |
3| c a l 3 d |
4| |
5| Version 0.10.0 |
6| |
7| Copyright (C) 2001-2005 Cal3D Team |
8| |
9o-----------------------------------------------------------------------------o
10
11o-----------------------------------------------------------------------------o
12| Table of Contents |
13o-----------------------------------------------------------------------------o
14
15 1 License
16 2 Expectations
17 3 What is 'cal3d'?
18 4 Features
19 5 Requirements
20 6 Website
21 7 Author
22
23
24o-----------------------------------------------------------------------------o
25| 1 License |
26o-----------------------------------------------------------------------------o
27
28 This library is free software; you can redistribute it and/or modify it
29 under the terms of the GNU Lesser General Public License as published by the
30 Free Software Foundation; either version 2.1 of the License, or (at your
31 option) any later version.
32
33 This library is distributed in the hope that it will be useful, but WITHOUT
34 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
35 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
36 for more details.
37
38 You should have received a copy of the GNU Lesser General Public License
39 along with this library; if not, write to the Free Software Foundation,
40 Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
41
42
43o-----------------------------------------------------------------------------o
44| 2 Expectations |
45o-----------------------------------------------------------------------------o
46
47 The Cal3D library is licensed under the LGPL (GNU Lesser General Public
48 License) which, among other things, allows you to link proprietary
49 applications with it. The Cal3D team strongly believes in the Free Software
50 movement and provides this library without any additional restrictions.
51 However, to make this a "fair deal" and to support the future development of
52 the library, we ask you to follow these points when using the Cal3D library
53 in your projects:
54
55 - Seriously consider releasing you project under a free license yourself.
56 - Read and understand the LGPL and make sure that your usage of Cal3D
57 complies with it.
58 - Include a prominent mention about the usage of the Cal3D library in
59 your project.
60 - Send a short message to us when you release your work.
61 - Provide feedback to the Cal3D project to help us enhance it.
62 - If you make millions with your project, donate some bucks to the Cal3D
63 project to fund the future development =)
64
65 Furthermore, here are a few other possibilities to help the Cal3D project:
66
67 - The Cal3D is always in need of models, animations, textures and demos.
68 So, if you have something to spare, send it along!
69 - Sponsoring and donations can definitively help the project, just
70 contact us.
71 - Have you heard of a new animation technology? Is there a freshly
72 written, earth-shaking paper about inverse-kinematics on your desk?
73 Fell free to send it to the Cal3D project, so we can put it into the
74 library!
75
76 The Cal3D team thanks you for your support and wishes you success with all
77 your projects!
78
79
80o-----------------------------------------------------------------------------o
81| 3 What is 'cal3d'? |
82o-----------------------------------------------------------------------------o
83
84 Cal3D is a skeletal based character animation library. It is platform-
85 independent and not bound to a specific graphic API. Originally designed to
86 be used in a 3d client for the Worldforge project ( www.worldforge.org )
87 it evolved into a stand-alone product that can be used in many different
88 projects.
89
90
91o-----------------------------------------------------------------------------o
92| 4 Features |
93o-----------------------------------------------------------------------------o
94
95 - skeletal based animation setup
96 - seamless blending of multiple animation tracks
97 - attachment and detachment of one or more skinned meshes at runtime
98 - transformation of vertices and normals according to the weighted influence
99 of one or more bones
100 - flexible material handling
101 - support for multiple texture mapping channels
102 - progressive meshes for LOD (level-of-detail)
103 - binary and text file formats
104 - experimental spring-system module for cloth and hair animation
105 - unified exporter plugin framework (3D Studio Max, MilkShape 3D and others
106 following)
107 - highly portable and modular design (only depends on C++ and STL)
108 - simple and clean API (both in C++ and "pure" C)
109 - did I mention that it is free? (see the LGPL license)
110
111
112o-----------------------------------------------------------------------------o
113| 5 Requirements |
114o-----------------------------------------------------------------------------o
115
116 There are no special requirements to compile/use cal3d. A C++ compiler with
117 (decent) STL support should be enough.
118
119
120o-----------------------------------------------------------------------------o
121| 6 Website |
122o-----------------------------------------------------------------------------o
123
124 The official website of cal3d can be found at: http://gna.org/projects/cal3d/
125
126
127o-----------------------------------------------------------------------------o
128| 7 Author |
129o-----------------------------------------------------------------------------o
130
131 This project was originally started by Bruno 'Beosil' Heidelberger. You can
132 find a list of all people contributing to cal3d in the AUTHORS file.
133
134
135o-----------------------------------------------------------------------------o
136