What is The Game Framework Wide
Game Framework for RubyCocoa > What is The Game Framework

The game framework is an easy game-creating environment that is intended to help developers make small games that run on MiniKidsGames in a short time. The game framework provides frequently used code such as creating the main window, switching between full screen mode and windowed mode, scanning multiple key statuses, and lots more.

Most part of the framework is written in Ruby as it uses RubyCocoa. This enables you to write a game in Ruby, which eases creating a game compared to doing so in Objective-C.

How does the game framework help you

Out in the box

The game framework provides an Xcode project template and a Ruby file template. You don't have to create a new Xcode project from scratch. Once you create a new Xcode project with the template, you already get a ready-to-make-your-game running application. You can create your own game right after creating a new project.

Hard work is done

The game framework provides a lifecycle of a simple game. The game framework itself is a running application, which means that most of the basic code for an application is already written. You don't have to write any lines of code for creating a window, switching to full-screen mode, etc. This enables you to concentrate on writing only the code for your games.

Game Template - halfway done

The framework comes with a game template as an Xcode file template. This template contains about 100 lines of ruby code that is a skeleton of a game. It runs as a game that does nothing but shows a message. All you have to do is: 1) Add a new file with the Xcode file template, and 2) write what you want by modifying the file.

Simple and Organized structure

The game framework gives you the basic structure of a game, which is based on both the MVC pattern and the State pattern. These patterns help you write some code in a consistent fashion. Are these patterns beyond your knowledge? Don't worry. The basic part of these patterns is already implemented in the template.

Game Tutorial - your good friend to tell you how

The game framework also provides a tutorial for making a simple game. This tutorial illustrates how to create a simple game by using the game framework. See Mini Game Tutorial for more details.

If you are not familiar with RubyCocoa, read the tutorial, and get some knowledge in writing a game on your Mac. It is a good starting point. Then, you may come back here to elaborate your game.

What the game framework provides

The game framework itself is a running application. it contains:

  • Xcode project files (for Xcode version 2.4)
    • framework source (*.rb)
    • The main window routine (MiniGameWindow.rb)
    • The main view routine (MiniGameView.rb)
    • Controller (MiniGameController.rb)
    • Window, View, and Menu (MainMenu.nib)

It also contains a variety of classes that eases developing a game, which includes:

  • Event handling (Event.rb, TimerEvent.rb, KeyEvent.rb, MouseEvent.rb)
  • Abstract View class (View.rb)
  • Game State (State.rb)
  • Preference access (Preferences.rb)
  • Utility classes (Utility.rb)

What the framework does not provide

Unfortunately, the game framework does not provide any of sound files or graphic images that are essential for games. However, there is a lot of tools available on your Mac - GarageBand, Gimp, and lots more. Most of these tools are either bundled on your Mac or available for free. By using these tools, you can create sounds, music loops, and images that you want.

Top:Game Framework for RubyCocoa|Next>Structure of A Game