Skip to main content

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

Project description

🎮 UnrealMate

Professional CLI Toolkit for Unreal Engine Developers

Unreal Engine geliştiricileri için profesyonel CLI araç kiti

PyPI Version Python License Platform Unreal Engine Status


⚡ Crafted by gktrk363 ⚡

Speed up your Unreal Engine workflow with 30+ powerful CLI commands

🚀 Quick Start📖 Documentation🎯 Features🇹🇷 Türkçe


🎉 What's New in v1.0.0

Production/Stable Release - Complete feature set with personal branding!

  • Personal Signature System - Beautiful cyan/magenta themed interface
  • Performance Profiler - Analyze CPU/GPU/Memory bottlenecks
  • 🔍 Shader Analyzer - Detect shader complexity issues
  • 💾 Memory Auditor - Track asset memory usage
  • 🔌 Plugin Manager - Install/manage UE plugins via CLI
  • 🏗️ CI/CD Generator - GitHub Actions, GitLab CI, Jenkins
  • ⚙️ Configuration System - .unrealmate.toml support
  • 📝 Comprehensive Logging - Debug mode with file logging

✨ Features

🔧 Git Tools

Manage your Git workflow efficiently

  • ✅ Generate optimized .gitignore
  • ✅ Setup Git LFS automatically
  • ✅ Clean temporary files (save GBs!)
  • ✅ Pre-commit hooks

📦 Asset Management

Keep your assets organized

  • ✅ Scan & report all assets
  • ✅ Auto-organize into folders
  • ✅ Find duplicate files
  • ✅ Dependency tracking

📊 Blueprint Analysis

Understand your Blueprint complexity

  • ✅ Analyze BP statistics
  • ✅ Complexity scoring
  • ✅ Export HTML/JSON reports
  • ✅ Visual graph generation

⚡ Performance Tools

Optimize your project

  • ✅ Performance profiling
  • ✅ Shader complexity analysis
  • ✅ Memory auditing
  • ✅ Bottleneck detection

🔌 Plugin Management

Manage plugins easily

  • ✅ Install from Git/local
  • ✅ Enable/disable plugins
  • ✅ List installed plugins
  • ✅ Remove plugins

🏗️ Build & CI/CD

Automate your builds

  • ✅ GitHub Actions generator
  • ✅ GitLab CI generator
  • ✅ Jenkins pipelines
  • ✅ Build optimization

🚀 Installation

Via pip (Recommended)

pip install unrealmate

From source

git clone https://github.com/gktrk363/unrealmate.git
cd unrealmate
pip install -e .

Verification

unrealmate version

You should see the beautiful UnrealMate banner! 🎨


📖 Commands

Core Commands

unrealmate version          # Show version and signature banner
unrealmate doctor           # Health check with recommendations
unrealmate --help           # Show all available commands

Git Commands

unrealmate git init         # Generate .gitignore for UE projects
unrealmate git lfs          # Setup Git LFS for large files
unrealmate git clean        # Clean temporary files (Saved, Intermediate, etc.)

Asset Commands

unrealmate asset scan                    # Scan all assets in project
unrealmate asset scan --all              # Show detailed asset list
unrealmate asset organize                # Auto-organize assets by type
unrealmate asset organize --dry-run      # Preview organization
unrealmate asset duplicates              # Find duplicate files
unrealmate asset duplicates --content    # Compare by content (slower but accurate)

Blueprint Commands

unrealmate blueprint analyze             # Analyze all blueprints
unrealmate blueprint analyze --all       # Show all blueprints
unrealmate blueprint report              # Generate complexity report
unrealmate blueprint report -o report.html  # Export to HTML

Performance Commands ⚡ NEW!

unrealmate performance profile           # Analyze performance bottlenecks
unrealmate performance shaders           # Analyze shader complexity
unrealmate performance shaders --all     # Show all shaders
unrealmate performance memory            # Audit memory usage

Plugin Commands 🔌 NEW!

unrealmate plugin list                   # List installed plugins
unrealmate plugin install <git-url>      # Install from Git
unrealmate plugin install <local-path>   # Install from local directory
unrealmate plugin enable <name>          # Enable a plugin
unrealmate plugin disable <name>         # Disable a plugin
unrealmate plugin remove <name>          # Remove a plugin

Build Commands 🏗️ NEW!

unrealmate build ci-init --platform github   # Generate GitHub Actions
unrealmate build ci-init --platform gitlab   # Generate GitLab CI
unrealmate build ci-init --platform jenkins  # Generate Jenkinsfile
unrealmate build info                        # Show build information

Config Commands ⚙️ NEW!

unrealmate config init                   # Create .unrealmate.toml
unrealmate config show                   # Show all settings
unrealmate config set <key> <value>      # Set a configuration value
unrealmate config get <key>              # Get a configuration value

💡 Examples

Complete Workflow

# 1. Initialize your project
unrealmate config init
unrealmate git init
unrealmate git lfs

# 2. Check project health
unrealmate doctor

# 3. Analyze performance
unrealmate performance profile
unrealmate performance shaders
unrealmate performance memory

# 4. Manage plugins
unrealmate plugin list
unrealmate plugin install https://github.com/example/ue-plugin.git

# 5. Generate CI/CD
unrealmate build ci-init --platform github

# 6. Organize assets
unrealmate asset scan
unrealmate asset organize

