### Home Classes Methods

### Files

- CREDITS
- LICENSE
- NEWS
- README
- ROADMAP
- custom_sdl_load_paths.rdoc
- getting_started.rdoc
- keyboard_symbols.rdoc
- macosx_install.rdoc
- managing_framerate.rdoc
- surface_palettes.rdoc
- windows_install.rdoc

### Class Index

Quicksearch

- Rubygame
- Rubygame::ActiveEvent
- Rubygame::Clock
- Rubygame::Color
- Rubygame::Color::ColorBase
- Rubygame::Color::ColorHSL
- Rubygame::Color::ColorHSV
- Rubygame::Color::ColorRGB
- Rubygame::Color::Palette
- Rubygame::Event
- Rubygame::EventActions
- Rubygame::EventActions::BlockAction
- Rubygame::EventActions::MethodAction
- Rubygame::EventActions::MultiAction
- Rubygame::EventHandler
- Rubygame::EventHandler::HasEventHandler
- Rubygame::EventHook
- Rubygame::EventQueue
- Rubygame::EventTriggers
- Rubygame::EventTriggers::AndTrigger
- Rubygame::EventTriggers::AttrTrigger
- Rubygame::EventTriggers::BlockTrigger
- Rubygame::EventTriggers::InstanceOfTrigger
- Rubygame::EventTriggers::KeyPressTrigger
- Rubygame::EventTriggers::KeyReleaseTrigger
- Rubygame::EventTriggers::KindOfTrigger
- Rubygame::EventTriggers::MouseMoveTrigger
- Rubygame::EventTriggers::MousePressTrigger
- Rubygame::EventTriggers::MouseReleaseTrigger
- Rubygame::EventTriggers::OrTrigger
- Rubygame::EventTriggers::TickTrigger
- Rubygame::EventTriggers::YesTrigger
- Rubygame::Events
- Rubygame::Events::ClockTicked
- Rubygame::Events::InputFocusGained
- Rubygame::Events::InputFocusLost
- Rubygame::Events::JoystickAxisMoved
- Rubygame::Events::JoystickBallMoved
- Rubygame::Events::JoystickButtonEvent
- Rubygame::Events::JoystickButtonPressed
- Rubygame::Events::JoystickButtonReleased
- Rubygame::Events::JoystickHatMoved
- Rubygame::Events::KeyPressed
- Rubygame::Events::KeyReleased
- Rubygame::Events::KeyboardEvent
- Rubygame::Events::MouseButtonEvent
- Rubygame::Events::MouseFocusGained
- Rubygame::Events::MouseFocusLost
- Rubygame::Events::MouseMoved
- Rubygame::Events::MousePressed
- Rubygame::Events::MouseReleased
- Rubygame::Events::QuitRequested
- Rubygame::Events::WindowExposed
- Rubygame::Events::WindowMinimized
- Rubygame::Events::WindowResized
- Rubygame::Events::WindowUnminimized
- Rubygame::ExposeEvent
- Rubygame::Ftor
- Rubygame::GL
- Rubygame::Hotspot
- Rubygame::JoyAxisEvent
- Rubygame::JoyBallEvent
- Rubygame::JoyDownEvent
- Rubygame::JoyHatEvent
- Rubygame::JoyUpEvent
- Rubygame::Joystick
- Rubygame::Key
- Rubygame::KeyDownEvent
- Rubygame::KeyUpEvent
- Rubygame::MailQueue
- Rubygame::MediaBag
- Rubygame::Mixer
- Rubygame::Mixer::Music
- Rubygame::Mixer::Sample
- Rubygame::Mouse
- Rubygame::MouseDownEvent
- Rubygame::MouseMotionEvent
- Rubygame::MouseUpEvent
- Rubygame::Music
- Rubygame::NamedResource
- Rubygame::NamedResource::NamedResourceClassMethods
- Rubygame::QuitEvent
- Rubygame::Rect
- Rubygame::ResizeEvent
- Rubygame::SDLError
- Rubygame::SFont
- Rubygame::Screen
- Rubygame::Sound
- Rubygame::Sprites
- Rubygame::Sprites::DepthSortGroup
- Rubygame::Sprites::Group
- Rubygame::Sprites::LimitGroup
- Rubygame::Sprites::Sprite
- Rubygame::Sprites::UpdateGroup
- Rubygame::Surface
- Rubygame::TTF

No matching classes.

Note: You can view the latest version of this guide online at the Rubygame wiki: rubygame.org/wiki/Mac_Installation_Guide

## Installing Xcode

Rubygame does not need to be compiled anymore (since version 2.6), but you will need to install the Xcode development tools in order to install the dependencies with Fink or Darwinports, as well as to compile rsdl.

You can find Xcode on your Mac OS X installation disc. Or, you can download Xcode online. You must register for a (free) Mac developer account for this.

- Mac OS X 10.5 (Leopard) and 10.6 (Snow Leopard): Xcode 3.1

- Mac OS X 10.3 (Panther) and 10.4 (Tiger): Xcode 2.5

## Installing dependencies...

You have two options for installing the software libraries that Rubygame depends on: Fink or Darwinports. Which option you choose is just a matter of preference.

### ...with Fink

1. Install Fink and update to the latest version.

2. Open a new terminal (can be found in /Applications/Utilities).

3. Install SDL:

       sudo apt-get install sdl

4. (Optional, but highly recommended:) Install the SDL companion libraries:

       sudo apt-get install sdl-gfx13 sdl-image sdl-mixer sdl-ttf

Thanks to Matt Crinklaw for these instructions.

### ...with Darwinports

1. Install Darwinports (you must register first).

2. Open a new terminal (can be found in /Applications/Utilities).

3. Install SDL:

       sudo port install libsdl

4. (Optional, but highly recommended:) Install the SDL companion libraries:

       sudo port install libsdl_gfx libsdl_image libsdl_mixer libsdl_ttf

Thanks to Raffael Mancini (sepisultrum) for these instructions.

## Installing rsdl

In order to use Rubygame applications on Mac OS X, you must use a special wrapper for the Ruby interpreter, called rsdl.

1. Get rsdl.

2. From within the rsdl directory:

       ruby ./configure.rb
       make
       sudo cp rsdl /usr/local/bin/

## Installing Rubygame

The simplest way to install Rubygame is: `gem install rubygame`

Or you can download the source from Github and follow the installation instructions in README.

## Running an application

If all went well, you can now run Rubygame applications like so:

    rsdl a_rubygame_app.rb

If you have any trouble installing Rubygame, please post in the forums.

[Validate]

Generated with the Darkfish Rdoc Generator 2.