- ALenum alc_error = alcGetError(); // openal_2.14+
[blender-staging.git] / readme.txt
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 nspr:  ftp://ftp.mozilla.org/pub/nspr/releases
12 libjpeg:  http://www.ijg.org/
13 libpng:  http://www.libpng.org/pub/png/
14 zlib:   http://www.gzip.org/zlib/
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 If you do not have GL you will also need mesa:
21 http://www.mesa3d.org
22
23 --Notes on compiling mxTextTools----------------------------------------------
24 To get the latest version to compile on my machine I had to
25 edit mxSetup.py and remove /usr/include from INCLPATH for it to build
26 properly.
27 (after doing this you need to edit blender/source/Makefile and
28 fix the pointer to it I'm still working on automating this)
29
30 --------------Basic Makefile TIPS---------------------------------------
31 Assuming you are using tcsh/csh do the following before compiling.
32 #Set this to wherever you have extracted the source.
33 setenv NANBLENDERHOME `pwd`
34 setenv MAKEFLAGS "-w -I$NANBLENDERHOME/source"
35
36 Or for bash/sh do this:
37 NANBLENDERHOME=`pwd`
38 export NANBLENDERHOME
39 MAKEFLAGS="-w -I$NANBLENDERHOME/source"
40 export MAKEFLAGS
41
42 Then edit source/nan_definitions.mk to fit you're environment.
43 (You'll want to change things like NAN_OPENSSL,NAN_JPEG, NAN_PNG etc.. 
44 to point to where you have it installed)
45
46 If you tried to just have a go at making stuff you might wind up with
47 an empty file /tmp/.nanguess
48 You need to remove the empty file and it will get created automatically
49 by $NANBLENDERHOME/source/tools/guess/guessconfig after you have 
50 setup the NANBLENDERHOME variable.
51
52 After that cd $NANBLENDERHOME/intern 
53 make
54 make install
55
56 cd $NANBLENDERHOME/source/ode
57 Look at the README_BLENDER and follow instructions
58
59 Then cd $NANBLENDERHOME/source
60 make
61
62 If you have any problems with the above post a message to the Forums on
63 www.blender.org
64 ----------------------WINDOWS TIPS--------------------------------------
65 If you have any problems with the above post a message to the Forums on
66 www.blender.org
67
68
69 ----------------------Mac OSX TIPS--------------------------------------
70 Now before you go to the source directory, make sure you have installed the
71 external libraries that Blender depends upon. Here is a description of the 
72 things you need.
73
74 FINK:
75 Use fink (http://fink.sourceforge.net/) to install the following libraries that
76 Blender depends on:
77 1. openssl (fink install openssl)
78 2. jpeg    (fink install jpeg)
79 3. png     (fink install png)
80
81 PYTHON:
82 Mac OSX 10.2 (Jaguar) now comes with Python (2.2.1) pre-installed. This is fine
83 for producing the "frozen" Python code found in the intern directory. However,
84 the installation does not contain the python library to link against (at least
85 I could not find it). You could use fink to install Python but that Python 
86 installation depends on X being installed and that is a large installation.
87
88 If you prefer the easy way: download Python 2.2.2 from http://www.python.org.
89 Follow the instructions to in the documentation to install it on your box. If
90 you run OSX 10.2 it should install just fine. Basically a configure and a 
91 "make" will do the job. The result is a Python library that should be copied to
92 the library tree together with the associated header files.
93
94 Create the following  directories:
95 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/include/python2.2
96 $NANBLENDERHOME/lib/darwin-6.1-powerpc/python/lib/python2.2/config
97 Now copy the include files and the libpython2.2.a library to those locations.
98
99 FMOD:
100 Download FMOD from http://www.fmod.org/ and unpack with StuffIt Expander. The
101 archive contains header files and a library. Copy those to these directories
102 (that you need to create first):
103 $NANBLENDERHOME/lib/darwin-6.1-powerpc/fmod/include
104 $NANBLENDERHOME/lib/darwin-6.1-powerpc/fmod/lib
105
106 RANLIB:
107 Although the make files run ranlib on the libraries built, the gcc linker 
108 complains about ranlib not being run. Until there is a solution, you will need
109 to run ranlib by hand once in a while when the make breaks. Luckily, the error
110 message lists the full path of the file to run ranlib on... Anybody out there 
111 with a real solution? I guess the problem arises from copying the files from 
112 one location to the other...
113
114 Now wait, don't type make yet! You'll have to edit a config file of ODE first.
115 go to $NANBLENDERHOME/source/ode/config and edit the file "user-settings" so 
116 that platform is equal to osx (PLATFORM=osx).
117
118 Success!