unrealmate 1.0.2

Professional CLI toolkit for Unreal Engine developers - Complete with performance profiling, plugin management, CI/CD generation, and personal branding by gktrk363

🎮 UnrealMate

Professional CLI Toolkit for Unreal Engine Developers

⚡ Crafted by gktrk363 ⚡

Streamline your Unreal Engine workflow with 30+ powerful CLI commands

🚀 Quick Start • 📖 Documentation • 🎯 Features • 💡 Examples

---

🌟 What is UnrealMate?

UnrealMate is a comprehensive command-line toolkit designed to supercharge your Unreal Engine development workflow. Whether you're managing Git repositories, analyzing blueprints, profiling performance, or organizing assets, UnrealMate provides intuitive commands that save you hours of manual work.

Why UnrealMate?

• ✨ 30+ Specialized Commands - Purpose-built for Unreal Engine projects
• 🎨 Beautiful CLI Interface - Cyan/magenta themed with rich formatting
• ⚡ Performance Tools - Profile, analyze, and optimize your projects
• 🔌 Plugin Management - Install and manage plugins via CLI
• 🏗️ CI/CD Generation - Auto-generate GitHub Actions, GitLab CI, Jenkins
• ⚙️ Configurable - Customize behavior with .unrealmate.toml
• 🚀 Production Ready - Stable, tested, and actively maintained

---

🎉 What's New in v1.0.1

Latest Release - Critical package distribution fix

• ✅ Fixed: All submodules now included in PyPI package
• ✅ Fixed: Installation from PyPI works perfectly
• ✅ Improved: Banner display across all terminal widths

See CHANGELOG.md for complete release history.

---

📦 Installation

Via pip (Recommended)

pip install unrealmate

Verify Installation

unrealmate version

You should see the beautiful UnrealMate banner! 🎨

Requirements

• Python: 3.10 or higher
• OS: Windows, macOS, or Linux
• Unreal Engine: 4.x or 5.x (optional, for project-specific commands)

---

✨ Features

🔧 Git Tools Streamline your Git workflow for Unreal projects Smart Initialization - .gitignore and .gitattributes for UE LFS Setup - Auto-configure Git LFS for large assets Repository Cleanup - Remove unnecessary files safely	📁 Asset Management Organize and optimize your project assets Asset Scanner - Find all assets with detailed info Smart Organization - Auto-organize by type/category Duplicate Detection - Find and remove duplicate assets
🎯 Blueprint Analysis Understand and optimize your blueprints Complexity Analysis - Measure blueprint complexity Dependency Mapping - Visualize blueprint relationships Performance Reports - Identify optimization opportunities	⚡ Performance Profiling Analyze and optimize game performance CPU/GPU Profiler - Parse profiling reports Shader Analyzer - Detect shader complexity issues Memory Auditor - Track asset memory usage
🔌 Plugin Management Manage Unreal Engine plugins effortlessly Install from Git - Clone and install plugins Enable/Disable - Toggle plugins in .uproject List Plugins - View all installed plugins Safe Removal - Uninstall plugins cleanly	🏗️ CI/CD Generation Automate your build pipelines GitHub Actions - Generate workflow files GitLab CI - Create .gitlab-ci.yml Jenkins - Generate Jenkinsfile Best Practices - Industry-standard templates
⚙️ Configuration System Customize UnrealMate to your needs TOML Configuration - .unrealmate.toml support User Preferences - Save your settings Easy Management - Get/set config values Sensible Defaults - Works out of the box	🏥 Project Health Keep your project in top shape Doctor Command - Comprehensive health checks Issue Detection - Find common problems Recommendations - Get actionable advice Auto-fix - Automatic problem resolution (coming soon)

---

🎯 Commands

UnrealMate provides 7 command groups with 30+ commands:

Core Commands

unrealmate version          # Show version with beautiful banner
unrealmate doctor           # Run project health checks

Git Commands

unrealmate git init         # Initialize Git with UE-specific config
unrealmate git lfs          # Setup Git LFS for large files
unrealmate git clean        # Clean repository safely

Asset Commands

unrealmate asset scan       # Scan all project assets
unrealmate asset organize   # Auto-organize assets by type
unrealmate asset duplicates # Find duplicate assets

Blueprint Commands

unrealmate blueprint analyze  # Analyze blueprint complexity
unrealmate blueprint report   # Generate detailed reports

