Skip to content

Framework Object & File Database

Jump to bottom
github-actions[bot] edited this page Jun 16, 2026 · 19 revisions

Table of Contents

This Wiki page was last updated for [\textcolor{aqua}{Stellaris}] version v4.4.*

You can see The Name Convention for these Files and Objects in Framework Name Convention for Objects and Files wiki page.

1. 🌐 Architectural Layer: Omnipresent Runtime Hooks & Memory States

This foundational infrastructure holds global engine pointers, mathematical script constraints, and systemic memory registries accessible across all scopes.

1.1. 📊 Scripted Global Variable Constants (GLOBALVAR)

  • Paradox Target Directory: common/scripted_variables/
  • Rule Reminder: Loaded via FIOS rules. Must be prefixed with @ inside scripts. The trailing custom purpose string block must stay strictly lowercase and under 20 characters to preserve parsing memory footprints.

1.1.1. 🆔 DEBCF_GLOBALVAR_NOSCOPE_<purpose>

  • File Location & Properties:
    • Path: common/scripted_variables/!_DEBCF_core_variables.txt
    • Calling Reference Format: @DEBCF_GLOBALVAR_NOSCOPE_<purpose>
  • Scope Context Constraints:
    • Target Scope: Global script compilation layer
    • Persistence: Static baseline compile register
  • Context Summary & Implementation Details:
    • [Log the fixed mathematical float value, integer constant, or static mod check parameter defined for global file parsing usage.]

Tip

Example Entry: DEBCF_GLOBALVAR_NOSCOPE_nanite_base_growth

  • File Location & Properties:
    • Path: common/scripted_variables/!_DEBCF_core_variables.txt
    • Calling Reference Format: @DEBCF_GLOBALVAR_NOSCOPE_nanite_base_growth
  • Scope Context Constraints:
    • Target Scope: Global script compilation layer
    • Persistence: Static baseline compile register (Hardcoded value: 1.50)
  • Context Summary & Implementation Details:
    • Defines the foundational background growth acceleration coefficient utilized across all script systems to scale infection multipliers uniformly.

1.2. 📊 Scripted Local Variable Macros (LOCALVAR)

  • Rule Reminder: Local macros are file-bound string block replacements parsed dynamically during scope setup routines.

1.2.1. 🆔 DEBCF_LOCALVAR_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: Embedded directly within calling file header blocks
  • Scope Context Constraints:
    • Target Scope: File-isolated scope block boundaries
    • Persistence: Discarded instantly once compilation finishes
  • Context Summary & Implementation Details:
    • [Document the local macro string substitution logic, math overrides, or conditional inline case blocks bounded to this entry.]

Tip

Example Entry: DEBCF_LOCALVAR_PLANET_clearance_modifier

  • File Location & Properties:
    • Path: Embedded locally inside common/buildings/DEBCF_content_pack.txt
  • Scope Context Constraints:
    • Target Scope: PLANET (File runtime layer execution boundary)
    • Persistence: Discarded instantly once compilation finishes
  • Context Summary & Implementation Details:
    • Implements a local string script replacement macro that overrides infrastructure construction costs based on current planet classification layouts.

1.3. 📊 Dynamic Scope Saved Variables (VARIABLE)

  • Rule Reminder: Clear out runtime VARIABLE inputs systematically before execution leaves a scope block to protect stability. Keep purpose under 20 characters to respect the 64-character limit.

1.3.1. 🆔 DEBCF_VARIABLE_<SCOPE>_<purpose>

  • Registry Class Type: VARIABLE
  • Scope Context Constraints:
    • Target Scope: [e.g., COUNTRY / PLANET / FLEET / SYSTEM]
    • Persistence: Save File Cache Register (truncated silently past 64 total characters)
  • Context Summary & Implementation Details:
    • [Specify runtime persistence details, what scripts modify this value, and scope context rules needed to fetch this parameter accurately.]

Tip

