Skip to content

DIMFLIX/obsidian-memories

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

10 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Obsidian Memories





Obsidian Memories is a powerful plugin for Obsidian that transforms your media files into beautiful interactive galleries right inside your notes. View images, videos, and audio with support for fullscreen mode, slideshows, and advanced navigation features.

โœจ Features

๐ŸŽจ Flexible Display

  • Responsive grid โ€” automatic layout for any screen size
  • Two display modes โ€” full and compact
  • Customizable size โ€” control grid element size
  • Lazy loading โ€” performance optimization for large collections
  • ๐Ÿ“ค Built-in file manager โ€” upload and delete media directly from the gallery

๐Ÿ” Advanced Lightbox

  • Image zoom โ€” zoom with panning support
  • Multimedia support โ€” images, videos, and audio files
  • Interactive thumbnails โ€” quick navigation through the collection
  • Keyboard shortcuts โ€” full keyboard control

โšก Smart Features

  • Auto slideshow โ€” automatic switching with customizable interval
  • Random mode โ€” random media navigation
  • Flexible sorting โ€” by date, name, or random order
  • Thumbnail caching โ€” fast loading for video files

๐Ÿ“ Universal Sources

  • Multiple paths โ€” media from multiple folders simultaneously
  • Recursive search โ€” scanning all nested folders
  • Root access โ€” display all vault media files

๐ŸŒŒ Visual Overview

๐Ÿ“ฆ Installation

Method 1: Via Community Plugins (recommended)

  1. Open Settings โ†’ Community plugins
  2. Disable Restricted mode if enabled
  3. Click Browse and search for "Memories"
  4. Click Install, then Enable

Method 2: Manual Installation

  1. Download the latest version from releases
  2. Create a folder memories in .obsidian/plugins/ of your vault
  3. Extract the files into the created folder
  4. Reload Obsidian and activate the plugin in settings

๐Ÿš€ Usage

Basic Syntax

Create a code block with type memories in your note:

```memories
paths: Photos/
sort: date-desc
type: compact
limit: 9
```

Full Configuration

```memories
paths: Photos/Vacation, Photos/Family
sort: date-desc
type: full
size: 250
lazy: true
limit: 12
```

โš™๏ธ Configuration Parameters

๐Ÿ“ Specifying Paths

Single folder:

paths: Photos/Vacation

Multiple folders:

paths: Photos/Vacation, Photos/Family, Media/Videos

All media from vault:

paths: ./

๐Ÿ”„ Sorting

sort: date-desc

Available options:

  • date-desc โ€” by date (newest first) โฐ
  • date-asc โ€” by date (oldest first) ๐Ÿ•ฐ๏ธ
  • name-asc โ€” by name (alphabetical) ๐Ÿ”ค
  • random โ€” random order ๐ŸŽฒ

๐ŸŽฏ Display Modes

Full gallery:

type: full

Displays all media files in the selected folders.

Compact mode:

type: compact
limit: 6

Shows a limited number of files with the ability to view all in lightbox.

โšก Performance

lazy: true
size: 200
  • lazy โ€” lazy loading for performance optimization
  • size โ€” grid element size in pixels

๐ŸŽฎ Lightbox Controls

โŒจ๏ธ Keyboard Shortcuts

  • โ† / โ†’ โ€” previous/next media
  • Space โ€” start/stop slideshow
  • Esc โ€” close lightbox
  • Mouse wheel โ€” navigate through media

๐Ÿ–ฑ๏ธ Image Controls

  • Left click โ€” zoom in (up to 5x)
  • Right click โ€” zoom out
  • Wheel on image โ€” smooth zooming
  • Drag โ€” panning when zoomed

๐ŸŽช Additional Features

  • ๐ŸŽฒ Random โ€” random navigation through collection
  • โ–ถ๏ธ Slideshow โ€” automatic slideshow (interval 1-60 sec)
  • ๐Ÿ“Š Information โ€” file size and modification date
  • ๐Ÿ“ Open in explorer โ€” quick file access

๐ŸŽจ Supported Formats

๐Ÿ–ผ๏ธ Images

  • Basic: JPG, JPEG, PNG, GIF, BMP, SVG, WebP
  • Extended: TIFF, TIF, AVIF, HEIC, HEIF, ICO

๐ŸŽฅ Video

  • Modern: MP4, WebM, OGV, MOV
  • Classic: AVI, MKV, FLV, WMV, 3GP, M4V
  • Professional: MPG, MPEG, M2V, ASF

๐ŸŽต Audio

  • Popular: MP3, WAV, FLAC, OGG, AAC, M4A
  • Specialized: WMA, Opus, AIFF, AU

โšก Performance

๐Ÿš€ Optimizations

  • Lazy loading โ€” elements load as you scroll
  • Thumbnail caching โ€” fast previews for video files
  • Virtualization โ€” efficient display of large collections
  • Intelligent observation โ€” Intersection Observer for smooth operation

๐Ÿ“Š Recommendations

  • Use lazy: true for galleries with more than 20 items
  • Optimal size is 200-300 pixels for balance between detail and performance
  • Compact mode (type: compact) for quick viewing of large collections

๐Ÿ› Troubleshooting

๐Ÿ” Gallery Not Displaying

  • Check the folder path is correct
  • Ensure the folder contains supported media files
  • Verify the code block syntax

๐ŸŽฅ Videos Not Playing

  • Ensure the format is supported by your browser
  • Check video file integrity
  • For problematic formats, use MP4 as a universal option

โšก Slow Loading

  • Enable lazy loading: lazy: true
  • Use compact mode for large collections
  • Ensure video thumbnails are cached

๐Ÿ”ง Technical Diagnostics

  • Open developer console (Ctrl+Shift+I) to view errors
  • Check file access permissions
  • Ensure the plugin is activated in settings

๐Ÿค Support and Development

๐Ÿ“ Bug Reports

Found a bug? Create an issue with detailed description:

  • Steps to reproduce
  • Expected and actual behavior
  • Obsidian and plugin version

๐Ÿ’ก Feature Suggestions

Have an idea for improvement? We welcome suggestions! Describe:

  • What problem your suggestion solves
  • Specific implementation option
  • Usage examples

๐ŸŒŸ Support the Project

  • โญ Star on GitHub
  • ๐Ÿ“ข Share about the plugin on social media
  • ๐Ÿ’ป Participate in development through PRs

๐Ÿ“„ License

The plugin is distributed as an open-source project under the MIT license.


Made with โค๏ธ for the Obsidian community

โญ Star on GitHub ยท ๐Ÿ› Report Bug ยท ๐Ÿ’ก Request Feature

About

Plugin to display a gallery directly in a note.

Resources

License

Stars

Watchers

Forks

Packages

No packages published