SigmaOS Documentation

Getting Started

Introduction

SigmaOS is a modular fake operating system written in Python. Installation is simple - just download and run SigmaOS.py!

Installation

To get started:

Download SigmaOS.py from The404Company/SigmaOS
Run the file:

python SigmaOS.py

SigmaOS will automatically install all required dependencies

Basic Commands

System Commands

help - Show all available commands
exit or sigma quit - Exit SigmaOS
clear - Clear the screen
setup - Install essential packages
reset - Reset SigmaOS to default state
sysinfo - Show system information
now - Show current date and time
sendlogs - Send logs to the official Discord-Server
timer <number> <s|m|h> - Set timer in seconds, minutes or hours. Commands can be typed during countdown.

Keyboard Shortcuts

Tab - Auto-complete commands
Up/Down - Navigate command history
Left/Right - Move cursor
Ctrl+C - Interrupt current operation

Package System

Package Management

Manage packages using these commands:

ligma list - Show available packages
ligma install <pkg> - Install a package
ligma uninstall <pkg> - Remove a package
<package> - Run an installed package's main.py
<package>.<script> - Run a specific script in a package (e.g., yapper.config runs config.py)

Available Packages

BetaTask - System resource monitor and task manager
DoccX - Document viewer for files in documents directory
LigmaDev - Developer tools for creating SigmaOS packages
LigmaUpdate - Updates installed packages
OmegaNet - Network diagnostics and scanning tools
RhoSecure - Secure password manager with encryption
SigmaUpdate - Updates the SigmaOS system
Sourcerer - Install packages from external sources
Sucker - Install files from URLs
XiAI - AI ChatBot
yapper - Text editor for creating and editing files

Aliases

Alias Management

Create and manage command aliases:

alias list - Show all aliases
alias add <name> <cmd> - Create new alias
alias remove <name> - Delete alias

Community

Join The Community

Get involved with SigmaOS development:

Join our Discord Server to:
- Report bugs
- Submit packages to the official repository
- Join the development team
- Get help and support

Package Development

Create custom packages for SigmaOS using the LigmaDev toolkit and SigmaOS_core utilities.

Package Structure

Each package must contain:

main.py- Entry point executed by SigmaOS
description.txt- Package metadata and requirements

description.txt Format

[description]
Brief package description

[author]
Your name or username

[version]
1.0

[requirements]
colorama
requests
other_dependencies

requests is required for the suck() function in SigmaOS_core

Using SigmaOS_core

Download the SigmaOS_core file and copy-paste it into your package-folder.

Import core utilities in your package:

from SigmaOS_core import clear_screen, loading_animation, press_enter_to_continue, log, suck
from colorama import Fore, Style

Core Functions

clear_screen() - Clears the terminal screen
loading_animation(message, duration=2, task=None) - Shows loading animation with optional task
press_enter_to_continue() - Displays continue prompt
log(message) - Log important events and errors in a log-file. This data can be sent to the official Discord-Server by the user.
suck(url, save_to_documents=False, filename=None, hidden=False) - Download files from the internet with "flexible" save options.

File Download Function

The suck() function provides an easy way to download files from the internet with progress indication and flexible save options:

suck(url, save_to_documents=False, filename=None, hidden=False)

Parameters:

url - The URL of the file to download
save_to_documents - If True, saves the file to the ../../documents directory
filename - Optional custom filename. If not provided, uses the filename from the URL
hidden - If True, suppresses all output messages and progress indicators

Returns:

Path to the downloaded file on success
None if the download failed

Example usage:

# Download to current directory
suck("https://example.com/file.zip")

# Download to documents folder with custom name
suck("https://example.com/file.zip", save_to_documents=True, filename="my_file.zip")

# Silent download (no output)
suck("https://example.com/file.zip", hidden=True)

Best Practices

Always include clear_screen() at start
Show package banner/header
Use colorama for consistent styling
Handle keyboard interrupts gracefully
Provide clear user feedback
Place files in documents directory

Development Process

Use LigmaDev package to:

Create new package scaffolding
View example package structure
Access technical documentation

Testing

Put your package folder inSigmaOS/packages/directory
Launch SigmaOS and run your package by name
Test all features and error handling

Distribution

Once your package is ready, submit it to the official repository through ourDiscord Server.

Themes

Theme System

SigmaOS features a customizable theme system that allows you to change the colors of various UI elements. Themes are stored in the themes directory, and the current theme selection is stored in user.sigs.

Theme Management

Manage themes using these commands:

theme list - List all available themes
theme set <name> - Set a new theme (requires restart)
theme edit <name> [value] - Edit theme colors (all or specific value)
theme create <name> - Create a new theme
theme delete <name> - Delete a theme
theme show <name> - Show theme contents

Theme File Structure

Theme files are stored in the themes directory with the .sth extension. Here's an example of the default theme:

{
    "banner_sth": "cyan",
    "version_sth": "yellow",
    "success_sth": "green",
    "error_sth": "red",
    "warning_sth": "yellow",
    "info_sth": "cyan",
    "header_sth": "yellow",
    "command_sth": "green",
    "description_sth": "white",
    "author_sth": "cyan",
    "loading_sth": "cyan",
    "prompt_sth": "green",
    "suggestion_sth": "cyan",
    "relevance_sth": "blue",
    "system_info_sth": "yellow",
    "timer_sth": "green",
    "alias_sth": "green",
    "package_sth": "green",
    "package_version_sth": "cyan",
    "package_author_sth": "cyan",
    "package_description_sth": "white",
    "package_installed_sth": "green",
    "package_not_installed_sth": "yellow",
    "package_error_sth": "red",
    "package_loading_sth": "cyan",
    "package_skipped_sth": "yellow",
    "package_cleanup_sth": "green",
    "package_download_sth": "cyan",
    "package_install_sth": "cyan",
    "package_uninstall_sth": "yellow",
    "package_reset_sth": "red",
    "package_setup_sth": "cyan",
    "package_essential_sth": "green"
}

Available Colors

You can use any of the following color values in your theme (all colors from the colorama library):

black - Black text
blue - Blue text
cyan - Cyan text
green - Green text
magenta - Magenta text
red - Red text
white - White text
yellow - Yellow text
lightblack_ex - Light black text
lightblue_ex - Light blue text
lightcyan_ex - Light cyan text
lightgreen_ex - Light green text
lightmagenta_ex - Light magenta text
lightred_ex - Light red text
lightwhite_ex - Light white text
lightyellow_ex - Light yellow text

Customizing Themes

To customize your theme:

Create a new .sth file in the themes directory
Edit the color values to your preferred colors
Use theme set <name> to apply your theme
Restart SigmaOS to apply the changes

Theme Variables

Each theme variable controls a specific aspect of SigmaOS's interface:

banner_sth - Banner box and lines
command_sth - Commands, sigma symbol, and SigmaOS text
version_sth - Version number
description_sth - General text and descriptions
success_sth - Success messages
error_sth - Error messages
warning_sth - Warning messages
info_sth - Information messages
header_sth - Section headers
prompt_sth - Command prompt
loading_sth - Loading animations
timer_sth - Timer display
suggestion_sth - Command suggestions
relevance_sth - Suggestion relevance
alias_sth - Alias commands
system_info_sth - System information
package_sth - Package names
package_status_sth - Package status (installed, version, etc.)
package_error_sth - Package errors