Lost_Edge/README.md

# Repo structure
This repository contains all sources and data for project Lost_Edge excluding server and network deploy configs. \
Most of subdirectories represents individual modules and contains their own README.

Lost_Edge/ \
├─ [Audio/](Audio) ---> Audio data (e.g. music, sounds, dialogues) \
├─ [Documentation/](Documentation) ---> Documentation (e.g. game and level design) \
├─ [Fonts/](Fonts) ---> Fonts used in project \
├─ [Images/](Images) ---> Image data (e.g. textures, postures, logo) \
├─ [Models/](Models) ---> Models data (e.g. characters, decorations, foliages) \
├─ [ReleaseBuilds/](ReleaseBuilds) \
│  ├─ Legacy/ ---> Legacy build created as high school project \
│  └─ vX.X/ ---> Current builds of Lost_Edge (university project) \
├─ UnrealProject/ \
│  ├─ [Lost_Edge/](UnrealProject/Lost_Edge) ---> Current unreal project of Lost_Edge \
│  └─ Lost_Edge_Legacy/ ---> Legacy unreal project created as high school project \
└─[VoiceGenerator/](VoiceGenerator) ---> AI voice generation module

# Building your own project copy
Building a copy of the game requires only [UnrealProject/LostEdge/](UnrealProject/Lost_Edge) directory. \
For that purposes you can download the directory as archive or do a sparse checkout via commands below.
- git clone --no-checkout https://pixelyfier.com/git/Pixelyfier/Lost_Edge.git
- cd Lost_Edge/
- git sparse-checkout init
- git sparse-checkout set UnrealProject/Lost_Edge
- git checkout master

# Git lfs common issues
The download can be sometimes too long which makes git lfs drop the connection with error \
`"LFS: Put "https://pixelyfier.com/git/Pixelyfier/Lost_Edge.git/info/lfs/objects/HASH": read tcp IP:PORT->pixelyfier.com:443: i/o timeout"`
 - To fix this set local/global repo config `git config lfs.activitytimeout 240`