Initial Wii Effect Editor source

Author: N-I-N-0

.github/workflows/build.yml

@@ -0,0 +1,95 @@
+name: Build and rolling release
+
+on:
+  push:
+    branches: ['**']
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: effect-editor-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-24.04
+            platform: Linux-x64
+          - os: macos-14
+            platform: macOS-arm64
+          - os: windows-2022
+            platform: Windows-x64
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Linux dependencies
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y ninja-build pkg-config libasound2-dev libpulse-dev \
+            libx11-dev libxext-dev libxrandr-dev libxcursor-dev libxfixes-dev libxi-dev \
+            libxss-dev libxtst-dev libxkbcommon-dev libdrm-dev libgbm-dev libegl1-mesa-dev \
+            libgl1-mesa-dev libdbus-1-dev libibus-1.0-dev libudev-dev libwayland-dev \
+            libdecor-0-dev xvfb mesa-vulkan-drivers
+      - name: MSVC environment
+        if: runner.os == 'Windows'
+        uses: ilammy/msvc-dev-cmd@v1
+      - name: Configure
+        run: >-
+          cmake -S src -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
+          -DAURORA_DAWN_PROVIDER=package -DAURORA_SDL3_PROVIDER=vendor
+          -DAURORA_SDL3_LINKAGE=static
+      - name: Build
+        run: cmake --build build --target breff_editor_native --parallel 3
+      - name: Package runtime dependencies
+        run: cmake --install build --prefix stage --config Release --component EffectEditor
+      - name: Linux startup check
+        if: runner.os == 'Linux'
+        run: xvfb-run -a timeout 90 ./stage/EffectEditor --smoke-test
+      - name: Archive
+        shell: bash
+        run: |
+          mkdir -p artifacts
+          cd stage
+          cmake -E tar cf "../artifacts/Wii-Effect-Editor-${{ matrix.platform }}.zip" --format=zip .
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Wii-Effect-Editor-${{ matrix.platform }}
+          path: artifacts/*.zip
+          if-no-files-found: error
+
+  release:
+    needs: build
+    if: github.event_name != 'pull_request' && github.ref_name == github.event.repository.default_branch
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: Wii-Effect-Editor-*
+          path: artifacts
+          merge-multiple: true
+      - name: Update rolling release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        shell: bash
+        run: |
+          set -euo pipefail
+          git tag -f rolling "$GITHUB_SHA"
+          git push origin refs/tags/rolling --force
+          printf 'Automatic builds from commit `%s`.\n\nWindows x64, Linux x64 (Ubuntu 24.04 or newer), and macOS Apple Silicon.\n' "$GITHUB_SHA" > release-notes.md
+          if gh release view rolling >/dev/null 2>&1; then
+            gh release upload rolling artifacts/*.zip --clobber
+            gh release edit rolling --title 'Effect Editor — latest build' --notes-file release-notes.md --latest
+          else
+            gh release create rolling artifacts/*.zip --verify-tag --title 'Effect Editor — latest build' --notes-file release-notes.md --latest
+          fi
+

.gitignore

@@ -0,0 +1,11 @@
+/dist/
+/.vscode/
+/stage/
+/artifacts/
+CMakeUserPresets.json
+*.log
+*.pdb
+*.ilk
+*.obj
+*.o
+.DS_Store

README.md

@@ -0,0 +1,40 @@
+<p align="center"><img src="logo.png" width="160" alt="Wii Effect Editor logo"></p>
+
+# Wii Effect Editor
+
+A native C++ editor for Wii BREFF effect and BREFT texture archives, with an interactive preview powered by [Aurora](https://github.com/encounter/aurora).
+
+![Effect Editor playing a fire effect](docs/screenshot.png)
+
+## Features
+
+- Edit effects with structured fields, color pickers, and animation controls, or edit JSON.
+- Add, rename, and delete effects and textures. Inspect which effects reference each texture.
+- Preview changes immediately, with looping, selectable random seeds, and optional grid and axes.
+- Orbit with left-drag, zoom with the mouse wheel, and press **R** over the preview to reset the camera.
+- Import and export JSON files as produced by [Actually-Working-BREFF-Converter](https://github.com/NSMBW-Community/Actually-Working-BREFF-Converter)
+
+## Download
+
+Get the latest successful build from the [rolling release](../../releases/tag/rolling). Extract the complete archive, then launch:
+
+| Platform | Application |
+| --- | --- |
+| Windows x64 | `EffectEditor.exe` |
+| Linux x64 | `./EffectEditor` |
+| macOS Apple Silicon | `Effect Editor.app` |
+
+Linux builds target Ubuntu 24.04 or newer and need a working Vulkan driver. The macOS application is not Apple-notarized.
+
+## Build
+
+Requires Git, CMake 3.25+, Ninja, and a C++20 compiler. On Windows, use a Visual Studio 2022 developer shell with the C++ workload installed. Linux packages are listed in [the build workflow](.github/workflows/build.yml).
+
+```sh
+cmake -S src -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
+cmake --build build --target breff_editor_native --parallel
+cmake --install build --prefix dist/Wii-Effect-Editor --config Release --component EffectEditor
+```
+
+The first configuration downloads Aurora and its dependencies. The NW4R effect runtime is included in the repository.
+

docs/screenshot.png

@@ -0,0 +1,57 @@
+cmake_minimum_required(VERSION 3.25)
+project(Wii-Effect-Editor LANGUAGES C CXX)
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+include(FetchContent)
+
+set(AURORA_ENABLE_DVD OFF CACHE BOOL "" FORCE)
+set(AURORA_ENABLE_CARD OFF CACHE BOOL "" FORCE)
+set(AURORA_ENABLE_THP OFF CACHE BOOL "" FORCE)
+set(AURORA_ENABLE_RMLUI OFF CACHE BOOL "" FORCE)
+FetchContent_Declare(aurora
+    GIT_REPOSITORY https://github.com/encounter/aurora.git
+    GIT_TAG d0c931da2ed3f41d0e42736c2ab52a78c7cf1a9d)
+FetchContent_Declare(json
+    URL https://github.com/nlohmann/json/releases/download/v3.12.0/json.tar.xz)
+FetchContent_MakeAvailable(aurora json)
+add_subdirectory(codec)
+add_subdirectory(runtime)
+
+add_executable(breff_editor_native editor/main.cpp editor/preview_view.cpp editor/document.cpp)
+file(READ "${CMAKE_CURRENT_SOURCE_DIR}/../logo.png" EDITOR_LOGO_HEX HEX)
+string(REGEX REPLACE "([0-9a-f][0-9a-f])" "0x\\1," EDITOR_LOGO_BYTES "${EDITOR_LOGO_HEX}")
+configure_file(cmake/logo.h.in generated/logo.h @ONLY)
+target_include_directories(breff_editor_native PRIVATE "${CMAKE_CURRENT_BINARY_DIR}/generated")
+target_link_libraries(breff_editor_native PRIVATE breff_codec breff_runtime aurora::core aurora::gx aurora::main aurora::vi aurora::mtx nlohmann_json::nlohmann_json PNG::PNG)
+if(WIN32)
+    target_link_libraries(breff_editor_native PRIVATE windowscodecs ole32)
+endif()
+
+include(cmake/Package.cmake)
+if(WIN32)
+    include("${aurora_SOURCE_DIR}/cmake/AuroraCopyRuntimeDLLs.cmake")
+    aurora_copy_runtime_dlls(breff_editor_native)
+    # Ship the C++ runtime with the application. A newer MSVC mutex ABI can
+    # crash in an older system MSVCP140.dll before the first frame is drawn.
+    set(CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_SKIP TRUE)
+    set(CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_NO_WARNINGS TRUE)
+    include(InstallRequiredSystemLibraries)
+    if(MSVC AND NOT CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS)
+        # Portable MSVC layouts place the target CRT beside cl.exe.
+        get_filename_component(_compiler_directory "${CMAKE_CXX_COMPILER}" DIRECTORY)
+        foreach(_crt IN ITEMS msvcp140.dll msvcp140_1.dll msvcp140_2.dll
+                msvcp140_atomic_wait.dll msvcp140_codecvt_ids.dll
+                vcruntime140.dll vcruntime140_1.dll vcruntime140_threads.dll)
+            if(EXISTS "${_compiler_directory}/${_crt}")
+                list(APPEND CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS "${_compiler_directory}/${_crt}")
+            endif()
+        endforeach()
+    endif()
+    if(CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS)
+        add_custom_command(TARGET breff_editor_native POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy_if_different
+                ${CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS} $<TARGET_FILE_DIR:breff_editor_native>
+            COMMAND_EXPAND_LISTS)
+    endif()
+endif()
+

logo.png

@@ -0,0 +1,57 @@
+# Install only the editor component, excluding dependency SDKs and examples.
+set_target_properties(breff_editor_native PROPERTIES OUTPUT_NAME "EffectEditor")
+if(APPLE)
+    set_target_properties(breff_editor_native PROPERTIES
+        MACOSX_BUNDLE TRUE MACOSX_BUNDLE_BUNDLE_NAME "Effect Editor"
+        MACOSX_BUNDLE_GUI_IDENTIFIER "org.effect-editor.app"
+        OUTPUT_NAME "Effect Editor")
+    install(TARGETS breff_editor_native BUNDLE DESTINATION . COMPONENT EffectEditor)
+    install(CODE [[
+        include(BundleUtilities)
+        fixup_bundle("${CMAKE_INSTALL_PREFIX}/Effect Editor.app" "" "")
+        execute_process(COMMAND codesign --force --deep --sign -
+            "${CMAKE_INSTALL_PREFIX}/Effect Editor.app" COMMAND_ERROR_IS_FATAL ANY)
+    ]] COMPONENT EffectEditor)
+elseif(WIN32)
+    install(TARGETS breff_editor_native RUNTIME DESTINATION . COMPONENT EffectEditor)
+    install(CODE "
+        file(GLOB _dlls \"$<TARGET_FILE_DIR:breff_editor_native>/*.dll\")
+        file(INSTALL DESTINATION \"\${CMAKE_INSTALL_PREFIX}\" TYPE FILE FILES \${_dlls})
+    " COMPONENT EffectEditor)
+else()
+    set_target_properties(breff_editor_native PROPERTIES INSTALL_RPATH "$ORIGIN/lib")
+    install(TARGETS breff_editor_native
+        RUNTIME_DEPENDENCY_SET effect_editor_deps
+        RUNTIME DESTINATION . COMPONENT EffectEditor)
+    install(RUNTIME_DEPENDENCY_SET effect_editor_deps
+        PRE_EXCLUDE_REGEXES "^linux-vdso" "^ld-linux"
+        POST_EXCLUDE_REGEXES "^/lib/" "^/lib64/" "^/usr/lib/" "^/usr/lib64/"
+        LIBRARY DESTINATION lib COMPONENT EffectEditor)
+endif()
+install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/../README.md"
+    "${CMAKE_CURRENT_SOURCE_DIR}/../logo.png" DESTINATION . COMPONENT EffectEditor)
+install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/runtime/nw4r/LICENSE"
+    DESTINATION licenses/nw4r COMPONENT EffectEditor)
+foreach(_dependency aurora json fmt sdl3 sdl3_prebuilt dawn_prebuilt png zlib freetype imgui xxhash zstd sqlite3 tracy abseil)
+    if(DEFINED ${_dependency}_SOURCE_DIR)
+        file(GLOB _licenses LIST_DIRECTORIES FALSE "${${_dependency}_SOURCE_DIR}/LICENSE*" "${${_dependency}_SOURCE_DIR}/COPYING*")
+        if(_licenses)
+            install(FILES ${_licenses} DESTINATION "licenses/${_dependency}" COMPONENT EffectEditor)
+        endif()
+    endif()
+endforeach()
+# Dependencies declared inside Aurora have directory-scoped variables. Collect
+# their license files from FetchContent's source directories as well.
+file(GLOB _dependency_sources LIST_DIRECTORIES TRUE "${FETCHCONTENT_BASE_DIR}/*-src")
+foreach(_source IN LISTS _dependency_sources)
+    get_filename_component(_name "${_source}" NAME)
+    string(REGEX REPLACE "-src$" "" _name "${_name}")
+    file(GLOB _licenses LIST_DIRECTORIES FALSE "${_source}/LICENSE*" "${_source}/COPYING*" "${_source}/COPYRIGHT*")
+    if(_licenses)
+        install(FILES ${_licenses} DESTINATION "licenses/${_name}" COMPONENT EffectEditor)
+    endif()
+    if(IS_DIRECTORY "${_source}/licenses")
+        install(DIRECTORY "${_source}/licenses/" DESTINATION "licenses/${_name}" COMPONENT EffectEditor)
+    endif()
+endforeach()
+

src/CMakeLists.txt

@@ -0,0 +1,2 @@
+#pragma once
+inline constexpr unsigned char editorLogo[] = { @EDITOR_LOGO_BYTES@ };

src/cmake/Package.cmake

@@ -0,0 +1,3 @@
+add_library(breff_codec STATIC resource_file.cpp records.cpp animation.cpp effect.cpp texture.cpp form.cpp version7.cpp)
+target_include_directories(breff_codec PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
+target_link_libraries(breff_codec PUBLIC nlohmann_json::nlohmann_json)