Loom

A fast, minimal, and customizable text editor.

Built with C++ and Qt, featuring Lua scripting for configuration and plugins

Features

Professional Text Editing - Powered by KDE's KTextEditor framework used in Kate and KDevelop
Advanced Syntax Highlighting - KSyntaxHighlighting engine with 300+ language definitions
21 Unified Themes - Consistent styling across UI and syntax highlighting with modern scroll bars
Theme Switching - Toggle between themes with Ctrl+Shift+T or Tools menu
Multi-Tab Interface - Clean tab interface with no distracting mnemonics or underlines
File Tree Viewer - Navigate project directories with a collapsible file tree panel
Project Support - Open entire project directories and navigate files easily
Modern Interface - Sleek 8px transparent scroll bars with no pixelated minimap
Lightweight & Fast - Minimal resource usage with responsive text editing
Customizable Keybindings - Configure shortcuts to match your workflow
Line Numbers - Optional line number display with relative numbering
Find & Replace - Built-in search and replace functionality powered by KTextEditor
Integrated Live Server - Built-in HTTP server with hot reload for web development

Syntax Highlighting

Loom features optimized syntax highlighting powered by KDE's KSyntaxHighlighting framework, providing smooth, fast, and comprehensive language support with beautiful, customizable colors.

KTextEditor & KSyntaxHighlighting System

Professional text editing powered by KDE Frameworks with comprehensive syntax highlighting and modern editing features.

Loom integrates two powerful KDE Framework components:

KTextEditor: Advanced text editing engine used by Kate and KDevelop
KSyntaxHighlighting: Professional syntax highlighting with 300+ language definitions

Supported Languages & Formats (300+):

Programming Languages: C/C++, Python, JavaScript/TypeScript, Java, Rust, Go, Lua, PHP, Ruby, Swift, Kotlin, Scala, Haskell, Erlang, Elixir, Clojure, Scheme, R, Julia, MATLAB, Perl, Shell/Bash, PowerShell, SQL, GraphQL, YAML, TOML, XML
Web Technologies: HTML, CSS, SCSS/Sass, Less, JavaScript, TypeScript, JSX, TSX, Vue, Svelte, Pug, Haml, ERB, ASP.NET, JSP
Data Formats: JSON, XML, YAML, TOML, CSV, INI, Properties, HOCON, EDN
Markup Languages: Markdown, reStructuredText, AsciiDoc, Textile, MediaWiki, LaTeX, TeX, BibTeX
Configuration Files: INI, Properties, HOCON, TOML, YAML, JSON
Scripting Languages: Lua, Python, Ruby, Perl, PHP, Tcl, Awk, Sed
System Languages: C/C++, Rust, Go, Swift, Objective-C, Assembly
Functional Languages: Haskell, Scala, Clojure, Erlang, Elixir, F#, OCaml
Scientific Languages: R, Julia, MATLAB, Mathematica, Sage
Database Languages: SQL, PL/SQL, T-SQL, PostgreSQL, MySQL
Build Systems: Makefile, CMake, Ninja, Gradle, Maven, Ant
And 200+ more languages and formats...

KTextEditor Features:

Advanced Editing - Professional text manipulation and navigation
Modern Interface - Clean, distraction-free editing environment
Performance Optimized - Handles large files efficiently
Extensible Framework - Battle-tested by KDE applications

KSyntaxHighlighting Features:

High Performance - Optimized rendering with minimal resource usage
Comprehensive Support - 300+ languages and file formats
Theme Integration - Seamless integration with Loom's unified theme system
Real-time Updates - Instant color changes without restart
Professional Quality - Used by Kate, KDevelop, and other KDE applications

Unified Theme System

Loom features a single unified theme system that applies consistent styling across both the application UI and syntax highlighting. No separate configuration is needed - one theme setting controls everything.

Theme Configuration (`config/config.lua`)

Configure your theme with a single setting:

theme = {
    name = "gruvbox Dark" -- Single unified theme for both app UI and syntax highlighting
    -- Available themes: "Atom One Dark", "Atom One Light", "Breeze Dark", "Breeze Light",
    --                   "Dracula", "Falcon", "GitHub Dark", "GitHub Light", "Monokai",
    --                   "Nord", "Oblivion", "Printing", "Radical", "Solarized Dark",
    --                   "Solarized Light", "Vim Dark", "ayu Dark", "ayu Light",
    --                   "ayu Mirage", "gruvbox Dark", "gruvbox Light"
}

