134 lines
5.4 KiB
Markdown
134 lines
5.4 KiB
Markdown
# YAZE Infrastructure Overview
|
|
|
|
For developers to reference.
|
|
|
|
## Directory Structure
|
|
|
|
- **.github/workflows**: Contains `yaze_test` workflow config.
|
|
- **assets**: Hosts assets like fonts.
|
|
- **cmake**: Contains CMake configurations.
|
|
- **docs**: Contains documentation for users and developers.
|
|
- [Getting Started](./getting-started.md)
|
|
- [LC_LZ2 Compression](./compression.md)
|
|
- **src**: Contains source files.
|
|
- **app**: Contains the GUI editor `yaze`
|
|
- **cli**: Contains the command line interface `z3ed`
|
|
- **lib**: Contains git submodule dependencies.
|
|
- Abseil-cpp
|
|
- Asar
|
|
- ImGui
|
|
- ImGuiFileDialog
|
|
- ImGuiColorTextEdit
|
|
- imgui_memory_editor
|
|
- SDL2
|
|
- **test**: Contains testing interface `yaze_test`
|
|
|
|
## App Organization
|
|
|
|
- **Core Namespace**:
|
|
- Contains fundamental functionalities.
|
|
- [Common](../src/app/core/common.h)
|
|
- [Constants](../src/app/core/constants.h)
|
|
- [Controller](../src/app/core/controller.h)
|
|
- [Editor](../src/app/core/editor.h)
|
|
- [Emulator](../src/app/core/emulator.h)
|
|
- [Pipeline](../src/app/core/pipeline.h)
|
|
- **Editor Namespace**:
|
|
- Editors are responsible for representing the GUI view and handling user input.
|
|
- These classes are all controlled by [MasterEditor](../src/app/editor/master_editor.h)
|
|
- [AssemblyEditor](../src/app/editor/assembly_editor.h)
|
|
- [DungeonEditor](../src/app/editor/dungeon_editor.h)
|
|
- [GraphicsEditor](../src/app/editor/graphics_editor.h)
|
|
- [MusicEditor](../src/app/editor/music_editor.h)
|
|
- [OverworldEditor](../src/app/editor/overworld_editor.h)
|
|
- [ScreenEditor](../src/app/editor/screen_editor.h)
|
|
- [SpriteEditor](../src/app/editor/sprite_editor.h)
|
|
- **Emu Namespace**:
|
|
- Contains business logic for `core::emulator`
|
|
- [Audio](../src/app/emu/audio/)
|
|
- [Debug](../src/app/emu/debug/)
|
|
- [Memory](../src/app/emu/memory/)
|
|
- [Video](../src/app/emu/video/)
|
|
- **Gfx Namespace**:
|
|
- Handles graphics related tasks.
|
|
- [Bitmap](../src/app/gfx/bitmap.h)
|
|
- [Compression](../src/app/gfx/compression.h)
|
|
- [SCAD Format](../src/app/gfx/scad_format.h)
|
|
- [SNES Palette](../src/app/gfx/snes_palette.h)
|
|
- [SNES Tile](../src/app/gfx/snes_tile.h)
|
|
- **Gui Namespace**:
|
|
- Manages GUI elements.
|
|
- [Canvas](../src/app/gui/canvas.h)
|
|
- [Color](../src/app/gui/color.h)
|
|
- [Icons](../src/app/gui/icons.h)
|
|
- [Input](../src/app/gui/input.h)
|
|
- [Style](../src/app/gui/style.h)
|
|
- [Widgets](../src/app/gui/widgets.h)
|
|
- **Zelda3 Namespace**:
|
|
- Holds business logic specific to Zelda3.
|
|
- [Dungeon](../src/app/zelda3/dungeon/)
|
|
- [Music](../src/app/zelda3/music/)
|
|
- [Screen](../src/app/zelda3/screen/)
|
|
- [Sprite](../src/app/zelda3/sprite/)
|
|
- [OverworldMap](../src/app/zelda3/overworld_map.h)
|
|
- [Overworld](../src/app/zelda3/overworld.h)
|
|
|
|
### Flow of Control
|
|
|
|
- [app/yaze.cc](../src/app/yaze.cc)
|
|
- Initializes `absl::FailureSignalHandler` for stack tracing.
|
|
- Runs the `core::Controller` loop.
|
|
- [app/core/controller.cc](../src/app/core/controller.cc)
|
|
- Initializes SDLRenderer and SDLWindow
|
|
- Initializes ImGui, fonts, themes, and clipboard.
|
|
- Handles user input from keyboard and mouse.
|
|
- Updates `editor::MasterEditor`.
|
|
- Renders the output to the screen.
|
|
- Handles the teardown of SDL and ImGui resources.
|
|
- [app/editor/master_editor.cc](../src/app/editor/master_editor.cc)
|
|
- Handles the main menu bar.
|
|
- File
|
|
- Edit
|
|
- View
|
|
- Help
|
|
- Handles `absl::Status` errors as popups delivered to the user.
|
|
- Update all the editors in a tab view.
|
|
- [app/editor/assembly_editor.cc](../src/app/editor/assembly_editor.cc)
|
|
- [app/editor/dungeon_editor.cc](../src/app/editor/dungeon_editor.cc)
|
|
- [app/editor/graphics_editor.cc](../src/app/editor/graphics_editor.cc)
|
|
- [app/editor/music_editor.cc](../src/app/editor/music_editor.cc)
|
|
- [app/editor/overworld_editor.cc](../src/app/editor/overworld_editor.cc)
|
|
- [app/editor/screen_editor.cc](../src/app/editor/screen_editor.cc)
|
|
- [app/editor/sprite_editor.cc](../src/app/editor/sprite_editor.cc)
|
|
|
|
## Bitmap
|
|
|
|
Located in [app/gfx/bitmap.cc](../src/app/gfx/bitmap.cc)
|
|
|
|
- **Initialization**: Offers multiple constructors to create bitmaps using different data types.
|
|
- **Palette Application**: Provides grayscale palettes and can convert `SNESPalette` to `SDL_Palette`.
|
|
- **Texture Handling**: Can create and update textures based on SDL surfaces.
|
|
- **SDL Surface Management**: Allows for the creation, modification, and saving of SDL surfaces.
|
|
- **Memory Management**: Uses smart pointers for efficient memory utilization and cleanup.
|
|
|
|
## Z3ED cli
|
|
|
|
| Command | Arg | Params | Status |
|
|
|---------|-----|--------|--------|
|
|
| Apply BPS Patch | -a | rom_file bps_file | In progress |
|
|
| Create BPS Patch | -c | bps_file src_file modified_file | Not started |
|
|
| Open ROM | -o | rom_file | Complete |
|
|
| Backup ROM | -b | rom_file [new_file] | In progress |
|
|
| Expand ROM | -x | rom_file file_size | Not started |
|
|
| Transfer Tile16 | -t | src_rom dest_rom tile32_id_list(csv) | Complete |
|
|
| Export Graphics | -e | rom_file bin_file | In progress |
|
|
| Import Graphics | -i | bin_file rom_file | Not started |
|
|
| SNES to PC Address | -s | address | Complete |
|
|
| PC to SNES Address | -p | address | Complete |
|
|
|
|
|
|
## Further Development Ideas
|
|
- Extend `zelda3` namespace with additional functionalities.
|
|
- Optimize program performance.
|
|
- Introduce new features in the GUI editor.
|