ncharlton02 / aurora

A lua interpreter written in rust

Aurora (WIP)

A lua intepreter written in rust. There is currently little documentation due to the early stage of this project.

How to run

Aurora can run in two modes, file and console. File mode will run a file in the assets folder whereas console mode will run an interactive interpereter in the terminal.

To run file mode run:

$ cargo run --example=file -- -f=FILE_NAME_HERE
$ cargo run --example=file -- -f=basic

To run console mode run:

$ cargo run --example=console

To see the tokens and the raw AST use the verbose flag:

$ cargo run --example=file -- -v -f=basic

Note: Flags do not work in the console version!

Features

Aurora is currently a WIP. Lots of the lua language isn't supported. See below for the currently supported and planned features.

Implemented Features

• Comments
• If statements
• Print statements
• Basic arithmetic
• Functions
• While loops
• For loops
• Local variables
• Basic error messages with line numbers
• Tables
• Modules

Planned features

• Rust/Lua interops
• For in loops
• A std library
• Order of Operations
• Library to run files
• Basic concurrency

Known Problems

The expression parser is very buggy so I don't recomend writting complicated expressions like

local x = (5 - ((8 - 9) / 3.14) - (9 - 3) * 7)

Want to contribute?

Please do, there is a lot of areas that need work! A good place to start would be testing, examples, or the expression parser. If you have any questions, don't be afraid to ask.