Obsidian Local Images Plus

The plugin automatically handles media localization when you paste content or embed files.

Automatic Processing

You can enable Automatic processing in the plugin settings so that localization happens immediately upon pasting.

Supported Actions

• Copy/Paste: Copy web content or content from Word/Open Office documents and paste it into a note or Canvas. The plugin will download the media files to your local vault.
• Markdown Embedding: You can insert remote files using standard markdown syntax. The plugin will download them to your attachments folder:
  • Web files: ![description](http://mysite/mypdf.pdf)
  • Local files: ![description](file:///mylinuxdisk/mysong.mp3)
• Base64 Images: The plugin saves base64 embedded images to your vault.

Manual Commands

You can trigger localization manually via the Command Palette:

• Localize attachments for the current note (plugin folder): Processes the active note and saves attachments in the folder configured in the plugin settings.
• Localize attachments for the current note (Obsidian folder): Processes the active note and saves attachments in the folder configured in the Obsidian settings.
• Localize attachments for all your notes (plugin folder): Processes all notes in your vault that match the Include parameter in the plugin settings.

Warning: This plugin can modify all your notes at once. It is highly recommended to perform regular backups of your files.

The plugin automates the process of downloading remote images and moving them into your local vault. It works through several mechanisms:

Manual Processing

Users can trigger localization for a single note or the entire vault using the commands mentioned above. This replaces remote URLs with local paths.

Real-time Updates (Paste & Create)

• On Paste: If realTimeUpdate is enabled in settings, the plugin intercepts editor-paste events. If it detects media links in the clipboard content, it enqueues the active page for processing.
• On File Creation: When a new Markdown file is created, the plugin can automatically trigger the localization process for that file if processCreated is enabled.

Automated Queue Processing

Modified files are added to a modifiedQueue. A background interval (configured by realTimeUpdateInterval) periodically processes this queue to ensure that images are downloaded and links are updated without blocking the main UI thread.

The plugin is configured via the ISettings interface. These settings control how images are processed, where they are saved, and how the plugin interacts with your Obsidian vault.

Key configuration categories include:

• Processing Behavior: processCreated (process new files), processAll (process existing files), realTimeUpdate (enable/disable real-time monitoring), and filesizeLimit.
• Storage & Paths: mediaRootDir (defines the destination directory, e.g., _resources/${notename}), saveAttE (where to save attachments), and pathInTags.
• Image Optimization: ImgCompressionType (e.g., image/jpeg), JpegQuality (0-100), PngToJpeg, and PngToJpegLocal.
• Filtering: ignoredExt (extensions to ignore), includeps (file types to include), and ExcludedFoldersList / ExcludedFoldersListRegexp for skipping specific directories.
• Cleanup: removeMediaFolder and removeOrphansCompl.

Default settings are provided in DEFAULT_SETTINGS to ensure a functional baseline.

// Example of the shape of the settings object
const settings: ISettings = {
  processCreated: true,
  ignoredExt: "cnt|php|htm|html",
  processAll: true,
  useCaptions: true,
  pathInTags: "fullDirPath",
  downUnknown: false,
  saveAttE: "obsFolder",
  realTimeUpdate: true,
  filesizeLimit: 0,
  tryCount: 2,
  realTimeUpdateInterval: 5,
  addNameOfFile: true,
  showNotifications: true,
  includeps: "md|canvas",
  includepattern: "(?<md>.*\\.md)|(?<canvas>.*\\.canvas)",
  mediaRootDir: "_resources/${notename}",
  disAddCom: false,
  useMD5ForNewAtt: true,
  removeMediaFolder: true,
  removeOrphansCompl: false,
  PngToJpeg: false,
  PngToJpegLocal: true,
  JpegQuality: 80,
  DoNotCreateObsFolder: false,
  DateFormat: "YYYY MM DD",
  ImgCompressionType: "image/jpeg",
  ExcludedFoldersList: "",
  ExcludedFoldersListRegexp: ""
};