Example Entry: DEBCF_VARIABLE_COUNTRY_active_incident_count

  • Registry Class Type: VARIABLE
  • Scope Context Constraints:
    • Target Scope: COUNTRY
    • Persistence: Saved securely inside the game save file
  • Context Summary & Implementation Details:
    • Tracks the real-time number of ongoing framework incidents active inside a sovereign country scope. It increments dynamically via monthly ticks and adjusts empire-wide modifier weights.

1.4. 📊 Galaxy Game-State Switches (GLOBALFLAG)

  • Rule Reminder: Global flags persist engine-wide. Overuse impacts memory lookup indexes; ensure unique naming formats to prevent naming collisions with other mods.

1.4.1. 🆔 DEBCF_GLOBALFLAG_<purpose>

  • Registry Class Type: GLOBALFLAG
  • Scope Context Constraints:
    • Target Scope: None (Global engine layer)
    • Persistence: Permanent complete save file duration
  • Context Summary & Implementation Details:
    • [Outline global runtime parameters, startup states, and subsystem compilation toggles mapped to this flag.]

Tip

Example Entry: DEBCF_GLOBALFLAG_core_library_boot_completed

  • Registry Class Type: GLOBALFLAG
  • Scope Context Constraints:
    • Target Scope: None (Global engine layer)
    • Persistence: Permanent complete save file duration
  • Context Summary & Implementation Details:
    • Dictates whether the framework mod engine has fully executed its baseline math and localization setup macros on the initial game load phase to block double-booting errors.

1.5. 📊 Scoped Entity Operational Flags (SCOPEFLAG)

  • Rule Reminder: Flags tied to specific entities clear automatically if the parent object is destroyed or annexed by script instructions.

1.5.1. 🆔 DEBCF_SCOPEFLAG_<SCOPE>_<purpose>

  • Registry Class Type: SCOPEFLAG
  • Scope Context Constraints:
    • Target Scope: [e.g., PLANET / POP / SECTOR / LEADER]
    • Persistence: Bound entirely to the lifetime of the parent entity context
  • Context Summary & Implementation Details:
    • [Detail boolean behavior, condition requirements, lifetime limits, and modification scopes.]

Tip

Example Entry: DEBCF_SCOPEFLAG_PLANET_scan_compliance_passed

  • Registry Class Type: SCOPEFLAG
  • Scope Context Constraints:
    • Target Scope: PLANET
    • Persistence: Lifetime of the planetary body entity
  • Context Summary & Implementation Details:
    • Affixes a binary pass/fail condition state to a specific colony world, flagging that it successfully cleared standard script array compliance diagnostics.

1.6. 📊 Persistent Global Event Targets (GLOBALTARGET)

  • Rule Reminder: Target references remain valid until explicitly overridden or wiped out via background clean script loops.

1.6.1. 🆔 DEBCF_GLOBALTARGET_<purpose>

  • Registry Class Type: GLOBALTARGET
  • Scope Context Constraints:
    • Target Scope: Global engine layer pointing to a specific nested object context
    • Persistence: Save file retention until cleared
  • Context Summary & Implementation Details:
    • [Document object target references managed by this variable to pass specific targets directly to distant events.]

Tip

Example Entry: DEBCF_GLOBALTARGET_crisis_origin_system_focus

  • Registry Class Type: GLOBALTARGET
  • Scope Context Constraints:
    • Target Scope: Global engine layer pointing to a specific nested object context
    • Persistence: Save file retention until cleared
  • Context Summary & Implementation Details:
    • Saves an absolute entity pointer reference directly to the star system containing the initial anomaly outburst, enabling asynchronous framework operations to locate it instantly without scanning the galaxy map.

1.7. 📊 Volatile Scoped Event Targets (TEMPTARGET)

  • Rule Reminder: Wiping local targets before events or script triggers finish running prevents severe engine object leak loops.

