# Iconik — Obsidian Plugin

> Customize icons & colors on every file and folder — all from a single right-click.

![Obsidian](https://img.shields.io/badge/Obsidian-1.12.7%2B-7c3aed?logo=obsidian&logoColor=white)
![License](https://img.shields.io/badge/license-MIT-blue)
![Version](https://img.shields.io/badge/version-1.0.0-green)
![Languages](https://img.shields.io/badge/i18n-EN%20%7C%20FR-orange)

![Banner](assets/banner.webp)

---

## How to use

### Changing an icon
- Assign any **Lucide icon** (1700+ icons) to any file or folder
- Pick a **custom color** for each icon
- Icons persist across sessions and vault restarts
- Remove icons individually or reset all at once from Settings

![Icons](assets/icon.webp)

### Changing a color
- Set a **text color** and/or **background color** on any file or folder name in the explorer
- 12 curated **color presets** + a full **custom color palette picker**
- Live preview before applying
- Colors are injected via a single CSS stylesheet — zero performance overhead

![Colors](assets/color.webp)

---

## Installation

### From the Obsidian Community Plugin Browser (recommended)
1. Open **Settings → Community plugins → Browse**
2. Search for **Iconik**
3. Click **Install**, then **Enable**

### Manual installation
1. Download the latest release (`main.js`, `manifest.json`, `styles.css`) from the [Releases](../../releases) page
2. Copy the three files to `<your-vault>/.obsidian/plugins/Iconik/`
3. Restart Obsidian, then go to **Settings → Community plugins** and enable **Iconik**

---

## Usage

All actions are available via **right-click** on any file or folder in the explorer.

![Menu](assets/menu.webp)

### Assigning an icon
1. Right-click a file or folder → **Change icon**
2. Search or browse the icon grid
3. Optionally pick a color for the icon
4. Click **Apply**

### Customizing colors
1. Right-click → **Change color**
2. Choose a text color and/or background color from the swatches or the **Custom** palette picker
3. The live preview updates in real time — click **Apply** when satisfied

---

## Settings

Navigate to **Settings → Iconik** to configure:

![Settings](assets/settings.webp)

---

## Internationalization

The plugin ships with full **English** and **French** translations. The language is detected automatically from Obsidian's locale setting.

To add a new language, duplicate `i18n/en.json`, translate all values, and name the file with the locale code (e.g. `de.json` for German).

---

## Development

```bash
# Clone the repo
git clone https://github.com/creagleone/obsidian-iconik
cd obsidian-Iconik

# Install dependencies
npm install

# Development build (watch mode)
npm run dev

# Production build
npm run build
```

## Contributing

Pull requests and issues are welcome. Please open an issue before submitting a large PR.

1. Fork the repository
2. Create a feature branch: `git checkout -b feat/my-feature`
3. Commit and push
4. Open a pull request against `main`

---

## License

[MIT](LICENSE)