53 lines
1.5 KiB
Markdown
53 lines
1.5 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
|
|
```
|
|
|
|
## Documentation
|
|
|
|
- For users, please refer to [getting_started.md](docs/getting-started.md) for instructions on how to use yaze.
|
|
- For developers, please refer to [infrastructure.md](docs/infrastructure.md) for information on the project's infrastructure.
|
|
|
|
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
|
|
--------
|
|
|
|
|
|
|
|
|
|
|
|
|