# Kore Notepad++ Plugin & Windows Integration
View `.kore` files directly in Notepad++ without conversion.
## ⚡ Quick Start (3 Options)
### ✅ RECOMMENDED: Manual Registry (Guaranteed to Work!)
**Follow:** [REGISTRY_MANUAL_SETUP.md](REGISTRY_MANUAL_SETUP.md)
- 5-10 minutes, copy-paste into Registry Editor
- 100% success rate
- Works on all Windows 10+ versions
### 🚀 PowerShell (If Automated Works)
```powershell
# Run as Administrator:
powershell -ExecutionPolicy Bypass -File "C:\Users\ksak_\OneDrive\Desktop\dbt_prep\Kore\notepad-plugin\setup.ps1"
```
### 🔧 Batch File (Alternative Automated)
1. Right-click: [RUN_AS_ADMIN.bat](RUN_AS_ADMIN.bat)
2. Select "Run as Administrator"
**Still having issues?** See: [QUICKSTART.md](QUICKSTART.md) for troubleshooting
---
## ✨ Features After Setup
✅ **Double-click** any `.kore` file → Opens in Notepad++
✅ **Right-click** any `.kore` file → Shows:
- 📊 **View Metadata** - File structure instantly
- 📄 **Convert to CSV** - Readable version
- 📋 **Convert to JSON** - Structured format
✅ **No plugin download needed!**
✅ **Windows 10+ support**
✅ **5-10 minutes to setup**
---
## How It Works
Instead of opening `.kore` binary (which shows gibberish), the setup:
1. **Registers** `.kore` file type in Windows
2. **Adds** context menu options
3. **Runs** `kore inspect` or `kore convert` when you choose an option
4. **Shows** readable output instantly
You can still **open in Notepad++** if you want (shows binary), but the **context menu options** are more useful!
---
## What You'll See
When you select **"View Metadata"**:
```
File Size: 1,234,567 bytes
Version: 1.3.0
Compression Ratio: 64.8%
Number of Rows: 100,000
Number of Columns: 15
Schema:
• id (Integer)
• name (String)
• email (String)
• created_at (Timestamp)
```
---
## Requirements
- **Windows 10+**
- **Administrator access** (for setup only)
- **Notepad++ 8.0+** (optional, but recommended)
- **Kore CLI** (required): `pip install kore-fileformat`
---
## Setup Scripts
| [setup.ps1](setup.ps1) | PowerShell auto-setup (fastest) |
| [setup-notepad-plus-plus.bat](setup-notepad-plus-plus.bat) | Batch auto-setup |
| [MANUAL_SETUP.md](MANUAL_SETUP.md) | Manual registry steps |
| [QUICKSTART.md](QUICKSTART.md) | Complete setup guide |
---
## Troubleshooting
| "Access denied" | Run PowerShell **as Administrator** |
| Batch shows "permission denied" | Right-click .bat → "Run as Administrator" |
| Context menu doesn't appear | Restart Windows Explorer (Task Manager) |
| "kore CLI not found" | Install: `pip install kore-fileformat` |
| Notepad++ not found | Install: https://notepad-plus-plus.org |
**See:** [QUICKSTART.md](QUICKSTART.md#-troubleshooting)
---
## Notepad++ Plugin (Optional)
For the **actual Notepad++ plugin** (compiled DLL):
- **Source:** [KoreViewer.cpp](KoreViewer.cpp)
- **Build:** `msbuild KoreViewer.vcxproj /p:Configuration=Release`
- **Install:** Copy DLL to `%APPDATA%\Notepad++\plugins\`
**But the registry setup above is simpler!** 👆
### Build Prerequisites
- Visual Studio 2019 or later
- Notepad++ Plugin Pack SDK
- Windows SDK
---
## Related Tools
- **CLI:** [docs/CLI_GUIDE.md](../docs/CLI_GUIDE.md) - Terminal inspection & conversion
- **Python API:** [docs/PYTHON_API.md](../docs/PYTHON_API.md) - Programmatic access
- **VS Code:** [vscode-kore-viewer/](../vscode-kore-viewer/) - IDE integration
- **Web Viewer:** [WEB_VIEWER_PLAN.md](../WEB_VIEWER_PLAN.md) - Browser-based viewer
---
## License
KUOPL (Kore Use-Only Proprietary License) v1.1
---
## 🎯 TL;DR - Get Started Now
```powershell
# 1. Open PowerShell as Administrator
# 2. Paste and run:
powershell -ExecutionPolicy Bypass -File "C:\Users\ksak_\OneDrive\Desktop\dbt_prep\Kore\notepad-plugin\setup.ps1"
# 3. Done! Right-click any .kore file now
```
**Questions?** See [QUICKSTART.md](QUICKSTART.md) or [SETUP_GUIDE.md](SETUP_GUIDE.md)