Performance Commands ⚡ NEW!

unrealmate performance profile  # Analyze CPU/GPU/Memory
unrealmate performance shaders  # Detect shader issues
unrealmate performance memory   # Track memory usage

Plugin Commands 🔌 NEW!

unrealmate plugin list          # List all plugins
unrealmate plugin install       # Install from Git/local
unrealmate plugin enable        # Enable a plugin
unrealmate plugin disable       # Disable a plugin
unrealmate plugin remove        # Uninstall a plugin

Build Commands 🏗️ NEW!

unrealmate build ci-init        # Generate CI/CD configs
unrealmate build info           # Show project info

Config Commands ⚙️ NEW!

unrealmate config init          # Create config file
unrealmate config show          # Display current config
unrealmate config set           # Set a config value
unrealmate config get           # Get a config value

---

💡 Usage Examples

Quick Start

# Initialize a new Unreal project with Git
unrealmate git init
unrealmate git lfs

# Check project health
unrealmate doctor

# Scan and organize assets
unrealmate asset scan
unrealmate asset organize

Performance Optimization

# Profile your game
unrealmate performance profile --csv-file profiling_report.csv

# Analyze shaders
unrealmate performance shaders --shader-dir Content/Shaders

# Check memory usage
unrealmate performance memory --content-dir Content

Plugin Management

# List installed plugins
unrealmate plugin list

# Install a plugin from GitHub
unrealmate plugin install https://github.com/user/plugin.git

# Enable a plugin
unrealmate plugin enable MyPlugin

CI/CD Setup

# Generate GitHub Actions workflow
unrealmate build ci-init --platform github

# Generate GitLab CI config
unrealmate build ci-init --platform gitlab

Configuration

# Create config file
unrealmate config init

# Set preferences
unrealmate config set signature.compact_banner true
unrealmate config set signature.show_footer false

# View current config
unrealmate config show

---

📖 Documentation

Configuration File

UnrealMate uses .unrealmate.toml for configuration:

[signature]
compact_banner = false
show_footer = true

[logging]
level = "INFO"
file_logging = false

[paths]
unreal_engine_path = "C:/Program Files/Epic Games/UE_5.3"

Environment Variables

UNREALMATE_CONFIG_PATH    # Custom config file location
UNREALMATE_LOG_LEVEL      # Override log level

---

🛠️ Development

For Contributors

# Clone repository
git clone https://github.com/gktrk363/unrealmate.git
cd unrealmate

# Install in development mode
pip install -e .

# Run commands
unrealmate --help

Building from Source

# Install build tools
pip install build twine

# Build package
python -m build

# Install locally
pip install dist/unrealmate-*.whl

---

🤝 Contributing

Contributions are welcome! Here's how you can help:

1. Report Bugs - Open an issue with detailed information
2. Suggest Features - Share your ideas for improvements
3. Submit PRs - Fix bugs or add features
4. Improve Docs - Help make documentation better
5. Share - Tell others about UnrealMate!

See CONTRIBUTING.md for guidelines.

---

📝 License

UnrealMate is licensed under the MIT License.

See LICENSE file for details.

---

🙏 Acknowledgments

• Unreal Engine by Epic Games
• Typer for amazing CLI framework
• Rich for beautiful terminal output
• Community for feedback and support

Special thanks to all Unreal Engine developers who inspired this project!

---

📊 Project Stats

• Version: 1.0.1 (Production/Stable)
• Commands: 30+
• Python Support: 3.10, 3.11, 3.12
• Platforms: Windows, macOS, Linux
• License: MIT
• Status: Actively Maintained

---

🔗 Links

• PyPI: https://pypi.org/project/unrealmate/
• GitHub: https://github.com/gktrk363/unrealmate
• Issues: https://github.com/gktrk363/unrealmate/issues
• Changelog: CHANGELOG.md

---

💬 Support

Need help? Have questions?

• 📧 Email: Open an issue on GitHub
• 💬 Discussions: Use GitHub Discussions
• 🐛 Bug Reports: Open an issue with details
• 💡 Feature Requests: Share your ideas

---

🌟 Star History

If you find UnrealMate useful, please consider giving it a ⭐ on GitHub!

---

Made with ❤️ for Unreal Engine Developers

⚡ Crafted by gktrk363 ⚡

Streamline your workflow. Build better games.

⬆ Back to Top