Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a .gitignore for Unreal Engine 4 #1719

Merged
merged 3 commits into from
Oct 29, 2015
Merged

Conversation

samsheff
Copy link
Contributor

I think it would be really helpful to have a gitignore for Unreal Engine 4 projects. This is the one I have been using - But if there's anything I've overlooked or missed I'd be more than happy to add it.

Also, I've seen a few PR's that have similar gitignore's (See first link), but nothing is currently in master. Mine is actively maintained (see second link), but I think it would be beneficial and have more reach if we put one in this master list.

Technology Homepage: https://www.unrealengine.com/
Links with more info:

@shiftkey
Copy link
Member

Ugh, I thought we had this already but it turns out #1688 and #1464 didn't get much love and/or feedback.

Lemme have a look over those other PRs and add feedback, as your seems far more complete.

SourceArt/**/*.tga

# Binary Files
Binaries/*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of these rules have been made case-insenstive:

[Bb]inaries/
[Dd]erivedDataCache/
[Ii]ntermediate/
[Ss]aved/

Do you think that's worth doing here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's worth changing. The only thing is unreal generates them uppercased, and unless they are changed and you have a case sensitive file system (like those used by Linux, but I dont think Unreal runs there) it wouldn't matter.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 I'll defer to you as you're far more familiar with the tooling itself than I am

Build/*

# Don't ignore icon files in Build
!Build/**/*.ico
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another rule that might be valuable here:

!Build/**/*.png

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about that. The icon was excluded because it would cause windows builds to fail (See samsheff/UE4-Gitignore#1), but I don't know if we should exclude PNGs since they would be just copied as part of the build. It seems too broad to me.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if we should exclude PNGs since they would be just copied as part of the build. It seems too broad to me.

cc @chbecher who proposed this in an earlier

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shiftkey I think we should leave that out for now. My understanding of the build folder is that it's all processed code and assets, plus things such as project files generated by the engine. Any PNG's that end up in there would be already in another part of the project.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@shiftkey
Copy link
Member

Okay, I folded the other differences from those earlier PRs into here. Let me know what you think of them.

@samsheff
Copy link
Contributor Author

@shiftkey Great! Left some feedback, let me know what you think.

@shiftkey
Copy link
Member

Only thing I can think of is the file name - should this be UnrealEngine or UnrealEngine4 to make it more clear?

@samsheff
Copy link
Contributor Author

Let's make it UnrealEngine4, that way there's definitely no confusion.

@shiftkey
Copy link
Member

@samsheff I'd rather us handle the different versions of things in the single file - sorry I wasn't clearer on that. Could you change it to UnrealEngine?

The workflow that we've done with other projects like this is that when a new major release occurs:

  • introduce the new rules and annotate them to indicate which version they belong to
  • move deprecated rules out to a new section and indicate they are only specific to a new version

Having multiple files to manage (and update) just means more headaches for everyone. With one file at least we know where everything is, and with good organization in the file we can help users understand the differences between version...

@samsheff
Copy link
Contributor Author

@shiftkey I agree with that completely. I'll update it in a few minutes

@samsheff
Copy link
Contributor Author

@shiftkey Renamed the file! Give it a final look over and let me know if there's any other changes that need to be made. Thanks!

@shiftkey
Copy link
Member

well-done-sir

shiftkey added a commit that referenced this pull request Oct 29, 2015
Add a .gitignore for Unreal Engine 4
@shiftkey shiftkey merged commit d1a5e57 into github:master Oct 29, 2015
@BGR360
Copy link
Contributor

BGR360 commented Oct 31, 2015

I have a few contributions to make to this new Unreal Engine gitignore. Should I fork this repository?

@shiftkey
Copy link
Member

@BGR360 yes please! You should be able to make the changes on the website (it'll take care of forking for you, and then ask if you want to open a pull request).

@BGR360
Copy link
Contributor

BGR360 commented Oct 31, 2015

Awesome! I will get right on that!

@BGR360
Copy link
Contributor

BGR360 commented Oct 31, 2015

@shiftkey Which website are you talking about?

@shiftkey
Copy link
Member

@BGR360 this one!

u9E9F pushed a commit to u9E9F/gitignore that referenced this pull request Jul 8, 2017
Add a .gitignore for Unreal Engine 4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants