Configuration Reference
Settings Schema
The settings.json file follows this TypeScript interface structure:
interface Orynt3DSettings {
// Core application settings
app: {
theme: 'light' | 'dark' | 'auto';
language: string;
autoUpdate: boolean;
startMinimized: boolean;
};
// Library and scanning configuration
library: {
defaultImportPath: string;
scanDirectories: string[];
watchForChanges: boolean;
autoScan: boolean;
scanInterval: number; // minutes
supportedFormats: string[];
};
// Display and UI preferences
display: {
gridSize: 'small' | 'medium' | 'large';
showThumbnails: boolean;
thumbnailQuality: 'low' | 'medium' | 'high';
previewSize: number;
sortBy: 'name' | 'date' | 'size' | 'type';
sortOrder: 'asc' | 'desc';
};
// Performance and caching
performance: {
maxMemoryUsage: number; // MB
thumbnailCacheSize: number; // MB
backgroundProcessing: boolean;
maxConcurrentScans: number;
dbOptimizeInterval: number; // hours
};
// Import and processing settings
import: {
preserveStructure: boolean;
autoTag: boolean;
defaultTags: string[];
filenameAsName: boolean;
extractMetadata: boolean;
};
}
Configuration Examples
Basic Configuration
{
"app": {
"theme": "auto",
"language": "en",
"autoUpdate": true,
"startMinimized": false
},
"library": {
"defaultImportPath": "~/Models",
"scanDirectories": ["~/Models", "~/Downloads/STL"],
"watchForChanges": true,
"autoScan": false,
"scanInterval": 60
}
}
Performance-Optimized Configuration
{
"performance": {
"maxMemoryUsage": 2048,
"thumbnailCacheSize": 512,
"backgroundProcessing": true,
"maxConcurrentScans": 4,
"dbOptimizeInterval": 24
},
"display": {
"thumbnailQuality": "medium",
"previewSize": 256
}
}
Property Reference
App Settings
- theme: UI theme preference
- language: Interface language (ISO code)
- autoUpdate: Enable automatic updates
- startMinimized: Launch minimized to system tray
Library Settings
- defaultImportPath: Default directory for new imports
- scanDirectories: Directories to monitor for models
- watchForChanges: Real-time filesystem monitoring
- autoScan: Periodic automatic scanning
- scanInterval: Minutes between automatic scans
Display Settings
- gridSize: Thumbnail grid density
- showThumbnails: Enable preview thumbnails
- thumbnailQuality: Balance between quality and performance
- sortBy/sortOrder: Default sorting preferences
Performance Settings
- maxMemoryUsage: Memory limit in megabytes
- thumbnailCacheSize: Disk cache size for thumbnails
- maxConcurrentScans: Parallel scanning operations
- dbOptimizeInterval: Database maintenance frequency
Default Values
When settings.json doesn't exist, Orynt3D uses these defaults:
{
"app": {
"theme": "auto",
"language": "en",
"autoUpdate": true,
"startMinimized": false
},
"library": {
"scanDirectories": [],
"watchForChanges": true,
"autoScan": false,
"scanInterval": 60,
"supportedFormats": ["stl", "obj", "3mf", "amf", "ply"]
},
"display": {
"gridSize": "medium",
"thumbnailQuality": "medium",
"sortBy": "name",
"sortOrder": "asc"
},
"performance": {
"maxMemoryUsage": 1024,
"thumbnailCacheSize": 256,
"backgroundProcessing": true,
"maxConcurrentScans": 2
}
}
Validation
Settings are validated on startup. Invalid values are replaced with defaults and logged as warnings. The application will continue to run with corrected settings.