Skip to content

Move and Reorganize Project Files#46

Merged
atomic-junky merged 15 commits into
devfrom
wip/restructure
Nov 26, 2024
Merged

Move and Reorganize Project Files#46
atomic-junky merged 15 commits into
devfrom
wip/restructure

Conversation

@atomic-junky

@atomic-junky atomic-junky commented Nov 16, 2024

Copy link
Copy Markdown
Collaborator

The purpose of this pull request is to reorganise the project files to make their location more legible and logical.
I took the opportunity to delete some unused and obsolete files that were still lying around.

Here is a tree showing what the project tree looks like with the modifications (other changes are to be made).

.
├─ .github/
├─ addons/
├─ autoloads/
├─ common/
│  ├─ layouts/
│  ├─ ui/
│  │  ├─ buttons/
│  │  ├─ fields/
│  │  └─ ribbon/
│  └─ windows/
├─ examples/
├─ logic/
│  ├─ history/
├─ nodes/
├─ scenes/
│  ├─ main/
│  ├─ run/
│  └─ splash/
├─ ui/
│  ├─ assets/
│  │  ├─ cursors/
│  │  ├─ fonts/
│  │  └─ icons/
│  └─ theme_default/
└─ unit/

Summary by Sourcery

Reorganize and clean up project files by moving them into a more logical directory structure and removing obsolete files.

Enhancements:

  • Reorganize project files into a more logical structure, improving code readability and maintainability.

Chores:

  • Remove unused and obsolete files from the project to clean up the codebase.

@sourcery-ai

sourcery-ai Bot commented Nov 16, 2024

Copy link
Copy Markdown

Reviewer's Guide by Sourcery

This PR implements a major reorganization of the project's file structure to improve legibility and maintainability. The changes include moving files into more logical locations, standardizing naming conventions to follow Godot's style, and cleaning up unused files. The reorganization particularly focuses on grouping related functionality together and establishing a clearer separation of concerns.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Reorganized the project structure into logical domains
  • Created dedicated folders for different components (globals, graph_nodes, logic, scenes, ui)
  • Moved all UI-related assets into a ui/assets directory
  • Reorganized scene files into main, prefabs, and run categories
  • Standardized file naming to use snake_case
project.godot
scenes/main/app.tscn
scenes/main/graph.tscn
scenes/prefabs/*
ui/assets/*
Restructured graph nodes into independent modules
  • Created separate directories for each graph node type
  • Moved node-specific files into their respective directories
  • Updated file paths in node scripts to reflect new structure
graph_nodes/action_node/*
graph_nodes/bridge_in_node/*
graph_nodes/choice_node/*
graph_nodes/condition_node/*
graph_nodes/sentence_node/*
Reorganized UI components and assets
  • Moved UI fields into dedicated subdirectories
  • Reorganized theme assets into a theme_default directory
  • Updated asset import paths across the project
scenes/prefabs/ui/fields/*
ui/theme_default/*
ui/assets/icons/*
Cleaned up and relocated test and example content
  • Moved test scenes into scenes/run directory
  • Reorganized example files
  • Removed obsolete test files and assets
scenes/run/*
Examples/*
Test/*

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@atomic-junky atomic-junky added this to the 3.x milestone Nov 25, 2024
@atomic-junky atomic-junky marked this pull request as ready for review November 25, 2024 22:10

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The pull request #46 has too many files changed.

We can only review pull requests with up to 300 changed files, and this pull request has 336.

@atomic-junky atomic-junky linked an issue Nov 25, 2024 that may be closed by this pull request

@RailKill RailKill left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I fixed some path changes which were missed. There was also a problem where file renaming such as "Action.svg" to "action.svg" was not picked up by git. Part of this is because Windows filenames are case-insensitive. Before my commits, you can see that the "Examples" folder is still uppercase in GitHub.

This case inconsistency can cause some problems in our scripts, so I fixed it with commands like git mv or git rm so that git is aware of this change, forcing the files to be renamed to lowercase.

@atomic-junky atomic-junky merged commit 463450c into dev Nov 26, 2024
@atomic-junky atomic-junky deleted the wip/restructure branch November 26, 2024 14:58
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.

Rethink the project structure

2 participants