Initial commit: Complete project foundation with all documentation, scripts, and project structure
This commit is contained in:
107
scripts/README.md
Normal file
107
scripts/README.md
Normal file
@@ -0,0 +1,107 @@
|
||||
# Scripts Directory - Dubai Metaverse
|
||||
|
||||
This directory contains automation scripts for the Dubai Metaverse project.
|
||||
|
||||
## Setup Scripts
|
||||
|
||||
### setup_project.sh
|
||||
Initializes the project structure, Git LFS, and validates prerequisites.
|
||||
|
||||
**Usage**:
|
||||
```bash
|
||||
./scripts/setup_project.sh
|
||||
```
|
||||
|
||||
### setup_ue5_project.sh
|
||||
Validates and helps configure the Unreal Engine 5 project structure.
|
||||
|
||||
**Usage**:
|
||||
```bash
|
||||
./scripts/setup_ue5_project.sh
|
||||
```
|
||||
|
||||
## Validation Scripts
|
||||
|
||||
### validate_assets.sh
|
||||
Validates asset naming conventions and structure.
|
||||
|
||||
**Usage**:
|
||||
```bash
|
||||
./scripts/validate_assets.sh
|
||||
```
|
||||
|
||||
### generate_docs.sh
|
||||
Validates documentation completeness.
|
||||
|
||||
**Usage**:
|
||||
```bash
|
||||
./scripts/generate_docs.sh
|
||||
```
|
||||
|
||||
## Data Import Scripts
|
||||
|
||||
### import_osm_data.py
|
||||
Imports OpenStreetMap data for Dubai Marina.
|
||||
|
||||
**Usage**:
|
||||
```bash
|
||||
python3 scripts/import_osm_data.py --output data/processed/dubai_marina_buildings.geojson
|
||||
```
|
||||
|
||||
**Requirements**:
|
||||
- overpy
|
||||
- geojson
|
||||
|
||||
### gis_to_unreal.py
|
||||
Converts GIS elevation data to Unreal Engine terrain format.
|
||||
|
||||
**Usage**:
|
||||
```bash
|
||||
python3 scripts/gis_to_unreal.py data/elevation/dubai_marina_dem.tif --output data/processed/terrain_heightmap.raw
|
||||
```
|
||||
|
||||
**Requirements**:
|
||||
- rasterio
|
||||
- numpy
|
||||
|
||||
## Phase-Specific Scripts
|
||||
|
||||
### Phase 2 (Weeks 3-5)
|
||||
- `pcg_validation.py` - Validates PCG graph outputs
|
||||
- `texture_validation.py` - Validates texture resolution and format
|
||||
|
||||
### Phase 3 (Week 6)
|
||||
- `lighting_validation.py` - Validates lighting setup and performance
|
||||
|
||||
### Phase 4 (Week 10)
|
||||
- `performance_audit.py` - Audits performance metrics
|
||||
- `render_cinematic.py` - Automates Movie Render Queue rendering
|
||||
|
||||
### Phase 5 (Weeks 11-12)
|
||||
- `automated_tests.py` - Runs automated test suite
|
||||
- `package_build.sh` - Packages final build
|
||||
|
||||
## Optional Scripts
|
||||
|
||||
- `setup_pixel_streaming.sh` - Sets up Pixel Streaming (optional)
|
||||
- `npc_dialogue_api.py` - ChatGPT API integration (optional)
|
||||
|
||||
## Installation
|
||||
|
||||
Install Python dependencies:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
Make scripts executable:
|
||||
```bash
|
||||
chmod +x scripts/*.sh scripts/*.py
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- Some scripts are placeholders for future phases
|
||||
- Python scripts require Python 3.8+
|
||||
- Shell scripts require bash
|
||||
- All scripts should be run from project root directory
|
||||
|
||||
Reference in New Issue
Block a user