From 96b645ba081568b17dfa39833faa4185d03466a0 Mon Sep 17 00:00:00 2001 From: funtohard Date: Mon, 8 Sep 2025 21:35:31 +0530 Subject: [PATCH 1/4] Convert config documentation from Markdown to HTML - Replace config.md with config.html for better web presentation - Add comprehensive configuration documentation with examples - Include professional styling with responsive design - Add interactive navigation and smooth scrolling - Provide detailed explanations for all TranslucentTB settings - Include troubleshooting section and best practices --- config.html | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++ config.md | 3 - 2 files changed, 674 insertions(+), 3 deletions(-) create mode 100644 config.html delete mode 100644 config.md diff --git a/config.html b/config.html new file mode 100644 index 0000000..60dbb59 --- /dev/null +++ b/config.html @@ -0,0 +1,674 @@ + + + + + + TranslucentTB Configuration Documentation + + + +
+
+

TranslucentTB Configuration

+

Complete guide to customizing your Windows taskbar transparency

+
+
+ + + +
+
+
+

Overview

+

TranslucentTB uses a JSON configuration file to customize the appearance and behavior of the Windows taskbar. This document explains all available configuration options and their usage.

+ +
+

Configuration File Location

+

The configuration file should be saved as settings.json in the TranslucentTB application directory or user data folder.

+
+ +
+

Schema Reference

+

The configuration follows the JSON schema available at: https://TranslucentTB.github.io/settings.schema.json

+
+
+ +
+

Configuration Structure

+ 
{
+  "$schema": "https://TranslucentTB.github.io/settings.schema.json",
+  "desktop_appearance": { ... },
+  "visible_window_appearance": { ... },
+  "maximized_window_appearance": { ... },
+  "start_opened_appearance": { ... },
+  "search_opened_appearance": { ... },
+  "task_view_opened_appearance": { ... },
+  "battery_saver_appearance": { ... },
+  "ignored_windows": { ... },
+  "hide_tray": false,
+  "disable_saving": false,
+  "verbosity": "warn",
+  "language": "en-US",
+  "use_xaml_context_menu": false
+}
+
+ +
+

Appearance Settings

+

All appearance configurations support the following properties:

+ +

Basic Properties

+ +
+ accent (string): The accent/transparency effect to apply +
    +
  • "normal": Windows default appearance
    • +
  • "opaque": Solid, non-transparent taskbar
    • +
  • "clear": Fully transparent taskbar
    • +
  • "blur": Blurred transparency effect
    • +
  • "acrylic": Windows 10/11 acrylic material effect
    • +
+
+ +
+ color (string): Custom color in hexadecimal format +
    +
  • Format: #RRGGBB or #RRGGBBAA (with alpha channel)
    • +
  • Example: "#00000000" (fully transparent black)
    • +
+
+ +
+ show_peek (boolean): Enable/disable desktop peek functionality +
    +
  • true: Show desktop peek
    • +
  • false: Disable desktop peek
    • +
+
+ +
+ show_line (boolean): Show/hide the taskbar accent line +
    +
  • true: Display accent line
    • +
  • false: Hide accent line
    • +
+
+ +
+ blur_radius (number): Blur effect intensity (when using blur accent) +
    +
  • Range: Typically 0.0 to 50.0
    • +
  • Example: 9.0
    • +
+
+
+ +
+

Appearance Modes

+ +
+

1. Desktop Appearance

+

Applied when no windows are open or focused.

+ 
"desktop_appearance": {
+  "accent": "clear",
+  "color": "#00000000",
+  "show_peek": false,
+  "show_line": false,
+  "blur_radius": 9.0
+}
+
+ +
+

2. Visible Window Appearance

+

Applied when windows are visible but not maximized.

+ 
"visible_window_appearance": {
+  "enabled": false,
+  "accent": "clear",
+  "color": "#00000000",
+  "show_peek": true,
+  "show_line": false,
+  "blur_radius": 9.0,
+  "rules": {
+    "window_class": {},
+    "window_title": {},
+    "process_name": {}
+  }
+}
+
+ +
+

3. Maximized Window Appearance

+

Applied when a window is maximized.

+ 
"maximized_window_appearance": {
+  "enabled": true,
+  "accent": "clear",
+  "color": "#00000000",
+  "show_peek": true,
+  "show_line": false,
+  "blur_radius": 9.0,
+  "rules": {
+    "window_class": {},
+    "window_title": {},
+    "process_name": {}
+  }
+}
+
+ +
+

4. Start Menu Opened Appearance

+

Applied when the Start menu is open.

+ 
"start_opened_appearance": {
+  "enabled": false,
+  "accent": "normal",
+  "color": "#00000000",
+  "show_peek": true,
+  "show_line": true,
+  "blur_radius": 9.0
+}
+
+ +
+

5. Search Opened Appearance

+

Applied when Windows Search is open.

+ 
"search_opened_appearance": {
+  "enabled": true,
+  "accent": "normal",
+  "color": "#00000000",
+  "show_peek": true,
+  "show_line": true,
+  "blur_radius": 9.0
+}
+
+ +
+

6. Task View Opened Appearance

+

Applied when Task View (Alt+Tab) is open.

