# Letterboxd Mirror

Sync your [Letterboxd](https://letterboxd.com) diary entries as notes in [Obsidian](https://obsidian.md).

## Features

- Fetch viewings each viewing from your **Letterboxd diary** as individual notes.
- Batch import the history using **Letterboxd's exported data**.
- Integrate with **TMDB API** to create additional notes with extended information for each film.
- Deep customization of the **templates using the [Eta](https://eta.js.org) templating engine**.
- Configure the plugin to **auto-sync** on Obsidian startup.

## Installation

This plugin is pending approval for the Obsidian Community Plugins directory.

For now, see the [Installation Guide](docs/Installation.md) for manual installation instructions.

## Quick Start

1. Open **Settings → Letterboxd Mirror**
2. Enter your Letterboxd username
3. Click the clapperboard icon in the ribbon

See the [Usage Guide](docs/Usage.md) for detailed instructions.

## Documentation

- [Installation](docs/Installation.md) — How to install the plugin
- [Usage](docs/Usage.md) — RSS sync, CSV import, TMDB setup
- [Settings](docs/Settings.md) — All configuration options
- [Template Variables](docs/Template-Variables.md) — Customize your note templates

## License

Licensed under [MIT License](LICENSE). Film data fetched from [The Movie Database (TMDB)](https://www.themoviedb.org/), built for [Obsidian](https://obsidian.md).