Available Unified Themes

Loom supports 21 built-in themes that provide consistent styling for both the application interface and code syntax highlighting:

Dark Themes:

Atom One Dark - GitHub's Atom editor dark theme
Breeze Dark - KDE's elegant dark theme
Dracula - Popular dark theme with purple accents
Falcon - Unique dark theme with orange highlights
GitHub Dark - GitHub's modern dark interface
Monokai - Classic dark theme with bright colors
Nord - Arctic-inspired blue-tinted dark theme
Oblivion - High-contrast dark theme
Radical - Cyberpunk-inspired dark theme with neon accents
Solarized Dark - Low-contrast scientific dark theme
Vim Dark - Traditional terminal-inspired dark theme
ayu Dark - Modern dark theme with muted colors
ayu Mirage - Ayu's balanced dark variant
gruvbox Dark - Retro groove dark theme (default)

Light Themes:

Atom One Light - Clean and minimal light theme
Breeze Light - KDE's bright and airy light theme
GitHub Light - GitHub's clean light interface
Solarized Light - Scientific light theme with warm tones
ayu Light - Bright and modern light theme
gruvbox Light - Warm retro light variant

Special Purpose:

Printing - High-contrast theme optimized for printing documents

Theme Features

Each theme provides:

Consistent UI Styling - Menus, dialogs, tabs, and scroll bars match the theme
Syntax Highlighting - Code colors are perfectly coordinated with the UI
Modern Scroll Bars - Sleek 8px transparent scroll bars with theme-specific accents
Clean Interface - No distracting minimaps or visual clutter
Accessibility - Proper contrast ratios and readable color combinations

Switching Themes

Change themes instantly without restart:

Via Configuration: Edit config/config.lua and save
Via Plugin: Use the Theme Switcher plugin (Ctrl+Shift+T)
Via Menu: File → Theme Switcher (if plugin is loaded)

Plugin System

Extensible Architecture - Lua-based plugin system for unlimited customization
Theme Switcher Plugin - Easy theme switching with keyboard shortcuts and menu integration
AutoSave Plugin - Automatic file saving with configurable intervals
AutoFormat Plugin - Code formatting with external formatters (clang-format, prettier, black, stylua, rustfmt)
Plugin Management - Easy loading, configuration, error recovery, and dynamic menu updates

⚠️ IMPORTANT: The AutoFormat plugin requires external formatting tools to be installed on your system! Run ./scripts/install_formatters.sh to install all required formatters automatically.

Configuration System

Lua-Based Config - Powerful configuration through config/config.lua
Runtime Configuration - Change settings without restarting the editor
Plugin Configuration - Individual plugin settings and toggles
Keybinding Customization - Define custom keyboard shortcuts
Editor Settings - Font, theme, tab width, line numbers, and more

Quick Start

Prerequisites

Before building Loom, ensure you have the following installed:

CMake 3.16 or higher
Qt5 development libraries
Lua 5.3 or 5.4 development libraries
KTextEditor and KSyntaxHighlighting from KDE Frameworks
C++17 compatible compiler (GCC, Clang, or MSVC)

Installation

Linux (Ubuntu/Debian) - DEB Package (Recommended)

# Download the latest DEB package from GitHub releases
wget https://github.com/dexter-xd/loom/releases/download/beta_1.3.0/loom_1.3.0_amd64.deb

# Install the package
sudo dpkg -i loom_1.3.0_amd64.deb
sudo apt-get install -f  # Fix any dependency issues

# Run Loom
loom

Linux (Ubuntu/Debian) - Build from Source

# Install dependencies
sudo apt update
sudo apt install cmake qtbase5-dev liblua5.4-dev build-essential \
                 libkf5texteditor-dev libkf5syntaxhighlighting-dev

# Clone the repository
git clone https://github.com/dexter-xd/loom.git
cd loom

# Build using the provided script
chmod +x scripts/build_release.sh
./scripts/build_release.sh

