commit bcdc78110d9902f3a8700ab3dc3a4422890af6e3 Author: amasson Date: Sun Mar 24 09:58:55 2024 +0100 Repository Structure diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..03796ec --- /dev/null +++ b/.gitattributes @@ -0,0 +1,12 @@ +# UE file types +*.uasset filter=lfs diff=lfs merge=lfs -text +*.umap filter=lfs diff=lfs merge=lfs -text +# Raw Content types +*.fbx filter=lfs diff=lfs merge=lfs -text +*.3ds filter=lfs diff=lfs merge=lfs -text +*.psd filter=lfs diff=lfs merge=lfs -text +*.png filter=lfs diff=lfs merge=lfs -text +*.mp3 filter=lfs diff=lfs merge=lfs -text +*.wav filter=lfs diff=lfs merge=lfs -text +*.xcf filter=lfs diff=lfs merge=lfs -text +*.jpg filter=lfs diff=lfs merge=lfs -text diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7b7b5d8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,88 @@ +# MacOS cache file +.DS_Store + +# Visual Studio user specific files +.vs/ +.vscode/ +.vsconfig + +# Compiled Object files +*.slo +*.lo +*.o +*.obj + +# Precompiled Headers +*.gch +*.pch + +# Compiled Dynamic libraries +*.so +*.dylib +*.dll + +# Fortran module files +*.mod + +# Compiled Static libraries +*.lai +*.la +*.a +*.lib + +# Executables +*.exe +*.out +*.app +*.ipa + +# These project files can be generated by the engine +*.xcodeproj +*.xcworkspace +*.sln +*.suo +*.opensdf +*.sdf +*.VC.db +*.VC.opendb + +# Precompiled Assets +SourceArt/**/*.png +SourceArt/**/*.tga + +# Binary Files +Binaries/* +Plugins/*/Binaries/* + +# Builds +Build/* + +# Whitelist PakBlacklist-.txt files +!Build/*/ +Build/*/** +!Build/*/PakBlacklist*.txt + +# Don't ignore icon files in Build +!Build/**/*.ico + +# Built data for maps +*_BuiltData.uasset + +# Configuration files generated by the Editor +Saved/* + +# Compiled source files for the engine to use +Intermediate/* +Plugins/*/Intermediate/* + +# Cache files for the editor to use +DerivedDataCache/* + +# Generated Project files +Makefile +*.code-workspace + +# Obsidian documentation markup configuration files +.obsidian +!.obsidian/plugins/* + diff --git a/Cmd/regenerate.sh b/Cmd/regenerate.sh new file mode 100755 index 0000000..59f8194 --- /dev/null +++ b/Cmd/regenerate.sh @@ -0,0 +1,14 @@ +#!/bin/bash + +cd "$(dirname "$0")/.." + +PROJECT_NAME=$(find . -name "*.uproject" -exec basename {} .uproject \;) + +sh Script/remove_binaries.sh + +rm -rf $PROJECT_NAME.code-workspace\ + Makefile\ + Saved\ + .vscode + +GenerateProjectFiles.sh -project="$PWD/$PROJECT_NAME.uproject" -game diff --git a/Cmd/remove_binaries.sh b/Cmd/remove_binaries.sh new file mode 100755 index 0000000..955d63f --- /dev/null +++ b/Cmd/remove_binaries.sh @@ -0,0 +1,11 @@ +#!/bin/bash + +cd "$(dirname "$0")/.." + +rm -rf Binaries\ + DerivedDataCache\ + Intermediate + +rm -rf Plugins/*/Binaries\ + Plugins/*/DerivedDataCache\ + Plugins/*/Intermediate diff --git a/Cmd/resize_images.sh b/Cmd/resize_images.sh new file mode 100755 index 0000000..aafc8c1 --- /dev/null +++ b/Cmd/resize_images.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +# example: +# sh resize_images.sh ./Game "*.PNG" 50% + +IMAGES=$(find $1 -type f -name $2) + +for image in $IMAGES +do + echo $image + magick $image -resize $3 $image +done + diff --git a/Content/Assets/Character/.gitkeep b/Content/Assets/Character/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/Content/Assets/Environment/.gitkeep b/Content/Assets/Environment/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/Content/Assets/GUI/.gitkeep b/Content/Assets/GUI/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/Content/Assets/Sound/.gitkeep b/Content/Assets/Sound/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/Content/Assets/VFX/.gitkeep b/Content/Assets/VFX/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/Docs/.gitkeep b/Docs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md new file mode 100644 index 0000000..e7ae01e --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ + +# Unreal Engine Base Template + +Basic template project for unreal engine projects. + +```sh +├── Cmd # bash utilities commands +│   ├── regenerate.sh +│   ├── remove_binaries.sh +│   └── resize_images.sh +├── Content +│   └── Assets # assets folders regrouped by categories +│   ├── Character +│   ├── Environment +│   ├── GUI +│   ├── Sound +│   └── VFX +└── Docs # documentation of the project +``` +