Zirconium

Important

This is a fork of Vorlias' original Zirconium package which was made for a fork of Zircon.
While I believe I have fixed the types to work now with typescript 5.5, it is entirely possible there are edge cases I have yet to find. If you're going to use this, be aware it's currently possibly unstable and I've yet to come to a finalised API surface for V2. In addition this will likely be customised to my own needs. This also does not use the official Zr v2 branch, as the bytecode and vm based approach was unfinished, instead it is only v2 due to the major version changes and API changes.

What Zirconium is

• Zirconium is a runtime scripting language for Roblox, for programmatic manipulation of Roblox games during runtime. Unlike other solutions this is not bound to any sort of command framework. It is inspired by Rust and TypeScript.
• The scripts can be as simple as user commands, to more complex scripting systems like quest triggers.
• Zirconium is sandboxed. You can only use functions that you explicitly provide. Each script runs in it's own environment.

Supported

• Variables

  let x = 10; // basic declaration
  const x = 10; // constant (can not reassign)

• If/Else

  // Shorthand if
  if value: print "Hello, World!"
  
  // Longhand if
  if value { // brackets are optional
      print "Hello, World!"
  }
  
  // If else
  if value {
      print "Value is true!"
  } else {
      print "Value is false!"
  }

• For-In Statement

  // Iterate array/object - like for _, value in pairs(myArray)
  for value in myArray {
      print $value
  }
  
  // Iterate range (Print numbers 1 to 10), like for i = 1, 10 do
  for value in 1..10 {
      print $value
  }

• Functions (both Zr and Luau)

  // Command calls
  test! // no arguments, exclaimation is because otherwise it's evaluated as the variable itself
  print "Hello, World!" 42 true // arguments
  
  // Script calls
  test() //  no arguments
  print("Hello, World!", 42, true) // arguments
  
  // Declaring and using user functions
  function example() {
      print "Hello from example!"
  }
  
  example!

• Arrays (including indexing)

  let exampleArray = [1, 2, 3];
  let emptyArray = [];
  let arrayWithMixed = [1, "Hello!", true];

• Objects (including property access)

  let exampleObject = {
      aNumber: 10,
      aBoolean: true,
      aString: "Hi there!"
  }
  let emptyObject = {}

Limitations

• Stack limit: 256. This is intentionally small as you shouldn't be doing anything that complex with this.