70 lines
2.6 KiB
Markdown
70 lines
2.6 KiB
Markdown
# Yet Another Zelda3 Editor
|
|
|
|
- Platform: Windows, macOS, iOS, GNU/Linux
|
|
- Dependencies: SDL2, ImGui, abseil-cpp
|
|
|
|
## Description
|
|
|
|
General purpose editor for The Legend of Zelda: A Link to the Past for the Super Nintendo.
|
|
|
|
Provides bindings in C and Python for building custom tools and utilities.
|
|
|
|
Takes heavy inspiration from ALTTP community efforts such as [Hyrule Magic](https://www.romhacking.net/utilities/200/) and [ZScream](https://github.com/Zarby89/ZScreamDungeon)
|
|
|
|
Building and installation
|
|
-------------------------
|
|
[CMake](http://www.cmake.org "CMake") is required to build yaze
|
|
|
|
1. Clone the repository
|
|
2. Create the build directory and configuration
|
|
3. Build and run the application
|
|
4. (Optional) Run the tests
|
|
|
|
```
|
|
git clone --recurse-submodules https://github.com/scawful/yaze.git
|
|
cmake -S . -B build
|
|
cmake --build build
|
|
```
|
|
|
|
By default this will build all targets.
|
|
|
|
- **yaze**: Editor Application
|
|
- **yaze_c**: C Library
|
|
- **yaze_emu**: SNES Emulator
|
|
- **yaze_py**: Python Module
|
|
- **yaze_test**: Unit Tests
|
|
- **z3ed**: Command Line Interface
|
|
|
|
Dependencies are included as submodules and will be built automatically. For those who want to reduce compile times, consider installing the dependencies on your system. See [build-instructions.md](docs/build-instructions.md) for more information.
|
|
|
|
## Documentation
|
|
|
|
- **[Getting Started](docs/getting-started.md)** - Basic setup and usage guide
|
|
- **[Build Instructions](docs/build-instructions.md)** - Detailed build and installation guide
|
|
- **[Documentation Index](docs/index.md)** - Complete documentation overview
|
|
- **[Contributing](docs/contributing.md)** - How to contribute to the project
|
|
|
|
### Key Documentation
|
|
- **[Dungeon Editor Guide](docs/dungeon-editor-comprehensive-guide.md)** - Complete dungeon editing guide
|
|
- **[Overworld Loading Guide](docs/overworld_loading_guide.md)** - ZSCustomOverworld implementation
|
|
- **[Canvas Interface](docs/canvas-refactor-summary.md)** - Graphics system architecture
|
|
- **[Integration Tests](docs/integration_test_guide.md)** - Testing framework
|
|
|
|
For developers, see the [documentation index](docs/index.md) for a complete overview of all available documentation.
|
|
|
|
License
|
|
--------
|
|
YAZE is distributed under the [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.txt) license.
|
|
|
|
SDL2, ImGui and Abseil are subject to respective licenses.
|
|
|
|
Screenshots
|
|
--------
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|