106 lines
2.8 KiB
Markdown
106 lines
2.8 KiB
Markdown
# Simulator Game Project
|
|
|
|
## Overview
|
|
A spaceship simulator game developed in Unreal Engine 5, focusing on realistic physics and comprehensive ship systems management. Players control a fully simulated spacecraft with integrated power, navigation, and damage systems.
|
|
|
|
## Features
|
|
- Realistic zero-gravity space flight physics
|
|
- Comprehensive power management system
|
|
- Dynamic damage and shield mechanics
|
|
- Advanced navigation and autopilot capabilities
|
|
- Detailed ship systems simulation
|
|
- Interactive cockpit and HUD
|
|
|
|
## Prerequisites
|
|
- Unreal Engine 5.2 or higher
|
|
- Visual Studio 2022
|
|
- Git & Git LFS
|
|
- Windows 10/11 (64-bit)
|
|
|
|
## Getting Started
|
|
|
|
### Installation
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone https://git.cinis.cf/Ludusphere/Yamato.git
|
|
```
|
|
|
|
2. Initialize and update Git LFS:
|
|
```bash
|
|
git lfs install
|
|
git lfs pull
|
|
```
|
|
|
|
3. Right-click on the .uproject file and select "Generate Visual Studio project files"
|
|
4. Open the generated .sln file with Visual Studio 2022
|
|
5. Build the solution in Visual Studio
|
|
6. Launch the project through the Unreal Editor
|
|
|
|
### Project Structure
|
|
```
|
|
├── Config/ # Engine configuration
|
|
├── Content/
|
|
│ ├── Core/ # Base game systems
|
|
│ ├── Ships/ # Ship-related assets
|
|
│ ├── Environment/ # Space environment
|
|
│ ├── UI/ # HUD and menus
|
|
│ └── VFX/ # Visual effects
|
|
├── Source/ # C++ source code
|
|
└── Documentation/ # Additional documentation
|
|
```
|
|
|
|
## Development Workflow
|
|
|
|
### Branching Strategy
|
|
- `main`: Production-ready code
|
|
- `development`: Primary development branch
|
|
- `feature/*`: Individual feature branches
|
|
- `bugfix/*`: Bug fix branches
|
|
|
|
### Creating a New Feature
|
|
1. Create a new branch from development:
|
|
```bash
|
|
git checkout development
|
|
git pull
|
|
git checkout -b feature/your-feature-name
|
|
```
|
|
|
|
2. Implement your feature
|
|
3. Create a pull request to the development branch
|
|
|
|
### Code Style
|
|
- Follow Unreal Engine coding standards
|
|
- Use Unreal's naming conventions
|
|
- Include documentation for public functions
|
|
- Add comments for complex logic
|
|
|
|
## Building and Testing
|
|
|
|
### Development Build
|
|
1. Open the project in Unreal Editor
|
|
2. Select File > Package Project > Development
|
|
3. Choose your target platform
|
|
4. Select output directory
|
|
|
|
### Testing
|
|
- Run PIE (Play In Editor) for quick testing
|
|
- Use Standalone Game mode for performance testing
|
|
- Check CPU and GPU performance stats (Press ~ for console)
|
|
|
|
## Contributing
|
|
1. Fork the repository
|
|
2. Create a feature branch
|
|
3. Commit your changes
|
|
4. Push to your fork
|
|
5. Create a Pull Request
|
|
|
|
## Project Team
|
|
- Aiden Correya: Core Systems Developer
|
|
- Shashank Kumar: Content and Design Developer
|
|
|
|
## License
|
|
- To be decided
|
|
|
|
## Acknowledgments
|
|
- Unreal Engine
|