+ 
"task_view_opened_appearance": {
+  "enabled": true,
+  "accent": "normal",
+  "color": "#00000000",
+  "show_peek": false,
+  "show_line": true,
+  "blur_radius": 9.0
+}
+
+ +
+

7. Battery Saver Appearance

+

Applied when Windows Battery Saver mode is active.

+ 
"battery_saver_appearance": {
+  "enabled": true,
+  "accent": "clear",
+  "color": "#00000000",
+  "show_peek": true,
+  "show_line": false,
+  "blur_radius": 9.0
+}
+
+
+ +
+

Window Rules

+

For visible_window_appearance and maximized_window_appearance, you can define specific rules based on:

+ +

Rule Types

+
    +
  • window_class: Target specific window classes
    • +
  • window_title: Target windows by title
    • +
  • process_name: Target specific applications by process name
    • +
+ +

Rule Structure

+ 
"rules": {
+  "process_name": {
+    "notepad.exe": {
+      "accent": "blur",
+      "color": "#FF000080",
+      "show_peek": false,
+      "show_line": true,
+      "blur_radius": 15.0,
+      "inactive": {
+        "accent": "clear",
+        "color": "#00000000",
+        "show_peek": true,
+        "show_line": false
+      }
+    }
+  }
+}
+

The inactive property defines the appearance when the targeted window is not focused.

+ +

Ignored Windows

+

Configure windows that should be ignored by TranslucentTB:

+ 
"ignored_windows": {
+  "window_class": ["ClassName1", "ClassName2"],
+  "window_title": ["Window Title 1", "Window Title 2"],
+  "process_name": ["process1.exe", "process2.exe"]
+}
+
+ +
+

Global Settings

+ +

System Integration

+
+ hide_tray (boolean): Hide the system tray area +
    +
  • true: Hide tray
    • +
  • false: Show tray (default)
    • +
+
+ +
+ disable_saving (boolean): Prevent saving configuration changes +
    +
  • true: Disable automatic saving
    • +
  • false: Enable automatic saving (default)
    • +
+
+ +

Localization

+
+ language (string): Set application language +
    +
  • Format: "en-US", "de-DE", etc.
    • +
  • Must follow ISO 639-1 language code format
    • +
+
+ +

Interface Options

+
+ use_xaml_context_menu (boolean): Use modern context menu style +
    +
  • true: Use XAML-based context menu
    • +
  • false: Use classic context menu
    • +
+
+ +

Logging

+
+ verbosity (string): Set logging level +
    +
  • "trace": Most verbose logging
    • +
  • "debug": Debug information
    • +
  • "info": General information
    • +
  • "warn": Warnings only (default)
    • +
  • "err": Errors only
    • +
  • "critical": Critical errors only
    • +
  • "off": No logging
    • +
+
+
+ +
+

Example Configurations

+ +
+
+

Fully Transparent Desktop

+ 
{
+  "$schema": "https://TranslucentTB.github.io/settings.schema.json",
+  "desktop_appearance": {
+    "accent": "clear",
+    "color": "#00000000",
+    "show_peek": false,
+    "show_line": false
+  }
+}
+
+ +
+

Blur Effect with Custom Color

+ 
{
+  "$schema": "https://TranslucentTB.github.io/settings.schema.json",
+  "desktop_appearance": {
+    "accent": "blur",
+    "color": "#1E1E1E80",
+    "show_peek": true,
+    "show_line": true,
+    "blur_radius": 15.0
+  }
+}
+
+ +
+

Application-Specific Rules

+ 
{
+  "$schema": "https://TranslucentTB.github.io/settings.schema.json",
+  "maximized_window_appearance": {
+    "enabled": true,
+    "accent": "normal",
+    "rules": {
+      "process_name": {
+        "chrome.exe": {
+          "accent": "acrylic",
+          "color": "#000000AA",
+          "show_line": true
+        },
+        "notepad.exe": {
+          "accent": "clear",
+          "show_peek": false
+        }
+      }
+    }
+  }
+}
+
+
+
+ +
+

Tips and Best Practices

+
    +
  1. Start Simple: Begin with basic appearance settings before adding complex rules
    2. +
  2. Test Changes: Use different applications to test your configuration
    3. +
  3. Backup Configuration: Keep a backup of working configurations
    4. +
  4. Performance: Complex rules with many blur effects may impact system performance
    5. +
  5. Color Format: Always use proper hexadecimal color format with alpha channel for transparency
    6. +
+
+ +
+

Troubleshooting

+
    +
  • Configuration not loading: Check JSON syntax and schema validation
    • +
  • Rules not working: Verify process names and window classes using tools like Spy++
    • +
  • Performance issues: Reduce blur_radius values or disable complex effects
    • +
  • Color not applying: Ensure proper hex color format with alpha channel
    • +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/config.md b/config.md deleted file mode 100644 index 063e943..0000000 --- a/config.md +++ /dev/null @@ -1,3 +0,0 @@ -# TranslucentTB Config documentation - -TODO: write documentation \ No newline at end of file From 678c9da6e9a6307b13c108f88dab14cf72f1aef7 Mon Sep 17 00:00:00 2001 From: funtohard Date: Tue, 9 Sep 2025 09:08:44 +0530 Subject: [PATCH 2/4] Revert to Markdown format for consistency - Remove config.html and restore config.md. - Follow project consistency guidelines --- config.html | 674 ---------------------------------------------------- config.md | 455 +++++++++++++++++++++++++++++++++++ 2 files changed, 455 insertions(+), 674 deletions(-) delete mode 100644 config.html create mode 100644 config.md diff --git a/config.html b/config.html deleted file mode 100644 index 60dbb59..0000000 --- a/config.html +++ /dev/null @@ -1,674 +0,0 @@ - - - - - - TranslucentTB Configuration Documentation - - - -
