2D BYRL Lab Documentation

Getting Started

The lab is the powerful tool used for developing video games.

Basic Setup

To get started, simply open the Workspace, select/create a project, and begin writing your code.

Running Your Code

Click the Run button in the top bar to execute your code. The output will appear in the preview panel on the right.

Game Objects

GameObject = Circle;

GameObject = Rectangle;

GameObject = Square;

GameObject = Triangle;

GameObject = Capsule;

GameObject = Sprite;

GameObject = Text;

GameObject = Audio;

GameObject = Video;

GameObject = WebView;

GameObject = Constraint;

Event System

The event system allows game objects to communicate and react to custom actions. You can listen for events using on() and trigger them using trigger().

Syntax

ON [GameObject] [event]
    ...
END

[GameObject] TRIGGER [event];
[GameObject] TRIGGER [event] [eventData];

Event Methods

Keyboard

The Keyboard module allows you to handle key presses, holds, releases, and key combinations with full control over timing and context.

Access

To access the Keyboard functionality, make sure you import it.

Keyboard Methods

UI System

The UI System allows you to create interactive user interface elements.

Available Elements

• Button - Clickable button
• Label - Text display
• Panel - Container for other UI elements
• Slider - Draggable range selector
• ProgressBar - Visual progress indicator
• Input / Textbox - Text input field
• WebView - Embedded web content
• Countdown - Countdown timer
• Stopwatch - Stopwatch timer

Syntax

UI [type] : [properties];

Adding to Scene

COM Scene-specific UI (clears when scene changes)
button ADD TO SCENE;

Adding Globally

COM Persistent UI (stays across all scenes)
button ADD;

UIElement Methods

UI Events

WebView

Embed live web content directly in your UI.

Syntax

UI WebView : [properties];

Properties

Countdown

Syntax

UI Countdown : [config] AT [time]
    [callback]
END

Stopwatch

Syntax

UI Stopwatch : [config] AT [time]
    [callback]
END

Themes

29 visual themes available for Countdown and Stopwatch: default, neon, flaming, lux, retro, glowing, tacticle, news, candy, floating, 80s, distant, outline, love, inset, blocks, grave, solid, cartoon, vegas, comic, deep, mummy, hero, dracula, blurry, emboss, press, carve, ghost.

Themes with glow support: neon, flaming, glowing, vegas, hero, love, outline.

Collision System

The collision system allows you to detect and respond to interactions between game objects.

Creating a Collision

COLLISION OF [objects];

You can pass a single object or an array of objects to monitor collisions between them.

Collision Methods

Automatic Events

Each object involved in a collision also automatically triggers event's:

ON [GameObject] COLLISION START WITH [other]
    ...
END

ON [GameObject] COLLISION END WITH [other]
    ...
END

Hitbox [shapeType] : [properties];

Scene

Access scene properties and methods for responsive positioning and sizing.

Methods

Note: to reload the entire project, use the engine.reload(); function.

SCENE QUERY [query];

Camera

The 2D camera controls how the scene is viewed. You can create multiple cameras, switch between them, and apply visual effects.

Syntax

Camera [name];

To activate or deactivate a camera, use the activate/deactivate method. BYR provides a default 2D camera accessible via camera, so you can use it directly without creating a new one.

Camera Properties

Camera Methods

Layers

Layers allow you to organize game objects into groups for collective control.

Syntax

Layer [gameObjects] : [options];

Properties

Layer Methods

Properties

Advanced Features

Project Management

• New - Start a new project
• Save - Save your project
• Load - Load a saved project
• Export - Download the code source as a text file
• Publish - Publish the project
• Settings - Configure the project settings

Asset System

Extend functionality by importing assets from the marketplace.

Accessing Assets

1. Click the Assets dropdown in the top bar
2. Select Import to open the Asset Library
3. Browse available assets and click to add them to your project
4. Assets will automatically run when you execute your code

Managing Assets

Use the Manage option to view and remove currently loaded assets.

Asset Types

• Scripts - Add new functions and behaviors
• Sprites - Visual assets and graphics
• Models - 3D objects
• Audio - Sound effects and music
• Bundles - Collections of related assets

Timers

Wait

