lynxscript 0.1.1

A Python port of the LynxScript compiler

🐱 LynxScript (Python Port)

LynxScript is a programming language designed for CatWeb, a Roblox game where users can build website-esque creations. The LynxScript compiler compiles source code files into a JSON format that can be imported directly into CatWeb.

This project is a complete, architecturally faithful port of the original Rust implementation into Python 3.10+.

Usage

Syntax

LynxScript features a syntax familiar to web developers:

// Familiar syntax to web-devs
console.log("Hello, world!");

// In-language standard library definition
#[export_as("console.log")]
function log(arg) {
  // Raw CatWeb block ID calls
  #0(#"", arg);
}

Command Line Interface

You can compile a LynxScript source file to JSON using the following CLI arguments:

# Compile a LynxScript source file to JSON and output it to output.json
lync --compile ./src/main.lxs --output ./out/output.json

# Or just output the JSON onto the console
lync -c ./src/main.lxs
# (-c is shorthand for --compile, and -o for --output)

If you are running directly from the source directory, you can invoke the module via Python:

python -m lynxscript.main -c <path_to_script>.lxs -o <output_path>.json

Features & Roadmap

• Function declarations
• Event handlers
• Raw CatWeb block ID calls
• In-language standard library implementation
• Link statement (Importing site JSON files and referencing UI objects)
• Arbitrary expression compilation (binary, boolean)
• Return statements
• If statements
• Loops
• Optimizations
  • Function inlining
  • Constant folding
  • Dead code elimination

Installation

You can install lynxscript directly from PyPI:

pip install lynxscript

Or install it locally in editable mode for development:

1. Clone the repository.
2. Go to the project directory and run:

   pip install -e .
   

3. You can now use the lync command directly in your terminal!

Development & Testing

Prerequisites

• Python 3.10 or newer.
• pytest for running tests (installed automatically via requirements.txt or as dev dependency).

Running Tests

To run tests (which verify the parser and compiler AST output matches character-for-character with original Rust snapshots):

pytest

---

License

This project is licensed under the MIT License.

Acknowledgments

• Similar project: catlua also shaped the ecosystem of CatWeb text-based programming languages ✨
• Original Rust implementation by pickaxe828.

Rewritten in Python by Ziad.