# Run Loom
./scripts/run_loom.sh

Linux (Fedora/RHEL)

# Install dependencies
sudo dnf install cmake qt5-qtbase-devel lua-devel gcc-c++ \
                 kf5-ktexteditor-devel kf5-syntax-highlighting-devel

# Clone and build
git clone https://github.com/dexter-xd/loom.git
cd loom
chmod +x scripts/build_release.sh
./scripts/build_release.sh

macOS

# Install dependencies with Homebrew
brew install cmake qt@5 lua kde-frameworks

# Clone and build
git clone https://github.com/dexter-xd/loom.git
cd loom
chmod +x scripts/build_release.sh
./scripts/build_release.sh

Build Options

Using Build Scripts (Recommended)

Release Build (Optimized)

./scripts/build_release.sh

Debug Build (Development)

./scripts/build_debug.sh

Running Loom

# Recommended way (suppresses Qt warnings)
./scripts/run_loom.sh [optional-file-path]

# Direct execution
./build/loom [optional-file-path]

Manual Build

# Create build directory
mkdir build && cd build

# Configure with CMake
cmake -DCMAKE_BUILD_TYPE=Release ..

# Build the project
cmake --build . -j$(nproc)

# Run the editor
./loom

Important: External Formatters for AutoFormat Plugin

The AutoFormat plugin requires external formatting tools to be installed on your system. The plugin uses these external formatters to provide professional code formatting:

clang-format - For C/C++ code formatting
prettier - For JavaScript, TypeScript, JSON, HTML, CSS formatting
black - For Python code formatting
stylua - For Lua code formatting
rustfmt - For Rust code formatting (comes with Rust toolchain)

Quick Formatter Installation

I provide an automated installation script for all required formatters:

# Make the script executable and run it
chmod +x scripts/install_formatters.sh
./scripts/install_formatters.sh

The script will:

Detect your operating system (Linux, macOS)
Install system packages (clang-format, Node.js, Python)
Install npm packages (prettier)
Install Python packages (black)
Install Rust packages (stylua) if Cargo is available
Show you which formatters are installed and which are missing

Manual Installation

If you prefer manual installation:

# Ubuntu/Debian
sudo apt install clang-format nodejs npm python3-pip
npm install -g prettier
pip3 install black
cargo install stylua  # if you have Rust installed

# macOS (with Homebrew)
brew install clang-format node python
npm install -g prettier
pip3 install black
cargo install stylua  # if you have Rust installed

# Fedora/RHEL
sudo dnf install clang-tools-extra nodejs npm python3-pip
npm install -g prettier
pip3 install black
cargo install stylua  # if you have Rust installed

Note: The AutoFormat plugin will automatically detect which formatters are available and only format files for languages where the corresponding formatter is installed.

Configuration System

Loom uses a powerful Lua-based configuration system that allows you to customize every aspect of the editor.

Configuration Structure

config/
└── config.lua          # Main configuration file
plugins/
├── autoformat.lua      # Auto-formatting plugin
└── autosave.lua       # Auto-save plugin

Main Configuration (`config/config.lua`)

The main configuration file controls editor behavior, appearance, and keybindings:

config = {
    -- Editor Settings
    editor = {
        font_family = "JetBrains Mono",
        font_size = 12,
        tab_width = 8,
        show_line_numbers = true,
        word_wrap = true,
        auto_indent = true,
        highlight_current_line = true
    },
    
    -- Theme Settings
    theme = {
        name = "gruvbox" -- Options: "gruvbox", "dracula", "catppuccin-mocha"
    },

    -- Window Settings
    window = {
        width = 1224,
        height = 768,
        remember_size = true,
        remember_position = true
    },

    -- Keybindings
    keybindings = {
        ["Ctrl+S"] = "save_file",
        ["Ctrl+O"] = "open_file",
        ["Ctrl+N"] = "new_file",
        ["Ctrl+T"] = "new_tab",
        ["Ctrl+W"] = "close_file",
        ["Ctrl+Q"] = "quit_application",
        ["Ctrl+Z"] = "undo",
        ["Ctrl+Y"] = "redo",
        ["Ctrl+C"] = "copy",
        ["Ctrl+V"] = "paste",
        ["Ctrl+X"] = "cut",
        ["Ctrl+A"] = "select_all",
        ["Ctrl+F"] = "find",
        ["Ctrl+H"] = "replace",
        ["F11"] = "toggle_fullscreen",
        ["F12"] = "toggle_file_tree",         -- File tree panel toggle
        ["Ctrl+Shift+T"] = "toggle_theme",    -- Theme switching
        ["Ctrl+Shift+F"] = "format_document", -- Document formatting
        -- Add your custom keybindings here
    },

    -- Plugin Configuration
    plugins = {
        enabled = true,
        auto_load = true,
        error_recovery = true,
        
        -- Individual plugin settings
        theme_switcher = {
            enabled = true,
            auto_load = true
        },
        
        autosave = {
            enabled = false,
            interval = 10, -- seconds
            save_on_focus_lost = false
        },
        
        autoformat = {
            enabled = true,
            auto_load = true,
            format_on_save = true,
            use_external_formatters = true
        }
    }
}

