Updated the readme section on building OSX.
[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.
5
6 Here are some links to external packages you may or maynot need:
7
8 openssl:  http://www.openssl.org
9 python:  http://www.python.org
10 mxtexttools:http://www.egenix.com/files/python/mxTextTools.html (python lib)
11 libjpeg:  http://www.ijg.org/
12 libpng:  http://www.libpng.org/pub/png/
13 zlib:   http://www.gzip.org/zlib/
14 ode:    http://q12.org/ode/ode.html
15 openal:  http://www.openal.org/home/            (for linux/windows)
16         sdl: http://www.libsdl.org/index.php (for openal)
17         smpeg: http://www.lokigames.com/development/smpeg.php3 (for openal)
18 fmod: http://www.fmod.org/
19
20 mozilla: http://www.mozilla.org/
21 nspr:  ftp://ftp.mozilla.org/pub/nspr/releases
22         (side note: on debian linux you will need mozilla-dev and libnspr-dev)
23
24 If you do not have GL you will also need mesa:
25 http://www.mesa3d.org
26
27 *********************************************************************
28 *********************************************************************
29 We are in the process of moving things over to automake/autoconf
30 The old makefiles are still in place and will work.  
31 If you want to get a working blender skip down to the next section 
32 and use this readme as a guide.
33
34 If you want to play with the new autoconf environment take a look at 
35 doc/autoconfig.txt
36
37 *********************************************************************
38 *********************************************************************
39
40 --Notes on compiling mxTextTools----------------------------------------------
41 To get the latest version to compile on my machine I had to
42 edit mxSetup.py and remove /usr/include from INCLPATH for it to build
43 properly.
44 (after doing this you need to edit blender/source/Makefile and
45 fix the pointer to it I'm still working on automating this)
46
47 --------------Basic Makefile TIPS---------------------------------------
48 Assuming you are using tcsh/csh do the following before compiling.
49 #Set this to wherever you have extracted the source.
50 setenv NANBLENDERHOME `pwd`
51 setenv MAKEFLAGS "-w -I$NANBLENDERHOME/source"
52
53 Or for bash/sh do this:
54 NANBLENDERHOME=`pwd`
55 export NANBLENDERHOME
56 MAKEFLAGS="-w -I$NANBLENDERHOME/source"
57 export MAKEFLAGS
58
59 Then edit source/nan_definitions.mk to fit you're environment.
60 (You'll want to change things like NAN_OPENSSL,NAN_JPEG, NAN_PNG etc.. 
61 to point to where you have it installed)
62
63 If you tried to just have a go at making stuff you might wind up with
64 an empty file /tmp/.nanguess
65 You need to remove the empty file and it will get created automatically
66 by $NANBLENDERHOME/source/tools/guess/guessconfig after you have 
67 setup the NANBLENDERHOME variable.
68
69 After that cd $NANBLENDERHOME/intern 
70 make
71 make install
72
73 cd $NANBLENDERHOME/source/ode
74 Look at the README_BLENDER and follow instructions
75
76 Then cd $NANBLENDERHOME/source
77 make
78
79 If you have any problems with the above post a message to the Forums on
80 www.blender.org
81 ----------------------WINDOWS TIPS--------------------------------------
82 If you have any problems with the above post a message to the Forums on
83 www.blender.org
84
85
86 ----------------------Mac OSX TIPS--------------------------------------
87 When building Blender on OSX you have three choices:
88 METHOD 1. Build using the old NaN Makefiles.
89 METHOD 2. Build using the new automake/autoconf files
90 METHOD 3. Use the Project Builder project
91
92 METHOD 1 and 3
93 The first 4 steps are th same for methods 1 and 3. Only the actual Blender 
94 build step number 5 is different.
95
96 Step1:
97 If you want to follow method 1 and 3, follow the instructions above to set the
98 environment variables. You don't need to edit the Makefiles. They should work
99 out of the box in combinations with some external libraries that should be on
100 your system in a fixed location. 
101
102 Step 2:
103 You can use the package installer fink (http://fink.sourceforge.net/) for some
104 of the external libraries:
105 1. openssl (fink install openssl)
106 2. jpeg    (fink install jpeg)
107 3. png     (fink install png)
108
109 Step 3:
110 The rest of the external libraries are present in CVS in binary format so you
111 don't have to download them. Precompiled libraries are found in CVS in 
112 directory:
113 $NANBLENDERHOME/lib/darwin-6.1-powerpc
114 If you are not running on a darwing kernel 6.1 (which is likely if you auto-
115 update your system, you might want to add a symbolic link in the 
116 $NANBLENDERHOME/lib/ directory. For example, if you work on a 6.2 kernel:
117 ln -s darwin-6.1-powerpc darwin-6.2-powerpc
118
119 Step 4: 
120 Start the build process by building Blender's "intern" libraries. Navigate to 
121 $NANBLENDERHOME/intern and type make. This will build the intern libaries which
122 will be installed into the $NANBLENDERHOME/lib/darwin-6.1-powerpc (thanks to 
123 the symbolic link).
124 Now you can choose how to build Blender itself; using the Makefiles or the 
125 Project Builder project.
126
127 Step 5 METHOD 1:
128 Navigate to $NANBLENDERHOME/source and type make. 
129
130 Step 5 METHOD 3:
131 The project Builder project can be found in the directory:
132 $NANBLENDERHOME/projectfiles/pb_2_0_1
133 Start Project Builder open the blender.pbproj project, choose a target (blender
134 or player) and build.
135
136 Step 6:
137 Although the Makefiles in the intern directory run ranlib on the libraries 
138 built, the gcc linker complains about ranlib not being run. Until there is a
139 solution, you will need to run ranlib by hand once in a while when the make 
140 breaks. Luckily, the error message lists the full path of the file to run 
141 ranlib on... Anybody out there with a real solution? I guess the problem arises
142 from copying the files from one location to the other...
143
144
145 BUILDING EXTERNAL LIBRARIES
146 If you don't want to use the precompiled libraries you can download and/or
147 build them yourself. Here are some directions.
148
149 PYHON:
150 Mac OSX 10.2 (Jaguar) now comes with Python (2.2.1) pre-installed. This is fine
151 for producing the "frozen" Python code found in the intern directory. However,
152 the installation does not contain the python library to link against (at least
153 I could not find it). You could use fink to install Python but that Python 
154 installation depends on X being installed and that is a large installation.
155
156 If you prefer the easy way: download Python 2.2.2 from http://www.python.org.
157 Follow the instructions to in the documentation to install it on your box. If
158 you run OSX 10.2 it should install just fine. Basically a configure and a 
159 "make" will do the job. The result is a Python library that should be copied to
160 the library tree together with the associated header files.
161
162 Create the following  directories:
163 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/include/python2.2
164 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/lib/python2.2/config
165 Now copy the include files and the libpython2.2.a library to those locations.
166
167 FMOD:
168 Download FMOD from http://www.fmod.org/ and unpack with StuffIt Expander. The
169 archive contains header files and a library. Copy those to these directories
170 (that you need to create first):
171 $NANBLENDERHOME/lib/darwin-6.1-powerpc/fmod/include
172 $NANBLENDERHOME/lib/darwin-6.1-powerpc/fmod/lib
173
174 ODE:
175 Ode is currently included in the source tree of Blender. This might change in
176 the close future. But for now you don't need to download Ode.
177 If you want to build ODE yourself, you'll have to edit a config file of ODE first.
178 go to $NANBLENDERHOME/source/ode/config and edit the file "user-settings" so 
179 that platform is equal to osx (PLATFORM=osx).
180
181 Success!