1.7.1. 🆔 DEBCF_TEMPTARGET_<purpose>

  • Registry Class Type: TEMPTARGET
  • Scope Context Constraints:
    • Target Scope: Immediate current script execution block
    • Persistence: Wiped automatically the split-second the calling event or trigger script terminates
  • Context Summary & Implementation Details:
    • [Detail brief usage patterns, sorting criteria, and immediate target validation scopes.]

Tip

Example Entry: DEBCF_TEMPTARGET_current_combat_aggressor

  • Registry Class Type: TEMPTARGET
  • Scope Context Constraints:
    • Target Scope: Immediate current script execution block
    • Persistence: Wiped automatically the split-second the calling event or trigger script terminates
  • Context Summary & Implementation Details:
    • Temporarily stores a local pointer to an attacking fleet during combat intercept event evaluations, discarding the memory registry as soon as the defensive responses are calculated.

2. ⚙️ Architectural Layer: Core Logic & Scripting Engines

This layer houses the foundational execution files, triggers, macros, diagnostic outputs, and text compilation mechanics that process the calculations of the framework.

2.1. 📜 Asynchronous Logic Routines (EVENT)

  • Paradox Target Directory: events/
  • Rule Reminder: Every event file must declare an all-uppercase namespace matching its prefix.

2.1.1. 🆔 DEBCF_EVENT_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: events/DEBCF_EVENT_<SCOPE>_<purpose>.txt
    • Namespace: DEBCF_EVENT_<SCOPE>
  • Database References:
    • Pointers Saved:
    • Connected Localisation Keys:
  • Context Summary & Implementation Details:
    • [Provide a detailed description outlining why this event fires, what triggers it, and the performance footprint it introduces to the monthly game tick.]

Tip

Example Entry: DEBCF_EVENT_COUNTRY_crisis_nanite_rebellion

  • File Location & Properties:
    • Path: events/DEBCF_EVENT_COUNTRY_crisis_nanite_rebellion.txt
    • Namespace: DEBCF_EVENT_COUNTRY
  • Database References:
    • Pointers Saved: DEBCF_VARIABLE_COUNTRY_nanite_leak_count
    • Connected Localisation Keys: DEBCF_EVENT_COUNTRY_nanite_collapse_delayed
  • Context Summary & Implementation Details:
    • Evaluates pop configurations across affected systems when rogue nanite clusters bypass containment protocols, deploying targeted empire modifier changes.

2.2. 🪝 Engine Pulse & Lifecycle Hooks (ACTION)

  • Paradox Target Directory: common/on_actions/

2.2.1. 🆔 DEBCF_ACTION_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: common/on_actions/DEBCF_ACTION_<SCOPE>_<purpose>.txt
  • Target Anchors:
    • Vanilla Overwrites:
    • Appended Hooks:
  • Context Summary & Implementation Details:
    • [Insert description of the engine hook being utilized, what event arrays it executes, and whether it overwrites or appends to vanilla core game loops.]

Tip

Example Entry: DEBCF_ACTION_GAME_on_monthly_pulse

  • File Location & Properties:
    • Path: common/on_actions/DEBCF_ACTION_GAME_on_monthly_pulse.txt
  • Target Anchors:
    • Vanilla Overwrites: None (Safe append injection layout)
    • Appended Hooks: DEBCF_EVENT_COUNTRY_crisis_nanite_rebellion
  • Context Summary & Implementation Details:
    • Appends framework evaluation blocks securely directly to the engine's core monthly calculation sequence to update metrics cleanly.

2.3. 📂 Structural Snippet Replicators (INLINE)

  • Paradox Target Directory: common/inline_scripts/

2.3.1. 🆔 DEBCF_INLINE_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: common/inline_scripts/DEBCF_INLINE_<SCOPE>_<purpose>.txt
  • Requirements:
    • Required Variables:
    • Macro Parameters:
  • Context Summary & Implementation Details:
    • [Detail the repetitive structural logic chunk contained inside this inline file. Note down explicit variable requirements needed before inserting this inline block into script files.]

Tip