Configuration Functions

The configuration system provides helper functions:

-- Get configuration value with fallback
local font_size = get_config("editor.font_size", 12)

-- Set configuration value
set_config("editor.font_size", 14)

Plugin System

Loom features a robust plugin system powered by Lua scripting. Plugins can extend functionality, add new features, and integrate with external tools.

Available Plugins

Theme Switcher Plugin (`plugins/theme_switcher.lua`)

Provides easy theme switching functionality with multiple beautiful themes.

Features:

Toggle between available themes with Ctrl+Shift+T
Access via Tools → Toggle Theme menu
Supports three themes: Gruvbox, Dracula, and Catppuccin Mocha
Automatic theme cycling (wraps around to first theme)
Config updates when theme changes
Plugin metadata with version tracking

Available Themes:

Gruvbox: Warm, retro groove colors with excellent contrast
Dracula: Dark theme with vibrant purple and pink accents
Catppuccin Mocha: Soothing pastel colors on a dark background

Configuration:

plugins = {
    theme_switcher = {
        enabled = true,     -- Enable/disable theme switcher
        auto_load = true    -- Load plugin on startup
    }
}

-- Set default theme
theme = {
    name = "gruvbox"  -- Options: "gruvbox", "dracula", "catppuccin-mocha"
}

Usage:

Keyboard: Press Ctrl+Shift+T to cycle through themes
Menu: Go to Tools → Toggle Theme
Config: Set default theme in config.lua
Lua Console: Call toggle_theme() or switch_to_theme("theme_name")

AutoSave Plugin (`plugins/autosave.lua`)

Automatically saves your files at regular intervals to prevent data loss.

Features:

Configurable save interval (default: 30 seconds)
Smart saving (only saves when content changes)
Status bar integration
Save counter and timestamps

Configuration:

plugins = {
    autosave = {
        enabled = true,           -- Enable/disable autosave
        interval = 30,           -- Save interval in seconds
        save_on_focus_lost = false, -- Save when window loses focus
        backup_files = false     -- Create backup files
    }
}

Usage:

Automatically runs in the background when enabled
View status: Check status bar for save count and last save time
Toggle: Use Lua console to call autosave.toggle()

AutoFormat Plugin (`plugins/autoformat.lua`)

Automatically formats your code using external formatters for consistent code style.

Supported Languages & Formatters:

C/C++: clang-format (Google style)
JavaScript/TypeScript: prettier
JSON: prettier
HTML/CSS: prettier
Lua: stylua
Python: black
Rust: rustfmt

Features:

Format on save (configurable)
Manual formatting command
External formatter integration
Language auto-detection
Cursor position preservation

Configuration:

plugins = {
    autoformat = {
        enabled = true,                    -- Enable/disable plugin
        auto_load = true,                  -- Load plugin on startup
        format_on_save = true,            -- Format when saving files
        use_external_formatters = true    -- Use external tools
    }
}

Required External Tools:

# Install formatters as needed
npm install -g prettier          # JavaScript/TypeScript/JSON/HTML/CSS
pip install black               # Python
cargo install stylua           # Lua
# clang-format usually comes with clang
# rustfmt comes with Rust toolchain

Usage:

