# LucidX - AI-Powered Image Synthesis Engine
```
▄█▀▄ ▄▀▄▄
▀▄ ▄▀
▄▄▄ █▄▄▄▄▄▄█ ▄▄▄
▀ ▀█ █▀ ▐▌ ▀█ █▀ ▀
██ ▀▐▌▀ ██
▄█▀▀▀████████████▀▀▀█
█ ██████████ ▀▄
█▄ █▀ ▀▀▀▀▀▀ ▀█ ▄█
▀█ █ v.1.0.4 █ █▀
```
<div align="center">
**An AI-powered image synthesis engine crafted for creators, developers, and visionaries.**
[](https://www.python.org/downloads/)
[](LICENSE)
[](#compatibility)
[](https://stability.ai/)
[](#overview)
[](#overview)
[](#contributing)
[](https://github.com/VritraSecz/LucidX)
[](https://github.com/VritraSecz/LucidX)
[](https://github.com/VritraSecz/LucidX/issues)
[](https://github.com/VritraSecz/LucidX/graphs/contributors)
[](https://github.com/VritraSecz/LucidX)
[](https://github.com/VritraSecz/LucidX)
</div>
## 🆕 What's New in v1.0.4
<div align="center">
### ✨ **Latest Features & Improvements**
</div>
#### 🖥️ **Command Line Arguments Support**
- **`--help` / `-h`**: Get instant help and usage examples without entering the interactive menu
- **`--version` / `-v`**: Quickly check your LucidX version and system information
- **Smart Error Handling**: Prevents multiple arguments and shows helpful error messages
- **Professional CLI**: Standard Unix-style command line interface
#### 🌐 **Global Configuration System**
- **New Config Location**: `~/.config-vritrasecz/lucidx-config.json`
- **JSON Format**: Clean, structured configuration instead of Python files
- **Global Access**: Use your API key from any directory on your system
- **Auto-Creation**: Configuration directory is created automatically
- **Enhanced Security**: Config stored safely in your home directory
#### 🔧 **Enhanced User Experience**
- **Argument Validation**: Detects and handles invalid arguments gracefully
- **Better Error Messages**: More informative error handling throughout the tool
- **Backward Compatibility**: All existing functionality preserved
- **Improved Documentation**: Updated help system with new features
#### 📖 **Usage Examples**
```bash
# Quick help (new!)
python lucidx.py --help
# Check version (new!)
python lucidx.py --version
# Normal interactive mode (unchanged)
python lucidx.py
```
---
## 📋 Table of Contents
- [Overview](#-overview)
- [Features](#-features)
- [Requirements](#-requirements)
- [Installation](#-installation)
- [Configuration](#-configuration)
- [Usage](#-usage)
- [Style Presets](#-style-presets)
- [Screenshots](#️-screenshots)
- [File Structure](#-file-structure)
- [Output Management](#-output-management)
- [Logging System](#-logging-system)
- [Platform Compatibility](#-platform-compatibility)
- [Troubleshooting](#-troubleshooting)
- [Contributing](#-contributing)
- [Contact & Support](#-contact--support)
- [License](#-license)
## 🔮 Overview
**LucidX** is a sophisticated AI-powered image synthesis engine that leverages the Stability AI API to transform text prompts into stunning, high-resolution images. Designed with an intuitive command-line interface, LucidX offers creators, developers, and visionaries a powerful tool to bring their imagination to life through advanced AI image generation.
### Key Highlights
- 🎨 **Multi-Style Generation**: Choose from 8 distinctive artistic styles
- 🔧 **Interactive CLI**: User-friendly command-line interface with visual feedback
- 📱 **Cross-Platform**: Native support for Linux and Android (Termux)
- 📊 **Session Management**: Comprehensive logging and progress tracking
- 🛡️ **Secure API Handling**: Safe storage and management of API credentials
- ⚡ **Batch Processing**: Generate multiple variations per prompt automatically
## ✨ Features
### Core Functionality
- **AI Image Generation**: Powered by Stability AI's advanced image synthesis models
- **Multiple Style Presets**: 8 built-in artistic styles including photographic, anime, digital art, and more
- **Batch Generation**: Automatically creates 4 image variations per prompt
- **Smart File Management**: Automatic timestamped file naming and organized storage
- **Session Logging**: Comprehensive activity logs with detailed metadata
### User Experience
- **Interactive Menu System**: Intuitive navigation through all application features
- **Real-time Progress Feedback**: Visual indicators during image generation
- **Graceful Error Handling**: Robust error management with user-friendly messages
- **Interrupt Handling**: Safe Ctrl+C handling with session cleanup
- **Session Summary**: Detailed statistics upon completion
### Security & Configuration
- **Secure API Key Storage**: Encrypted local storage of Stability AI credentials
- **API Key Management**: Easy configuration and updating of API keys
- **Validation**: Input validation and API response verification
## 📋 Requirements
### System Requirements
- **Python**: Version 3.7 or higher
- **Operating System**: Linux (any distribution) or Android with Termux
- **Internet Connection**: Required for Stability AI API access
- **Storage**: Minimum 100MB free space for generated images
### Python Dependencies
```bash
colorama>=0.4.4 # Terminal color formatting
requests>=2.25.1 # HTTP requests for API communication
pathlib # File path management (built-in)
datetime # Timestamp generation (built-in)
```
### API Requirements
- **Stability AI API Key**: Required for image generation
- **API Credits**: Sufficient credits in your Stability AI account
## 🚀 Installation
### Method 1: Git Clone (Recommended)
```bash
# Clone the repository
git clone https://github.com/VritraSecz/LucidX.git
# Navigate to project directory
cd LucidX
# Install dependencies
pip3 install -r requirements.txt
# Run the application
python lucidx.py
```
### Method 2: Direct Download
1. Download the project as ZIP from GitHub
2. Extract to your desired location
3. Install dependencies: `pip install colorama requests`
4. Run: `python lucidx.py`
### Method 3: Termux (Android)
```bash
# Update package list
apt update && apt upgrade
# Install Python and Git
apt install python python-pip git
# Clone and setup
git clone https://github.com/VritraSecz/LucidX.git
cd LucidX
pip install -r requirements.txt
# Run
python lucidx.py
```
## ⚙️ Configuration
### API Key Setup
1. **Obtain Stability AI API Key**:
- Visit [Stability AI Platform](https://platform.stability.ai/)
- Create an account and generate an API key
- Ensure you have sufficient credits
2. **Configure in LucidX**:
- Launch LucidX: `python lucidx.py`
- Select option `[2] Configure API Key`
- Enter your API key when prompted
- Key is securely stored in `core/config.py`
3. **Update Existing Key**:
- Use the same configuration menu
- Choose to replace existing key when prompted
### Directory Structure Setup
The application automatically creates necessary directories:
**Linux/PC**:
```
./generated_images/ # Generated images storage
./generation_log.txt # Session activity log
./last_style.txt # Temporary style preference
```
**Termux (Android)**:
```
/sdcard/LucidX_Images/ # Generated images storage
./generation_log.txt # Session activity log
./last_style.txt # Temporary style preference
```
## 🎯 Usage
### Basic Workflow
1. **Launch Application**
```bash
python lucidx.py
```
2. **Configure API Key** (First-time setup)
- Select option `[2]` from main menu
- Enter your Stability AI API key
3. **Generate Images**
- Select option `[1] Image Generation`
- Choose your preferred style preset (1-8)
- Enter your text prompt
- Wait for generation completion
4. **View Results**
- Images saved automatically with timestamps
- Session summary displayed after each batch
### Advanced Usage
#### Custom Prompting Tips
- **Be Descriptive**: Use detailed, specific language
- **Add Modifiers**: Include quality terms like "high resolution", "cinematic", "detailed"
- **Style Keywords**: Incorporate style-specific terms that complement your chosen preset
- **Composition**: Describe the scene composition, lighting, and mood
#### Batch Operations
- Each prompt automatically generates 4 variations
- Seeds are incremented for unique results (1234, 1235, 1236, 1237)
- All images use consistent steps (30) for quality
#### Session Management
- View real-time generation progress
- Session statistics available at completion
- Graceful exit with Ctrl+C preserves session data
## 🎨 Style Presets
LucidX offers 8 distinctive artistic styles:
| ID | Style | Description | Best For |
|----|-------|-------------|----------|
| **1** | `photographic` | Realistic, camera-like imagery | Portraits, landscapes, realistic scenes |
| **2** | `anime` | Japanese animation style | Characters, fantasy scenes, stylized art |
| **3** | `digital-art` | Modern digital illustration | Concept art, creative designs, modern aesthetics |
| **4** | `neon-punk` | Cyberpunk aesthetic with neon colors | Futuristic scenes, urban landscapes, sci-fi |
| **5** | `fantasy-art` | Fantasy and magical themes | Mythical creatures, magical scenes, epic art |
| **6** | `pixel-art` | Retro pixelated style | Game assets, retro designs, minimalist art |
| **7** | `isometric` | 3D isometric perspective | Technical illustrations, game environments |
| **8** | `low-poly` | Geometric, minimalist 3D style | Abstract designs, modern minimalism |
### Style Selection Process
- Styles are remembered during the session
- Stored in temporary `last_style.txt` file
- Automatically cleaned up on exit
## 🖼️ Screenshots
### Main Menu + Output Interface
## 📁 File Structure
```
LucidX/
├── lucidx.py # Application entry point
├── core/ # Core modules directory
│ ├── genx.py # Image generation engine
│ ├── banr.py # ASCII art banners
│ ├── colors.py # Terminal color definitions
│ └── modulex.py # Utility functions and menus
├── generated_images/ # Output directory (auto-created)
├── generation_log.txt # Activity log (auto-created)
├── last_style.txt # Temporary style storage (auto-created)
├── requirements.txt # Install required python library
└── README.md # This documentation
```
### Core Module Details
#### `lucidx.py`
- Application entry point
- Main menu navigation
- Signal handling for graceful interruption
#### `core/genx.py`
- Image generation engine
- API communication with Stability AI
- File management and batch processing
- Progress tracking and logging
#### `core/modulex.py`
- Menu systems and user interactions
- API key configuration interface
- Help and documentation displays
#### `core/banr.py`
- ASCII art banners and logos
- Session information display
- Dynamic timestamp generation
#### `core/colors.py`
- Terminal color scheme definitions
- Consistent visual styling across application
## 📂 Output Management
### File Naming Convention
Generated images follow a standardized naming pattern:
```
YYYYMMDD_HHMMSS.png
```
Example: `20241220_143052.png` (December 20, 2024 at 14:30:52)
### Storage Locations
#### Linux/PC Systems
- **Path**: `./generated_images/`
- **Creation**: Automatically created relative to script location
- **Permissions**: Standard user permissions
#### Android (Termux)
- **Path**: `/sdcard/LucidX_Images/`
- **Creation**: Automatically created on SD card storage
- **Access**: Accessible through file manager apps
### Image Specifications
- **Format**: PNG
- **Quality**: High resolution (API dependent)
- **Size**: Variable based on Stability AI model output
- **Metadata**: Generation parameters logged separately
## 📊 Logging System
### Generation Log (`generation_log.txt`)
Each generation session creates detailed log entries:
```
[2024-12-20 14:30:52] Prompt: "sunset over mountain lake" -› 20241220_143052.png
[2024-12-20 14:30:54] Prompt: "sunset over mountain lake" -› 20241220_143054.png
[2024-12-20 14:30:56] Prompt: "sunset over mountain lake" -› 20241220_143056.png
[2024-12-20 14:30:58] Prompt: "sunset over mountain lake" -› 20241220_143058.png
```
### Session Summary
Displayed at the end of each session:
```
:: LucidX Session Summary ::
› Prompts entered : 3
› Images generated : 12
› Output directory : /home/user/LucidX/generated_images
› Session completed.
```
### Error Logging
- API errors logged with full response details
- Network issues captured with diagnostic information
- File system errors documented with context
## 🖥️ Platform Compatibility
### Linux Distributions
- **Ubuntu/Debian**: Fully supported
- **Fedora/CentOS**: Fully supported
- **Arch Linux**: Fully supported
- **Kali Linux**: Fully supported (as tested)
- **Alpine Linux**: Compatible with Python 3.7+
### Android (Termux)
- **Installation**: Available through Termux package manager
- **Storage**: Automatic internal storage integration
- **Performance**: Optimized for mobile hardware
- **Permissions**: Handles Android storage permissions
### Requirements by Platform
#### Linux
```bash
sudo apt update
sudo apt install python3 python3-pip
pip3 install colorama requests
```
#### Termux
```bash
pkg update
pkg install python python-pip git
pip install colorama requests
```
## 🔧 Troubleshooting
### Common Issues
#### API Key Problems
**Issue**: "API key not configured" or authentication errors
**Solutions**:
- Verify API key is correctly entered (check for extra spaces)
- Ensure API key is active on Stability AI platform
- Check account credit balance
- Reconfigure using menu option [2]
#### Network Issues
**Issue**: Connection timeout or network errors
**Solutions**:
- Verify internet connectivity
- Check firewall settings
- Try using VPN if blocked in your region
- Ensure stable internet connection during generation
#### File Permission Errors
**Issue**: Cannot save files or create directories
**Solutions**:
- Check write permissions in current directory
- For Termux: Ensure storage permissions are granted
- Run with appropriate user permissions
- Verify sufficient disk space
#### Import Errors
**Issue**: `ModuleNotFoundError` for colorama or requests
**Solutions**:
```bash
pip install --upgrade colorama requests
# or for system-wide installation
pip3 install --upgrade colorama requests
```
### Performance Optimization
#### For Slower Systems
- Close unnecessary applications during generation
- Ensure stable internet connection
- Monitor available RAM and storage
#### For Mobile/Termux
- Use Wi-Fi instead of mobile data for better stability
- Keep device plugged in during long sessions
- Clear app cache if experiencing issues
## 🤝 Contributing
We welcome contributions from the community! Here's how you can help:
### Ways to Contribute
- 🐛 **Bug Reports**: Submit detailed issue reports
- 💡 **Feature Requests**: Suggest new functionality
- 🔧 **Code Contributions**: Submit pull requests
- 📚 **Documentation**: Improve documentation and examples
- 🎨 **Style Presets**: Suggest new artistic styles
### Development Setup
```bash
# Fork the repository on GitHub
# Clone your fork
git clone https://github.com/yourusername/LucidX.git
# Create a feature branch
git checkout -b feature/your-feature-name
# Make changes and test thoroughly
# Commit with descriptive messages
git commit -m "Add: new feature description"
# Push to your fork and create pull request
git push origin feature/your-feature-name
```
### Code Standards
- Follow PEP 8 Python style guidelines
- Include docstrings for new functions
- Test on both Linux and Termux when possible
- Maintain backward compatibility
### Issue Reporting
When reporting issues, please include:
- Python version
- Operating system and version
- Error messages (full traceback)
- Steps to reproduce
- Expected vs actual behavior
## 📞 Contact & Support
### Developer Information
[](https://vritrasec.com)
[](https://vritrasec.com)
[](https://github.com/VritraSecz)
### Community & Support
[](https://instagram.com/haxorlex)
[](https://youtube.com/@Technolex)
[](https://t.me/LinkCentralX)
[](https://t.me/ethicxbot)
### Getting Help
1. **Check Documentation**: Review this README and built-in help
2. **Search Issues**: Look for existing solutions on GitHub
3. **Community Support**: Ask questions on Telegram channel
4. **Bug Reports**: Submit detailed issues on GitHub
5. **Direct Contact**: Use support bot for urgent issues
## 📄 License
<div align="center">
[](https://opensource.org/licenses/MIT)
[](https://github.com/VritraSecz/LucidX)
[](https://www.gnu.org/philosophy/free-sw.html)
</div>
+ **This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.**
<div align="center">
### 🏷️ MIT License Permissions & Limitations
<table>
<tr>
<td align="center" width="50%">
#### ✅ **PERMISSIONS**
<div align="left">
</div>
</td>
<td align="center" width="50%">
#### ❌ **LIMITATIONS**
<div align="left">
</div>
#### ⚠️ **REQUIREMENTS**
<div align="left">
</div>
</td>
</tr>
</table>
</div>
---
<div align="center">
**LucidX v1.0.4** - *"I don't paint dreams. I compute realities yet to be rendered."*
Made with ❤️ by [VritraSec](https://vritrasec.com)
</div>
Raw data
{
"_id": null,
"home_page": "https://github.com/VritraSecz/LucidX",
"name": "lucidx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "ai, artificial-intelligence, image-generation, stability-ai, text-to-image, image-synthesis, cli, tool, python, machine-learning, deep-learning, creative, art, digital-art",
"author": "Alex Butler [Vritra Security Organization]",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/be/56/6e8336b3472674fb79eb729ba85a72f5d89b57760eb1690536c9def3144e/lucidx-1.0.4.tar.gz",
"platform": "any",
"description": "# LucidX - AI-Powered Image Synthesis Engine\n\n```\n \u2584\u2588\u2580\u2584 \u2584\u2580\u2584\u2584\n \u2580\u2584 \u2584\u2580\n \u2584\u2584\u2584 \u2588\u2584\u2584\u2584\u2584\u2584\u2584\u2588 \u2584\u2584\u2584\n \u2580 \u2580\u2588 \u2588\u2580 \u2590\u258c \u2580\u2588 \u2588\u2580 \u2580\n \u2588\u2588 \u2580\u2590\u258c\u2580 \u2588\u2588\n \u2584\u2588\u2580\u2580\u2580\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2580\u2580\u2580\u2588\n \u2588 \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588 \u2580\u2584\n \u2588\u2584 \u2588\u2580 \u2580\u2580\u2580\u2580\u2580\u2580 \u2580\u2588 \u2584\u2588\n \u2580\u2588 \u2588 v.1.0.4 \u2588 \u2588\u2580\n```\n\n\n<div align=\"center\">\n\n\n**An AI-powered image synthesis engine crafted for creators, developers, and visionaries.**\n\n[](https://www.python.org/downloads/)\n[](LICENSE)\n[](#compatibility)\n[](https://stability.ai/)\n[](#overview)\n[](#overview)\n[](#contributing)\n[](https://github.com/VritraSecz/LucidX)\n[](https://github.com/VritraSecz/LucidX)\n[](https://github.com/VritraSecz/LucidX/issues)\n[](https://github.com/VritraSecz/LucidX/graphs/contributors)\n[](https://github.com/VritraSecz/LucidX)\n[](https://github.com/VritraSecz/LucidX)\n\n</div>\n\n## \ud83c\udd95 What's New in v1.0.4\n\n<div align=\"center\">\n\n### \u2728 **Latest Features & Improvements**\n\n</div>\n\n#### \ud83d\udda5\ufe0f **Command Line Arguments Support**\n- **`--help` / `-h`**: Get instant help and usage examples without entering the interactive menu\n- **`--version` / `-v`**: Quickly check your LucidX version and system information\n- **Smart Error Handling**: Prevents multiple arguments and shows helpful error messages\n- **Professional CLI**: Standard Unix-style command line interface\n\n#### \ud83c\udf10 **Global Configuration System**\n- **New Config Location**: `~/.config-vritrasecz/lucidx-config.json`\n- **JSON Format**: Clean, structured configuration instead of Python files\n- **Global Access**: Use your API key from any directory on your system\n- **Auto-Creation**: Configuration directory is created automatically\n- **Enhanced Security**: Config stored safely in your home directory\n\n#### \ud83d\udd27 **Enhanced User Experience**\n- **Argument Validation**: Detects and handles invalid arguments gracefully\n- **Better Error Messages**: More informative error handling throughout the tool\n- **Backward Compatibility**: All existing functionality preserved\n- **Improved Documentation**: Updated help system with new features\n\n#### \ud83d\udcd6 **Usage Examples**\n```bash\n# Quick help (new!)\npython lucidx.py --help\n\n# Check version (new!)\npython lucidx.py --version\n\n# Normal interactive mode (unchanged)\npython lucidx.py\n```\n\n---\n\n## \ud83d\udccb Table of Contents\n\n- [Overview](#-overview)\n- [Features](#-features)\n- [Requirements](#-requirements)\n- [Installation](#-installation)\n- [Configuration](#-configuration)\n- [Usage](#-usage)\n- [Style Presets](#-style-presets)\n- [Screenshots](#\ufe0f-screenshots)\n- [File Structure](#-file-structure)\n- [Output Management](#-output-management)\n- [Logging System](#-logging-system)\n- [Platform Compatibility](#-platform-compatibility)\n- [Troubleshooting](#-troubleshooting)\n- [Contributing](#-contributing)\n- [Contact & Support](#-contact--support)\n- [License](#-license)\n\n## \ud83d\udd2e Overview\n\n**LucidX** is a sophisticated AI-powered image synthesis engine that leverages the Stability AI API to transform text prompts into stunning, high-resolution images. Designed with an intuitive command-line interface, LucidX offers creators, developers, and visionaries a powerful tool to bring their imagination to life through advanced AI image generation.\n\n### Key Highlights\n\n- \ud83c\udfa8 **Multi-Style Generation**: Choose from 8 distinctive artistic styles\n- \ud83d\udd27 **Interactive CLI**: User-friendly command-line interface with visual feedback\n- \ud83d\udcf1 **Cross-Platform**: Native support for Linux and Android (Termux)\n- \ud83d\udcca **Session Management**: Comprehensive logging and progress tracking\n- \ud83d\udee1\ufe0f **Secure API Handling**: Safe storage and management of API credentials\n- \u26a1 **Batch Processing**: Generate multiple variations per prompt automatically\n\n## \u2728 Features\n\n### Core Functionality\n- **AI Image Generation**: Powered by Stability AI's advanced image synthesis models\n- **Multiple Style Presets**: 8 built-in artistic styles including photographic, anime, digital art, and more\n- **Batch Generation**: Automatically creates 4 image variations per prompt\n- **Smart File Management**: Automatic timestamped file naming and organized storage\n- **Session Logging**: Comprehensive activity logs with detailed metadata\n\n### User Experience\n- **Interactive Menu System**: Intuitive navigation through all application features\n- **Real-time Progress Feedback**: Visual indicators during image generation\n- **Graceful Error Handling**: Robust error management with user-friendly messages\n- **Interrupt Handling**: Safe Ctrl+C handling with session cleanup\n- **Session Summary**: Detailed statistics upon completion\n\n### Security & Configuration\n- **Secure API Key Storage**: Encrypted local storage of Stability AI credentials\n- **API Key Management**: Easy configuration and updating of API keys\n- **Validation**: Input validation and API response verification\n\n## \ud83d\udccb Requirements\n\n### System Requirements\n- **Python**: Version 3.7 or higher\n- **Operating System**: Linux (any distribution) or Android with Termux\n- **Internet Connection**: Required for Stability AI API access\n- **Storage**: Minimum 100MB free space for generated images\n\n### Python Dependencies\n```bash\ncolorama>=0.4.4 # Terminal color formatting\nrequests>=2.25.1 # HTTP requests for API communication\npathlib # File path management (built-in)\ndatetime # Timestamp generation (built-in)\n```\n\n### API Requirements\n- **Stability AI API Key**: Required for image generation\n- **API Credits**: Sufficient credits in your Stability AI account\n\n## \ud83d\ude80 Installation\n\n### Method 1: Git Clone (Recommended)\n```bash\n# Clone the repository\ngit clone https://github.com/VritraSecz/LucidX.git\n\n# Navigate to project directory\ncd LucidX\n\n# Install dependencies\npip3 install -r requirements.txt\n\n# Run the application\npython lucidx.py\n```\n\n### Method 2: Direct Download\n1. Download the project as ZIP from GitHub\n2. Extract to your desired location\n3. Install dependencies: `pip install colorama requests`\n4. Run: `python lucidx.py`\n\n### Method 3: Termux (Android)\n```bash\n# Update package list\napt update && apt upgrade\n\n# Install Python and Git\napt install python python-pip git\n\n# Clone and setup\ngit clone https://github.com/VritraSecz/LucidX.git\ncd LucidX\npip install -r requirements.txt\n\n# Run\npython lucidx.py\n```\n\n## \u2699\ufe0f Configuration\n\n### API Key Setup\n\n1. **Obtain Stability AI API Key**:\n - Visit [Stability AI Platform](https://platform.stability.ai/)\n - Create an account and generate an API key\n - Ensure you have sufficient credits\n\n2. **Configure in LucidX**:\n - Launch LucidX: `python lucidx.py`\n - Select option `[2] Configure API Key`\n - Enter your API key when prompted\n - Key is securely stored in `core/config.py`\n\n3. **Update Existing Key**:\n - Use the same configuration menu\n - Choose to replace existing key when prompted\n\n### Directory Structure Setup\n\nThe application automatically creates necessary directories:\n\n**Linux/PC**:\n```\n./generated_images/ # Generated images storage\n./generation_log.txt # Session activity log\n./last_style.txt # Temporary style preference\n```\n\n**Termux (Android)**:\n```\n/sdcard/LucidX_Images/ # Generated images storage\n./generation_log.txt # Session activity log\n./last_style.txt # Temporary style preference\n```\n\n## \ud83c\udfaf Usage\n\n### Basic Workflow\n\n1. **Launch Application**\n ```bash\n python lucidx.py\n ```\n\n2. **Configure API Key** (First-time setup)\n - Select option `[2]` from main menu\n - Enter your Stability AI API key\n\n3. **Generate Images**\n - Select option `[1] Image Generation`\n - Choose your preferred style preset (1-8)\n - Enter your text prompt\n - Wait for generation completion\n\n4. **View Results**\n - Images saved automatically with timestamps\n - Session summary displayed after each batch\n\n### Advanced Usage\n\n#### Custom Prompting Tips\n- **Be Descriptive**: Use detailed, specific language\n- **Add Modifiers**: Include quality terms like \"high resolution\", \"cinematic\", \"detailed\"\n- **Style Keywords**: Incorporate style-specific terms that complement your chosen preset\n- **Composition**: Describe the scene composition, lighting, and mood\n\n#### Batch Operations\n- Each prompt automatically generates 4 variations\n- Seeds are incremented for unique results (1234, 1235, 1236, 1237)\n- All images use consistent steps (30) for quality\n\n#### Session Management\n- View real-time generation progress\n- Session statistics available at completion\n- Graceful exit with Ctrl+C preserves session data\n\n## \ud83c\udfa8 Style Presets\n\nLucidX offers 8 distinctive artistic styles:\n\n| ID | Style | Description | Best For |\n|----|-------|-------------|----------|\n| **1** | `photographic` | Realistic, camera-like imagery | Portraits, landscapes, realistic scenes |\n| **2** | `anime` | Japanese animation style | Characters, fantasy scenes, stylized art |\n| **3** | `digital-art` | Modern digital illustration | Concept art, creative designs, modern aesthetics |\n| **4** | `neon-punk` | Cyberpunk aesthetic with neon colors | Futuristic scenes, urban landscapes, sci-fi |\n| **5** | `fantasy-art` | Fantasy and magical themes | Mythical creatures, magical scenes, epic art |\n| **6** | `pixel-art` | Retro pixelated style | Game assets, retro designs, minimalist art |\n| **7** | `isometric` | 3D isometric perspective | Technical illustrations, game environments |\n| **8** | `low-poly` | Geometric, minimalist 3D style | Abstract designs, modern minimalism |\n\n### Style Selection Process\n- Styles are remembered during the session\n- Stored in temporary `last_style.txt` file\n- Automatically cleaned up on exit\n\n## \ud83d\uddbc\ufe0f Screenshots\n\n### Main Menu + Output Interface\n\n\n\n## \ud83d\udcc1 File Structure\n\n```\nLucidX/\n\u251c\u2500\u2500 lucidx.py # Application entry point\n\u251c\u2500\u2500 core/ # Core modules directory\n\u2502 \u251c\u2500\u2500 genx.py # Image generation engine\n\u2502 \u251c\u2500\u2500 banr.py # ASCII art banners\n\u2502 \u251c\u2500\u2500 colors.py # Terminal color definitions\n\u2502 \u2514\u2500\u2500 modulex.py # Utility functions and menus\n\u251c\u2500\u2500 generated_images/ # Output directory (auto-created)\n\u251c\u2500\u2500 generation_log.txt # Activity log (auto-created)\n\u251c\u2500\u2500 last_style.txt # Temporary style storage (auto-created)\n\u251c\u2500\u2500 requirements.txt # Install required python library\n\u2514\u2500\u2500 README.md # This documentation\n```\n\n### Core Module Details\n\n#### `lucidx.py`\n- Application entry point\n- Main menu navigation\n- Signal handling for graceful interruption\n\n#### `core/genx.py`\n- Image generation engine\n- API communication with Stability AI\n- File management and batch processing\n- Progress tracking and logging\n\n#### `core/modulex.py`\n- Menu systems and user interactions\n- API key configuration interface\n- Help and documentation displays\n\n#### `core/banr.py`\n- ASCII art banners and logos\n- Session information display\n- Dynamic timestamp generation\n\n#### `core/colors.py`\n- Terminal color scheme definitions\n- Consistent visual styling across application\n\n## \ud83d\udcc2 Output Management\n\n### File Naming Convention\nGenerated images follow a standardized naming pattern:\n```\nYYYYMMDD_HHMMSS.png\n```\nExample: `20241220_143052.png` (December 20, 2024 at 14:30:52)\n\n### Storage Locations\n\n#### Linux/PC Systems\n- **Path**: `./generated_images/`\n- **Creation**: Automatically created relative to script location\n- **Permissions**: Standard user permissions\n\n#### Android (Termux)\n- **Path**: `/sdcard/LucidX_Images/`\n- **Creation**: Automatically created on SD card storage\n- **Access**: Accessible through file manager apps\n\n### Image Specifications\n- **Format**: PNG\n- **Quality**: High resolution (API dependent)\n- **Size**: Variable based on Stability AI model output\n- **Metadata**: Generation parameters logged separately\n\n## \ud83d\udcca Logging System\n\n### Generation Log (`generation_log.txt`)\n\nEach generation session creates detailed log entries:\n\n```\n[2024-12-20 14:30:52] Prompt: \"sunset over mountain lake\" -\u203a 20241220_143052.png\n[2024-12-20 14:30:54] Prompt: \"sunset over mountain lake\" -\u203a 20241220_143054.png\n[2024-12-20 14:30:56] Prompt: \"sunset over mountain lake\" -\u203a 20241220_143056.png\n[2024-12-20 14:30:58] Prompt: \"sunset over mountain lake\" -\u203a 20241220_143058.png\n```\n\n### Session Summary\n\nDisplayed at the end of each session:\n```\n:: LucidX Session Summary ::\n \u203a Prompts entered : 3\n \u203a Images generated : 12\n \u203a Output directory : /home/user/LucidX/generated_images\n \u203a Session completed.\n```\n\n### Error Logging\n- API errors logged with full response details\n- Network issues captured with diagnostic information\n- File system errors documented with context\n\n## \ud83d\udda5\ufe0f Platform Compatibility\n\n### Linux Distributions\n- **Ubuntu/Debian**: Fully supported\n- **Fedora/CentOS**: Fully supported \n- **Arch Linux**: Fully supported\n- **Kali Linux**: Fully supported (as tested)\n- **Alpine Linux**: Compatible with Python 3.7+\n\n### Android (Termux)\n- **Installation**: Available through Termux package manager\n- **Storage**: Automatic internal storage integration\n- **Performance**: Optimized for mobile hardware\n- **Permissions**: Handles Android storage permissions\n\n### Requirements by Platform\n\n#### Linux\n```bash\nsudo apt update\nsudo apt install python3 python3-pip\npip3 install colorama requests\n```\n\n#### Termux\n```bash\npkg update\npkg install python python-pip git\npip install colorama requests\n```\n\n## \ud83d\udd27 Troubleshooting\n\n### Common Issues\n\n#### API Key Problems\n**Issue**: \"API key not configured\" or authentication errors\n**Solutions**:\n- Verify API key is correctly entered (check for extra spaces)\n- Ensure API key is active on Stability AI platform\n- Check account credit balance\n- Reconfigure using menu option [2]\n\n#### Network Issues\n**Issue**: Connection timeout or network errors\n**Solutions**:\n- Verify internet connectivity\n- Check firewall settings\n- Try using VPN if blocked in your region\n- Ensure stable internet connection during generation\n\n#### File Permission Errors\n**Issue**: Cannot save files or create directories\n**Solutions**:\n- Check write permissions in current directory\n- For Termux: Ensure storage permissions are granted\n- Run with appropriate user permissions\n- Verify sufficient disk space\n\n#### Import Errors\n**Issue**: `ModuleNotFoundError` for colorama or requests\n**Solutions**:\n```bash\npip install --upgrade colorama requests\n# or for system-wide installation\npip3 install --upgrade colorama requests\n```\n\n### Performance Optimization\n\n#### For Slower Systems\n- Close unnecessary applications during generation\n- Ensure stable internet connection\n- Monitor available RAM and storage\n\n#### For Mobile/Termux\n- Use Wi-Fi instead of mobile data for better stability\n- Keep device plugged in during long sessions\n- Clear app cache if experiencing issues\n\n\n## \ud83e\udd1d Contributing\n\nWe welcome contributions from the community! Here's how you can help:\n\n### Ways to Contribute\n- \ud83d\udc1b **Bug Reports**: Submit detailed issue reports\n- \ud83d\udca1 **Feature Requests**: Suggest new functionality\n- \ud83d\udd27 **Code Contributions**: Submit pull requests\n- \ud83d\udcda **Documentation**: Improve documentation and examples\n- \ud83c\udfa8 **Style Presets**: Suggest new artistic styles\n\n### Development Setup\n```bash\n# Fork the repository on GitHub\n# Clone your fork\ngit clone https://github.com/yourusername/LucidX.git\n\n# Create a feature branch\ngit checkout -b feature/your-feature-name\n\n# Make changes and test thoroughly\n# Commit with descriptive messages\ngit commit -m \"Add: new feature description\"\n\n# Push to your fork and create pull request\ngit push origin feature/your-feature-name\n```\n\n### Code Standards\n- Follow PEP 8 Python style guidelines\n- Include docstrings for new functions\n- Test on both Linux and Termux when possible\n- Maintain backward compatibility\n\n### Issue Reporting\nWhen reporting issues, please include:\n- Python version\n- Operating system and version\n- Error messages (full traceback)\n- Steps to reproduce\n- Expected vs actual behavior\n\n## \ud83d\udcde Contact & Support\n\n### Developer Information\n[](https://vritrasec.com)\n[](https://vritrasec.com)\n[](https://github.com/VritraSecz)\n\n### Community & Support\n[](https://instagram.com/haxorlex)\n[](https://youtube.com/@Technolex)\n[](https://t.me/LinkCentralX)\n[](https://t.me/ethicxbot)\n\n### Getting Help\n1. **Check Documentation**: Review this README and built-in help\n2. **Search Issues**: Look for existing solutions on GitHub\n3. **Community Support**: Ask questions on Telegram channel\n4. **Bug Reports**: Submit detailed issues on GitHub\n5. **Direct Contact**: Use support bot for urgent issues\n\n\n## \ud83d\udcc4 License\n\n<div align=\"center\">\n\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/VritraSecz/LucidX)\n[](https://www.gnu.org/philosophy/free-sw.html)\n\n</div>\n\n+ **This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.**\n\n<div align=\"center\">\n\n### \ud83c\udff7\ufe0f MIT License Permissions & Limitations\n\n<table>\n<tr>\n<td align=\"center\" width=\"50%\">\n\n#### \u2705 **PERMISSIONS**\n\n<div align=\"left\">\n\n\n\n\n\n\n\n\n\n</div>\n\n</td>\n<td align=\"center\" width=\"50%\">\n\n#### \u274c **LIMITATIONS**\n\n<div align=\"left\">\n\n\n\n\n\n</div>\n\n\n\n#### \u26a0\ufe0f **REQUIREMENTS**\n\n<div align=\"left\">\n\n\n\n</div>\n</td>\n</tr>\n</table>\n\n</div>\n\n---\n\n<div align=\"center\">\n\n**LucidX v1.0.4** - *\"I don't paint dreams. I compute realities yet to be rendered.\"*\n\nMade with \u2764\ufe0f by [VritraSec](https://vritrasec.com)\n\n</div>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "AI-powered image synthesis engine using Stability AI API",
"version": "1.0.4",
"project_urls": {
"Bug Tracker": "https://github.com/VritraSecz/LucidX/issues",
"Documentation": "https://github.com/VritraSecz/LucidX#readme",
"Homepage": "https://github.com/VritraSecz/LucidX",
"Source Code": "https://github.com/VritraSecz/LucidX",
"Telegram": "https://t.me/LinkCentralX",
"Website": "https://vritrasec.com"
},
"split_keywords": [
"ai",
" artificial-intelligence",
" image-generation",
" stability-ai",
" text-to-image",
" image-synthesis",
" cli",
" tool",
" python",
" machine-learning",
" deep-learning",
" creative",
" art",
" digital-art"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "dde55120ef60845409ea92e2b242a627e246c09bcb9f9ac44276924c92853952",
"md5": "c71119d66c5e931d4e63e4b60a68b661",
"sha256": "339e640cbb75afb50553dd61bc8fa06f676c7b8027f140ffcbbc9b0d8f40674c"
},
"downloads": -1,
"filename": "lucidx-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c71119d66c5e931d4e63e4b60a68b661",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18653,
"upload_time": "2025-07-31T22:13:50",
"upload_time_iso_8601": "2025-07-31T22:13:50.126983Z",
"url": "https://files.pythonhosted.org/packages/dd/e5/5120ef60845409ea92e2b242a627e246c09bcb9f9ac44276924c92853952/lucidx-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "be566e8336b3472674fb79eb729ba85a72f5d89b57760eb1690536c9def3144e",
"md5": "5aa8501e9c2541e3df215673a9eb7b07",
"sha256": "9749d5f8be22480efc74b5b9fe112d26a773040c05675134a0050bf30bf52bc4"
},
"downloads": -1,
"filename": "lucidx-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "5aa8501e9c2541e3df215673a9eb7b07",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 24927,
"upload_time": "2025-07-31T22:13:52",
"upload_time_iso_8601": "2025-07-31T22:13:52.537999Z",
"url": "https://files.pythonhosted.org/packages/be/56/6e8336b3472674fb79eb729ba85a72f5d89b57760eb1690536c9def3144e/lucidx-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-31 22:13:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VritraSecz",
"github_project": "LucidX",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "colorama",
"specs": [
[
">=",
"0.4.4"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.28.0"
]
]
}
],
"lcname": "lucidx"
}
JSON
