docs: rewrite README to be more concise and professional
Removed excessive emojis, marketing fluff, and outdated information. Updated to reflect actually implemented features and current development focus. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
108
README.md
108
README.md
@@ -1,37 +1,36 @@
|
|||||||
# Claudia
|
# Claudia
|
||||||
|
|
||||||
Beautiful AI roleplay desktop companion built with Tauri and Rust.
|
Desktop AI chat application built with Tauri and Rust, focused on roleplay and character-based interactions.
|
||||||
|
|
||||||
## Vision
|
|
||||||
|
|
||||||
Claudia aims to be a lightweight, desktop-native alternative to SillyTavern, focusing on roleplay and character-based interactions while maintaining a clean, modern interface.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
### Core Chat Features
|
### Chat
|
||||||
- 🎨 **Beautiful glassmorphic UI** - Modern design with gradient backgrounds
|
- Streaming responses with real-time display
|
||||||
- 🔧 **Bring-your-own-API** - Supports any Anthropic-compatible API
|
- Full markdown rendering with syntax highlighting
|
||||||
- ✅ **API validation** - Automatic model detection via /v1/models
|
- Message swipes (multiple response alternatives)
|
||||||
- 💬 **Full conversation context** - AI remembers your entire conversation
|
- Edit and regenerate from any message
|
||||||
- 💾 **Persistent chat history** - Conversations saved per character
|
- Per-character conversation history
|
||||||
- 🎯 **Streaming responses** - Real-time token display (optional)
|
- Copy code blocks with one click
|
||||||
|
|
||||||
### Character System
|
### Characters
|
||||||
- 🎭 **Multiple characters** - Switch between different AI personas
|
- V2/V3 character card import/export (PNG format)
|
||||||
- 🖼️ **Character avatars** - Upload custom images with zoom preview
|
- Multiple characters with avatar support
|
||||||
- 📇 **V2/V3 character cards** - Import/export Tavern-compatible cards
|
- Full character editor (description, personality, scenario, examples, etc.)
|
||||||
- ✏️ **Full character editor** - All v2/v3 fields supported (description, scenario, examples, etc.)
|
- Character-specific chat history
|
||||||
|
|
||||||
### Advanced Chat Features
|
### Roleplay Tools
|
||||||
- 🔄 **Message swipes** - Generate multiple responses and swipe between them
|
- World Info/Lorebook system with keyword detection and priority
|
||||||
- ✏️ **Message editing** - Edit messages and regenerate from any point
|
- Author's Note with configurable positioning
|
||||||
- 🔀 **Chat branching** - Explore alternate conversation paths
|
- User Personas with chat/character locking
|
||||||
|
- Prompt Presets with instruction blocks
|
||||||
|
- Message Examples from character cards
|
||||||
|
- Regex Scripts for text transformations
|
||||||
|
- Token counter with per-section breakdown
|
||||||
|
|
||||||
### Message Display
|
### API
|
||||||
- 📝 **Full markdown rendering** - Headers, lists, tables, links, blockquotes
|
- Bring-your-own-API (Anthropic-compatible)
|
||||||
- 🎨 **Syntax highlighting** - Beautiful code blocks with highlight.js
|
- Automatic model detection via /v1/models
|
||||||
- 📋 **Copy code blocks** - One-click copy button on hover
|
- API validation and error handling
|
||||||
- ✨ **Smooth animations** - Elegant message transitions
|
|
||||||
|
|
||||||
## Running
|
## Running
|
||||||
|
|
||||||
@@ -40,59 +39,44 @@ npm install
|
|||||||
npm run dev
|
npm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
Build:
|
Build for production:
|
||||||
```bash
|
```bash
|
||||||
npm run build
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note**: The dev script includes `WEBKIT_DISABLE_DMABUF_RENDERER=1` to fix Wayland compatibility issues on KDE Plasma.
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
On first launch, click settings and configure:
|
On first launch, configure in Settings:
|
||||||
- Base URL (e.g., https://api.anthropic.com)
|
- Base URL (e.g., https://api.anthropic.com)
|
||||||
- API Key
|
- API Key
|
||||||
- Model (validated from /v1/models endpoint)
|
- Model
|
||||||
|
|
||||||
- Config stored in `~/.config/claudia/config.json`
|
Config stored in `~/.config/claudia/config.json`
|
||||||
- Chat history stored in `~/.config/claudia/history.json`
|
|
||||||
|
|
||||||
## Usage
|
## Keyboard Shortcuts
|
||||||
|
|
||||||
### Keyboard Shortcuts
|
|
||||||
- **Enter** - Send message
|
- **Enter** - Send message
|
||||||
- **Shift+Enter** - New line in message
|
- **Shift+Enter** - New line
|
||||||
- **Up Arrow** - Edit last user message
|
- **Up Arrow** - Edit last user message
|
||||||
- **Left/Right Arrow** - Swipe between alternative responses
|
- **Left/Right Arrow** - Swipe between responses
|
||||||
|
|
||||||
### Character Management
|
|
||||||
- **Character Dropdown** - Switch between characters
|
|
||||||
- **Settings → Character Tab** - Edit current character
|
|
||||||
- **Import v2 Card** - Import Tavern character cards (PNG format)
|
|
||||||
- **Export v2 Card** - Export character as Tavern-compatible card
|
|
||||||
|
|
||||||
### Interface
|
|
||||||
- **Drag header** - Move window around your desktop
|
|
||||||
- **Trash icon** - Clear conversation history
|
|
||||||
- **Settings icon** - Configure API settings
|
|
||||||
- **Minimize/Maximize** - Window controls
|
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|
||||||
Claudia is being developed to become a full-featured roleplay platform comparable to SillyTavern. See [ROADMAP.md](ROADMAP.md) for detailed plans including:
|
See [ROADMAP.md](ROADMAP.md) for detailed development plans.
|
||||||
|
|
||||||
**Coming Soon:**
|
**Current Focus:** Chat Branching/Checkpoints for non-linear conversation exploration
|
||||||
- 📚 World Info/Lorebooks for dynamic context
|
|
||||||
- 📝 Author's Note for better prompt control
|
|
||||||
- 👤 User Personas for identity management
|
|
||||||
- 😊 Character Expression Sprites
|
|
||||||
- 🔢 Token Counter and context visualization
|
|
||||||
- 👥 Group Chats with multiple characters
|
|
||||||
- ⚡ Quick Replies and macro system
|
|
||||||
|
|
||||||
**Current Version:** v0.1.0 - Basic character chat with swipes and card import/export
|
**Upcoming:**
|
||||||
**Next Version:** v0.2.0 - Roleplay Foundation (World Info, Author's Note, Token Counter)
|
- Chat branching with timeline visualization
|
||||||
|
- Character expression sprites
|
||||||
|
- Group chats with multiple characters
|
||||||
|
- Quick replies and macro system
|
||||||
|
- Context templates for different model formats
|
||||||
|
|
||||||
## Contributing
|
## Development
|
||||||
|
|
||||||
This is a personal project, but feedback and suggestions are welcome! If you encounter bugs or have feature requests, please open an issue on GitHub.
|
Built with:
|
||||||
|
- Tauri 2.0
|
||||||
|
- Rust backend
|
||||||
|
- Vanilla JavaScript frontend
|
||||||
|
- tiktoken-rs for token counting
|
||||||
|
|||||||
Reference in New Issue
Block a user