🧠 VaultOS – Plugin for Obsidian

VaultOS is a modular plugin orchestration system for Obsidian – designed to manage, compile, and control an ecosystem of VaultOS-powered subplugins right from your vault.

---

✨ What is VaultOS?

VaultOS is the beating heart of a modular dev environment inside Obsidian. It watches your plugin folder, auto-registers and compiles VaultOS submodules, and provides an elegant control panel for managing your extended vault OS.

Whether you're building a single subplugin or orchestrating dozens, VaultOS gives you a solid foundation.

---

🔧 Core Features

• 🧩 Auto-detect vaultos_* folders and treat them as managed subplugins
• ⚙️ Subplugin scaffolder to generate all required files and folders
• 📦 Converter, Relocator, Validator, and Compilator utilities to streamline module deployment
• 💾 Module metadata cache for tracking status, structure, and logs
• 🪟 VaultOS UI Panel inside Obsidian's workspace (left or right dock)
• 📁 Manifest builder for compiling subplugin metadata into the main manifest
• 📑 Logging system to track plugin events and actions

---

📁 Folder Structure

├── main.ts                # The plugin entry point
├── src/
│   ├── core/              # Watcher, logger, cache, UI panel view
│   ├── modules/           # Module manager and subplugin scaffolder
│   ├── ops/               # Converter, validator, relocator, compiler
│   └── templates/         # Handlebars scaffolding templates
├── dist/                  # Finalized plugin builds and JSON configs
├── data/                  # Cache, logs, backups
└── config/                # vaultos_config_extended.json and variants

---

📦 Getting Started

# 1. Clone this repository anywhere on your machine
git clone https://github.com/PtiCalin/vaultos.git
cd vaultos

# 2. Install dependencies and run tests
./setup.sh
#    Run `ENABLE_NET=1 ./setup.sh` if you need to fetch packages from the internet

# 3. Build the plugin
npm run build

# 4. Copy `manifest.json` and `main.js` to your vault's
#    `.obsidian/plugins/vaultos/` folder

After copying the built files you can reload Obsidian to use VaultOS. To distribute the plugin, package the same files in a GitHub release following the community plugin guidelines.

---

🚀 Powered By

• Obsidian API
• TypeScript
• Handlebars for template scaffolding
• ❤️ Curiosity and caffeine

---

🤝 Contributing

Contributions welcome! Check out CONTRIBUTING.md to learn more.

---

🧪 Status

This is an alpha kernel release of VaultOS. Expect improvements to:

• Configuration parsing
• UI panel features
• Plugin lifecycle automation

Built by @PtiCalin · Join the Discord

---

🌌 A modular engine for a modular mind.