updated comment for osx compiling
[blender.git] / README
1 Welcome to the fun world of open-source.
2
3 This file is to help you get started using the source and will hopefully
4 answer most questions.  If you do have any problems with these instructions,
5 post a message to the Forums on www.blender.org, or visit us at #blendersauce
6 on irc.freenode.net
7
8 Here are some links to external packages you may or may not need:
9
10 openssl:     http://www.openssl.org
11 python:      http://www.python.org
12 mxtexttools: http://www.egenix.com/files/python/mxTextTools.html (python lib)
13 libjpeg:     http://www.ijg.org/
14 libpng:      http://www.libpng.org/pub/png/
15 zlib:        http://www.gzip.org/zlib/
16 ode:         http://opende.sourceforge.net/
17 openal:      http://www.openal.org/home/                (for linux/windows)
18     sdl:     http://www.libsdl.org/index.php (for openal)
19     smpeg:   http://www.lokigames.com/development/smpeg.php3 (for openal)
20 fmod: http://www.fmod.org/
21
22 mozilla: http://www.mozilla.org/
23 nspr:  ftp://ftp.mozilla.org/pub/nspr/releases
24         (side note: on debian linux you will need mozilla-dev and libnspr-dev)
25
26 glut:    http://www.opengl.org/developers/documentation/glut.html
27
28 If you do not have GL you will also need mesa:
29 mesa:    http://www.mesa3d.org
30
31 For the translations to other languages than English you will need gettext,
32 freetype2 and FTGL. Note that these translations are not complete yet, some
33 time after the release of 2.27 they will be made available for download also.
34 We welcome feedback about the translated user interface, and even contributions
35 to the translation effort :)
36
37 gettext:     http://www.gnu.org/software/gettext/
38 freetype2:   http://www.freetype.org/
39 FTGL:        http://homepages.paradise.net.nz/henryj/code/#FTGL
40
41 FTGL needs a small patch to get glyphs with the right colour in the cache
42 --- FTGL/src/FTPixmapGlyph.cpp.orig     2003-05-10 16:07:45.000000000 +0200
43 +++ FTGL/src/FTPixmapGlyph.cpp  2003-05-10 16:09:19.000000000 +0200
44 @@ -33,3 +33,3 @@
45          // Get the current glColor.
46          float ftglColour[4];
47 -        glGetFloatv( GL_CURRENT_COLOR, ftglColour);
48 +        ftglColour[0] = ftglColour[1] = ftglColour[2] = ftglColour[3] = 1.0;
49
50
51 You may also need to modify the typedef for GLUTesselatorFunction in 
52 src/FTVectoriser.cpp if your on an undefined system.  To do that
53 check the following link to find out various platform identifiers.
54 http://www.blender.org/modules/documentation/intranet/conventions/codingstyleguide.html#3_2
55
56 *********************************************************************
57 *********************************************************************
58 We are in the process of moving things over to automake/autoconf
59 The old makefiles are still in place and will work.  
60 If you want to get a working blender skip down to the next section 
61 and use this readme as a guide.
62
63 If you want to play with the new autoconf environment take a look at 
64 doc/autoconfig.txt
65
66 *********************************************************************
67 *********************************************************************
68
69 --Notes on compiling mxTextTools----------------------------------------------
70 To get the latest version to compile on my machine I had to
71 edit mxSetup.py and remove /usr/include from INCLPATH for it to build
72 properly.
73 (after doing this you need to edit blender/source/Makefile and
74 fix the pointer to it I'm still working on automating this)
75
76 --------------Basic Makefile TIPS---------------------------------------
77 Edit source/nan_definitions.mk to fit your environment, be sure to edit the
78 block matching your OS. You will want to change variables like NAN_OPENSSL,
79 NAN_JPEG, NAN_PNG etc. to point to where you have those installed.
80
81 If you want to integrate the game-engine in Blender, you might want
82 to uncomment the following line in nan_compile.mk:
83 #CFLAGS += -DGAMEBLENDER=1
84 The define is disabled by default because there are still some
85 problems with this at the moment.
86
87 After adjusting things for your environment run 'make' (or use the nice hmake
88 script at blender/source/tools/hmake/hmake)
89
90 ----------------------WINDOWS TIPS--------------------------------------
91
92 When building Blender on Windows you have three choices:
93 METHOD 1. Build using the old NaN Makefiles.
94 METHOD 2. Build using the new automake/autoconf files
95 METHOD 3. Use Microsoft Visual Studio project files
96
97 These directions are for method 3. Method 1 was used in Nan in combination 
98 with Cygwin. I don't know if somebody ever tried method 2.
99
100 EXTERNAL LIBARIES
101 All external libraries that Blender depends on are found in CVS in 
102 precompiled form. If you did not already do so, check out 
103 blender/lib/windows from CVS. If you prefer to build or download those 
104 libraries yourself, there are some directions below.
105
106 INTERN LIBRARIES:
107 The first thing you need to do is to build the Blender "intern" libraries.
108 You need to have Python installed on your machine.
109
110 Open the workspace in the $NANBLENDERHOME/intern/make/msvc_6_0 directory.
111 Build the "build_install_all" project. This will build all the intern libraries
112 and installs them in the $NANBLENDERHOME/lib/windows directory.
113
114 If the post build step (copying the libraries to their destinations) fails,
115 this is probably due to the fact that MSVC can't find the XCOPY command as 
116 happened to me on an XP system. MSVC has it's own PATH that you can set through
117 the options. Open options from the menu: Tools->Options. Go to the directories
118 tab and select "Executable files" from the drop down menu. Now add you SYSTEM32
119 directory.
120
121 The last project build is the python_freeze project that will freeze python code
122 for compilation and linking with Blender's C code. At the moment, this should be
123 automatic except that batch file probably does not find Python. If this is the
124 case, follow the same procedure as was mentioned above for the XCOPY command
125 to add Python to your path.
126
127 BUILDING BLENDER
128
129 Open the workspace $NANBLENDERHOME/projectfiles/blender/blender.dsw
130
131 This contains the following three main projects:
132 blender           Builds the main executable
133 GP_ghost          Builds the stand-alone game player
134 GP_axctl          Builds the ActiveX control
135
136 Choose the project you want to build and hit F7. If all is well it should build
137 with a lot of warnings but no errors.
138
139 BUILDING/DOWNLOADING EXTERNAL LIBRARIES
140 If you don't want to use the precompiled libraries you can download and/or
141 build them yourself. Here are some directions.
142
143 JPEG:
144 BINARY LIBRARY:
145 Go to sourceforge.net, navigate to the GnuWin32 project and download 
146 libjpeg-6b-lib.zip. Rename the unzipped directory "jpeg" and copy it to the 
147 $NANBLENDERHOME/lib/windows directory.
148 FROM SOURCES:
149 Download the jpeg sources from http://www.ijg.org/. Go into the source 
150 directory and copy the file jconfig.vc to jconfig.h. Now start a command box
151 and run nmake /f makefile.vc (assuming nmake is in your path, if not run the
152 vcvars32.bat batch file located in the VC98/Bin directory of the MSVC 
153 installation directory first).
154 Copy these include files: jconfig.h, jerror.h, jmorecfg.h, jpeglib.h
155 from the build directory to the lib tree in this directory:
156 $NANBLENDERHOME/lib/windows/jpeg/include
157 The file libjpeg.lib should be copied to:
158 $NANBLENDERHOME/lib/windows/jpeg/lib
159
160 PNG:
161 Go to sourceforge.net, navigate to the GnuWin32 project and download 
162 libpng-1.2.4-1-lib.zip. Rename the unzipped directory "png" and copy it to the 
163 $NANBLENDERHOME/lib/windows directory.
164
165 ZLIB:
166 Go to sourceforge.net, navigate to the GnuWin32 project and download 
167 zlib-1.1.4-lib.zip. Rename the unzipped directory "zlib" and copy it to the 
168 $NANBLENDERHOME/lib/windows directory.
169
170
171 ----------------------Mac OSX TIPS--------------------------------------
172 When building Blender on OSX you have three choices:
173 METHOD 1. Build using the old NaN Makefiles.
174 METHOD 2. Build using the new automake/autoconf files
175 METHOD 3. Use the Project Builder project
176
177 METHOD 1 and 3
178 The first 4 steps are th same for methods 1 and 3. Only the actual Blender 
179 build step number 5 is different.
180
181 Step1:
182 If you want to follow method 1 and 3, follow the instructions above to set the
183 environment variables. You don't need to edit the Makefiles. They should work
184 out of the box in combinations with some external libraries that should be on
185 your system in a fixed location. 
186
187 Step 2:
188 You can use the package installer fink (http://fink.sourceforge.net/) for some
189 of the external libraries:
190 1. openssl (fink install openssl)
191 2. openssl-dev (fink install openssl-dev)
192 3. jpeg    (fink install libjpeg)
193 4. png     (fink install libpng3)
194 5. cvs     (fixes some bugs in the shipped cvs: fink install cvs)
195 6. python22 ((addes the static lib for python) fink install python22)
196         You will probably want to select python-nox when
197         it asks you.
198 7. freetype (fink install freetype2)
199
200 After you have done this you should install the mx lib from:
201 http://www.egenix.com/files/python/mxTextTools.html
202
203 (we are currently in the process removing openssl and mxTextTools from Blender)
204
205 Step 3:
206 The rest of the external libraries are present in CVS in binary format so you
207 don't have to download them. Precompiled libraries are found in CVS in 
208 directory:
209 $NANBLENDERHOME/lib/darwin-6.1-powerpc
210 If you are not running on a darwing kernel 6.1 (which is likely if you auto-
211 update your system, you might want to add a symbolic link in the 
212 $NANBLENDERHOME/lib/ directory. For example, if you work on a 6.2 kernel:
213 ln -s darwin-6.1-powerpc darwin-6.2-powerpc
214
215 Step 4: 
216 Start the build process by building Blender's "intern" libraries. Navigate to 
217 $NANBLENDERHOME/intern and type make. This will build the intern libaries which
218 will be installed into the $NANBLENDERHOME/lib/darwin-6.1-powerpc (thanks to 
219 the symbolic link).
220 Now you can choose how to build Blender itself; using the Makefiles or the 
221 Project Builder project.
222
223 Step 5 METHOD 1:
224 Navigate to $NANBLENDERHOME/source and type make. 
225
226 Step 5 METHOD 3:
227 The project Builder project can be found in the directory:
228 $NANBLENDERHOME/projectfiles/pb_2_0_1
229 Start Project Builder open the blender.pbproj project, choose a target (blender
230 or player) and build.
231
232 Step 6:
233 Although the Makefiles in the intern directory run ranlib on the libraries 
234 built, the gcc linker complains about ranlib not being run. Until there is a
235 solution, you will need to run ranlib by hand once in a while when the make 
236 breaks. Luckily, the error message lists the full path of the file to run 
237 ranlib on... Anybody out there with a real solution? I guess the problem arises
238 from copying the files from one location to the other...
239
240
241 BUILDING EXTERNAL LIBRARIES
242 If you don't want to use the precompiled libraries you can download and/or
243 build them yourself. Here are some directions.
244
245 PYTHON:
246 Mac OSX 10.2 (Jaguar) now comes with Python (2.2.1) pre-installed. This is fine
247 for producing the "frozen" Python code found in the intern directory. However,
248 the installation does not contain the python library to link against (at least
249 I could not find it). You could use fink to install Python but that Python 
250 installation depends on X being installed and that is a large installation.
251
252 If you prefer the easy way: download Python 2.2.2 from http://www.python.org.
253 Follow the instructions to in the documentation to install it on your box. If
254 you run OSX 10.2 it should install just fine. Basically a configure and a 
255 "make" will do the job. The result is a Python library that should be copied to
256 the library tree together with the associated header files.
257
258 Create the following  directories:
259 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/include/python2.2
260 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/lib/python2.2/config
261 Now copy the include files and the libpython2.2.a library to those locations.
262
263 ODE:
264 Ode is currently included in the source tree of Blender. This might change in
265 the close future. But for now you don't need to download Ode.
266 If you want to build ODE yourself, you'll have to edit a config file of ODE first.
267 go to $NANBLENDERHOME/extern/ode/dist/config and edit the file "user-settings" so 
268 that platform is equal to osx (PLATFORM=osx).
269
270 QUICKTIME:
271 In order to compile Blender with QuickTime support enabled, you need to have the 
272 QuickTime 6 SDK installed (see http://developer.apple.com/quicktime/). This extra
273 step is only necessary if you're using a version of MacOS X prior to 10.2.
274 When using the new automake system, QuickTime support can be enabled by passing
275 the "--enable-quicktime=yes" flag to ./configure. When building with the original 
276 NaN Makefiles, QuickTime support is enabled automatically.