README.MacOSX
author Sam Lantinga <slouken@libsdl.org>
Tue, 09 May 2006 07:26:58 +0000
changeset 1790 828a17e05192
parent 1650 ee4f2d77206f
child 1659 14717b52abc0
permissions -rw-r--r--
Date: Mon, 8 May 2006 14:19:30 -0700
From: Bob Ippolito
Subject: SDL trunk (r2346) and Mac OS X

The current state of the trunk doesn't quite compile on Mac OS X,
I've attached a series of patches that gets it to compile and kills a
few warnings.

sdl-trunk-r2346-dlcompat-warnings.diff:
The dlcompat thing is just loaded with incorrect type signatures ..
some of them have changed since 10.2 and others are just flat wrong.
This puts it in sync with the latest headers. People on 10.2 will get
the warnings instead of people with new kits.
slouken@0
     1
==============================================================================
slouken@0
     2
Using the Simple DirectMedia Layer with Mac OS X
slouken@0
     3
==============================================================================
slouken@0
     4
slouken@0
     5
These instructions are for people using Apple's Mac OS X (pronounced
slouken@0
     6
"ten").
slouken@0
     7
slouken@0
     8
From the developer's point of view, OS X is a sort of hybrid Mac and
slouken@0
     9
Unix system, and you have the option of using either traditional
slouken@1006
    10
command line tools or Apple's IDE Xcode.
slouken@0
    11
slouken@869
    12
To build SDL using the command line, use the standard configure and make
slouken@0
    13
process:
slouken@0
    14
slouken@0
    15
	./configure
slouken@0
    16
	make
slouken@869
    17
	sudo make install
slouken@0
    18
slouken@1649
    19
You can also build SDL as a Universal library (a single binary for both
slouken@1649
    20
PowerPC and Intel architectures), on Mac OS X 10.4 and newer, by using
slouken@1649
    21
the fatbuild.sh script in build-scripts:
slouken@1649
    22
	sh build-scripts/fatbuild.sh
slouken@1649
    23
	sudo build-scripts/fatbuild.sh install
slouken@0
    24
slouken@172
    25
To use the library once it's built, you essential have two possibilities:
slouken@1650
    26
use the traditional autoconf/automake/make method, or use Xcode.
slouken@172
    27
slouken@172
    28
==============================================================================
slouken@172
    29
Using the Simple DirectMedia Layer with a traditional Makefile
slouken@172
    30
==============================================================================
slouken@172
    31
slouken@221
    32
An existing autoconf/automake build system for your SDL app has good chances
slouken@1621
    33
to work almost unchanged on OS X. However, to produce a "real" Mac OS X binary
slouken@221
    34
that you can distribute to users, you need to put the generated binary into a
slouken@221
    35
so called "bundle", which basically is a fancy folder with a name like
slouken@221
    36
"MyCoolGame.app".
slouken@172
    37
slouken@221
    38
To get this build automatically, add something like the following rule to
slouken@221
    39
your Makefile.am:
slouken@172
    40
slouken@199
    41
bundle_contents = APP_NAME.app/Contents
slouken@199
    42
APP_NAME_bundle: EXE_NAME
slouken@199
    43
	mkdir -p $(bundle_contents)/MacOS
slouken@199
    44
	mkdir -p $(bundle_contents)/Resources
slouken@199
    45
	echo "APPL????" > $(bundle_contents)/PkgInfo
slouken@199
    46
	$(INSTALL_PROGRAM) $< $(bundle_contents)/MacOS/
slouken@172
    47
slouken@221
    48
You should replace EXE_NAME with the name of the executable. APP_NAME is what
slouken@221
    49
will be visible to the user in the Finder. Usually it will be the same
slouken@221
    50
as EXE_NAME but capitalized. E.g. if EXE_NAME is "testgame" then APP_NAME 
slouken@221
    51
usually is "TestGame". You might also want to use @PACKAGE@ to use the package
slouken@221
    52
