Namespace Scylla.Core.Config

Classes

ConfigFileManager

Static orchestrator for the layered config file system. Manages global enable/disable state based on build type (debug vs production) and resolves layered overrides from user documents and app folder config files. Per-config enable/disable is handled by each ScyllaConfiguration instance.

Thread Safety: This class is NOT thread-safe. All methods must be called from Unity's main thread.

ConfigurationRegistry

Default implementation of IConfigurationRegistry for managing multiple ScyllaConfiguration assets within a single owner (typically a module or the bootstrap). Provides O(1) lookup by concrete type using an internal dictionary and maintains stable registration order using a parallel list for deterministic iteration during validation and application.

ConfigurationSlotAttribute

Marks a serialized ScyllaConfiguration field on a ScyllaModule (or the bootstrap) as a configuration slot, declaring the asset that the module requires or optionally accepts. Configuration slots define which configuration assets a module supports, how they should be auto-loaded at startup, and how they are labeled and ordered in the Inspector.

ConsoleLoggingSettings

Controls which metadata components appear on each line written to the Unity console via UnityConsoleLog. All boolean flags are independent and can be combined freely.

FileLogFormattingSettings

Controls the output format and metadata components written to each entry in log files produced by FileLog. These settings are independent of ConsoleLoggingSettings and are applied only to the on-disk log.

FileLoggingSettings

Settings that govern the behavior of the FileLog receiver, including file rotation policy, disk space protection, directory location, and the async write pipeline.

ScyllaConfiguration

Abstract base class for all Scylla configuration UnityEngine.ScriptableObject assets. Provides a shared contract for validation, default-reset, runtime application, and config-file integration across every module configuration in the framework.

Concrete subclasses must implement Validate() to return ConfigurationValidationResult diagnostics and ResetToDefaults() to restore all fields to their authored defaults. Optionally, subclasses can override Apply() to push configuration values to live runtime systems, GetConfigFileName() to declare a config-file name for JSON override support, ApplyConfigFileOverrides(ConfigFile) to read values from a loaded ConfigFile, and ExportToConfigFile() to write current values back to a ConfigFile.

The config-file system uses a two-level enable gate: the global switch on ScyllaCoreConfiguration (managed by ConfigFileManager) must be on, and the per-configuration switch exposed by IsConfigFileEnabledForCurrentBuild() must also be on, before any JSON overrides are applied to a configuration.

In the Unity Editor, any change made to an Inspector field during Play Mode automatically schedules a deferred call to Apply() so that runtime systems reflect the updated values immediately without requiring a restart.

ScyllaCoreConfiguration

Core framework configuration asset containing initialization settings that govern how ScyllaBootstrap starts up the framework and whether the JSON-based config file system is active at runtime.

This configuration can be assigned directly to ScyllaBootstrap in the Inspector to control framework behavior, or loaded automatically from the Resources/Config/ folder at runtime via LoadDefault(). When neither is available, ScyllaBootstrap falls back to built-in default values.

The global config file switches on this asset (ConfigFilesEnabledInDebugBuild, ConfigFilesEnabledInProductionBuild, CreateConfigFiles) act as master gates passed to ConfigFileManager during bootstrap. They determine whether JSON overrides are loaded for any configuration in the project. Per-configuration switches inherited from ScyllaConfiguration only take effect when the global gate is open.

Logging settings are managed separately via ScyllaLoggerConfiguration.

ScyllaEventConfiguration

Configuration asset for the Scylla Event eXchange System (SEX) that controls subscriber leak detection thresholds and exception handling behavior during event dispatch.

This configuration can be assigned to ScyllaBootstrap in the Inspector to tune event bus behavior, or loaded automatically from the Resources/Config/ folder at runtime via LoadDefault(). When neither is available, ScyllaBootstrap falls back to built-in default values.

Subscriber leak detection: The event bus monitors the number of active subscriptions per event type. When the count reaches SubscriberWarningThreshold, a warning is logged to alert developers to a potential subscription leak. When the count reaches SubscriberLimit, an InvalidOperationException is thrown to prevent unbounded memory growth.

Exception isolation: When ExceptionIsolation is enabled (the default), handler exceptions are caught, logged, and dispatch continues to remaining handlers. When disabled, the first handler exception propagates out of Publish, which is useful during development for breaking on errors immediately.

ScyllaLoggerConfiguration

ScyllaConfiguration asset that controls every aspect of the Scylla logging system: whether logging is active, the minimum severity level that passes the filter, whether log files are written to disk, how console and file entries are formatted, and how large the early-startup entry buffer may grow.

Structs

ConfigurationValidationResult

An immutable, read-only value type that carries a single result produced by Validate().

Each result has a Severity level, a human-readable Message, and an optional FieldName that identifies which serialized field the result relates to. The field name is used by the custom Inspector to highlight the offending field directly in the Unity Inspector.

Use the static factory methods Info(string, string), Warning(string, string), and Error(string, string) rather than the constructor directly, as they make call-site intent immediately clear.

Interfaces

IConfigurationRegistry

Contract for a registry that manages a collection of ScyllaConfiguration assets associated with a single owner (typically a module or the bootstrap). Provides O(1) lookup by concrete type and maintains stable registration order for deterministic iteration during validation and application.

Enums

ValidationSeverity

Represents the severity level of a ConfigurationValidationResult. Severity determines how the framework and Inspector treat a validation message: informational results are displayed for awareness, warnings flag potential problems, and errors block the configuration from being considered valid by IsValid().