Example Entry: DEBCF_INLINE_PLANET_clear_nanite_blockers

  • File Location & Properties:
    • Path: common/inline_scripts/DEBCF_INLINE_PLANET_clear_nanite_blockers.txt
  • Requirements:
    • Required Variables: DEBCF_VARIABLE_PLANET_pollution_severity
    • Macro Parameters: COST_MULTIPLIER = 1.2
  • Context Summary & Implementation Details:
    • Injects standardized resource clearance routines to wipe out anomalous blockages safely across worlds without script duplication bloat.

2.4. 💥 Parametric Command Blocks (SCEFFECT)

  • Paradox Target Directory: common/scripted_effects/
  • Rule Reminder: Every custom effect script manipulating economic balances or moving fleets must be wrapped in an explicit trigger validation layer to secure engine threads.

2.4.1. 🆔 DEBCF_SCEFFECT_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: common/scripted_effects/DEBCF_SCEFFECT_<SCOPE>_<purpose>.txt
  • Inputs & Outputs:
    • Inputs:
    • Validation Scopes:
  • Context Summary & Implementation Details:
    • [Provide a breakdown of the inputs required, the logic math applied, and validation targets to prevent unexpected null pointer crashes.]

Tip

Example Entry: DEBCF_SCEFFECT_COUNTRY_apply_stability_debuff

  • File Location & Properties:
    • Path: common/scripted_effects/DEBCF_SCEFFECT_COUNTRY_apply_stability_debuff.txt
  • Inputs & Outputs:
    • Inputs: DEBCF_VARIABLE_COUNTRY_nanite_leak_count
    • Validation Scopes: this = country
  • Context Summary & Implementation Details:
    • Implements rapid country adjustments, converting raw numerical metrics instantly into temporary public unrest trends inside localized sectors.

2.5. 💥 Conditional Engine Evaluators (SCTRIGGER)

  • Paradox Target Directory: common/scripted_triggers/
  • Rule Reminder: Triggers load using LIOS (Last In Only Served) rules. Duplicate file entries completely overwrite earlier definitions.

2.5.1. 🆔 DEBCF_SCTRIGGER_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: common/scripted_triggers/DEBCF_SCTRIGGER_<SCOPE>_<purpose>.txt
  • Inputs & Outputs:
    • Inputs:
    • Validation Scopes:
  • Context Summary & Implementation Details:
    • [Provide a complete technical structural breakdown of the checks performed and parameters evaluated.]

Tip

Example Entry: DEBCF_SCTRIGGER_FLEET_is_nanite_corrupted

  • File Location & Properties:
    • Path: common/scripted_triggers/DEBCF_SCTRIGGER_FLEET_is_nanite_corrupted.txt
  • Inputs & Outputs:
    • Inputs: Fleet design module layout composition strings
    • Validation Scopes: this = fleet
  • Context Summary & Implementation Details:
    • Validates if target ship hulls feature localized integrity failure codes before approving automated route navigation commands across system borders.

2.6. ⚠️ Diagnostic Failure Output Codes (ERROR)

  • Rule Reminder: Explicitly called via the native log_error effect block mechanism. Helps debug state breaks safely across the engineering team.

2.6.1. 🆔 DEBCF_ERROR_<SCOPE>_<purpose>

  • Calling Method Architecture: log_error = "DEBCF_ERROR_<SCOPE>_<purpose> [State Details]"
  • Scope Context Constraints:
    • Target Scope: System error tracking pipeline
    • Persistence: Written directly to the localized system logs on disk
  • Context Summary & Implementation Details:
    • [Log the fallback warning format, script break trap coordinates, or corrupted index registry information tied to this alert hook.]

Tip

Example Entry: DEBCF_ERROR_SYSTEM_pointer_lost_alert

  • Calling Method Architecture: log_error = "DEBCF_ERROR_SYSTEM_pointer_lost_alert: Starbase instance lookup array null or severed."
  • Scope Context Constraints:
    • Target Scope: System error tracking pipeline
    • Persistence: Written directly to the localized system logs on disk
  • Context Summary & Implementation Details:
    • Fires an explicit diagnostic tracking code when structural background events hit a broken scope reference pointer loop while querying space asset configurations.

