Files
yaze/README.md
Justin Scofield 31a0d2a67e Update README.md
2022-07-30 14:57:44 -04:00

39 lines
1.0 KiB
Markdown

# Yet Another Zelda3 Editor
- Platform: Windows, macOS, GNU/Linux
- Dependencies: SDL2, ImGui
## Description
General purpose editor for The Legend of Zelda: A Link to the Past for the Super Nintendo.
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
git clone --recurse-submodules https://github.com/scawful/yaze.git
2. Create the build directory and configuration
cmake -S . -B build
3. Build and run.
cmake --build build
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
--------
![image](https://user-images.githubusercontent.com/47263509/181937830-efdcae4f-af92-4856-bc09-a4d60f5a4a40.png)