Add README.md
This commit is contained in:
40
README.md
Normal file
40
README.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Projet Final Unreal — Thesis Project
|
||||
**College LaSalle | Game Development Thesis**
|
||||
|
||||
## About
|
||||
A proof of concept action game developed in Unreal Engine 5 as a thesis project. The game was designed as a hybrid between a **souls-like boss encounter** and a **third-person shooter**, though the project remained in a prototype state due to time constraints.
|
||||
|
||||
## Built With
|
||||
- Unreal Engine 5.1.1
|
||||
- Git + Git LFS
|
||||
|
||||
## Contributors
|
||||
| Name | Role |
|
||||
|------|------|
|
||||
| Steven | AI System, Bosses & Enemies |
|
||||
| Partner | Player Character & Shooter Mechanics |
|
||||
|
||||
## Branches
|
||||
| Branch | Description |
|
||||
|--------|-------------|
|
||||
| `main` | Stable baseline, project initialization |
|
||||
| `develop` | Main development branch |
|
||||
| `feature/AI-Base-Setup` | AI system, boss fights, enemy behaviors |
|
||||
| `feature/Makeeverithingfotheplayer` | Player character, shooter mechanics |
|
||||
|
||||
## Project State
|
||||
This project is a **work in progress / prototype**. The following reflects what was completed at the time of submission:
|
||||
|
||||
- ✅ AI system architecture (behavior trees, perception, stat structs/enums)
|
||||
- ✅ One fully implemented boss (main boss)
|
||||
- ✅ Enemy AI framework
|
||||
- ✅ Somewhat playable map
|
||||
- ❌ Combat animations (not implemented due to time constraints)
|
||||
- ❌ Animal AI (developed but not used in the final build)
|
||||
- ⚠️ Shooter mechanics (partially implemented)
|
||||
|
||||
## Setup
|
||||
1. Clone the repository
|
||||
2. Ensure Git LFS is installed: `git lfs install`
|
||||
3. Pull LFS objects: `git lfs pull`
|
||||
4. Open `ProjetFinalUnreal.uproject` in Unreal Engine 5.1.1
|
||||
Reference in New Issue
Block a user