108 lines
2.2 KiB
Markdown
108 lines
2.2 KiB
Markdown
# Quick Reference Guide - Dubai Metaverse
|
|
|
|
## Common Commands
|
|
|
|
### Project Setup
|
|
```bash
|
|
# Initialize project
|
|
./scripts/setup_project.sh
|
|
|
|
# Setup UE5 project structure
|
|
./scripts/setup_ue5_project.sh
|
|
|
|
# Validate assets
|
|
./scripts/validate_assets.sh
|
|
|
|
# Generate documentation check
|
|
./scripts/generate_docs.sh
|
|
```
|
|
|
|
### Data Import
|
|
```bash
|
|
# Import OSM data
|
|
python3 scripts/import_osm_data.py --output data/processed/dubai_marina_buildings.geojson
|
|
|
|
# Convert elevation data
|
|
python3 scripts/gis_to_unreal.py data/elevation/dem.tif --output data/processed/terrain_heightmap.raw
|
|
```
|
|
|
|
### Git Commands
|
|
```bash
|
|
# Initialize Git LFS
|
|
git lfs install
|
|
|
|
# Track large files
|
|
git lfs track "*.uasset"
|
|
git lfs track "*.umap"
|
|
|
|
# Add and commit
|
|
git add .
|
|
git commit -m "Initial commit"
|
|
```
|
|
|
|
## Key File Locations
|
|
|
|
### Documentation
|
|
- **Main README**: `README.md`
|
|
- **Project Plan**: `PROJECT_PLAN.md`
|
|
- **Technical Brief**: `TECHNICAL_BRIEF.md`
|
|
- **Art Bible**: `ART_BIBLE.md`
|
|
|
|
### Configuration
|
|
- **Engine Settings**: `Config/DefaultEngine.ini`
|
|
- **Game Settings**: `Config/DefaultGame.ini`
|
|
- **Project Settings**: `PROJECT_SETTINGS.md`
|
|
|
|
### Tasks
|
|
- **Phase Tasks**: `TASKS/phaseX_tasks.md`
|
|
- **Milestones**: `MILESTONES.md`
|
|
|
|
## Common Tasks
|
|
|
|
### Create New Asset
|
|
1. Follow naming convention (see `NAMING_CONVENTIONS.md`)
|
|
2. Place in appropriate folder
|
|
3. Validate with `validate_assets.sh`
|
|
4. Commit with descriptive message
|
|
|
|
### Update Documentation
|
|
1. Edit relevant .md file
|
|
2. Check links
|
|
3. Update if needed
|
|
4. Commit changes
|
|
|
|
### Report Progress
|
|
1. Update `PROGRESS_REPORTS/weekX_report.md`
|
|
2. Check off completed tasks
|
|
3. Document issues
|
|
4. Commit progress
|
|
|
|
## Troubleshooting
|
|
|
|
### Scripts Not Working
|
|
- Check file permissions: `chmod +x scripts/*.sh`
|
|
- Check Python version: `python3 --version`
|
|
- Install dependencies: `pip install -r requirements.txt`
|
|
|
|
### Git LFS Issues
|
|
- Verify installation: `git lfs version`
|
|
- Re-track files: `git lfs track "*.uasset"`
|
|
- Check .gitattributes file
|
|
|
|
### Documentation Links Broken
|
|
- Run `generate_docs.sh` to check
|
|
- Verify file paths
|
|
- Update links if needed
|
|
|
|
## Quick Links
|
|
|
|
- [Project Status](PROJECT_STATUS.md)
|
|
- [Next Steps](NEXT_STEPS.md)
|
|
- [Technical Specs](TECHNICAL_SPECS.md)
|
|
- [Asset Catalog](ASSET_CATALOG.md)
|
|
|
|
---
|
|
|
|
**Last Updated**: [Current Date]
|
|
|