Keyboard: Press Ctrl+Shift+F to format current document
Menu: Go to Tools → Format Document
Automatic: Enable format_on_save in configuration
Lua Console: Call autoformat.format_document()
Status: Use autoformat.show_status() to see available formatters

Plugin Management

Loading Plugins

Plugins are automatically loaded from the plugins/ directory on startup. The plugin manager:

Scans for .lua files in the plugins directory
Validates plugin structure
Initializes plugins with error recovery
Provides status reporting

Plugin Configuration

Each plugin can be configured in the main config.lua file:

plugins = {
    enabled = true,        -- Global plugin system toggle
    auto_load = true,      -- Load plugins on startup
    error_recovery = true, -- Continue loading other plugins if one fails
    
    -- Plugin-specific settings
    plugin_name = {
        enabled = true,
        -- plugin-specific options
    }
}

Creating Custom Plugins

Create a new .lua file in the plugins/ directory:

-- my_plugin.lua
my_plugin = {
    name = "my_plugin",
    version = "1.0",
    description = "My custom plugin",
    enabled = true
}

-- Initialize plugin
function my_plugin.initialize()
    print("My plugin initialized!")
    
    -- Register event handlers
    events.connect("file_saved", "my_plugin.on_file_saved")
end

-- Cleanup plugin
function my_plugin.cleanup()
    print("My plugin cleaned up!")
end

-- Event handler
function my_plugin.on_file_saved(event_name, file_path)
    print("File saved: " .. file_path)
end

-- Make event handler globally accessible
_G["my_plugin.on_file_saved"] = my_plugin.on_file_saved

print("My plugin loaded!")

Live Server Integration

Loom includes an integrated HTTP server with hot reload functionality for web development, similar to VS Code's Live Server extension.

Features

Hot Reload: Automatically reloads the browser when HTML, CSS, or JS files change
WebSocket Integration: Real-time communication for instant updates
File Watching: Efficient file system monitoring using inotify
Menu Integration: Start/stop server directly from the Tools menu
Smart Directory Detection: Automatically serves the current file's directory
Browser Integration: One-click browser opening
Configurable Logging: Choose between quiet, normal, or verbose output

Usage

Start Live Server: Go to Tools → Start Live Server or use the keyboard shortcut
Edit Files: Make changes to your HTML, CSS, or JavaScript files
Auto Reload: The browser automatically refreshes when you save files
Stop Server: Go to Tools → Stop Live Server when done

Configuration

Configure the live server in config/config.lua:

live_server = {
    enabled = true,
    port = "8080",
    auto_open_browser = false,
    default_directory = "", -- empty means use current file's directory
    executable_path = "", -- empty means use live-server from same directory as loom executable
    log_level = "quiet" -- "quiet", "normal", or "verbose"
}

Log Level Options:

"quiet" - Only show errors (default, recommended for production)
"normal" - Standard server output (startup messages, basic info)
"verbose" - Detailed debug output (file watching, WebSocket events)

Build Options

The live-server can be built with or without integration:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
make -C build -j$(nproc)

Standalone Usage

The live-server can also be used independently:

# Build standalone live-server
cd live-server
make

# Run standalone
./build/live-server -d ./my-website -p 3000 -v

Theming

Loom now supports multiple beautiful themes that you can switch between easily.

Available Themes

Gruvbox (Default)

A warm, retro groove color scheme providing comfortable dark theme optimized for long coding sessions.