WAIT [seconds]
    ...
END

waitFor

WAIT FOR [value]
    ...
END

waitUntil

WAIT UNTIL [value] [targetValue]
    ...
END

Loop

LOOP
    ...
END

LOOP EVERY [seconds]
    ...
END

Iteration

ITERATION [value] [targetValue] : STEPS [n]
    ...
END

ITERATION [value] [targetValue] : STEPS [n] TIMEOUT [seconds]
    ...
TIMEOUT_CALLBACK
    ...
END

Countdown

Syntax

UI Countdown : [config] AT [time]
    [callback]
END

Stopwatch

Syntax

UI Stopwatch : [config] AT [time]
    [callback]
END

Themes

29 visual themes available for Countdown and Stopwatch: default, neon, flaming, lux, retro, glowing, tacticle, news, candy, floating, 80s, distant, outline, love, inset, blocks, grave, solid, cartoon, vegas, comic, deep, mummy, hero, dracula, blurry, emboss, press, carve, ghost.

Themes with glow support: neon, flaming, glowing, vegas, hero, love, outline.

Animation

Interpolates GameObject properties over time. Supports chaining and looping for complex motion.

Animation [gameObject] : [config];

Methods

Particle System

Create particle effects. The ParticleSystem must be imported before use.

Syntax

ParticleSystem : [config];

Properties

Methods

Utilities

Random

Math

Context Menu

Create context menus.

Syntax

ContextMenu : [config];

Config

Methods

Developer Console

The developer console is a real-time debugging and command interface for monitoring and interacting with your project at runtime.

It provides logging, command execution, error tracking, debug visualization, asset management, module importing, runtime inspection, and output control.

Logging Output

Use the console to display runtime information, warnings, and errors.

CONSOLE LOG [message];
CONSOLE WARN [message];
CONSOLE ERROR [message];
CONSOLE SUCCESS [message];

• console.log() - General information output
• console.warn() - Non-critical warnings
• console.error() - Critical errors
• console.success() - Success messages

Command System

Commands are entered into the console and executed immediately. They allow direct interaction with engine systems at runtime.

Comments

The console supports inline comments using the # symbol. Everything after # is ignored during execution.

Error System

Filters

The SHOW ERRORS command supports filtering using the FILTER[...] syntax. This allows you to narrow results by source or message content.

Types

• SRC - Filter by error source
• CON - Filter by message content

Commands

SHOW ERRORS - Show the 10 most recent errors
SHOW ERRORS [number] - Show a specific number of errors (max: 50)
SHOW ERRORS * - Show all stored errors
SHOW ERRORS FILTER[SRC] {source, ...} - Filter errors by source
SHOW ERRORS FILTER[CON] {text, ...} - Filter errors by content
• CLEAR ERRORS - Clear all stored errors
• COUNT ERRORS - Show the total number of errors
• HELP DEBUG - Show debug system help

Available Sources

• asset-system (asset)
• user-code (user)
• auth-system (auth)
• nav-system (nav)
• help-system (help)
• script-execution (script)
• audio-system (audio)
• sprite-system (sprite)
• constraint-system (constraint)
• security-violation (security)
• async-command (async)
• command-parsing (command)

Common Commands

byr@ByrLab:~$   INFO # Show project information

byr@ByrLab:~$   HELP # Show all available commands

byr@ByrLab:~$   HELP [command] # Show detailed help for a command

byr@ByrLab:~$   CLS # Clear console output

byr@ByrLab:~$   CLEARHISTORY # Clear command history

byr@ByrLab:~$   RUN # Execute current code

byr@ByrLab:~$   ECHO [text] # Print text to console

byr@ByrLab:~$   FPS # Display current FPS

byr@ByrLab:~$   VERSION # Show engine version

byr@ByrLab:~$   OPEN [destination] # Navigate to a section

Supported Destinations

• home - Navigate to the homepage
• profile - Open your user profile
• market - Open the marketplace
• community - Open the community section

Debug Commands

byr@ByrLab:~$   DEBUG STATUS # Show active debug systems

byr@ByrLab:~$   ENABLE DEBUG [type(s)] # Enable specific debug types

