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

# Building your own project copy
Building a copy of the game requires only [Lost_Edge/UnrealProject/LostEdge/](Lost_Edge/src/branch/master/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`
Update README 2024-11-11 14:23:59 +00:00			`# Repo structure`
README 2024-12-13 17:47:12 +00:00			`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. \`
Update README 2024-11-11 14:23:59 +00:00
README 2024-12-13 17:47:12 +00:00			`Lost_Edge/`
			`├─ [Audio/](Lost_Edge/src/branch/master/Audio) ---> Audio data (e.g. music, sounds, dialogues)`
			`├─ [Documentation/](Lost_Edge/src/branch/master/Documentation) ---> Documentation (e.g. game and level design)`
			`├─ [Fonts/](Lost_Edge/src/branch/master/Fonts) ---> Fonts used in project`
			`├─ [Images/](Lost_Edge/src/branch/master/Images) ---> Image data (e.g. textures, postures, logo)`
			`├─ [Models/](Lost_Edge/src/branch/master/Models) ---> Models data (e.g. characters, decorations, foliages)`
			`├─ [ReleaseBuilds/](Lost_Edge/src/branch/master/ReleaseBuilds)`
			`│ ├─ Legacy/ ---> Legacy build created as high school project`
			`│ └─ vX.X/ ---> Current builds of Lost_Edge (university project)`
			`├─ UnrealProject/`
			`│ ├─ [Lost_Edge/](Lost_Edge/src/branch/master/UnrealProject/Lost_Edge) ---> Current unreal project of Lost_Edge`
			`│ └─ Lost_Edge_Legacy/ ---> Legacy unreal project created as high school project`
			`└─[VoiceGenerator/](Lost_Edge/src/branch/master/UnrealProject/VoiceGenerator) ---> AI voice generation module`
Update README.md 2024-09-27 13:22:04 +00:00
README 2024-12-13 17:47:12 +00:00			`# Building your own project copy`
			`Building a copy of the game requires only [Lost_Edge/UnrealProject/LostEdge/](Lost_Edge/src/branch/master/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`
Update README 2024-11-11 14:23:59 +00:00
			`# Git lfs common issues`
README 2024-12-13 17:47:12 +00:00			`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" \`
Update README 2024-11-11 14:23:59 +00:00			- To fix this set local/global repo config `git config lfs.activitytimeout 240`