6a49f7defa
- Added a new feature to the `z3ed` AI agent allowing testing in mock ROM mode, which creates a minimal valid ROM structure with embedded labels but no actual game data. - Updated the `agent_test_suite.sh` script to default to mock ROM mode for easier testing. - Introduced `--mock-rom` command line flag to enable mock ROM mode in various agent commands. - Enhanced documentation to cover the usage and benefits of mock ROM mode for CI/CD and development testing. - Implemented necessary changes in the codebase to support mock ROM initialization and label management.
yaze Build Scripts
This directory contains build and setup scripts for YAZE development on different platforms.
Windows Scripts
vcpkg Setup (Optional)
setup-vcpkg-windows.ps1- Setup vcpkg for SDL2 dependency (PowerShell)setup-vcpkg-windows.bat- Setup vcpkg for SDL2 dependency (Batch)
Note: vcpkg is optional. YAZE uses bundled dependencies by default.
Windows Build Workflow
Recommended: Visual Studio CMake Mode
YAZE uses Visual Studio's native CMake support - no project generation needed.
- Install Visual Studio 2022 with "Desktop development with C++" workload
- Open Visual Studio 2022
- File → Open → Folder
- Navigate to yaze directory
- Select configuration (Debug/Release) from toolbar
- Press F5 to build and run
Command Line Build
# Standard CMake workflow
cmake -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build --config Debug
# Run the application
.\build\bin\Debug\yaze.exe
Compiler Notes
The CMake configuration is designed to work with MSVC (Visual Studio's compiler). The build system includes automatic workarounds for C++23 compatibility:
- Abseil int128 is automatically excluded on Windows
- C++23 deprecation warnings are properly silenced
- Platform-specific definitions are handled automatically
Quick Start (Windows)
Option 1: Visual Studio (Recommended)
- Open Visual Studio 2022
- File → Open → Folder
- Navigate to yaze directory
- Select configuration (Debug/Release)
- Press F5 to build and run
Option 2: Command Line
# Standard CMake build
cmake -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build --config Debug
Option 3: With vcpkg (Optional)
# Setup vcpkg for SDL2
.\scripts\setup-vcpkg-windows.ps1
# Then build normally in Visual Studio or command line
Troubleshooting
Common Issues
-
PowerShell Execution Policy
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser -
Visual Studio Not Detecting CMakeLists.txt
- Ensure you opened the folder (not a solution file)
- Check that CMakeLists.txt exists in the root directory
- Try: File → Close Folder, then File → Open → Folder
-
vcpkg Issues (if using vcpkg)
- Run
.\scripts\setup-vcpkg-windows.ps1to reinstall - Check internet connection for dependency downloads
- Note: vcpkg is optional; bundled dependencies work by default
- Run
-
CMake Configuration Errors
- Delete the
build/directory - Close and reopen the folder in Visual Studio
- Or run:
cmake -B build -DCMAKE_BUILD_TYPE=Debug
- Delete the
-
Missing Git Submodules
git submodule update --init --recursive
Getting Help
- Check the Build Instructions
- Review CMake output for specific error messages
- Ensure all prerequisites are installed (Visual Studio 2022 with C++ workload)
Other Scripts
create_release.sh- Create GitHub releases (Linux/macOS)extract_changelog.py- Extract changelog for releasesquality_check.sh- Code quality checks (Linux/macOS)create-macos-bundle.sh- Create macOS application bundle for releases
Build Environment Verification
This directory also contains build environment verification scripts.
verify-build-environment.ps1 / .sh
A comprehensive script that checks:
- ✅ CMake Installation - Version 3.16+ required
- ✅ Git Installation - With submodule support
- ✅ C++ Compiler - GCC 13+, Clang 16+, or MSVC 2019+
- ✅ Platform Tools - Xcode (macOS), Visual Studio (Windows), build-essential (Linux)
- ✅ Git Submodules - All dependencies synchronized
Usage
Windows (PowerShell):
.\scripts\verify-build-environment.ps1
macOS/Linux:
./scripts/verify-build-environment.sh