Installation and Configuration

Relevant source files

README.md

export/TajemnikTV-TajsModded.zip

extensions/scripts/utilities/config_manager.gd

manifest.json

preview/Containers6Input.png

This page covers the installation procedures for Taj’s Mod and explains the configuration system that manages all mod settings. For detailed feature documentation and how to use specific features, see Feature Reference. For information about building the mod or contributing, see Development Guide.

System Requirements

Taj’s Mod requires the following base system components:

Component	Minimum Version	Notes
Upload Labs	2.0.17	Base game version
Mod Loader	7.0.0	GDWeave mod loader
Operating System	Windows/Linux	Same as base game

The mod has no known conflicts with other mods as of version 0.0.23.

Sources: manifest.json L9-L13

README.md L75-L80

Installation Methods

Steam Workshop Installation (Recommended)

The Steam Workshop provides automatic installation, updates, and conflict resolution.

sequenceDiagram
  participant User
  participant Steam Workshop
  participant Steam Client
  participant Upload Labs
  participant GDWeave Mod Loader

  User->>Steam Workshop: Subscribe to mod
  Steam Workshop->>Steam Client: Queue download
  Steam Client->>Steam Client: Download TajemnikTV-TajsModded.zip
  Steam Client->>Upload Labs: Install to mods directory
  User->>Upload Labs: Launch game
  Upload Labs->>GDWeave Mod Loader: Load mod_main.gd
  GDWeave Mod Loader->>Upload Labs: Inject mod scripts

Installation Steps:

Navigate to the Steam Workshop page
Click Subscribe
Steam will automatically download and install the mod
Launch Upload Labs
Verify installation by looking for the puzzle-piece settings button in the HUD

The mod is packaged as TajemnikTV-TajsModded.zip in the Workshop and extracted to the game’s mods directory by Steam.

Sources: README.md L62-L65

manifest.json L32-L34

export/TajemnikTV-TajsModded.zip L1

Manual Installation

Manual installation is not officially supported but possible for advanced users:

flowchart TD

GitHub["GitHub Releases<br>TajsModded-v0.0.23"]
Download["Download .zip"]
Extract["Extract to<br>game/mods/"]
Verify["Verify:<br>mods-unpacked/<br>TajemnikTV-TajsModded/"]
Launch["Launch game"]

GitHub --> Download
Download --> Extract
Extract --> Verify
Verify --> Launch

Manual Steps:

Download the latest release from GitHub Releases
Extract the zip file to <game_directory>/mods/
Ensure the structure is: mods-unpacked/TajemnikTV-TajsModded/mod_main.gd
Launch the game

Warning: Remove any previous manual installations before installing via Steam Workshop to avoid duplicates.

Sources: README.md L66-L69

manifest.json L32

Configuration System Architecture

Taj’s Mod uses a persistent JSON-based configuration system managed by TajsModConfigManager.

flowchart TD

DefaultConfig["DEFAULT_CONFIG<br>(config_manager.gd:12-54)<br>50+ default keys"]
UserFile["user://tajs_mod_config.json<br>User overrides"]
ConfigMgr["TajsModConfigManager<br>(config_manager.gd)"]
LoadLogic["load_config()<br>line 62"]
SaveLogic["save_config()<br>line 100"]
GetValue["get_value(key, default)<br>line 110"]
SetValue["set_value(key, value)<br>line 119"]
ModMain["mod_main.gd<br>config_manager.get_value()"]
SettingsUI["Settings Panel<br>Read/Write config"]
Commands["Command Palette<br>Toggle settings"]

DefaultConfig --> LoadLogic
UserFile --> LoadLogic
SaveLogic --> UserFile
ModMain --> GetValue
ModMain --> SetValue
SettingsUI --> GetValue
SettingsUI --> SetValue
Commands --> SetValue

subgraph subGraph2 ["Runtime Access"]
    ModMain
    SettingsUI
    Commands
end

subgraph subGraph1 ["Configuration Manager"]
    ConfigMgr
    LoadLogic
    SaveLogic
    GetValue
    SetValue
    LoadLogic --> ConfigMgr
    ConfigMgr --> GetValue
    ConfigMgr --> SetValue
    SetValue --> SaveLogic
end

subgraph subGraph0 ["Configuration Sources"]
    DefaultConfig
    UserFile
end

Key Characteristics:

