Get started

Learn how to start creating 2D apps in Ruby

✏️ Suggest an edit to this page »

Set up your environment and install dependencies

Before installing the gem, we’ll need to install a few dependencies, namely a native graphics engine Ruby 2D will use behind the scenes called Simple 2D.

• On macOS, we recommend using Homebrew and running:

  $ brew tap simple2d/tap && brew install simple2d
  

• On Linux, paste and run this snippet in your terminal:

  url='https://raw.githubusercontent.com/simple2d/simple2d/master/bin/simple2d.sh'; which curl > /dev/null && cmd='curl -fsSL' || cmd='wget -qO -'; bash <($cmd $url) install
  

  If you need further help, learn how to set up your Linux environment »

• On Windows, learn how to set up your environment »

Install the gem

Now you’re ready to install the Ruby 2D gem! On your command line, run:

gem install ruby2d

Writing your first 2D app

After installing the gem, create a new Ruby script called app.rb and add the following two lines.

require 'ruby2d'

show

This is the simplest Ruby 2D application you can write. The require statement adds the Ruby 2D domain-specific language and classes, and the show method tells Ruby 2D to show the empty window. Let’s make this window more interesting by giving it a name and adding a shape. We’ll use the set method to change the title of the window and add a colorful triangle.

require 'ruby2d'

set title: "Hello Triangle"

Triangle.new(
  x1: 320, y1:  50,
  x2: 540, y2: 430,
  x3: 100, y3: 430,
  color: ['red', 'green', 'blue']
)

show

Great! Now save your script and run it on the command line using:

ruby app.rb

You should see this impressive triangle…

Congrats, you just built your first Ruby 2D app! 🎉

What’s next?

There’s a lot Ruby 2D can do. Continue to the next topic or select one from the contents menu. 👆