LumenScript Studio

A custom scripting language and IDE for game development, built with Haskell. This project provides the tools to write, parse, and eventually execute game logic scripts.

Code Owners

• Arpita Swain
• Aurabhri Sharma
• Manshi Singh

Getting Started

This project is built using the Haskell Stack tool. All commands should be run from the lumenscript-studio directory.

Prerequisites

Ensure you have Stack installed on your system.

Building the Project

To build the project and all its dependencies, run the following command:

stack build

Running Tests

The project includes a test suite to verify the functionality of the lexer, parser, and other components. To run the tests, use:

stack test

Running Demos

To see the parser in action with example scripts, you can run the following commands:

stack run demos/dialogue_tree.lum
stack run demos/enemy_ai.lum
stack run demos/platformer.lum

---

Project Structure

A brief overview of the key directories in this project:

• src/: Contains the core source code for the language (Lexer, Parser, ParserTypes, ParserExpressions, etc.).
• test/: Contains the test suites for all components.
• demos/: Contains example .lum scripts demonstrating language features.
• lumenscript-studio.cabal: The main package definition file.

---

LumenScript by Example

Here is a simple script showing an event handler that moves a player entity.

Move the player to the right on every frame update

on update: player.x = player.x + 1

On collision with a coin, increase the score

on collision "player" "coin": score = score + 10

Project Roadmap

• Lexer: Tokenizes the source code. (Complete and documented)
• Parser: Builds a bare-minimum Abstract Syntax Tree (AST) from tokens. New files ParserTypes.hs and ParserExpressions.hs have been added to support this.
• Semantic Analysis: The next step is to perform type checking and validation on the AST.
• Bytecode Compiler: Compiles the AST to an intermediate representation.
• Virtual Machine (VM): Executes the compiled bytecode.

---

Lexer Token Set (v1.0)

The following table documents the complete set of tokens produced by the lexer. This serves as the official contract for the parser development phase.

Token Constructor	Description	Example(s)
TInt Int	An integer literal.	123, 42, 0
TString String	A string literal.	"Hello", "Game Over"
TBool Bool	A boolean literal.	true, false
TIdent String	An identifier (variable, function name).	player, health, jump
TDot	The dot operator for member access.	.
TComma	The comma separator.	,
TLParen	A left parenthesis.	(
TRParen	A right parenthesis.	)
TColon	A colon, used for blocks.	:
TAssign	The assignment operator.	=
TPlus	The addition operator.	+
TMinus	The subtraction operator.	-
TMultiply	The multiplication operator.	*
TDivide	The division operator.	/
TMod	The modulo operator.	%
TLt	The less than operator.	<
TGt	The greater than operator.	>
TEq	The equality operator.	==
TNotEqual	The inequality operator.	!=
TLe	The less than or equal to operator.	<=
TGe	The greater than or equal to operator.	>=
TKwLet	The let keyword.	let
TKwIf	The if keyword.	if
TKwElse	The else keyword.	else
TKwElif	The elif keyword.	elif
TKwOn	The on keyword for event handlers.	on
TKwKeyPress	The key_press keyword.	key_press
TKwCollision	The collision keyword.	collision
TKwUpdate	The update keyword.	update
TKwInteract	The interact keyword.	interact
TIndent	Represents an increase in indentation.	(Generated by the lexer)
TDedent	Represents a decrease in indentation.	(Generated by the lexer)
TNewline	A newline character.	\n
TEOF	End of the input file.	(Generated by the lexer)
TError String	Represents a lexing error.	(Generated on invalid input)