Write-through persistence: Every set_value() call immediately writes to disk
Three-tier fallback: User config → Default config → Method override parameter
Automatic migration: New default keys are automatically added to existing user configs
Type preservation: JSON maintains data types (bool, int, float, string)

Sources: extensions/scripts/utilities/config_manager.gd L1-L134

Configuration File Structure

File Location

The configuration file is stored at:

user://tajs_mod_config.json

On Windows, this typically resolves to:

%APPDATA%/Godot/app_userdata/Upload Labs/tajs_mod_config.json

Sources: extensions/scripts/utilities/config_manager.gd L10

Configuration Schema

The configuration is organized into logical categories matching the Settings UI tabs:

flowchart TD

Config["tajs_mod_config.json"]
General["General Settings"]
Visual["Visual Settings"]
Palette["Palette Settings"]
Debug["Debug Settings"]
NodeLimit["node_limit<br>screenshot_quality<br>screenshot_watermark"]
InputFeatures["select_all_enabled<br>command_palette_enabled<br>wire_drop_menu_enabled"]
UIFeatures["goto_group_enabled<br>buy_max_enabled<br>six_input_containers"]
Audio["mute_on_focus_loss<br>background_volume"]
Glow["extra_glow<br>glow_intensity<br>glow_strength<br>glow_bloom"]
UI["ui_opacity"]
PaletteOpts["palette_tools_enabled"]
DebugOpts["custom_boot_screen"]

Config --> General
Config --> Visual
Config --> Palette
Config --> Debug
General --> NodeLimit
General --> InputFeatures
General --> UIFeatures
General --> Audio
Visual --> Glow
Visual --> UI
Palette --> PaletteOpts
Debug --> DebugOpts

Sources: extensions/scripts/utilities/config_manager.gd L12-L54

Example Configuration File

{
    "node_limit": 400,
    "screenshot_quality": 2,
    "screenshot_watermark": true,
    "select_all_enabled": true,
    "command_palette_enabled": true,
    "wire_drop_menu_enabled": true,
    "right_click_clear_enabled": true,
    "goto_group_enabled": true,
    "buy_max_enabled": true,
    "z_order_fix_enabled": true,
    "disable_slider_scroll": false,
    "mute_on_focus_loss": true,
    "background_volume": 0.0,
    "drag_dead_zone": 5,
    "six_input_containers": true,
    "extra_glow": false,
    "glow_intensity": 2.0,
    "glow_strength": 1.3,
    "glow_bloom": 0.2,
    "glow_sensitivity": 0.8,
    "ui_opacity": 100.0,
    "palette_tools_enabled": false,
    "highlight_disconnected_enabled": true,
    "highlight_disconnected_style": "pulse",
    "highlight_disconnected_intensity": 0.5,
    "highlight_disconnected_debug": false,
    "notification_log_enabled": true,
    "custom_boot_screen": true
}

Sources: extensions/scripts/utilities/config_manager.gd L12-L54

Configuration Categories

General Settings

Key	Type	Default	Description
`node_limit`	int	400	Maximum nodes allowed in workspace
`screenshot_quality`	int	2	Screenshot resolution (0=Low, 1=Med, 2=High, 3=Original)
`screenshot_watermark`	bool	true	Add Taj’s Mod watermark to screenshots
`select_all_enabled`	bool	true	Enable Ctrl+A to select all nodes
`command_palette_enabled`	bool	true	Enable middle-click command palette
`wire_drop_menu_enabled`	bool	true	Enable wire drop node menu
`right_click_clear_enabled`	bool	true	Enable right-click to clear wires
`goto_group_enabled`	bool	true	Enable “Go To Group” panel button
`buy_max_enabled`	bool	true	Enable Buy Max button in upgrades
`z_order_fix_enabled`	bool	true	Fix node group z-order rendering
`disable_slider_scroll`	bool	false	Disable scroll wheel on sliders
`six_input_containers`	bool	true	Increase container inputs from 4 to 6

Sources: extensions/scripts/utilities/config_manager.gd L13-L35

Audio Settings

Key	Type	Default	Description
`mute_on_focus_loss`	bool	true	Mute audio when window loses focus
`background_volume`	float	0.0	Volume when unfocused (0-100%, 0=mute)

Sources: extensions/scripts/utilities/config_manager.gd L30-L31

Input Settings

Key	Type	Default	Description
`drag_dead_zone`	int	5	Pixels before drag operation starts

Sources: extensions/scripts/utilities/config_manager.gd L33

