Skip to main content

URL Parameters

Bilup supports URL parameters that let you load projects and adjust runtime and compiler behavior. These are useful for embedding, automation, and sharing reproducible setups.

Basic Usage​

URL Parameter Syntax​

Add parameters using standard query string format:

https://editor.bilup.org/?parameter1&parameter2=value&parameter3=value

Multiple Parameters​

Combine multiple parameters with &:

https://editor.bilup.org/?turbo&fps=60&username=alice&autoplay

Project Loading​

Load by ID​

Load a Scratch project by its ID:

https://editor.bilup.org/123456789

Load from URL​

Load a project from a direct URL:

https://editor.bilup.org/?project_url=https://example.com/project.sb3

Auto-start (embed only)​

Automatically start the project in embeds:

https://editor.bilup.org/123456789?autoplay

Username​

Set the username used by cloud variables and blocks:

https://editor.bilup.org/123456789?username=alice

Performance​

Turbo Mode​

Enable high-speed execution:

https://editor.bilup.org/?turbo

Frame Rate​

Set custom frame rate:

https://editor.bilup.org/?fps=60     # 60 FPS
https://editor.bilup.org/?fps=120    # 120 FPS
https://editor.bilup.org/?fps=30     # 30 FPS (default)

High Quality Pen​

Enable anti-aliased pen rendering:

https://editor.bilup.org/?hqpen

Interpolation​

Enable frame interpolation for smoother motion:

https://editor.bilup.org/?interpolate

Remove Misc Limits​

Disable certain runtime limits:

https://editor.bilup.org/?limitless

Display​

Custom Stage Size​

Set custom stage dimensions:

https://editor.bilup.org/?size=800x600
https://editor.bilup.org/?size=1920x1080

Fullscreen Background (player-only)​

Control fullscreen background color:

https://editor.bilup.org/?fullscreen-background=%23abc123

Offscreen Fencing​

Disable offscreen fencing:

https://editor.bilup.org/?offscreen

Clone Limit​

Set maximum clones:

https://editor.bilup.org/?clones=300

Extensions​

Load Extensions​

Load custom extensions by URL (unsandboxed recommended):

https://editor.bilup.org/?extension=https://example.com/ext.js
https://editor.bilup.org/?extension=https://example.com/other.js

Addons (embed only)​

Enable specific addons in embeds:

https://editor.bilup.org/123456789/embed?addons=pause,gamepad

Embedding​

Autoplay and Addons​

Embed-specific options:

https://editor.bilup.org/123456789/embed?autoplay
https://editor.bilup.org/123456789/embed?addons=pause,gamepad

Development​

Disable Compiler​

Turn off the compiler (for debugging):

https://editor.bilup.org/?nocompile

Project URL​

Load project data from a direct URL:

https://editor.bilup.org/?project_url=https://example.com/project.sb3

Cloud Host (embed/player)​

Override cloud server:

https://editor.bilup.org/?cloud_host=wss://clouddata.turbowarp.org

Reference​

Complete Parameter Reference​

Performance​

ParameterValuesDescription
turbobooleanEnable turbo mode
fpsnumberSet frame rate
hqpenbooleanHigh quality pen
interpolatebooleanEnable interpolation
limitlessbooleanDisable misc limits
stuckbooleanEnable warp timer (player-only)

Display​

ParameterValuesDescription
sizeWIDTHxHEIGHTCustom stage size
fullscreen-backgroundCSS colorFullscreen background color
offscreenbooleanDisable offscreen fencing

Project​

ParameterValuesDescription
usernamestringUsername
project_urlURLLoad from URL

Extensions​

ParameterValuesDescription
extensionURLLoad extension by URL

Development​

ParameterValuesDescription
nocompilebooleanDisable compiler
cloud_hostwss://...Custom cloud host

URL Parameter Examples​

Gaming Setup​

Optimized for games:

https://editor.bilup.org/123456789?turbo&fps=60&interpolate

Educational Embedding​

Clean embed for education:

https://editor.bilup.org/123456789/embed?autoplay&size=800x600

Development Testing​

Development environment:

https://editor.bilup.org/?turbo&fps=120&hqpen

High Performance​

Maximum performance:

https://editor.bilup.org/?turbo&fps=120&hqpen

Accessible Mode​

Use OS/browser accessibility features. Theme is controlled in the UI, not via URL.

URL Encoding​

Special Characters​

Encode special characters in URLs:

Space: %20
#: %23
&: %26
=: %3D

Example with Encoding​

https://editor.bilup.org/?fps=60&hqpen

JavaScript URL Manipulation​

Reading Parameters​

const urlParams = new URLSearchParams(window.location.search);
const turboMode = urlParams.has('turbo');
const fps = urlParams.get('fps') || '30';

Setting Parameters​

const url = new URL(window.location);
url.searchParams.set('fps', '60');
url.searchParams.set('turbo', '');
window.history.pushState({}, '', url);

Building URLs Programmatically​

function buildBilupURL(projectId, options = {}) {
  const url = new URL(`https://editor.bilup.org/${projectId}`);
  
  Object.entries(options).forEach(([key, value]) => {
    if (value === true) {
      url.searchParams.set(key, '');
    } else if (value !== false && value !== null) {
      url.searchParams.set(key, value);
    }
  });
  
  return url.toString();
}

// Usage
const gameURL = buildBilupURL('123456789', {
  turbo: true,
  fps: 60,
  interpolate: true
});

Best Practices​

URL Length​

  • Keep URLs reasonable length (under 2000 characters)
  • Use essential parameters only
  • Consider using short parameter names

User Experience​

  • Provide sensible defaults
  • Use autoplay sparingly
  • Test URLs thoroughly

Performance​

  • Combine compatible performance parameters
  • Test performance impact of parameter combinations
  • Monitor for conflicts between parameters

URL parameters provide powerful customization capabilities for Bilup. Use them to create tailored experiences for different users and use cases!