Documentation

Introduction

StreamOS is a high-performance virtual desktop environment designed specifically for broadcasters and content creators. It functions as a mini operating system within your stream, providing tools for window management, pet interaction, task tracking, and persistent cloud storage.

Account Setup

To begin using StreamOS, you must first make an account at StreamOS. Click the login button at the top right and login with Discord. Once you are logged in you need to head over to your Dashboard and Click Setup Account.

• Choose a unique username and a secure password.
• Your account is automatically linked to your subscription tier.
• Use these credentials to log in to the StreamOS environment via your OBS browser source.

Browser Source Setup

Open your any streaming software that supports Interactable Browser Sources. Add a new Browser Source and fill out the following information.

• URL: overlay.streamos.cloud
• Width: 1920
• Height: 1080
• Custom CSS: Delete anything in this box.
• 1920x1080 is used as an example. StreamOS supports any 16:9 screen resolution

To interact with the Browser Source you need to right click it and select Interact.

Core Features

Files App

The Files app is the heart of your data management. You can upload media, organize folders, and manage your Virtual File System (VFS).

• Uploading: Click the 📄+ icon to upload images (.pic), videos (.vid), or music (.tune).
• Folders: Use 📁+ to create directories and drag files to move them.
• Backgrounds: Click and hold a .pic file and select "Set as Background".

Chat & Integration

StreamOS integrates directly with your Twitch or YouTube chat, allowing you and your viewers to interact with the overlay.

• Commands: Control your pet with !feed, !water, and !pet.
• Remote Open: Allow viewers to open files on your screen using !filename.papr (if enabled).
• Terminal: Run system commands via !cmd <command>.

Social Network

Connect with other StreamOS creators through the built-in social platform.

• Feed: Share updates and media with your followers.
• Messaging: Real-time group chats and direct messages.
• Profiles: Customize your bio and avatar to stand out in the community.

Writing with Paper

Paper is a professional rich-text editor for scripts, notes, and documents.

• Formatting: Use the toolbar for bold, italic, colors, and headings.
• Saving: Files are saved with the .papr extension and synced to the cloud.
• Opening: Open .papr files directly from the Files app or within Paper.

Music & Playlists

Listen to your music and watch your pet dance along!

• Adding Songs: Upload MP3 files via the Files app; they automatically become .tune files.
• Playlists: Create lists and add songs from your "All Tunes" library.
• Pet Sync: If enabled, Spot will automatically dance when music is playing.

Interacting with Spot (The Pet)

Spot lives on your desktop and interacts with your stream in real-time.

• Needs: Spot has Hunger and Thirst. If neglected, Spot may throw a "tantrum".
• Feeding: Fill bowls by clicking them or via chat commands like !feed and !water.
• Customization: Change Spot's name, type (Slime, Robot, Ghost), and color in Settings.

Customizing your Theme

Navigate to Settings > Display to customize your experience.

• Colors: Use color pickers for Primary Glow, Glass Backgrounds, and Text.
• Presets: Save "Theme Presets" to quickly swap between different styles.

Stream Overlays (Stream Control)

Create and trigger fullscreen overlays (Starting Soon, BRB, etc.) directly from the Stream Control app.

Terminal

For power users, the Terminal provides a command-line interface to manage the system.

• Navigation: Use ls to list files and cd to change directories.
• Apps: Use lsapps to see available applications and open <app> to launch them.
• Scenes: Quickly switch stream layouts with the scene <name> command.

Cloud Synchronization

StreamOS automatically syncs your data every 5 seconds. Look for the Cloud Icon at the bottom right:

• Blue/Theme Color: Synced and up to date.
• Yellow: Syncing changes...
• Red: Connection error.

Storage & Tiers

Your storage capacity is determined by your subscription plan.

Updates & Maintenance

System Updates: When an update is available, a breathing icon will appear. Clicking it will refresh your session.

Factory Reset: Found in Settings > Reset. This clears all local cache and settings. Warning: This cannot be undone.