2.9 KiB
2.9 KiB
Getting Started - Dubai Metaverse
Welcome!
This guide will help you get started with the Dubai Metaverse project.
Prerequisites Checklist
- Git installed
- Git LFS installed (for large files)
- Python 3.8+ installed
- Unreal Engine 5.4 (to be installed)
- Epic Games Launcher (for UE5)
Quick Start (5 Minutes)
1. Verify Setup
# Run master setup to validate everything
./scripts/setup/master_setup.sh
2. Install Python Dependencies
pip install -r requirements.txt
3. Install Git LFS (if not installed)
# Linux
sudo apt install git-lfs
git lfs install
# macOS
brew install git-lfs
git lfs install
# Windows
# Download from: https://git-lfs.github.com
4. Verify Git Repository
git status
git log --oneline
Next Steps
Immediate (Can Do Now)
- ✅ Review documentation
- ✅ Run validation scripts
- ✅ Check project structure
- ✅ Review task lists
After UE5 Installation
- Install Unreal Engine 5.4 (see
docs/setup/UE5_INSTALLATION.md) - Create
DubaiMetaverseproject - Copy config templates
- Begin Phase 1, Week 2
Key Files to Read First
- README.md - Project overview
- docs/reference/COMMAND_REFERENCE.md - Command reference (includes quick commands)
- PROGRESS_REPORTS/PROJECT_STATUS.md - Current status and next steps
- docs/setup/NEXT_STEPS_AFTER_BUILD.md - Complete next steps guide
- docs/setup/UE5_INSTALLATION.md - UE5 installation guide
Common Tasks
View Project Status
cat PROGRESS_REPORTS/PROJECT_STATUS.md
Run Validation
./scripts/validation/validate_project.sh
Check Next Steps
cat PROGRESS_REPORTS/PROJECT_STATUS.md
View Task List
cat TASKS/phase1_tasks.md
Getting Help
- Documentation: See
docs/directory - Command Reference:
docs/reference/COMMAND_REFERENCE.md - Command Reference:
docs/reference/COMMAND_REFERENCE.md - Troubleshooting: Check relevant documentation files
Project Structure
metaverseDubai/
├── README.md # Start here
├── docs/setup/GETTING_STARTED.md # This file
├── docs/reference/COMMAND_REFERENCE.md # Command reference
├── PROGRESS_REPORTS/PROJECT_STATUS.md # Current status and next steps
├── docs/ # Technical documentation
├── TASKS/ # Task breakdowns
├── scripts/ # Automation scripts
└── Content/ # UE5 content (after project creation)
Success Indicators
You're ready when:
- ✅
./scripts/master_setup.shruns without errors - ✅
./scripts/validation/validate_project.shpasses - ✅ All documentation files present
- ✅ Git repository initialized
- ✅ Python dependencies installed
Ready to begin? Follow docs/setup/UE5_INSTALLATION.md to install Unreal Engine 5.4!