From 23c744a949de76a55b02b1dfa075995e1de81ec6 Mon Sep 17 00:00:00 2001 From: Mark Joshwel Date: Thu, 6 Jun 2024 15:59:53 +0800 Subject: [PATCH] meta: become common --- Design.gitattributes | 105 +++++++++++++++++++++++ Generic.gitattributes | 89 +++++++++++++++++++ Modelling.gitattributes | 119 ++++++++++++++++++++++++++ README.md | 48 +++++++++-- .gitattributes => Unity.gitattributes | 0 .gitignore => Unity.gitignore | 0 6 files changed, 355 insertions(+), 6 deletions(-) create mode 100644 Design.gitattributes create mode 100644 Generic.gitattributes create mode 100644 Modelling.gitattributes rename .gitattributes => Unity.gitattributes (100%) rename .gitignore => Unity.gitignore (100%) diff --git a/Design.gitattributes b/Design.gitattributes new file mode 100644 index 0000000..a1dd641 --- /dev/null +++ b/Design.gitattributes @@ -0,0 +1,105 @@ +# design .gitattributes for design files (e.g., adobe, figma, ...) + +# fonts +*.otf lfs +*.ttf lfs +*.woff lfs +*.woff2 lfs + +# design files +*.psd lfs +*.ai lfs +*.ae lfs +*.prproj lfs +*.xd lfs +*.fig lfs + +# images +*.jpg lfs +*.JPG lfs +*.jpeg lfs +*.JPEG lfs +*.png lfs +*.PNG lfs +*.gif lfs +*.GIF lfs +*.tif lfs +*.TIF lfs +*.tiff lfs +*.TIFF lfs +*.bmp lfs +*.BMP lfs +*.exr lfs +*.EXR lfs +*.hdr lfs +*.HDR lfs +*.psd lfs +*.PSD lfs +*.tga lfs +*.TGA lfs +*.pdf lfs +*.PDF lfs +*.pict lfs +*.webp lfs + +# media +*.mov lf +*.MOV lfs +*.avi lfs +*.AVI lfs +*.mp4 lfs +*.MP4 lfs +*.m4a lfs +*.M4A lfs +*.m4v lfs +*.M4v lfs +*.mp3 lfs +*.MP3 lfs +*.ogg lfs +*.OGG lfs +*.ogv lfs +*.OGV lfs +*.oga lfs +*.OGA lfs +*.ogx lfs +*.OGX lfs +*.spx lfs +*.SPX lfs +*.aif lfs +*.AIF lfs +*.aiff lfs +*.AIFF lfs +*.wav lfs +*.WAV lfs +*.flac lfs +*.FLAC lfs +*.mod lfs +*.wav lfs +*.xm lfs + +# video +*.asf lfs +*.flv lfs +*.mpeg lfs +*.mpg lfs +*.wmv lfs + +# libraries +*.dll lfs +*.DLL lfs +*.so lfs +*.SO lfs +*.pdb lfs + +# archives +*.7z lfs +*.bz2 lfs +*.gz lfs +*.rar lfs +*.tar lfs +*.zip lfs + +# Executable/Installer +*.apk lfs +*.exe lfs +*.dat lfs diff --git a/Generic.gitattributes b/Generic.gitattributes new file mode 100644 index 0000000..e29c612 --- /dev/null +++ b/Generic.gitattributes @@ -0,0 +1,89 @@ +# images +*.jpg lfs +*.JPG lfs +*.jpeg lfs +*.JPEG lfs +*.png lfs +*.PNG lfs +*.gif lfs +*.GIF lfs +*.tif lfs +*.TIF lfs +*.tiff lfs +*.TIFF lfs +*.bmp lfs +*.BMP lfs +*.exr lfs +*.EXR lfs +*.hdr lfs +*.HDR lfs +*.psd lfs +*.PSD lfs +*.tga lfs +*.TGA lfs +*.pdf lfs +*.PDF lfs +*.pict lfs +*.webp lfs + +# media +*.mov lf +*.MOV lfs +*.avi lfs +*.AVI lfs +*.mp4 lfs +*.MP4 lfs +*.m4a lfs +*.M4A lfs +*.m4v lfs +*.M4v lfs +*.mp3 lfs +*.MP3 lfs +*.ogg lfs +*.OGG lfs +*.ogv lfs +*.OGV lfs +*.oga lfs +*.OGA lfs +*.ogx lfs +*.OGX lfs +*.spx lfs +*.SPX lfs +*.aif lfs +*.AIF lfs +*.aiff lfs +*.AIFF lfs +*.wav lfs +*.WAV lfs +*.flac lfs +*.FLAC lfs +*.mod lfs +*.wav lfs +*.xm lfs + +# video +*.asf lfs +*.flv lfs +*.mpeg lfs +*.mpg lfs +*.wmv lfs + +# libraries +*.dll lfs +*.DLL lfs +*.so lfs +*.SO lfs +*.pdb lfs + +# archives +*.7z lfs +*.bz2 lfs +*.gz lfs +*.rar lfs +*.tar lfs +*.zip lfs + +# Executable/Installer +*.apk lfs +*.exe lfs +*.dat lfs diff --git a/Modelling.gitattributes b/Modelling.gitattributes new file mode 100644 index 0000000..eb9353a --- /dev/null +++ b/Modelling.gitattributes @@ -0,0 +1,119 @@ +# sauel-tracking: https://gist.github.com/mstevenson/34b7a42d28ed909e7efc + +# .gitattributes for modelling files (e.g., maya, substance painter, zbrush) + +# unity + +*.unitypackage filter=lfs diff=lfs merge=lfs -text +*.cubemap filter=lfs diff=lfs merge=lfs -text +*.spm filter=lfs diff=lfs merge=lfs -text + +# models + +*.mb filter=lfs diff=lfs merge=lfs -text +*.MB filter=lfs diff=lfs merge=lfs -text +*.ma filter=lfs diff=lfs merge=lfs -text +*.MA filter=lfs diff=lfs merge=lfs -text +*.mlt filter=lfs diff=lfs merge=lfs -text +*.MLT filter=lfs diff=lfs merge=lfs -text +*.obj filter=lfs diff=lfs merge=lfs -text +*.OBJ filter=lfs diff=lfs merge=lfs -text +*.fbx filter=lfs diff=lfs merge=lfs -text +*.FBX filter=lfs diff=lfs merge=lfs -text +*.ztl filter=lfs diff=lfs merge=lfs -text +*.ZTL filter=lfs diff=lfs merge=lfs -text +*.zpr filter=lfs diff=lfs merge=lfs -text +*.ZPR filter=lfs diff=lfs merge=lfs -text +*.zbr filter=lfs diff=lfs merge=lfs -text +*.ZBR filter=lfs diff=lfs merge=lfs -text +*.max filter=lfs diff=lfs merge=lfs -text +*.MAX filter=lfs diff=lfs merge=lfs -text +*.stl filter=lfs diff=lfs merge=lfs -text +*.STL filter=lfs diff=lfs merge=lfs -text + +# substance painter + +*.spp filter=lfs diff=lfs merge=lfs -text +*.SPP filter=lfs diff=lfs merge=lfs -text + +# images + +*.jpg filter=lfs diff=lfs merge=lfs -text +*.JPG filter=lfs diff=lfs merge=lfs -text +*.jpeg filter=lfs diff=lfs merge=lfs -text +*.JPEG filter=lfs diff=lfs merge=lfs -text +*.png filter=lfs diff=lfs merge=lfs -text +*.PNG filter=lfs diff=lfs merge=lfs -text +*.gif filter=lfs diff=lfs merge=lfs -text +*.GIF filter=lfs diff=lfs merge=lfs -text +*.tif filter=lfs diff=lfs merge=lfs -text +*.TIF filter=lfs diff=lfs merge=lfs -text +*.tiff filter=lfs diff=lfs merge=lfs -text +*.TIFF filter=lfs diff=lfs merge=lfs -text +*.bmp filter=lfs diff=lfs merge=lfs -text +*.BMP filter=lfs diff=lfs merge=lfs -text +*.exr filter=lfs diff=lfs merge=lfs -text +*.EXR filter=lfs diff=lfs merge=lfs -text +*.hdr filter=lfs diff=lfs merge=lfs -text +*.HDR filter=lfs diff=lfs merge=lfs -text +*.psd filter=lfs diff=lfs merge=lfs -text +*.PSD filter=lfs diff=lfs merge=lfs -text +*.tga filter=lfs diff=lfs merge=lfs -text +*.TGA filter=lfs diff=lfs merge=lfs -text +*.pdf filter=lfs diff=lfs merge=lfs -text +*.PDF filter=lfs diff=lfs merge=lfs -text + +# archives + +*.zip filter=lfs diff=lfs merge=lfs -text +*.ZIP filter=lfs diff=lfs merge=lfs -text +*.gz filter=lfs diff=lfs merge=lfs -text +*.GZ filter=lfs diff=lfs merge=lfs -text +*.7z filter=lfs diff=lfs merge=lfs -text +*.7Z filter=lfs diff=lfs merge=lfs -text + +# media + +*.mov filter=lfs diff=lfs merge=lfs -text +*.MOV filter=lfs diff=lfs merge=lfs -text +*.avi filter=lfs diff=lfs merge=lfs -text +*.AVI filter=lfs diff=lfs merge=lfs -text +*.mp4 filter=lfs diff=lfs merge=lfs -text +*.MP4 filter=lfs diff=lfs merge=lfs -text +*.m4a filter=lfs diff=lfs merge=lfs -text +*.M4A filter=lfs diff=lfs merge=lfs -text +*.m4v filter=lfs diff=lfs merge=lfs -text +*.M4v filter=lfs diff=lfs merge=lfs -text +*.mp3 filter=lfs diff=lfs merge=lfs -text +*.MP3 filter=lfs diff=lfs merge=lfs -text +*.ogg filter=lfs diff=lfs merge=lfs -text +*.OGG filter=lfs diff=lfs merge=lfs -text +*.ogv filter=lfs diff=lfs merge=lfs -text +*.OGV filter=lfs diff=lfs merge=lfs -text +*.oga filter=lfs diff=lfs merge=lfs -text +*.OGA filter=lfs diff=lfs merge=lfs -text +*.ogx filter=lfs diff=lfs merge=lfs -text +*.OGX filter=lfs diff=lfs merge=lfs -text +*.spx filter=lfs diff=lfs merge=lfs -text +*.SPX filter=lfs diff=lfs merge=lfs -text +*.aif filter=lfs diff=lfs merge=lfs -text +*.AIF filter=lfs diff=lfs merge=lfs -text +*.aiff filter=lfs diff=lfs merge=lfs -text +*.AIFF filter=lfs diff=lfs merge=lfs -text +*.wav filter=lfs diff=lfs merge=lfs -text +*.WAV filter=lfs diff=lfs merge=lfs -text +*.flac filter=lfs diff=lfs merge=lfs -text +*.FLAC filter=lfs diff=lfs merge=lfs -text + +# libraries + +*.dll filter=lfs diff=lfs merge=lfs -text +*.DLL filter=lfs diff=lfs merge=lfs -text +*.so filter=lfs diff=lfs merge=lfs -text +*.SO filter=lfs diff=lfs merge=lfs -text + +# misc + +*.dat filter=lfs diff=lfs merge=lfs -text +*.DAT filter=lfs diff=lfs merge=lfs -text +*.exe filter=lfs diff=lfs merge=lfs -text diff --git a/README.md b/README.md index 1841bdb..c90d26e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,49 @@ -# git (lfs) files for unity projects +# git lfs files -just make sure that these two are in your unity project (**not** the `Assets/` subfolder!) +## file placement -- [.gitignore](https://forge.joshwel.co/mark/unity/raw/branch/main/.gitignore) (skip this if you already made one with github desktop or by hand) -- [.gitattributes](https://forge.joshwel.co/mark/unity/raw/branch/main/.gitattributes) (for pushing things to git lfs) +- for Game-only projects -and then run the following if you encounter any issues with lfs: + ```text + Game (Unity) Repository Folder + ├── .git/ + ├── .gitignore (from Unity.gitignore) + ├── .gitattributes (from Unity.gitattributes) + └── ... + ``` -``` +- for Modelling-only projects + + ```text + Modelling (Maya / Z Brush / Substance Painter) Repository Folder + ├── .git/ + ├── .gitattributes (from Modelling.gitattributes) + └── ... + ``` + +- for Shared projects + + ```text + Shared Repository (a la Integrated Project) + ├── .git/ + ├── Game + │ ├── .gitignore (from Unity.gitignore) + │ ├── .gitattributes (from Unity.gitattributes) + │ └── ... + ├── Modelling + │ ├── .gitattributes (from Modelling.gitattributes + │ └── ... + └── ... + ``` + +## setting up lfs + +```shell +# init git lfs git lfs install + +# optional, for multi-user/multi-collaborator repositories git config lfs.https://forge.joshwel.co//.git/info/lfs.locksverify true ``` + +also see the forge's [Resources](https://poissonparler.notion.site/La-Forge-du-Poisson-Resources-d6d6b694a92b4211ac7496dec2b8689d) page for more info on setting up LFS projects diff --git a/.gitattributes b/Unity.gitattributes similarity index 100% rename from .gitattributes rename to Unity.gitattributes diff --git a/.gitignore b/Unity.gitignore similarity index 100% rename from .gitignore rename to Unity.gitignore