# 7. Analyze blueprints
unrealmate blueprint analyze
unrealmate blueprint report -o report.html

Clean Up Project

# Preview what will be deleted
unrealmate git clean --dry-run

# Clean temporary files (saves GBs!)
unrealmate git clean

Find Issues

# Find duplicate assets
unrealmate asset duplicates --content

# Find complex blueprints
unrealmate blueprint analyze --all

# Find shader issues
unrealmate performance shaders

🎨 Personal Signature

Every command features beautiful branding by gktrk363:

  • 🎨 Cyan (#00D9FF) and Magenta (#FF006E) color theme
  • ⚡ Signature banner on version command
  • 🎯 Branded panels in all commands
  • ✨ Signature footer: "Powered by UnrealMate | Crafted by gktrk363"

📊 Project Statistics

  • 30+ Commands across 7 command groups
  • 8 New Modules in v1.0.0
  • 2000+ Lines of code added
  • Production/Stable status
  • Personal Signature throughout

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.


🙏 Acknowledgments

  • Built with Typer and Rich
  • Inspired by the Unreal Engine developer community
  • Special thanks to all contributors

📧 Contact

Developer: gktrk363
GitHub: @gktrk363
Project: UnrealMate


⭐ Star this repository if you find it helpful!

© 2026 gktrk363 - Crafted with passion for Unreal Engine developers

Powered by UnrealMate



🇹🇷 Türkçe

📋 İçindekiler

✨ Özellikler

🔧 Git Araçları

  • ✅ Optimize edilmiş .gitignore oluşturma
  • ✅ Git LFS otomatik kurulum
  • ✅ Geçici dosyaları temizleme (GB'larca yer kazanın!)

📦 Asset Yönetimi

  • ✅ Tüm assetleri tarama ve raporlama
  • ✅ Otomatik klasörlere organize etme
  • ✅ Duplicate dosyaları bulma

📊 Blueprint Analizi

  • ✅ Blueprint istatistikleri
  • ✅ Karmaşıklık skorlama
  • ✅ HTML/JSON rapor çıktısı

⚡ Performans Araçları (YENİ!)

  • ✅ Performans profilleme
  • ✅ Shader karmaşıklık analizi
  • ✅ Bellek denetimi

🔌 Plugin Yönetimi (YENİ!)

  • ✅ Git'ten plugin kurma
  • ✅ Plugin aktif/pasif etme
  • ✅ Plugin listesi

🏗️ Build & CI/CD (YENİ!)

  • ✅ GitHub Actions oluşturma
  • ✅ GitLab CI oluşturma
  • ✅ Jenkins pipeline

🚀 Kurulum

pip install unrealmate

🎯 Hızlı Başlangıç

# Versiyon kontrolü
unrealmate version

# Proje sağlık kontrolü
unrealmate doctor

# Git kurulumu
unrealmate git init
unrealmate git lfs

# Asset tarama
unrealmate asset scan

# Blueprint analizi
unrealmate blueprint analyze

📖 Komutlar

Tüm komutlar için:

unrealmate --help

Her komut grubu için yardım:

unrealmate git --help
unrealmate asset --help
unrealmate blueprint --help
unrealmate performance --help
unrealmate plugin --help
unrealmate build --help
unrealmate config --help

💡 Örnekler

Proje Temizleme

# Önizleme
unrealmate git clean --dry-run

# Temizle
unrealmate git clean

Performans Analizi

# Performans profili
unrealmate performance profile

# Shader analizi
unrealmate performance shaders

# Bellek denetimi
unrealmate performance memory

Plugin Yönetimi

# Kurulu pluginleri listele
unrealmate plugin list

# Git'ten plugin kur
unrealmate plugin install https://github.com/example/plugin.git

# Plugin aktif et
unrealmate plugin enable MyPlugin

⚡ gktrk363 tarafından Unreal Engine geliştiricileri için özenle hazırlanmıştır ⚡

⬆ Başa Dön

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unrealmate-1.0.0.tar.gz (35.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unrealmate-1.0.0-py3-none-any.whl (38.4 kB view details)

Uploaded Python 3

File details

Details for the file unrealmate-1.0.0.tar.gz.

File metadata

  • Download URL: unrealmate-1.0.0.tar.gz
  • Upload date:
  • Size: 35.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for unrealmate-1.0.0.tar.gz
Algorithm Hash digest
SHA256 3db05058aa80113ddaf2937ea2c37043489af71e3771dda2d3a3a6e209b92935
MD5 62fb98468a1d4db63e9e86a821f7b748
BLAKE2b-256 fec5542c4175452d785d49690260c7fc93acbfbc9a3a2785651bae6815c5b78a

See more details on using hashes here.

Provenance

The following attestation bundles were made for unrealmate-1.0.0.tar.gz:

Publisher: release.yml on gktrk363/unrealmate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file unrealmate-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: unrealmate-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 38.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for unrealmate-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 76ab6ebf033e4504910ab780ea144e39e273ddf8ad271053be615ce68de6988a
MD5 0739f555ecc2c7f712feb8ebbf186c4f
BLAKE2b-256 b4f2e3fe09e9c580d45de0bae507bfded8c022fb99e4a33b90c03f8702027ab9

See more details on using hashes here.

Provenance

The following attestation bundles were made for unrealmate-1.0.0-py3-none-any.whl:

Publisher: release.yml on gktrk363/unrealmate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page