Skip to main content

All-in-one CLI toolkit for Unreal Engine developers

Project description

🎮 UnrealMate

All-in-one CLI toolkit for Unreal Engine developers

Unreal Engine geliştiricileri için hepsi bir arada CLI araç kiti

PyPI Tests Python License Platform Unreal Engine


🇬🇧 English🇹🇷 Türkçe


Speed up your Unreal Engine workflow with powerful CLI commands


🇬🇧 English

📋 Table of Contents

✨ Features

🔧 Git Tools

Manage your Git workflow efficiently

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

📦 Asset Management

Keep your assets organized

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

📊 Blueprint Analysis

Understand your Blueprint complexity

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

🩺 Project Health

Keep your project healthy

  • ✅ Health score (0-100)
  • ✅ Configuration checks
  • ✅ Best practice validation

🚀 Installation

The easiest way to install UnrealMate v0.1.5 🚀via pip:

pip install unrealmate

Verification

unrealmate --help

Dev Installation (Optional)

If you want to contribute or develop:

git clone https://github.com/gktrk363/unrealmate.git
cd unrealmate
python -m venv venv
# Windows: venv\Scripts\activate
# Mac/Linux: source venv/bin/activate
pip install -e .

⚡ Quick Start

# Navigate to your UE project
cd "C:/Projects/MyGame"

# Check project health
unrealmate doctor

# Setup Git (one-time)
unrealmate git init
unrealmate git lfs

# Clean temporary files (save space)
unrealmate git clean

# Scan assets
unrealmate asset scan

# Analyze blueprints
unrealmate blueprint analyze

📖 Commands

🔧 Git Commands

Command Description
unrealmate git init Generate .gitignore for UE projects
unrealmate git lfs Setup Git LFS for large files
unrealmate git clean Remove temporary/cache files
# Examples
unrealmate git init              # Create .gitignore
unrealmate git clean --dry-run   # Preview what will be deleted

📦 Asset Commands

Command Description
unrealmate asset scan Scan and report all assets
unrealmate asset organize Auto-organize assets into folders
unrealmate asset duplicates Find duplicate assets
# Examples
unrealmate asset scan --all              # Show all files
unrealmate asset organize --dry-run      # Preview organization
unrealmate asset duplicates --content    # Accurate duplicate scan

📊 Blueprint Commands

Command Description
unrealmate blueprint analyze Analyze Blueprint statistics
unrealmate blueprint report Generate complexity report
# Examples
unrealmate blueprint analyze --all        # Show all BPs
unrealmate blueprint report -o report.html   # Generate HTML report

🩺 Health Commands

Command Description
unrealmate doctor Check project health & configuration
unrealmate version Show version info

🤝 Contributing

Contributions are welcome! Here's how:

  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

📄 License

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


🇹🇷 Türkçe

📋 İçindekiler

✨ Özellikler

🔧 Git Araçları

