Yet another raylib wrapper for Ruby

• Created : 2021-10-17
• Last modified : 2024-10-14

Provides Ruby bindings for raylib-related libraries including:

• raylib version 5.5-dev
  • raylib
  • raymath
  • rlgl
• raygui version 4.5-dev
• Physac version 1.1

Features

• Generated semi-automatically
• Based on Ruby/FFI ( https://github.com/ffi/ffi )
• Pre-built binaries are inside:
  • Windows (x86_64)
  • macOS (x86_64, ARM64)
  • Linux (x86_64, ARM64)

Quick Start

D:\> gem install raylib-bindings
Fetching raylib-bindings-...
...
1 gem installed

D:\> ruby -r raylib -e 'Raylib.template'
[Info] Raylib.template : C:/Ruby31-x64/lib/ruby/gems/3.1.0/gems/raylib-bindings-0.0.11/examples/template.rb => d://template.rb
[Info] Raylib.template : Done

D:\> ruby template.rb

↓

Prerequisites

• Ruby interpreter

  • Tested on:
    • [macOS] https://rvm.io
      • ruby 3.3.3 (2024-06-12 revision f1c7b6f435) [arm64-darwin23]
    • [Windows] https://rubyinstaller.org/downloads/ Ruby+Devkit
      • ruby 3.3.0 (2023-12-25 revision 5124f9ac75) [x64-mingw-ucrt]
    • [Linux/x86_64 WSL] https://github.com/rvm/ubuntu_rvm
      • ruby 3.2.0preview1 (2022-04-03 master f801386f0c) [x86_64-linux]
    • [Linux/ARM64 Chromebook] https://github.com/rvm/ubuntu_rvm
      • ruby 3.3.0 (2023-12-25 revision 5124f9ac75) [aarch64-linux]

• If you need to build DLLs/shared libralies for your own runtime envrioenment (Linux, etc.):

  • CMake https://cmake.org/download/
  • C Compiler
    • Tested compilers:

      • [macOS] clang

        $ clang --version
        Apple clang version 15.0.0 (clang-1500.3.9.4)
        Target: arm64-apple-darwin23.4.0
        Thread model: posix
        InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
        

      • [Windows] gcc

        gcc (Rev3, Built by MSYS2 project) 13.2.0
        

      • [Linux] gcc, clang

        (x86_64) Ubuntu clang version 14.0.0-1ubuntu1
        (arm64) Debian clang version 14.0.6
        

Older versions

• Ruby interpreter

  • Tested on:
    • [macOS]
      • ruby 3.3.0 (2023-12-25 revision 5124f9ac75) [arm64-darwin23]
      • ruby 3.2.1 (2023-02-08 revision 31819e82c8) [arm64-darwin22]
      • ruby 3.2.0 (2022-12-25 revision a528908271) [arm64-darwin21]
      • ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [arm64-darwin21]
      • ruby 3.1.0p0 (2021-12-25 revision fb4df44d16) [arm64-darwin20]
      • ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [arm64-darwin20]
    • [Windows] https://rubyinstaller.org/downloads/ Ruby+Devkit
      • ruby 3.2.0 (2022-12-25 revision a528908271) [x64-mingw-ucrt]
      • ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x64-mingw-ucrt]
      • ruby 3.1.1p18 (2022-02-18 revision 53f5fc4236) [x64-mingw-ucrt]
      • ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x64-mingw32]
    • [Linux/ARM64 Chromebook] https://github.com/rvm/ubuntu_rvm
      • ruby 3.2.0 (2022-12-25 revision a528908271) [aarch64-linux]

• Compiler

  • Tested on:

    • [macOS] clang

      $ clang --version
      Apple clang version 15.0.0 (clang-1500.0.40.1)
      Target: arm64-apple-darwin23.0.0
      Thread model: posix
      InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
      
      $ clang --version
      Apple clang version 14.0.0 (clang-1400.0.29.202)
      Target: arm64-apple-darwin22.2.0
      Thread model: posix
      InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
      
      $ clang --version
      Apple clang version 13.1.6 (clang-1316.0.21.2.5)
      Target: arm64-apple-darwin21.5.0
      Thread model: posix
      InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
      
      $ clang --version
      Apple clang version 13.1.6 (clang-1316.0.21.2.3)
      Target: arm64-apple-darwin21.5.0
      Thread model: posix
      InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
      
      Apple clang version 13.0.0 (clang-1300.0.29.3)
      Target: arm64-apple-darwin20.6.0
      Thread model: posix
      InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
      

    • [Windows] gcc

      gcc (Rev7, Built by MSYS2 project) 12.2.0
      gcc (Rev10, Built by MSYS2 project) 11.2.0
      gcc (Rev9, Built by MSYS2 project) 11.2.0
      

Projects

Games

See the projects below to learn how to use this library:

• Whac-a-Mole! : Ruby raylib bindings demo

  • 
  • https://github.com/vaiorabbit/raylib-bindings-whacamole

• 1D dot eater : Ruby raylib bindings demo

  • 
  • https://github.com/vaiorabbit/raylib-bindings-pacone

• flapper.rb : Ruby raylib bindings demo

  • 
  • https://github.com/vaiorabbit/raylib-bindings-flapper

Libraries

• raylib-bindings-tileson : Provides Ruby bindings for raylib-tileson ( https://github.com/RobLoach/raylib-tileson )
  • 
  • https://github.com/vaiorabbit/raylib-bindings-tileson

Limitation

• SetTraceLogCallback and TraceLogCallback are unusable since Ruby-FFI does not support :varargs parameter in callbacks (Proc, etc.)

  • Ref.: https://ffi.github.io/ruby-ffi-archive/messages/20130214-%5Bruby-ffi%5D%20Re_%20Callback%20Function%20with%20varargs-345.html

• For macOS users: if you get error messages like “'.... .dylib' not valid for use in process: library load disallowed by system policy” , you can work around it with the following command (although it is not recommended):

  • $ xattr -dr com.apple.quarantine (path to the .dylib)

License

Shared libraries in lib directory are built on top of these products and are available under the terms of these licenses:

• libraylib.arm64.dylib, libraylib.x86_64.dylib, libraylib.dll, libraylib.aarch64.so, libraylib.x86_64.so
  • raylib ( https://github.com/raysan5/raylib )
    • zlib License https://github.com/raysan5/raylib/blob/master/LICENSE
• raygui.arm64.dylib, raygui.x86_64.dylib, raygui.dll, raygui.aarch64.so, raygui.x86_64.so
  • raygui ( https://github.com/raysan5/raygui )
    • zlib License https://github.com/raysan5/raygui/blob/master/LICENSE
• physac.arm64.dylib, physac.x86_64.dylib, physac.dll, physac.aarch64.so, physac.x86_64.so
  • Physac ( https://github.com/raysan5/physac )
    • LICENSE: zlib/libpng https://github.com/raysan5/physac/blob/4a8e17f263fb8e1150b3fbafc96f880c7d7a4833/src/physac.h#L51-L68

All ruby codes here are available under the terms of the zlib/libpng License ( http://opensource.org/licenses/Zlib ).

Ruby-raylib : Yet another raylib wrapper for Ruby
Copyright (c) 2021-2024 vaiorabbit <http://twitter.com/vaiorabbit>

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

    1. The origin of this software must not be misrepresented; you must not
    claim that you wrote the original software. If you use this software
    in a product, an acknowledgment in the product documentation would be
    appreciated but is not required.

    2. Altered source versions must be plainly marked as such, and must not be
    misrepresented as being the original software.

    3. This notice may not be removed or altered from any source
    distribution.