Files
yaze/README.md
Soham S Gumaste 9e56a7885c Add LICENSE
2022-07-30 13:11:20 -05:00

42 lines
1.2 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
3. Create a build directory in the root workspace folder
mkdir build
4. Move to the build directory and generate the build files specified in CMakeLists.txt
cmake -G "<MinGW Makefiles/Unix Makefiles>" ../
4. Build and run.
make yaze
cmake --build <yaze_root/build> --config Debug --target yaze
Screenshots
--------
![image](https://user-images.githubusercontent.com/47263509/175393817-39ba86c1-d940-4426-b4db-e2c0f6bd857f.png)
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.