-
-

TranslucentTB Configuration

-

Complete guide to customizing your Windows taskbar transparency

-
-
- - - -
-
-
-

Overview

-

TranslucentTB uses a JSON configuration file to customize the appearance and behavior of the Windows taskbar. This document explains all available configuration options and their usage.

- -
-

Configuration File Location

-

The configuration file should be saved as settings.json in the TranslucentTB application directory or user data folder.

-
- -
-

Schema Reference

-

The configuration follows the JSON schema available at: https://TranslucentTB.github.io/settings.schema.json

-
-
- -
-

Configuration Structure

- 
{
-  "$schema": "https://TranslucentTB.github.io/settings.schema.json",
-  "desktop_appearance": { ... },
-  "visible_window_appearance": { ... },
-  "maximized_window_appearance": { ... },
-  "start_opened_appearance": { ... },
-  "search_opened_appearance": { ... },
-  "task_view_opened_appearance": { ... },
-  "battery_saver_appearance": { ... },
-  "ignored_windows": { ... },
-  "hide_tray": false,
-  "disable_saving": false,
-  "verbosity": "warn",
-  "language": "en-US",
-  "use_xaml_context_menu": false
-}
-
- -
-

Appearance Settings

-

All appearance configurations support the following properties:

- -

Basic Properties

- -
- accent (string): The accent/transparency effect to apply -
    -
  • "normal": Windows default appearance
    • -
  • "opaque": Solid, non-transparent taskbar
    • -
  • "clear": Fully transparent taskbar
    • -
  • "blur": Blurred transparency effect
    • -
  • "acrylic": Windows 10/11 acrylic material effect
    • -
-
- -
- color (string): Custom color in hexadecimal format -
    -
  • Format: #RRGGBB or #RRGGBBAA (with alpha channel)
    • -
  • Example: "#00000000" (fully transparent black)
    • -
-
- -
- show_peek (boolean): Enable/disable desktop peek functionality -
    -
  • true: Show desktop peek
    • -
  • false: Disable desktop peek
    • -
-
- -
- show_line (boolean): Show/hide the taskbar accent line -
    -
  • true: Display accent line
    • -
  • false: Hide accent line
    • -
-
- -
- blur_radius (number): Blur effect intensity (when using blur accent) -
    -
  • Range: Typically 0.0 to 50.0
    • -
  • Example: 9.0
    • -
-
-
- -
-

Appearance Modes

- -
-

1. Desktop Appearance

-

Applied when no windows are open or focused.

- 
"desktop_appearance": {
-  "accent": "clear",
-  "color": "#00000000",
-  "show_peek": false,
-  "show_line": false,
-  "blur_radius": 9.0
-}
-
- -
-

2. Visible Window Appearance

-

Applied when windows are visible but not maximized.

- 
"visible_window_appearance": {
-  "enabled": false,
-  "accent": "clear",
-  "color": "#00000000",
-  "show_peek": true,
-  "show_line": false,
-  "blur_radius": 9.0,
-  "rules": {
-    "window_class": {},
-    "window_title": {},
-    "process_name": {}
-  }
-}
-
- -
-

3. Maximized Window Appearance

-

Applied when a window is maximized.

- 
"maximized_window_appearance": {
-  "enabled": true,
-  "accent": "clear",
-  "color": "#00000000",
-  "show_peek": true,
-  "show_line": false,
-  "blur_radius": 9.0,
-  "rules": {
-    "window_class": {},
-    "window_title": {},
-    "process_name": {}
-  }
-}
-
- -
-

4. Start Menu Opened Appearance

-

Applied when the Start menu is open.

- 
"start_opened_appearance": {
-  "enabled": false,
-  "accent": "normal",
-  "color": "#00000000",
-  "show_peek": true,
-  "show_line": true,
-  "blur_radius": 9.0
-}
-
- -
-

5. Search Opened Appearance

-

Applied when Windows Search is open.

- 
"search_opened_appearance": {
-  "enabled": true,
-  "accent": "normal",
-  "color": "#00000000",
-  "show_peek": true,
-  "show_line": true,
-  "blur_radius": 9.0
-}
-
- -
-

6. Task View Opened Appearance

-

Applied when Task View (Alt+Tab) is open.

- 
"task_view_opened_appearance": {
-  "enabled": true,
-  "accent": "normal",
-  "color": "#00000000",
-  "show_peek": false,
-  "show_line": true,
-  "blur_radius": 9.0
-}
-
- -
-

7. Battery Saver Appearance

-

Applied when Windows Battery Saver mode is active.

- 
"battery_saver_appearance": {
-  "enabled": true,
-  "accent": "clear",
-  "color": "#00000000",
-  "show_peek": true,
-  "show_line": false,
-  "blur_radius": 9.0
-}
-
-
- -
-

Window Rules

-

For visible_window_appearance and maximized_window_appearance, you can define specific rules based on:

