DOCSEARCHbyAlgolia
Submit Docs

Unity Actions

repository·main·Indexed 22 days ago

https://github.com/game-ci/unity-actions

A suite of GitHub Actions for automating Unity project workflows. It provides tools for license management (activation and return), automated testing via the Unity Test Runner in Edit and Play modes, and multi-platform builds for WebGL, Android, iOS, and various desktop configurations.

Tokens
1.1K
Snippets
0
Records
6
Agent score
78%

What's inside unity-actions

  1. Overview of Unity Actions

    main
    Unity Actions is a collection of GitHub Actions designed to automate the testing and building of Unity projects. It is part of the GameCI ecosystem and provides specialized workflows for license management, running Unity Test Runner (both Edit and Play modes), and building for various target platforms including WebGL, Android, iOS, and multiple desktop/mobile configurations.

  2. Overview of the Universal Project Template

    main

    The Universal Project Template is designed for Unity projects where performance, wide platform support, and ease of graphics customization are priorities.

    Key features include:

    • Universal Render Pipeline (URP): A prebuilt Scriptable Render Pipeline optimized for various platforms, including an optimized 2D renderer with 2D lights, pixel-perfect rendering, and integrated post-processing.
    • Shader Graph: A visual node-based editor for creating shaders without writing code.
    • Sample Content: Includes a sample Scene demonstrating lighting settings, Materials, Shaders, and post-processing effects.
    • Quality Presets: Contains preconfigured Universal Render Pipeline Assets to allow quick swapping between different graphics quality levels.
    • Optimized Presets: Includes Presets specifically optimized for use with URP.

  3. Update HDRP via Unity Package Manager

    main

    This project utilizes the Unity Package Manager to manage the High Definition Render Pipeline (HDRP). To ensure you are using the latest features and fixes, you should manually check for updates:

    1. Open the Package Manager from Windows > Package Manager.
    2. Select the HDRP package from the list on the left.
    3. Click the Update to button in the bottom right corner if a newer version is available.

  4. Explore HDRP Sample Projects and Resources

    main

    To see HDRP in practice, you can explore these community and official samples:

    Visual & Material Examples

    • Fontainebleau: Demonstrates complex Material usage, volumetric effects, decals, and Shader Graphs. GitHub Repository
    • Spaceship: Showcases high-quality visual effects using the Visual Effect Graph and scripting-triggered interactions. GitHub Repository
    • VR Alchemist Lab: Showcases HDRP rendering features specifically for VR environments. GitHub Repository

    Ray Tracing (Preview)

    Assets

  5. Available Unity Actions by Category

    main

    The Unity Actions ecosystem is divided into several functional categories:

    Configuration & Licensing

    • unity-request-activation-file: Requests a Unity activation file.
    • unity-activate: Activates a Unity license.
    • unity-return-license: Returns a Unity license.
    • actions/cache: Native support for caching dependencies.

    Testing

    • unity-test-runner: Supports running tests in Edit Mode, Play Mode, or All-in-one mode.

    Building

    • unity-builder: Supports building for a wide range of platforms, including:
      • Web: WebGL
      • Desktop: Windows (Mono & IL2CPP), Linux (Mono & IL2CPP), macOS (Mono & IL2CPP), Universal Windows Platform (UWP)
      • Mobile: Android, iOS
      • Other: AppleTV

    Note: Dedicated Server builds and console platforms (Xbox, Playstation, Switch) may have limited support or require NDAs.

  6. Access HDRP and Post-Processing Documentation

    main

    For detailed technical information regarding the High Definition Render Pipeline, use the following official resources: