The Power of Git in Unreal Engine: a Step-by-Step Guide | UE5
HTML-код
- Опубликовано: 1 авг 2024
- Unreal Engine projects are huge and can get messed up quite easily, so make sure to use Git and back it up to GitHub. Whether you are a solo dev or working with a team, these tools are a must for any software project.
Download git
git-scm.com/download/win
Create a repository on GitHub
github.com/new/
Command for generating SSH key
ssh-keygen -t ed25519 -C "WRITE_YOUR_EMAIL_HERE"
Command for viewing the public key in the terminal
cat /c/Users/Alizoh/.ssh/id_ed25519.pub
Replace the above path with the path to your public key
Download the project files and support my channel on Patreon
/ alizoh
Join my Discord server to chat and mingle with the community
/ discord
Chapters:
00:00 Intro
00:37 Downloading git
01:25 Setup git in the unreal engine editor
03:07 Making our first git commit
05:51 Creating a repository on GitHub
07:28 Connecting to GitHub using HTTPS
09:29 Connecting to GitHub using SSH
12:06 Common Git Workflow
15:57 Use git history to go back to previous version of your project
17:55 Conclusion
18:25 Outro
About me:
I've been learning game development for a few years now, I have a background in software engineering, and I also have a background in education, so being able to combine my love of gaming, software engineering and education is the best way to spend my time.
I am currently working on a few unreal engine games as a hobby, but I am also trying to build a community, thus I am creating RUclips tutorials to find others who are interested in game development and design.
#git #unrealengine5 #tutorial #unrealengine #ue5 #gamedev #github #version #control #versioncontrol #backup 
Игры
Outstanding! Thanks, Ali. Every single thing you've done on this channel thus far has merited immediate support and praise.
Thank you so much for your incredible support and kind words! I truly appreciate your feedback and am thrilled to know that my content has been helpful to you.
I really appreciate your tutorials. I watch a LOT of tutorials, and yours work for me because there is a functional example and a deep dive into WHY things are the way they are. Thank you for making these and I hope you continue with them to your success!
Thank you so much for your kind words! I'm very happy to hear that my tutorials are resonating with you and helping you understand the WHY behind the concepts. Your support is truly appreciated, and I'll definitely continue creating more content.
BRO, this is awesome. I was getting ready to research these items over the weekend. Your timing, at least for me, is great. Thank you!
That's great to hear! I'm glad the timing worked out well for you. Thank you for your comment and I hope you find the content helpful.
@AliElZoheiry You articulate yourself well. It's a pleasure to learn from people who have love in this field. So thank you.
Hi Ali just wanted to say your tutorials have been amazing. Super useful for me developing my first game project. I had been wanting to incorporate a remaining enemy counter for my Retro / Boomer shooter and this works perfectly. Thanks again!!
Thank you for the kind words! I'm glad to hear that the tutorials have been helpful for your game project development. It sounds like a cool idea. Keep up the great work and feel free to reach out if you need any more assistance!
As an experienced software dev in general but noob at unreal engine, you answer a lot of questions i have with how normal dev type things work with unreal, im really surprised that blueprints has a diff feature like that, really awesome.
Glad to hear that you found the content helpful! Unreal Engine does have some unique features to explore, and I'm always here to help with any questions you have along the way 😊
I just found you man but your tutorials are awesome! Please keep doing what you're doing!
Thank you so much for your kind words! I'm really glad you found the tutorials helpful. I'll definitely continue creating more content. Stay tuned for future tutorials!
Spot on - we set this up a while ago and it is priceless...
Glad to hear that it's been helpful for you! If you have any questions or need further assistance, feel free to ask.
I needed this so much. Thank you.
You're very welcome! I'm glad you found it helpful. Thank you for watching and commenting 🙏
Very helpful video, man. Greatly appreciate it.
I appreciate you 🙏 Thanks for watching and commenting
Your videos are great, my suggestion is to teach virtual reality in Unreal engine, you can't find much from VR to Unreal.
Hey there! Thank you for the suggestion! Teaching virtual reality in Unreal Engine sounds like a great idea, and I'll definitely take it into consideration for future videos. Appreciate your support and feedback!
Fantastic Stuff man!
Thank you so much! I'm really happy you enjoyed it 🙏
thank you very much for your very complete tutorial, you're a life saviour!
You're very welcome! I'm glad you found the tutorial helpful 🙏
Excellent explanation. thank you!
Glad you found it helpful! Thanks for watching 🙏
Thank you so much for making this tutorial!!!!!
You're very welcome! I'm so glad you found the tutorial helpful. Thank you for your comment!
Thank you man. Big fan.
Thank you for your support! Glad to have you as a fan 🙌
How nice you are. I really need kind tutorial about using git. Thank you!
Hey there! I'm really glad you found the tutorials helpful. Thank you for the support!
Amazing tutorial!! Thank you
You're very welcome! I'm glad you found it helpful. Thank you for watching and commenting 🙏
@@AliElZoheiry Thank you for your amazing tutorials! Keep up the amazing work!
thanks, was looking for an explanation on versions, since I often break my projects dead(((
You're welcome! I'm glad you found the explanation helpful. Let me know if you have any other questions.
Thank you! really helpful
You're very welcome! I'm glad you found it helpful. Thank you for watching and commenting 🙏
@@AliElZoheiry I'd really appreciate it if you'd create a C++ series sometime.
I started on Game Maker(GML) and then switched to Unity(C#) I ended up with Unreal,but I can't get into blueprints I like "code" but the difficulty between C++ and C# is really hard.
I'll definitely consider it! Thank you for the suggestion @@eFko_
You are blessed with teaching skills. If I go back to a commit that I made previously, and I want to continue from that commit, which means a new branch, does the command git switch -c this is the old commit, do the job? Thanks guru!
Hey, thank you for your kind words! To continue from a previous commit on a new branch, you can use "git switch -c new-branch-name old-commit-number". This will create a new branch from the old commit you specify. But be aware that this will be a different branch other than your master/main branch, so if you want this new branch to be the master one, you'll have to "Force merge" your new branch to master. Hope this helps!
Лучшие туториалы только у него ❤
"Спасибо большое за ваш отзыв! Я очень рад, что вам понравилось!"
@ali thanks man again youre videos are always coming clutch. Ive been really focused on optimization lately as my project grows.
Do you have or plan to create a tutorial on project management?
i find myself feeling like i lose track of my levels or when i say ok i want the player to hit this portal
and go here then im like should this level be part of the same world or a seperate level, sure it depends on many things. but just overall managing the project and keeping things aligned that are supposed to stay and vice versa. sorry for confusing question lol
Hey there, glad to hear that you find my videos helpful in your journey! I definitely understand the challenges of project management, and it's a great suggestion for a future tutorial. I'll add it to my list of ideas for upcoming content. Thanks for the feedback and your support!
@@AliElZoheiry keep it up G! I would be interested in how you would manage your content (work and workflow) like a lessons learned from your Arrow game project. That would be sweet.
Is it a big difference if i commit from the Git huh desktop and im not using the revesion control
Thanks for the clear explanation. I have one doubt. For example, if two people are working on a project and one person has pushed changes, can the second person see the changes made by the first person before taking a pull? For code, yes, we can see the changes, but for blueprints, can we?
Hey there! Thank you for your question. In Unreal Engine, with blueprints, you can see the "diff" between changes you make locally (as I showed in the video) but unfortunately, the editor doesn't yet support diff between your changes and changes you are pulling from the remote repo. So if both you and someone else are working on the same blueprint file, and they push, then you pull. Git will tell you that there is a conflict in the file and you should select one of the versions (yours or theirs) but it won't show you a diff of the files to compare the conflict (because these are binary files that git doesn't understand)
Excellent work on this and all your tutorials. One question I have is I'm very remote and on Starlink.. I get a Terabyte a month, my project is 30GB and growing so I will have to be careful about uploading every day. Does it upload all the files each time, or does it only upload changed/new files after the initial upload?
Hey there! Thank you for your kind words. Using git, after the initial upload, only the changed or new files are uploaded. This should help you manage your data better with limited monthly bandwidth. Good luck with your project!
Hey so I've a project already linked to gitlabs (with lfs, tho i dont think this matters) and want to rename the project, any idea how that can be done?
(i am using gitkraken rather than the console for pushing / pulling)
Hey, you can rename your project in GitLab by going to your project's settings and then selecting "General" from the left-hand navigation. From there, you can update the "Project name" field. It should automatically update your remote URL. As for using GitKraken instead of the console, you should see the updated project name reflected in GitKraken once you've renamed it in GitLab.
Now if you want to rename the Unreal project itself, then you rename the uproject file, and also edit the project name in the DefaultEngine.ini file which is in the config folder. Good luck
Hey very nice tutorial thanks ! Therefore I’m quite curious about lfs. Every other tuto I see says we need lfs for git as a version control. Because unreal project are full of binary files and git is bad to deal with it. But still from your point of view it is possible and not a bad thing to build a full game with git and never have to deal with lfs ? Could you elaborate ? It’s seems way easier to set it up without but I am afraid it could lead to some lack of performance for git later.
Thank you again !
Hey, thank you for your kind words and question! Git can handle Unreal projects without LFS if properly set up, but LFS can be beneficial for managing large binary files and maintaining performance over time. It's worth considering the specific needs and complexities of your project when deciding whether to use LFS, especially as the project grows. You can decide to opt in for LFS at anytime, it doesn't have to be when setting up the project.
In all cases. The free tier of GitHub just isn't enough for game development, but I decided to go with GitHub for the tutorial since it's the most commonly used
I attempted to proceed with the second (SSH) method and received feedback that my project exceeded the maximum 2GB limit, making it impossible to upload. I have nearly completed a wave zombie shooter with a Content folder weighing just under 7GB. Do I need to split the upload into three parts, or is there an alternative approach?
If you are referring to the Github limitations in size, unfortunately this is the size limit for the free tier, but Github is just one option for remote repository storage, there are many others with larger storage options if that's what you need. I heard Azure offers 200GB for free
Thank you, Ali, for this insightful tutorial that highlights the capabilities and impact of GitHub. I appreciate it.
I have a question: Is GitHub a viable alternative to Perforce? maybe Git is excellent for small, agile teams, while Perforce shines in scenarios where IP security, large files, and complex workflows are critical. What you think?
Perforce is indeed better at handling large files and binary file types. I've always used git though for coding projects, so it's just what I'm used to
@@AliElZoheiry Thank you Ali !
Hey Ali, thank you for this tutorial. Quick question please. Is it worth implementing git if my project has 25gb and counting? I obviously have to pay but the "tracking changes" thing is really really good. Thanks
Yes, implementing Git would definitely be worth it for tracking changes and managing a project of that size. It can help streamline collaboration and version control, especially for larger projects like yours. Good luck!
also when I choose git , as sc method, I do not get the size UI as you have, mine has no options below email, specifically one I want, choosing lfs or not, can that be done manually at uie console or git bash ?? Just want to verify I do not have lfs so I can get a bity more space on github.
LFS isn't turned on by default, so you don't have to worry there
Is there a way to fix merge conflicts of blueprint, materials and other binary files? If not (that's what I heard from everyone else) then how should we work on a team and not mess the files for each other
Unfortunately there isn't a way that is built into the engine to do that, but the work around I use is after committing my changes, I pull any new changes from the remote repo, and if there is a conflict in a binary file, I replace my version with one pulled, and check the in editor diff tool to see the changes, then I handle conflicts manually. It's not an easy process but at least you get to see what exactly changed in a binary file
I was hoping UE has UI tool to work with git like Webstorm does. Well, maybe this will be added in a future updates
Well this diffing tool is quite new, prior to this, there was no way to check changes in any blueprint files, so I would say this is their answer to that, I wouldn't expect more from them anytime soon 😅
Nice Tutorial. I'm guessing this process is still applicable even with another provider such as Azure Devops, even with git LFS.
Hey there! Thank you for your comment! I'm glad you found the tutorial useful. Yes, the process should still be applicable with Azure DevOps and git LFS. Good luck with your project!
@@AliElZoheiry Thanks man. All of your tutorials have been great and useful for my project and, I bet, for many others.
What if I was crerating project without git and later decided to use git together with it when my project is already big. Is it possible then to push my project to github? Or do I have to create new project and send its versions to github from beginning and add parts of previous project to new one?
Hey there! Yes, it's definitely possible to start using Git with an existing project and push it to GitHub. You don't have to create a new project from scratch. You can simply initialize a Git repository in your existing project, add all the files, and start committing and pushing to GitHub from there. Good luck! 🙌
can you explain the CI/CD to make git action work as a build machine or something not sure how things go
Hey, thanks for your question! That would be a purely software engineering tutorial, unrelated to game development. Although it's quite up my alley, it's not going to be very beneficial for most of my viewers.
@@AliElZoheiry yes i was being selfish XDD, and i also wanted to take the easy route because i couldn't set it up my self, but at the end you did us great and provided maybe the best learning resources for unreal ever, thanks for that , if you got any tips or directions for a noob like me would be great just saying that in the comment , sorry XD, much love thanks
Thanks for the tutorial, is there a shorterhand way I can search for the project when reopening Gitbash? The project I am using at the moment is deep in a file strucutre multiple files in so having to type the full absolute path once swapped to the drive becomes tedious I was wondering if there was another method, or a method to somehwat save the path in gitbash to easily go to it? Copy and pasting is just as tedious as all the of \ need to be swapped over
Hey there, thanks for watching 🙏 Since git bash is just a regular basis terminal, you can setup "Bash Aliases" and alias is a custom shorthand then when written translates to a longer command. Google how to setup Bash Aliases to quickly CD to a directory
@@AliElZoheiry Thanks for quick response and pointing in right direction :)
thx! with your video I have git working, just locally, Imafraid I'm run out on github and have to pay a lot, what do yu think, project is 110gb.
Hey, glad the video helped you get Git working locally! For larger projects like yours, I'd recommend looking into other repository host options like Bitbucket or GitLab, which offer more generous free tiers for larger project sizes. I even heard from someone that Azure offers 200GB for free, but I haven't checked that. Though any remote repository host will work the same, so feel free to pick and choose
amazing thank you so much i learned something new and i wanted to say thank you so much.
i have a queastion 10:44 what if i write a password will it ask me that password later? i mean should i not secure that with password?
Hey there! Glad you found this helpful ☺️🙏
If you write a password for private keys then indeed you'll be asked for this password every now and then when your computer tries to access it. It's more secure of course to add a password, but just keep in mind that this file is already only on your computer, the password is just to protect your private keys in case someone managed to get access to your computer
Great videos but I'm curious why you chose Git over Perforce?
Hey there, thanks for your comment! While both Git and Perforce have their advantages, I've been using git for 15 years now, so I know it inside and out. I never considered switching to anything else
Another great tutorial, what nest CI Cd? Deployment of new version to Dev Test Stage and Production? Cant wait for it 🫡😂🎉
A buildgraph tutorial would be great!
All great suggestions! Thank you for the feedback, I'm glad you enjoyed this, and thank you for watching ;)
I am half way though my game should i set this up now?
Yeah definitely, you can set it up anytime, the sooner the better
Hi Ali! how would you compare the of Git compared to Perforce workflow?
Hey there! Thanks for your question! I can see the appeal of using Git over Perforce as it offers a more decentralized and flexible workflow, especially for smaller teams and individual projects. However, Perforce provides robust support for larger teams and complex projects, making it a great choice for enterprise-level development. Ultimately, the choice between the two depends on your project's specific needs and team dynamics. Cheers!
@@AliElZoheiry Thank you very much! :)
Damn im so dumb I alway was creating the repos manually, cool!
Glad you found it helpful! It's always a great time-saver to discover these kinds of features.
Worth noting that github without LFS has a 100mb file size limit and 2gb commit size limit.
Hey there! You can still enable LFS and nothing changes in regards to how you use git
Hello, I'm not sure if it's due to my Unreal Engine version (I haven't tested yet on UE5+, currently in 4.23), but when I submit any changes, the status is empty in the bash command line but I still need to push to the branch to have the online repository updated. Is it normal?
And thank you for the video! ❤
I've tried on my own month ago but wasn't managing to make it work, now I understand (Got a funny issue with credentials because I was using another account and had to manually update it from the Control Panel xD)
It's great to hear that you found the video helpful! Regarding the empty status in the bash command line, it could be due to how unreal engine stages commits, I am not sure though. However, as long as the changes are being pushed and updated in the online repository after pushing to the branch, then you're good 😊
@@AliElZoheiry Thank you!
I started source control with Perforce (kinda fell in love with it xD) and when we submit a change it directly "push it" to the repository, but I'm planning to read the documentation of Perforce to understand how it works with unreal 😁
I get such communicat:
This repository is over its data quota. Account responsible for LFS bandwidth should purchase more data packs to restore access.
What does it mean?
If you are getting this from GitHub when trying to push, It probably means you exceeded the maximum storage size on the free version of GitHub, and you have to upgrade to the paid version for more storage capacity
@@AliElZoheiry ok, so there is maximum space which can be used for free on github? During sending my studies projects to github everything was ok but they wer up to 1GB. When I first time tried to send my unreal engine project to github it had size of 16GB and now when it's finished it has 24GB and in both cases I was getting such message
I researched this because it's a problem for me too. Github's free plan allows pushing a repository not larger than 5 GB.
Hi, don't plan to make VR tutorials?
Hey! I haven't really thought about it. I do have an oculus, so I might do some VR in the future, but it's not currently on my roadmap
Hi I'm new to game dev. And i want to make an rpg game but with a very complicated functions powerful bosses that you can tame or add them to your team if you beat them and a lot more stuff and i know this isn't easy at all
So i want you to suggest me a channel or a place yo learn ue 4 or 5 from scratch rn i can't follow along with you when you make all those nodes and blueprints i want someone who explained it in a very detailed way every option any what it does and why
Hey there! I would recommend checking out "Virtus Learning Hub" on RUclips. They provide in-depth tutorials and explanations that could be very helpful for starting out with Unreal Engine and learning the complexities of game development. Best of luck with your RPG game!
How big the project we can use without using LFS?
As far as I know, GitHub has limits on the file sizes themselves, not the repository size (So 50MB per file), and they recommend the repository to be between smaller than 5GB, but I don't think they have strict limits on the size of the repository itself, but once you have files larger than 50MB, then GitHub will force you to use LFS
Thanks for the info, now i wondering that if we just could use Git for local versioning without push to the cloud?
@@hendra_winata13 of course, you can do that without setting up a remote repository, but you lose one of the biggest benefits of version control, which is having a cloud backup in case something happens to your computer
@@AliElZoheiry Yeah i consider that, but since my project assets are big (> 100Gb in total), i am afraid that Git Remote Repo will support it.
Anyway, thank you very much for answering my question 🙏 Waiting for your next video especially optimization things 😁🙏
Mükemmel tutorial. Peki neden gitDesktop kullanmadın
I've never been a fan of the desktop UI for git, it slows me down significantly, I can do so much more with the terminal and much faster. it definitely takes longer to get used to a terminal if you're not a developer, but once you get the hang of it, it's much much more powerful than the desktop UI
@@AliElZoheiry
thank you for response Ali you are the best
Thanks for the tutorial.
LFS is not more performant (actually less performant and extremely slow). LFS is a glorified FTP server that uses http to transfers non text files, since git is exclusive a tool built for version control text files. LFS is literally a hack that was put in place to try to solve one of the biggest problems in version control.
Thank you for your feedback. I didn't know that ;) I understood that LFS will compare references to binary files instead of the actual files themselves, so then it's a lot more performant.
Hi Ali,
I've been burnt by this built-in beta version a few times now. I hadn't committed before I left for the day and the automatic pull upon launch removed my files. I feel like you should probably recommend something else than this. It's been convenient but data loss is never worth it.
Seems like a very easy mistake to make as a newcomer.
Best!
Hey there, that's really frustrating indeed, and quite strange. Because git never deletes anything automatically, and since you always have a backup on GitHub, you can always revert back to the latest working version.
The only way to delete things is by running a command with a `--force` option, basically telling git to force pull or push something and ignore changes.
@@AliElZoheiry By my experience, that's just not true. Uncommitted files are just not related to Git in any way yet, and UE does its autofetch on launch. So if you ever forget to commit something, it's removed upon the next launch. Since it was never committed, Git never knows about it and can't save it.
Accept Settings "Connection Error: Failed to enable Git revision control. You need to initialize the project as a Git repository first."
Not sure what you're doing that led to this error, but it seems you are trying to push without first initializing the git repository locally
@@AliElZoheiry My buddy was helping me out. He had me create a gitignore file. Then I watched this video and apparently it was the file he had me make that was breaking it. Once I deleted the gitignore file, it all worked. Pretty weird.
i watched the video even if i dont plan on using git,lol.
Thank you for watching and commenting ;) consider git though, it can really save you in a lot of cases
@AliElZoheiry I know I should but I just zip them an put read me notes an toss them on an external. Maybe 1 day I may.
I want to ask, if a repository is full with our 3d assets can evil companies scrape it for AI training?. Im scared to upload anything anymore.
Hey there, I understand your concern. It's always important to consider the potential risks of sharing assets online. Though if you make your repository private on GitHub, then it can't be used as training data. If you make it public though, then it's public, so it can be used for that.