scawful/yaze
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update infra doc, add overworld section

Browse Source
This commit is contained in:
scawful
2023-10-20 11:36:50 -04:00
parent 71ceb03823
commit ca841bb08b
1 changed files with 45 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
docs/infrastructure.md
View File

@@ -82,28 +82,56 @@ For developers to reference.
- Initializes SDLRenderer and SDLWindow - Initializes SDLRenderer and SDLWindow
- Initializes ImGui, fonts, themes, and clipboard. - Initializes ImGui, fonts, themes, and clipboard.
- Handles user input from keyboard and mouse. - Handles user input from keyboard and mouse.
- Updates `editor::MasterEditor`. - Updates `editor::MasterEditor`
- Renders the output to the screen. - Renders the output to the screen.
- Handles the teardown of SDL and ImGui resources. - Handles the teardown of SDL and ImGui resources.
- [app/editor/master_editor.cc](../src/app/editor/master_editor.cc) - [app/editor/master_editor.cc](../src/app/editor/master_editor.cc)
- Handles the main menu bar. - Handles the main menu bar.
- File - File
- Edit - Open - [app::ROM::LoadFromFile](../src/app/rom.cc&l=90)
- View - Save - [app::ROM::SaveToFile](../src/app/rom.cc&l=301)
- Help - Edit
- Handles `absl::Status` errors as popups delivered to the user. - View
- Update all the editors in a tab view. - Emulator
- [app/editor/assembly_editor.cc](../src/app/editor/assembly_editor.cc) - HEX Editor
- [app/editor/dungeon_editor.cc](../src/app/editor/dungeon_editor.cc) - ASM Editor
- [app/editor/graphics_editor.cc](../src/app/editor/graphics_editor.cc) - Palette Editor
- [app/editor/music_editor.cc](../src/app/editor/music_editor.cc) - Memory Viewer
- [app/editor/overworld_editor.cc](../src/app/editor/overworld_editor.cc) - ImGui Demo
- [app/editor/screen_editor.cc](../src/app/editor/screen_editor.cc) - GUI Tools
- [app/editor/sprite_editor.cc](../src/app/editor/sprite_editor.cc) - Runtime Metrics
- Style Editor
- 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)
## Overworld
- [app/zelda3/overworld.cc](../src/app/zelda3/overworld.cc)
- [app/zelda3/overworld.h](../src/app/zelda3/overworld.h)
- [app/zelda3/overworld_map.cc](../src/app/zelda3/overworld_map.cc)
- [app/zelda3/overworld_map.h](../src/app/zelda3/overworld_map.h)
---
- **Construction of Tile16 and Tile32**
- **Save and Load Resources**
- Sprites
- Entrances
- Tilemaps
## Bitmap ## Bitmap
Located in [app/gfx/bitmap.cc](../src/app/gfx/bitmap.cc) - [app/gfx/bitmap.cc](../src/app/gfx/bitmap.cc)
- [app/gfx/bitmap.h](../src/app/gfx/bitmap.cc)
---
- **Initialization**: Offers multiple constructors to create bitmaps using different data types. - **Initialization**: Offers multiple constructors to create bitmaps using different data types.
- **Palette Application**: Provides grayscale palettes and can convert `SNESPalette` to `SDL_Palette`. - **Palette Application**: Provides grayscale palettes and can convert `SNESPalette` to `SDL_Palette`.