§ Installationtop ^

• Get a recent release of Catspeak from the GitHub releases page. You should see a download for a file with the extension .yymps.

• Open your project file in the GameMaker IDE.

• Navigate to the toolbar at the top of the IDE and find "Tools". Click this and select "Import Local Package" from the drop-down menu.

• Select the .yymps file you downloaded, and follow the wizard to import the Catspeak resources. If you're not sure what to import, click "Add All".

Now you're setup, see the Basic Usage section for an introductory example, or read through the Catspeak for Developers chapter for a full-fat overview.

§ Basic Usagetop ^

A minimal working example of a function which returns a message:

GameMaker Language (.gml)
Copy// parse Catspeak code
var hir = Catspeak.parseString(@'
  let catspeak = "Catspeak"

  return "hello! from within " + catspeak
');

// compile Catspeak code into a callable GML function
var getMessage = Catspeak.compile(hir);

// call the Catspeak code just like you would any other GML function!
show_message(getMessage());

Create an object, then copy-and-paste this code into its create event to see magic happen.