Visual Settings

Key	Type	Default	Description
`extra_glow`	bool	false	Enable enhanced glow effects
`glow_intensity`	float	2.0	Glow brightness multiplier
`glow_strength`	float	1.3	Glow effect strength
`glow_bloom`	float	0.2	Bloom amount for glow
`glow_sensitivity`	float	0.8	Glow threshold sensitivity
`ui_opacity`	float	100.0	HUD transparency (0-100%)

Sources: extensions/scripts/utilities/config_manager.gd L37-L42

Palette Settings

Key	Type	Default	Description
`palette_tools_enabled`	bool	false	Enable palette tool features

Sources: extensions/scripts/utilities/config_manager.gd L44

Disconnected Node Highlighting

Key	Type	Default	Description
`highlight_disconnected_enabled`	bool	true	Enable disconnected node highlighting
`highlight_disconnected_style`	string	”pulse”	Highlight style (“pulse” or “outline”)
`highlight_disconnected_intensity`	float	0.5	Highlight effect intensity
`highlight_disconnected_debug`	bool	false	Enable debug logging for highlighting

Sources: extensions/scripts/utilities/config_manager.gd L46-L49

Notification Settings

Key	Type	Default	Description
`notification_log_enabled`	bool	true	Enable notification history log

Sources: extensions/scripts/utilities/config_manager.gd L51

Debug Settings

Key	Type	Default	Description
`custom_boot_screen`	bool	true	Show custom Taj’s Mod boot screen

Sources: extensions/scripts/utilities/config_manager.gd L53

Accessing Settings In-Game

Settings Panel Access

The primary interface for modifying configuration is the Settings Panel:

flowchart TD

HUD["Game HUD"]
Button["Puzzle-piece Button<br>(Top-right)"]
Panel["Settings Panel"]
Tab1["General Tab"]
Tab2["Visuals Tab"]
Tab3["Cheats Tab"]
Tab4["Debug Tab"]
Apply["Immediate Apply<br>via config_manager.set_value()"]
Save["Auto-save to<br>tajs_mod_config.json"]

HUD --> Button
Button --> Panel
Panel --> Tab1
Panel --> Tab2
Panel --> Tab3
Panel --> Tab4
Tab1 --> Apply
Tab2 --> Apply
Tab3 --> Apply
Tab4 --> Apply
Apply --> Save

Look for the puzzle-piece icon in the top-right of the HUD
Click to open the Settings Panel
Navigate between tabs using the tab buttons
Modify settings using checkboxes, sliders, and input fields
Changes are immediately applied and saved

Sources: README.md L24

Command Palette Access

Some settings can be toggled via the Command Palette:

Press Middle Mouse Button or Spacebar to open the palette
Type a setting name (e.g., “glow”, “node limit”)
Execute the command to toggle or modify the setting
Changes are immediately saved to configuration

Sources: README.md L36-L39

Configuration Manager API

Initialization

The TajsModConfigManager is instantiated early in the mod lifecycle:

# In mod_main.gd _init()
var config_manager := TajsModConfigManager.new()

Sources: extensions/scripts/utilities/config_manager.gd L58-L60

Reading Configuration Values

# Basic read with fallback to default
var node_limit = config_manager.get_value("node_limit")

# Read with custom override
var quality = config_manager.get_value("screenshot_quality", 1)

# Returns null if key doesn't exist and no override provided
var unknown = config_manager.get_value("nonexistent_key")

The get_value() method follows this resolution order:

User configuration file value (if exists)
default_override parameter (if provided)
DEFAULT_CONFIG dictionary value (if exists)
null (if not found anywhere)

Sources: extensions/scripts/utilities/config_manager.gd L110-L117

Writing Configuration Values

# Set a value (automatically saves to disk)
config_manager.set_value("node_limit", 800)

# Enable a feature
config_manager.set_value("extra_glow", true)

# Adjust intensity
config_manager.set_value("glow_intensity", 2.5)

Every call to set_value() triggers an immediate save_config() operation, ensuring persistence.

Sources: extensions/scripts/utilities/config_manager.gd L119-L121

Resetting Configuration

# Reset all settings to defaults
config_manager.reset_to_defaults()

This operation:

Deletes the user configuration file
Resets the in-memory _config dictionary to DEFAULT_CONFIG
Saves the default configuration to disk

Sources: extensions/scripts/utilities/config_manager.gd L126-L133

Retrieving All Configuration