Git iş akışınızı verimli yönetin

  • ✅ Optimize edilmiş .gitignore oluştur
  • ✅ Git LFS'i otomatik kur
  • ✅ Geçici dosyaları temizle (GB'larca yer kazan!)

📦 Asset Yönetimi

Asset'lerinizi düzenli tutun

  • ✅ Tüm asset'leri tara ve raporla
  • ✅ Klasörlere otomatik düzenle
  • ✅ Tekrarlayan dosyaları bul

📊 Blueprint Analizi

Blueprint karmaşıklığınızı anlayın

  • ✅ BP istatistiklerini analiz et
  • ✅ Karmaşıklık puanlaması
  • ✅ HTML/JSON rapor çıkart

🩺 Proje Sağlığı

Projenizi sağlıklı tutun

  • ✅ Sağlık puanı (0-100)
  • ✅ Yapılandırma kontrolleri
  • ✅ Best practice doğrulama

🚀 Kurulum

UnrealMate'i kurmanın en kolay yolu pip kullanmaktır:

pip install unrealmate

Doğrulama

unrealmate --help

Geliştirici Kurulumu (Opsiyonel)

Eğer projeye katkıda bulunmak istiyorsanız:

git clone https://github.com/gktrk363/unrealmate.git
cd unrealmate
python -m venv venv
# Windows: venv\Scripts\activate
# Mac/Linux: source venv/bin/activate
pip install -e .

⚡ Hızlı Başlangıç

# UE projenize gidin
cd "C:/Projects/MyGame"

# Proje sağlığını kontrol et
unrealmate doctor

# Git kurulumu (bir kere)
unrealmate git init
unrealmate git lfs

# Geçici dosyaları temizle (yer açın)
unrealmate git clean

# Asset'leri tara
unrealmate asset scan

# Blueprint'leri analiz et
unrealmate blueprint analyze

📖 Komutlar

🔧 Git Komutları

Komut Açıklama
unrealmate git init UE projeleri için .gitignore oluştur
unrealmate git lfs Büyük dosyalar için Git LFS kur
unrealmate git clean Geçici/önbellek dosyalarını sil
# Örnekler
unrealmate git init              # .gitignore oluştur
unrealmate git clean --dry-run   # Silinecekleri önizle

📦 Asset Komutları

Komut Açıklama
unrealmate asset scan Tüm asset'leri tara ve raporla
unrealmate asset organize Asset'leri klasörlere otomatik düzenle
unrealmate asset duplicates Tekrarlayan asset'leri bul
# Örnekler
unrealmate asset scan --all              # Tüm dosyaları göster
unrealmate asset organize --dry-run      # Düzenlemeyi önizle
unrealmate asset duplicates --content    # İçeriğe göre karşılaştır (doğru)

📊 Blueprint Komutları

Komut Açıklama
unrealmate blueprint analyze Blueprint istatistiklerini analiz et
unrealmate blueprint report Karmaşıklık raporu oluştur
# Örnekler
unrealmate blueprint analyze --all        # Tüm BP'leri göster
unrealmate blueprint report -o report.html   # HTML rapor oluştur

🩺 Sağlık Komutları

Komut Açıklama
unrealmate doctor Proje sağlığını ve yapılandırmasını kontrol et
unrealmate version Versiyon bilgisini göster

🤝 Katkıda Bulunma

Katkılarınızı bekliyoruz! İşte nasıl yapılır:

  1. 🍴 Repoyu fork'layın
  2. 🌿 Feature branch oluşturun (git checkout -b feature/harika-ozellik)
  3. ✍️ Değişikliklerinizi commit'leyin (git commit -m '✨ Harika özellik ekle')
  4. 📤 Branch'e push'layın (git push origin feature/harika-ozellik)
  5. 🔃 Pull Request açın

📄 Lisans

Bu proje MIT Lisansı ile lisanslanmıştır - detaylar için LICENSE dosyasına bakın.


👤 Author / Geliştirici

gktrk363

GitHub


⭐ Star this repo if it helped you! / Yardımcı olduysa yıldız ver!


Made for Unreal Engine developers <3 Unreal Engine geliştiricileri için yapıldı <3


🎮 Happy Game Development! / İyi Oyun Geliştirmeler! 🎮

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-0.1.5.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

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

unrealmate-0.1.5-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for unrealmate-0.1.5.tar.gz
Algorithm Hash digest
SHA256 d3559fac0481474dfd1cf2d846ab7b21df6ce8528413a60df941825526c5e162
MD5 5ab4b83fb85288c74ce08c607c586842
BLAKE2b-256 d9a8e2d5f0e6644c64d9d71ed5bfe898b16dd6e994ee49fa08f9c8ad9bf99eed

See more details on using hashes here.

Provenance

The following attestation bundles were made for unrealmate-0.1.5.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-0.1.5-py3-none-any.whl.

File metadata

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

File hashes

Hashes for unrealmate-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b15d7b1f7a29c5d45d6781dc1e2f00c102f601e8ddda5a171728e2ba9b704bbe
MD5 a4be5d14c9a4312d4b3ab584d9079900
BLAKE2b-256 92ab05332bde1a1c7a6a870637575c95fc3c55e9a5ea4e0543c0fd4686b9132e

See more details on using hashes here.

Provenance

The following attestation bundles were made for unrealmate-0.1.5-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