- -

Rule Types

-
    -
  • window_class: Target specific window classes
    • -
  • window_title: Target windows by title
    • -
  • process_name: Target specific applications by process name
    • -
- -

Rule Structure

- 
"rules": {
-  "process_name": {
-    "notepad.exe": {
-      "accent": "blur",
-      "color": "#FF000080",
-      "show_peek": false,
-      "show_line": true,
-      "blur_radius": 15.0,
-      "inactive": {
-        "accent": "clear",
-        "color": "#00000000",
-        "show_peek": true,
-        "show_line": false
-      }
-    }
-  }
-}
-

The inactive property defines the appearance when the targeted window is not focused.

- -

Ignored Windows

-

Configure windows that should be ignored by TranslucentTB:

- 
"ignored_windows": {
-  "window_class": ["ClassName1", "ClassName2"],
-  "window_title": ["Window Title 1", "Window Title 2"],
-  "process_name": ["process1.exe", "process2.exe"]
-}
-
- -
-

Global Settings

- -

System Integration

-
- hide_tray (boolean): Hide the system tray area -
    -
  • true: Hide tray
    • -
  • false: Show tray (default)
    • -
-
- -
- disable_saving (boolean): Prevent saving configuration changes -
    -
  • true: Disable automatic saving
    • -
  • false: Enable automatic saving (default)
    • -
-
- -

Localization

-
- language (string): Set application language -
    -
  • Format: "en-US", "de-DE", etc.
    • -
  • Must follow ISO 639-1 language code format
    • -
-
- -

Interface Options

-
- use_xaml_context_menu (boolean): Use modern context menu style -
    -
  • true: Use XAML-based context menu
    • -
  • false: Use classic context menu
    • -
-
- -

Logging

-
- verbosity (string): Set logging level -
    -
  • "trace": Most verbose logging
    • -
  • "debug": Debug information
    • -
  • "info": General information
    • -
  • "warn": Warnings only (default)
    • -
  • "err": Errors only
    • -
  • "critical": Critical errors only
    • -
  • "off": No logging
    • -
-
-
- -
-

Example Configurations

- -
-
-

Fully Transparent Desktop

- 
{
-  "$schema": "https://TranslucentTB.github.io/settings.schema.json",
-  "desktop_appearance": {
-    "accent": "clear",
-    "color": "#00000000",
-    "show_peek": false,
-    "show_line": false
-  }
-}
-
- -
-

Blur Effect with Custom Color

- 
{
-  "$schema": "https://TranslucentTB.github.io/settings.schema.json",
-  "desktop_appearance": {
-    "accent": "blur",
-    "color": "#1E1E1E80",
-    "show_peek": true,
-    "show_line": true,
-    "blur_radius": 15.0
-  }
-}
-
- -
-

Application-Specific Rules

- 
{
-  "$schema": "https://TranslucentTB.github.io/settings.schema.json",
-  "maximized_window_appearance": {
-    "enabled": true,
-    "accent": "normal",
-    "rules": {
-      "process_name": {
-        "chrome.exe": {
-          "accent": "acrylic",
-          "color": "#000000AA",
-          "show_line": true
-        },
-        "notepad.exe": {
-          "accent": "clear",
-          "show_peek": false
-        }
-      }
-    }
-  }
-}
-
-
-
- -
-

Tips and Best Practices

-
    -
  1. Start Simple: Begin with basic appearance settings before adding complex rules
    2. -
  2. Test Changes: Use different applications to test your configuration
    3. -
  3. Backup Configuration: Keep a backup of working configurations
    4. -
  4. Performance: Complex rules with many blur effects may impact system performance
    5. -
  5. Color Format: Always use proper hexadecimal color format with alpha channel for transparency
    6. -
-
- -
-

Troubleshooting

-
    -
  • Configuration not loading: Check JSON syntax and schema validation
    • -
  • Rules not working: Verify process names and window classes using tools like Spy++
    • -
  • Performance issues: Reduce blur_radius values or disable complex effects
    • -
  • Color not applying: Ensure proper hex color format with alpha channel
    • -
-
-
-
- -
-
-

© 2025 TranslucentTB Project. Configuration documentation for better Windows taskbar customization.