name as specified in your configure.in file.
slouken@172
    53
slouken@221
    54
If your project builds more than one application, you will have to do a bit
slouken@221
    55
more.  For each of your target applications, you need a seperate rule.
slouken@172
    56
slouken@221
    57
If you want the created bundles to be installed, you may want to add this
slouken@221
    58
rule to your Makefile.am:
slouken@172
    59
slouken@199
    60
install-exec-hook: APP_NAME_bundle
slouken@199
    61
	rm -rf $(DESTDIR)$(prefix)/Applications/APP_NAME.app
slouken@199
    62
	mkdir -p $(DESTDIR)$(prefix)/Applications/
slouken@199
    63
	cp -r $< /$(DESTDIR)$(prefix)Applications/
slouken@172
    64
slouken@221
    65
This rule takes the Bundle created by the rule from step 3 and installs them
slouken@221
    66
into $(DESTDIR)$(prefix)/Applications/.
slouken@172
    67
slouken@221
    68
Again, if you want to install multiple applications, you will have to augment
slouken@221
    69
the make rule accordingly.
slouken@172
    70
slouken@0
    71
slouken@869
    72
But beware! That is only part of the story! With the above, you end up with
slouken@869
    73
a bare bone .app bundle, which is double clickable from the Finder. But
slouken@869
    74
there are some  more things you should do before shipping yor product...
slouken@869
    75
slouken@869
    76
1) The bundle right now probably is dynamically linked against SDL. That 
slouken@869
    77
   means that when you copy it to another computer, *it will not run*,
slouken@869
    78
   unless you also install SDL on that other computer. A good solution
slouken@869
    79
   for this dilemma is to static link against SDL. On OS X, you can
slouken@869
    80
   achieve that by linkinag against the libraries listed by
slouken@869
    81
     sdl-config --static-libs
slouken@869
    82
   instead of those listed by
slouken@869
    83
     sdl-config --libs
slouken@869
    84
   Depending on how exactly SDL is integrated into your build systems, the
slouken@869
    85
   way to achieve that varies, so I won't describe it here in detail
slouken@869
    86
2) Add an 'Info.plist' to your application. That is a special XML file which
slouken@869
    87
   contains some meta-information about your application (like some copyright
slouken@869
    88
   information, the version of your app, the name of an optional icon file,
slouken@869
    89
   and other things). Part of that information is displayed by the Finder
slouken@869
    90
   when you click on the .app, or if you look at the "Get Info" window.
slouken@869
    91
   More information about Info.plist files can be found on Apple's homepage.
slouken@869
    92
slouken@869
    93
slouken@869
    94
As a final remark, let me add that I use some of the techniques (and some
slouken@869
    95
variations of them) in Exult and ScummVM; both are available in source on
slouken@869
    96
the net, so feel free to take a peek at them for inspiration!
slouken@869
    97
slouken@869
    98
slouken@47
    99
==============================================================================
slouken@1006
   100
Using the Simple DirectMedia Layer with Xcode
slouken@47
   101
==============================================================================
slouken@0
   102
slouken@1006
   103
These instructions are for using Apple's Xcode IDE to build SDL applications.
slouken@0
   104
slouken@53
   105
- First steps
slouken@53
   106
slouken@1006
   107
The first thing to do is to unpack the Xcode.tar.gz archive in the
slouken@1006
   108
top level SDL directory (where the Xcode.tar.gz archive resides).
slouken@53
   109
Because Stuffit Expander will unpack the archive into a subdirectory,
slouken@53
   110
you should unpack the archive manually from the command line:
slouken@53
   111
	cd [path_to_SDL_source]
slouken@1006
   112
	tar zxf Xcode.tar.gz
slouken@1006
   113
This will create a new folder called Xcode, which you can browse
slouken@53
   114
normally from the Finder.
slouken@53
   115
slouken@47
   116
- Building the Framework
slouken@47
   117
slouken@47
   118
The SDL Library is packaged as a framework bundle, an organized
slouken@47
   119
relocatable folder heirarchy of executible code, interface headers, 
slouken@47
   120
and additional resources. For practical purposes, you can think of a 
slouken@47
   121
framework as a more user and system-friendly shared library, whose library
slouken@47
   122
file behaves more or less like a standard UNIX shared library.
slouken@47
   123
slouken@47
   124
To build the framework, simply open the framework project and build it. 
slouken@47
   125
By default, the framework bundle "SDL.framework" is installed in 
slouken@1006
   126
/Library/Frameworks. Therefore, the testers and project stationary expect
slouken@47
   127
it to be located there. However, it will function the same in any of the
slouken@47
   128
following locations:
slouken@47
   129
slouken@47
   130
    ~/Library/Frameworks
slouken@47
   131
    /Local/Library/Frameworks
slouken@47
   132
    /System/Library/Frameworks
slouken@47
   133
slouken@47
   134
- Build Options
slouken@47
   135
    There are two "Build Styles" (See the "Targets" tab) for SDL.
slouken@47
   136
    "Deployment" should be used if you aren't tweaking the SDL library.
slouken@47
   137
    "Development" should be used to debug SDL apps or the library itself.
slouken@47
   138
slouken@47
   139
- Building the Testers
slouken@47
   140
    Open the SDLTest project and build away!
slouken@47
   141
slouken@47
   142
- Using the Project Stationary
slouken@47
   143
    Copy the stationary to the indicated folders to access it from
slouken@47
   144
    the "New Project" and "Add target" menus. What could be easier?
slouken@47
   145
slouken@47
   146
- Setting up a new project by hand
slouken@47
   147
    Some of you won't want to use the Stationary so I'll give some tips:
slouken@47
   148
    * Create a new "Cocoa Application"
slouken@207
   149
    * Add src/main/macosx/SDLMain.m , .h and .nib to your project
slouken@47
   150
    * Remove "main.c" from your project
slouken@47
   151
    * Remove "MainMenu.nib" from your project
slouken@47
   152
    * Add "$(HOME)/Library/Frameworks/SDL.framework/Headers" to include path
slouken@47
   153
    * Add "$(HOME)/Library/Frameworks" to the frameworks search path
slouken@207
   154
    * Add "-framework SDL -framework Foundation -framework AppKit" to "OTHER_LDFLAGS"
slouken@207
   155
    * Set the "Main Nib File" under "Application Settings" to "SDLMain.nib"
slouken@47
   156
    * Add your files
slouken@47
   157
    * Clean and build
slouken@47
   158
slouken@47
   159
- Building from command line
slouken@47
   160
    Use pbxbuild in the same directory as your .pbproj file
slouken@47
   161
         
slouken@47
   162
- Running your app
slouken@47
   163
    You can send command line args to your app by either invoking it from
slouken@47
   164
    the command line (in *.app/Contents/MacOS) or by entering them in the
slouken@47
   165
    "Executibles" panel of the target settings.
slouken@47
   166
    
slouken@47
   167
- Implementation Notes
slouken@47
   168
    Some things that may be of interest about how it all works...
slouken@47
   169
    * Working directory
slouken@191
   170
        As defined in the SDL_main.m file, the working directory of your SDL app
slouken@47
   171
        is by default set to its parent. You may wish to change this to better
slouken@47
   172
        suit your needs.
slouken@47
   173
    * You have a Cocoa App!
slouken@47
   174
        Your SDL app is essentially a Cocoa application. When your app
slouken@47
   175
        starts up and the libraries finish loading, a Cocoa procedure is called,
slouken@47
   176
        which sets up the working directory and calls your main() method.
slouken@47
   177
        You are free to modify your Cocoa app with generally no consequence 
slouken@47
   178
        to SDL. You cannot, however, easily change the SDL window itself.
slouken@47
   179
        Functionality may be added in the future to help this.
slouken@207
   180
	
slouken@207
   181
slouken@0
   182
Known bugs are listed in the file "BUGS"