backend-infra-engineer: Pre-0.2.2 snapshot (2023)
This commit is contained in:
scawful
@@ -1,26 +0,0 @@
|
||||
## September 2022
|
||||
|
||||
- Drawing Overworld maps to the screen
|
||||
- Drawing entrance data on the overworld
|
||||
- Drawing 2bpp inventory graphics data
|
||||
- Started the YazeDelta project for version control.
|
||||
|
||||
## August 2022
|
||||
|
||||
- Added ValidateCompressionResults to ROM::Compress
|
||||
- Improved Overworld systems in preparation for drawing maps.
|
||||
|
||||
## July 2022
|
||||
|
||||
- Display current overworld map graphics tile sheets.
|
||||
- Added CreateAllGraphicsData to the ROM class
|
||||
- Added Google Abseil C++ library for error handling, string manipulation
|
||||
- Refactor ROM class to use smart pointers and STL containers
|
||||
|
||||
## June 2022
|
||||
|
||||
- Implemented LC_LZ2 Decompression
|
||||
- Created Bitmap class for displaying SNES Graphics
|
||||
- Added Overworld and OverworldMap class definitions
|
||||
- Built user interface using ImGui and SDL2
|
||||
- Started YAZE
|
||||
67
docs/compression.md
Normal file
67
docs/compression.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# LC_LZ2 Compression
|
||||
|
||||
The compression algorithm has multiple implementations with varying levels of quality, based primarily on the implementations made in skarsnik/sneshacking, Zarby89/ZScreamDungeon and ZCompress with optimizations made for C++.
|
||||
|
||||
## Key Definitions
|
||||
|
||||
### Constants and Macros:
|
||||
- `BUILD_HEADER(command, length)`: Macro to build a header from a command and a length.
|
||||
- Command Constants: Constants to represent different commands like `kCommandDirectCopy`, `kCommandByteFill`, etc.
|
||||
- Length and Mode Constants: Such as `kMaxLengthNormalHeader`, `kNintendoMode1`, etc.
|
||||
|
||||
### Data Structures:
|
||||
|
||||
#### 1. CompressionCommand:
|
||||
- **arguments**: 2D array representing the command arguments for each possible command.
|
||||
- **cmd_size**: Array storing the size of each possible command.
|
||||
- **data_size**: Array storing the size of the data processed by each possible command.
|
||||
|
||||
#### 2. CompressionPiece:
|
||||
- **command**: Represents the compression command.
|
||||
- **length**: Length of the compressed data piece.
|
||||
- **argument_length**: Length of the argument.
|
||||
- **argument**: Argument as a string.
|
||||
- **next**: Pointer to the next compression piece.
|
||||
|
||||
#### 3. CompressionContext (for Compression V3):
|
||||
- Contains vectors to store raw and compressed data, compression pieces, and compression string.
|
||||
- Various counters and flags for compression control.
|
||||
- Current compression command details.
|
||||
|
||||
## Compression Functions
|
||||
|
||||
### Version 1:
|
||||
- **Byte Repeat**: `CheckByteRepeat`
|
||||
- **Word Repeat**: `CheckWordRepeat`
|
||||
- **Increasing Byte**: `CheckIncByte`
|
||||
- **Intra Copy**: `CheckIntraCopy`
|
||||
- **Validation and Alternatives**: `ValidateForByteGain` & `CompressionCommandAlternative`
|
||||
|
||||
### Version 2:
|
||||
- **Byte Repeat**: `CheckByteRepeatV2`
|
||||
- **Word Repeat**: `CheckWordRepeatV2`
|
||||
- **Increasing Byte**: `CheckIncByteV2`
|
||||
- **Intra Copy**: `CheckIntraCopyV2`
|
||||
- **Validation and Alternatives**: `ValidateForByteGainV2` & `CompressionCommandAlternativeV2`
|
||||
|
||||
### Version 3:
|
||||
Using `CompressionContext` to handle compression.
|
||||
- **Initialization**: `InitializeCompression`
|
||||
- **Command Checks**: Such as `CheckByteRepeatV3`
|
||||
- **Determining Best Compression**: `DetermineBestCompression`
|
||||
- **Handling Direct Copy**: `HandleDirectCopy`
|
||||
- **Adding Compression to Chain**: `AddCompressionToChain`
|
||||
|
||||
## Decompression Functions:
|
||||
- `SetBuffer`: Prepares a buffer from data.
|
||||
- `memfill`: Fills memory.
|
||||
- **Decompression**: Such as `DecompressV2`, `DecompressGraphics`, and `DecompressOverworld`.
|
||||
|
||||
## Utility Functions:
|
||||
- **Printing**: Such as `PrintCompressionPiece` and `PrintCompressionChain`.
|
||||
- **Compression String Creation**: `CreateCompressionString`
|
||||
- **Compression Result Validation**: Such as `ValidateCompressionResult` and its V3 variant.
|
||||
- **Compression Piece Manipulation**: Like `SplitCompressionPiece` and its V3 variant.
|
||||
|
||||
## Final Notes
|
||||
The YAZE's LC_LZ2 compression scheme provides three versions of compression methodologies with comprehensive support for various commands and modes. It ensures versatility and adaptability for different compression needs.
|
||||
32
docs/getting-started.md
Normal file
32
docs/getting-started.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Getting Started with YAZE
|
||||
|
||||
This software allows you to modify the classic SNES game "The Legend of Zelda: A Link to the Past" by editing its ROM file. With this editor, you can change various aspects of the game, such as the maps, sprites, items, and more.
|
||||
|
||||
Please note that this project is currently a work in progress, and some features may not be fully implemented or may be subject to change.
|
||||
|
||||
## Prerequisites
|
||||
Before you start using YAZE, make sure you have the following:
|
||||
|
||||
- A copy of "The Legend of Zelda: A Link to the Past" ROM file (US or JP)
|
||||
- Basic knowledge of hexadecimal and binary data
|
||||
|
||||
## Installation
|
||||
To install YAZE, follow these steps based on your platform:
|
||||
|
||||
### Windows
|
||||
|
||||
### MacOS
|
||||
|
||||
### GNU/Linux
|
||||
|
||||
## Usage
|
||||
To use the Link to the Past ROM Editor, follow these steps:
|
||||
|
||||
Open the "ALTTP.sfc" ROM file using the "File" menu.
|
||||
|
||||
...
|
||||
|
||||
Save your changes using the "File" menu.
|
||||
Backup files are enabled by default. Each save will produce a timestamped copy of your ROM before you last saved.
|
||||
|
||||
That's it! With these instructions, you should be able to get started with using YAZE. Happy editing!
|
||||
209
docs/infrastructure.md
Normal file
209
docs/infrastructure.md
Normal file
@@ -0,0 +1,209 @@
|
||||
# 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)
|
||||
- [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)
|
||||
- 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
|
||||
- Open - [app::ROM::LoadFromFile](../src/app/rom.cc#l=90)
|
||||
- Save - [app::ROM::SaveToFile](../src/app/rom.cc#l=301)
|
||||
- Edit
|
||||
- View
|
||||
- Emulator
|
||||
- HEX Editor
|
||||
- ASM Editor
|
||||
- Palette Editor
|
||||
- Memory Viewer
|
||||
- ImGui Demo
|
||||
- GUI Tools
|
||||
- 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)
|
||||
|
||||
## ROM
|
||||
- [app/rom.cc](../src/app/rom.cc)
|
||||
- [app/rom.h](../src/app/rom.h)
|
||||
---
|
||||
|
||||
This `ROM` class provides methods to manipulate and access data from a ROM.
|
||||
|
||||
- **Key Methods**:
|
||||
- `Load2BppGraphics()`: Loads 2BPP graphics data from specified sheets.
|
||||
- `LoadAllGraphicsData()`: Loads all graphics data, both compressed and uncompressed, converting where necessary.
|
||||
- `LoadFromFile(const absl::string_view& filename, bool z3_load)`: Loads ROM data from a file. It also handles headers and Zelda 3 specific data if requested.
|
||||
- `LoadFromPointer(uchar* data, size_t length)`: Loads ROM data from a provided pointer.
|
||||
- `LoadFromBytes(const Bytes& data)`: Loads ROM data from bytes.
|
||||
- `LoadAllPalettes()`: Loads all color palettes used in the ROM. This includes palettes for various elements like sprites, shields, swords, etc.
|
||||
- `UpdatePaletteColor(...)`: Updates a specific color within a named palette group.
|
||||
|
||||
- **Internal Data Structures**:
|
||||
- `rom_data_`: A container that holds the ROM data.
|
||||
- `graphics_bin_`: Holds the graphics data.
|
||||
- `palette_groups_`: A map containing various palette groups, each having its own set of color palettes.
|
||||
|
||||
- **Special Notes**:
|
||||
- The class interacts with various external functionalities, such as decompression algorithms (`gfx::DecompressV2`) and color conversion (`gfx::SnesTo8bppSheet`).
|
||||
- Headers in the ROM data, if present, are identified and removed.
|
||||
- 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)
|
||||
- [app/gfx/bitmap.h](../src/app/gfx/bitmap.cc)
|
||||
---
|
||||
|
||||
This class is responsible for creating, managing, and manipulating bitmap data, which can be displayed on the screen using the ImGui library.
|
||||
|
||||
### Key Attributes:
|
||||
|
||||
1. **Width, Height, Depth, and Data Size**: These represent the dimensions and data size of the bitmap.
|
||||
2. **Pixel Data**: Points to the raw data of the bitmap.
|
||||
3. **Texture and Surface**: Use SDL to manage the graphical representation of the bitmap data. Both these attributes have custom deleters, ensuring proper resource management.
|
||||
|
||||
### Main Functions:
|
||||
|
||||
1. **Constructors**: Multiple constructors allow for different ways to create a Bitmap instance, like specifying width, height, depth, and data.
|
||||
2. **Create**: This set of overloaded functions provides ways to create a bitmap from different data sources.
|
||||
3. **CreateFromSurface**: Allows for the creation of a bitmap from an SDL_Surface.
|
||||
4. **Apply**: Changes the bitmap's data to a new set of Bytes.
|
||||
5. **Texture Operations**:
|
||||
- **CreateTexture**: Creates an SDL_Texture from the bitmap's data for rendering.
|
||||
- **UpdateTexture**: Updates the SDL_Texture with the latest bitmap data.
|
||||
6. **SaveSurfaceToFile**: Saves the SDL_Surface to a file.
|
||||
7. **SetSurface**: Assigns a new SDL_Surface to the bitmap.
|
||||
8. **Palette Functions**:
|
||||
- **ApplyPalette (Overloaded)**: This allows for the application of a SNESPalette or a standard SDL_Color palette to the bitmap.
|
||||
9. **WriteToPixel**: Directly writes a value to a specified position in the pixel data.
|
||||
|
||||
## 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.
|
||||
6
docs/macos-build.md
Normal file
6
docs/macos-build.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# macOS Build Settings
|
||||
|
||||
- Clang 15.0.1 x86_64-apple-darrwin22.5.0
|
||||
- SDL2 Source v2.26.5
|
||||
- Removed snes_spc
|
||||
- Removed asar_static
|
||||
Binary file not shown.
@@ -1,40 +0,0 @@
|
||||
\documentclass[12pt, oneside]{report}
|
||||
\title{Yet Another Zelda3 Editor}
|
||||
\author{Justin Scofield\thanks{Special thanks to JaredBrian, Zarby89}}
|
||||
\date{June 2022 - October 2022}
|
||||
\pagestyle{headings}
|
||||
|
||||
\begin{document}
|
||||
\maketitle
|
||||
|
||||
\tableofcontents
|
||||
|
||||
\chapter{Introduction}
|
||||
|
||||
{\bf Yet Another Zelda3 Editor} is a multi-purpose editor for the retro video game title {\it {"The Legend of Zelda: A Link to the Past"}} for the Super Nintendo Entertainment System. The editor only supports the US version.
|
||||
|
||||
\section{Getting Started}
|
||||
\section{Loading from ROM}
|
||||
\section{Saving to ROM}
|
||||
|
||||
\chapter{Overworld}
|
||||
|
||||
The editor provides an interface for the user to make various changes to the overworld maps. These changes include the manpulation of the maps tiles, palettes, entrances, exits, sprites, area music, and other properties. Here we will explain the basics of the tile system.
|
||||
|
||||
\section{Tile System}
|
||||
\section{Map Toolset}
|
||||
\section{Map Canvas}
|
||||
|
||||
\chapter{Dungeons}
|
||||
|
||||
\chapter{Palettes}
|
||||
|
||||
\chapter{Sprites}
|
||||
|
||||
\chapter{Screens}
|
||||
\section{Inventory}
|
||||
\section{Heads-up Display}
|
||||
|
||||
\chapter{Modules}
|
||||
|
||||
\end{document}
|
||||
Reference in New Issue
Block a user