illusions - 日本語小説エディタ

ダウンロード / Downloads

Download For MacOS

Download For Windows

illusions on Chrome

---

システム要件 / System Requirements

macOS

• OS: macOS 10.15 (Catalina) or later
• Processor: Intel または Apple Silicon
• Memory: 4 GB RAM 以上
• Disk Space: 1 GB 以上の空き容量

Windows

• OS: Windows 10 version 1909 以上 または Windows 11
• Processor: Intel または AMD (x64)
• Memory: 4 GB RAM 以上
• Disk Space: 1 GB 以上の空き容量
• Note: SmartScreen警告が表示される場合がありますが、これは署名なしアプリケーションの標準的な動作です

Chrome版 / Web Version

• Browser: Google Chrome 90+ (latest recommended)

---

🌐 公式サイト / Official Website

🌍 Website: https://www.illusions.app 📥 Downloads: https://www.illusions.app/downloads

Available for macOS (Intel & Apple Silicon) and Windows (installer or Microsoft Store). Also runs in Chrome — visit illusions.app to try it online.

---

🚀 Quick Start

macOS

1. Download the .dmg file from illusions.app/downloads
2. Open the DMG and drag illusions to your Applications folder
3. Launch the app and start writing!

Windows

1. Download the .exe installer from illusions.app/downloads
2. Run the installer
3. Important: You may see a Windows SmartScreen warning saying "Unknown Publisher"
   • This is normal for unsigned applications
   • Click "More info" → "Run anyway" to proceed with installation
4. Launch the app and start writing!

Tip: To skip the SmartScreen warning, install from the Microsoft Store instead (search "illusions novel editor").

Why does Windows show this warning?

• illusions is currently distributed without a Windows code signing certificate
• Code signing certificates cost $200-400/year for individual developers
• The app is completely safe and open-source - you can review the code on GitHub
• We plan to add code signing in the future as the project grows

---

🛠️ For Developers

Prerequisites

• Node.js 22+
• npm or yarn

Installation

# Clone the repository
git clone https://github.com/Iktahana/illusions.git
cd illusions

# Install dependencies
npm install

# Set up environment variables (for GitHub OAuth)
cp .env.local.example .env.local
# Edit .env.local and add your GitHub OAuth Client ID

# Run web development server
npm run dev

Open http://localhost:3000 in your browser.

GitHub OAuth Setup (Optional)

To enable GitHub authentication and cloud sync:

1. Create a GitHub OAuth App at https://github.com/settings/applications/new
2. Configure the OAuth App:
   • Application name: illusions Novel Editor (or your preferred name)
   • Homepage URL: http://localhost:3000
   • Authorization callback URL: http://localhost:3000
3. Copy the Client ID from the OAuth App page
4. Create a .env.local file in the project root:

   cp .env.local.example .env.local

5. Edit .env.local and replace your_client_id_here with your actual Client ID:

   GITHUB_CLIENT_ID=your_actual_client_id
   

6. Restart the development server

The GitHub avatar will appear at the bottom of the left sidebar, allowing you to log in and sync your work.

Electron Development

# Run Electron app in development mode
npm run electron:dev

# Build Electron app for production
npm run electron:build

Generate Dependency Credits

# Generate credits.json (list of production dependency licenses)
npm run generate:credits

The generated file is used in the "About illusions" page in Settings.

---

📂 Project Structure

illusions/
├── app/                      # Next.js App Router pages
│   ├── api/                  # API routes (NLP endpoints)
│   ├── globals.css           # Global styles & theme variables
│   └── page.tsx              # Main editor page
├── components/               # React components
│   ├── Editor.tsx            # Milkdown editor
│   ├── Explorer.tsx          # Left sidebar (file tree)
│   ├── Inspector.tsx         # Right sidebar (stats & tools)
│   ├── ActivityBar.tsx       # Left activity bar
│   └── explorer/             # Explorer sub-components
├── contexts/                 # React context providers
├── electron/                 # Electron main process
│   ├── main.js               # Main process entry
│   ├── preload.js            # Preload script (secure IPC)
│   ├── nlp/                  # NLP backend (kuromoji)
│   └── storage-ipc-handlers.js
├── lib/                      # Core libraries
│   ├── storage/              # Storage abstraction layer
│   ├── services/             # App services (history, notifications, etc.)
│   ├── linting/              # Japanese text linting framework
│   ├── keymap/               # Keyboard shortcut customization
│   ├── nlp-client/           # NLP client abstraction
│   ├── nlp-backend/          # NLP backend logic
│   ├── export/               # PDF/EPUB/DOCX export
│   ├── dockview/             # Panel layout (dockview-react adapter)
│   ├── hooks/                # React hooks
│   ├── project/              # Project management
│   ├── tab-manager/          # Multi-tab management
│   ├── vfs/                  # Virtual file system
│   └── utils/                # Utility functions
├── packages/                 # Internal packages
│   └── milkdown-plugin-japanese-novel/
├── www/                      # Landing page (Vite)
├── types/                    # TypeScript type definitions
├── scripts/                  # Build and utility scripts
└── docs/                     # Documentation

---

🛠️ Tech Stack

Core

• Next.js 16 - React framework with App Router
• React 18 - UI library
• TypeScript - Type-safe development
• Tailwind CSS 3 - Utility-first styling

Editor

• Milkdown 7 - WYSIWYG Markdown editor
• ProseMirror - Editor foundation
• Kuromoji.js - Japanese morphological analysis

Storage

• Dexie.js - IndexedDB wrapper (Web)
• better-sqlite3 - SQLite database (Electron)

Layout & Terminal

• dockview-react - Flexible panel layout system
• xterm.js + node-pty - Integrated terminal panel

Testing

• Vitest - Unit testing framework

Desktop

• Electron 32 - Cross-platform desktop app
• electron-builder - Build and packaging
• electron-updater - Auto-update support

---

🔒 Security

• Token encryption: OS-level encryption via Electron safeStorage (macOS Keychain / Windows DPAPI)
• Context isolation: Electron preload with secure IPC, sandbox enabled
• IPC input validation: Type and size checks on security-sensitive IPC handlers (VFS, NLP, file operations, context-menu)
• Save-file path validation: Directory traversal prevention, system path denylist, extension allowlist, and dialog-approval enforcement
• Content Security Policy: CSP headers enforced; unsafe-eval disabled in production
• Navigation guards: Blocks unexpected navigation and new-window creation
• VFS sandboxing: File system access restricted to approved project directories
• HTTPS only: All network requests use HTTPS

---

🤝 Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Please follow the code review standards in CLAUDE.md.

---

📝 License

GNU Affero General Public License v3.0 - See LICENSE file for details.

See also: 利用規約 / Terms of Service | Online Policy Page

---

🙏 Acknowledgments

• Milkdown - Excellent Markdown editor framework
• Kuromoji.js - Japanese text tokenization
• Electron - Cross-platform desktop framework

---

📧 Contact

• GitHub Issues: https://github.com/Iktahana/illusions/issues
• Website: https://www.illusions.app

---

Made with ❤️ for Japanese novelists