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

Would Love More Directory Structure Examples #103

Open
GuyPaddock opened this issue Feb 22, 2024 · 2 comments
Open

Would Love More Directory Structure Examples #103

GuyPaddock opened this issue Feb 22, 2024 · 2 comments

Comments

@GuyPaddock
Copy link

The current directory structure guidelines are on the right track, but painfully vague. I'd love a lot more examples in that section. For example, we aren't sure where best to put UI-related stuff in the folder structure prescribed. We're thinking likely Core/UI.

As another example, where should input actions go? We don't want to put them in a folder called Core/InputActions/ because section 2.6 indicates that you should not create folders specific to the type of an asset. I considered Core/Input/ so that all input-related content can go there (e.g., binding contexts, etc.) but I'd also expect that the input actions and binding contexts that go with a particular UI context would go with that context. So, perhaps, Core/UI/<Name of Screen> would be better?

@detilium
Copy link

I disagree with the proposal of placing user interface elements within the Core folder. As stated in section 2.5, this section should only be relevant to engineers, and non-engineers shouldn't have a reason to enter the folder:

"This creates a very clear "don't touch these" message for other team members. Non-engineers should have very little reason to enter the Core folder."

Considering the existing example project content structure, I propose a new subfolder within the GenericShooter project folder, simply called UserInterface. This would contain all assets types as defined in section 1.2.11. In my opinion, UI related functionality does not contain in any of the existing folders.

Example

|-- Content
    |-- GenericShooter
        |-- UserInterface

I have not thought about potential subfolders.

@detilium
Copy link

On second though, maybe the following structure would make sense:

|-- Content
    |-- GenericShooter
        |-- UserInterface
            |-- Fonts
            |-- HUD
            |-- Menus

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

No branches or pull requests

2 participants