byr@ByrLab:~$   DISABLE DEBUG [type(s)] # Disable specific debug types

byr@ByrLab:~$   PERFORMANCE # Manage performance monitor

Supported Debug Types

• angleindicator - Show angle indicators
• axes - Show axes
• bounds - Show bounding boxes
• collisions - Visualize collision points
• convexhulls/hulls - Show convex hulls
• ids - Show object IDs
• internaledges/edges - Show internal edges
• positions - Show position markers
• separations - Show separation vectors
• shadows - Render debug shadows
• sleeping - Indicate sleeping bodies
• stats - Show performance stats
• velocity - Show velocity vectors
• vertexnumbers/vertices - Show vertex indices
• wireframe - Toggle wireframe rendering

Available Performance Sub-Commands

• ON - Enable the performance monitor
• OFF - Disable the performance monitor
• POSITION - Set performance monitor position (TOP / BOTTOM)
• COLOR - Toggle between heatmap and one color mode
• PROTECT - Toggle crash protection on/off
• THRESHOLD - Set minimum FPS before protection triggers
• TIMING - Set seconds before the scene is cleared

byr@ByrLab:~$   IMPORT [module] # Import module

byr@ByrLab:~$   IMPORT [module] AS [alias] # Import with alias

byr@ByrLab:~$   IMPORT [module] /g # Global import

byr@ByrLab:~$   IMPORT [module] /r # Replace existing import

byr@ByrLab:~$   IMPORT [module] /d # Import dependencies

byr@ByrLab:~$   UNIMPORT [module] # Remove module

byr@ByrLab:~$   UNIMPORT [module] /g # Remove global module

byr@ByrLab:~$   IMPORTS # List all imported modules

Asset Commands

byr@ByrLab:~$   ASSETS # List all loaded assets

byr@ByrLab:~$   BYR INSTALL [asset ID/name] # Install asset from marketplace

byr@ByrLab:~$   BYR UNINSTALL [asset ID/name] # Uninstall asset from marketplace

Runtime Inspection

byr@ByrLab:~$   LIST GAME OBJECTS # List all scene objects

byr@ByrLab:~$   GET # Log object to console

byr@ByrLab:~$   SELECT # Highlight object in scene

Add a properties bracket to open an interactive panel: SELECT name -> [name] [*] for all properties, or SELECT name -> [name] [properties] for specific ones.

Output Mode

byr@ByrLab:~$   INLINE ON # Enable inline output

byr@ByrLab:~$   INLINE OFF # Disable inline output

byr@ByrLab:~$   SPAM PROTECTION # Show current status

byr@ByrLab:~$   SPAM PROTECTION ON # Enable spam protection

byr@ByrLab:~$   SPAM PROTECTION OFF # Disable spam protection

byr@ByrLab:~$   SPAM PROTECTION LIMIT [count] WITHIN [time] # Set custom rate limit

Note

• Commands are case-insensitive
• Multiple arguments and flags are supported

Debug System

The Debug system provides visual development aids, including grids and wireframe toggles.

SHOW GRID;

HIDE GRID;

Helper

The Helper class provides visual debugging tools for GameObjects, Hitboxes, and Constraints. It can display bounding boxes, position markers, labels, and audio icons.

Syntax

Helper [target] : [options];

Helper Methods

Options

Label Options

When label is an object, you can configure:

Errors

Below is a comprehensive list of common errors you may encounter in the BYR Lab console, along with their causes and solutions.

Syntax & Parsing Errors

//  Wrong (Check for missing punctuation or operators near 'health')
const player = {
    name: "Warrior" // Missing comma
    health: 100
};

//  Correct
const player = {
    name: "Warrior",
    health: 100
};

//  Wrong (Unexpected token ')')
const array = [1, 2, 3); // Mismatched brackets

//  Correct
const array = [1, 2, 3];

Reference Errors

//  Wrong (variable is not defined)
console.log(variable);

//  Correct
let variable = "value";
console.log(variable);

byr@ByrLab:~$   IMPORT [module] 

Type Errors

//  Wrong (Cannot access 'variable' before initialization)
console.log(variable); 
const variable = "value";

//  Correct
const variable = "value";
console.log(variable);