3. 🖥️ Architectural Layer: Graphic Assets & Interface Systems

This layer handles the visual representation, rendering setups, clickable canvas blocks, and multi-lingual translation arrays.

3.1. 🎨 Low-Level Texture Mapping Indexes (GFX)

  • Paradox Target Directory: interface/ (.gfx maps)
  • Rule Reminder: Loaded via FIOS rules. Filenames and scripts must adhere to standard lowercase file extensions to pass strict cross-platform filesystem validation checks.

3.1.1. 🆔 DEBCF_GFX_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: interface/DEBCF_assets.gfx
  • Technical Specifications:
    • Format: .dds texture coordinate dictionary references
    • Casing Type: Enforced lowercase asset targets
  • Context Summary & Implementation Details:
    • [Detail raw asset pathways, frame sub-divisions, and orientation rules used to pass to visual menus.]

Tip

Example Entry: DEBCF_GFX_FLEET_status_diagnostic_icon

  • File Location & Properties:
    • Path: interface/DEBCF_assets.gfx
  • Technical Specifications:
    • Format: .dds sprite configuration mapping coordinates
    • Casing Type: Enforced lowercase asset targets
  • Context Summary & Implementation Details:
    • Links a 24x24 pixel status marker indicator texture cleanly to the galaxy overlay system interface to render hull health values.

3.2. 🎨 Sound Environment Matrices (SOUND)

  • Paradox Target Directory: sound/
  • Rule Reminder: Loaded via FIOS rules. File tracks must retain standard case precision inside scripts to pass Linux filesystem checks.

3.2.1. 🆔 DEBCF_SOUND_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: sound/DEBCF_audio_registry.sfx
  • Technical Specifications:
    • Format: .ogg or .wav spatial balance asset pathways
    • Casing Type: Strict casing matching file structures
  • Context Summary & Implementation Details:
    • [Log sound registry IDs, track mixing parameters, volume thresholds, and attenuation falloff patterns.]

Tip

Example Entry: DEBCF_SOUND_NOSCOPE_error_macro_alarm

  • File Location & Properties:
    • Path: sound/DEBCF_audio_registry.sfx
  • Technical Specifications:
    • Format: .wav media master target audio file
    • Casing Type: Strict casing matching file structures
  • Context Summary & Implementation Details:
    • Commands an immediate high-frequency alert sound play event globally to notify users if tracking systems cross unsafe memory loops.

3.3. 🖥️ Window Canvas Container Forms (GUI)

  • Paradox Target Directory: interface/
  • Rule Reminder: Interface configuration files load using FIOS rules. Duplicate visual components or variables loaded later are skipped by the parser.

3.3.1. 🆔 DEBCF_GUI_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: interface/DEBCF_GUI_<SCOPE>_<purpose>.gui
  • UI Layout Properties:
    • Screen Anchors:
    • Asset Mapping:
  • Context Summary & Implementation Details:
    • [Detail component coordinates, scaling rules for ultra-wide setups, and responsive design properties.]

Tip

Example Entry: DEBCF_GUI_NOSCOPE_framework_config_panel

  • File Location & Properties:
    • Path: interface/DEBCF_GUI_NOSCOPE_framework_config_panel.gui
  • UI Layout Properties:
    • Screen Anchors: center_up (Coordinates: X=400, Y=150)
    • Asset Mapping: DEBCF_GFX_NOSCOPE_menu_background
  • Context Summary & Implementation Details:
    • Renders the administrative settings panel interface screen box element cleanly on the user layout workspace display environment.

3.4. 🖥️ Clickable Interface Triggers (BUTTON)

  • Paradox Target Directory: interface/

