📸 Vault Image Generator Plugin

Create images from your notes with a modular Obsidian plugin.

Welcome to the Vault Image Generator plugin for Obsidian, built with PtiCalin flair. This repo provides the scaffold and features needed to generate images right inside your vault.

---

🧰 Features

• 🖼 Generate images from text prompts directly inside Obsidian
• 🤖 Powered by Ollama for local AI image generation
• ⚙️ VaultOS-ready modular structure (src/, ops/, config/, dist/)
• 📦 Rollup build system with manifest.json
• 📁 Ready-to-use GitHub Actions and PR templates
• 💬 Discussions and sponsor links for community-driven growth

---

🚀 Getting Started

Clone this repository to start using the image generator plugin:

git clone https://github.com/PtiCalin/vault_image-generator.git
cd vault_image-generator

For an automated setup you can simply run:

./setup.sh

🛠 Local Setup

Install dependencies and bundle the plugin:

npm install
npm run build

During development you can watch the files and rebuild on changes with:

npm run dev

After building, copy the contents of /dist into your Obsidian vault’s .obsidian/plugins/ folder.

The plugin uses Ollama locally. You can configure the model and output folder from the plugin settings inside Obsidian.

Codex Setup

If you open this project in Codex, set setup.sh as the setup script from Workspace → Setup script in the workspace settings. Should package installation fail, enable internet access from the same screen and rerun the setup. See the Codex documentation for full details on configuring workspace setup.

---

🧱 Folder Structure

src/           → TypeScript plugin source
dist/          → Compiled output used by Obsidian
ops/           → Plugin orchestration logic
config/        → Static metadata and module configs
.github/       → GitHub Actions, PR/issue templates

---

🤝 Contributing

We welcome contributions of all kinds!

Use our templates to get started:

• 🐛 Bug Reports
• 🌟 Feature Requests
• 📦 Pull Requests

Read our CONTRIBUTING.md for more info, or start a conversation in 💬 GitHub Discussions.

---

📜 License

This project is licensed under the MIT License.
Use freely, fork creatively — just spread the love.

---

💌 Sponsor

If this plugin sparks creativity or helps you generate visuals, consider sponsoring here: github.com/sponsors/PtiCalin

---

Have fun building, and spend less time structuring!