Background: Dark variants (#282828, #1d2021, #3c3836)
Foreground: Light variants (#ebdbb2, #fbf1c7, #d5c4a1)
Accents: Red, Green, Yellow, Blue, Purple, Aqua, Orange

Dracula

A dark theme with vibrant purple and pink accents, popular among developers.

Background: Dark purple (#282a36, #44475a)
Foreground: Light variants (#f8f8f2, #6272a4)
Accents: Purple, Pink, Green, Orange, Red, Yellow

Catppuccin Mocha

A soothing pastel theme with warm colors on a dark background.

Background: Dark variants (#1e1e2e, #313244, #45475a)
Foreground: Light variants (#cdd6f4, #bac2de)
Accents: Soft pastels in various hues

Theme Switching

Change themes instantly without restarting:

Keyboard Shortcut: Press Ctrl+Shift+T to cycle through themes
Tools Menu: Go to Tools → Toggle Theme

Configuration: Set default theme in config.lua:

theme = {
    name = "gruvbox"  -- Options: "gruvbox", "dracula", "catppuccin-mocha"
}

Lua Console: Call theme functions directly:

toggle_theme()                    -- Cycle to next theme
switch_to_theme("dracula")       -- Switch to specific theme
get_current_theme()              -- Get current theme name
list_themes()                    -- List available themes

Theme Customization

Themes are defined in themes/*.qss files using Qt stylesheets. You can customize:

Color values for any theme
Font settings (though fonts are controlled by configuration)
UI element styling
Tab appearance
Scrollbar design
Syntax highlighting colors

Keybindings

Default Keybindings

Shortcut	Action
`Ctrl+N`	New file
`Ctrl+O`	Open file
`Ctrl+S`	Save file
`Ctrl+T`	New tab
`Ctrl+W`	Close current file
`Ctrl+Q`	Quit application
`Ctrl+Z`	Undo
`Ctrl+Y`	Redo
`Ctrl+C`	Copy
`Ctrl+V`	Paste
`Ctrl+X`	Cut
`Ctrl+A`	Select all
`Ctrl+F`	Find
`Ctrl+H`	Replace
`F11`	Toggle fullscreen
`F12`	Toggle file tree
`Ctrl+Shift+T`	Toggle theme
`Ctrl+Shift+F`	Format document

Custom Keybindings

Add custom keybindings in config/config.lua:

keybindings = {
    ["Ctrl+Shift+T"] = "toggle_theme",     -- Theme switching
    ["Ctrl+Shift+F"] = "format_document",  -- Document formatting
    ["Ctrl+/"] = "toggle_comment",         -- Comment toggling
    ["Ctrl+D"] = "duplicate_line",         -- Line duplication
    -- Add your custom bindings here
}

Development

Project Structure

loom/
├── src/                    # Main source code
│   ├── main.cpp           # Application entry point
│   ├── editor_window.cpp  # Main window and UI logic
│   ├── code_editor.cpp    # KTextEditor integration
│   ├── buffer.cpp         # File buffer management
│   ├── lua_bridge.cpp     # Lua scripting interface
│   ├── plugin_manager.cpp # Plugin system
│   └── file_tree_widget.cpp # File tree sidebar
├── include/               # Header files
├── config/               # Lua configuration files
├── plugins/              # Lua plugins
├── themes/               # Qt stylesheet themes (21 themes)
├── test_files/           # Sample files for testing KTextEditor

External Dependencies

Loom uses KTextEditor and KSyntaxHighlighting from KDE Frameworks for professional-grade text editing and syntax highlighting:

KTextEditor

KF5TextEditor: Advanced text editing component from KDE Frameworks
Provides professional text editing features like advanced search/replace, bookmarks, and text manipulation
Powers the main editor interface with modern editing capabilities
Used by Kate, KDevelop, and other KDE applications

KSyntaxHighlighting

KF5SyntaxHighlighting: Comprehensive syntax highlighting engine
Provides 300+ language definitions and syntax highlighting themes
Powers the unified theme system with consistent styling
Lightweight and optimized for performance

Installing KDE Framework Dependencies

Ubuntu/Debian:

sudo apt install libkf5texteditor-dev libkf5syntaxhighlighting-dev

Fedora/RHEL:

sudo dnf install kf5-ktexteditor-devel kf5-syntax-highlighting-devel

Arch Linux:

sudo pacman -S ktexteditor syntax-highlighting

Note: Both libraries are standard KDE Frameworks components and are typically available in most Linux distributions' package repositories.

Debug Build

For development and debugging:

./scripts/build_debug.sh

Debug builds include:

Debug symbols for debugging
Verbose logging output
Development-friendly error messages
Unoptimized code for easier debugging

Logging

Loom includes a comprehensive logging system:

// In C++ code
LOG_ERROR("Error message");
DEBUG_LOG("Debug message");

// In Lua plugins
editor.debug_log("Debug message from Lua")

Testing

Test your changes with the provided sample files in test_files/:

# Test KSyntaxHighlighting for various languages
./scripts/run_loom.sh test_files/sample.cpp
./scripts/run_loom.sh test_files/sample.py
./scripts/run_loom.sh test_files/sample.js
./scripts/run_loom.sh test_files/sample.html
./scripts/run_loom.sh test_files/sample.json
./scripts/run_loom.sh test_files/sample.java
./scripts/run_loom.sh test_files/sample.go
./scripts/run_loom.sh test_files/sample.lua
./scripts/run_loom.sh test_files/sample.md
./scripts/run_loom.sh test_files/style.css

Creating DEB Packages

For maintainers and contributors who want to create distribution packages:

# Build, test, and package everything in one command
./scripts/package.sh

This single script will:

Build the optimized release binary
Create the DEB package with proper dependencies
Run comprehensive tests to verify package integrity
Display detailed package information and statistics
Provide installation instructions

The DEB package includes:

Compiled binary (/usr/bin/loom)
Configuration files (/usr/share/loom/config/)
Plugin system (/usr/share/loom/plugins/)
Themes (/usr/share/loom/themes/)
Desktop integration (.desktop file and icon)
Proper dependency management

Contributing

I welcome contributions! Here's how you can help:

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Contribution Guidelines

Follow the existing code style
Add tests for new features
Update documentation as needed
Ensure all builds pass
Test on multiple platforms when possible

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

Textadept - Inspiration for the minimal editor design
Gruvbox - Beautiful color scheme
Qt Framework - Cross-platform GUI toolkit
Lua - Powerful scripting language
KSyntaxHighlighting - Syntax highlighting framework from KDE
Contributors - Everyone who helps improve Loom

Support

Issues: GitHub Issues
Discussions: Join our Discord Server

⭐ Star this project if you find it useful!

Name		Name	Last commit message	Last commit date
Latest commit History 35 Commits
.github		.github
assets		assets
config		config
debian		debian
include		include
live-server		live-server
plugins		plugins
scripts		scripts
src		src
test_files		test_files
themes		themes
.gitignore		.gitignore
CMakeLists.txt		CMakeLists.txt
LICENSE		LICENSE
README.md		README.md
banner.png		banner.png
loom.desktop.in		loom.desktop.in
themes.qrc		themes.qrc

Uh oh!

License

dexter-xD/loom

Folders and files

Latest commit

History

Repository files navigation

Loom

Features

Syntax Highlighting

KTextEditor & KSyntaxHighlighting System

Unified Theme System

Theme Configuration (config/config.lua)

Available Unified Themes

Theme Features

Switching Themes

Plugin System

Configuration System

Quick Start

Prerequisites

Installation

Linux (Ubuntu/Debian) - DEB Package (Recommended)

Linux (Ubuntu/Debian) - Build from Source

Linux (Fedora/RHEL)

macOS

Build Options

Using Build Scripts (Recommended)

Manual Build

Important: External Formatters for AutoFormat Plugin

Quick Formatter Installation

Manual Installation

Configuration System

Configuration Structure

Main Configuration (config/config.lua)

Configuration Functions

Plugin System

Available Plugins

Theme Switcher Plugin (plugins/theme_switcher.lua)

AutoSave Plugin (plugins/autosave.lua)

AutoFormat Plugin (plugins/autoformat.lua)

Plugin Management

Loading Plugins

Plugin Configuration

Creating Custom Plugins

Live Server Integration

Features

Usage

Configuration

Build Options

Standalone Usage

Theming

Available Themes

Gruvbox (Default)

Dracula

Catppuccin Mocha

Theme Switching

Theme Customization

Keybindings

Default Keybindings

Custom Keybindings

Development

Project Structure

External Dependencies

KTextEditor

KSyntaxHighlighting

Installing KDE Framework Dependencies

Debug Build

Logging

Testing

Creating DEB Packages

Contributing

Contribution Guidelines

License

Acknowledgments

Support

About

Topics

Resources

License

Uh oh!

Theme Configuration (`config/config.lua`)

Main Configuration (`config/config.lua`)

Theme Switcher Plugin (`plugins/theme_switcher.lua`)

AutoSave Plugin (`plugins/autosave.lua`)

AutoFormat Plugin (`plugins/autoformat.lua`)

Packages