https://github.com/katsaii/catspeak-lang
A cross-platform modding language for GameMaker games.
https://github.com/katsaii/catspeak-lang
compiler domain-specific-language dynamically-typed gamemaker-studio-2 games language lexer-parser programming-language
Last synced: 3 months ago
JSON representation
A cross-platform modding language for GameMaker games.
- Host: GitHub
- URL: https://github.com/katsaii/catspeak-lang
- Owner: katsaii
- License: mit
- Created: 2021-02-20T04:19:22.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-24T00:25:49.000Z (4 months ago)
- Last Synced: 2025-02-24T01:25:21.083Z (4 months ago)
- Topics: compiler, domain-specific-language, dynamically-typed, gamemaker-studio-2, games, language, lexer-parser, programming-language
- Language: Game Maker Language
- Homepage: https://www.katsaii.com/catspeak-lang/
- Size: 2.01 MB
- Stars: 98
- Watchers: 8
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-gamemaker - Catspeak - Cross-platform programming language for modding support. (Utilities / Recommendations)
README
# The Catspeak Programming Language
A **cross-platform** scripting language and compiler back-end for GameMaker
projects. Use Catspeak to implement, **fast** and **sandboxed modding support**
by compiling and executing **arbitrary user code** from files or text prompt.
_Developed and maintained by [Katsaii](https://www.katsaii.com/)._
_Logo design by [Mashmerlow](https://mashmerlow.github.io/)._
## Overview
The spiritual successor to the long dead `execute_string` function...
```js
// parse Catspeak code
var ir = Catspeak.parseString(@'
let catspeak = "Catspeak"
return "hello! from within " + catspeak
');
// compile Catspeak code into a callable GML function
var getMessage = Catspeak.compile(ir);
// call the Catspeak code just like you would any other GML function!
show_message(getMessage());
```
...without any of the vulnerabilities from unrestricted access to your game
code:
```js
var ir = Catspeak.parseString(@'
game_end(); -- heheheh, my mod will make your game close >:3
');
// calling `badMod` will throw an error instead of calling the `game_end` function
try {
var badMod = Catspeak.compile(ir);
badMod();
} catch (e) {
show_message("a mod did something bad!");
}
```
## Projects Using Catspeak
In no particular order:
- [Rusted Moss](https://store.steampowered.com/app/1772830/Rusted_Moss/)
_(If you have a project you would want to appear here, please [get in contact](https://github.com/katsaii/catspeak-lang/issues/new?template=iuseit.yml)!)_
## Features
If you run into any issues using this project, please create a [GitHub issue](https://github.com/katsaii/catspeak-lang/issues/new/choose)
or get in contact on Discord through the [GameMaker Kitchen](https://discord.gg/8krYCqr) server.
### 📝 Minimal Setup Required
- Self-contained and ready to use after installation.
- No need to place a persistent God Object in the first room of your game!
### ☯ Seamless GML-Catspeak Interoperability
- Call GML code from Catspeak.
- Call Catspeak code from GML.
- Familiar syntax inspired by GML and JavaScript.
### 🏃♀️ Performant Runtime
- Optimising compiler generates performant code capable of competing with pure GML implementations.
- At best, Catspeak code will be just as fast as GML.
- On average, Catspeak code will be 5x slower than GML.
### 👽 Cross-platform
- Implemented in pure GML.
- No external dependencies or platform-specific DLLs.
- Mods should work on any target platform. _(Tested on Windows 10 using: VM, YYC, HTML5, and GMRT)_
### 🔨 Customisable, Sandboxed Runtime Environment
- Modders cannot gain access to parts of your game you don't want them to.
- Expose only the functions and resources you feel comfortable with.
- Impossible for modders to execute malicious code by default.
- Detects infinite loops and recursion so the sly `while true { }` doesn't freeze your game, whether intentionally or unintentionally.
### 💪 Built for Power Users
- Full compiler back-end documented and available for experimentation.
- Pre-compile your scripts to JSON, and cache them for later. Skip straight to code generation.
- Parse your own domain-specific language into Catspeak IR, then let the code generator turn that into a GML compatibile representation:
- A custom UI language which supports running user-defined functions as button events.
- A custom data-specification language where certain keywords act as calls to GML functions.
- A simple shell-script language for a developer console.
- A custom scripting language for a programming game.
### 🙀 Cute Name and Mascot
## Acknowledgements
Thanks to [JujuAdams](https://www.jujuadams.com/) for giving important feedback
on aspects of the implementation, an important step towards making sure
Catspeak is battle hardened.
Thanks to [TabularElf](https://github.com/tabularelf) for donating lots and lots
of prototype code for new Catspeak features.
Thanks to anyone spreading the good name of Catspeak.