Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.05 KB

README.md

File metadata and controls

59 lines (39 loc) · 2.05 KB

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 and ZScream

Building and installation

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 for more information.

Documentation

  • For users, please refer to getting_started.md for instructions on how to use yaze.
  • For developers, please refer to the documentation for information on the project's infrastructure.

License

YAZE is distributed under the GNU GPLv3 license.

SDL2, ImGui and Abseil are subject to respective licenses.

Screenshots

image

image

image