# Command Reference - Dubai Metaverse **Quick Reference Guide** - All common commands and workflows in one place. ## Table of Contents - [Git Commands](#git-commands) - [Project Scripts](#project-scripts) - [Data Import](#data-import) - [Python Environment](#python-environment) - [Unreal Engine](#unreal-engine) - [Common Tasks](#common-tasks) - [Key File Locations](#key-file-locations) - [Troubleshooting](#troubleshooting) --- ## Git Commands ### Initial Setup ```bash # Initialize repository git init # Install Git LFS git lfs install # Track large files git lfs track "*.uasset" git lfs track "*.umap" git lfs track "*.png" git lfs track "*.fbx" # Initial commit git add . git commit -m "Initial commit" ``` ### Daily Workflow ```bash # Check status git status # Add changes git add git add . # Commit git commit -m "Description of changes" # Push (if remote configured) git push origin main ``` ## Project Scripts ### Setup ```bash # Full project setup ./scripts/setup/setup_project.sh # UE5 project setup validation ./scripts/setup/setup_ue5_project.sh ``` ### Validation ```bash # Validate assets ./scripts/validation/validate_assets.sh # Validate documentation ./scripts/generate_docs.sh # Full project validation ./scripts/validation/validate_project.sh ``` ### Data Import ```bash # Import OSM data python3 scripts/data/import_osm_data.py \ --output data/processed/dubai_marina_buildings.geojson # Convert elevation data python3 scripts/data/gis_to_unreal.py \ data/elevation/dem.tif \ --output data/processed/terrain_heightmap.raw \ --format raw ``` ## Python Environment ### Setup ```bash # Install dependencies pip install -r requirements.txt # Or use virtual environment python3 -m venv venv source venv/bin/activate # Linux/Mac # venv\Scripts\activate # Windows pip install -r requirements.txt ``` ## Unreal Engine (After Installation) ### Project Creation 1. Launch Unreal Engine 5.4 2. Create new project: `DubaiMetaverse` 3. Template: Blank 4. Blueprint 5. Desktop platform 6. Maximum quality 7. No starter content ### Configuration 1. Copy `Config/DefaultEngine.ini.template` to `Config/DefaultEngine.ini` 2. Copy `Config/DefaultGame.ini.template` to `Config/DefaultGame.ini` 3. Customize settings as needed 4. Enable plugins (see docs/setup/PLUGINS.md) ## Common Tasks ### Create New Asset 1. Follow naming convention 2. Place in appropriate Content/ folder 3. Validate: `./scripts/validation/validate_assets.sh` 4. Commit: `git add Content/Assets/... && git commit -m "Add [asset name]"` ### Update Documentation 1. Edit .md file 2. Check links 3. Commit: `git add [file].md && git commit -m "Update [file]"` ### Report Progress 1. Edit `PROGRESS_REPORTS/weekX_report.md` 2. Update checkboxes 3. Commit progress ## Key File Locations ### Documentation - **Main README**: `README.md` - **Project Plan**: `docs/planning/PROJECT_PLAN.md` - **Technical Brief**: `docs/TECHNICAL_BRIEF.md` - **Art Bible**: `docs/ART_BIBLE.md` - **Documentation Index**: `docs/README.md` ### Configuration - **Engine Settings**: `Config/DefaultEngine.ini` - **Game Settings**: `Config/DefaultGame.ini` - **Project Settings**: `docs/setup/PROJECT_SETTINGS.md` - **Project Config**: `project.config.json` ### Tasks - **Phase Tasks**: `TASKS/phaseX_tasks.md` - **Milestones**: `docs/planning/MILESTONES.md` ### Scripts - **Setup**: `scripts/setup/` - **Installation**: `scripts/install/` - **Validation**: `scripts/validation/` - **Data Processing**: `scripts/data/` - **Build**: `scripts/build/` ## Troubleshooting ### Scripts Not Working - Check file permissions: `chmod +x scripts/**/*.sh` - Check Python version: `python3 --version` - Install dependencies: `pip install -r requirements.txt` - See: `docs/troubleshooting/TROUBLESHOOTING.md` ### Git LFS Issues - Verify installation: `git lfs version` - Re-track files: `git lfs track "*.uasset"` - Check .gitattributes file - See: `docs/setup/VERSION_CONTROL.md` ### Documentation Links Broken - Run `scripts/generate_docs.sh` to check - Verify file paths - Update links if needed - See: `docs/README.md` ### UE5 Installation Issues - See: `docs/setup/UE5_INSTALLATION.md` - Troubleshooting: `docs/troubleshooting/FAQ.md` ## Quick Links - [Project Status](PROGRESS_REPORTS/PROJECT_STATUS.md) - [Project Health](docs/PROJECT_HEALTH.md) - [Technical Specs](docs/TECHNICAL_SPECS.md) - [Asset Catalog](ASSET_CATALOG.md) - [Documentation Index](docs/README.md) - [Troubleshooting](docs/troubleshooting/TROUBLESHOOTING.md) --- **Last Updated**: 2024