241 lines
5.1 KiB
Markdown
241 lines
5.1 KiB
Markdown
|
# Quest System - Dubai Metaverse
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
This document describes the simple quest/navigation system for the Dubai Metaverse project.
|
||
|
|
|
||
|
|
## System Architecture
|
||
|
|
|
||
|
|
### BP_QuestSystem
|
||
|
|
|
||
|
|
**Main quest system controller**
|
||
|
|
|
||
|
|
### Components
|
||
|
|
|
||
|
|
1. **Quest Database**: Quest data storage
|
||
|
|
2. **Quest Manager**: Manages active quests
|
||
|
|
3. **Quest UI**: Quest UI system
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Quest Types
|
||
|
|
|
||
|
|
### Navigation Quests
|
||
|
|
|
||
|
|
**Guide player to locations**
|
||
|
|
|
||
|
|
#### Properties
|
||
|
|
|
||
|
|
- **Destination**: Target location
|
||
|
|
- **Description**: Quest description
|
||
|
|
- **Reward**: Optional reward
|
||
|
|
- **Status**: Active, Complete, Failed
|
||
|
|
|
||
|
|
#### Implementation
|
||
|
|
|
||
|
|
1. **Quest Creation**: Create navigation quest
|
||
|
|
2. **Destination Marker**: Show destination on map
|
||
|
|
3. **Navigation Guide**: Guide player to destination
|
||
|
|
4. **Completion**: Mark complete when reached
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### Exploration Quests
|
||
|
|
|
||
|
|
**Encourage exploration**
|
||
|
|
|
||
|
|
#### Properties
|
||
|
|
|
||
|
|
- **Locations**: Multiple locations to visit
|
||
|
|
- **Description**: Exploration description
|
||
|
|
- **Progress**: Track visited locations
|
||
|
|
- **Completion**: Complete when all visited
|
||
|
|
|
||
|
|
#### Implementation
|
||
|
|
|
||
|
|
1. **Quest Creation**: Create exploration quest
|
||
|
|
2. **Location Markers**: Mark locations on map
|
||
|
|
3. **Progress Tracking**: Track visited locations
|
||
|
|
4. **Completion**: Mark complete when all visited
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
### Interaction Quests
|
||
|
|
|
||
|
|
**Require interactions**
|
||
|
|
|
||
|
|
#### Properties
|
||
|
|
|
||
|
|
- **Interactions**: Required interactions
|
||
|
|
- **Description**: Interaction description
|
||
|
|
- **Progress**: Track completed interactions
|
||
|
|
- **Completion**: Complete when all interactions done
|
||
|
|
|
||
|
|
#### Implementation
|
||
|
|
|
||
|
|
1. **Quest Creation**: Create interaction quest
|
||
|
|
2. **Interaction Markers**: Mark interactions
|
||
|
|
3. **Progress Tracking**: Track completed interactions
|
||
|
|
4. **Completion**: Mark complete when all done
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Quest Data
|
||
|
|
|
||
|
|
### DA_Quest Data Assets
|
||
|
|
|
||
|
|
**Quest data storage**
|
||
|
|
|
||
|
|
### Properties
|
||
|
|
|
||
|
|
- **Quest ID**: Unique quest identifier
|
||
|
|
- **Quest Name**: Quest name
|
||
|
|
- **Description**: Quest description
|
||
|
|
- **Type**: Quest type (Navigation, Exploration, Interaction)
|
||
|
|
- **Objectives**: Quest objectives
|
||
|
|
- **Rewards**: Quest rewards (optional)
|
||
|
|
- **Status**: Quest status
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Quest UI
|
||
|
|
|
||
|
|
### WBP_QuestLog
|
||
|
|
|
||
|
|
**Quest log UI widget**
|
||
|
|
|
||
|
|
### Elements
|
||
|
|
|
||
|
|
1. **Active Quests**: List of active quests
|
||
|
|
2. **Quest Details**: Selected quest details
|
||
|
|
3. **Objectives**: Quest objectives list
|
||
|
|
4. **Progress**: Progress indicators
|
||
|
|
|
||
|
|
### Display
|
||
|
|
|
||
|
|
- **Position**: Screen position (side panel)
|
||
|
|
- **Toggle**: Toggle quest log (M key)
|
||
|
|
- **Updates**: Update in real-time
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Navigation System
|
||
|
|
|
||
|
|
### BP_NavigationPrompt
|
||
|
|
|
||
|
|
**Navigation guidance system**
|
||
|
|
|
||
|
|
### Components
|
||
|
|
|
||
|
|
1. **Destination Marker**: Visual marker for destination
|
||
|
|
2. **Path Indicator**: Path to destination (optional)
|
||
|
|
3. **Distance Display**: Distance to destination
|
||
|
|
4. **Direction Arrow**: Direction indicator
|
||
|
|
|
||
|
|
### Implementation
|
||
|
|
|
||
|
|
1. **Set Destination**: Set quest destination
|
||
|
|
2. **Show Marker**: Display destination marker
|
||
|
|
3. **Update Path**: Update path to destination
|
||
|
|
4. **Guide Player**: Guide player to destination
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Quest Flow
|
||
|
|
|
||
|
|
### Quest Start
|
||
|
|
|
||
|
|
1. **Quest Trigger**: Quest is triggered (interaction, location, etc.)
|
||
|
|
2. **Quest Activation**: Quest is activated
|
||
|
|
3. **UI Update**: Quest UI updates
|
||
|
|
4. **Navigation**: Navigation system activates
|
||
|
|
|
||
|
|
### Quest Progress
|
||
|
|
|
||
|
|
1. **Objective Updates**: Objectives update as player progresses
|
||
|
|
2. **UI Updates**: Quest UI updates with progress
|
||
|
|
3. **Feedback**: Provide feedback on progress
|
||
|
|
|
||
|
|
### Quest Completion
|
||
|
|
|
||
|
|
1. **Completion Check**: Check if quest is complete
|
||
|
|
2. **Reward**: Give reward (if applicable)
|
||
|
|
3. **Quest Complete**: Mark quest as complete
|
||
|
|
4. **UI Update**: Update quest UI
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Integration
|
||
|
|
|
||
|
|
### With Interaction System
|
||
|
|
|
||
|
|
- **Quest Triggers**: Interactions trigger quests
|
||
|
|
- **Quest Objectives**: Interactions complete objectives
|
||
|
|
- **Quest Dialogue**: Interactions provide quest info
|
||
|
|
|
||
|
|
### With Navigation System
|
||
|
|
|
||
|
|
- **Quest Destinations**: Quests set navigation destinations
|
||
|
|
- **Quest Markers**: Quests show navigation markers
|
||
|
|
- **Quest Guidance**: Quests provide navigation guidance
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Performance Optimization
|
||
|
|
|
||
|
|
### Quest Optimization
|
||
|
|
|
||
|
|
1. **Update Frequency**: Optimize quest update frequency
|
||
|
|
2. **UI Updates**: Optimize UI updates
|
||
|
|
3. **Navigation**: Optimize navigation calculations
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Testing
|
||
|
|
|
||
|
|
### Quest Testing
|
||
|
|
|
||
|
|
1. **Quest Creation**: Test quest creation
|
||
|
|
2. **Quest Progress**: Test quest progress tracking
|
||
|
|
3. **Quest Completion**: Test quest completion
|
||
|
|
4. **UI**: Test quest UI
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Troubleshooting
|
||
|
|
|
||
|
|
### Common Issues
|
||
|
|
|
||
|
|
**Issue**: Quests not starting
|
||
|
|
- **Solution**: Check quest triggers
|
||
|
|
- **Solution**: Verify quest system setup
|
||
|
|
|
||
|
|
**Issue**: Navigation not working
|
||
|
|
- **Solution**: Check navigation system
|
||
|
|
- **Solution**: Verify destination markers
|
||
|
|
|
||
|
|
**Issue**: Quest UI not updating
|
||
|
|
- **Solution**: Check UI widget setup
|
||
|
|
- **Solution**: Verify quest updates
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
### Quest Documentation
|
||
|
|
|
||
|
|
Document each quest:
|
||
|
|
- **Quest Name**: Quest name
|
||
|
|
- **Type**: Quest type
|
||
|
|
- **Objectives**: Quest objectives
|
||
|
|
- **Rewards**: Quest rewards
|
||
|
|
- **Triggers**: How quest is triggered
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Version**: 1.0
|
||
|
|
**Last Updated**: [Current Date]
|
||
|
|
|
||
|
|
**Note**: Quest system is simple and optional. Focus is on exploration and interaction rather than complex quests.
|
||
|
|
|