# Get a copy of the entire configuration
var all_config = config_manager.get_all()

# Returns a duplicate dictionary to prevent external mutation

Sources: extensions/scripts/utilities/config_manager.gd L123-L124

Configuration Lifecycle

sequenceDiagram
  participant Mod Loader
  participant mod_main.gd
  participant ConfigManager
  participant File System
  participant Settings UI

  Mod Loader->>mod_main.gd: Load mod
  mod_main.gd->>ConfigManager: new ConfigManager()
  ConfigManager->>ConfigManager: _init()
  ConfigManager->>ConfigManager: _config = DEFAULT_CONFIG.duplicate()
  ConfigManager->>ConfigManager: load_config()
  loop [Config file exists]
    ConfigManager->>File System: Read user://tajs_mod_config.json
    File System->>ConfigManager: JSON data
    ConfigManager->>ConfigManager: Merge user config with defaults
    ConfigManager->>File System: Create default config
  end
  note over ConfigManager: Config ready for use
  mod_main.gd->>ConfigManager: get_value("node_limit")
  ConfigManager->>mod_main.gd: 400
  Settings UI->>ConfigManager: set_value("node_limit", 800)
  ConfigManager->>ConfigManager: _config["node_limit"] = 800
  ConfigManager->>ConfigManager: save_config()
  ConfigManager->>File System: Write JSON to disk
  File System->>ConfigManager: Success

Key Lifecycle Events:

Mod Load: ConfigManager instantiated during mod_main.gd _init()
Initial Load: load_config() reads from disk or creates defaults
Runtime Access: get_value() called by features throughout execution
Setting Changes: set_value() immediately persists to disk
Reset: Optional reset_to_defaults() wipes user config

Sources: extensions/scripts/utilities/config_manager.gd L58-L133

Configuration Persistence Strategy

Write-Through Caching

Taj’s Mod uses a write-through cache strategy:

All reads come from the in-memory _config dictionary (fast)
All writes go to both memory and disk immediately (durable)
No deferred write or batching (simple, reliable)

File Format

Configuration is stored as pretty-printed JSON with tab indentation:

var json_string := JSON.stringify(_config, "\t")

This makes the file human-readable and easy to edit manually if needed.

Sources: extensions/scripts/utilities/config_manager.gd L103

Error Handling

The configuration system includes basic error handling:

if !FileAccess.file_exists(CONFIG_PATH):
    ModLoaderLog.info("No config file found, using defaults.", LOG_NAME)
    save_config()
    return

Missing files trigger default creation
Parse errors log to console and continue with defaults
Write failures log errors but don’t crash the mod

Sources: extensions/scripts/utilities/config_manager.gd L63-L71

extensions/scripts/utilities/config_manager.gd L96-L98

Advanced: Custom Configuration Keys

The configuration system supports arbitrary keys beyond DEFAULT_CONFIG:

# In config loading (line 90-92)
for key in loaded_data:
    if !DEFAULT_CONFIG.has(key):
        _config[key] = loaded_data[key]

This allows features to store custom data (e.g., wire_colors_hex for wire color customization) without modifying DEFAULT_CONFIG.

Example:

# Store custom wire colors
config_manager.set_value("wire_colors_hex", {
    "Input": "#FF6B6B",
    "Output": "#4ECDC4",
    "Logic": "#FFE66D"
})

# Retrieve later
var wire_colors = config_manager.get_value("wire_colors_hex", {})

Sources: extensions/scripts/utilities/config_manager.gd L89-L92

Troubleshooting

Configuration Not Persisting

Symptoms: Settings reset after game restart

Solutions:

Check file permissions on %APPDATA%/Godot/app_userdata/Upload Labs/
Verify the config file exists at user://tajs_mod_config.json
Check mod logs for file write errors
Try resetting to defaults via Settings UI

Invalid Configuration Values

Symptoms: Settings show unexpected values or don’t apply

Solutions:

Open Settings Panel and use “Reset All Settings”
Manually delete tajs_mod_config.json and restart
Verify the file contains valid JSON (use a JSON validator)

Mod Settings Not Appearing

Symptoms: No puzzle-piece button in HUD

Solutions:

Verify mod is installed correctly via Steam Workshop or manual installation
Check that Mod Loader version is 7.0.0 or higher
Check for mod load errors in the game console
Ensure game version is 2.0.17 or higher

Sources: README.md L75-L80

manifest.json L9-L13