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
Speed up your Unreal Engine workflow with powerful CLI commands
🇬🇧 English
📋 Table of Contents
✨ Features
🚀 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:
- 🍴 Fork the repository
- 🌿 Create a feature branch (
git checkout -b feature/amazing-feature) - ✍️ Commit your changes (
git commit -m '✨ Add amazing feature') - 📤 Push to the branch (
git push origin feature/amazing-feature) - 🔃 Open a Pull Request
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🇹🇷 Türkçe
📋 İçindekiler
✨ Özellikler
🚀 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:
- 🍴 Repoyu fork'layın
- 🌿 Feature branch oluşturun (
git checkout -b feature/harika-ozellik) - ✍️ Değişikliklerinizi commit'leyin (
git commit -m '✨ Harika özellik ekle') - 📤 Branch'e push'layın (
git push origin feature/harika-ozellik) - 🔃 Pull Request açın
📄 Lisans
Bu proje MIT Lisansı ile lisanslanmıştır - detaylar için LICENSE dosyasına bakın.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file unrealmate-0.1.9.tar.gz.
File metadata
- Download URL: unrealmate-0.1.9.tar.gz
- Upload date:
- Size: 19.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1de25eae76604ce27567668442282f701746d1de7dcda9ca45ab3c17d945ba0d
|
|
| MD5 |
615c5d6ea4e6304c2515cb0280a7c83f
|
|
| BLAKE2b-256 |
8756eeefdb1a76c14473f8de98298655a52f0bc9c902b33bfc8067c198b3187d
|
File details
Details for the file unrealmate-0.1.9-py3-none-any.whl.
File metadata
- Download URL: unrealmate-0.1.9-py3-none-any.whl
- Upload date:
- Size: 18.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bd630bf1a54712f7e7b39c4af93d94f9cd3177b6892e33c7dec0121aa434d10c
|
|
| MD5 |
f5b7698c0a240eba804f1c9beb86848a
|
|
| BLAKE2b-256 |
f60b031f8d2676b7eaae2a67adb3edb6f162b1272f1e61d874c29e9488989c89
|