Update infrastructure doc and add compression doc
This commit is contained in:
scawful
@@ -2,33 +2,110 @@
|
||||
|
||||
For developers to reference.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
- **.github/workflows**: Contains workflow configuration for running yaze_test.
|
||||
- **assets**: Hosts assets like fonts.
|
||||
- **cmake**: Contains CMake configurations.
|
||||
- **docs**: Stores documentation.
|
||||
- **src**: Source files.
|
||||
- **test**: Contains test files and configurations.
|
||||
|
||||
## Main Components
|
||||
|
||||
- `app` Namespace: Represents the GUI editor YAZE.
|
||||
- `cli` Namespace: Represents the command line interface Z3ED.
|
||||
|
||||
## YAZE app
|
||||
## 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.
|
||||
- **lib**: Contains git submodule dependencies.
|
||||
- **test**: Contains test files and configurations.
|
||||
|
||||
## App Organization
|
||||
|
||||
- **Core Namespace**:
|
||||
- Contains fundamental functionalities.
|
||||
- [Common](../src/core/common.h)
|
||||
- [Constants](../src/core/constants.h)
|
||||
- [Controller](../src/core/controller.h)
|
||||
- [Editor](../src/core/editor.h)
|
||||
- [Emulator](../src/core/emulator.h)
|
||||
- [Pipeline](../src/core/pipeline.h)
|
||||
- **Editor Namespace**:
|
||||
- Represents the GUI view.
|
||||
- Contains a class holding objects such as `zelda3::Overworld` and `gfx::Bitmap` for rendering and user input handling.
|
||||
- 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/emu/audio/)
|
||||
- [Debug](../src/emu/debug/)
|
||||
- [Memory](../src/emu/memory/)
|
||||
- [Video](../src/emu/video/)
|
||||
- **Gfx Namespace**:
|
||||
- Handles graphics-related tasks.
|
||||
- Handles graphics related tasks.
|
||||
- [Bitmap](../src/gfx/bitmap.h)
|
||||
- [Compression](../src/gfx/compression.h)
|
||||
- [SCAD Format](../src/gfx/scad_format.h)
|
||||
- [SNES Palette](../src/gfx/snes_palette.h)
|
||||
- [SNES Tile](../src/gfx/snes_tile.h)
|
||||
- **Gui Namespace**:
|
||||
- Manages GUI elements.
|
||||
- [Canvas](../src/gui/canvas.h)
|
||||
- [Color](../src/gui/color.h)
|
||||
- [Icons](../src/gui/icons.h)
|
||||
- [Input](../src/gui/input.h)
|
||||
- [Style](../src/gui/style.h)
|
||||
- [Widgets](../src/gui/widgets.h)
|
||||
- **Zelda3 Namespace**:
|
||||
- Holds business logic specific to Zelda3.
|
||||
- [Dungeon](../src/zelda3/dungeon/)
|
||||
- [Music](../src/zelda3/music/)
|
||||
- [Screen](../src/zelda3/screen/)
|
||||
- [Sprite](../src/zelda3/sprite/)
|
||||
- [OverworldMap](../src/zelda3/overworld_map.h)
|
||||
- [Overworld](../src/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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user