-
-
- - - - \ No newline at end of file diff --git a/config.md b/config.md new file mode 100644 index 0000000..94e0417 --- /dev/null +++ b/config.md @@ -0,0 +1,455 @@ +# TranslucentTB Configuration Documentation + +TranslucentTB uses a JSON configuration file to customize the appearance and behavior of the Windows taskbar. This document explains all available configuration options and their usage. + +## Table of Contents + +- [Overview](#overview) +- [Configuration Structure](#configuration-structure) +- [Appearance Settings](#appearance-settings) +- [Appearance Modes](#appearance-modes) +- [Window Rules](#window-rules) +- [Global Settings](#global-settings) +- [Example Configurations](#example-configurations) +- [Tips and Best Practices](#tips-and-best-practices) +- [Troubleshooting](#troubleshooting) + +## Overview + +### Configuration File Location + +The configuration file should be saved as `settings.json` in the TranslucentTB application directory or user data folder. + +### Schema Reference + +The configuration follows the JSON schema available at: `https://TranslucentTB.github.io/settings.schema.json` + +## Configuration Structure + +```json +{ + "$schema": "https://TranslucentTB.github.io/settings.schema.json", + "desktop_appearance": { ... }, + "visible_window_appearance": { ... }, + "maximized_window_appearance": { ... }, + "start_opened_appearance": { ... }, + "search_opened_appearance": { ... }, + "task_view_opened_appearance": { ... }, + "battery_saver_appearance": { ... }, + "ignored_windows": { ... }, + "hide_tray": false, + "disable_saving": false, + "verbosity": "warn", + "language": "en-US", + "use_xaml_context_menu": false +} +``` + +## Appearance Settings + +All appearance configurations support the following properties: + +### Basic Properties + +#### `accent` (string) +The accent/transparency effect to apply: +- `"normal"`: Windows default appearance +- `"opaque"`: Solid, non-transparent taskbar +- `"clear"`: Fully transparent taskbar +- `"blur"`: Blurred transparency effect +- `"acrylic"`: Windows 10/11 acrylic material effect + +#### `color` (string) +Custom color in hexadecimal format: +- Format: `#RRGGBB` or `#RRGGBBAA` (with alpha channel) +- Example: `"#00000000"` (fully transparent black) + +#### `show_peek` (boolean) +Enable/disable desktop peek functionality: +- `true`: Show desktop peek +- `false`: Disable desktop peek + +#### `show_line` (boolean) +Show/hide the taskbar accent line: +- `true`: Display accent line +- `false`: Hide accent line + +#### `blur_radius` (number) +Blur effect intensity (when using blur accent): +- Range: Typically 0.0 to 50.0 +- Example: `9.0` + +## Appearance Modes + +### 1. Desktop Appearance + +Applied when no windows are open or focused. + +```json +"desktop_appearance": { + "accent": "clear", + "color": "#00000000", + "show_peek": false, + "show_line": false, + "blur_radius": 9.0 +} +``` + +### 2. Visible Window Appearance + +Applied when windows are visible but not maximized. + +```json +"visible_window_appearance": { + "enabled": false, + "accent": "clear", + "color": "#00000000", + "show_peek": true, + "show_line": false, + "blur_radius": 9.0, + "rules": { + "window_class": {}, + "window_title": {}, + "process_name": {} + } +} +``` + +### 3. Maximized Window Appearance + +Applied when a window is maximized. + +```json +"maximized_window_appearance": { + "enabled": true, + "accent": "clear", + "color": "#00000000", + "show_peek": true, + "show_line": false, + "blur_radius": 9.0, + "rules": { + "window_class": {}, + "window_title": {}, + "process_name": {} + } +} +``` + +### 4. Start Menu Opened Appearance + +Applied when the Start menu is open. + +```json +"start_opened_appearance": { + "enabled": false, + "accent": "normal", + "color": "#00000000", + "show_peek": true, + "show_line": true, + "blur_radius": 9.0 +} +``` + +### 5. Search Opened Appearance + +Applied when Windows Search is open. + +```json +"search_opened_appearance": { + "enabled": true, + "accent": "normal", + "color": "#00000000", + "show_peek": true, + "show_line": true, + "blur_radius": 9.0 +} +``` + +### 6. Task View Opened Appearance + +Applied when Task View (Alt+Tab) is open. + +```json +"task_view_opened_appearance": { + "enabled": true, + "accent": "normal", + "color": "#00000000", + "show_peek": false, + "show_line": true, + "blur_radius": 9.0 +} +``` + +### 7. Battery Saver Appearance + +Applied when Windows Battery Saver mode is active. + +```json +"battery_saver_appearance": { + "enabled": true, + "accent": "clear", + "color": "#00000000", + "show_peek": true, + "show_line": false, + "blur_radius": 9.0 +} +``` + +## Window Rules + +For `visible_window_appearance` and `maximized_window_appearance`, you can define specific rules based on: + +### Rule Types + +- **`window_class`**: Target specific window classes +- **`window_title`**: Target windows by title +- **`process_name`**: Target specific applications by process name + +### Rule Structure + +```json +"rules": { + "process_name": { + "notepad.exe": { + "accent": "blur", + "color": "#FF000080", + "show_peek": false, + "show_line": true, + "blur_radius": 15.0, + "inactive": { + "accent": "clear", + "color": "#00000000", + "show_peek": true, + "show_line": false + } + } + } +} +``` + +The `inactive` property defines the appearance when the targeted window is not focused. + +### Ignored Windows + +Configure windows that should be ignored by TranslucentTB: + +```json +"ignored_windows": { + "window_class": ["ClassName1", "ClassName2"], + "window_title": ["Window Title 1", "Window Title 2"], + "process_name": ["process1.exe", "process2.exe"] +} +``` + +## Global Settings + +### System Integration + +#### `hide_tray` (boolean) +Hide the system tray area: +- `true`: Hide tray +- `false`: Show tray (default) + +#### `disable_saving` (boolean) +Prevent saving configuration changes: +- `true`: Disable automatic saving +- `false`: Enable automatic saving (default) + +### Localization + +#### `language` (string) +Set application language: +- Format: `"en-US"`, `"de-DE"`, etc. +- Must follow ISO 639-1 language code format + +### Interface Options + +#### `use_xaml_context_menu` (boolean) +Use modern context menu style: +- `true`: Use XAML-based context menu +- `false`: Use classic context menu + +### Logging + +#### `verbosity` (string) +Set logging level: +- `"trace"`: Most verbose logging +- `"debug"`: Debug information +- `"info"`: General information +- `"warn"`: Warnings only (default) +- `"err"`: Errors only +- `"critical"`: Critical errors only +- `"off"`: No logging + +## Example Configurations + +### Fully Transparent Desktop + +```json +{ + "$schema": "https://TranslucentTB.github.io/settings.schema.json", + "desktop_appearance": { + "accent": "clear", + "color": "#00000000", + "show_peek": false, + "show_line": false + } +} +``` + +### Blur Effect with Custom Color + +```json +{ + "$schema": "https://TranslucentTB.github.io/settings.schema.json", + "desktop_appearance": { + "accent": "blur", + "color": "#1E1E1E80", + "show_peek": true, + "show_line": true, + "blur_radius": 15.0 + } +} +``` + +### Application-Specific Rules + +```json +{ + "$schema": "https://TranslucentTB.github.io/settings.schema.json", + "maximized_window_appearance": { + "enabled": true, + "accent": "normal", + "rules": { + "process_name": { + "chrome.exe": { + "accent": "acrylic", + "color": "#000000AA", + "show_line": true + }, + "notepad.exe": { + "accent": "clear", + "show_peek": false + } + } + } + } +} +``` + +### Complete Configuration Example + +```json +{ + "$schema": "https://TranslucentTB.github.io/settings.schema.json", + "desktop_appearance": { + "accent": "clear", + "color": "#00000000", + "show_peek": false, + "show_line": false, + "blur_radius": 9.0 + }, + "visible_window_appearance": { + "enabled": false, + "accent": "clear", + "color": "#00000000", + "show_peek": true, + "show_line": false, + "blur_radius": 9.0, + "rules": { + "window_class": {}, + "window_title": {}, + "process_name": {} + } + }, + "maximized_window_appearance": { + "enabled": true, + "accent": "clear", + "color": "#00000000", + "show_peek": true, + "show_line": false, + "blur_radius": 9.0, + "rules": { + "window_class": {}, + "window_title": {}, + "process_name": {} + } + }, + "start_opened_appearance": { + "enabled": false, + "accent": "normal", + "color": "#00000000", + "show_peek": true, + "show_line": true, + "blur_radius": 9.0 + }, + "search_opened_appearance": { + "enabled": true, + "accent": "normal", + "color": "#00000000", + "show_peek": true, + "show_line": true, + "blur_radius": 9.0 + }, + "task_view_opened_appearance": { + "enabled": true, + "accent": "normal", + "color": "#00000000", + "show_peek": false, + "show_line": true, + "blur_radius": 9.0 + }, + "battery_saver_appearance": { + "enabled": true, + "accent": "clear", + "color": "#00000000", + "show_peek": true, + "show_line": false, + "blur_radius": 9.0 + }, + "ignored_windows": { + "window_class": [], + "window_title": [], + "process_name": [] + }, + "disable_saving": false, + "verbosity": "warn" +} +``` + +## Tips and Best Practices + +1. **Start Simple**: Begin with basic appearance settings before adding complex rules +2. **Test Changes**: Use different applications to test your configuration +3. **Backup Configuration**: Keep a backup of working configurations +4. **Performance**: Complex rules with many blur effects may impact system performance +5. **Color Format**: Always use proper hexadecimal color format with alpha channel for transparency +6. **JSON Validation**: Use a JSON validator or editor with syntax checking to avoid errors +7. **Schema Validation**: Include the `$schema` property to enable validation and autocomplete in editors + +## Troubleshooting + +### Common Issues + +- **Configuration not loading**: Check JSON syntax and schema validation +- **Rules not working**: Verify process names and window classes using tools like Spy++ +- **Performance issues**: Reduce `blur_radius` values or disable complex effects +- **Color not applying**: Ensure proper hex color format with alpha channel +- **Settings not saving**: Check if `disable_saving` is set to `false` + +### Debugging Tips (Advanced) + +1. **Check the logs**: Set `verbosity` to `"debug"` to see detailed information +2. **Validate JSON**: Use online JSON validators or VS Code with the schema +3. **Test incrementally**: Add one setting at a time to isolate issues +4. **Use process monitor**: Tools like Process Monitor can help identify file access issues +5. **Check permissions**: Ensure TranslucentTB has write access to the config directory + +### Getting Help + +If you encounter issues not covered in this documentation: + +1. Check the [TranslucentTB Issues](https://github.com/TranslucentTB/TranslucentTB/issues) page +2. Search for similar problems in existing issues +3. Create a new issue with your configuration file and detailed description +4. Include system information and TranslucentTB version From a133ac9da159194ee0d469f9c1037b57cb598bd4 Mon Sep 17 00:00:00 2001 From: funtohard Date: Fri, 12 Sep 2025 16:57:09 +0530 Subject: [PATCH 3/4] Update config.md --- config.md | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/config.md b/config.md index 94e0417..e1f817f 100644 --- a/config.md +++ b/config.md @@ -64,17 +64,12 @@ Custom color in hexadecimal format: - Format: `#RRGGBB` or `#RRGGBBAA` (with alpha channel) - Example: `"#00000000"` (fully transparent black) -#### `show_peek` (boolean) -Enable/disable desktop peek functionality: -- `true`: Show desktop peek -- `false`: Disable desktop peek - -#### `show_line` (boolean) +#### `show_line` (boolean) **Windows 11 only** Show/hide the taskbar accent line: - `true`: Display accent line - `false`: Hide accent line -#### `blur_radius` (number) +#### `blur_radius` (number) **Windows 11 only** Blur effect intensity (when using blur accent): - Range: Typically 0.0 to 50.0 - Example: `9.0` @@ -167,7 +162,7 @@ Applied when Windows Search is open. ### 6. Task View Opened Appearance -Applied when Task View (Alt+Tab) is open. +Applied when Task View ( **⊞ Win+Tab ↹** ) is open. ```json "task_view_opened_appearance": { @@ -260,7 +255,7 @@ Prevent saving configuration changes: #### `language` (string) Set application language: - Format: `"en-US"`, `"de-DE"`, etc. -- Must follow ISO 639-1 language code format +- Must follow [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code format ### Interface Options @@ -423,15 +418,15 @@ Set logging level: 2. **Test Changes**: Use different applications to test your configuration 3. **Backup Configuration**: Keep a backup of working configurations 4. **Performance**: Complex rules with many blur effects may impact system performance -5. **Color Format**: Always use proper hexadecimal color format with alpha channel for transparency -6. **JSON Validation**: Use a JSON validator or editor with syntax checking to avoid errors +5. **Color Format**: Always use proper [hexadecimal color format](https://en.wikipedia.org/wiki/Web_colors) with alpha channel for transparency +6. **JSON Validation**: Use a [JSON validator](https://jsonlint.com/) or editor with syntax checking to avoid errors 7. **Schema Validation**: Include the `$schema` property to enable validation and autocomplete in editors ## Troubleshooting ### Common Issues -- **Configuration not loading**: Check JSON syntax and schema validation +- **Configuration not loading**: Check [JSON syntax](https://jsonlint.com/) and schema validation - **Rules not working**: Verify process names and window classes using tools like Spy++ - **Performance issues**: Reduce `blur_radius` values or disable complex effects - **Color not applying**: Ensure proper hex color format with alpha channel @@ -440,9 +435,9 @@ Set logging level: ### Debugging Tips (Advanced) 1. **Check the logs**: Set `verbosity` to `"debug"` to see detailed information -2. **Validate JSON**: Use online JSON validators or VS Code with the schema +2. **Validate JSON**: Use online JSON validators like [JSONLint](https://jsonlint.com/) (Recommended) or [VS Code](https://code.visualstudio.com/) with the schema 3. **Test incrementally**: Add one setting at a time to isolate issues -4. **Use process monitor**: Tools like Process Monitor can help identify file access issues +4. **Use process monitor**: Tools like [Process Monitor](https://docs.microsoft.com/en-us/sysinternals/downloads/procmon) can help identify file access issues 5. **Check permissions**: Ensure TranslucentTB has write access to the config directory ### Getting Help From 4c10d0d205d6910968b342478445cf38912d1e55 Mon Sep 17 00:00:00 2001 From: Charles Milette Date: Sat, 7 Mar 2026 17:29:13 -0500 Subject: [PATCH 4/4] Revise config.md for clarity and detail enhancements Updated configuration file details for Store/MSIX installs and added clarifications on appearance modes and rules. --- config.md | 68 +++++++++++++++++++++++++++---------------------------- 1 file changed, 33 insertions(+), 35 deletions(-) diff --git a/config.md b/config.md index e1f817f..d447ce8 100644 --- a/config.md +++ b/config.md @@ -18,7 +18,7 @@ TranslucentTB uses a JSON configuration file to customize the appearance and beh ### Configuration File Location -The configuration file should be saved as `settings.json` in the TranslucentTB application directory or user data folder. +The configuration file should be saved as `settings.json` in `%LocalAppData%\Packages\28017CharlesMilette.TranslucentTB_v826wp6bftszj\RoamingState` for Store/MSIX installs, and in the same directory as the app executable for portable installs. ### Schema Reference @@ -26,17 +26,17 @@ The configuration follows the JSON schema available at: `https://TranslucentTB.g ## Configuration Structure -```json +```jsonc { "$schema": "https://TranslucentTB.github.io/settings.schema.json", - "desktop_appearance": { ... }, - "visible_window_appearance": { ... }, - "maximized_window_appearance": { ... }, - "start_opened_appearance": { ... }, - "search_opened_appearance": { ... }, - "task_view_opened_appearance": { ... }, - "battery_saver_appearance": { ... }, - "ignored_windows": { ... }, + "desktop_appearance": { /* ... */ }, + "visible_window_appearance": { /* ... */ }, + "maximized_window_appearance": { /* ... */ }, + "start_opened_appearance": { /* ... */ }, + "search_opened_appearance": { /* ... */ }, + "task_view_opened_appearance": { /* ... */ }, + "battery_saver_appearance": { /* ... */ }, + "ignored_windows": { /* ... */ }, "hide_tray": false, "disable_saving": false, "verbosity": "warn", @@ -78,7 +78,7 @@ Blur effect intensity (when using blur accent): ### 1. Desktop Appearance -Applied when no windows are open or focused. +Applied when no windows are open or focused. It can also be considered the "default" if no other appearance is enabled or active, so it cannot be disabled. ```json "desktop_appearance": { @@ -162,7 +162,7 @@ Applied when Windows Search is open. ### 6. Task View Opened Appearance -Applied when Task View ( **⊞ Win+Tab ↹** ) is open. +Applied when Task View (Win+Tab) is open. ```json "task_view_opened_appearance": { @@ -192,7 +192,12 @@ Applied when Windows Battery Saver mode is active. ## Window Rules -For `visible_window_appearance` and `maximized_window_appearance`, you can define specific rules based on: +For `visible_window_appearance` and `maximized_window_appearance`, you can define specific rules. The order of importance for rules is the following: +- If the highest z-order maximized window triggers a maximized window rule, this rule is automatically used. +- If there is no maximized window, TranslucentTB searches a rule for the current foreground (active) window and applies it to the monitor the window is on. + +For example, if you have a maximized window rule for VS Code, and a visible window rule for Discord, and VS Code is maximized but the Discord window is normal and in the foreground, then VSCode's window rule will apply. +Once you minimize or make VSCode not maximized, Discord's rule will apply. ### Rule Types @@ -222,7 +227,7 @@ For `visible_window_appearance` and `maximized_window_appearance`, you can defin } ``` -The `inactive` property defines the appearance when the targeted window is not focused. +The `inactive` property defines the appearance when the targeted window is not focused. As explained above, visible window rules are only considered for the foreground window, meaning this has currently no effect for visible window rules. ### Ignored Windows @@ -241,10 +246,12 @@ Configure windows that should be ignored by TranslucentTB: ### System Integration #### `hide_tray` (boolean) -Hide the system tray area: +Hide TranslucentTB's system tray icon: - `true`: Hide tray - `false`: Show tray (default) +This option is hidden from the config file by default but can be manually added. + #### `disable_saving` (boolean) Prevent saving configuration changes: - `true`: Disable automatic saving @@ -255,14 +262,16 @@ Prevent saving configuration changes: #### `language` (string) Set application language: - Format: `"en-US"`, `"de-DE"`, etc. -- Must follow [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code format +- Must be a [Windows Language Code Identifier](https://learn.microsoft.com/openspecs/windows_protocols/ms-lcid/c4ece252-4acf-4961-bf5f-f9adacfff27e) ### Interface Options #### `use_xaml_context_menu` (boolean) Use modern context menu style: - `true`: Use XAML-based context menu -- `false`: Use classic context menu +- `false`: Use classic Win32 context menu + +This option is hidden from the config file by default but can be manually added. ### Logging @@ -274,11 +283,11 @@ Set logging level: - `"warn"`: Warnings only (default) - `"err"`: Errors only - `"critical"`: Critical errors only -- `"off"`: No logging +- `"off"`: No logging, unless a state dump is manually requested. ## Example Configurations -### Fully Transparent Desktop +### Fully Transparent Taskbar ```json { @@ -417,29 +426,18 @@ Set logging level: 1. **Start Simple**: Begin with basic appearance settings before adding complex rules 2. **Test Changes**: Use different applications to test your configuration 3. **Backup Configuration**: Keep a backup of working configurations -4. **Performance**: Complex rules with many blur effects may impact system performance -5. **Color Format**: Always use proper [hexadecimal color format](https://en.wikipedia.org/wiki/Web_colors) with alpha channel for transparency -6. **JSON Validation**: Use a [JSON validator](https://jsonlint.com/) or editor with syntax checking to avoid errors -7. **Schema Validation**: Include the `$schema` property to enable validation and autocomplete in editors +4. **Color Format**: Always use proper [hexadecimal color format](https://en.wikipedia.org/wiki/Web_colors) with alpha channel for transparency +5. **JSON Validation**: Use a [JSON validator](https://jsonlint.com/) or editor with syntax checking to avoid errors +6. **Schema Validation**: Include the `$schema` property to enable validation and autocomplete in editors ## Troubleshooting ### Common Issues -- **Configuration not loading**: Check [JSON syntax](https://jsonlint.com/) and schema validation -- **Rules not working**: Verify process names and window classes using tools like Spy++ -- **Performance issues**: Reduce `blur_radius` values or disable complex effects -- **Color not applying**: Ensure proper hex color format with alpha channel +- **Error during configuration load**: Check [JSON syntax](https://jsonlint.com/) and schema validation. The error given by TranslucentTB should help. +- **Rules not working**: Verify process names and window classes using tools like Spy++ or AutoHotKey's Window Spy. - **Settings not saving**: Check if `disable_saving` is set to `false` -### Debugging Tips (Advanced) - -1. **Check the logs**: Set `verbosity` to `"debug"` to see detailed information -2. **Validate JSON**: Use online JSON validators like [JSONLint](https://jsonlint.com/) (Recommended) or [VS Code](https://code.visualstudio.com/) with the schema -3. **Test incrementally**: Add one setting at a time to isolate issues -4. **Use process monitor**: Tools like [Process Monitor](https://docs.microsoft.com/en-us/sysinternals/downloads/procmon) can help identify file access issues -5. **Check permissions**: Ensure TranslucentTB has write access to the config directory - ### Getting Help If you encounter issues not covered in this documentation: