From 0095b08d8c3960d0ee562ea305a424f1ef5bb94f Mon Sep 17 00:00:00 2001 From: scawful Date: Sun, 14 Apr 2024 10:40:51 -0500 Subject: [PATCH] Remove redundant sections from infrastructure doc --- docs/infrastructure.md | 69 ------------------------------------------ 1 file changed, 69 deletions(-) diff --git a/docs/infrastructure.md b/docs/infrastructure.md index b066f30f..0b53b3f8 100644 --- a/docs/infrastructure.md +++ b/docs/infrastructure.md @@ -23,59 +23,6 @@ For developers to reference. - 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) - - [Pipeline](../src/app/gui/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) - - [DungeonEditor](../src/app/editor/dungeon_editor.h) - - [GraphicsEditor](../src/app/editor/graphics_editor.h) - - [OverworldEditor](../src/app/editor/overworld_editor.h) - - [ScreenEditor](../src/app/editor/screen_editor.h) - - [SpriteEditor](../src/app/editor/sprite_editor.h) - - **Modules** - - [AssemblyEditor](../src/app/editor/modules/assembly_editor.h) - - [MusicEditor](../src/app/editor/modules/music_editor.h) - - [GfxGroupEditor](../src/app/editor/modules/gfx_group_editor.h) - - [Tile16Editor](../src/app/editor/modules/tile16_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/) - - [Emulator](../src/app/emu/emulator.h) -- **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) @@ -142,22 +89,6 @@ This `ROM` class provides methods to manipulate and access data from a ROM. - Specific Zelda 3 data can be loaded if specified. - Palettes are categorized into multiple groups (e.g., `ow_main`, `ow_aux`, `hud`, etc.) and loaded accordingly. - -## 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 - [app/gfx/bitmap.cc](../src/app/gfx/bitmap.cc)