**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](https://github.com/DIMFLIX/obsidian-memories/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:
````markdown
```memories
paths: Photos/
sort: date-desc
type: compact
limit: 9
```
````
### Full Configuration
````markdown
```memories
paths: Photos/Vacation, Photos/Family
sort: date-desc
type: full
size: 250
lazy: true
limit: 12
```
````
## โ๏ธ Configuration Parameters
### ๐ Specifying Paths
**Single folder:**
```yaml
paths: Photos/Vacation
```
**Multiple folders:**
```yaml
paths: Photos/Vacation, Photos/Family, Media/Videos
```
**All media from vault:**
```yaml
paths: ./
```
### ๐ Sorting
```yaml
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:**
```yaml
type: full
```
Displays all media files in the selected folders.
**Compact mode:**
```yaml
type: compact
limit: 6
```
Shows a limited number of files with the ability to view all in lightbox.
### โก Performance
```yaml
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](https://github.com/DIMFLIX/obsidian-memories/issues) 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](./LICENSE).
---
**Made with โค๏ธ for the Obsidian community**
[โญ Star on GitHub](https://github.com/DIMFLIX/obsidian-memories) ยท
[๐ Report Bug](https://github.com/DIMFLIX/obsidian-memories/issues) ยท
[๐ก Request Feature](https://github.com/DIMFLIX/obsidian-memories/issues)
