RGSS Reference Manual

RGSS (Ruby Game Scripting System) uses the object-oriented scripting language Ruby to develop 2D games for the Windows® platform. RGSS lets you build entirely original game systems far more easily than would other languages like C. Ruby is a simple language that's easy even for beginners to use, yet it's still a powerful and sophisticated tool.

About This Document

This document presents a selection of entries from the Ruby reference manual, the bare minimum needed for using RGSS. It has been edited to include explanations of RGSS's unique specifications as well. Aimed at RGSS users, we've greatly scaled back on those areas that aren't important for game programming and updated each entry. This means that some portions might not be strictly accurate; as a Ruby reference, it's no more than a quick-and-dirty guide and should be treated as such.

The original Ruby language, as well as the source for this document, can be found at the official Ruby homepage: http://www.ruby-lang.org/. Check it out if you need more detailed Ruby information.

User Support

Enterbrain provides no user support for creating games with the script editor or any problems that may arise from the game-creation process. Furthermore, neither Enterbrain nor Yukihiro Matsumoto assume any responsibility to provide Ruby script support. Be sure you have a thorough understanding of RGSS's functions when attempting to edit a script.

Be a responsible programmer--make sure to check these pages, the Ruby homepage, any other Ruby information and support sites, and similar resources before approaching a site administrator for assistance.

Contents

  • RGSS Specifications

  • Ruby Syntax

    • Syntax and Expressions

    • Variables and Constants

    • Literals

    • Operator Expressions

    • Control Structures

    • Method Calls

    • Class and Method Definitions

  • Standard Library

    • Built-in Functions

    • Built-in Variables

    • Built-in Classes

    • Built-in Modules

    • Built-in Exception Classes

  • Game Library

    • RGSS Built-in Functions

    • RGSS Built-in Classes

    • RGSS Built-in Modules

    • RPGXP Data Structure

  • Appendix

    • Regular Expressions

    • sprintf Format

NextRGSS Specifications

Last updated