Projects Documentation

Complete guide to creating, managing, and publishing projects on BYR Lab

Introduction to BYR Projects

Projects are the core units in BYR. They are interactive experiences that can be built, shared, collaborated on, and published directly on the platform.

What are BYR Projects?

BYR Projects are interactive experiences built using the editor.

Key Features:

  • Real-time collaboration with other creators
  • Built-in physics engine for 2D and 3D
  • Visual scripting with Blueprint system
  • Asset management and version control
  • Cross-platform publishing

Creating Your First Project

Creating a project in BYR is a simple 4-step process.

Step 1: Initialize The Project

Navigate to the workspace page and click on the "Create New Project" button.

Step 2: Choose Your Project Type

Start by selecting whether you want to create a 2D or 3D project. This choice determines the workspace environment and available tools.

Step 3: Add Assets (Optional)

Select assets from your personal library to include in your project:

  • Browse your downloaded assets from the marketplace
  • Click any asset to select it
  • Preview assets before adding them to your project
  • You can skip this step if you want to start without assets
  • Assets can always be added later via the "Asset Library".

Step 4: Name Your Project

Give your project a descriptive name:

  • Choose something memorable that reflects your project's purpose
  • Good names help you organize your workspace later
  • You can always change the name later

Project Setup

Detailed configuration options for setting up new projects.

Initial Configuration

When creating a new project, you'll be presented with several configuration options:

Resolution & Aspect Ratio

Set your project's base resolution. This affects how your project appears on different devices.

Physics Settings

Configure gravity, collision detection, and physics performance settings.

Rendering Options

Choose between different rendering modes based on your project's requirements.

Tip:

Most settings can be changed later in the Project Settings menu, but starting with the right configuration saves time.

Organization

Keep your projects structured and maintainable with effective organization strategies.

Folder Structure Best Practices

Establish a consistent folder structure for your projects:

  • Assets/ - Store all imported media (images, audio, 3D models)
  • Scenes/ - Keep individual scenes organized by functionality
  • Blueprints/ - Group visual scripts by feature or system
  • Components/ - Store reusable custom components
  • Documentation/ - Maintain project notes and guidelines

Naming Conventions

Use clear naming patterns to improve discoverability:

  • Use descriptive names that indicate purpose
  • Prefix asset types (e.g., "BG_", "SFX_", "CHAR_")
  • Avoid special characters and spaces (use underscores or camelCase)
  • Maintain consistent casing throughout the project

Version Control

Track changes, manage revisions, and collaborate safely with built-in version control.

Creating Versions

Save snapshots of your project at key milestones:

  • Click the version control icon in the workspace toolbar
  • Select "Create New Version"
  • Provide a descriptive name and notes about changes
  • Choose to include current state of all assets
  • Versions are automatically timestamped and attributed

Managing Versions

Review, restore, and compare different versions:

  • Version History: View a timeline of all saved versions
  • Restore: Revert to any previous version
  • Compare: See differences between versions
  • Tagging: Mark significant versions (e.g., "v1.0", "Beta Release")
  • Branching: Create experimental branches to test new features

Backup & Recovery

Protect your work with automatic backups and recovery options.

Automatic Backup System

BYR Lab automatically saves versions of your work:

  • Auto-save: Changes are saved every few minutes
  • Recovery Versions: Temporary snapshots created before major actions
  • Cloud Storage: All project data is securely stored in the cloud
  • Export: Download local backups of your project at any time

Recovering Lost Work

If you need to recover previous work:

  • Check the version history for saved milestones
  • Look for auto-save versions created during your session
  • Contact support if you need help recovering older versions
  • Regular exports provide additional safety for critical projects

Settings

Configure project-wide settings that affect behavior, appearance, and publishing.

General Settings

Basic project configuration options:

  • Project Name: Change the display name of your project
  • Description: Add or update project description
  • Thumbnail: Set the project preview image
  • Tags: Add searchable tags for discoverability
  • Default Scene: Choose which scene loads first

Technical Settings

Advanced configuration for project behavior:

  • Resolution: Adjust base canvas size and scaling behavior
  • Physics: Modify gravity, collision thresholds, and performance
  • Performance: Set quality levels, frame rate targets, and memory limits
  • Input: Configure keyboard, mouse, and touch controls
  • Audio: Adjust global audio settings and mixing

Tip:

Most settings can be changed at any time without affecting existing content. However, changes to physics or resolution may require adjustments to object placements and interactions.

Licenses

Define how others can use, modify, and distribute your projects. Selecting the appropriate license protects your work while setting clear expectations for users.

Available License Types

When publishing your project, you can choose from the following license options to control its usage:

License Permissions Requirements
All Rights Reserved
  • No sharing
  • No modification
  • No commercial use
 Standard copyright protection
Creative Commons Attribution (CC BY)
  • Sharing allowed
  • Modification allowed
  • Commercial use allowed
 Credit must be given to the original creator