3.4.1. 🆔 DEBCF_BUTTON_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: interface/DEBCF_GUI_<SCOPE>_<purpose>.gui (Embedded item definition block)
  • UI Layout Properties:
    • Screen Anchors:
    • Asset Mapping:
  • Context Summary & Implementation Details:
    • [Outline precise trigger box boundaries, cursor states, sound triggers, and calling script connections.]

Tip

Example Entry: DEBCF_BUTTON_NOSCOPE_execute_purge

  • File Location & Properties:
    • Path: interface/DEBCF_GUI_NOSCOPE_framework_config_panel.gui
  • UI Layout Properties:
    • Screen Anchors: bottom_right quadrant reference margins
    • Asset Mapping: DEBCF_GFX_NOSCOPE_execute_button_texture
  • Context Summary & Implementation Details:
    • Maps out the physical interaction layer assigned to fire administrative sweep systems manually via administrative HUD elements.

3.5. 🌍 Direct Text Entry Strings (LOCKEY)

  • Paradox Target Directory: localisation/english/
  • Rule Reminder: Every file MUST use UTF-8 with BOM file encoding patterns to protect multi-language setups from breaking Linux execution pipelines. Alterations targeting base game text keys must reside in localisation/replace/english/ subfolders to activate the engine's LIOS structural replacement routine.

3.5.1. 🆔 DEBCF_LOCKEY_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: localisation/english/DEBCF_l_english.yml
  • Suffix Schemes:
    • Arrays used:
    • Suffix Tags: _name, _desc, _tooltip, _delayed, _error
  • Context Summary & Implementation Details:
    • [Track raw text configurations and nested fallback formatting code entries inside localization maps.]

Tip

Example Entry: DEBCF_LOCKEY_COUNTRY_nanite_leak

  • File Location & Properties:
    • Path: localisation/english/DEBCF_l_english.yml
  • Suffix Schemes:
    • Arrays used: Standard English Mod Translation Array
    • Suffix Tags: DEBCF_LOCKEY_COUNTRY_nanite_leak_name, DEBCF_LOCKEY_COUNTRY_nanite_leak_desc
  • Context Summary & Implementation Details:
    • Translates abstract system error events into clear descriptions to describe core mechanics directly to players.

3.6. 🌍 Dynamic Script-Driven Translation Tables (SCRIPTEDLOC)

  • Paradox Target Directory: common/scripted_localisation/
  • Rule Reminder: Loaded via FIOS rules.

3.6.1. 🆔 DEBCF_SCRIPTEDLOC_<SCOPE>_<purpose>

  • File Location & Properties:
    • Path: common/scripted_localisation/DEBCF_SCRIPTEDLOC_<SCOPE>_<purpose>.txt
  • Suffix Schemes:
    • Arrays used:
    • Suffix Tags:
  • Context Summary & Implementation Details:
    • [Detail logic arrays evaluating data conditions to output translated keywords on the fly based on current target status.]

Tip

Example Entry: DEBCF_SCRIPTEDLOC_COUNTRY_get_ruler_pronoun

  • File Location & Properties:
    • Path: common/scripted_localisation/DEBCF_SCRIPTEDLOC_COUNTRY_get_ruler_pronoun.txt
  • Suffix Schemes:
    • Arrays used: GetDEBCFRulerPronoun
    • Suffix Tags: Dynamic conditional language values returned depending on leader traits.
  • Context Summary & Implementation Details:
    • Evaluates machine vs biological traits on active leader objects to swap dialog strings smoothly without requiring disjointed event text files.

Note

This is a Markdown file and is formatted for viewing in $$\textcolor{Gold}{Github}$$ only. VS Code Markdown Viewer Extensions gives some errors.

You can read the Markdown Wiki to learn how to use and modify these types of files.

This Documentation is for $$\textcolor{aqua}{Stellaris}$$ game. Pay attention to last time the Wiki page got updated.

Introduction & Using the Framework

Framework Modding (for Contributors)

Stellaris Modding & Gaming

Paradox Games Modding & Gaming

Generic Modding & Gaming

Git & Github Management

Other

Clone this wiki locally