Files

scawful caffe59800 Update README and build instructions for clarity and organization

- Revised README to enhance feature descriptions and streamline sections for better readability.
- Updated build instructions to clarify platform-specific setup and improve the overall structure.
- Added new documentation files for platform compatibility and build presets, detailing native file dialog support and build configuration options.
- Removed outdated documentation related to overworld expansion to maintain relevance.

2025-09-26 15:00:57 -04:00

3.3 KiB

Raw Blame History

Build Instructions

YAZE uses CMake 3.16+ with modern target-based configuration. For VSCode users, install the CMake extensions:

Quick Start

macOS (Apple Silicon)

cmake --preset debug
cmake --build build

Linux / Windows

cmake -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build

Minimal Build

cmake -B build -DYAZE_MINIMAL_BUILD=ON
cmake --build build

Dependencies

Required

CMake 3.16+
C++23 compiler (GCC 13+, Clang 16+, MSVC 2019+)
Git with submodule support

Bundled Libraries

SDL2, ImGui, Abseil, Asar, GoogleTest
Native File Dialog Extended (NFD)
All dependencies included in repository

Platform Setup

macOS

# Install Xcode Command Line Tools
xcode-select --install

# Optional: Install Homebrew dependencies (auto-detected)
brew install cmake pkg-config

Linux (Ubuntu/Debian)

sudo apt-get update
sudo apt-get install -y build-essential cmake ninja-build pkg-config \
  libgtk-3-dev libdbus-1-dev

Windows

Option 1 - Minimal (Recommended for CI):

Visual Studio 2019+ with C++ CMake tools
No additional dependencies needed (all bundled)

Option 2 - Full Development:

Install vcpkg and dependencies from vcpkg.json

Build Targets

Applications

yaze: Main GUI editor application
z3ed: Command-line interface tool

Libraries

yaze_c: C API library for extensions
asar-static: 65816 assembler library

Development (Debug Builds Only)

yaze_emu: Standalone SNES emulator
yaze_test: Comprehensive test suite

Build Configurations

Debug (Full Features)

cmake --preset debug  # macOS
# OR
cmake -B build -DCMAKE_BUILD_TYPE=Debug  # All platforms

Includes: NFD, ImGuiTestEngine, PNG support, emulator, all tools

Minimal (CI/Fast Builds)

cmake -B build -DYAZE_MINIMAL_BUILD=ON

Excludes: Emulator, CLI tools, UI tests, optional dependencies

Release

cmake --preset release  # macOS
# OR  
cmake -B build -DCMAKE_BUILD_TYPE=Release  # All platforms

IDE Integration

VS Code

Install CMake Tools extension
Open project, select "Debug" preset
Language server uses compile_commands.json automatically

CLion

Opens CMake projects directly
Select Debug configuration

Xcode (macOS)

cmake --preset debug -G Xcode
open build/yaze.xcodeproj

Features by Build Type

Feature	Debug	Release	Minimal (CI)
GUI Editor	✅	✅	✅
Native File Dialogs	✅	✅	❌
PNG Support	✅	✅	❌
Emulator	✅	✅	❌
CLI Tools	✅	✅	❌
Test Suite	✅	❌	✅ (limited)
UI Testing	✅	❌	❌

Troubleshooting

Architecture Errors (macOS)

# Clean and use ARM64-only preset
rm -rf build
cmake --preset debug  # Uses arm64 only

Missing Headers (Language Server)

# Regenerate compile commands
cmake --preset debug
cp build/compile_commands.json .
# Restart VS Code

CI Build Failures

Use minimal build configuration that matches CI:

cmake -B build -DYAZE_MINIMAL_BUILD=ON -DYAZE_ENABLE_UI_TESTS=OFF
cmake --build build

3.3 KiB Raw Blame History