MIT License
  • Sharing allowed
  • Modification allowed
  • Commercial use allowed
 No credit required

Important Considerations:

  • Licenses apply to the project as a whole, including all original assets. Derivative works must comply with all asset licenses.
  • Once published, the license cannot be changed retroactively for distributed copies
  • Always verify asset licenses before incorporating them into your project

Legal Protection:

License violations (unauthorized distribution, selling, or piracy) will be reported to appropriate authorities and may result in legal action.

Team Collaboration

Work together with your friends on shared projects.

Inviting Team Members

To collaborate on a project:

  1. Open your project in the workspace
  2. Click the "Collaborators" button in the top toolbar
  3. Enter the username or email of the person you want to invite
  4. Select their permission level (View, Edit, or Admin)
  5. Send the invitation

Real-time Collaboration Features

When multiple people are working on the same project:

  • Live Cursors: See where other team members are working
  • Selection Highlighting: View what objects others have selected
  • Chat Integration: Communicate within the workspace
  • Change History: Track who made which changes
  • Conflict Resolution: Automatic merging for most changes

Best Practice:

For large teams, establish naming conventions and organizational structures early to avoid confusion.

Permissions & Roles

Control what different team members can do in your projects.

Permission Levels

Role Permissions Best For
Viewer Can view and test the project, but cannot make changes Clients, stakeholders, testers
Editor Can edit project content, but cannot change settings or invite others Team members, contributors
Admin Full access including settings changes, inviting collaborators, and publishing Project leads, owners

Permission Management

Permissions can be adjusted at any time:

  • Upgrade or downgrade team member permissions
  • Remove collaborators from projects
  • Set time-limited access for temporary collaborators
  • Review permission history for audit purposes

Publishing Process

Make your projects available to others through BYR Lab's publishing system.

Before Publishing

Complete these checks before publishing your project:

  • Testing: Thoroughly test all features and interactions
  • Performance: Ensure your project runs smoothly on target devices
  • Content Review: Check for any placeholder content or incomplete features
  • Metadata: Add descriptive title, description, and tags
  • Thumbnail: Create an eye-catching thumbnail image

Visibility Options

Choose how your project is shared:

  • Public: Visible to everyone and listed in search results
  • Unlisted: Accessible only to people with the direct link
  • Private: Only visible to you and your collaborators
  • Password Protected: Requires a password to access

Publishing Steps

  1. Click the "Publish" button in the workspace toolbar
  2. Review project settings and metadata
  3. Select visibility options
  4. Choose whether to allow comments and ratings
  5. Confirm publishing

Sharing Options

Different ways to share your published projects with others.

Direct Links

Every published project gets a unique URL that can be shared anywhere:

  • Share via email or messaging apps
  • Post on social media platforms
  • Include in portfolios or resumes
  • Embed in websites or blogs

Social Features

Engage with the BYR Lab community through social features:

  • Collections: Group related projects together
  • Following: Follow creators to see their new projects
  • Likes & Comments: Receive feedback from the community
  • Project Forks: Allow others to create their own versions

Blueprint System

Create complex behaviors and interactions without writing code.

What is the Blueprint System?

The Blueprint System is BYR Lab's visual scripting environment that allows you to create interactive behaviors by connecting nodes in a graph editor.

Key Concepts

  • Nodes: Individual actions or functions
  • Connections: Lines that define the flow between nodes
  • Events: Triggers that start a sequence of actions
  • Variables: Storage for values that can change during runtime
  • Functions: Reusable groups of nodes

Common Use Cases

The Blueprint System can be used for:

  • Character movement and controls
  • Game mechanics and rules
  • UI interactions and menus
  • Animation triggers and sequences
  • Physics interactions and simulations

Common Issues

Solutions to frequently encountered problems when working with projects.

Performance Problems

If your project is running slowly:

  • Check object count: Too many objects can slow down performance
  • Optimize assets: Use compressed images and simplified 3D models
  • Review Blueprints: Inefficient logic can cause performance issues
  • Enable LOD: Use Level of Detail settings for 3D objects
  • Profile performance: Use the built-in performance profiler

Publishing Failures

If you can't publish your project:

  • Check file size: Projects have maximum size limits
  • Verify assets: Make sure all assets are properly imported
  • Review errors: Fix any errors shown in the error console
  • Check permissions: Ensure you have permission to publish
  • Try re-saving: Sometimes re-saving the project helps

Getting Help

Resources and support options for project-related issues.

Support Channels

If you need help with your projects:

  • Community Forums: Ask questions in the relevant community sections
  • Tutorials: Access step-by-step guides for common tasks
  • Documentation: Refer to official documentation for detailed information
  • Example Projects: Study existing projects to learn techniques
  • Contact Support: Reach out to BYR Lab support for specific issues

Before Asking for Help:

When seeking assistance, provide as much information as possible:

  • Project type and configuration
  • Steps to reproduce the issue
  • Error messages or screenshots
  • What you've already tried