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

Restructure the source tree #291

Open
lhearachel opened this issue Nov 4, 2024 · 0 comments
Open

Restructure the source tree #291

lhearachel opened this issue Nov 4, 2024 · 0 comments

Comments

@lhearachel
Copy link
Collaborator

Problem Statement

We currently have a mix of documented and undocumented source files scattered across src|include folders and the various overlays. This is less than ideal for modding, and we should make an effort to organize code conceptually as we do assets. Existing code, then, needs to be reorganized to fit a new structure.

Proposal

We can organize the code into a structure resembling the following:

src/
|-- applications/
|   |-- pokemon_summary_screen/
|   |   |-- main.c
|   |   |-- subscreen.c
|   |   `-- window.c
|   |-- choose_starter.c
|   |-- library_tv.c
|   `-- options_menu.c
|-- battle/
|   |-- animation/
|   |   `-- <future contents>
|   |-- interface/
|   |   |-- healthbox.c
|   |   |-- input.c
|   |   `-- party_status.c
|   |-- ai.c
|   |-- controller.c
|   `-- script.c
|-- contest/
|   `-- <future_contents>
|-- field/
|   |-- script/
|   |   |-- cmd.c
|   |   |-- cmd_system_flags.c
|   |   |-- context.c
|   |-- map_change.c
|   |-- save_info_window.c
|   |-- start_menu.c
|   |-- system.c
|   `-- task.c
|-- graphics/
|   |-- lib.c
|   |-- palette.c
|   |-- render_text.c
|   |-- render_window.c
|   `-- sprite.c
|-- itemlib/
|   |-- bag.c
|   `-- item.c
|-- pokelib/
|   |-- move.c
|   |-- icon.c
|   |-- party.c
|   `-- pokemon.c
|-- save/
|   |-- data.c
|   |-- data_misc.c
|   |-- records.c
|   |-- system_flags.c
|   |-- options.c
|   |-- table.c
|   `-- vars_flags.c
`-- system/
    |-- bg_window.c
    |-- charcode.c
    |-- font.c
    |-- narc.c
    |-- strbuf.c
    `-- text.c
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

1 participant