Add documentation generation for in-engine display (#115) #152
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Build | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - wwise_v2023.1 | |
| - wwise_v2024.1 | |
| pull_request: | |
| branches: | |
| - main | |
| - wwise_v2023.1 | |
| - wwise_v2024.1 | |
| env: | |
| BASE_BRANCH: ci | |
| WWISE_VERSION: "2023.1.0" | |
| GODOT_ENGINE_VERSION: "4.1.3" | |
| GODOT_ENGINE_STAGE: "stable" | |
| INTEGRATION_VERSION: "3.0.0" | |
| jobs: | |
| build-all: | |
| runs-on: ${{ matrix.os }} | |
| name: ${{ matrix.name }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - name: Windows | |
| os: "windows-2019" | |
| sdk-platform: windows | |
| scons-platform: windows | |
| release-flags: use_static_cpp=true | |
| artifact-name: windows | |
| - name: macOS | |
| os: "macos-13" | |
| sdk-platform: mac | |
| scons-platform: macos | |
| artifact-name: macos | |
| - name: Linux | |
| os: "ubuntu-20.04" | |
| sdk-platform: linux | |
| scons-platform: linux | |
| artifact-name: linux | |
| - name: iOS | |
| os: "macos-13" | |
| sdk-platform: ios | |
| scons-platform: ios | |
| debug-flags: arch=arm64 ios_min_version=11.0 | |
| release-flags: arch=arm64 ios_min_version=11.0 | |
| artifact-name: ios | |
| - name: Android | |
| os: "ubuntu-20.04" | |
| sdk-platform: android | |
| scons-platform: android | |
| debug-flags-arm64: ANDROID_NDK_ROOT=$ANDROID_NDK_LATEST_HOME arch=arm64 | |
| release-flags-arm64: ANDROID_NDK_ROOT=$ANDROID_NDK_LATEST_HOME arch=arm64 | |
| debug-flags-arm32: ANDROID_NDK_ROOT=$ANDROID_NDK_LATEST_HOME arch=arm32 | |
| release-flags-arm32: ANDROID_NDK_ROOT=$ANDROID_NDK_LATEST_HOME arch=arm32 | |
| artifact-name: android-lib | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| with: | |
| submodules: recursive | |
| - name: Setup java | |
| uses: actions/setup-java@v3 | |
| if: matrix.sdk-platform == 'android' | |
| with: | |
| distribution: 'temurin' | |
| java-version: '17' | |
| - name: Android dependencies | |
| if: matrix.sdk-platform == 'android' | |
| uses: nttld/setup-ndk@v1 | |
| with: | |
| ndk-version: r23c | |
| link-to-sdk: true | |
| - name: Wwise SDK cache | |
| id: cache-wwise-sdk | |
| uses: actions/cache@v3 | |
| env: | |
| cache-name: cache-wwise-sdk | |
| with: | |
| path: addons/Wwise/native/wwise_sdk | |
| key: ${{ matrix.sdk-platform }}-build-${{ env.cache-name }}-${{ env.WWISE_VERSION }} | |
| # - name: Load .scons_cache directory | |
| # id: cache-godot-extension | |
| # uses: actions/cache@v3 | |
| # with: | |
| # path: ${{github.workspace}}/.scons_cache/ | |
| # key: ${{matrix.sdk-platform}}-${{env.BASE_BRANCH}}-${{github.ref}}-${{github.sha}} | |
| # restore-keys: | | |
| # ${{matrix.sdk-platform}}-${{env.BASE_BRANCH}}-${{github.ref}}-${{github.sha}} | |
| # ${{matrix.sdk-platform}}-${{env.BASE_BRANCH}}-${{github.ref}} | |
| # ${{matrix.sdk-platform}}-${{env.BASE_BRANCH}} | |
| - name: Set up Python 3.x | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.x" | |
| architecture: "x64" | |
| - name: Set up dependencies (Python, SCons) | |
| run: python -m pip install scons==4.7.0 | |
| - name: Set up Windows dependencies | |
| if: runner.os == 'Windows' | |
| run: | | |
| choco install 7zip -y | |
| - name: Set up Linux dependencies | |
| if: runner.os == 'Linux' && matrix.sdk-platform == 'linux' | |
| run: | | |
| sudo apt-get install build-essential pkg-config libx11-dev \ | |
| yasm zip unzip p7zip-full p7zip-rar | |
| - name: Download Wwise SDK (Base) | |
| uses: suisei-cn/[email protected] | |
| if: steps.cache-wwise-sdk.outputs.cache-hit != 'true' | |
| with: | |
| url: "https://www.dropbox.com/scl/fi/xlrcmxbmxsmy58tp33uiw/wwise_sdk_2023.1.0_base.zip?rlkey=30ut2n1g1bi5dp33y923epsbd&dl=1" | |
| target: ./addons/Wwise/native/wwise_sdk/ | |
| - name: Download Wwise SDK (Windows) | |
| uses: suisei-cn/[email protected] | |
| if: runner.os == 'Windows' && steps.cache-wwise-sdk.outputs.cache-hit != 'true' | |
| with: | |
| url: "https://www.dropbox.com/scl/fi/kt51rpzdbvgzt6wsnclhe/wwise_sdk_2023.1.0_win.zip?rlkey=ossw4of3bxjat6fbempev6jbr&dl=1" | |
| target: ./addons/Wwise/native/wwise_sdk/ | |
| - name: Download Wwise SDK (macOS) | |
| uses: suisei-cn/[email protected] | |
| if: runner.os == 'MacOS' && matrix.sdk-platform == 'mac' && steps.cache-wwise-sdk.outputs.cache-hit != 'true' | |
| with: | |
| url: "https://www.dropbox.com/scl/fi/97zus2pl7btnua0s5dhw1/wwise_sdk_2023.1.0_mac.zip?rlkey=v4io943jvor5ovbw7x6n5p6gm&dl=1" | |
| target: ./addons/Wwise/native/wwise_sdk/ | |
| - name: Download Wwise SDK (Linux) | |
| uses: suisei-cn/[email protected] | |
| if: runner.os == 'Linux' && matrix.sdk-platform == 'linux' && steps.cache-wwise-sdk.outputs.cache-hit != 'true' | |
| with: | |
| url: "https://www.dropbox.com/scl/fi/76dgnud1pg6bbctiruiy4/wwise_sdk_2023.1.0_linux.zip?rlkey=8oimalx8sj8klaze2hl35pbha&dl=1" | |
| target: ./addons/Wwise/native/wwise_sdk/ | |
| - name: Download Wwise SDK (iOS) | |
| uses: suisei-cn/[email protected] | |
| if: runner.os == 'MacOS' && matrix.sdk-platform == 'ios' && steps.cache-wwise-sdk.outputs.cache-hit != 'true' | |
| with: | |
| url: "https://www.dropbox.com/scl/fi/p0jknjqz3ahw4myzq5y1g/wwise_sdk_2023.1.0_ios.zip?rlkey=ybyvp3bavmh6h2r6csftsmtep&dl=1" | |
| target: ./addons/Wwise/native/wwise_sdk/ | |
| - name: Download Wwise SDK (Android) | |
| uses: suisei-cn/[email protected] | |
| if: runner.os == 'Linux' && matrix.sdk-platform == 'android' && steps.cache-wwise-sdk.outputs.cache-hit != 'true' | |
| with: | |
| url: "https://www.dropbox.com/scl/fi/0armk45ync2ijvrq5epgq/wwise_sdk_2023.1.0_android.zip?rlkey=twmaw7gc39bytxgenuc8baqml&dl=1" | |
| target: ./addons/Wwise/native/wwise_sdk/ | |
| - name: Unzip SDK (Windows) | |
| if: runner.os == 'Windows' && steps.cache-wwise-sdk.outputs.cache-hit != 'true' | |
| run: | | |
| cd ./addons/Wwise/native/wwise_sdk | |
| 7z x wwise_sdk_2023.1.0_base.zip | |
| 7z x wwise_sdk_2023.1.0_win.zip | |
| cd ../../../../ | |
| - name: Unzip SDK (macOS) | |
| if: runner.os == 'MacOS' && matrix.sdk-platform == 'mac' && steps.cache-wwise-sdk.outputs.cache-hit != 'true' | |
| run: | | |
| cd ./addons/Wwise/native/wwise_sdk | |
| 7z x wwise_sdk_2023.1.0_base.zip | |
| 7z x wwise_sdk_2023.1.0_mac.zip | |
| cd ../../../../ | |
| - name: Unzip SDK (Linux) | |
| if: runner.os == 'Linux' && matrix.sdk-platform == 'linux' && steps.cache-wwise-sdk.outputs.cache-hit != 'true' | |
| run: | | |
| cd ./addons/Wwise/native/wwise_sdk | |
| 7z x wwise_sdk_2023.1.0_base.zip | |
| 7z x wwise_sdk_2023.1.0_linux.zip | |
| cd ../../../../ | |
| - name: Unzip SDK (iOS) | |
| if: runner.os == 'MacOS' && matrix.sdk-platform == 'ios' && steps.cache-wwise-sdk.outputs.cache-hit != 'true' | |
| run: | | |
| cd ./addons/Wwise/native/wwise_sdk | |
| 7z x wwise_sdk_2023.1.0_base.zip | |
| 7z x wwise_sdk_2023.1.0_ios.zip | |
| cd ../../../../ | |
| - name: Unzip SDK (Android) | |
| if: runner.os == 'Linux' && matrix.sdk-platform == 'android' && steps.cache-wwise-sdk.outputs.cache-hit != 'true' | |
| run: | | |
| cd ./addons/Wwise/native/wwise_sdk | |
| 7z x wwise_sdk_2023.1.0_base.zip | |
| 7z x wwise_sdk_2023.1.0_android.zip | |
| cd ../../../../ | |
| - name: Compile Editor library | |
| if: matrix.sdk-platform != 'android' && matrix.sdk-platform != 'ios' | |
| shell: bash | |
| env: | |
| SCONS_CACHE: ${{github.workspace}}/.scons_cache/ | |
| SCONS_CACHE_LIMIT: 7168 | |
| run: | | |
| cd addons/Wwise/native | |
| mkdir -p godot-cpp/bin | |
| scons platform=${{ matrix.scons-platform }} target=editor debug_symbols=yes wwise_sdk=wwise_sdk -j6 ${{ matrix.debug-flags }} | |
| cd ../../../ | |
| - name: Compile Debug library | |
| if: matrix.sdk-platform != 'android' | |
| shell: bash | |
| env: | |
| SCONS_CACHE: ${{github.workspace}}/.scons_cache/ | |
| SCONS_CACHE_LIMIT: 7168 | |
| run: | | |
| cd addons/Wwise/native | |
| scons platform=${{ matrix.scons-platform }} target=template_debug dev_build=yes debug_symbols=yes asserts=yes wwise_sdk=wwise_sdk -j6 ${{ matrix.debug-flags }} | |
| cd ../../../ | |
| - name: Compile Release library | |
| if: matrix.sdk-platform != 'android' | |
| shell: bash | |
| env: | |
| SCONS_CACHE: ${{github.workspace}}/.scons_cache/ | |
| SCONS_CACHE_LIMIT: 7168 | |
| run: | | |
| cd addons/Wwise/native | |
| scons platform=${{ matrix.scons-platform }} target=template_release wwise_sdk=wwise_sdk -j6 ${{ matrix.release-flags }} | |
| cd ../../../ | |
| - name: Compile Android libraries | |
| if: matrix.sdk-platform == 'android' | |
| shell: bash | |
| run: | | |
| cd addons/Wwise/native/wwise_sdk | |
| WWISESDK=$(pwd) | |
| cd ../godot-cpp | |
| mkdir -p bin | |
| scons platform=android target=template_debug dev_build=yes -j6 ${{ matrix.debug-flags-arm64 }} | |
| scons platform=android target=template_debug dev_build=yes -j6 ${{ matrix.debug-flags-arm32 }} | |
| scons platform=android target=template_release -j6 ${{ matrix.release-flags-arm64 }} | |
| scons platform=android target=template_release -j6 ${{ matrix.release-flags-arm32 }} | |
| cd ../android | |
| chmod +x ./gradlew | |
| ./gradlew assemble -PWWISE_SDK="$WWISESDK" | |
| - name: Upload libs | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: ${{ matrix.artifact-name }} | |
| path: addons/Wwise/native/lib | |
| upload-addon: | |
| runs-on: "ubuntu-20.04" | |
| needs: [build-all] | |
| name: Addon | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Download all libs | |
| uses: actions/download-artifact@v3 | |
| - name: Assemble all artifacts | |
| run: | | |
| ls | |
| shopt -s dotglob | |
| if [ ! -d "addons/Wwise/native/lib" ]; then | |
| mkdir -p addons/Wwise/native/lib | |
| fi | |
| if [ -d windows ]; then | |
| mv windows/* addons/Wwise/native/lib/ | |
| rm -r windows | |
| fi | |
| if [ -d macos ]; then | |
| mv macos/* addons/Wwise/native/lib/ | |
| rm -r macos | |
| fi | |
| if [ -d linux ]; then | |
| mv linux/* addons/Wwise/native/lib/ | |
| rm -r linux | |
| fi | |
| if [ -d android-lib ]; then | |
| mv android-lib/* addons/Wwise/native/lib/ | |
| rm -r android-lib | |
| fi | |
| if [ -d ios ]; then | |
| mv ios/* addons/Wwise/native/lib/ | |
| rm -r ios | |
| fi | |
| - name: Clean up addon | |
| run: | | |
| rm -r ./addons/Wwise/native/godot-cpp | |
| rm -r ./addons/Wwise/native/src | |
| rm -r ./addons/Wwise/native/vs2022 | |
| rm -r ./addons/Wwise/native/android | |
| rm -r ./addons/Wwise/native/doc_classes | |
| rm ./addons/Wwise/native/SConstruct | |
| rm ./LICENSE | |
| rm ./README.md | |
| rm .gitattributes | |
| rm .gitmodules | |
| rm project.godot | |
| rm -r ./.git | |
| rm -r ./.github | |
| rm -r ./addons/Wwise/tests | |
| mkdir -p GeneratedSoundBanks | |
| cp addons/Wwise/tools/wwise_ids.template GeneratedSoundBanks/wwise_ids.gd | |
| rm -r ./addons/Wwise/tools | |
| - name: Upload final artifact | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: wwise-${{ env.WWISE_VERSION }}-for-godot-${{ env.GODOT_ENGINE_VERSION }}-${{ env.GODOT_ENGINE_STAGE }}-${{ env.INTEGRATION_VERSION }} | |
| path: ./ |