126 lines
2.6 KiB
Markdown
126 lines
2.6 KiB
Markdown
# 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
|
|
```bash
|
|
# Run master setup to validate everything
|
|
./scripts/master_setup.sh
|
|
```
|
|
|
|
### 2. Install Python Dependencies
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
### 3. Install Git LFS (if not installed)
|
|
```bash
|
|
# 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
|
|
```bash
|
|
git status
|
|
git log --oneline
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
### Immediate (Can Do Now)
|
|
1. ✅ Review documentation
|
|
2. ✅ Run validation scripts
|
|
3. ✅ Check project structure
|
|
4. ✅ Review task lists
|
|
|
|
### After UE5 Installation
|
|
1. Install Unreal Engine 5.4 (see `UE5_SETUP.md`)
|
|
2. Create `DubaiMetaverse` project
|
|
3. Copy config templates
|
|
4. Begin Phase 1, Week 2
|
|
|
|
## Key Files to Read First
|
|
|
|
1. **README.md** - Project overview
|
|
2. **QUICK_REFERENCE.md** - Quick commands
|
|
3. **NEXT_STEPS.md** - Detailed next steps
|
|
4. **PROJECT_STATUS.md** - Current status
|
|
5. **UE5_SETUP.md** - UE5 installation guide
|
|
|
|
## Common Tasks
|
|
|
|
### View Project Status
|
|
```bash
|
|
cat PROJECT_STATUS.md
|
|
```
|
|
|
|
### Run Validation
|
|
```bash
|
|
./scripts/validate_project.sh
|
|
```
|
|
|
|
### Check Next Steps
|
|
```bash
|
|
cat NEXT_STEPS.md
|
|
```
|
|
|
|
### View Task List
|
|
```bash
|
|
cat TASKS/phase1_tasks.md
|
|
```
|
|
|
|
## Getting Help
|
|
|
|
- **Documentation**: See `docs/` directory
|
|
- **Quick Reference**: `QUICK_REFERENCE.md`
|
|
- **Command Reference**: `COMMAND_REFERENCE.md`
|
|
- **Troubleshooting**: Check relevant documentation files
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
metaverseDubai/
|
|
├── README.md # Start here
|
|
├── GETTING_STARTED.md # This file
|
|
├── QUICK_REFERENCE.md # Quick commands
|
|
├── NEXT_STEPS.md # Detailed 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.sh` runs without errors
|
|
- ✅ `./scripts/validate_project.sh` passes
|
|
- ✅ All documentation files present
|
|
- ✅ Git repository initialized
|
|
- ✅ Python dependencies installed
|
|
|
|
---
|
|
|
|
**Ready to begin?** Follow `UE5_SETUP.md` to install Unreal Engine 5.4!
|
|
|