From c84d70e8937c5d8a9566e060974ef4bd39b69202 Mon Sep 17 00:00:00 2001 From: Cameron Reikes Date: Thu, 29 Jun 2023 22:32:21 -0700 Subject: [PATCH] Add note to be conservative about committing git lfs files --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f1febff..5186f47 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # rpgpt RPG GPT. Short experience -# Important Building Steps +# Important Building Steps and Contribution Notes +Be very cautious about committing a change to any large asset files, i.e the art.blend and png files. Every time you do so, even if you change one little thing like moving the player somewhere, you copy the entire file in git lfs, ballooning the storage usage of the git project on the remote. So just try to minimize edits to those big files. + You must clone with git lfs is, and download git lfs files in this repository. If you don't know what that is, google it Open `art.blend`, go to the scripting tab and hit the play button run the script and export all the 3d assets. Then, make sure that when you build, you also build and run the codegen so that said assets and other files are copied and imported. For debug builds on windows, that's `call build_desktop_debug.bat codegen`, the codegen argument to the build script causing it to run codegen